ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | List of all members
itk::SpatialObjectReader< NDimensions, PixelType, TMeshTraits > Class Template Reference
Group IO » Module ITKIOSpatialObjects

#include <itkSpatialObjectReader.h>

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

Public Types

using GroupPointer = typename GroupType::Pointer
 
using GroupType = GroupSpatialObject< NDimensions >
 
using MetaConverterBaseType = MetaConverterBase< NDimensions >
 
using MetaSceneConverterType = MetaSceneConverter< NDimensions, PixelType, TMeshTraits >
 
using Pointer = SmartPointer< Self >
 
using Self = SpatialObjectReader
 
using SpatialObjectPointer = typename SpatialObjectType::Pointer
 
using SpatialObjectType = SpatialObject< NDimensions >
 
- 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 ::itk::LightObject::Pointer CreateAnother () 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
 
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
 
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)
 
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
 
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 ()
 
using Superclass = Object
 
std::string m_FileName
 
GroupPointer m_Group
 
SpatialObjectPointer m_SpatialObject
 
MetaSceneConverterType::Pointer m_MetaToSpatialConverter
 
virtual const char * GetNameOfClass () const
 
void Update ()
 
virtual void SetFileName (const char *_arg)
 
virtual const char * GetFileName () const
 
SpatialObjectPointer GetOutput ()
 
GroupPointer GetGroup ()
 
const MetaEvent * GetEvent ()
 
void SetEvent (MetaEvent *event)
 
void RegisterMetaConverter (const char *metaTypeName, const char *spatialObjectTypeName, MetaConverterBaseType *converter)
 
 SpatialObjectReader ()
 
 ~SpatialObjectReader () override=default
 

Additional Inherited Members

- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
- 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 inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

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

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

Definition at line 36 of file itkSpatialObjectReader.h.

Member Typedef Documentation

◆ GroupPointer

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

Definition at line 47 of file itkSpatialObjectReader.h.

◆ GroupType

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

Definition at line 46 of file itkSpatialObjectReader.h.

◆ MetaConverterBaseType

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

base type for MetaConverters – bidirections conversion btw SpatialObject & MetaObject

Definition at line 52 of file itkSpatialObjectReader.h.

◆ MetaSceneConverterType

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

Definition at line 53 of file itkSpatialObjectReader.h.

◆ Pointer

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

Definition at line 43 of file itkSpatialObjectReader.h.

◆ Self

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

SmartPointer type alias support

Definition at line 42 of file itkSpatialObjectReader.h.

◆ SpatialObjectPointer

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

Definition at line 45 of file itkSpatialObjectReader.h.

◆ SpatialObjectType

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

Definition at line 44 of file itkSpatialObjectReader.h.

◆ Superclass

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
using itk::SpatialObjectReader< NDimensions, 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 NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
itk::SpatialObjectReader< NDimensions, PixelType, TMeshTraits >::SpatialObjectReader ( )
protected

Run-time type information (and related methods).

◆ ~SpatialObjectReader()

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

Run-time type information (and related methods).

Member Function Documentation

◆ CreateAnother()

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
virtual::itk::LightObject::Pointer itk::SpatialObjectReader< NDimensions, PixelType, TMeshTraits >::CreateAnother ( ) 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::Object.

◆ GetEvent()

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

Set/GetEvent

Definition at line 104 of file itkSpatialObjectReader.h.

◆ GetFileName()

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

Get the filename

◆ GetGroup()

template<unsigned int NDimensions = 3, typename PixelType = unsigned char, typename TMeshTraits = DefaultStaticMeshTraits<PixelType, NDimensions, NDimensions>>
GroupPointer itk::SpatialObjectReader< NDimensions, 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.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::Object.

◆ GetOutput()

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

Get the output

Definition at line 75 of file itkSpatialObjectReader.h.

◆ New()

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

Method for creation through the object factory

◆ RegisterMetaConverter()

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

Add a converter for a new MetaObject/SpatialObject type

◆ SetEvent()

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

Run-time type information (and related methods).

Definition at line 110 of file itkSpatialObjectReader.h.

◆ SetFileName()

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

Set the filename

◆ Update()

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

Load a scene file.

Member Data Documentation

◆ m_FileName

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

Run-time type information (and related methods).

Definition at line 122 of file itkSpatialObjectReader.h.

◆ m_Group

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

Run-time type information (and related methods).

Definition at line 128 of file itkSpatialObjectReader.h.

◆ m_MetaToSpatialConverter

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

Run-time type information (and related methods).

Definition at line 132 of file itkSpatialObjectReader.h.

◆ m_SpatialObject

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

Run-time type information (and related methods).

Definition at line 130 of file itkSpatialObjectReader.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.
Generated on Thu Apr 1 2021 02:33:17 for ITK by   doxygen 1.8.16