IGSTK
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
igstk::SpatialObjectReader< TDimension, TPixelType > Class Template Reference

This class reads spatial object data stored in files. More...

#include <igstkSpatialObjectReader.h>

Inheritance diagram for igstk::SpatialObjectReader< TDimension, TPixelType >:
Inheritance graph
[legend]
Collaboration diagram for igstk::SpatialObjectReader< TDimension, TPixelType >:
Collaboration graph
[legend]

Public Types

typedef
::itk::DefaultDynamicMeshTraits
< TPixelType, TDimension,
TDimension > 
MeshTraitsType
typedef
::itk::SpatialObjectReader
< TDimension, TPixelType,
MeshTraitsType
SpatialObjectReaderType
typedef ::itk::SpatialObject
< TDimension > 
SpatialObjectType
typedef
::itk::GroupSpatialObject
< TDimension > 
GroupSpatialObjectType
typedef std::string FileNameType
 Type for representing the string of the filename.
- Public Types inherited from igstk::Object
typedef Object Self
 General Typedefs.
typedef ::itk::Object Superclass
typedef ::itk::SmartPointer< SelfPointer
typedef ::itk::SmartPointer
< const Self
ConstPointer
typedef igstk::Logger LoggerType

Public Member Functions

void RequestSetFileName (const FileNameType &filename)
 Method to pass the directory name containing the spatial object data.
void RequestReadObject ()
 This method request Object read.
void RequestGetOutput ()
 This method will invoke a event from derived reader class, such as: MeshModifiedEvent for igstkMeshReader TubeModifiedEvent for igstkTubeReader.
 igstkEventMacro (ObjectReaderEvent, IGSTKEvent)
 igstkEventMacro (ObjectReadingErrorEvent, IGSTKErrorEvent)
 igstkEventMacro (ObjectReadingSuccessEvent, ObjectReaderEvent)
 igstkEventMacro (ObjectInvalidRequestErrorEvent, ObjectReadingErrorEvent)
- Public Member Functions inherited from igstk::Object
virtual const char * GetNameOfClass () const
void SetLogger (LoggerType *logger)
 Connect the Logger for this class.
void RemoveObserver (unsigned long tag) const

Public Attributes

igstkStandardTemplatedClassTraitsMacro(SpatialObjectReader,
Object) public typedef
TPixelType 
PixelType
 Macro with standard traits declarations.

Protected Member Functions

 SpatialObjectReader (void)
virtual ~SpatialObjectReader (void)
void PrintSelf (std::ostream &os,::itk::Indent indent) const
 Print the object information in a stream.
virtual void AttemptReadObjectProcessing ()
virtual void ReportObjectProcessing ()
- Protected Member Functions inherited from igstk::Object
LoggerTypeGetLogger () const
 Object (void)
 Constructor is protected in order to enforce the use of the New() operator.
virtual ~Object (void)
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information.
void RegisterObservedObject (const ::igstk::Object *object, unsigned long tag)
 Register observed objects in an internal array so that they can be disconnected upon destruction.
void RemoveFromObservedObjects ()
 Remove observers that this object may have connected to other objects.

Protected Attributes

SpatialObjectReaderType::Pointer m_SpatialObjectReader
std::string m_FileNameToBeSet
std::string m_FileName

Additional Inherited Members

- Static Public Member Functions inherited from igstk::Object
static Pointer New (void)

Detailed Description

template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
class igstk::SpatialObjectReader< TDimension, TPixelType >

This class reads spatial object data stored in files.

This class reads spatial object data stored in files and provide pointers to the spatial object data for use in an ITK pipeline. This class is template over the dimension of the object to read

igstkSpatialObjectReader.png

"Spatial Object Reader State Machine Diagram"

"Spatial Object Reader State Machine Diagram"

Definition at line 51 of file igstkSpatialObjectReader.h.

Member Typedef Documentation

template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
typedef ::itk::DefaultDynamicMeshTraits< TPixelType , TDimension, TDimension> igstk::SpatialObjectReader< TDimension, TPixelType >::MeshTraitsType

Definition at line 67 of file igstkSpatialObjectReader.h.

template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
typedef ::itk::SpatialObjectReader< TDimension, TPixelType, MeshTraitsType > igstk::SpatialObjectReader< TDimension, TPixelType >::SpatialObjectReaderType

Definition at line 71 of file igstkSpatialObjectReader.h.

template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
typedef ::itk::SpatialObject<TDimension> igstk::SpatialObjectReader< TDimension, TPixelType >::SpatialObjectType

Definition at line 73 of file igstkSpatialObjectReader.h.

template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
typedef ::itk::GroupSpatialObject<TDimension> igstk::SpatialObjectReader< TDimension, TPixelType >::GroupSpatialObjectType

Definition at line 74 of file igstkSpatialObjectReader.h.

template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
typedef std::string igstk::SpatialObjectReader< TDimension, TPixelType >::FileNameType

Type for representing the string of the filename.

Definition at line 77 of file igstkSpatialObjectReader.h.

Constructor & Destructor Documentation

template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
igstk::SpatialObjectReader< TDimension, TPixelType >::SpatialObjectReader ( void  )
protected
template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
virtual igstk::SpatialObjectReader< TDimension, TPixelType >::~SpatialObjectReader ( void  )
protectedvirtual

Member Function Documentation

template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
void igstk::SpatialObjectReader< TDimension, TPixelType >::RequestSetFileName ( const FileNameType filename)

Method to pass the directory name containing the spatial object data.

template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
void igstk::SpatialObjectReader< TDimension, TPixelType >::RequestReadObject ( )

This method request Object read.

template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
void igstk::SpatialObjectReader< TDimension, TPixelType >::RequestGetOutput ( )

This method will invoke a event from derived reader class, such as: MeshModifiedEvent for igstkMeshReader TubeModifiedEvent for igstkTubeReader.

template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
igstk::SpatialObjectReader< TDimension, TPixelType >::igstkEventMacro ( ObjectReaderEvent  ,
IGSTKEvent   
)
template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
igstk::SpatialObjectReader< TDimension, TPixelType >::igstkEventMacro ( ObjectReadingErrorEvent  ,
IGSTKErrorEvent   
)
template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
igstk::SpatialObjectReader< TDimension, TPixelType >::igstkEventMacro ( ObjectReadingSuccessEvent  ,
ObjectReaderEvent   
)
template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
igstk::SpatialObjectReader< TDimension, TPixelType >::igstkEventMacro ( ObjectInvalidRequestErrorEvent  ,
ObjectReadingErrorEvent   
)
template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
void igstk::SpatialObjectReader< TDimension, TPixelType >::PrintSelf ( std::ostream &  os,
::itk::Indent  indent 
) const
protected

Print the object information in a stream.

template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
virtual void igstk::SpatialObjectReader< TDimension, TPixelType >::AttemptReadObjectProcessing ( )
protectedvirtual

Reimplemented in igstk::MeshReader, and igstk::TubeReader.

template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
virtual void igstk::SpatialObjectReader< TDimension, TPixelType >::ReportObjectProcessing ( )
protectedvirtual

Reimplemented in igstk::MeshReader, and igstk::TubeReader.

Member Data Documentation

template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
igstkStandardTemplatedClassTraitsMacro ( SpatialObjectReader, Object ) public typedef TPixelType igstk::SpatialObjectReader< TDimension, TPixelType >::PixelType

Macro with standard traits declarations.

Some convenient typedefs for input Object

Definition at line 57 of file igstkSpatialObjectReader.h.

template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
SpatialObjectReaderType::Pointer igstk::SpatialObjectReader< TDimension, TPixelType >::m_SpatialObjectReader
protected

Definition at line 105 of file igstkSpatialObjectReader.h.

template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
std::string igstk::SpatialObjectReader< TDimension, TPixelType >::m_FileNameToBeSet
protected

Definition at line 106 of file igstkSpatialObjectReader.h.

template<unsigned int TDimension = 3, typename TPixelType = unsigned char>
std::string igstk::SpatialObjectReader< TDimension, TPixelType >::m_FileName
protected

Definition at line 107 of file igstkSpatialObjectReader.h.


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