mitk::MetricParameters Class Reference

This class is used to hold all metric parameters needed for a rigid registration process. More...

#include <mitkMetricParameters.h>

Inheritance diagram for mitk::MetricParameters:

Collaboration diagram for mitk::MetricParameters:

Public Types
enum	MetricType {   MEANSQUARESIMAGETOIMAGEMETRIC, NORMALIZEDCORRELATIONIMAGETOIMAGEMETRIC, GRADIENTDIFFERENCEIMAGETOIMAGEMETRIC, KULLBACKLEIBLERCOMPAREHISTOGRAMIMAGETOIMAGEMETRIC,   CORRELATIONCOEFFICIENTHISTOGRAMIMAGETOIMAGEMETRIC, MEANSQUARESHISTOGRAMIMAGETOIMAGEMETRIC, MUTUALINFORMATIONHISTOGRAMIMAGETOIMAGEMETRIC, NORMALIZEDMUTUALINFORMATIONHISTOGRAMIMAGETOIMAGEMETRIC,   MATTESMUTUALINFORMATIONIMAGETOIMAGEMETRIC, MEANRECIPROCALSQUAREDIFFERENCEIMAGETOIMAGEMETRIC, MUTUALINFORMATIONIMAGETOIMAGEMETRIC, MATCHCARDINALITYIMAGETOIMAGEMETRIC,   KAPPASTATISTICIMAGETOIMAGEMETRIC }
	Unique integer value for every metric. More...

Public Member Functions
	mitkClassMacroItkParent (MetricParameters,::itk::Object)
Pointer	Clone () const
virtual void	SetMetric (int _arg)
	Sets the metric used for registration by its unique integer value. More...
virtual int	GetMetric ()
	Returns the metric used for registration by its unique integer value. More...
virtual void	SetComputeGradient (bool _arg)
	Sets whether a gradient image has to be computed. Some optimizer need this. More...
virtual bool	GetComputeGradient ()
	Returns whether a gradient image has to be computed. More...
virtual void	SetNumberOfHistogramBinsKullbackLeiblerCompareHistogram (unsigned int _arg)
	for itk::KullbackLeiblerCompareHistogramImageToImageMetric More...
virtual unsigned int	GetNumberOfHistogramBinsKullbackLeiblerCompareHistogram ()
	for itk::KullbackLeiblerCompareHistogramImageToImageMetric More...
virtual void	SetNumberOfHistogramBinsCorrelationCoefficientHistogram (unsigned int _arg)
	for itk::CorrelationCoefficientHistogramImageToImageMetric More...
virtual unsigned int	GetNumberOfHistogramBinsCorrelationCoefficientHistogram ()
	for itk::CorrelationCoefficientHistogramImageToImageMetric More...
virtual void	SetNumberOfHistogramBinsMeanSquaresHistogram (unsigned int _arg)
	for itk::MeanSquaresHistogramImageToImageMetric More...
virtual unsigned int	GetNumberOfHistogramBinsMeanSquaresHistogram ()
	for itk::MeanSquaresHistogramImageToImageMetric More...
virtual void	SetNumberOfHistogramBinsMutualInformationHistogram (unsigned int _arg)
	for itk::MutualInformationHistogramImageToImageMetric More...
virtual unsigned int	GetNumberOfHistogramBinsMutualInformationHistogram ()
	for itk::MutualInformationHistogramImageToImageMetric More...
virtual void	SetNumberOfHistogramBinsNormalizedMutualInformationHistogram (unsigned int _arg)
	for itk::NormalizedMutualInformationHistogramImageToImageMetric More...
virtual unsigned int	GetNumberOfHistogramBinsNormalizedMutualInformationHistogram ()
	for itk::NormalizedMutualInformationHistogramImageToImageMetric More...
virtual void	SetSpatialSamplesMattesMutualInformation (unsigned int _arg)
	for itk::MattesMutualInformationImageToImageMetric More...
virtual unsigned int	GetSpatialSamplesMattesMutualInformation ()
	for itk::MattesMutualInformationImageToImageMetric More...
virtual void	SetUseSamplesMattesMutualInformation (bool _arg)
	for itk::MattesMutualInformationImageToImageMetric More...
virtual bool	GetUseSamplesMattesMutualInformation ()
	for itk::MattesMutualInformationImageToImageMetric More...
virtual void	SetNumberOfHistogramBinsMattesMutualInformation (unsigned int _arg)
	for itk::MattesMutualInformationImageToImageMetric More...
virtual unsigned int	GetNumberOfHistogramBinsMattesMutualInformation ()
	for itk::MattesMutualInformationImageToImageMetric More...
virtual void	SetLambdaMeanReciprocalSquareDifference (unsigned int _arg)
	for itk::MeanReciprocalSquareDifferenceImageToImageMetric More...
virtual unsigned int	GetLambdaMeanReciprocalSquareDifference ()
	for itk::MeanReciprocalSquareDifferenceImageToImageMetric More...
virtual void	SetSpatialSamplesMutualInformation (unsigned int _arg)
	for itk::MutualInformationImageToImageMetric More...
virtual unsigned int	GetSpatialSamplesMutualInformation ()
	for itk::MutualInformationImageToImageMetric More...
virtual void	SetFixedImageStandardDeviationMutualInformation (float _arg)
	for itk::MutualInformationImageToImageMetric More...
virtual float	GetFixedImageStandardDeviationMutualInformation ()
	for itk::MutualInformationImageToImageMetric More...
virtual void	SetMovingImageStandardDeviationMutualInformation (float _arg)
	for itk::MutualInformationImageToImageMetric More...
virtual float	GetMovingImageStandardDeviationMutualInformation ()
	for itk::MutualInformationImageToImageMetric More...
virtual void	SetUseNormalizerAndSmootherMutualInformation (bool _arg)
	for itk::MutualInformationImageToImageMetric More...
virtual bool	GetUseNormalizerAndSmootherMutualInformation ()
	for itk::MutualInformationImageToImageMetric More...
virtual void	SetFixedSmootherVarianceMutualInformation (float _arg)
	for itk::MutualInformationImageToImageMetric More...
virtual float	GetFixedSmootherVarianceMutualInformation ()
	for itk::MutualInformationImageToImageMetric More...
virtual void	SetMovingSmootherVarianceMutualInformation (float _arg)
	for itk::MutualInformationImageToImageMetric More...
virtual float	GetMovingSmootherVarianceMutualInformation ()
	for itk::MutualInformationImageToImageMetric More...

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	MetricParameters ()
	~MetricParameters ()

Protected Attributes
int	m_Metric
bool	m_ComputeGradient
unsigned int	m_NumberOfHistogramBinsKullbackLeiblerCompareHistogram
unsigned int	m_NumberOfHistogramBinsCorrelationCoefficientHistogram
unsigned int	m_NumberOfHistogramBinsMeanSquaresHistogram
unsigned int	m_NumberOfHistogramBinsMutualInformationHistogram
unsigned int	m_NumberOfHistogramBinsNormalizedMutualInformationHistogram
unsigned int	m_NumberOfHistogramBinsMattesMutualInformation
bool	m_UseSamplesMattesMutualInformation
unsigned int	m_SpatialSamplesMattesMutualInformation
unsigned int	m_LambdaMeanReciprocalSquareDifference
unsigned int	m_SpatialSamplesMutualInformation
float	m_FixedImageStandardDeviationMutualInformation
float	m_MovingImageStandardDeviationMutualInformation
bool	m_UseNormalizerAndSmootherMutualInformation
float	m_FixedSmootherVarianceMutualInformation
float	m_MovingSmootherVarianceMutualInformation

Detailed Description

This class is used to hold all metric parameters needed for a rigid registration process.

To use the rigid registration framework you have to create an instance of this class and fill it with the parameters belonging to the selected metric. To let the rigid registration work properly, this instance has to be given to mitkImageRegistrationMethod before calling the update() method in mitkImageRegistrationMethod.

Also instances of the classes mitkTransformParameters and mitkOptimizerParameters have to be set in mitkImageRegistrationMethod before calling the update() method.

Author

Daniel Stein

Definition at line 42 of file mitkMetricParameters.h.

Constructor & Destructor Documentation

mitk::MetricParameters::MetricParameters ( )

protected

Definition at line 21 of file mitkMetricParameters.cpp.

mitk::MetricParameters::~MetricParameters ( )

inlineprotected

Definition at line 237 of file mitkMetricParameters.h.

Member Function Documentation

Pointer mitk::MetricParameters::Clone

(

)

const

virtual bool mitk::MetricParameters::GetComputeGradient ( )

virtual

Returns whether a gradient image has to be computed.

virtual float mitk::MetricParameters::GetFixedImageStandardDeviationMutualInformation ( )

virtual

for itk::MutualInformationImageToImageMetric

virtual float mitk::MetricParameters::GetFixedSmootherVarianceMutualInformation ( )

virtual

for itk::MutualInformationImageToImageMetric

virtual unsigned int mitk::MetricParameters::GetLambdaMeanReciprocalSquareDifference ( )

virtual

for itk::MeanReciprocalSquareDifferenceImageToImageMetric

virtual int mitk::MetricParameters::GetMetric ( )

virtual

Returns the metric used for registration by its unique integer value.

virtual float mitk::MetricParameters::GetMovingImageStandardDeviationMutualInformation ( )

virtual

for itk::MutualInformationImageToImageMetric

virtual float mitk::MetricParameters::GetMovingSmootherVarianceMutualInformation ( )

virtual

for itk::MutualInformationImageToImageMetric

virtual unsigned int mitk::MetricParameters::GetNumberOfHistogramBinsCorrelationCoefficientHistogram ( )

virtual

for itk::CorrelationCoefficientHistogramImageToImageMetric

virtual unsigned int mitk::MetricParameters::GetNumberOfHistogramBinsKullbackLeiblerCompareHistogram ( )

virtual

for itk::KullbackLeiblerCompareHistogramImageToImageMetric

virtual unsigned int mitk::MetricParameters::GetNumberOfHistogramBinsMattesMutualInformation ( )

virtual

for itk::MattesMutualInformationImageToImageMetric

virtual unsigned int mitk::MetricParameters::GetNumberOfHistogramBinsMeanSquaresHistogram ( )

virtual

for itk::MeanSquaresHistogramImageToImageMetric

virtual unsigned int mitk::MetricParameters::GetNumberOfHistogramBinsMutualInformationHistogram ( )

virtual

for itk::MutualInformationHistogramImageToImageMetric

virtual unsigned int mitk::MetricParameters::GetNumberOfHistogramBinsNormalizedMutualInformationHistogram ( )

virtual

for itk::NormalizedMutualInformationHistogramImageToImageMetric

virtual unsigned int mitk::MetricParameters::GetSpatialSamplesMattesMutualInformation ( )

virtual

for itk::MattesMutualInformationImageToImageMetric

virtual unsigned int mitk::MetricParameters::GetSpatialSamplesMutualInformation ( )

virtual

for itk::MutualInformationImageToImageMetric

virtual bool mitk::MetricParameters::GetUseNormalizerAndSmootherMutualInformation ( )

virtual

for itk::MutualInformationImageToImageMetric

virtual bool mitk::MetricParameters::GetUseSamplesMattesMutualInformation ( )

virtual

for itk::MattesMutualInformationImageToImageMetric

mitk::MetricParameters::mitkClassMacroItkParent	(	MetricParameters	,
		::itk::Object
	)

static Pointer mitk::MetricParameters::New ( )

static

Referenced by mitk::PyramidalRegistrationMethod::PyramidalRegistrationMethod().

virtual void mitk::MetricParameters::SetComputeGradient ( bool  _arg )

virtual

Sets whether a gradient image has to be computed. Some optimizer need this.

virtual void mitk::MetricParameters::SetFixedImageStandardDeviationMutualInformation ( float  _arg )

virtual

for itk::MutualInformationImageToImageMetric

virtual void mitk::MetricParameters::SetFixedSmootherVarianceMutualInformation ( float  _arg )

virtual

for itk::MutualInformationImageToImageMetric

virtual void mitk::MetricParameters::SetLambdaMeanReciprocalSquareDifference ( unsigned int  _arg )

virtual

for itk::MeanReciprocalSquareDifferenceImageToImageMetric

virtual void mitk::MetricParameters::SetMetric ( int  _arg )

virtual

Sets the metric used for registration by its unique integer value.

virtual void mitk::MetricParameters::SetMovingImageStandardDeviationMutualInformation ( float  _arg )

virtual

for itk::MutualInformationImageToImageMetric

virtual void mitk::MetricParameters::SetMovingSmootherVarianceMutualInformation ( float  _arg )

virtual

for itk::MutualInformationImageToImageMetric

virtual void mitk::MetricParameters::SetNumberOfHistogramBinsCorrelationCoefficientHistogram ( unsigned int  _arg )

virtual

for itk::CorrelationCoefficientHistogramImageToImageMetric

virtual void mitk::MetricParameters::SetNumberOfHistogramBinsKullbackLeiblerCompareHistogram ( unsigned int  _arg )

virtual

for itk::KullbackLeiblerCompareHistogramImageToImageMetric

virtual void mitk::MetricParameters::SetNumberOfHistogramBinsMattesMutualInformation ( unsigned int  _arg )

virtual

for itk::MattesMutualInformationImageToImageMetric

virtual void mitk::MetricParameters::SetNumberOfHistogramBinsMeanSquaresHistogram ( unsigned int  _arg )

virtual

for itk::MeanSquaresHistogramImageToImageMetric

virtual void mitk::MetricParameters::SetNumberOfHistogramBinsMutualInformationHistogram ( unsigned int  _arg )

virtual

for itk::MutualInformationHistogramImageToImageMetric

virtual void mitk::MetricParameters::SetNumberOfHistogramBinsNormalizedMutualInformationHistogram ( unsigned int  _arg )

virtual

for itk::NormalizedMutualInformationHistogramImageToImageMetric

virtual void mitk::MetricParameters::SetSpatialSamplesMattesMutualInformation ( unsigned int  _arg )

virtual

for itk::MattesMutualInformationImageToImageMetric

virtual void mitk::MetricParameters::SetSpatialSamplesMutualInformation ( unsigned int  _arg )

virtual

for itk::MutualInformationImageToImageMetric

virtual void mitk::MetricParameters::SetUseNormalizerAndSmootherMutualInformation ( bool  _arg )

virtual

for itk::MutualInformationImageToImageMetric

virtual void mitk::MetricParameters::SetUseSamplesMattesMutualInformation ( bool  _arg )

virtual

for itk::MattesMutualInformationImageToImageMetric

Member Data Documentation

bool mitk::MetricParameters::m_ComputeGradient

protected

Definition at line 240 of file mitkMetricParameters.h.

float mitk::MetricParameters::m_FixedImageStandardDeviationMutualInformation

protected

Definition at line 259 of file mitkMetricParameters.h.

float mitk::MetricParameters::m_FixedSmootherVarianceMutualInformation

protected

Definition at line 262 of file mitkMetricParameters.h.

unsigned int mitk::MetricParameters::m_LambdaMeanReciprocalSquareDifference

protected

Definition at line 256 of file mitkMetricParameters.h.

int mitk::MetricParameters::m_Metric

protected

Definition at line 237 of file mitkMetricParameters.h.

float mitk::MetricParameters::m_MovingImageStandardDeviationMutualInformation

protected

Definition at line 260 of file mitkMetricParameters.h.

float mitk::MetricParameters::m_MovingSmootherVarianceMutualInformation

protected

Definition at line 263 of file mitkMetricParameters.h.

unsigned int mitk::MetricParameters::m_NumberOfHistogramBinsCorrelationCoefficientHistogram

protected

Definition at line 244 of file mitkMetricParameters.h.

unsigned int mitk::MetricParameters::m_NumberOfHistogramBinsKullbackLeiblerCompareHistogram

protected

Definition at line 242 of file mitkMetricParameters.h.

unsigned int mitk::MetricParameters::m_NumberOfHistogramBinsMattesMutualInformation

protected

Definition at line 252 of file mitkMetricParameters.h.

unsigned int mitk::MetricParameters::m_NumberOfHistogramBinsMeanSquaresHistogram

protected

Definition at line 246 of file mitkMetricParameters.h.

unsigned int mitk::MetricParameters::m_NumberOfHistogramBinsMutualInformationHistogram

protected

Definition at line 248 of file mitkMetricParameters.h.

unsigned int mitk::MetricParameters::m_NumberOfHistogramBinsNormalizedMutualInformationHistogram

protected

Definition at line 250 of file mitkMetricParameters.h.

unsigned int mitk::MetricParameters::m_SpatialSamplesMattesMutualInformation

protected

Definition at line 254 of file mitkMetricParameters.h.

unsigned int mitk::MetricParameters::m_SpatialSamplesMutualInformation

protected

Definition at line 258 of file mitkMetricParameters.h.

bool mitk::MetricParameters::m_UseNormalizerAndSmootherMutualInformation

protected

Definition at line 261 of file mitkMetricParameters.h.

bool mitk::MetricParameters::m_UseSamplesMattesMutualInformation

protected

Definition at line 253 of file mitkMetricParameters.h.

---

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

• mitkMetricParameters.h
• mitkMetricParameters.cpp