Public Types | Public Member Functions | Private Attributes

cmtk::ImagePairSimilarityMeasure Class Reference
[cmtkRegistration Library]

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

#include <cmtkImagePairSimilarityMeasure.h>

Inheritance diagram for cmtk::ImagePairSimilarityMeasure:
Inheritance graph
[legend]
Collaboration diagram for cmtk::ImagePairSimilarityMeasure:
Collaboration graph
[legend]

List of all members.

Public Types

typedef ImagePairSimilarityMeasure Self
 This type.
typedef SmartPointer< SelfSmartPtr
 Smart pointer.
typedef Functional::ReturnType ReturnType
 Return type: same as cmtk::Functional.

Public Member Functions

 ImagePairSimilarityMeasure (const UniformVolume::SmartConstPtr &refVolume, const UniformVolume::SmartConstPtr &fltVolume, const Interpolators::InterpolationEnum interpolation=Interpolators::DEFAULT)
 Constructor.
 ImagePairSimilarityMeasure ()
 Default constructor.
virtual ~ImagePairSimilarityMeasure ()
 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 metric computation.
Types::DataItem GetSampleX (const size_t index) const
 Get a value from the X distribution (reference image).
bool GetSampleX (Types::DataItem &sample, const size_t index) const
 Get a value from the X distribution (reference image).
size_t GetNumberOfSamplesX () const
 Get number of samples in the X data (reference image pixels).
const Types::DataItemRange GetDataRangeX () const
 Get value range of X data (reference data).
Types::DataItem GetSampleY (const int *index, const Types::Coordinate *frac) const
 Interpolate a value from the Y distribution (floating image).
size_t GetNumberOfSamplesY () const
 Get number of samples in the Y data (floating image pixels).
const Types::DataItemRange GetDataRangeY () const
 Get value range of Y data (floating data).
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).
virtual Self::ReturnType Get () const =0
 Get the value of the metric.

Private Attributes

UniformVolume::SmartConstPtr m_ReferenceVolume
 Smart pointer to reference volume.
TypedArray::SmartConstPtr m_ReferenceData
 Smart pointer to reference image data.
UniformVolume::SmartConstPtr m_FloatingVolume
 Smart pointer to floating volume.
TypedArray::SmartConstPtr m_FloatingData
 Smart pointer to floating image data.
Interpolators::InterpolationEnum m_InterpolationMethod
 Interpolation method ID.
cmtk::UniformVolumeInterpolatorBase::SmartConstPtr m_FloatingImageInterpolator
 Floating image interpolator.

Detailed Description

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

Definition at line 54 of file cmtkImagePairSimilarityMeasure.h.


Member Typedef Documentation


Constructor & Destructor Documentation

cmtk::ImagePairSimilarityMeasure::ImagePairSimilarityMeasure (  ) [inline]

Default constructor.

Definition at line 76 of file cmtkImagePairSimilarityMeasure.h.

virtual cmtk::ImagePairSimilarityMeasure::~ImagePairSimilarityMeasure (  ) [inline, virtual]

Virtual destructor.

Definition at line 79 of file cmtkImagePairSimilarityMeasure.h.


Member Function Documentation

virtual Self::ReturnType cmtk::ImagePairSimilarityMeasure::Get (  ) const [pure virtual]
const Types::DataItemRange cmtk::ImagePairSimilarityMeasure::GetDataRangeX (  ) const [inline]

Get value range of X data (reference data).

Definition at line 113 of file cmtkImagePairSimilarityMeasure.h.

const Types::DataItemRange cmtk::ImagePairSimilarityMeasure::GetDataRangeY (  ) const [inline]

Get value range of Y data (floating data).

Definition at line 131 of file cmtkImagePairSimilarityMeasure.h.

virtual Types::DataItem cmtk::ImagePairSimilarityMeasure::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 in cmtk::ImagePairSimilarityJointHistogram.

Definition at line 137 of file cmtkImagePairSimilarityMeasure.h.

size_t cmtk::ImagePairSimilarityMeasure::GetNumberOfSamplesX (  ) const [inline]

Get number of samples in the X data (reference image pixels).

Definition at line 107 of file cmtkImagePairSimilarityMeasure.h.

size_t cmtk::ImagePairSimilarityMeasure::GetNumberOfSamplesY (  ) const [inline]

Get number of samples in the Y data (floating image pixels).

Definition at line 125 of file cmtkImagePairSimilarityMeasure.h.

bool cmtk::ImagePairSimilarityMeasure::GetSampleX ( Types::DataItem sample,
const size_t  index 
) const [inline]

Get a value from the X distribution (reference image).

Definition at line 101 of file cmtkImagePairSimilarityMeasure.h.

Types::DataItem cmtk::ImagePairSimilarityMeasure::GetSampleX ( const size_t  index ) const [inline]

Get a value from the X distribution (reference image).

Definition at line 93 of file cmtkImagePairSimilarityMeasure.h.

Types::DataItem cmtk::ImagePairSimilarityMeasure::GetSampleY ( const int *  index,
const Types::Coordinate frac 
) const [inline]

Interpolate a value from the Y distribution (floating image).

Definition at line 119 of file cmtkImagePairSimilarityMeasure.h.

virtual void cmtk::ImagePairSimilarityMeasure::Reset (  ) [inline, virtual]

Member Data Documentation

Smart pointer to floating image data.

Definition at line 156 of file cmtkImagePairSimilarityMeasure.h.

Floating image interpolator.

Definition at line 162 of file cmtkImagePairSimilarityMeasure.h.

Smart pointer to floating volume.

Definition at line 153 of file cmtkImagePairSimilarityMeasure.h.

Interpolation method ID.

Definition at line 159 of file cmtkImagePairSimilarityMeasure.h.

Smart pointer to reference image data.

Definition at line 150 of file cmtkImagePairSimilarityMeasure.h.

Smart pointer to reference volume.

Definition at line 147 of file cmtkImagePairSimilarityMeasure.h.


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