igstk::ImageSpatialObjectRepresentation< TImageSpatialObject > Class Template Reference

This class renders and ImageSpatialObject in a VTK scene using a slice based representation. More...

#include <igstkImageSpatialObjectRepresentation.h>

Inheritance diagram for igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >:
Inheritance graph
[legend]
Collaboration diagram for igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >:
Collaboration graph
[legend]

List of all members.

Public Types

enum  OrientationType { Sagittal, Coronal, Axial }
 

Orientation Type: Publically declared orientation types supported for slice viewing.

More...
typedef unsigned int SliceNumberType
 Type used for representing the slice number.

Public Member Functions

Pointer Copy () const
 Return a copy of the current object representation.
void RequestSetImageSpatialObject (const ImageSpatialObjectType *ImageSpatialObject)
 Connect this representation class to the spatial object.
void RequestSetSliceNumber (SliceNumberType slice)
 Request the state machine to attempt to select a slice number.
void RequestSetOrientation (OrientationType orientation)
 Request the state machine to attempt to select a slice orientation.
void SetWindowLevel (double window, double level)
 Set the Window Level for the representation.
void SetOpacity (float alpha)
 Set the opacity.
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream.
void RequestGetSliceNumberBounds ()
 Returns the Minimum and Maximum number of slice available in the current orientation.

Public Attributes

igstkStandardTemplatedClassTraitsMacro(ImageSpatialObjectRepresentation,
ObjectRepresentation) public
typedef
ImageSpatialObjectType::ConstPointer 
ImageSpatialObjectConstPointer
 Macro with standard traits declarations.

Protected Member Functions

 ImageSpatialObjectRepresentation ()
 Constructor.
 ~ImageSpatialObjectRepresentation ()
 Destructor.
void DeleteActors ()
 Overloaded function to delete actors.
void CreateActors ()
 Create the VTK actors for displaying geometry.
 igstkObserverMacro (VTKImage, VTKImageModifiedEvent, EventHelperType::VTKImagePointerType)
 Observer macro that will received a event with an image as payload and will store it internally.
 igstkObserverMacro (ImageTransform, CoordinateSystemTransformToEvent, CoordinateSystemTransformToResult)

Detailed Description

template<class TImageSpatialObject>
class igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >

This class renders and ImageSpatialObject in a VTK scene using a slice based representation.

You can select the orientation of the slice to be Axial, Sagittal or Coronal. The number of the slice to be rendered can also be selected, as well as values of opacity, window and level.

igstkImageSpatialObjectRepresentation.png

State Machine Diagram

Definition at line 51 of file igstkImageSpatialObjectRepresentation.h.


Member Typedef Documentation

template<class TImageSpatialObject>
typedef unsigned int igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >::SliceNumberType

Type used for representing the slice number.

Definition at line 85 of file igstkImageSpatialObjectRepresentation.h.


Member Enumeration Documentation

template<class TImageSpatialObject>
enum igstk::ImageSpatialObjectRepresentation::OrientationType

Orientation Type: Publically declared orientation types supported for slice viewing.

Enumerator:
Sagittal 
Coronal 
Axial 

Definition at line 72 of file igstkImageSpatialObjectRepresentation.h.


Constructor & Destructor Documentation

template<class TImageSpatialObject>
igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >::ImageSpatialObjectRepresentation (  )  [protected]

Constructor.

template<class TImageSpatialObject>
igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >::~ImageSpatialObjectRepresentation (  )  [protected]

Destructor.


Member Function Documentation

template<class TImageSpatialObject>
Pointer igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >::Copy (  )  const

Return a copy of the current object representation.

template<class TImageSpatialObject>
void igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >::RequestSetImageSpatialObject ( const ImageSpatialObjectType *  ImageSpatialObject  ) 

Connect this representation class to the spatial object.

template<class TImageSpatialObject>
void igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >::RequestSetSliceNumber ( SliceNumberType  slice  ) 

Request the state machine to attempt to select a slice number.

template<class TImageSpatialObject>
void igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >::RequestSetOrientation ( OrientationType  orientation  ) 

Request the state machine to attempt to select a slice orientation.

template<class TImageSpatialObject>
void igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >::SetWindowLevel ( double  window,
double  level 
)

Set the Window Level for the representation.

template<class TImageSpatialObject>
void igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >::SetOpacity ( float  alpha  ) 

Set the opacity.

template<class TImageSpatialObject>
virtual void igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const [virtual]
template<class TImageSpatialObject>
void igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >::RequestGetSliceNumberBounds (  ) 

Returns the Minimum and Maximum number of slice available in the current orientation.

template<class TImageSpatialObject>
void igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >::DeleteActors (  )  [protected, virtual]

Overloaded function to delete actors.

Reimplemented from igstk::ObjectRepresentation.

template<class TImageSpatialObject>
void igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >::CreateActors (  )  [protected, virtual]

Create the VTK actors for displaying geometry.

Implements igstk::ObjectRepresentation.

template<class TImageSpatialObject>
igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >::igstkObserverMacro ( VTKImage  ,
VTKImageModifiedEvent  ,
EventHelperType::VTKImagePointerType   
) [protected]

Observer macro that will received a event with an image as payload and will store it internally.

This will be the receptor of the event sent by the ImageSpatialObject when an image is requested.

template<class TImageSpatialObject>
igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >::igstkObserverMacro ( ImageTransform  ,
CoordinateSystemTransformToEvent  ,
CoordinateSystemTransformToResult   
) [protected]

Member Data Documentation

template<class TImageSpatialObject>
igstkStandardTemplatedClassTraitsMacro ( ImageSpatialObjectRepresentation, ObjectRepresentation ) public typedef ImageSpatialObjectType::ConstPointer igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >::ImageSpatialObjectConstPointer

Macro with standard traits declarations.

Definition at line 57 of file igstkImageSpatialObjectRepresentation.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on Sun Aug 30 05:50:11 2009 for IGSTK by  doxygen 1.6.1