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

#include <itkImageToMeshFilter.h>

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.

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

Public Types

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

Public Member Functions

void GenerateOutputInformation () override
 
OutputMeshTypeGetOutput ()
 
 itkOverrideGetNameOfClassMacro (ImageToMeshFilter)
 
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 >
OutputMeshTypeGetOutput ()
 
OutputMeshTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftOutput (DataObject *graft)
 
 itkOverrideGetNameOfClassMacro (MeshSource)
 
void SetOutput (TOutputMesh *output)
 
DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
 itkOverrideGetNameOfClassMacro (ProcessObject)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
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
 
 itkOverrideGetNameOfClassMacro (Object)
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkVirtualGetNameOfClassMacro (LightObject)
 
void Print (std::ostream &os, Indent indent=0) const
 

Protected Member Functions

 ImageToMeshFilter ()
 
 ~ImageToMeshFilter () override=default
 
- Protected Member Functions inherited from itk::MeshSource< TOutputMesh >
void GenerateInputRequestedRegion () override
 
 MeshSource ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~MeshSource () override=default
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
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 DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
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 idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- 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 ()
 

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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 45 of file itkImageToMeshFilter.h.

◆ DataObjectPointerArraySizeType

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

Create a valid output.

Definition at line 51 of file itkImageToMeshFilter.h.

◆ InputImageConstPointer

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

Definition at line 59 of file itkImageToMeshFilter.h.

◆ InputImagePixelType

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

Definition at line 61 of file itkImageToMeshFilter.h.

◆ InputImagePointer

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

Definition at line 58 of file itkImageToMeshFilter.h.

◆ InputImageRegionType

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

Definition at line 60 of file itkImageToMeshFilter.h.

◆ InputImageType

template<typename TInputImage, typename TOutputMesh>
using itk::ImageToMeshFilter< TInputImage, TOutputMesh >::InputImageType = TInputImage

Some Image related type alias.

Definition at line 57 of file itkImageToMeshFilter.h.

◆ OutputMeshPointer

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

Definition at line 65 of file itkImageToMeshFilter.h.

◆ OutputMeshType

template<typename TInputImage, typename TOutputMesh>
using itk::ImageToMeshFilter< TInputImage, TOutputMesh >::OutputMeshType = TOutputMesh

Some Mesh related type alias.

Definition at line 64 of file itkImageToMeshFilter.h.

◆ Pointer

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

Definition at line 44 of file itkImageToMeshFilter.h.

◆ Self

template<typename TInputImage, typename TOutputMesh>
using itk::ImageToMeshFilter< TInputImage, TOutputMesh >::Self = ImageToMeshFilter

Standard class type aliases.

Definition at line 42 of file itkImageToMeshFilter.h.

◆ Superclass

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

Definition at line 43 of file itkImageToMeshFilter.h.

Constructor & Destructor Documentation

◆ ImageToMeshFilter()

template<typename TInputImage, typename TOutputMesh>
itk::ImageToMeshFilter< TInputImage, TOutputMesh >::ImageToMeshFilter ( )
protected

◆ ~ImageToMeshFilter()

template<typename TInputImage, typename TOutputMesh>
itk::ImageToMeshFilter< TInputImage, TOutputMesh >::~ImageToMeshFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ GenerateOutputInformation()

template<typename TInputImage, typename TOutputMesh>
void itk::ImageToMeshFilter< TInputImage, TOutputMesh >::GenerateOutputInformation ( )
overridevirtual

◆ GetInput() [1/2]

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

Get the input image of this process object.

Definition at line 82 of file itkImageToMeshFilter.h.

◆ GetInput() [2/2]

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

Get the input image of this process object.

◆ GetOutput()

template<typename TInputImage, typename TOutputMesh>
OutputMeshType* itk::ImageToMeshFilter< TInputImage, TOutputMesh >::GetOutput ( )

Get the output Mesh of this process object.

◆ itkOverrideGetNameOfClassMacro()

template<typename TInputImage, typename TOutputMesh>
itk::ImageToMeshFilter< TInputImage, TOutputMesh >::itkOverrideGetNameOfClassMacro ( ImageToMeshFilter< TInputImage, TOutputMesh >  )

Run-time type information (and related methods).

◆ MakeOutput()

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 itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

◆ SetInput() [1/2]

template<typename TInputImage, typename TOutputMesh>
void itk::ImageToMeshFilter< TInputImage, TOutputMesh >::SetInput ( const InputImageType input)
inline

Definition at line 72 of file itkImageToMeshFilter.h.

◆ SetInput() [2/2]

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

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