Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage > Class Template Reference

Base class for filters that take a SpatialObject as input and produce an image as output. By default, if the user does not specify the size of the output image, the maximum size of the object's bounding box is used. The spacing of the image is given by the spacing of the input Spatial object. More...

#include <itkSpatialObjectToImageFilter.h>

Inheritance diagram for itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >:

Inheritance graph
[legend]
Collaboration diagram for itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef SpatialObjectToImageFilter Self
typedef ImageSource< TOutputImage > Superclass
typedef SmartPointer< Self > Pointer
typedef SmartPointer< const
Self > 		ConstPointer
typedef TOutputImage::SizeType SizeType
typedef TOutputImage::PointType PointType
typedef TOutputImage OutputImageType
typedef OutputImageType::Pointer OutputImagePointer
typedef OutputImageType::ValueType ValueType
typedef OutputImageType::SpacingType SpacingType
typedef Superclass::OutputImageRegionType OutputImageRegionType
typedef TInputSpatialObject InputSpatialObjectType
typedef InputSpatialObjectType::Pointer InputSpatialObjectPointer
typedef InputSpatialObjectType::ConstPointer InputSpatialObjectConstPointer
typedef TInputSpatialObject::ChildrenListType ChildrenListType

Public Member Functions

virtual const char * GetNameOfClass () const
 itkStaticConstMacro (ObjectDimension, unsigned int, InputSpatialObjectType::ObjectDimension)
 itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)
virtual void SetInput (const InputSpatialObjectType *object)
virtual void SetInput (unsigned int, const InputSpatialObjectType *object)
const InputSpatialObjectType * GetInput (void)
const InputSpatialObjectType * GetInput (unsigned int idx)
virtual void SetSpacing (const SpacingType &spacing)
virtual void SetSpacing (const double *spacing)
virtual void SetSpacing (const float *spacing)
virtual const double * GetSpacing () const
virtual void SetInsideValue (ValueType _arg)
virtual ValueType GetInsideValue ()
virtual void SetOutsideValue (ValueType _arg)
virtual ValueType GetOutsideValue ()
virtual void SetOrigin (const PointType &origin)
virtual void SetOrigin (const double *origin)
virtual void SetOrigin (const float *origin)
virtual const double * GetOrigin () const
virtual void SetChildrenDepth (unsigned int _arg)
virtual unsigned int GetChildrenDepth ()
virtual void SetSize (SizeType _arg)
virtual SizeType GetSize ()
virtual void SetUseObjectValue (bool _arg)
virtual bool GetUseObjectValue ()

Static Public Member Functions

Pointer New ()

Protected Member Functions

 SpatialObjectToImageFilter ()
 ~SpatialObjectToImageFilter ()
virtual void GenerateOutputInformation ()
virtual void GenerateData ()
virtual void PrintSelf (std::ostream &os, Indent indent) const

Protected Attributes

SizeType m_Size
double m_Spacing [OutputImageDimension]
double m_Origin [OutputImageDimension]
unsigned int m_ChildrenDepth
ValueType m_InsideValue
ValueType m_OutsideValue
bool m_UseObjectValue

Detailed Description

template<class TInputSpatialObject, class TOutputImage>
class itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >

Base class for filters that take a SpatialObject as input and produce an image as output. By default, if the user does not specify the size of the output image, the maximum size of the object's bounding box is used. The spacing of the image is given by the spacing of the input Spatial object.

Definition at line 35 of file itkSpatialObjectToImageFilter.h.

Member Typedef Documentation

template<class TInputSpatialObject, class TOutputImage>
typedef TInputSpatialObject::ChildrenListType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::ChildrenListType
 

Definition at line 63 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef SmartPointer<const Self> itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::ConstPointer
 

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 42 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef InputSpatialObjectType::ConstPointer itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::InputSpatialObjectConstPointer
 

Definition at line 62 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef InputSpatialObjectType::Pointer itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::InputSpatialObjectPointer
 

Definition at line 61 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef TInputSpatialObject itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::InputSpatialObjectType
 

Some convenient typedefs.

Definition at line 60 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef OutputImageType::Pointer itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::OutputImagePointer
 

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 46 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef Superclass::OutputImageRegionType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::OutputImageRegionType
 

Superclass typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 57 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef TOutputImage itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::OutputImageType
 

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 45 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef SmartPointer<Self> itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::Pointer
 

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 41 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef TOutputImage::PointType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::PointType
 

Definition at line 44 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef SpatialObjectToImageFilter itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::Self
 

Standard class typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 39 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef TOutputImage::SizeType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SizeType
 

Definition at line 43 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef OutputImageType::SpacingType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SpacingType
 

Definition at line 48 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef ImageSource<TOutputImage> itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::Superclass
 

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 40 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
typedef OutputImageType::ValueType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::ValueType
 

Definition at line 47 of file itkSpatialObjectToImageFilter.h.

Referenced by itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GenerateOutputInformation().

Constructor & Destructor Documentation

template<class TInputSpatialObject, class TOutputImage>
itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SpatialObjectToImageFilter (   )  [protected]
 

template<class TInputSpatialObject, class TOutputImage>
itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::~SpatialObjectToImageFilter (   )  [protected]
 

Member Function Documentation

template<class TInputSpatialObject, class TOutputImage>
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GenerateData (   )  [protected, virtual]
 

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling ThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter an be threaded, it should NOT provide a GenerateData() method but should provide a ThreadedGenerateData() instead.

See also:
ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputSpatialObject, class TOutputImage>
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GenerateOutputInformation (   )  [inline, protected, virtual]
 

Generate the information decribing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Reimplemented from itk::ProcessObject.

Definition at line 143 of file itkSpatialObjectToImageFilter.h.

References itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::ValueType.

template<class TInputSpatialObject, class TOutputImage>
virtual unsigned int itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetChildrenDepth (   )  [virtual]
 

The spatial object being transformed can be part of a hierarchy. How deep in the hierarchy should we descend in generating the image? A ChildrenDepth of 0 means to only include the object itself.

template<class TInputSpatialObject, class TOutputImage>
const InputSpatialObjectType* itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetInput (  unsigned int  idx  ) 
 

Set/Get the image input of this process object.

Reimplemented from itk::ProcessObject.

template<class TInputSpatialObject, class TOutputImage>
const InputSpatialObjectType* itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetInput (  void   ) 
 

Set/Get the image input of this process object.

template<class TInputSpatialObject, class TOutputImage>
virtual ValueType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetInsideValue (   )  [virtual]
 

Set/Get the value for pixels inside the spatial object. By default, this filter will return an image that contains values from the spatial object specified as input. If this "inside" value is changed to a non-null value, the output produced by this filter will be a mask with inside/outside values specified by the user.

template<class TInputSpatialObject, class TOutputImage>
virtual const char* itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetNameOfClass (   )  const [virtual]
 

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputSpatialObject, class TOutputImage>
virtual const double* itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetOrigin (   )  const [virtual]
 

The origin of the output image. The origin is the geometric coordinates of the index (0,0,...,0). It is stored internally as double but may be set from float.

See also:
GetOrigin()

template<class TInputSpatialObject, class TOutputImage>
virtual ValueType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetOutsideValue (   )  [virtual]
 

Set/Get the value for pixels outside the spatial object. By default, this filter will return an image that contains values from the spatial object specified as input. If this "outside" value is changed to a non-null value, the output produced by this filter will be a mask with inside/outside values specified by the user.

template<class TInputSpatialObject, class TOutputImage>
virtual SizeType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetSize (   )  [virtual]
 

Set/Get Size

template<class TInputSpatialObject, class TOutputImage>
virtual const double* itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetSpacing (   )  const [virtual]
 

Spacing (size of a pixel) of the output image. The spacing is the geometric distance between image samples. It is stored internally as double, but may be set from float.

See also:
GetSpacing()

template<class TInputSpatialObject, class TOutputImage>
virtual bool itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetUseObjectValue (   )  [virtual]
 

If UseObjectValue is set to true, then the filter uses the ValueAt() function instead of IsInside()

template<class TInputSpatialObject, class TOutputImage>
itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::itkStaticConstMacro (  OutputImageDimension  ,
unsigned  int,
TOutputImage::ImageDimension 
) 
 

ImageDimension constants

template<class TInputSpatialObject, class TOutputImage>
itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::itkStaticConstMacro (  ObjectDimension  ,
unsigned  int,
InputSpatialObjectType::ObjectDimension 
) 
 

ImageDimension constants

template<class TInputSpatialObject, class TOutputImage>
Pointer itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::New (   )  [static]
 

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputSpatialObject, class TOutputImage>
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::PrintSelf (  std::ostream &  os,
Indent  indent
)  const [protected, virtual]
 

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ProcessObject.

template<class TInputSpatialObject, class TOutputImage>
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetChildrenDepth (  unsigned int  _arg  )  [virtual]
 

The spatial object being transformed can be part of a hierarchy. How deep in the hierarchy should we descend in generating the image? A ChildrenDepth of 0 means to only include the object itself.

template<class TInputSpatialObject, class TOutputImage>
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetInput (  unsigned  int,
const InputSpatialObjectType *  object
)  [virtual]
 

Set/Get the image input of this process object.

template<class TInputSpatialObject, class TOutputImage>
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetInput (  const InputSpatialObjectType *  object  )  [virtual]
 

Set/Get the image input of this process object.

template<class TInputSpatialObject, class TOutputImage>
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetInsideValue (  ValueType  _arg  )  [virtual]
 

Set/Get the value for pixels inside the spatial object. By default, this filter will return an image that contains values from the spatial object specified as input. If this "inside" value is changed to a non-null value, the output produced by this filter will be a mask with inside/outside values specified by the user.

template<class TInputSpatialObject, class TOutputImage>
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetOrigin (  const float *  origin  )  [virtual]
 

The origin of the output image. The origin is the geometric coordinates of the index (0,0,...,0). It is stored internally as double but may be set from float.

See also:
GetOrigin()

template<class TInputSpatialObject, class TOutputImage>
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetOrigin (  const double *  origin  )  [virtual]
 

The origin of the output image. The origin is the geometric coordinates of the index (0,0,...,0). It is stored internally as double but may be set from float.

See also:
GetOrigin()

template<class TInputSpatialObject, class TOutputImage>
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetOrigin (  const PointType &  origin  )  [virtual]
 

The origin of the output image. The origin is the geometric coordinates of the index (0,0,...,0). It is stored internally as double but may be set from float.

See also:
GetOrigin()

template<class TInputSpatialObject, class TOutputImage>
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetOutsideValue (  ValueType  _arg  )  [virtual]
 

Set/Get the value for pixels outside the spatial object. By default, this filter will return an image that contains values from the spatial object specified as input. If this "outside" value is changed to a non-null value, the output produced by this filter will be a mask with inside/outside values specified by the user.

template<class TInputSpatialObject, class TOutputImage>
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetSize (  SizeType  _arg  )  [virtual]
 

Set/Get Size

template<class TInputSpatialObject, class TOutputImage>
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetSpacing (  const float *  spacing  )  [virtual]
 

Spacing (size of a pixel) of the output image. The spacing is the geometric distance between image samples. It is stored internally as double, but may be set from float.

See also:
GetSpacing()

template<class TInputSpatialObject, class TOutputImage>
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetSpacing (  const double *  spacing  )  [virtual]
 

Spacing (size of a pixel) of the output image. The spacing is the geometric distance between image samples. It is stored internally as double, but may be set from float.

See also:
GetSpacing()

template<class TInputSpatialObject, class TOutputImage>
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetSpacing (  const SpacingType &  spacing  )  [virtual]
 

Spacing (size of a pixel) of the output image. The spacing is the geometric distance between image samples. It is stored internally as double, but may be set from float.

See also:
GetSpacing()

template<class TInputSpatialObject, class TOutputImage>
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetUseObjectValue (  bool  _arg  )  [virtual]
 

If UseObjectValue is set to true, then the filter uses the ValueAt() function instead of IsInside()

Member Data Documentation

template<class TInputSpatialObject, class TOutputImage>
unsigned int itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_ChildrenDepth [protected]
 

Definition at line 150 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
ValueType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_InsideValue [protected]
 

Definition at line 151 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
double itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_Origin[OutputImageDimension] [protected]
 

Definition at line 149 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
ValueType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_OutsideValue [protected]
 

Definition at line 152 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
SizeType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_Size [protected]
 

Definition at line 147 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
double itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_Spacing[OutputImageDimension] [protected]
 

Definition at line 148 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject, class TOutputImage>
bool itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_UseObjectValue [protected]
 

Definition at line 153 of file itkSpatialObjectToImageFilter.h.

The documentation for this class was generated from the following file:
Generated at Thu May 25 02:24:30 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000