cmtk::VoxelMatchingCorrRatio< I > Class Template Reference [cmtkRegistration Library]

Voxel metric "correlation ratio". More...

#include <cmtkVoxelMatchingCorrRatio.h>

Inheritance diagram for cmtk::VoxelMatchingCorrRatio< I >:

Collaboration diagram for cmtk::VoxelMatchingCorrRatio< I >:

List of all members.

Public Types
typedef VoxelMatchingCorrRatio< I >	Self
	This type.
typedef SmartPointer< Self >	SmartPtr
	Smart pointer.
Public Member Functions
	VoxelMatchingCorrRatio (const UniformVolume *refVolume, const UniformVolume *fltVolume, const unsigned int numBins=CMTK_HISTOGRAM_AUTOBINS)
	Constructor.
void	Reset ()
	Reset computation.
template<class T >
void	Increment (const T a, const T b)
	Continue incremental calculation.
template<class T >
void	Decrement (const T a, const T b)
	Remove a pair of values from the metric.
void	AddMetric (const Self &other)
void	RemoveMetric (const Self &other)
Self::ReturnType	Get () const
	Return correlation ratio.
Private Attributes
size_t	NumBinsX
	Number of bins for the X-distribution.
std::vector< double >	SumJ
	Array with sums of all Y-values by X-bins.
std::vector< double >	SumJ2
	Array with sums of squares of all Y-values by X-bins.
Histogram< unsigned int >	HistogramI
	Histogram with counts of all X-values.
Types::DataItem	SigmaSqJ
Types::DataItem	MuJ
size_t	NumBinsY
	Number of bins for the Y-distribution.
std::vector< double >	SumI
	Array with sums of all X-values by Y-bins.
std::vector< double >	SumI2
	Array with sums of squares of all X-values by Y-bins.
Histogram< unsigned int >	HistogramJ
	Histogram with counts of all X-values.
Types::DataItem	SigmaSqI
Types::DataItem	MuI

---

Detailed Description

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>
class cmtk::VoxelMatchingCorrRatio< I >

Voxel metric "correlation ratio".

Deprecated:

For future code, use cmtk::ImagePairSimilarityMetricCR instead.

Definition at line 53 of file cmtkVoxelMatchingCorrRatio.h.

---

Member Typedef Documentation

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

typedef VoxelMatchingCorrRatio<I> cmtk::VoxelMatchingCorrRatio< I >::Self

This type.

Reimplemented from cmtk::VoxelMatchingMetric< short, TYPE_SHORT, I >.

Definition at line 58 of file cmtkVoxelMatchingCorrRatio.h.

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

typedef SmartPointer<Self> cmtk::VoxelMatchingCorrRatio< I >::SmartPtr

Smart pointer.

Reimplemented from cmtk::VoxelMatchingMetric< short, TYPE_SHORT, I >.

Definition at line 61 of file cmtkVoxelMatchingCorrRatio.h.

---

Constructor & Destructor Documentation

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

cmtk::VoxelMatchingCorrRatio< I >::VoxelMatchingCorrRatio	(	const UniformVolume *	refVolume,
		const UniformVolume *	fltVolume,
		const unsigned int	numBins = CMTK_HISTOGRAM_AUTOBINS
	)		[inline]

Constructor.

The inherited constructor is called to initialize the given datasets. Afterwards, the original (untransformed) probability distribution functions of model and reference are calculated.

Definition at line 68 of file cmtkVoxelMatchingCorrRatio.h.

References CMTK_HISTOGRAM_AUTOBINS, and cmtk::DataGrid::GetNumberOfPixels().

---

Member Function Documentation

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

void cmtk::VoxelMatchingCorrRatio< I >::AddMetric

(

const Self &

other )

[inline]

Definition at line 154 of file cmtkVoxelMatchingCorrRatio.h.

References cmtk::VoxelMatchingCorrRatio< I >::HistogramI, cmtk::VoxelMatchingCorrRatio< I >::HistogramJ, cmtk::VoxelMatchingCorrRatio< I >::SumI, cmtk::VoxelMatchingCorrRatio< I >::SumI2, cmtk::VoxelMatchingCorrRatio< I >::SumJ, and cmtk::VoxelMatchingCorrRatio< I >::SumJ2.

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

template<class T >

void cmtk::VoxelMatchingCorrRatio< I >::Decrement	(	const T	a,
		const T	b
	)		[inline]

Remove a pair of values from the metric.

Definition at line 134 of file cmtkVoxelMatchingCorrRatio.h.

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

template<class T >

void cmtk::VoxelMatchingCorrRatio< I >::Increment	(	const T	a,
		const T	b
	)		[inline]

Continue incremental calculation.

Add a pair of values to the metric.

Definition at line 114 of file cmtkVoxelMatchingCorrRatio.h.

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

void cmtk::VoxelMatchingCorrRatio< I >::RemoveMetric

(

const Self &

other )

[inline]

Definition at line 173 of file cmtkVoxelMatchingCorrRatio.h.

References cmtk::VoxelMatchingCorrRatio< I >::HistogramI, cmtk::VoxelMatchingCorrRatio< I >::HistogramJ, cmtk::VoxelMatchingCorrRatio< I >::SumI, cmtk::VoxelMatchingCorrRatio< I >::SumI2, cmtk::VoxelMatchingCorrRatio< I >::SumJ, and cmtk::VoxelMatchingCorrRatio< I >::SumJ2.

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

void cmtk::VoxelMatchingCorrRatio< I >::Reset

(

)

[inline]

Reset computation.

Initialize arrays that hold the sums of all floating values and their squares, separated by histogram classes of the reference image.

Definition at line 100 of file cmtkVoxelMatchingCorrRatio.h.

---

Member Data Documentation

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

Histogram<unsigned int> cmtk::VoxelMatchingCorrRatio< I >::HistogramI [private]

Histogram with counts of all X-values.

Definition at line 202 of file cmtkVoxelMatchingCorrRatio.h.

Referenced by cmtk::VoxelMatchingCorrRatio< I >::AddMetric(), and cmtk::VoxelMatchingCorrRatio< I >::RemoveMetric().

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

Histogram<unsigned int> cmtk::VoxelMatchingCorrRatio< I >::HistogramJ [private]

Histogram with counts of all X-values.

Definition at line 220 of file cmtkVoxelMatchingCorrRatio.h.

Referenced by cmtk::VoxelMatchingCorrRatio< I >::AddMetric(), and cmtk::VoxelMatchingCorrRatio< I >::RemoveMetric().

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

Types::DataItem cmtk::VoxelMatchingCorrRatio< I >::MuI [private]

Definition at line 226 of file cmtkVoxelMatchingCorrRatio.h.

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

Types::DataItem cmtk::VoxelMatchingCorrRatio< I >::MuJ [private]

Definition at line 208 of file cmtkVoxelMatchingCorrRatio.h.

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

size_t cmtk::VoxelMatchingCorrRatio< I >::NumBinsX [private]

Number of bins for the X-distribution.

Definition at line 193 of file cmtkVoxelMatchingCorrRatio.h.

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

size_t cmtk::VoxelMatchingCorrRatio< I >::NumBinsY [private]

Number of bins for the Y-distribution.

Definition at line 211 of file cmtkVoxelMatchingCorrRatio.h.

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

Types::DataItem cmtk::VoxelMatchingCorrRatio< I >::SigmaSqI [private]

Definition at line 223 of file cmtkVoxelMatchingCorrRatio.h.

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

Types::DataItem cmtk::VoxelMatchingCorrRatio< I >::SigmaSqJ [private]

Definition at line 205 of file cmtkVoxelMatchingCorrRatio.h.

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

std::vector<double> cmtk::VoxelMatchingCorrRatio< I >::SumI [private]

Array with sums of all X-values by Y-bins.

Definition at line 214 of file cmtkVoxelMatchingCorrRatio.h.

Referenced by cmtk::VoxelMatchingCorrRatio< I >::AddMetric(), and cmtk::VoxelMatchingCorrRatio< I >::RemoveMetric().

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

std::vector<double> cmtk::VoxelMatchingCorrRatio< I >::SumI2 [private]

Array with sums of squares of all X-values by Y-bins.

Definition at line 217 of file cmtkVoxelMatchingCorrRatio.h.

Referenced by cmtk::VoxelMatchingCorrRatio< I >::AddMetric(), and cmtk::VoxelMatchingCorrRatio< I >::RemoveMetric().

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

std::vector<double> cmtk::VoxelMatchingCorrRatio< I >::SumJ [private]

Array with sums of all Y-values by X-bins.

Definition at line 196 of file cmtkVoxelMatchingCorrRatio.h.

Referenced by cmtk::VoxelMatchingCorrRatio< I >::AddMetric(), and cmtk::VoxelMatchingCorrRatio< I >::RemoveMetric().

template<Interpolators::InterpolationEnum I = Interpolators::LINEAR>

std::vector<double> cmtk::VoxelMatchingCorrRatio< I >::SumJ2 [private]

Array with sums of squares of all Y-values by X-bins.

Definition at line 199 of file cmtkVoxelMatchingCorrRatio.h.

Referenced by cmtk::VoxelMatchingCorrRatio< I >::AddMetric(), and cmtk::VoxelMatchingCorrRatio< I >::RemoveMetric().

---

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

• libs/Registration/cmtkVoxelMatchingCorrRatio.h
• libs/Registration/cmtkVoxelMatchingCorrRatio.cxx