itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet > Class Template Reference

#include <itkSpatialObjectToPointSetFilter.h>

Inheritance diagram for itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >:

Collaboration diagram for itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >:

List of all members.

Public Types
typedef TInputSpatialObject::ChildrenListType	ChildrenListType
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef InputSpatialObjectType::ConstPointer	InputSpatialObjectConstPointer
typedef InputSpatialObjectType::Pointer	InputSpatialObjectPointer
typedef TInputSpatialObject	InputSpatialObjectType
typedef OutputPointSetType::Pointer	OutputPointSetPointer
typedef TOutputPointSet	OutputPointSetType
typedef itk::PointBasedSpatialObject < itkGetStaticConstMacro(ObjectDimension) >	PointBasedSpatialObjectType
typedef SmartPointer< Self >	Pointer
typedef itk::SpatialObjectPoint < itkGetStaticConstMacro(ObjectDimension) >	PointType
typedef SpatialObjectToPointSetFilter	Self
typedef MeshSource < TOutputPointSet >	Superclass
Public Types inherited from itk::MeshSource< TOutputPointSet >
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef OutputMeshType::Pointer	OutputMeshPointer
typedef TOutputPointSet	OutputMeshType
typedef ProcessObject::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
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 InputSpatialObjectType *	GetInput (void)
const InputSpatialObjectType *	GetInput (unsigned int idx)
virtual const char *	GetNameOfClass () const
virtual unsigned int	GetSamplingFactor () const
virtual void	SetInput (const InputSpatialObjectType *object)
virtual void	SetInput (unsigned int, const InputSpatialObjectType *object)
virtual void	SetSamplingFactor (unsigned int _arg)
virtual void	SetChildrenDepth (unsigned int _arg)
virtual unsigned int	GetChildrenDepth () const
Public Member Functions inherited from itk::MeshSource< TOutputPointSet >
OutputMeshType *	GetOutput (void)
OutputMeshType *	GetOutput (unsigned int idx)
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
void	SetOutput (TOutputPointSet *output)
virtual void	GraftOutput (DataObject *output)
virtual DataObjectPointer	MakeOutput (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	ObjectDimension = InputSpatialObjectType::ObjectDimension

Protected Member Functions
virtual void	GenerateData ()
virtual void	GenerateOutputInformation ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
	SpatialObjectToPointSetFilter ()
	~SpatialObjectToPointSetFilter ()
Protected Member Functions inherited from itk::MeshSource< TOutputPointSet >
void	GenerateInputRequestedRegion ()
	MeshSource ()
virtual	~MeshSource ()
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	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
unsigned int	m_ChildrenDepth

Private Member Functions
void	operator= (const Self &)
	SpatialObjectToPointSetFilter (const Self &)

Private Attributes
unsigned int	m_SamplingFactor

---

Detailed Description

template<class TInputSpatialObject, class TOutputPointSet>
class itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >

Base class for filters that take a SpatialObject as input and produce a PointSet as output. The pointset created is in physical space.

Definition at line 34 of file itkSpatialObjectToPointSetFilter.h.

---

Member Typedef Documentation

template<class TInputSpatialObject , class TOutputPointSet >

typedef TInputSpatialObject::ChildrenListType itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::ChildrenListType

Definition at line 59 of file itkSpatialObjectToPointSetFilter.h.

template<class TInputSpatialObject , class TOutputPointSet >

typedef SmartPointer< const Self > itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::ConstPointer

Reimplemented from itk::MeshSource< TOutputPointSet >.

Definition at line 41 of file itkSpatialObjectToPointSetFilter.h.

template<class TInputSpatialObject , class TOutputPointSet >

typedef DataObject::Pointer itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::DataObjectPointer

Smart Pointer type to a DataObject.

Reimplemented from itk::MeshSource< TOutputPointSet >.

Definition at line 47 of file itkSpatialObjectToPointSetFilter.h.

template<class TInputSpatialObject , class TOutputPointSet >

typedef InputSpatialObjectType::ConstPointer itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::InputSpatialObjectConstPointer

Definition at line 58 of file itkSpatialObjectToPointSetFilter.h.

template<class TInputSpatialObject , class TOutputPointSet >

typedef InputSpatialObjectType::Pointer itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::InputSpatialObjectPointer

Definition at line 57 of file itkSpatialObjectToPointSetFilter.h.

template<class TInputSpatialObject , class TOutputPointSet >

typedef TInputSpatialObject itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::InputSpatialObjectType

Some convenient typedefs.

Definition at line 53 of file itkSpatialObjectToPointSetFilter.h.

template<class TInputSpatialObject , class TOutputPointSet >

typedef OutputPointSetType::Pointer itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::OutputPointSetPointer

Definition at line 44 of file itkSpatialObjectToPointSetFilter.h.

template<class TInputSpatialObject , class TOutputPointSet >

typedef TOutputPointSet itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::OutputPointSetType

Definition at line 43 of file itkSpatialObjectToPointSetFilter.h.

template<class TInputSpatialObject , class TOutputPointSet >

typedef itk::PointBasedSpatialObject< itkGetStaticConstMacro(ObjectDimension) > itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::PointBasedSpatialObjectType

Definition at line 66 of file itkSpatialObjectToPointSetFilter.h.

template<class TInputSpatialObject , class TOutputPointSet >

typedef SmartPointer< Self > itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::Pointer

Reimplemented from itk::MeshSource< TOutputPointSet >.

Definition at line 40 of file itkSpatialObjectToPointSetFilter.h.

template<class TInputSpatialObject , class TOutputPointSet >

typedef itk::SpatialObjectPoint< itkGetStaticConstMacro(ObjectDimension) > itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::PointType

Definition at line 65 of file itkSpatialObjectToPointSetFilter.h.

template<class TInputSpatialObject , class TOutputPointSet >

typedef SpatialObjectToPointSetFilter itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::Self

Standard class typedefs.

Reimplemented from itk::MeshSource< TOutputPointSet >.

Definition at line 38 of file itkSpatialObjectToPointSetFilter.h.

template<class TInputSpatialObject , class TOutputPointSet >

typedef MeshSource< TOutputPointSet > itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::Superclass

Reimplemented from itk::MeshSource< TOutputPointSet >.

Definition at line 39 of file itkSpatialObjectToPointSetFilter.h.

---

Constructor & Destructor Documentation

template<class TInputSpatialObject , class TOutputPointSet >

itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::SpatialObjectToPointSetFilter ( )

protected

template<class TInputSpatialObject , class TOutputPointSet >

itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::~SpatialObjectToPointSetFilter ( )

protected

template<class TInputSpatialObject , class TOutputPointSet >

itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::SpatialObjectToPointSetFilter ( const Self &  )

private

---

Member Function Documentation

template<class TInputSpatialObject , class TOutputPointSet >

virtual::itk::LightObject::Pointer itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::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::MeshSource< TOutputPointSet >.

template<class TInputSpatialObject , class TOutputPointSet >

virtual void itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::GenerateData ( void  )

protectedvirtual

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

template<class TInputSpatialObject , class TOutputPointSet >

virtual void itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::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 94 of file itkSpatialObjectToPointSetFilter.h.

template<class TInputSpatialObject , class TOutputPointSet >

virtual unsigned int itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::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 PointSet? A ChildrenDepth of 0 means to only include the object itself.

template<class TInputSpatialObject , class TOutputPointSet >

const InputSpatialObjectType* itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::GetInput

(

void

)

template<class TInputSpatialObject , class TOutputPointSet >

const InputSpatialObjectType* itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::GetInput

(

unsigned int

idx

)

template<class TInputSpatialObject , class TOutputPointSet >

virtual const char* itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::MeshSource< TOutputPointSet >.

template<class TInputSpatialObject , class TOutputPointSet >

virtual unsigned int itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::GetSamplingFactor ( ) const

virtual

template<class TInputSpatialObject , class TOutputPointSet >

static Pointer itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::MeshSource< TOutputPointSet >.

template<class TInputSpatialObject , class TOutputPointSet >

void itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::operator= ( const Self &  )

private

Time when GenerateOutputInformation was last called.

Reimplemented from itk::MeshSource< TOutputPointSet >.

template<class TInputSpatialObject , class TOutputPointSet >

virtual void itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::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::MeshSource< TOutputPointSet >.

template<class TInputSpatialObject , class TOutputPointSet >

virtual void itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::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 PointSet? A ChildrenDepth of 0 means to only include the object itself.

template<class TInputSpatialObject , class TOutputPointSet >

virtual void itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::SetInput ( const InputSpatialObjectType *  object )

virtual

template<class TInputSpatialObject , class TOutputPointSet >

virtual void itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::SetInput ( unsigned  int, const InputSpatialObjectType *  object  )

virtual

template<class TInputSpatialObject , class TOutputPointSet >

virtual void itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::SetSamplingFactor ( unsigned int  _arg )

virtual

---

Member Data Documentation

template<class TInputSpatialObject , class TOutputPointSet >

unsigned int itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::m_ChildrenDepth

protected

Definition at line 97 of file itkSpatialObjectToPointSetFilter.h.

template<class TInputSpatialObject , class TOutputPointSet >

unsigned int itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::m_SamplingFactor

private

Definition at line 105 of file itkSpatialObjectToPointSetFilter.h.

template<class TInputSpatialObject , class TOutputPointSet >

const unsigned int itk::SpatialObjectToPointSetFilter< TInputSpatialObject, TOutputPointSet >::ObjectDimension = InputSpatialObjectType::ObjectDimension

static

Dimension constants

Definition at line 63 of file itkSpatialObjectToPointSetFilter.h.

---

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

• itkSpatialObjectToPointSetFilter.h