ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits > Class Template Reference

#include <itkSpatialObjectReader.h>

Detailed Description

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
class itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >

Examples
Examples/SpatialObjects/MeshSpatialObject.cxx, and Examples/SpatialObjects/ReadWriteSpatialObject.cxx.

Definition at line 36 of file itkSpatialObjectReader.h.

+ Inheritance diagram for itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >:
+ Collaboration diagram for itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >:

Public Types

using GroupPointer = typename GroupType::Pointer
 
using GroupType = GroupSpatialObject< VDimension >
 
using MetaConverterBaseType = MetaConverterBase< VDimension >
 
using MetaSceneConverterType = MetaSceneConverter< VDimension, PixelType, TMeshTraits >
 
using Pointer = SmartPointer< Self >
 
using Self = SpatialObjectReader
 
using SpatialObjectPointer = typename SpatialObjectType::Pointer
 
using SpatialObjectType = SpatialObject< VDimension >
 
- 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

const MetaEventGetEvent ()
 
virtual const char * GetFileName () const
 
SpatialObjectPointer GetOutput ()
 
void RegisterMetaConverter (const char *metaTypeName, const char *spatialObjectTypeName, MetaConverterBaseType *converter)
 
void SetEvent (MetaEvent *event)
 
virtual void SetFileName (const char *_arg)
 
void Update ()
 
GroupPointer GetGroup ()
 
- 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
 

Static Public Member Functions

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

Protected Member Functions

 SpatialObjectReader ()
 
 ~SpatialObjectReader () 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 PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

std::string m_FileName {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Private Attributes

GroupPointer m_Group {}
 
MetaSceneConverterType::Pointer m_MetaToSpatialConverter {}
 
SpatialObjectPointer m_SpatialObject {}
 
using Superclass = Object
 
 itkOverrideGetNameOfClassMacro (SpatialObjectReader)
 

Member Typedef Documentation

◆ GroupPointer

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
using itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::GroupPointer = typename GroupType::Pointer

Definition at line 47 of file itkSpatialObjectReader.h.

◆ GroupType

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
using itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::GroupType = GroupSpatialObject<VDimension>

Definition at line 46 of file itkSpatialObjectReader.h.

◆ MetaConverterBaseType

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
using itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::MetaConverterBaseType = MetaConverterBase<VDimension>

base type for MetaConverters – bidirectional conversion btw SpatialObject & MetaObject

Definition at line 52 of file itkSpatialObjectReader.h.

◆ MetaSceneConverterType

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
using itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::MetaSceneConverterType = MetaSceneConverter<VDimension, PixelType, TMeshTraits>

Definition at line 53 of file itkSpatialObjectReader.h.

◆ Pointer

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
using itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::Pointer = SmartPointer<Self>

Definition at line 43 of file itkSpatialObjectReader.h.

◆ Self

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
using itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::Self = SpatialObjectReader

SmartPointer type alias support

Definition at line 42 of file itkSpatialObjectReader.h.

◆ SpatialObjectPointer

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
using itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::SpatialObjectPointer = typename SpatialObjectType::Pointer

Definition at line 45 of file itkSpatialObjectReader.h.

◆ SpatialObjectType

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
using itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::SpatialObjectType = SpatialObject<VDimension>

Definition at line 44 of file itkSpatialObjectReader.h.

◆ Superclass

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
using itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::Superclass = Object

Run-time type information (and related methods).

Definition at line 59 of file itkSpatialObjectReader.h.

Constructor & Destructor Documentation

◆ SpatialObjectReader()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::SpatialObjectReader ( )
protected

◆ ~SpatialObjectReader()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::~SpatialObjectReader ( )
overrideprotecteddefault

Member Function Documentation

◆ GetEvent()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
const MetaEvent* itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::GetEvent ( )
inline

Set/GetEvent

Definition at line 104 of file itkSpatialObjectReader.h.

◆ GetFileName()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
virtual const char* itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::GetFileName ( ) const
virtual

Get the filename

◆ GetGroup()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
GroupPointer itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::GetGroup ( )
inline

Get the output, with a group spatial object added to the top. This addition makes it easy to use GetChildren() to get the list of objects read.

Definition at line 84 of file itkSpatialObjectReader.h.

References New().

◆ GetOutput()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
SpatialObjectPointer itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::GetOutput ( )
inline

Get the output

Definition at line 75 of file itkSpatialObjectReader.h.

◆ itkOverrideGetNameOfClassMacro()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::itkOverrideGetNameOfClassMacro ( SpatialObjectReader< VDimension, PixelType, TMeshTraits >  )

Run-time type information (and related methods).

◆ New()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
static Pointer itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::New ( )
static

Method for creation through the object factory

◆ RegisterMetaConverter()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
void itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::RegisterMetaConverter ( const char *  metaTypeName,
const char *  spatialObjectTypeName,
MetaConverterBaseType converter 
)

Add a converter for a new MetaObject/SpatialObject type

◆ SetEvent()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
void itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::SetEvent ( MetaEvent event)
inline

Definition at line 110 of file itkSpatialObjectReader.h.

◆ SetFileName()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
virtual void itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::SetFileName ( const char *  _arg)
virtual

Set the filename

◆ Update()

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
void itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::Update ( )

Load a scene file.

Member Data Documentation

◆ m_FileName

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
std::string itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::m_FileName {}
protected

Definition at line 122 of file itkSpatialObjectReader.h.

◆ m_Group

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
GroupPointer itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::m_Group {}
private

Definition at line 128 of file itkSpatialObjectReader.h.

◆ m_MetaToSpatialConverter

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
MetaSceneConverterType::Pointer itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::m_MetaToSpatialConverter {}
private

Definition at line 132 of file itkSpatialObjectReader.h.

◆ m_SpatialObject

template<unsigned int VDimension = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, VDimension, VDimension>>
SpatialObjectPointer itk::SpatialObjectReader< VDimension, PixelType, TMeshTraits >::m_SpatialObject {}
private

Definition at line 130 of file itkSpatialObjectReader.h.


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