cmtk::Region< NDIM, T > Class Template Reference

Class for n-dimensional image index. More...

#include <cmtkRegion.h>

Collaboration diagram for cmtk::Region< NDIM, T >:

List of all members.

Public Types
typedef Region< NDIM, T >	Self
	This class.
typedef FixedVector< NDIM, T >	IndexType
	Index type.
typedef SmartPointer< Self >	SmartPtr
	Smart pointer to this class.
typedef SmartConstPointer< Self >	SmartConstPtr
	Smart pointer-to-const to this class.
Public Member Functions
	Region ()
	Default constructor.
	Region (const typename Self::IndexType &fromIndex, const typename Self::IndexType &toIndex)
	Constructor from two index, from and to.
Self::IndexType &	From ()
	Get "from".
const Self::IndexType &	From () const
	Get const "from".
Self::IndexType &	To ()
	Get "from".
const Self::IndexType &	To () const
	Get const "from".
T	Size () const
	Compute region size (e.g., number of pixels for grid regions).
const Self::IndexType	begin () const
	Region "begin" index.
const Self::IndexType	end () const
	Region "end" index.
Private Attributes
Self::IndexType	m_RegionFrom
	Beginning index.
Self::IndexType	m_RegionTo
	End index.

---

Detailed Description

template<size_t NDIM, typename T = int>
class cmtk::Region< NDIM, T >

Class for n-dimensional image index.

Definition at line 50 of file cmtkRegion.h.

---

Member Typedef Documentation

template<size_t NDIM, typename T = int>

typedef FixedVector<NDIM,T> cmtk::Region< NDIM, T >::IndexType

Index type.

Definition at line 57 of file cmtkRegion.h.

template<size_t NDIM, typename T = int>

typedef Region<NDIM,T> cmtk::Region< NDIM, T >::Self

This class.

Definition at line 54 of file cmtkRegion.h.

template<size_t NDIM, typename T = int>

typedef SmartConstPointer<Self> cmtk::Region< NDIM, T >::SmartConstPtr

Smart pointer-to-const to this class.

Definition at line 63 of file cmtkRegion.h.

template<size_t NDIM, typename T = int>

typedef SmartPointer<Self> cmtk::Region< NDIM, T >::SmartPtr

Smart pointer to this class.

Definition at line 60 of file cmtkRegion.h.

---

Constructor & Destructor Documentation

template<size_t NDIM, typename T = int>

cmtk::Region< NDIM, T >::Region

(

)

[inline]

Default constructor.

Definition at line 66 of file cmtkRegion.h.

template<size_t NDIM, typename T = int>

cmtk::Region< NDIM, T >::Region	(	const typename Self::IndexType &	fromIndex,
		const typename Self::IndexType &	toIndex
	)		[inline]

Constructor from two index, from and to.

Definition at line 69 of file cmtkRegion.h.

---

Member Function Documentation

template<size_t NDIM, typename T = int>

const Self::IndexType cmtk::Region< NDIM, T >::begin

(

)

const [inline]

Region "begin" index.

Definition at line 109 of file cmtkRegion.h.

template<size_t NDIM, typename T = int>

const Self::IndexType cmtk::Region< NDIM, T >::end

(

)

const [inline]

Region "end" index.

Definition at line 115 of file cmtkRegion.h.

template<size_t NDIM, typename T = int>

const Self::IndexType& cmtk::Region< NDIM, T >::From

(

)

const [inline]

Get const "from".

Definition at line 82 of file cmtkRegion.h.

template<size_t NDIM, typename T = int>

Self::IndexType& cmtk::Region< NDIM, T >::From

(

)

[inline]

Get "from".

Definition at line 76 of file cmtkRegion.h.

Referenced by cmtk::ImageOperationCropThreshold::Apply(), cmtk::SplineWarpMultiChannelRegistrationFunctional< TMetricFunctional >::BacktraceMetric(), cmtk::VoxelMatchingElasticFunctional_Template< VM >::EvaluateIncremental(), cmtk::SplineWarpMultiChannelRegistrationFunctional< TMetricFunctional >::EvaluateIncremental(), cmtk::ParallelElasticFunctional< VM >::EvaluateIncremental(), cmtk::ImagePairNonrigidRegistrationFunctionalTemplate< VM >::EvaluateIncremental(), cmtk::FunctionalAffine2D::FunctionalAffine2D(), cmtk::UniformVolume::GetHighResCropRegion(), cmtk::WarpXform::GetInverseConsistencyError(), cmtk::SplineWarpXform::GetInverseConsistencyError(), cmtk::SplineWarpXform::GetJacobianConstraintDerivative(), cmtk::SplineWarpXform::GetJacobianFoldingConstraintDerivative(), cmtk::SplineWarpXform::GetRigidityConstraintDerivative(), cmtk::operator>>(), cmtk::Registration2d2d::Register(), cmtk::ScalarImage::ScalarImage(), cmtk::DataGrid::SetCropRegion(), cmtk::SplineWarpMultiChannelRegistrationFunctional< TMetricFunctional >::UpdateTransformationFixedControlPoints(), cmtk::GroupwiseRegistrationFunctionalXformTemplate< SplineWarpXform >::UpdateVolumesOfInfluence(), cmtk::VoxelMatchingElasticFunctional_Template< VM >::UpdateWarpFixedParameters(), and cmtk::ImagePairNonrigidRegistrationFunctionalTemplate< VM >::UpdateWarpFixedParameters().

template<size_t NDIM, typename T = int>

T cmtk::Region< NDIM, T >::Size

(

)

const [inline]

Compute region size (e.g., number of pixels for grid regions).

Definition at line 100 of file cmtkRegion.h.

Referenced by cmtk::SplineWarpXform::GetJacobianConstraintDerivative(), cmtk::SplineWarpXform::GetJacobianFoldingConstraintDerivative(), cmtk::SplineWarpXform::GetRigidityConstraintDerivative(), and cmtk::GroupwiseRegistrationFunctionalXformTemplate< SplineWarpXform >::UpdateVolumesOfInfluence().

template<size_t NDIM, typename T = int>

Self::IndexType& cmtk::Region< NDIM, T >::To

(

)

[inline]

Get "from".

Definition at line 88 of file cmtkRegion.h.

Referenced by cmtk::ImageOperationCropThreshold::Apply(), cmtk::SplineWarpMultiChannelRegistrationFunctional< TMetricFunctional >::BacktraceMetric(), cmtk::VoxelMatchingElasticFunctional_Template< VM >::EvaluateIncremental(), cmtk::SplineWarpMultiChannelRegistrationFunctional< TMetricFunctional >::EvaluateIncremental(), cmtk::ParallelElasticFunctional< VM >::EvaluateIncremental(), cmtk::ImagePairNonrigidRegistrationFunctionalTemplate< VM >::EvaluateIncremental(), cmtk::UniformVolume::GetHighResCropRegion(), cmtk::WarpXform::GetInverseConsistencyError(), cmtk::SplineWarpXform::GetInverseConsistencyError(), cmtk::SplineWarpXform::GetJacobianConstraintDerivative(), cmtk::SplineWarpXform::GetJacobianFoldingConstraintDerivative(), cmtk::SplineWarpXform::GetRigidityConstraintDerivative(), cmtk::operator>>(), cmtk::ScalarImage::ScalarImage(), cmtk::SplineWarpMultiChannelRegistrationFunctional< TMetricFunctional >::UpdateTransformationFixedControlPoints(), cmtk::GroupwiseRegistrationFunctionalXformTemplate< SplineWarpXform >::UpdateVolumesOfInfluence(), cmtk::VoxelMatchingElasticFunctional_Template< VM >::UpdateWarpFixedParameters(), and cmtk::ImagePairNonrigidRegistrationFunctionalTemplate< VM >::UpdateWarpFixedParameters().

template<size_t NDIM, typename T = int>

const Self::IndexType& cmtk::Region< NDIM, T >::To

(

)

const [inline]

Get const "from".

Definition at line 94 of file cmtkRegion.h.

---

Member Data Documentation

template<size_t NDIM, typename T = int>

Self::IndexType cmtk::Region< NDIM, T >::m_RegionFrom [private]

Beginning index.

Definition at line 124 of file cmtkRegion.h.

template<size_t NDIM, typename T = int>

Self::IndexType cmtk::Region< NDIM, T >::m_RegionTo [private]

End index.

Definition at line 127 of file cmtkRegion.h.

---

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

• libs/Base/cmtkRegion.h