This class is the elastix base class for all Metrics. More...

#include <elxMetricBase.h>

Inheritance diagram for elastix::MetricBase< TElastix >:

Collaboration diagram for elastix::MetricBase< TElastix >:

Public Types
typedef AdvancedImageToImageMetric < FixedImageType, MovingImageType >	AdvancedMetricType
typedef Superclass::ConfigurationPointer	ConfigurationPointer
typedef Superclass::ConfigurationType	ConfigurationType
typedef ITKBaseType::ParametersValueType	CoordinateRepresentationType
typedef Superclass::ElastixPointer	ElastixPointer
typedef Superclass::ElastixType	ElastixType
typedef ElastixType::FixedImageType	FixedImageType
typedef PointSet < CoordinateRepresentationType, FixedImageDimension, DefaultStaticMeshTraits < CoordinateRepresentationType, FixedImageDimension, FixedImageDimension, CoordinateRepresentationType, CoordinateRepresentationType, CoordinateRepresentationType > >	FixedPointSetType
typedef FixedImageType::PointType	FixedPointType
typedef FixedPointType::ValueType	FixedPointValueType
typedef AdvancedMetricType::ImageSamplerType	ImageSamplerBaseType
typedef SingleValuedCostFunction	ITKBaseType
typedef ElastixType::MovingImageType	MovingImageType
typedef PointSet < CoordinateRepresentationType, MovingImageDimension, DefaultStaticMeshTraits < CoordinateRepresentationType, MovingImageDimension, MovingImageDimension, CoordinateRepresentationType, CoordinateRepresentationType, CoordinateRepresentationType > >	MovingPointSetType
typedef MovingImageType::PointType	MovingPointType
typedef MovingPointType::ValueType	MovingPointValueType
typedef Superclass::RegistrationPointer	RegistrationPointer
typedef Superclass::RegistrationType	RegistrationType
typedef MetricBase	Self
typedef BaseComponentSE< TElastix >	Superclass
Public Member Functions
virtual void	AfterEachIterationBase (void)
virtual void	BeforeEachResolutionBase (void)
virtual ImageSamplerBaseType *	GetAdvancedMetricImageSampler (void) const
virtual bool	GetAdvancedMetricUseImageSampler (void) const
virtual const ITKBaseType *	GetAsITKBaseType (void) const
virtual ITKBaseType *	GetAsITKBaseType (void)
virtual const char *	GetClassName () const
	itkStaticConstMacro (FixedImageDimension, unsigned int, FixedImageType::ImageDimension)
	itkStaticConstMacro (MovingImageDimension, unsigned int, MovingImageType::ImageDimension)
virtual void	SelectNewSamples (void)
virtual void	SetAdvancedMetricImageSampler (ImageSamplerBaseType *sampler)
Protected Types
typedef itk::ImageFullSampler < FixedImageType >	ImageFullSamplerType
typedef ITKBaseType::MeasureType	MeasureType
typedef ITKBaseType::ParametersType	ParametersType
Protected Member Functions
virtual MeasureType	GetExactValue (const ParametersType &parameters)
	MetricBase ()
virtual	~MetricBase ()
Protected Attributes
ImageFullSamplerType::Pointer	m_ExactMetricSampler
bool	m_ShowExactMetricValue
Private Member Functions
	MetricBase (const Self &)
void	operator= (const Self &)

Detailed Description

template<class TElastix>
class elastix::MetricBase< TElastix >

This class is the elastix base class for all Metrics.

This class contains the common functionality for all Metrics.

The parameters used in this class are:

Parameters:: ShowExactMetricValue: Flag that can set to "true" or "false". If "true" the metric computes the exact metric value (computed on all voxels rather than on the set of spatial samples) and shows it each iteration. Must be given for each resolution.
example: (ShowExactMetricValue "true" "true" "false")
Default is "false" for all resolutions.

Parameters:: CheckNumberOfSamples: Whether the metric checks if at least a certain fraction (default 1/4) of the samples map inside the moving image. Can be given for each resolution or for all resolutions at once.
example: (CheckNumberOfSamples "false" "true" "false")
The default is true. In general it is wise to set this to true, since it detects if the registration is going really bad.

Parameters:: RequiredRatioOfValidSamples: Defines the fraction needed in CheckNumberOfSamples.
example: (RequiredRatioOfValidSamples 0.1)
The default is 0.25.

Definition at line 62 of file elxMetricBase.h.

Member Typedef Documentation

template<class TElastix>

typedef AdvancedImageToImageMetric< FixedImageType, MovingImageType > elastix::MetricBase< TElastix >::AdvancedMetricType

Definition at line 92 of file elxMetricBase.h.

template<class TElastix>

typedef Superclass::ConfigurationPointer elastix::MetricBase< TElastix >::ConfigurationPointer

Reimplemented from elastix::BaseComponentSE< TElastix >.

Definition at line 77 of file elxMetricBase.h.

template<class TElastix>

typedef Superclass::ConfigurationType elastix::MetricBase< TElastix >::ConfigurationType

Reimplemented from elastix::BaseComponentSE< TElastix >.

Definition at line 76 of file elxMetricBase.h.

template<class TElastix>

typedef ITKBaseType::ParametersValueType elastix::MetricBase< TElastix >::CoordinateRepresentationType

Typedefs for point sets.

Definition at line 100 of file elxMetricBase.h.

template<class TElastix>

typedef Superclass::ElastixPointer elastix::MetricBase< TElastix >::ElastixPointer

Reimplemented from elastix::BaseComponentSE< TElastix >.

Definition at line 75 of file elxMetricBase.h.

template<class TElastix>

typedef Superclass::ElastixType elastix::MetricBase< TElastix >::ElastixType

Typedef's inherited from Elastix.

Reimplemented from elastix::BaseComponentSE< TElastix >.

Definition at line 71 of file elxMetricBase.h.

template<class TElastix>

typedef ElastixType::FixedImageType elastix::MetricBase< TElastix >::FixedImageType

Other typedef's.

Definition at line 82 of file elxMetricBase.h.

template<class TElastix>

typedef PointSet< CoordinateRepresentationType, FixedImageDimension, DefaultStaticMeshTraits< CoordinateRepresentationType, FixedImageDimension, FixedImageDimension, CoordinateRepresentationType, CoordinateRepresentationType, CoordinateRepresentationType > > elastix::MetricBase< TElastix >::FixedPointSetType

Reimplemented in elastix::CorrespondingPointsEuclideanDistanceMetric< TElastix >.

Definition at line 107 of file elxMetricBase.h.

template<class TElastix>

typedef FixedImageType::PointType elastix::MetricBase< TElastix >::FixedPointType

Definition at line 83 of file elxMetricBase.h.

template<class TElastix>

typedef FixedPointType::ValueType elastix::MetricBase< TElastix >::FixedPointValueType

Definition at line 84 of file elxMetricBase.h.

template<class TElastix>

typedef itk::ImageFullSampler<FixedImageType> elastix::MetricBase< TElastix >::ImageFullSamplerType [protected]

The full sampler used by the GetExactValue method.

Definition at line 171 of file elxMetricBase.h.

template<class TElastix>

typedef AdvancedMetricType::ImageSamplerType elastix::MetricBase< TElastix >::ImageSamplerBaseType

Typedefs for sampler support.

Definition at line 117 of file elxMetricBase.h.

template<class TElastix>

typedef SingleValuedCostFunction elastix::MetricBase< TElastix >::ITKBaseType

ITKBaseType.

Definition at line 90 of file elxMetricBase.h.

template<class TElastix>

typedef ITKBaseType::MeasureType elastix::MetricBase< TElastix >::MeasureType [protected]

The type returned by the GetValue methods. Used by the GetExactValue method.

Definition at line 167 of file elxMetricBase.h.

template<class TElastix>

typedef ElastixType::MovingImageType elastix::MetricBase< TElastix >::MovingImageType

Definition at line 85 of file elxMetricBase.h.

template<class TElastix>

typedef PointSet< CoordinateRepresentationType, MovingImageDimension, DefaultStaticMeshTraits< CoordinateRepresentationType, MovingImageDimension, MovingImageDimension, CoordinateRepresentationType, CoordinateRepresentationType, CoordinateRepresentationType > > elastix::MetricBase< TElastix >::MovingPointSetType

Reimplemented in elastix::CorrespondingPointsEuclideanDistanceMetric< TElastix >.

Definition at line 114 of file elxMetricBase.h.

template<class TElastix>

typedef MovingImageType::PointType elastix::MetricBase< TElastix >::MovingPointType

Definition at line 86 of file elxMetricBase.h.

template<class TElastix>

typedef MovingPointType::ValueType elastix::MetricBase< TElastix >::MovingPointValueType

Definition at line 87 of file elxMetricBase.h.

template<class TElastix>

typedef ITKBaseType::ParametersType elastix::MetricBase< TElastix >::ParametersType [protected]

Definition at line 168 of file elxMetricBase.h.

template<class TElastix>

typedef Superclass::RegistrationPointer elastix::MetricBase< TElastix >::RegistrationPointer

Reimplemented from elastix::BaseComponentSE< TElastix >.

Definition at line 79 of file elxMetricBase.h.

template<class TElastix>

typedef Superclass::RegistrationType elastix::MetricBase< TElastix >::RegistrationType

Reimplemented from elastix::BaseComponentSE< TElastix >.

Definition at line 78 of file elxMetricBase.h.

template<class TElastix>

typedef MetricBase elastix::MetricBase< TElastix >::Self

Standard ITK stuff.

Reimplemented from elastix::BaseComponentSE< TElastix >.

Definition at line 67 of file elxMetricBase.h.

template<class TElastix>

typedef BaseComponentSE<TElastix> elastix::MetricBase< TElastix >::Superclass

Reimplemented from elastix::BaseComponentSE< TElastix >.

Definition at line 68 of file elxMetricBase.h.

Constructor & Destructor Documentation

template<class TElastix>

elastix::MetricBase< TElastix >::MetricBase ( ) [protected]

The constructor.

template<class TElastix>

virtual elastix::MetricBase< TElastix >::~MetricBase ( ) [inline, protected, virtual]

The destructor.

Definition at line 176 of file elxMetricBase.h.

template<class TElastix>

elastix::MetricBase< TElastix >::MetricBase ( const Self & ) [private]

The private constructor.

Member Function Documentation

template<class TElastix>

virtual void elastix::MetricBase< TElastix >::AfterEachIterationBase ( void ) [virtual]

Execute stuff after each iteration:

Optionally compute the exact metric value and plot it to screen.

Reimplemented from elastix::BaseComponent.

template<class TElastix>

virtual void elastix::MetricBase< TElastix >::BeforeEachResolutionBase ( void ) [virtual]

Execute stuff before each resolution:

Check if the exact metric value should be computed (to monitor the progress of the registration).

Reimplemented from elastix::BaseComponent.

template<class TElastix>

virtual ImageSamplerBaseType* elastix::MetricBase< TElastix >::GetAdvancedMetricImageSampler ( void ) const [virtual]

Methods to get the image sampler. The image sampler is only used when the metric is of type AdvancedMetricType, and has UseImageSampler set to true. In other cases, the function returns 0.

template<class TElastix>

virtual bool elastix::MetricBase< TElastix >::GetAdvancedMetricUseImageSampler ( void ) const [virtual]

Returns whether the metric uses a sampler. When the metric is not of AdvancedMetricType, the function returns false immediately.

template<class TElastix>

virtual const ITKBaseType* elastix::MetricBase< TElastix >::GetAsITKBaseType ( void ) const [inline, virtual]

Cast to ITKBaseType, to use in const functions.

Definition at line 126 of file elxMetricBase.h.

template<class TElastix>

virtual ITKBaseType* elastix::MetricBase< TElastix >::GetAsITKBaseType ( void ) [inline, virtual]

Cast to ITKBaseType.

Definition at line 120 of file elxMetricBase.h.

template<class TElastix>

virtual const char* elastix::MetricBase< TElastix >::GetClassName ( ) const [virtual]

Run-time type information (and related methods).

template<class TElastix>

virtual MeasureType elastix::MetricBase< TElastix >::GetExactValue ( const ParametersType & parameters ) [protected, virtual]

Get the exact value. Mutual information computed over all points. It is meant in situations when you optimize using just a subset of pixels, but are interested in the exact value of the metric.

This method only works when the itkYourMetric inherits from the AdvancedMetricType. In other cases it returns 0. You may re-implement this method in the elxYourMetric, if you like.

template<class TElastix>

elastix::MetricBase< TElastix >::itkStaticConstMacro	(	MovingImageDimension	,
		unsigned	int,
		MovingImageType::ImageDimension
	)

Get the dimension of the moving image.

template<class TElastix>

elastix::MetricBase< TElastix >::itkStaticConstMacro	(	FixedImageDimension	,
		unsigned	int,
		FixedImageType::ImageDimension
	)

Get the dimension of the fixed image.

template<class TElastix>

void elastix::MetricBase< TElastix >::operator= ( const Self & ) [private]

The private copy constructor.

template<class TElastix>

virtual void elastix::MetricBase< TElastix >::SelectNewSamples ( void ) [virtual]

Force the metric to base its computation on a new subset of image samples. Not every metric may have implemented this.

Reimplemented in elastix::CorrespondingPointsEuclideanDistanceMetric< TElastix >, and elastix::TransformRigidityPenalty< TElastix >.

template<class TElastix>

virtual void elastix::MetricBase< TElastix >::SetAdvancedMetricImageSampler ( ImageSamplerBaseType * sampler ) [virtual]

Method to set the image sampler. The image sampler is only used when the metric is of type AdvancedMetricType, and has UseImageSampler set to true. In other cases, the function does nothing.

Field Documentation

template<class TElastix>

ImageFullSamplerType::Pointer elastix::MetricBase< TElastix >::m_ExactMetricSampler [protected]

Definition at line 191 of file elxMetricBase.h.

template<class TElastix>

bool elastix::MetricBase< TElastix >::m_ShowExactMetricValue [protected]

Todo:: the method GetExactDerivative could as well be added here.

Definition at line 190 of file elxMetricBase.h.

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

template<class TElastix> class elastix::MetricBase< TElastix >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation

template<class TElastix>
class elastix::MetricBase< TElastix >