IGSTK
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | List of all members
igstk::TubeReader Class Reference

This class reads 3D Tube in the metaIO format. More...

#include <igstkTubeReader.h>

Inheritance diagram for igstk::TubeReader:
Inheritance graph
[legend]
Collaboration diagram for igstk::TubeReader:
Collaboration graph
[legend]

Public Types

typedef
SpatialObjectType::ConstPointer 
SpatialObjectTypeConstPointer
typedef igstk::TubeObject TubeType
typedef itk::TubeSpatialObject< 3 > TubeSpatialObjectType
- Public Types inherited from igstk::SpatialObjectReader< 3 >
typedef
::itk::DefaultDynamicMeshTraits
< unsigned char, TDimension,
TDimension > 
MeshTraitsType
typedef
::itk::SpatialObjectReader
< TDimension, unsigned char,
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

 igstkEventMacro (TubeReaderEvent, ObjectReaderEvent) igstkEventMacro(TubeReadingErrorEvent
 Event type.
ObjectReadingErrorEvent igstkLoadedObjectEventMacro (TubeModifiedEvent, TubeReaderEvent, TubeType)
 Declare the TubeReaderToTubeSpatialObject class to be a friend in order to give it access to the private method GetITKTubeSpatialObject().
- Public Member Functions inherited from igstk::SpatialObjectReader< 3 >
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

igstkStandardClassTraitsMacro(TubeReader,
SpatialObjectReader
< 3 >) public typedef
Superclass::GroupSpatialObjectType 
GroupSpatialObjectType
 Macro with standard traits declarations.
- Public Attributes inherited from igstk::SpatialObjectReader< 3 >
igstkStandardTemplatedClassTraitsMacro(SpatialObjectReader,
Object) public typedef
unsigned char 
PixelType
 Macro with standard traits declarations.

Protected Member Functions

 TubeReader ()
 Constructor and Destructor.
 ~TubeReader ()
void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream.
void AttemptReadObjectProcessing ()
 This method request Object read.
void ReportObjectProcessing ()
 This method will invoke the TubeModifiedEvent.
void ConnectTube ()
 Connect the ITK TubeSpatialObject to the output TubeSpatialObject.
- Protected Member Functions inherited from igstk::SpatialObjectReader< 3 >
 SpatialObjectReader (void)
virtual ~SpatialObjectReader (void)
void PrintSelf (std::ostream &os,::itk::Indent indent) const
 Print the object information in a stream.
- 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)
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.

Additional Inherited Members

- Static Public Member Functions inherited from igstk::Object
static Pointer New (void)
- Protected Attributes inherited from igstk::SpatialObjectReader< 3 >
SpatialObjectReaderType::Pointer m_SpatialObjectReader
std::string m_FileNameToBeSet
std::string m_FileName

Detailed Description

This class reads 3D Tube in the metaIO format.

Tubular structures are quite common in human anatomy. This class is intended to read groups of tubular structrures from files in metaIO format. Typical these structures are the result of a segmentation method applied on pre-operative images.

igstkTubeReader.png
Tube Reader State Machine Diagram

Definition at line 77 of file igstkTubeReader.h.

Member Typedef Documentation

typedef SpatialObjectType::ConstPointer igstk::TubeReader::SpatialObjectTypeConstPointer

Definition at line 90 of file igstkTubeReader.h.

Definition at line 91 of file igstkTubeReader.h.

typedef itk::TubeSpatialObject<3> igstk::TubeReader::TubeSpatialObjectType

Definition at line 92 of file igstkTubeReader.h.

Constructor & Destructor Documentation

igstk::TubeReader::TubeReader ( )
protected

Constructor and Destructor.

igstk::TubeReader::~TubeReader ( )
protected

Member Function Documentation

igstk::TubeReader::igstkEventMacro ( TubeReaderEvent  ,
ObjectReaderEvent   
)

Event type.

ObjectReadingErrorEvent igstk::TubeReader::igstkLoadedObjectEventMacro ( TubeModifiedEvent  ,
TubeReaderEvent  ,
TubeType   
)

Declare the TubeReaderToTubeSpatialObject class to be a friend in order to give it access to the private method GetITKTubeSpatialObject().

void igstk::TubeReader::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual

Print the object information in a stream.

Reimplemented from igstk::Object.

void igstk::TubeReader::AttemptReadObjectProcessing ( )
protectedvirtual

This method request Object read.

This method is intended to be invoked ONLY by the State Machine of the superclass.

Reimplemented from igstk::SpatialObjectReader< 3 >.

void igstk::TubeReader::ReportObjectProcessing ( )
protectedvirtual

This method will invoke the TubeModifiedEvent.

Reimplemented from igstk::SpatialObjectReader< 3 >.

void igstk::TubeReader::ConnectTube ( )
protected

Connect the ITK TubeSpatialObject to the output TubeSpatialObject.

Member Data Documentation

Macro with standard traits declarations.

Typedefs

Definition at line 83 of file igstkTubeReader.h.


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