cmtk::ImagePairSimilarityJointHistogram Class Reference [cmtkRegistration Library]

Base class for voxel metrics with pre-converted image data. More...

#include <cmtkImagePairSimilarityJointHistogram.h>

Inheritance diagram for cmtk::ImagePairSimilarityJointHistogram:

Collaboration diagram for cmtk::ImagePairSimilarityJointHistogram:

List of all members.

Public Types
typedef ImagePairSimilarityJointHistogram	Self
	This type.
typedef SmartPointer< Self >	SmartPtr
	Smart pointer.
typedef ImagePairSimilarityMeasure	Superclass
	Parent class.
typedef Functional::ReturnType	ReturnType
	Return type: same as cmtk::Functional.
Public Member Functions
	ImagePairSimilarityJointHistogram (UniformVolume::SmartConstPtr &refVolume, UniformVolume::SmartConstPtr &fltVolume, const Interpolators::InterpolationEnum interpolation=Interpolators::DEFAULT)
	Constructor.
	ImagePairSimilarityJointHistogram ()
	Default constructor.
virtual	~ImagePairSimilarityJointHistogram ()
	Virtual destructor.
virtual void	SetReferenceVolume (const UniformVolume::SmartConstPtr &refVolume)
	Set reference volume.
virtual void	SetFloatingVolume (const UniformVolume::SmartConstPtr &fltVolume)
	Set floating volume.
virtual void	Reset ()
	Reset computation: clear joint histogram.
template<class T >
void	Increment (const T a, const T b)
	Add a pair of values to the metric.
template<class T >
void	Decrement (const T a, const T b)
	Remove a pair of values from the metric.
void	Add (const Self &other)
	Add another metric object to this one.
void	Remove (const Self &other)
	Add another metric object to this one.
virtual Types::DataItem	GetFloatingValueScaled (const Types::DataItem value) const
	Get scaled floating value if this metric rescales (implemented in derived classes), or input value if it does not (done here as the default).
Protected Attributes
size_t	m_NumberOfBinsX
	Number of X bins (reference image)
size_t	m_NumberOfBinsY
	Number of Y bins (floating image)
JointHistogram< unsigned int >	m_JointHistogram
	The joint histogram.
Private Member Functions
UniformVolume::SmartPtr	PrescaleData (const UniformVolume::SmartConstPtr &volume, size_t *numberOfBins, Types::DataItem *scaleFactor, Types::DataItem *scaleOffset)
	Duplicate and pre-scale image data so that we have the histogram bin numbers readily available.
Private Attributes
Types::DataItem	m_ScaleOffsetReference
	Store reference data rescaling offset.
Types::DataItem	m_ScaleFactorReference
	Store reference data rescaling factor.
Types::DataItem	m_ScaleOffsetFloating
	Store floating data rescaling offset.
Types::DataItem	m_ScaleFactorFloating
	Store floating data rescaling factor.

---

Detailed Description

Base class for voxel metrics with pre-converted image data.

Definition at line 58 of file cmtkImagePairSimilarityJointHistogram.h.

---

Member Typedef Documentation

typedef Functional::ReturnType cmtk::ImagePairSimilarityJointHistogram::ReturnType

Return type: same as cmtk::Functional.

Reimplemented from cmtk::ImagePairSimilarityMeasure.

Reimplemented in cmtk::ImagePairSimilarityMeasureMI, and cmtk::ImagePairSimilarityMeasureNMI.

Definition at line 73 of file cmtkImagePairSimilarityJointHistogram.h.

typedef ImagePairSimilarityJointHistogram cmtk::ImagePairSimilarityJointHistogram::Self

This type.

Reimplemented from cmtk::ImagePairSimilarityMeasure.

Reimplemented in cmtk::ImagePairSimilarityMeasureMI, and cmtk::ImagePairSimilarityMeasureNMI.

Definition at line 64 of file cmtkImagePairSimilarityJointHistogram.h.

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

Smart pointer.

Reimplemented from cmtk::ImagePairSimilarityMeasure.

Reimplemented in cmtk::ImagePairSimilarityMeasureMI, and cmtk::ImagePairSimilarityMeasureNMI.

Definition at line 67 of file cmtkImagePairSimilarityJointHistogram.h.

typedef ImagePairSimilarityMeasure cmtk::ImagePairSimilarityJointHistogram::Superclass

Parent class.

Definition at line 70 of file cmtkImagePairSimilarityJointHistogram.h.

---

Constructor & Destructor Documentation

cmtk::ImagePairSimilarityJointHistogram::ImagePairSimilarityJointHistogram

(

)

[inline]

Default constructor.

Definition at line 85 of file cmtkImagePairSimilarityJointHistogram.h.

virtual cmtk::ImagePairSimilarityJointHistogram::~ImagePairSimilarityJointHistogram

(

)

[inline, virtual]

Virtual destructor.

Definition at line 89 of file cmtkImagePairSimilarityJointHistogram.h.

---

Member Function Documentation

void cmtk::ImagePairSimilarityJointHistogram::Add

(

const Self &

other )

[inline]

Add another metric object to this one.

Definition at line 126 of file cmtkImagePairSimilarityJointHistogram.h.

References m_JointHistogram.

template<class T >

void cmtk::ImagePairSimilarityJointHistogram::Decrement	(	const T	a,
		const T	b
	)		[inline]

Remove a pair of values from the metric.

Definition at line 120 of file cmtkImagePairSimilarityJointHistogram.h.

virtual Types::DataItem cmtk::ImagePairSimilarityJointHistogram::GetFloatingValueScaled

(

const Types::DataItem

value )

const [inline, virtual]

Get scaled floating value if this metric rescales (implemented in derived classes), or input value if it does not (done here as the default).

Reimplemented from cmtk::ImagePairSimilarityMeasure.

Definition at line 138 of file cmtkImagePairSimilarityJointHistogram.h.

template<class T >

void cmtk::ImagePairSimilarityJointHistogram::Increment	(	const T	a,
		const T	b
	)		[inline]

Add a pair of values to the metric.

Definition at line 113 of file cmtkImagePairSimilarityJointHistogram.h.

void cmtk::ImagePairSimilarityJointHistogram::Remove

(

const Self &

other )

[inline]

Add another metric object to this one.

Definition at line 132 of file cmtkImagePairSimilarityJointHistogram.h.

References m_JointHistogram.

virtual void cmtk::ImagePairSimilarityJointHistogram::Reset

(

)

[inline, virtual]

Reset computation: clear joint histogram.

Reimplemented from cmtk::ImagePairSimilarityMeasure.

Definition at line 106 of file cmtkImagePairSimilarityJointHistogram.h.

---

Member Data Documentation

JointHistogram<unsigned int> cmtk::ImagePairSimilarityJointHistogram::m_JointHistogram [protected]

The joint histogram.

Definition at line 151 of file cmtkImagePairSimilarityJointHistogram.h.

Referenced by Add(), and Remove().

size_t cmtk::ImagePairSimilarityJointHistogram::m_NumberOfBinsX [protected]

Number of X bins (reference image)

Definition at line 145 of file cmtkImagePairSimilarityJointHistogram.h.

size_t cmtk::ImagePairSimilarityJointHistogram::m_NumberOfBinsY [protected]

Number of Y bins (floating image)

Definition at line 148 of file cmtkImagePairSimilarityJointHistogram.h.

Types::DataItem cmtk::ImagePairSimilarityJointHistogram::m_ScaleFactorFloating [private]

Store floating data rescaling factor.

Definition at line 175 of file cmtkImagePairSimilarityJointHistogram.h.

Types::DataItem cmtk::ImagePairSimilarityJointHistogram::m_ScaleFactorReference [private]

Store reference data rescaling factor.

Definition at line 169 of file cmtkImagePairSimilarityJointHistogram.h.

Types::DataItem cmtk::ImagePairSimilarityJointHistogram::m_ScaleOffsetFloating [private]

Store floating data rescaling offset.

Definition at line 172 of file cmtkImagePairSimilarityJointHistogram.h.

Types::DataItem cmtk::ImagePairSimilarityJointHistogram::m_ScaleOffsetReference [private]

Store reference data rescaling offset.

Definition at line 166 of file cmtkImagePairSimilarityJointHistogram.h.

---

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

• libs/Registration/cmtkImagePairSimilarityJointHistogram.h
• libs/Registration/cmtkImagePairSimilarityJointHistogram.cxx