itk::PathToImageFilter< TInputPath, TOutputImage > Class Template Reference

Base class for filters that take a Path as input and produce an image as output. Base class for filters that take a Path 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 path's bounding box is used. The default spacing of the image is given by the spacing of the input path (currently assumed internally to be 1.0). More...

#include <itkPathToImageFilter.h>

Inheritance diagram for itk::PathToImageFilter< TInputPath, TOutputImage >:

[legend]Collaboration diagram for itk::PathToImageFilter< TInputPath, TOutputImage >:

[legend]List of all members.

Public Types
typedef PathToImageFilter	Self
typedef ImageSource< TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef TInputPath	InputPathType
typedef InputPathType::Pointer	InputPathPointer
typedef InputPathType::ConstPointer	InputPathConstPointer
typedef TOutputImage	OutputImageType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::SizeType	SizeType
typedef OutputImageType::ValueType	ValueType
Public Member Functions
virtual const char *	GetClassName () const
	itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)
virtual void	SetInput (const InputPathType *path)
virtual void	SetInput (unsigned int, const TInputPath *path)
const InputPathType *	GetInput (void)
const InputPathType *	GetInput (unsigned int idx)
virtual void	SetSpacing (const double spacing[OutputImageDimension])
virtual void	SetSpacing (const float spacing[OutputImageDimension])
virtual const double *	GetSpacing () const
virtual void	SetPathValue (ValueType _arg)
virtual ValueType	GetPathValue ()
virtual void	SetBackgroundValue (ValueType _arg)
virtual ValueType	GetBackgroundValue ()
virtual void	SetOrigin (const double origin[OutputImageDimension])
virtual void	SetOrigin (const float origin[OutputImageDimension])
virtual const double *	GetOrigin () const
virtual void	SetSize (SizeType _arg)
virtual SizeType	GetSize ()
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	PathToImageFilter ()
	~PathToImageFilter ()
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]
ValueType	m_PathValue
ValueType	m_BackgroundValue

---

Detailed Description

template<class TInputPath, class TOutputImage>
class itk::PathToImageFilter< TInputPath, TOutputImage >

Base class for filters that take a Path as input and produce an image as output. Base class for filters that take a Path 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 path's bounding box is used. The default spacing of the image is given by the spacing of the input path (currently assumed internally to be 1.0).

Definition at line 35 of file itkPathToImageFilter.h.

---

Member Typedef Documentation

template<class TInputPath, class TOutputImage> typedef SmartPointer<const Self> itk::PathToImageFilter< TInputPath, TOutputImage >::ConstPointer

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 42 of file itkPathToImageFilter.h.

template<class TInputPath, class TOutputImage> typedef InputPathType::ConstPointer itk::PathToImageFilter< TInputPath, TOutputImage >::InputPathConstPointer

Definition at line 54 of file itkPathToImageFilter.h.

template<class TInputPath, class TOutputImage> typedef InputPathType::Pointer itk::PathToImageFilter< TInputPath, TOutputImage >::InputPathPointer

Definition at line 53 of file itkPathToImageFilter.h.

template<class TInputPath, class TOutputImage> typedef TInputPath itk::PathToImageFilter< TInputPath, TOutputImage >::InputPathType

Definition at line 52 of file itkPathToImageFilter.h.

template<class TInputPath, class TOutputImage> typedef OutputImageType::Pointer itk::PathToImageFilter< TInputPath, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 56 of file itkPathToImageFilter.h.

template<class TInputPath, class TOutputImage> typedef Superclass::OutputImageRegionType itk::PathToImageFilter< TInputPath, TOutputImage >::OutputImageRegionType

Some convenient typedefs. Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 51 of file itkPathToImageFilter.h.

template<class TInputPath, class TOutputImage> typedef TOutputImage itk::PathToImageFilter< TInputPath, TOutputImage >::OutputImageType

Some convenient typedefs. Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 55 of file itkPathToImageFilter.h.

template<class TInputPath, class TOutputImage> typedef SmartPointer<Self> itk::PathToImageFilter< TInputPath, TOutputImage >::Pointer

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 41 of file itkPathToImageFilter.h.

template<class TInputPath, class TOutputImage> typedef PathToImageFilter itk::PathToImageFilter< TInputPath, TOutputImage >::Self

Standard class typedefs. Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 39 of file itkPathToImageFilter.h.

template<class TInputPath, class TOutputImage> typedef OutputImageType::SizeType itk::PathToImageFilter< TInputPath, TOutputImage >::SizeType

Definition at line 57 of file itkPathToImageFilter.h.

template<class TInputPath, class TOutputImage> typedef ImageSource<TOutputImage> itk::PathToImageFilter< TInputPath, TOutputImage >::Superclass

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

template<class TInputPath, class TOutputImage> typedef OutputImageType::ValueType itk::PathToImageFilter< TInputPath, TOutputImage >::ValueType

Definition at line 58 of file itkPathToImageFilter.h. Referenced by itk::PathToImageFilter< TInputPath, TOutputImage >::GenerateOutputInformation().

---

Constructor & Destructor Documentation

template<class TInputPath, class TOutputImage> itk::PathToImageFilter< TInputPath, TOutputImage >::PathToImageFilter (   )  [protected]

template<class TInputPath, class TOutputImage> itk::PathToImageFilter< TInputPath, TOutputImage >::~PathToImageFilter (   )  [protected]

---

Member Function Documentation

template<class TInputPath, class TOutputImage> virtual void itk::PathToImageFilter< TInputPath, 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 TInputPath, class TOutputImage> virtual void itk::PathToImageFilter< TInputPath, 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 106 of file itkPathToImageFilter.h. References itk::PathToImageFilter< TInputPath, TOutputImage >::ValueType.

template<class TInputPath, class TOutputImage> virtual ValueType itk::PathToImageFilter< TInputPath, TOutputImage >::GetBackgroundValue (   )  [virtual]

Set/Get the value for pixels on and off the path. By default, this filter will return a "0" image with path pixels set to 1

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

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

template<class TInputPath, class TOutputImage> const InputPathType* itk::PathToImageFilter< TInputPath, TOutputImage >::GetInput (  unsigned int  idx  )

Set/Get the path input of this process object. Reimplemented from itk::ProcessObject.

template<class TInputPath, class TOutputImage> const InputPathType* itk::PathToImageFilter< TInputPath, TOutputImage >::GetInput (  void   )

Set/Get the path input of this process object.

template<class TInputPath, class TOutputImage> virtual const double* itk::PathToImageFilter< TInputPath, 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 TInputPath, class TOutputImage> virtual ValueType itk::PathToImageFilter< TInputPath, TOutputImage >::GetPathValue (   )  [virtual]

Set/Get the value for pixels on and off the path. By default, this filter will return a "0" image with path pixels set to 1

template<class TInputPath, class TOutputImage> virtual SizeType itk::PathToImageFilter< TInputPath, TOutputImage >::GetSize (   )  [virtual]

Set/Get Size

template<class TInputPath, class TOutputImage> virtual const double* itk::PathToImageFilter< TInputPath, 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 TInputPath, class TOutputImage> itk::PathToImageFilter< TInputPath, TOutputImage >::itkStaticConstMacro (  OutputImageDimension  , unsigned  int, TOutputImage::ImageDimension  )

ImageDimension constants

template<class TInputPath, class TOutputImage> Pointer itk::PathToImageFilter< TInputPath, TOutputImage >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TInputPath, class TOutputImage> virtual void itk::PathToImageFilter< TInputPath, 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 TInputPath, class TOutputImage> virtual void itk::PathToImageFilter< TInputPath, TOutputImage >::SetBackgroundValue (  ValueType  _arg  )  [virtual]

Set/Get the value for pixels on and off the path. By default, this filter will return a "0" image with path pixels set to 1

template<class TInputPath, class TOutputImage> virtual void itk::PathToImageFilter< TInputPath, TOutputImage >::SetInput (  unsigned  int, const TInputPath *  path )  [virtual]

Set/Get the path input of this process object.

template<class TInputPath, class TOutputImage> virtual void itk::PathToImageFilter< TInputPath, TOutputImage >::SetInput (  const InputPathType *  path  )  [virtual]

Set/Get the path input of this process object.

template<class TInputPath, class TOutputImage> virtual void itk::PathToImageFilter< TInputPath, TOutputImage >::SetOrigin (  const float  origin[OutputImageDimension]  )  [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 TInputPath, class TOutputImage> virtual void itk::PathToImageFilter< TInputPath, TOutputImage >::SetOrigin (  const double  origin[OutputImageDimension]  )  [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 TInputPath, class TOutputImage> virtual void itk::PathToImageFilter< TInputPath, TOutputImage >::SetPathValue (  ValueType  _arg  )  [virtual]

Set/Get the value for pixels on and off the path. By default, this filter will return a "0" image with path pixels set to 1

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

Set/Get Size

template<class TInputPath, class TOutputImage> virtual void itk::PathToImageFilter< TInputPath, TOutputImage >::SetSpacing (  const float  spacing[OutputImageDimension]  )  [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 TInputPath, class TOutputImage> virtual void itk::PathToImageFilter< TInputPath, TOutputImage >::SetSpacing (  const double  spacing[OutputImageDimension]  )  [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()

---

Member Data Documentation

template<class TInputPath, class TOutputImage> ValueType itk::PathToImageFilter< TInputPath, TOutputImage >::m_BackgroundValue [protected]

Definition at line 114 of file itkPathToImageFilter.h.

template<class TInputPath, class TOutputImage> double itk::PathToImageFilter< TInputPath, TOutputImage >::m_Origin[OutputImageDimension] [protected]

Definition at line 112 of file itkPathToImageFilter.h.

template<class TInputPath, class TOutputImage> ValueType itk::PathToImageFilter< TInputPath, TOutputImage >::m_PathValue [protected]

Definition at line 113 of file itkPathToImageFilter.h.

template<class TInputPath, class TOutputImage> SizeType itk::PathToImageFilter< TInputPath, TOutputImage >::m_Size [protected]

Definition at line 110 of file itkPathToImageFilter.h.

template<class TInputPath, class TOutputImage> double itk::PathToImageFilter< TInputPath, TOutputImage >::m_Spacing[OutputImageDimension] [protected]

Definition at line 111 of file itkPathToImageFilter.h.

---

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

• itkPathToImageFilter.h

---