Public Types | Public Member Functions | Private Attributes

cmtk::UniformVolumePainter Class Reference
[cmtkBase Library]

Class for painting in uniform volume objects. More...

#include <cmtkUniformVolumePainter.h>

Collaboration diagram for cmtk::UniformVolumePainter:
Collaboration graph
[legend]

List of all members.

Public Types

enum  CoordinateModeEnum { COORDINATES_ABSOLUTE = 0, COORDINATES_RELATIVE = 1, COORDINATES_INDEXED = 2 }
 

Enum for coordinate mode.

More...
typedef UniformVolumePainter Self
 This class.
typedef SmartPointer< SelfSmartPtr
 Smart pointer.

Public Member Functions

 UniformVolumePainter (UniformVolume::SmartPtr &volume, const CoordinateModeEnum coordinateMode=Self::COORDINATES_INDEXED)
 Constructor: link to target volume.
void DrawSphere (const UniformVolume::CoordinateVectorType &center, const Types::Coordinate radius, const Types::DataItem value)
 Draw a sphere.
void DrawBox (const UniformVolume::CoordinateVectorType &boxFrom, const UniformVolume::CoordinateVectorType &boxTo, const Types::DataItem value)
 Draw a box.

Private Attributes

UniformVolume::SmartPtr m_Volume
 Pointer to target volume.
Self::CoordinateModeEnum m_CoordinateMode
 Coordinate mode for all operations.

Detailed Description

Class for painting in uniform volume objects.

This class provides operations to draw simple geometric objects into UniformVolume objects. This is useful, for example, to create electronic phantom images.

Definition at line 51 of file cmtkUniformVolumePainter.h.


Member Typedef Documentation

This class.

Definition at line 55 of file cmtkUniformVolumePainter.h.

Smart pointer.

Definition at line 58 of file cmtkUniformVolumePainter.h.


Member Enumeration Documentation

Enum for coordinate mode.

Enumerator:
COORDINATES_ABSOLUTE 

Absolute coordinates: all coordinates are absoluate values within the volume field of view.

COORDINATES_RELATIVE 

Relative coordinates: all coordinates are in range [0,1] which is mapped to volume field of view for each dimension.

COORDINATES_INDEXED 

Indexed grid coordinates: all coordinates are grid indexes.

Definition at line 61 of file cmtkUniformVolumePainter.h.


Constructor & Destructor Documentation

cmtk::UniformVolumePainter::UniformVolumePainter ( UniformVolume::SmartPtr volume,
const CoordinateModeEnum  coordinateMode = Self::COORDINATES_INDEXED 
) [inline]

Constructor: link to target volume.

Definition at line 73 of file cmtkUniformVolumePainter.h.


Member Function Documentation

void cmtk::UniformVolumePainter::DrawBox ( const UniformVolume::CoordinateVectorType boxFrom,
const UniformVolume::CoordinateVectorType boxTo,
const Types::DataItem  value 
)

Draw a box.

Definition at line 92 of file cmtkUniformVolumePainter.cxx.

void cmtk::UniformVolumePainter::DrawSphere ( const UniformVolume::CoordinateVectorType center,
const Types::Coordinate  radius,
const Types::DataItem  value 
)

Member Data Documentation

Coordinate mode for all operations.

Definition at line 86 of file cmtkUniformVolumePainter.h.

Pointer to target volume.

Definition at line 83 of file cmtkUniformVolumePainter.h.


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