IGSTK
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | List of all members
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]

Public Types

typedef ImageType::ConstPointer ImageConstPointer
 
typedef
ImageSpatialObjectType::PointType 
PointType
 
typedef ImageType::IndexType IndexType
 
typedef itk::ContinuousIndex
< double, 3 > 
ContinuousIndexType
 
- Public Types inherited from igstk::Object
typedef Object Self
 General Typedefs. More...
 
typedef ::itk::Object Superclass
 
typedef ::itk::SmartPointer< SelfPointer
 
typedef ::itk::SmartPointer
< const Self
ConstPointer
 
typedef igstk::Logger LoggerType
 

Public Member Functions

virtual bool IsInside (const PointType &point) const
 Test whether a point is inside or outside the object. More...
 
virtual void TransformIndexToPhysicalPoint (const IndexType &index, PointType &point) const
 Transform index to physical point. More...
 
virtual bool TransformPhysicalPointToIndex (const PointType &point, IndexType &index) const
 Transform physical point to index. More...
 
virtual bool TransformPhysicalPointToContinuousIndex (const PointType &point, ContinuousIndexType &index) const
 Transform physical point to index. More...
 
virtual bool IsEmpty () const
 Returns wheter the image have any pixels allocated or not. More...
 
void RequestGetITKImage ()
 The ImageReaderToImageSpatialObject class is declared as a friend in order to be able to set the input image. More...
 
void RequestGetITKImage () const
 
void RequestGetVTKImage ()
 Request to get the VTK image as a const pointer payload into an event. More...
 
void RequestGetVTKImage () const
 
void RequestGetImageExtent ()
 Request to get the VTK image extent as a const pointer payload into an event. More...
 
void RequestGetImageExtent () const
 
void RequestGetImageTransform ()
 Request to get the image transform. More...
 
void RequestGetImageTransform () const
 
 igstkLoadedTemplatedConstObjectEventMacro (ITKImageModifiedEvent, IGSTKEvent, ImageType)
 Event types. More...
 
 igstkEventMacro (ImageNotAvailableEvent, IGSTKErrorEvent)
 
void SetLogger (LoggerType *logger)
 
- Public Member Functions inherited from igstk::SpatialObject
 igstkLoadedObjectEventMacro (BoundingBoxEvent, IGSTKEvent, BoundingBoxType)
 
void RequestGetBounds ()
 
void RequestGetBounds () const
 
- Public Member Functions inherited from igstk::Object
virtual const char * GetNameOfClass () const
 
void SetLogger (LoggerType *logger)
 Connect the Logger for this class. More...
 
void RemoveObserver (unsigned long tag) const
 

Public Attributes

igstkStandardTemplatedClassTraitsMacro(ImageSpatialObject,
SpatialObject) public typedef
itk::Image< TPixelType,
TDimension > 
ImageType
 Macro with standard traits declarations. More...
 
- Public Attributes inherited from igstk::SpatialObject
igstkStandardClassTraitsMacro(SpatialObject,
Object) public typedef
SpatialObjectType::BoundingBoxType 
BoundingBoxType
 Macro with standard traits declarations. More...
 

Protected Member Functions

virtual bool IsInternalTransformRequired ()
 For coordinate systems, this method lets us indicate that we need to provide an additional transform. More...
 
virtual Transform GetInternalTransform () const
 For coordinate systems, allows us to hook in the image transform to calls to RequestSetTransformAndParent. More...
 
 ImageSpatialObject (void)
 
 ~ImageSpatialObject (void)
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object informations in a stream. More...
 
LoggerTypeGetLogger () const
 Declarations needed for the Logger. More...
 
- Protected Member Functions inherited from igstk::SpatialObject
 SpatialObject (void)
 The constructor of this class is declared protected to enforce the use of SmartPointers syntax when instantiating objects of this class. More...
 
 ~SpatialObject (void)
 The destructor should be overriden in derived classes that allocate memory for member variables. More...
 
void RequestSetInternalSpatialObject (SpatialObjectType *object)
 Replacement for RequestSetSpatialObject(). More...
 
SpatialObjectType * GetInternalSpatialObject () const
 Returns the ITK spatial object that is contained inside this IGSTK spatial object. More...
 
- Protected Member Functions inherited from igstk::Object
LoggerTypeGetLogger () const
 
 Object (void)
 Constructor is protected in order to enforce the use of the New() operator. More...
 
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. More...
 
void RemoveFromObservedObjects ()
 Remove observers that this object may have connected to other objects. More...
 

Additional Inherited Members

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

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 58 of file igstkImageSpatialObject.h.

Member Typedef Documentation

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

Definition at line 78 of file igstkImageSpatialObject.h.

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

Definition at line 79 of file igstkImageSpatialObject.h.

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

Definition at line 80 of file igstkImageSpatialObject.h.

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

Definition at line 81 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 ( )
protectedvirtual

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
protectedvirtual

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
protectedvirtual

Print the object informations in a stream.

Reimplemented from igstk::SpatialObject.

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

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

Declarations needed for the Logger.

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

Member Data Documentation

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

Macro with standard traits declarations.

Definition at line 65 of file igstkImageSpatialObject.h.


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