ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
itk::ImageToMeshFilter< TInputImage, TOutputMesh > Class Template Reference

#include <itkImageToMeshFilter.h>

+ Inheritance diagram for itk::ImageToMeshFilter< TInputImage, TOutputMesh >:
+ Collaboration diagram for itk::ImageToMeshFilter< TInputImage, TOutputMesh >:

Detailed Description

template<typename TInputImage, typename TOutputMesh>
class itk::ImageToMeshFilter< TInputImage, TOutputMesh >

ImageToMeshFilter is the base class for all process objects that output Mesh data and require image data as input. Specifically, this class defines the SetInput() method for defining the input to a filter.

Definition at line 36 of file itkImageToMeshFilter.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
ProcessObject::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef InputImageType::PixelType InputImagePixelType
 
typedef InputImageType::Pointer InputImagePointer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef OutputMeshType::Pointer OutputMeshPointer
 
typedef TOutputMesh OutputMeshType
 
typedef SmartPointer< SelfPointer
 
typedef ImageToMeshFilter Self
 
typedef MeshSource< TOutputMesh > Superclass
 
- Public Types inherited from itk::MeshSource< TOutputMesh >
typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef OutputMeshType::Pointer OutputMeshPointer
 
typedef TOutputMesh OutputMeshType
 
typedef SmartPointer< SelfPointer
 
typedef MeshSource Self
 
typedef ProcessObject Superclass
 
typedef
ProcessObject::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

void GenerateOutputInformation () override
 
virtual const char * GetNameOfClass () const
 
OutputMeshTypeGetOutput ()
 
DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
void SetInput (unsigned int idx, const InputImageType *input)
 
void SetInput (const InputImageType *input)
 
const InputImageTypeGetInput (unsigned int idx)
 
const InputImageTypeGetInput ()
 
- Public Member Functions inherited from itk::MeshSource< TOutputMesh >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
OutputMeshTypeGetOutput ()
 
OutputMeshTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
void SetOutput (TOutputMesh *output)
 
virtual void GraftOutput (DataObject *output)
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
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 Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () 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
 

Protected Member Functions

 ImageToMeshFilter ()
 
 ~ImageToMeshFilter ()
 
- Protected Member Functions inherited from itk::MeshSource< TOutputMesh >
virtual void GenerateInputRequestedRegion () override
 
 MeshSource ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual ~MeshSource ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateData ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
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 ()
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- 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 ()
 

Private Member Functions

 ImageToMeshFilter (const ImageToMeshFilter &)
 
void operator= (const ImageToMeshFilter &)
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::MeshSource< TOutputMesh >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TInputImage, typename TOutputMesh>
typedef SmartPointer< const Self > itk::ImageToMeshFilter< TInputImage, TOutputMesh >::ConstPointer

Definition at line 43 of file itkImageToMeshFilter.h.

template<typename TInputImage, typename TOutputMesh>
typedef ProcessObject::DataObjectPointerArraySizeType itk::ImageToMeshFilter< TInputImage, TOutputMesh >::DataObjectPointerArraySizeType

Create a valid output.

Definition at line 46 of file itkImageToMeshFilter.h.

template<typename TInputImage, typename TOutputMesh>
typedef InputImageType::ConstPointer itk::ImageToMeshFilter< TInputImage, TOutputMesh >::InputImageConstPointer

Definition at line 56 of file itkImageToMeshFilter.h.

template<typename TInputImage, typename TOutputMesh>
typedef InputImageType::PixelType itk::ImageToMeshFilter< TInputImage, TOutputMesh >::InputImagePixelType

Definition at line 58 of file itkImageToMeshFilter.h.

template<typename TInputImage, typename TOutputMesh>
typedef InputImageType::Pointer itk::ImageToMeshFilter< TInputImage, TOutputMesh >::InputImagePointer

Definition at line 55 of file itkImageToMeshFilter.h.

template<typename TInputImage, typename TOutputMesh>
typedef InputImageType::RegionType itk::ImageToMeshFilter< TInputImage, TOutputMesh >::InputImageRegionType

Definition at line 57 of file itkImageToMeshFilter.h.

template<typename TInputImage, typename TOutputMesh>
typedef TInputImage itk::ImageToMeshFilter< TInputImage, TOutputMesh >::InputImageType

Some Image related typedefs.

Definition at line 54 of file itkImageToMeshFilter.h.

template<typename TInputImage, typename TOutputMesh>
typedef OutputMeshType::Pointer itk::ImageToMeshFilter< TInputImage, TOutputMesh >::OutputMeshPointer

Definition at line 62 of file itkImageToMeshFilter.h.

template<typename TInputImage, typename TOutputMesh>
typedef TOutputMesh itk::ImageToMeshFilter< TInputImage, TOutputMesh >::OutputMeshType

Some Mesh related typedefs.

Definition at line 61 of file itkImageToMeshFilter.h.

template<typename TInputImage, typename TOutputMesh>
typedef SmartPointer< Self > itk::ImageToMeshFilter< TInputImage, TOutputMesh >::Pointer

Definition at line 42 of file itkImageToMeshFilter.h.

template<typename TInputImage, typename TOutputMesh>
typedef ImageToMeshFilter itk::ImageToMeshFilter< TInputImage, TOutputMesh >::Self

Standard class typedefs.

Definition at line 40 of file itkImageToMeshFilter.h.

template<typename TInputImage, typename TOutputMesh>
typedef MeshSource< TOutputMesh > itk::ImageToMeshFilter< TInputImage, TOutputMesh >::Superclass

Definition at line 41 of file itkImageToMeshFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage, typename TOutputMesh>
itk::ImageToMeshFilter< TInputImage, TOutputMesh >::ImageToMeshFilter ( )
protected
template<typename TInputImage, typename TOutputMesh>
itk::ImageToMeshFilter< TInputImage, TOutputMesh >::~ImageToMeshFilter ( )
protected
template<typename TInputImage, typename TOutputMesh>
itk::ImageToMeshFilter< TInputImage, TOutputMesh >::ImageToMeshFilter ( const ImageToMeshFilter< TInputImage, TOutputMesh > &  )
private

Member Function Documentation

template<typename TInputImage, typename TOutputMesh>
void itk::ImageToMeshFilter< TInputImage, TOutputMesh >::GenerateOutputInformation ( )
overridevirtual
template<typename TInputImage, typename TOutputMesh>
const InputImageType* itk::ImageToMeshFilter< TInputImage, TOutputMesh >::GetInput ( unsigned int  idx)

Get the input image of this process object.

template<typename TInputImage, typename TOutputMesh>
const InputImageType* itk::ImageToMeshFilter< TInputImage, TOutputMesh >::GetInput ( )
inline

Get the input image of this process object.

Definition at line 75 of file itkImageToMeshFilter.h.

Referenced by itk::ImageToMeshFilter< TImage, TFeatures >::GetInput().

template<typename TInputImage, typename TOutputMesh>
virtual const char* itk::ImageToMeshFilter< TInputImage, TOutputMesh >::GetNameOfClass ( ) const
virtual
template<typename TInputImage, typename TOutputMesh>
OutputMeshType* itk::ImageToMeshFilter< TInputImage, TOutputMesh >::GetOutput ( )

Get the output Mesh of this process object.

template<typename TInputImage, typename TOutputMesh>
DataObject::Pointer itk::ImageToMeshFilter< TInputImage, TOutputMesh >::MakeOutput ( DataObjectPointerArraySizeType  idx)
overridevirtual

Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a SmartPointer to a DataObject. If a subclass of MeshSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().

Reimplemented from itk::MeshSource< TOutputMesh >.

template<typename TInputImage, typename TOutputMesh>
void itk::ImageToMeshFilter< TInputImage, TOutputMesh >::operator= ( const ImageToMeshFilter< TInputImage, TOutputMesh > &  )
private
template<typename TInputImage, typename TOutputMesh>
void itk::ImageToMeshFilter< TInputImage, TOutputMesh >::SetInput ( unsigned int  idx,
const InputImageType input 
)
template<typename TInputImage, typename TOutputMesh>
void itk::ImageToMeshFilter< TInputImage, TOutputMesh >::SetInput ( const InputImageType input)
inline

Definition at line 67 of file itkImageToMeshFilter.h.


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