igstk::ImageSpatialObject< TPixelType, TDimension > Class Template Reference

This class represents an image object. More...

#include <igstkImageSpatialObject.h>

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

List of all members.

Public Types

typedef ImageType::ConstPointer ImageConstPointer
typedef
ImageSpatialObjectType::PointType 
PointType
typedef ImageType::IndexType IndexType
typedef itk::ContinuousIndex
< double, 3 > 
ContinuousIndexType

Public Member Functions

virtual bool IsInside (const PointType &point) const
 Test whether a point is inside or outside the object.
virtual void TransformIndexToPhysicalPoint (const IndexType &index, PointType &point) const
 Transform index to physical point.
virtual bool TransformPhysicalPointToIndex (const PointType &point, IndexType &index) const
 Transform physical point to index.
virtual bool TransformPhysicalPointToContinuousIndex (const PointType &point, ContinuousIndexType &index) const
 Transform physical point to index.
virtual bool IsEmpty () const
 Returns wheter the image have any pixels allocated or not.
void RequestGetITKImage ()
 The ImageReaderToImageSpatialObject class is declared as a friend in order to be able to set the input image.
void RequestGetITKImage () const
void RequestGetVTKImage ()
 Request to get the VTK image as a const pointer payload into an event.
void RequestGetVTKImage () const
void RequestGetImageExtent ()
 Request to get the VTK image extent as a const pointer payload into an event.
void RequestGetImageExtent () const
void RequestGetImageTransform ()
 Request to get the image transform.
void RequestGetImageTransform () const
 igstkLoadedTemplatedConstObjectEventMacro (ITKImageModifiedEvent, IGSTKEvent, ImageType)
 Event types.
 igstkEventMacro (ImageNotAvailableEvent, IGSTKErrorEvent)
void SetLogger (LoggerType *logger)
 Connect the Logger for this class.

Public Attributes

igstkStandardTemplatedClassTraitsMacro(ImageSpatialObject,
SpatialObject) public typedef
itk::OrientedImage< TPixelType,
TDimension > 
ImageType
 Macro with standard traits declarations.

Protected Member Functions

virtual bool IsInternalTransformRequired ()
 For coordinate systems, this method lets us indicate that we need to provide an additional transform.
virtual Transform GetInternalTransform () const
 For coordinate systems, allows us to hook in the image transform to calls to RequestSetTransformAndParent.
 ImageSpatialObject (void)
 ~ImageSpatialObject (void)
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object informations in a stream.
LoggerTypeGetLogger () const
 Declarations needed for the Logger.

Detailed Description

template<class TPixelType, unsigned int TDimension>
class igstk::ImageSpatialObject< TPixelType, TDimension >

This class represents an image object.

This class is the base for all the image data objects in the toolkit. It associates an internal ITK image and a VTK importer in such a way that internally it can make available both image formats to ITK and VTK classes. The ITK and VTK layers are concealed in order to enforce the safety of the IGSTK layer.

Definition at line 52 of file igstkImageSpatialObject.h.


Member Typedef Documentation

template<class TPixelType, unsigned int TDimension>
typedef ImageType::ConstPointer igstk::ImageSpatialObject< TPixelType, TDimension >::ImageConstPointer

Definition at line 67 of file igstkImageSpatialObject.h.

template<class TPixelType, unsigned int TDimension>
typedef ImageSpatialObjectType::PointType igstk::ImageSpatialObject< TPixelType, TDimension >::PointType

Definition at line 68 of file igstkImageSpatialObject.h.

template<class TPixelType, unsigned int TDimension>
typedef ImageType::IndexType igstk::ImageSpatialObject< TPixelType, TDimension >::IndexType

Definition at line 69 of file igstkImageSpatialObject.h.

template<class TPixelType, unsigned int TDimension>
typedef itk::ContinuousIndex< double, 3 > igstk::ImageSpatialObject< TPixelType, TDimension >::ContinuousIndexType

Definition at line 70 of file igstkImageSpatialObject.h.


Constructor & Destructor Documentation

template<class TPixelType, unsigned int TDimension>
igstk::ImageSpatialObject< TPixelType, TDimension >::ImageSpatialObject ( void   )  [protected]
template<class TPixelType, unsigned int TDimension>
igstk::ImageSpatialObject< TPixelType, TDimension >::~ImageSpatialObject ( void   )  [protected]

Member Function Documentation

template<class TPixelType, unsigned int TDimension>
virtual bool igstk::ImageSpatialObject< TPixelType, TDimension >::IsInside ( const PointType point  )  const [virtual]

Test whether a point is inside or outside the object.

template<class TPixelType, unsigned int TDimension>
virtual void igstk::ImageSpatialObject< TPixelType, TDimension >::TransformIndexToPhysicalPoint ( const IndexType index,
PointType point 
) const [virtual]

Transform index to physical point.

template<class TPixelType, unsigned int TDimension>
virtual bool igstk::ImageSpatialObject< TPixelType, TDimension >::TransformPhysicalPointToIndex ( const PointType point,
IndexType index 
) const [virtual]

Transform physical point to index.

template<class TPixelType, unsigned int TDimension>
virtual bool igstk::ImageSpatialObject< TPixelType, TDimension >::TransformPhysicalPointToContinuousIndex ( const PointType point,
ContinuousIndexType index 
) const [virtual]

Transform physical point to index.

template<class TPixelType, unsigned int TDimension>
virtual bool igstk::ImageSpatialObject< TPixelType, TDimension >::IsEmpty (  )  const [virtual]

Returns wheter the image have any pixels allocated or not.

template<class TPixelType, unsigned int TDimension>
void igstk::ImageSpatialObject< TPixelType, TDimension >::RequestGetITKImage (  ) 

The ImageReaderToImageSpatialObject class is declared as a friend in order to be able to set the input image.

The UltrasoundImageSimulatorToImageSpatialObject class is declared as a friend in order to be able to set the input image Request to get the ITK image as a const pointer payload into an event. Both the const and non-const versions are needed.

template<class TPixelType, unsigned int TDimension>
void igstk::ImageSpatialObject< TPixelType, TDimension >::RequestGetITKImage (  )  const
template<class TPixelType, unsigned int TDimension>
void igstk::ImageSpatialObject< TPixelType, TDimension >::RequestGetVTKImage (  ) 

Request to get the VTK image as a const pointer payload into an event.

Both the const and non-const versions are needed.

template<class TPixelType, unsigned int TDimension>
void igstk::ImageSpatialObject< TPixelType, TDimension >::RequestGetVTKImage (  )  const
template<class TPixelType, unsigned int TDimension>
void igstk::ImageSpatialObject< TPixelType, TDimension >::RequestGetImageExtent (  ) 

Request to get the VTK image extent as a const pointer payload into an event.

Both the const and non-const versions are needed.

template<class TPixelType, unsigned int TDimension>
void igstk::ImageSpatialObject< TPixelType, TDimension >::RequestGetImageExtent (  )  const
template<class TPixelType, unsigned int TDimension>
void igstk::ImageSpatialObject< TPixelType, TDimension >::RequestGetImageTransform (  ) 

Request to get the image transform.

This transform involves the Translation to the origin, and the rotation given by the direction cosines from the DICOM image.

template<class TPixelType, unsigned int TDimension>
void igstk::ImageSpatialObject< TPixelType, TDimension >::RequestGetImageTransform (  )  const
template<class TPixelType, unsigned int TDimension>
igstk::ImageSpatialObject< TPixelType, TDimension >::igstkLoadedTemplatedConstObjectEventMacro ( ITKImageModifiedEvent  ,
IGSTKEvent  ,
ImageType   
)

Event types.

template<class TPixelType, unsigned int TDimension>
igstk::ImageSpatialObject< TPixelType, TDimension >::igstkEventMacro ( ImageNotAvailableEvent  ,
IGSTKErrorEvent   
)
template<class TPixelType, unsigned int TDimension>
virtual bool igstk::ImageSpatialObject< TPixelType, TDimension >::IsInternalTransformRequired (  )  [protected, virtual]

For coordinate systems, this method lets us indicate that we need to provide an additional transform.

template<class TPixelType, unsigned int TDimension>
virtual Transform igstk::ImageSpatialObject< TPixelType, TDimension >::GetInternalTransform (  )  const [protected, virtual]

For coordinate systems, allows us to hook in the image transform to calls to RequestSetTransformAndParent.

template<class TPixelType, unsigned int TDimension>
virtual void igstk::ImageSpatialObject< TPixelType, TDimension >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const [protected, virtual]

Print the object informations in a stream.

Reimplemented from igstk::SpatialObject.

Reimplemented in igstk::CTImageSpatialObject, igstk::MRImageSpatialObject, and igstk::USImageObject.

template<class TPixelType, unsigned int TDimension>
LoggerType* igstk::ImageSpatialObject< TPixelType, TDimension >::GetLogger (  )  const [protected]

Declarations needed for the Logger.

Reimplemented from igstk::Object.

template<class TPixelType, unsigned int TDimension>
void igstk::ImageSpatialObject< TPixelType, TDimension >::SetLogger ( LoggerType logger  ) 

Connect the Logger for this class.

Reimplemented from igstk::Object.


Member Data Documentation

template<class TPixelType, unsigned int TDimension>
igstkStandardTemplatedClassTraitsMacro ( ImageSpatialObject, SpatialObject ) public typedef itk::OrientedImage< TPixelType, TDimension > igstk::ImageSpatialObject< TPixelType, TDimension >::ImageType

Macro with standard traits declarations.

Reimplemented in igstk::USImageObject.

Definition at line 59 of file igstkImageSpatialObject.h.


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

Generated on Tue Dec 22 03:55:47 2009 for IGSTK by  doxygen 1.6.1