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

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. More...
 
- Public Types inherited from igstk::ObjectRepresentation
typedef double OpacityType
 Type for representing the opacity of the object. More...
 
- 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

Pointer Copy () const
 Return a copy of the current object representation. More...
 
void RequestSetImageSpatialObject (const ImageSpatialObjectType *ImageSpatialObject)
 Connect this representation class to the spatial object. More...
 
void RequestSetSliceNumber (SliceNumberType slice)
 Request the state machine to attempt to select a slice number. More...
 
void RequestSetOrientation (OrientationType orientation)
 Request the state machine to attempt to select a slice orientation. More...
 
void SetWindowLevel (double window, double level)
 Set the Window Level for the representation. More...
 
void SetOpacity (float alpha)
 Set the opacity. More...
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream. More...
 
void RequestGetSliceNumberBounds ()
 Returns the Minimum and Maximum number of slice available in the current orientation. More...
 
- Public Member Functions inherited from igstk::ObjectRepresentation
void SetColor (ColorScalarType r, ColorScalarType g, ColorScalarType b)
 Set the color. More...
 
ColorScalarType GetRed () const
 Get each color component. More...
 
ColorScalarType GetGreen () const
 
ColorScalarType GetBlue () const
 
virtual void SetOpacity (OpacityType alpha)
 Set/Get the opacity. More...
 
virtual OpacityType GetOpacity ()
 
virtual ActorsListType GetActors ()
 Get the VTK actors. More...
 
virtual void RequestUpdateRepresentation (const TimeStamp &time, const CoordinateSystem *cs)
 Update the visual representation with changes in the geometry. More...
 
- 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(ImageSpatialObjectRepresentation,
ObjectRepresentation) public
typedef
ImageSpatialObjectType::ConstPointer 
ImageSpatialObjectConstPointer
 Macro with standard traits declarations. More...
 
- Public Attributes inherited from igstk::ObjectRepresentation
igstkStandardAbstractClassTraitsMacro(ObjectRepresentation,
Object) public typedef double 
ColorScalarType
 Macro with standard traits declarations. More...
 

Protected Member Functions

 ImageSpatialObjectRepresentation ()
 Constructor. More...
 
 ~ImageSpatialObjectRepresentation ()
 Destructor. More...
 
void DeleteActors ()
 Overloaded function to delete actors. More...
 
void CreateActors ()
 Create the VTK actors for displaying geometry. More...
 
 igstkObserverMacro (VTKImage, VTKImageModifiedEvent, EventHelperType::VTKImagePointerType)
 Observer macro that will received a event with an image as payload and will store it internally. More...
 
 igstkObserverMacro (ImageTransform, CoordinateSystemTransformToEvent, CoordinateSystemTransformToResult)
 
- Protected Member Functions inherited from igstk::ObjectRepresentation
 ObjectRepresentation (void)
 
 ~ObjectRepresentation (void)
 
void AddActor (vtkProp *)
 Add an actor to the list. More...
 
void RequestSetSpatialObject (const SpatialObject *spatialObject)
 Request the state machine to set a Spatial Object. More...
 
virtual bool VerifyTimeStamp () const
 Verify the time stamp. More...
 
TimeStamp GetRenderTimeStamp () const
 Get Time stamp for the time at which the next rendering will take place. 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)
 
- Protected Attributes inherited from igstk::ObjectRepresentation
ActorsListType m_Actors
 
OpacityType m_Opacity
 

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 ( )
protectedvirtual

Overloaded function to delete actors.

Reimplemented from igstk::ObjectRepresentation.

template<class TImageSpatialObject>
void igstk::ImageSpatialObjectRepresentation< TImageSpatialObject >::CreateActors ( )
protectedvirtual

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: