Computer Assited Medical Intervention Tool Kit  version 3.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Member Functions | Public Attributes | List of all members
camitk::InterfaceBitMap Class Referenceabstract

This class describes what are the methods to implement for a BitMap. More...

#include <InterfaceBitMap.h>

+ Inheritance diagram for camitk::InterfaceBitMap:

Public Types

enum  PossibleOrientation { AXIAL_ORIENTATION, CORONAL_ORIENTATION, SAGITTAL_ORIENTATION, ARBITRARY_ORIENTATION }
 Common slices orientation: axial, sagittal, coronal or anything else. More...
 

Public Member Functions

virtual bool addProp (const QString &, vtkSmartPointer< vtkProp >)=0
 insert an additional prop, defining it by its name (default visibility = false) More...
 
virtual vtkSmartPointer
< vtkImageActor > 
get2DImageActor () const =0
 Return the vtkImageActor (vtkProp) representing a slice to be displayed in 2D. More...
 
virtual vtkSmartPointer
< vtkImageActor > 
get3DImageActor () const =0
 Return the vtkImageActor (vtkProp) representing a slice to be displayed in 2D. More...
 
virtual vtkSmartPointer
< vtkImageData > 
getImageData () const =0
 Return the displayed images as a vtkImageData. More...
 
virtual int getNumberOfColors () const =0
 Return the number of colors in the images. More...
 
virtual unsigned int getNumberOfProp () const =0
 return the number of additional prop More...
 
virtual int getNumberOfSlices () const =0
 Return the number of slices in the image data set. More...
 
virtual vtkSmartPointer< vtkActor > getPickPlaneActor () const =0
 Return the vtkActor used to pick pixels in the slices. More...
 
virtual vtkSmartPointer< vtkActor > getPixelActor ()=0
 Return the vtkActor used to pick pixels in the slices. More...
 
virtual vtkSmartPointer< vtkProp > getProp (const QString &)=0
 Return the vtkProp (actors, volumes and annotations) corresponding to the given name. More...
 
virtual vtkSmartPointer< vtkProp > getProp (unsigned int)=0
 return an additional prop by its index More...
 
virtual double getRotationX () const =0
 Return the current angle applied to the arbitrary slice. More...
 
virtual double getRotationY () const =0
 
virtual double getRotationZ () const =0
 
virtual int getSlice () const =0
 Return the index of the current displayed slice. More...
 
virtual void pixelPicked (double, double, double)=0
 This method is called when the associated plane has been picked in the InteractiveViewer, the given coordinates is position where the plane was picked. More...
 
virtual bool removeProp (const QString &)=0
 remove a given additional prop. More...
 
virtual void setOriginalVolume (vtkSmartPointer< vtkImageData >)=0
 set the original volume image data (the source vtkImageData before any reslice) and refresh the vtk pipeline More...
 
virtual void setPixelRealPosition (double, double, double)=0
 move the pixel selection green indicator (pixelActor) to the given real position More...
 
virtual void setRotationX (double angle)=0
 Set the current angle to the arbitrary slice. More...
 
virtual void setRotationY (double angle)=0
 
virtual void setRotationZ (double angle)=0
 
virtual void setSlice (int s)=0
 Set the current slice index. More...
 
virtual void setSlice (double x, double y, double z)=0
 Set the slice corresponding to the given world coordinates. More...
 
virtual void updatePickPlane ()=0
 
virtual ~InterfaceBitMap ()
 virtual destructor More...
 

Public Attributes

QMap< QString, vtkSmartPointer
< vtkProp > > 
extraProp
 The additional map for prop (include at least "label" and "glyph". More...
 

Detailed Description

This class describes what are the methods to implement for a BitMap.

An InterfaceBitMap is a kind of simplifier/wrapper for vtkImageData.

This class defines an "interface" (in the OOP/java meaning of the term). See the introduction of GoF: "Program to an interface, not an implementation." To see what Erich Gamma has to say about it: http://www.artima.com/lejava/articles/designprinciplesP.html To see what Bjarne Stroustrup has to say about it: http://www.artima.com/intv/modern.html

See Also
Slice

Member Enumeration Documentation

Common slices orientation: axial, sagittal, coronal or anything else.

The slices organisation will depend on how the original volume image has been read (generally: RAI): RAI: Right Anterior Inferior, LAI: Left Anterior Inferior, LAS: Left Anterior Superior, RAS: Right Anterior Superior, LPS: Left Posterior Superior, RPS: Right Posterior Superior, LPI: Left Posterior Inferior, RPI: Right Posterior Inferior

AXIAL_ORIENTATION: from feet to head of the patient in case of RAI, LAI, LPI and RPI from head to feet of the patient in case of LAS, RAS, LPS and RPS

CORONAL_ORIENTATION: from front to back of the patient in case of RAI, LAI, LAS and RAS from back to front of the patient in case of LPI, RPI, LPS and RPS

SAGITTAL_ORIENTATION: from right to left facing the patient in case of RAI, RPI, RAS and RPS from left to right facing the patient in case of LAI, LAS, LPI and LPS

ARBITRARY_ORIENTATION: well give the orientation you want!

Enumerator
AXIAL_ORIENTATION 
CORONAL_ORIENTATION 
SAGITTAL_ORIENTATION 
ARBITRARY_ORIENTATION 

Constructor & Destructor Documentation

virtual camitk::InterfaceBitMap::~InterfaceBitMap ( )
inlinevirtual

virtual destructor

Member Function Documentation

virtual bool camitk::InterfaceBitMap::addProp ( const QString &  ,
vtkSmartPointer< vtkProp >   
)
pure virtual

insert an additional prop, defining it by its name (default visibility = false)

Returns
true if the additional prop was added (i.e. another additional prop of the same name does not exist)

Implemented in camitk::Component, and camitk::Slice.

virtual vtkSmartPointer<vtkImageActor> camitk::InterfaceBitMap::get2DImageActor ( ) const
pure virtual

Return the vtkImageActor (vtkProp) representing a slice to be displayed in 2D.

Implemented in camitk::Slice.

virtual vtkSmartPointer<vtkImageActor> camitk::InterfaceBitMap::get3DImageActor ( ) const
pure virtual

Return the vtkImageActor (vtkProp) representing a slice to be displayed in 2D.

Implemented in camitk::Slice.

virtual vtkSmartPointer<vtkImageData> camitk::InterfaceBitMap::getImageData ( ) const
pure virtual

Return the displayed images as a vtkImageData.

Implemented in camitk::Slice.

virtual int camitk::InterfaceBitMap::getNumberOfColors ( ) const
pure virtual

Return the number of colors in the images.

If color is coded on 1 byte, the images are on 256 grey level. If color is coded on 2 bytes, the images are on 4096 grey level (not 65536).

Implemented in camitk::Slice, and camitk::ImageComponent.

virtual unsigned int camitk::InterfaceBitMap::getNumberOfProp ( ) const
pure virtual

return the number of additional prop

Implemented in camitk::Component, and camitk::Slice.

virtual int camitk::InterfaceBitMap::getNumberOfSlices ( ) const
pure virtual

Return the number of slices in the image data set.

Implemented in camitk::Component, camitk::ImageComponent, and camitk::Slice.

virtual vtkSmartPointer<vtkActor> camitk::InterfaceBitMap::getPickPlaneActor ( ) const
pure virtual

Return the vtkActor used to pick pixels in the slices.

Implemented in camitk::Slice.

virtual vtkSmartPointer<vtkActor> camitk::InterfaceBitMap::getPixelActor ( )
pure virtual

Return the vtkActor used to pick pixels in the slices.

Implemented in camitk::Slice.

virtual vtkSmartPointer<vtkProp> camitk::InterfaceBitMap::getProp ( const QString &  )
pure virtual

Return the vtkProp (actors, volumes and annotations) corresponding to the given name.

Implemented in camitk::Component, and camitk::Slice.

virtual vtkSmartPointer<vtkProp> camitk::InterfaceBitMap::getProp ( unsigned  int)
pure virtual

return an additional prop by its index

Implemented in camitk::Component, and camitk::Slice.

virtual double camitk::InterfaceBitMap::getRotationX ( ) const
pure virtual

Return the current angle applied to the arbitrary slice.

Implemented in camitk::Component, and camitk::Slice.

virtual double camitk::InterfaceBitMap::getRotationY ( ) const
pure virtual

Implemented in camitk::Component, and camitk::Slice.

virtual double camitk::InterfaceBitMap::getRotationZ ( ) const
pure virtual

Implemented in camitk::Component, and camitk::Slice.

virtual int camitk::InterfaceBitMap::getSlice ( ) const
pure virtual

Return the index of the current displayed slice.

Implemented in camitk::Component, and camitk::Slice.

virtual void camitk::InterfaceBitMap::pixelPicked ( double  ,
double  ,
double   
)
pure virtual

This method is called when the associated plane has been picked in the InteractiveViewer, the given coordinates is position where the plane was picked.

Implemented in camitk::Slice, and camitk::SingleImageComponent.

virtual bool camitk::InterfaceBitMap::removeProp ( const QString &  )
pure virtual

remove a given additional prop.

Returns
true if effictively done

Implemented in camitk::Component, and camitk::Slice.

virtual void camitk::InterfaceBitMap::setOriginalVolume ( vtkSmartPointer< vtkImageData >  )
pure virtual

set the original volume image data (the source vtkImageData before any reslice) and refresh the vtk pipeline

Implemented in camitk::Slice.

virtual void camitk::InterfaceBitMap::setPixelRealPosition ( double  ,
double  ,
double   
)
pure virtual

move the pixel selection green indicator (pixelActor) to the given real position

Implemented in camitk::Slice.

virtual void camitk::InterfaceBitMap::setRotationX ( double  angle)
pure virtual

Set the current angle to the arbitrary slice.

Implemented in camitk::Slice.

virtual void camitk::InterfaceBitMap::setRotationY ( double  angle)
pure virtual

Implemented in camitk::Slice.

virtual void camitk::InterfaceBitMap::setRotationZ ( double  angle)
pure virtual

Implemented in camitk::Slice.

virtual void camitk::InterfaceBitMap::setSlice ( int  s)
pure virtual

Set the current slice index.

If the slice index is less than the first slice index, the first slice is displayed. If the slice index is more than the last slice index, the last slice is displayed.

Parameters
sthe index of the slice to display (base 0).

Implemented in camitk::Slice.

virtual void camitk::InterfaceBitMap::setSlice ( double  x,
double  y,
double  z 
)
pure virtual

Set the slice corresponding to the given world coordinates.

Implemented in camitk::Slice.

virtual void camitk::InterfaceBitMap::updatePickPlane ( )
pure virtual

Implemented in camitk::Slice.

Member Data Documentation

QMap<QString, vtkSmartPointer<vtkProp> > camitk::InterfaceBitMap::extraProp

The additional map for prop (include at least "label" and "glyph".


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