ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::MetaConverterBase< VDimension > Class Template Referenceabstract
Group Core » Module ITKSpatialObjects

#include <itkMetaConverterBase.h>

Detailed Description

template<unsigned int VDimension = 3>
class itk::MetaConverterBase< VDimension >

Base class for MetaObject<->SpatialObject converters.

SpatialObject scenes are written and read using the MetaIO Library. This is managed by the MetaSceneConverter class, which converts MetaObject scenes to SpatialObject scenes and vice versa.

MetaScene walks the scene and uses the converter on each object in the scene.

Definition at line 42 of file itkMetaConverterBase.h.

+ Inheritance diagram for itk::MetaConverterBase< VDimension >:
+ Collaboration diagram for itk::MetaConverterBase< VDimension >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using MetaObjectType = MetaObject
 
using Pointer = SmartPointer< Self >
 
using Self = MetaConverterBase
 
using SpatialObjectConstPointer = typename SpatialObjectType::ConstPointer
 
using SpatialObjectPointer = typename SpatialObjectType::Pointer
 
using SpatialObjectType = SpatialObject< VDimension >
 
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

virtual unsigned int GetMetaIOVersion () const
 
const char * GetNameOfClass () const override
 
virtual SpatialObjectPointer MetaObjectToSpatialObject (const MetaObjectType *mo)=0
 
void MetaObjectToSpatialObjectBase (const MetaObjectType *mo, SpatialObjectPointer spatialObject)
 
virtual SpatialObjectPointer ReadMeta (const char *name)
 
virtual void SetMetaIOVersion (unsigned int _arg)
 
virtual MetaObjectType * SpatialObjectToMetaObject (const SpatialObjectType *spatialObject)=0
 
void SpatialObjectToMetaObjectBase (SpatialObjectConstPointer spatialObject, MetaObjectType *mo)
 
virtual bool WriteMeta (const SpatialObjectType *spatialObject, const char *name)
 
virtual void SetWriteImagesInSeparateFile (bool _arg)
 
virtual bool GetWriteImagesInSeparateFile () const
 
virtual void WriteImagesInSeparateFileOn ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) 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
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStamp & GetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag) const
 
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 Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Protected Member Functions

virtual MetaObjectType * CreateMetaObject ()=0
 
 MetaConverterBase ()=default
 
 ~MetaConverterBase () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
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 PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

unsigned int m_MetaIOVersion { 0 }
 
bool m_WriteImagesInSeparateFile { false }
 

Additional Inherited Members

- 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 ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<unsigned int VDimension = 3>
using itk::MetaConverterBase< VDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 50 of file itkMetaConverterBase.h.

◆ MetaObjectType

template<unsigned int VDimension = 3>
using itk::MetaConverterBase< VDimension >::MetaObjectType = MetaObject

Definition at line 58 of file itkMetaConverterBase.h.

◆ Pointer

template<unsigned int VDimension = 3>
using itk::MetaConverterBase< VDimension >::Pointer = SmartPointer<Self>

Definition at line 49 of file itkMetaConverterBase.h.

◆ Self

template<unsigned int VDimension = 3>
using itk::MetaConverterBase< VDimension >::Self = MetaConverterBase

standard class type alias

Definition at line 47 of file itkMetaConverterBase.h.

◆ SpatialObjectConstPointer

template<unsigned int VDimension = 3>
using itk::MetaConverterBase< VDimension >::SpatialObjectConstPointer = typename SpatialObjectType::ConstPointer

Definition at line 57 of file itkMetaConverterBase.h.

◆ SpatialObjectPointer

template<unsigned int VDimension = 3>
using itk::MetaConverterBase< VDimension >::SpatialObjectPointer = typename SpatialObjectType::Pointer

Definition at line 56 of file itkMetaConverterBase.h.

◆ SpatialObjectType

template<unsigned int VDimension = 3>
using itk::MetaConverterBase< VDimension >::SpatialObjectType = SpatialObject<VDimension>

Definition at line 55 of file itkMetaConverterBase.h.

◆ Superclass

template<unsigned int VDimension = 3>
using itk::MetaConverterBase< VDimension >::Superclass = Object

Definition at line 48 of file itkMetaConverterBase.h.

Constructor & Destructor Documentation

◆ MetaConverterBase()

template<unsigned int VDimension = 3>
itk::MetaConverterBase< VDimension >::MetaConverterBase ( )
protecteddefault

◆ ~MetaConverterBase()

template<unsigned int VDimension = 3>
itk::MetaConverterBase< VDimension >::~MetaConverterBase ( )
overrideprotecteddefault

Member Function Documentation

◆ CreateMetaObject()

template<unsigned int VDimension = 3>
virtual MetaObjectType * itk::MetaConverterBase< VDimension >::CreateMetaObject ( )
protectedpure virtual

Creator for specific metaObject, defined in subclass

Implemented in itk::MetaArrowConverter< VDimension >, itk::MetaBlobConverter< VDimension >, itk::MetaContourConverter< VDimension >, itk::MetaDTITubeConverter< VDimension >, itk::MetaEllipseConverter< VDimension >, itk::MetaGaussianConverter< VDimension >, itk::MetaGroupConverter< VDimension >, itk::MetaImageConverter< VDimension, TPixel, TSpatialObjectType >, itk::MetaImageConverter< 3, unsigned char, ImageMaskSpatialObject< 3 > >, itk::MetaLandmarkConverter< VDimension >, itk::MetaLineConverter< VDimension >, itk::MetaMeshConverter< VDimension, PixelType, TMeshTraits >, itk::MetaSurfaceConverter< VDimension >, itk::MetaTubeConverter< VDimension >, and itk::MetaVesselTubeConverter< VDimension >.

◆ GetMetaIOVersion()

template<unsigned int VDimension = 3>
virtual unsigned int itk::MetaConverterBase< VDimension >::GetMetaIOVersion ( ) const
virtual

◆ GetNameOfClass()

template<unsigned int VDimension = 3>
const char * itk::MetaConverterBase< VDimension >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

Reimplemented in itk::MetaImageConverter< 3, unsigned char, ImageMaskSpatialObject< 3 > >.

◆ GetWriteImagesInSeparateFile()

template<unsigned int VDimension = 3>
virtual bool itk::MetaConverterBase< VDimension >::GetWriteImagesInSeparateFile ( ) const
virtual

Set/Get flag for writing images to separate files in metaImage instances

◆ MetaObjectToSpatialObject()

template<unsigned int VDimension = 3>
virtual SpatialObjectPointer itk::MetaConverterBase< VDimension >::MetaObjectToSpatialObject ( const MetaObjectType *  mo)
pure virtual

Convert the MetaObject to Spatial Object

Implemented in itk::MetaArrowConverter< VDimension >, itk::MetaBlobConverter< VDimension >, itk::MetaContourConverter< VDimension >, itk::MetaDTITubeConverter< VDimension >, itk::MetaEllipseConverter< VDimension >, itk::MetaGaussianConverter< VDimension >, itk::MetaGroupConverter< VDimension >, itk::MetaImageConverter< VDimension, TPixel, TSpatialObjectType >, itk::MetaImageConverter< 3, unsigned char, ImageMaskSpatialObject< 3 > >, itk::MetaLandmarkConverter< VDimension >, itk::MetaLineConverter< VDimension >, itk::MetaMeshConverter< VDimension, PixelType, TMeshTraits >, itk::MetaSurfaceConverter< VDimension >, itk::MetaTubeConverter< VDimension >, and itk::MetaVesselTubeConverter< VDimension >.

◆ MetaObjectToSpatialObjectBase()

template<unsigned int VDimension = 3>
void itk::MetaConverterBase< VDimension >::MetaObjectToSpatialObjectBase ( const MetaObjectType *  mo,
SpatialObjectPointer  spatialObject 
)

◆ ReadMeta()

template<unsigned int VDimension = 3>
virtual SpatialObjectPointer itk::MetaConverterBase< VDimension >::ReadMeta ( const char *  name)
virtual

Read a MetaIO file, return a SpatialObject

◆ SetMetaIOVersion()

template<unsigned int VDimension = 3>
virtual void itk::MetaConverterBase< VDimension >::SetMetaIOVersion ( unsigned int  _arg)
virtual

◆ SetWriteImagesInSeparateFile()

template<unsigned int VDimension = 3>
virtual void itk::MetaConverterBase< VDimension >::SetWriteImagesInSeparateFile ( bool  _arg)
virtual

Set/Get flag for writing images to separate files in metaImage instances

◆ SpatialObjectToMetaObject()

template<unsigned int VDimension = 3>
virtual MetaObjectType * itk::MetaConverterBase< VDimension >::SpatialObjectToMetaObject ( const SpatialObjectType *  spatialObject)
pure virtual

Convert the SpatialObject to MetaObject

Implemented in itk::MetaContourConverter< VDimension >, itk::MetaEllipseConverter< VDimension >, itk::MetaGaussianConverter< VDimension >, itk::MetaGroupConverter< VDimension >, itk::MetaImageConverter< VDimension, TPixel, TSpatialObjectType >, itk::MetaImageConverter< 3, unsigned char, ImageMaskSpatialObject< 3 > >, itk::MetaLandmarkConverter< VDimension >, itk::MetaMeshConverter< VDimension, PixelType, TMeshTraits >, itk::MetaSurfaceConverter< VDimension >, itk::MetaVesselTubeConverter< VDimension >, itk::MetaArrowConverter< VDimension >, itk::MetaBlobConverter< VDimension >, itk::MetaDTITubeConverter< VDimension >, itk::MetaLineConverter< VDimension >, and itk::MetaTubeConverter< VDimension >.

◆ SpatialObjectToMetaObjectBase()

template<unsigned int VDimension = 3>
void itk::MetaConverterBase< VDimension >::SpatialObjectToMetaObjectBase ( SpatialObjectConstPointer  spatialObject,
MetaObjectType *  mo 
)

◆ WriteImagesInSeparateFileOn()

template<unsigned int VDimension = 3>
virtual void itk::MetaConverterBase< VDimension >::WriteImagesInSeparateFileOn ( )
virtual

Set/Get flag for writing images to separate files in metaImage instances

◆ WriteMeta()

template<unsigned int VDimension = 3>
virtual bool itk::MetaConverterBase< VDimension >::WriteMeta ( const SpatialObjectType *  spatialObject,
const char *  name 
)
virtual

Write a MetaIO file based on this SpatialObject

Member Data Documentation

◆ m_MetaIOVersion

template<unsigned int VDimension = 3>
unsigned int itk::MetaConverterBase< VDimension >::m_MetaIOVersion { 0 }
private

Definition at line 104 of file itkMetaConverterBase.h.

◆ m_WriteImagesInSeparateFile

template<unsigned int VDimension = 3>
bool itk::MetaConverterBase< VDimension >::m_WriteImagesInSeparateFile { false }
private

Definition at line 103 of file itkMetaConverterBase.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3