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

#include <itkPathToImageFilter.h>

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

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

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef InputPathType::ConstPointer	InputPathConstPointer
typedef InputPathType::Pointer	InputPathPointer
typedef TInputPath	InputPathType
typedef OutputImageType::Pointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef PathToImageFilter	Self
typedef OutputImageType::SizeType	SizeType
typedef ImageSource< TOutputImage >	Superclass
typedef OutputImageType::ValueType	ValueType
Public Types inherited from itk::ImageSource< TOutputImage >
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
typedef OutputImageType::PixelType	OutputImagePixelType
Public Types inherited from itk::ProcessObject
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef std::vector < DataObjectIdentifierType >	NameArray
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
const InputPathType *	GetInput (void)
const InputPathType *	GetInput (unsigned int idx)
virtual const char *	GetNameOfClass () const
virtual const double *	GetOrigin () const
virtual const double *	GetSpacing () const
virtual void	SetInput (const InputPathType *path)
virtual void	SetInput (unsigned int, const TInputPath *path)
virtual void	SetOrigin (const double *origin)
virtual void	SetOrigin (const float *origin)
virtual void	SetSpacing (const double *spacing)
virtual void	SetSpacing (const float *spacing)
virtual void	SetPathValue (ValueType _arg)
virtual ValueType	GetPathValue () const
virtual void	SetBackgroundValue (ValueType _arg)
virtual ValueType	GetBackgroundValue () const
Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageType *	GetOutput (void)
const OutputImageType *	GetOutput (void) const
virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Attributes
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Static Public Attributes inherited from itk::ImageSource< TOutputImage >

Protected Member Functions
virtual void	GenerateData ()
virtual void	GenerateOutputInformation ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual	~ImageSource ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyInputInformation ()
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Protected Attributes
ValueType	m_BackgroundValue
double	m_Origin [OutputImageDimension]
ValueType	m_PathValue
SizeType	m_Size
double	m_Spacing [OutputImageDimension]

Private Member Functions
void	operator= (const Self &)
	PathToImageFilter (const Self &)
virtual void	SetSize (SizeType _arg)
virtual SizeType	GetSize () const
	PathToImageFilter ()
	~PathToImageFilter ()

Additional Inherited Members
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

---

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).

Examples:

itkOrthogonalSwath2DPathFilterTest.cxx.

Definition at line 36 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 43 of file itkPathToImageFilter.h.

template<class TInputPath , class TOutputImage >

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

Definition at line 55 of file itkPathToImageFilter.h.

template<class TInputPath , class TOutputImage >

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

Definition at line 54 of file itkPathToImageFilter.h.

template<class TInputPath , class TOutputImage >

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

Definition at line 53 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 57 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 49 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 56 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 42 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 40 of file itkPathToImageFilter.h.

template<class TInputPath , class TOutputImage >

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

Definition at line 58 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 41 of file itkPathToImageFilter.h.

template<class TInputPath , class TOutputImage >

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

Definition at line 59 of file itkPathToImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputPath , class TOutputImage >

itk::PathToImageFilter< TInputPath, TOutputImage >::PathToImageFilter ( )

protected

Set/Get Size

template<class TInputPath , class TOutputImage >

itk::PathToImageFilter< TInputPath, TOutputImage >::~PathToImageFilter ( )

protected

Set/Get Size

template<class TInputPath , class TOutputImage >

itk::PathToImageFilter< TInputPath, TOutputImage >::PathToImageFilter ( const Self &  )

private

---

Member Function Documentation

template<class TInputPath , class TOutputImage >

virtual::itk::LightObject::Pointer itk::PathToImageFilter< TInputPath, 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 TInputPath , class TOutputImage >

virtual void itk::PathToImageFilter< TInputPath, TOutputImage >::GenerateData ( )

protectedvirtual

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 ( )

inlineprotectedvirtual

Generate the information describing 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 111 of file itkPathToImageFilter.h.

template<class TInputPath , class TOutputImage >

virtual ValueType itk::PathToImageFilter< TInputPath, TOutputImage >::GetBackgroundValue ( ) const

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 >

const InputPathType* itk::PathToImageFilter< TInputPath, TOutputImage >::GetInput

(

void

)

template<class TInputPath , class TOutputImage >

const InputPathType* itk::PathToImageFilter< TInputPath, TOutputImage >::GetInput

(

unsigned int

idx

)

template<class TInputPath , class TOutputImage >

virtual const char* itk::PathToImageFilter< TInputPath, TOutputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputPath , class TOutputImage >

virtual const double* itk::PathToImageFilter< TInputPath, TOutputImage >::GetOrigin ( ) const

virtual

template<class TInputPath , class TOutputImage >

virtual ValueType itk::PathToImageFilter< TInputPath, TOutputImage >::GetPathValue ( ) const

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 ( ) const

virtual

Set/Get Size

template<class TInputPath , class TOutputImage >

virtual const double* itk::PathToImageFilter< TInputPath, TOutputImage >::GetSpacing ( ) const

virtual

template<class TInputPath , class TOutputImage >

static Pointer itk::PathToImageFilter< TInputPath, TOutputImage >::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TInputPath , class TOutputImage >

void itk::PathToImageFilter< TInputPath, TOutputImage >::operator= ( const Self &  )

private

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TInputPath , class TOutputImage >

virtual void itk::PathToImageFilter< TInputPath, TOutputImage >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protectedvirtual

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 ( const InputPathType *  path )

virtual

template<class TInputPath , class TOutputImage >

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

virtual

template<class TInputPath , class TOutputImage >

virtual void itk::PathToImageFilter< TInputPath, 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 TInputPath , class TOutputImage >

virtual void itk::PathToImageFilter< TInputPath, TOutputImage >::SetOrigin ( const float *  origin )

virtual

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 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 TInputPath , class TOutputImage >

virtual void itk::PathToImageFilter< TInputPath, TOutputImage >::SetSpacing ( const float *  spacing )

virtual

---

Member Data Documentation

template<class TInputPath , class TOutputImage >

ValueType itk::PathToImageFilter< TInputPath, TOutputImage >::m_BackgroundValue

protected

Definition at line 118 of file itkPathToImageFilter.h.

template<class TInputPath , class TOutputImage >

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

protected

Definition at line 116 of file itkPathToImageFilter.h.

template<class TInputPath , class TOutputImage >

ValueType itk::PathToImageFilter< TInputPath, TOutputImage >::m_PathValue

protected

Definition at line 117 of file itkPathToImageFilter.h.

template<class TInputPath , class TOutputImage >

SizeType itk::PathToImageFilter< TInputPath, TOutputImage >::m_Size

protected

Definition at line 114 of file itkPathToImageFilter.h.

template<class TInputPath , class TOutputImage >

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

protected

Definition at line 115 of file itkPathToImageFilter.h.

template<class TInputPath , class TOutputImage >

const unsigned int itk::PathToImageFilter< TInputPath, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension

static

ImageDimension constants

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 63 of file itkPathToImageFilter.h.

---

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

• itkPathToImageFilter.h