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:

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

[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	OutputImageType
typedef OutputImageType::Pointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef TInputSpatialObject	InputSpatialObjectType
typedef InputSpatialObjectType::Pointer	InputSpatialObjectPointer
typedef InputSpatialObjectType::ConstPointer	InputSpatialObjectConstPointer
typedef TInputSpatialObject::ChildrenListType	ChildrenListType
Public Methods
virtual const char *	GetClassName () const
virtual void	GenerateOutputInformation ()
virtual void	GenerateData ()
virtual void	SetChildrenDepth (unsigned int _arg)
virtual unsigned int	GetChildrenDepth ()
	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	SetSize (SizeType _arg)
virtual SizeType	GetSize ()
Static Public Methods
Pointer	New ()
Protected Methods
	SpatialObjectToImageFilter ()
	~SpatialObjectToImageFilter ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
Protected Attributes
SizeType	m_Size
unsigned int	m_ChildrenDepth

---

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

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

Definition at line 58 of file itkSpatialObjectToImageFilter.h.

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

Some convenient typedefs. Definition at line 57 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 45 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 54 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 44 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 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 ImageSource<TOutputImage> itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::Superclass

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 40 of file itkSpatialObjectToImageFilter.h.

---

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 (    )  [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, 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 76 of file itkSpatialObjectToImageFilter.h. References HardConnectedComponentImageFilter::PrintSelf(), and HardConnectedComponentImageFilter::SizeType.

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

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

Run-time type information (and related methods). Reimplemented from itk::ImageSource< TOutputImage >.

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 SizeType itk::SpatialObjectToImageFilter< TInputSpatialObject, TOutputImage >::GetSize (    )  [virtual]

Set/Get Size

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]

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 >::SetSize (  SizeType    _arg )  [virtual]

Set/Get Size

---

Member Data Documentation

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

Definition at line 92 of file itkSpatialObjectToImageFilter.h.

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

Definition at line 91 of file itkSpatialObjectToImageFilter.h.

---

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

• itkSpatialObjectToImageFilter.h

---