Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes

mitk::MetricParameters Class Reference
[Classes related to rigid registration]

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

#include <mitkMetricParameters.h>

List of all members.

Public Types

enum  MetricType {
  MEANSQUARESIMAGETOIMAGEMETRIC = 0, NORMALIZEDCORRELATIONIMAGETOIMAGEMETRIC = 1, GRADIENTDIFFERENCEIMAGETOIMAGEMETRIC = 2, KULLBACKLEIBLERCOMPAREHISTOGRAMIMAGETOIMAGEMETRIC = 3,
  CORRELATIONCOEFFICIENTHISTOGRAMIMAGETOIMAGEMETRIC = 4, MEANSQUARESHISTOGRAMIMAGETOIMAGEMETRIC = 5, MUTUALINFORMATIONHISTOGRAMIMAGETOIMAGEMETRIC = 6, NORMALIZEDMUTUALINFORMATIONHISTOGRAMIMAGETOIMAGEMETRIC = 7,
  MATTESMUTUALINFORMATIONIMAGETOIMAGEMETRIC = 8, MEANRECIPROCALSQUAREDIFFERENCEIMAGETOIMAGEMETRIC = 9, MUTUALINFORMATIONIMAGETOIMAGEMETRIC = 10, MATCHCARDINALITYIMAGETOIMAGEMETRIC = 11,
  KAPPASTATISTICIMAGETOIMAGEMETRIC = 12
}
 

Unique integer value for every metric.

More...
typedef MetricParameters Self
typedef ::itk::Object Superclass
typedef itk::SmartPointer< Self > Pointer
typedef itk::SmartPointer
< const Self > 		ConstPointer

Public Member Functions

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

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.

Member Typedef Documentation

typedef itk::SmartPointer<const Self> mitk::MetricParameters::ConstPointer

Definition at line 45 of file mitkMetricParameters.h.

typedef itk::SmartPointer<Self> mitk::MetricParameters::Pointer

Definition at line 45 of file mitkMetricParameters.h.

typedef MetricParameters mitk::MetricParameters::Self

Definition at line 45 of file mitkMetricParameters.h.

typedef ::itk::Object mitk::MetricParameters::Superclass

Definition at line 45 of file mitkMetricParameters.h.

Member Enumeration Documentation

enum mitk::MetricParameters::MetricType

Unique integer value for every metric.

Enumerator:
MEANSQUARESIMAGETOIMAGEMETRIC 
NORMALIZEDCORRELATIONIMAGETOIMAGEMETRIC 
GRADIENTDIFFERENCEIMAGETOIMAGEMETRIC 
KULLBACKLEIBLERCOMPAREHISTOGRAMIMAGETOIMAGEMETRIC 
CORRELATIONCOEFFICIENTHISTOGRAMIMAGETOIMAGEMETRIC 
MEANSQUARESHISTOGRAMIMAGETOIMAGEMETRIC 
MUTUALINFORMATIONHISTOGRAMIMAGETOIMAGEMETRIC 
NORMALIZEDMUTUALINFORMATIONHISTOGRAMIMAGETOIMAGEMETRIC 
MATTESMUTUALINFORMATIONIMAGETOIMAGEMETRIC 
MEANRECIPROCALSQUAREDIFFERENCEIMAGETOIMAGEMETRIC 
MUTUALINFORMATIONIMAGETOIMAGEMETRIC 
MATCHCARDINALITYIMAGETOIMAGEMETRIC 
KAPPASTATISTICIMAGETOIMAGEMETRIC 

Definition at line 51 of file mitkMetricParameters.h.

                    {
      MEANSQUARESIMAGETOIMAGEMETRIC = 0,
      NORMALIZEDCORRELATIONIMAGETOIMAGEMETRIC = 1,
      GRADIENTDIFFERENCEIMAGETOIMAGEMETRIC = 2,
      KULLBACKLEIBLERCOMPAREHISTOGRAMIMAGETOIMAGEMETRIC = 3,
      CORRELATIONCOEFFICIENTHISTOGRAMIMAGETOIMAGEMETRIC = 4,
      MEANSQUARESHISTOGRAMIMAGETOIMAGEMETRIC = 5,
      MUTUALINFORMATIONHISTOGRAMIMAGETOIMAGEMETRIC = 6,
      NORMALIZEDMUTUALINFORMATIONHISTOGRAMIMAGETOIMAGEMETRIC = 7,
      MATTESMUTUALINFORMATIONIMAGETOIMAGEMETRIC = 8,
      MEANRECIPROCALSQUAREDIFFERENCEIMAGETOIMAGEMETRIC = 9,
      MUTUALINFORMATIONIMAGETOIMAGEMETRIC = 10,
      MATCHCARDINALITYIMAGETOIMAGEMETRIC = 11,
      KAPPASTATISTICIMAGETOIMAGEMETRIC = 12
    };

Constructor & Destructor Documentation

mitk::MetricParameters::MetricParameters (  ) [protected]

Definition at line 24 of file mitkMetricParameters.cpp.

                                     : 
    m_Metric(MEANSQUARESIMAGETOIMAGEMETRIC),
    m_ComputeGradient(true),
    // for itk::KullbackLeiblerCompareHistogramImageToImageMetric
    m_NumberOfHistogramBinsKullbackLeiblerCompareHistogram(256),
    // for itk::CorrelationCoefficientHistogramImageToImageMetric
    m_NumberOfHistogramBinsCorrelationCoefficientHistogram(256),
    // for itk::MeanSquaresHistogramImageToImageMetric
    m_NumberOfHistogramBinsMeanSquaresHistogram(256),
    // for itk::MutualInformationHistogramImageToImageMetric
    m_NumberOfHistogramBinsMutualInformationHistogram(256),
    // for itk::NormalizedMutualInformationHistogramImageToImageMetric
    m_NumberOfHistogramBinsNormalizedMutualInformationHistogram(256),
    // for itk::MattesMutualInformationImageToImageMetric
    m_NumberOfHistogramBinsMattesMutualInformation(256),
    m_UseSamplesMattesMutualInformation(true),
    m_SpatialSamplesMattesMutualInformation(500),
    // for itk::MeanReciprocalSquareDifferenceImageToImageMetric
    m_LambdaMeanReciprocalSquareDifference(10),
    // for itk::MutualInformationImageToImageMetric
    m_SpatialSamplesMutualInformation(100),
    m_FixedImageStandardDeviationMutualInformation(0.4),
    m_MovingImageStandardDeviationMutualInformation(0.4),
    m_UseNormalizerAndSmootherMutualInformation(true),
    m_FixedSmootherVarianceMutualInformation(0.2),
    m_MovingSmootherVarianceMutualInformation(0.2)
  {

  }
mitk::MetricParameters::~MetricParameters (  ) [inline, protected]

Definition at line 237 of file mitkMetricParameters.h.

{};

Member Function Documentation

virtual const char* mitk::MetricParameters::GetClassName (  ) const [virtual]
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

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:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines
Generated on Tue Oct 19 2010 16:20:38 for mitk by  doxygen 1.7.2