cmtk::Volume Class Reference [cmtkBase Library]

General 3D volume. More...

#include <cmtkVolume.h>

Inheritance diagram for cmtk::Volume:

Collaboration diagram for cmtk::Volume:

List of all members.

Public Types
typedef Volume	Self
	This class type.
typedef DataGrid	Superclass
	Superclass.
typedef SmartPointer< Self >	SmartPtr
	Smart pointer to Volume.
typedef Region < 3, Types::Coordinate >	CoordinateRegionType
	Region type.
typedef CoordinateRegionType::IndexType	CoordinateVectorType
	Index type.
Public Member Functions
void	SetOffset (const Vector3D &o)
	Set volume offset.
	Volume ()
	Default constructor.
virtual	~Volume ()
	Destructor.
virtual Types::Coordinate	MinSize () const
	Get minumum extent.
virtual Types::Coordinate	MaxSize () const
	Get maximum extent.
virtual Types::Coordinate	TotalVolume () const
	Get total volume.
virtual Types::Coordinate	AverageVoxelVolume () const
	Return average volume of all voxels.
Vector3D	GetCenter () const
	Calculate volume center.
Public Attributes
CoordinateVectorType	m_Offset
	Volume offset (coordinate of first voxel in RAS standard space).
LandmarkList::SmartPtr	m_LandmarkList
	List of landmarks defined in this volume.
FixedVector< 3, Types::Coordinate >	Size
	Spatial extent of the volume in world coordinates.
Protected Member Functions
bool	GetTrilinear (ProbeInfo &, const int, const int, const int, const Vector3D &, const Types::Coordinate *, const Types::Coordinate *) const
	Get information needed for trilinear interpolation.

---

Detailed Description

General 3D volume.

This class handles three-dimensional volume data with a coordinate transformation and associated distance measure. Methods to retrieve data and general structural information are provided.

Author:

Torsten Rohlfing

Definition at line 68 of file cmtkVolume.h.

---

Member Typedef Documentation

typedef Region<3,Types::Coordinate> cmtk::Volume::CoordinateRegionType

Region type.

Reimplemented in cmtk::ImageTemplate< TPixelType >, and cmtk::UniformVolume.

Definition at line 83 of file cmtkVolume.h.

typedef CoordinateRegionType::IndexType cmtk::Volume::CoordinateVectorType

Index type.

Reimplemented in cmtk::ImageTemplate< TPixelType >, and cmtk::UniformVolume.

Definition at line 86 of file cmtkVolume.h.

typedef Volume cmtk::Volume::Self

This class type.

Reimplemented from cmtk::DataGrid.

Reimplemented in cmtk::ImageTemplate< TPixelType >, and cmtk::UniformVolume.

Definition at line 74 of file cmtkVolume.h.

typedef SmartPointer<Self> cmtk::Volume::SmartPtr

Smart pointer to Volume.

Reimplemented from cmtk::DataGrid.

Reimplemented in cmtk::ImageTemplate< TPixelType >, and cmtk::UniformVolume.

Definition at line 80 of file cmtkVolume.h.

typedef DataGrid cmtk::Volume::Superclass

Superclass.

Reimplemented in cmtk::ImageTemplate< TPixelType >, and cmtk::UniformVolume.

Definition at line 77 of file cmtkVolume.h.

---

Constructor & Destructor Documentation

cmtk::Volume::Volume

(

)

[inline]

Default constructor.

Definition at line 111 of file cmtkVolume.h.

virtual cmtk::Volume::~Volume

(

)

[inline, virtual]

Destructor.

Do nothing really; just be present and virtual.

Definition at line 116 of file cmtkVolume.h.

---

Member Function Documentation

virtual Types::Coordinate cmtk::Volume::AverageVoxelVolume

(

)

const [inline, virtual]

Return average volume of all voxels.

Definition at line 143 of file cmtkVolume.h.

virtual Types::Coordinate cmtk::Volume::MaxSize

(

)

const [inline, virtual]

Get maximum extent.

Returns:

Maximum volume extent among the three spatial dimensions.

Definition at line 129 of file cmtkVolume.h.

virtual Types::Coordinate cmtk::Volume::MinSize

(

)

const [inline, virtual]

Get minumum extent.

Returns:

Minimum volume extent among the three spatial dimensions.

Definition at line 121 of file cmtkVolume.h.

void cmtk::Volume::SetOffset

(

const Vector3D &

o )

[inline]

Set volume offset.

Definition at line 94 of file cmtkVolume.h.

Referenced by cmtk::UniformVolume::CloneGridVirtual(), cmtk::UniformVolume::GetDownsampledAndAveraged(), cmtk::UniformVolume::GetInterleavedPaddedSubVolume(), and cmtk::UniformVolume::GetInterleavedSubVolume().

virtual Types::Coordinate cmtk::Volume::TotalVolume

(

)

const [inline, virtual]

Get total volume.

Returns:

Product of the spatial extents in all three coordinate directions.

Definition at line 137 of file cmtkVolume.h.

---

Member Data Documentation

LandmarkList::SmartPtr cmtk::Volume::m_LandmarkList

List of landmarks defined in this volume.

Definition at line 100 of file cmtkVolume.h.

CoordinateVectorType cmtk::Volume::m_Offset

Volume offset (coordinate of first voxel in RAS standard space).

Note:

This offset is NOT included in the volume size, m_Size.

Definition at line 91 of file cmtkVolume.h.

Referenced by cmtk::DeformationField::DeformationField(), cmtk::operator<<(), cmtk::SplineWarpXformUniformVolume::RegisterVolume(), cmtk::SplineWarpXform::RegisterVolume(), cmtk::UniformVolumeInterpolatorBase::SetVolume(), cmtk::TransformedVolumeAxes::TransformedVolumeAxes(), cmtk::UniformDistanceMap< TDistanceDataType >::UniformDistanceMap(), and cmtk::UniformVolume::UniformVolume().

FixedVector<3,Types::Coordinate> cmtk::Volume::Size

Spatial extent of the volume in world coordinates.

Note:

This is the actual size of the volume between first and last pixel. Therefore, if a non-zero volume coordinate offset is set in m_Offset, this does not affect this field, because the volume size as the product of pixel size times number of pixels per dimension minus one remains unaffected.

Definition at line 108 of file cmtkVolume.h.

Referenced by cmtk::UniformDistanceMap< TDistanceDataType >::BuildDistanceMap(), cmtk::DeformationField::DeformationField(), cmtk::PlaneSource::Execute(), cmtk::PlaneSource::GetMaxPosition(), cmtk::operator<<(), cmtk::UniformVolume::UniformVolume(), cmtk::QtTriplanarWindow::UpdateDialog(), cmtk::MultiChannelRegistrationFunctionalBase::VerifyImageSize(), and cmtk::VolumeGridToGridLookup::VolumeGridToGridLookup().

---

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

• libs/Base/cmtkVolume.h
• libs/Base/cmtkVolume.cxx