go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions
elastix::NormalizedMutualInformationMetric< TElastix > Class Template Reference

#include <elxNormalizedMutualInformationMetric.h>

Inheritance diagram for elastix::NormalizedMutualInformationMetric< TElastix >:
Inheritance graph
[legend]
Collaboration diagram for elastix::NormalizedMutualInformationMetric< TElastix >:
Collaboration graph
[legend]

Public Types

typedef
Superclass2::ConfigurationPointer 
ConfigurationPointer
typedef
Superclass2::ConfigurationType 
ConfigurationType
typedef SmartPointer< const SelfConstPointer
typedef
Superclass1::CoordinateRepresentationType 
CoordinateRepresentationType
typedef Superclass1::DerivativeType DerivativeType
typedef Superclass2::ElastixPointer ElastixPointer
typedef Superclass2::ElastixType ElastixType
typedef
Superclass1::FixedImageConstPointer 
FixedImageConstPointer
typedef
Superclass1::FixedImageLimiterOutputType 
FixedImageLimiterOutputType
typedef
Superclass1::FixedImageLimiterType 
FixedImageLimiterType
typedef
Superclass1::FixedImageMaskPointer 
FixedImageMaskPointer
typedef
Superclass1::FixedImageMaskType 
FixedImageMaskType
typedef
Superclass1::FixedImagePixelType 
FixedImagePixelType
typedef
Superclass1::FixedImageRegionType 
FixedImageRegionType
typedef Superclass1::FixedImageType FixedImageType
typedef
Superclass1::GradientImageFilterPointer 
GradientImageFilterPointer
typedef
Superclass1::GradientImageFilterType 
GradientImageFilterType
typedef
Superclass1::GradientImagePointer 
GradientImagePointer
typedef
Superclass1::GradientImageType 
GradientImageType
typedef
Superclass1::GradientPixelType 
GradientPixelType
typedef
Superclass1::ImageSampleContainerPointer 
ImageSampleContainerPointer
typedef
Superclass1::ImageSampleContainerType 
ImageSampleContainerType
typedef
Superclass1::ImageSamplerPointer 
ImageSamplerPointer
typedef
Superclass1::ImageSamplerType 
ImageSamplerType
typedef Superclass1::InputPointType InputPointType
typedef
Superclass1::InterpolatorPointer 
InterpolatorPointer
typedef
Superclass1::InterpolatorType 
InterpolatorType
typedef Superclass2::ITKBaseType ITKBaseType
typedef Superclass1::MeasureType MeasureType
typedef
Superclass1::MovingImageConstPointer 
MovingImageConstPointer
typedef
Superclass1::MovingImageDerivativeScalesType 
MovingImageDerivativeScalesType
typedef
Superclass1::MovingImageLimiterOutputType 
MovingImageLimiterOutputType
typedef
Superclass1::MovingImageLimiterType 
MovingImageLimiterType
typedef
Superclass1::MovingImageMaskPointer 
MovingImageMaskPointer
typedef
Superclass1::MovingImageMaskType 
MovingImageMaskType
typedef
Superclass1::MovingImagePixelType 
MovingImagePixelType
typedef
Superclass1::MovingImageRegionType 
MovingImageRegionType
typedef
Superclass1::MovingImageType 
MovingImageType
typedef
Superclass1::OutputPointType 
OutputPointType
typedef Superclass1::ParametersType ParametersType
typedef SmartPointer< SelfPointer
typedef Superclass1::RealType RealType
typedef
Superclass2::RegistrationPointer 
RegistrationPointer
typedef
Superclass2::RegistrationType 
RegistrationType
typedef
NormalizedMutualInformationMetric 
Self
typedef
ParzenWindowNormalizedMutualInformationImageToImageMetric
< typename MetricBase
< TElastix >::FixedImageType,
typename MetricBase< TElastix >
::MovingImageType
Superclass1
typedef MetricBase< TElastix > Superclass2
typedef TimerType::Pointer TimerPointer
typedef tmr::Timer TimerType
typedef
Superclass1::TransformJacobianType 
TransformJacobianType
typedef
Superclass1::TransformParametersType 
TransformParametersType
typedef
Superclass1::TransformPointer 
TransformPointer
typedef Superclass1::TransformType TransformType

Public Member Functions

virtual void BeforeEachResolution (void)
 elxClassNameMacro ("NormalizedMutualInformation")
virtual const char * GetClassName () const
virtual void Initialize (void) throw (ExceptionObject)
 itkStaticConstMacro (FixedImageDimension, unsigned int, FixedImageType::ImageDimension)
 itkStaticConstMacro (MovingImageDimension, unsigned int, MovingImageType::ImageDimension)

Static Public Member Functions

static Pointer New ()

Protected Member Functions

 NormalizedMutualInformationMetric ()
virtual ~NormalizedMutualInformationMetric ()

Private Member Functions

 NormalizedMutualInformationMetric (const Self &)
void operator= (const Self &)

Detailed Description

template<class TElastix>
class elastix::NormalizedMutualInformationMetric< TElastix >

A metric based on the itk::ParzenWindowNormalizedMutualInformationImageToImageMetric.

The parameters used in this class are:

Parameters:
Metric: Select this metric as follows:
(Metric "NormalizedMutualInformation")
Parameters:
NumberOfHistogramBins: The size of the histogram. Must be given for each resolution, or for all resolutions at once.
example: (NumberOfHistogramBins 32 32 64)
The default is 32 for each resolution.
Parameters:
NumberOfFixedHistogramBins: The size of the histogram in the fixed dimension. Can be given for each resolution, or for all resolutions at once. If not given, NumberOfHistograms is used.
example: (NumberOfFixedHistogramBins 32 32 64)
The default is the value of NumberOfHistograms.
Parameters:
NumberOfMovingHistogramBins: The size of the histogram in the fixed dimension. Can be given for each resolution, or for all resolutions at once. If not given, NumberOfHistograms is used.
example: (NumberOfMovingHistogramBins 32 32 64)
The default is the value of NumberOfHistograms.
Parameters:
FixedKernelBSplineOrder: The B-spline order of the Parzen window, used to estimate the joint histogram. Can be given for each resolution, or for all resolutions at once.
example: (FixedKernelBSplineOrder 0 1 1)
The default value is 0.
Parameters:
MovingKernelBSplineOrder: The B-spline order of the Parzen window, used to estimate the joint histogram. Can be given for each resolution, or for all resolutions at once.
example: (MovingKernelBSplineOrder 3 3 3)
The default value is 3.
Parameters:
FixedLimitRangeRatio: The relative extension of the intensity range of the fixed image.
If your image has gray values from 0 to 1000 and the FixedLimitRangeRatio is 0.001, the joint histogram will expect fixed image gray values from -0.001 to 1000.001. This may be useful if you use high order B-spline interpolator for the fixed image.
example: (FixedLimitRangeRatio 0.001 0.01 0.01)
The default value is 0.01. Can be given for each resolution, or for all resolutions at once.
Parameters:
MovingLimitRangeRatio: The relative extension of the intensity range of the moving image.
If your image has gray values from 0 to 1000 and the MovingLimitRangeRatio is 0.001, the joint histogram will expect moving image gray values from -0.001 to 1000.001. This may be useful if you use high order B-spline interpolator for the moving image.
example: (MovingLimitRangeRatio 0.001 0.01 0.01)
The default value is 0.01. Can be given for each resolution, or for all resolutions at once.
See also:
ParzenWindowNormalizedMutualInformationImageToImageMetric

Definition at line 73 of file elxNormalizedMutualInformationMetric.h.


Member Typedef Documentation

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 162 of file elxNormalizedMutualInformationMetric.h.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 161 of file elxNormalizedMutualInformationMetric.h.

template<class TElastix >
typedef SmartPointer<const Self> elastix::NormalizedMutualInformationMetric< TElastix >::ConstPointer

Typedefs from the superclass.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 106 of file elxNormalizedMutualInformationMetric.h.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 160 of file elxNormalizedMutualInformationMetric.h.

Typedef's inherited from Elastix.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 159 of file elxNormalizedMutualInformationMetric.h.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 110 of file elxNormalizedMutualInformationMetric.h.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 165 of file elxNormalizedMutualInformationMetric.h.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 131 of file elxNormalizedMutualInformationMetric.h.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 107 of file elxNormalizedMutualInformationMetric.h.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 133 of file elxNormalizedMutualInformationMetric.h.

template<class TElastix >
typedef SmartPointer<Self> elastix::NormalizedMutualInformationMetric< TElastix >::Pointer
template<class TElastix >
typedef Superclass1::RealType elastix::NormalizedMutualInformationMetric< TElastix >::RealType

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 164 of file elxNormalizedMutualInformationMetric.h.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 163 of file elxNormalizedMutualInformationMetric.h.

Standard ITK-stuff.

Reimplemented from elastix::MetricBase< TElastix >.

Definition at line 83 of file elxNormalizedMutualInformationMetric.h.

Definition at line 86 of file elxNormalizedMutualInformationMetric.h.

template<class TElastix >
typedef MetricBase<TElastix> elastix::NormalizedMutualInformationMetric< TElastix >::Superclass2

Definition at line 87 of file elxNormalizedMutualInformationMetric.h.

template<class TElastix >
typedef TimerType::Pointer elastix::NormalizedMutualInformationMetric< TElastix >::TimerPointer

Typedef for timer.

Definition at line 170 of file elxNormalizedMutualInformationMetric.h.

template<class TElastix >
typedef tmr::Timer elastix::NormalizedMutualInformationMetric< TElastix >::TimerType

Typedef for timer.

Definition at line 168 of file elxNormalizedMutualInformationMetric.h.


Constructor & Destructor Documentation

template<class TElastix >
elastix::NormalizedMutualInformationMetric< TElastix >::NormalizedMutualInformationMetric ( ) [inline, protected]

The constructor.

Definition at line 186 of file elxNormalizedMutualInformationMetric.h.

template<class TElastix >
virtual elastix::NormalizedMutualInformationMetric< TElastix >::~NormalizedMutualInformationMetric ( ) [inline, protected, virtual]

The destructor.

Definition at line 192 of file elxNormalizedMutualInformationMetric.h.

template<class TElastix >
elastix::NormalizedMutualInformationMetric< TElastix >::NormalizedMutualInformationMetric ( const Self ) [private]

The private constructor.


Member Function Documentation

template<class TElastix >
virtual void elastix::NormalizedMutualInformationMetric< TElastix >::BeforeEachResolution ( void  ) [virtual]

Execute stuff before each new pyramid resolution:

  • Set the number of histogram bins.
  • Set the CheckNumberOfSamples option.
  • Set the fixed/moving LimitRangeRatio
  • Set the fixed/moving limiter.

Reimplemented from elastix::BaseComponent.

template<class TElastix >
elastix::NormalizedMutualInformationMetric< TElastix >::elxClassNameMacro ( "NormalizedMutualInformation"  )

Name of this class. Use this name in the parameter file to select this specific metric.
example: (Metric "NormalizedMutualInformation")

template<class TElastix >
virtual const char* elastix::NormalizedMutualInformationMetric< TElastix >::GetClassName ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from elastix::MetricBase< TElastix >.

template<class TElastix >
virtual void elastix::NormalizedMutualInformationMetric< TElastix >::Initialize ( void  ) throw (ExceptionObject) [virtual]

Set up a timer to measure the intialisation time and call the Superclass' implementation.

Reimplemented from itk::ParzenWindowHistogramImageToImageMetric< MetricBase< TElastix >::FixedImageType, MetricBase< TElastix >::MovingImageType >.

template<class TElastix >
elastix::NormalizedMutualInformationMetric< TElastix >::itkStaticConstMacro ( FixedImageDimension  ,
unsigned  int,
FixedImageType::ImageDimension   
)

The fixed image dimension.

Reimplemented from elastix::MetricBase< TElastix >.

template<class TElastix >
elastix::NormalizedMutualInformationMetric< TElastix >::itkStaticConstMacro ( MovingImageDimension  ,
unsigned  int,
MovingImageType::ImageDimension   
)

The moving image dimension.

Reimplemented from elastix::MetricBase< TElastix >.

template<class TElastix >
static Pointer elastix::NormalizedMutualInformationMetric< TElastix >::New ( ) [static]
template<class TElastix >
void elastix::NormalizedMutualInformationMetric< TElastix >::operator= ( const Self ) [private]

The private copy constructor.



Generated on 11-05-2012 for elastix by doxygen 1.7.6.1 elastix logo