ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions
itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage > Class Template Reference

#include <itkSpatialObjectToImageFilter.h>

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

List of all members.

Public Types

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

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const DirectionTypeGetDirection (void) const
const InputSpatialObjectTypeGetInput (void)
const InputSpatialObjectTypeGetInput (unsigned int idx)
virtual const char * GetNameOfClass () const
virtual const double * GetOrigin (void) const
virtual const double * GetSpacing (void) const
virtual void SetDirection (const DirectionType &direction)
virtual void SetInput (const InputSpatialObjectType *object)
virtual void SetInput (unsigned int, const InputSpatialObjectType *object)
virtual void SetOrigin (const PointType &origin)
virtual void SetOrigin (const double *origin)
virtual void SetOrigin (const float *origin)
virtual void SetSpacing (const SpacingType &spacing)
virtual void SetSpacing (const double *spacing)
virtual void SetSpacing (const float *spacing)
virtual void SetInsideValue (ValueType _arg)
virtual ValueType GetInsideValue () const
virtual void SetOutsideValue (ValueType _arg)
virtual ValueType GetOutsideValue () const
virtual void SetChildrenDepth (unsigned int _arg)
virtual unsigned int GetChildrenDepth () const
virtual void SetSize (SizeType _arg)
virtual SizeType GetSize () const

Static Public Member Functions

static Pointer New ()

Static Public Attributes

static const unsigned int ObjectDimension = InputSpatialObjectType::ObjectDimension
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension

Protected Member Functions

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

Protected Attributes

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

Private Member Functions

void operator= (const Self &)
 SpatialObjectToImageFilter (const Self &)
virtual void SetUseObjectValue (bool _arg)
virtual bool GetUseObjectValue () const
 SpatialObjectToImageFilter ()
 ~SpatialObjectToImageFilter ()

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.

Wiki Examples:

Definition at line 40 of file itkSpatialObjectToImageFilter.h.


Member Typedef Documentation

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

Definition at line 70 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 47 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 55 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 69 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 68 of file itkSpatialObjectToImageFilter.h.

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

Some convenient typedefs.

Definition at line 67 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 52 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 61 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 49 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 46 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 51 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 44 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 50 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 54 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 45 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 53 of file itkSpatialObjectToImageFilter.h.


Constructor & Destructor Documentation

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

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 >::~SpatialObjectToImageFilter ( ) [protected]

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 >::SpatialObjectToImageFilter ( const Self ) [private]

Member Function Documentation

template<class TInputSpatialObject , class TOutputImage >
virtual::itk::LightObject::Pointer itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::CreateAnother ( void  ) const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

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 161 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject , class TOutputImage >
virtual unsigned int itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetChildrenDepth ( ) const [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 const DirectionType& itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetDirection ( void  ) const [virtual]
template<class TInputSpatialObject , class TOutputImage >
const InputSpatialObjectType* itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetInput ( void  )
template<class TInputSpatialObject , class TOutputImage >
const InputSpatialObjectType* itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetInput ( unsigned int  idx)
template<class TInputSpatialObject , class TOutputImage >
virtual ValueType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetInsideValue ( ) const [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 ( void  ) const [virtual]
template<class TInputSpatialObject , class TOutputImage >
virtual ValueType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetOutsideValue ( ) const [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 ( ) const [virtual]

Set/Get Size

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

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

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

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputSpatialObject , class TOutputImage >
void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::operator= ( const Self ) [private]

Reimplemented from itk::ImageSource< TOutputImage >.

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 >::SetDirection ( const DirectionType direction) [virtual]

Directions of the output image. The direction is for oriented images.

template<class TInputSpatialObject , class TOutputImage >
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetInput ( const InputSpatialObjectType object) [virtual]
template<class TInputSpatialObject , class TOutputImage >
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetInput ( unsigned  int,
const InputSpatialObjectType object 
) [virtual]
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 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 >::SetOrigin ( const double *  origin) [virtual]
template<class TInputSpatialObject , class TOutputImage >
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetOrigin ( const float *  origin) [virtual]
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 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 >::SetSpacing ( const double *  spacing) [virtual]
template<class TInputSpatialObject , class TOutputImage >
virtual void itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::SetSpacing ( const float *  spacing) [virtual]
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 169 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject , class TOutputImage >
DirectionType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::m_Direction [protected]

Definition at line 167 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 171 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 166 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 172 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 164 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 165 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 174 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject , class TOutputImage >
const unsigned int itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::ObjectDimension = InputSpatialObjectType::ObjectDimension [static]

ImageDimension constants

Definition at line 74 of file itkSpatialObjectToImageFilter.h.

template<class TInputSpatialObject , class TOutputImage >
const unsigned int itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension [static]

ImageDimension constant

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 77 of file itkSpatialObjectToImageFilter.h.


The documentation for this class was generated from the following file: