itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage > Class Template Reference

#include <itkMeanSquaresImageToImageMetric.h>

Inheritance diagram for itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >:

Collaboration diagram for itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::CoordinateRepresentationType	CoordinateRepresentationType
typedef Superclass::DerivativeType	DerivativeType
typedef Superclass::FixedImageConstPointer	FixedImageConstPointer
typedef Superclass::FixedImagePointType	FixedImagePointType
typedef Superclass::FixedImageSampleContainer	FixedImageSampleContainer
typedef Superclass::FixedImageType	FixedImageType
typedef Superclass::ImageDerivativesType	ImageDerivativesType
typedef Superclass::IndexValueType	IndexValueType
typedef Superclass::InterpolatorType	InterpolatorType
typedef Superclass::MeasureType	MeasureType
typedef Superclass::MovingImageConstPointer	MovingImageConstPointer
typedef Superclass::MovingImagePointType	MovingImagePointType
typedef Superclass::MovingImageType	MovingImageType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef MeanSquaresImageToImageMetric	Self
typedef ImageToImageMetric < TFixedImage, TMovingImage >	Superclass
typedef Superclass::TransformJacobianType	TransformJacobianType
typedef Superclass::TransformPointer	TransformPointer
typedef Superclass::TransformType	TransformType
typedef Superclass::WeightsValueType	WeightsValueType
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
void	GetDerivative (const ParametersType &parameters, DerivativeType &Derivative) const
virtual const char *	GetNameOfClass () const
MeasureType	GetValue (const ParametersType &parameters) const
void	GetValueAndDerivative (const ParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const
virtual void	Initialize (void) throw ( ExceptionObject )
Static Public Member Functions
static Pointer	New ()
Static Public Attributes
static const unsigned int	MovingImageDimension = MovingImageType::ImageDimension
Protected Member Functions
	MeanSquaresImageToImageMetric ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~MeanSquaresImageToImageMetric ()
Private Member Functions
bool	GetValueAndDerivativeThreadProcessSample (ThreadIdType threadID, SizeValueType fixedImageSample, const MovingImagePointType &mappedPoint, double movingImageValue, const ImageDerivativesType &movingImageGradientValue) const
bool	GetValueThreadProcessSample (ThreadIdType threadID, SizeValueType fixedImageSample, const MovingImagePointType &mappedPoint, double movingImageValue) const
	MeanSquaresImageToImageMetric (const Self &)
void	operator= (const Self &)
Private Attributes
MeasureType *	m_ThreaderMSE
DerivativeType *	m_ThreaderMSEDerivatives

---

Detailed Description

template<class TFixedImage, class TMovingImage>
class itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >

TODO.

Wiki Examples:

• All Examples

• Compute the mean squares metric between two images

Definition at line 39 of file itkMeanSquaresImageToImageMetric.h.

---

Member Typedef Documentation

template<class TFixedImage , class TMovingImage >

typedef SmartPointer< const Self > itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::ConstPointer

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 48 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::CoordinateRepresentationType itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::CoordinateRepresentationType

Type used for representing point components

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 69 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::DerivativeType itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::DerivativeType

Type of the derivative.

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 62 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::FixedImageConstPointer itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::FixedImageConstPointer

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 67 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::FixedImagePointType itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::FixedImagePointType

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 76 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::FixedImageSampleContainer itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::FixedImageSampleContainer

FixedImageSamplePoint typedef support.

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 70 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::FixedImageType itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::FixedImageType

Type of the fixed Image.

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 64 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::ImageDerivativesType itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::ImageDerivativesType

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 71 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::IndexValueType itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::IndexValueType

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 73 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::InterpolatorType itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::InterpolatorType

Type of the Interpolator Base class

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 60 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::MeasureType itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::MeasureType

Type of the measure.

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 61 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::MovingImageConstPointer itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::MovingImageConstPointer

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 68 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::MovingImagePointType itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::MovingImagePointType

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 66 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::MovingImageType itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::MovingImageType

Type of the moving Image.

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 65 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::ParametersType itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::ParametersType

Type of the parameters.

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 63 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef SmartPointer< Self > itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::Pointer

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 47 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef MeanSquaresImageToImageMetric itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 45 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef ImageToImageMetric< TFixedImage, TMovingImage > itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::Superclass

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 46 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::TransformJacobianType itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::TransformJacobianType

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 59 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::TransformPointer itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::TransformPointer

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 58 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::TransformType itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::TransformType

Types inherited from Superclass.

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 54 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

typedef Superclass::WeightsValueType itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::WeightsValueType

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 72 of file itkMeanSquaresImageToImageMetric.h.

---

Constructor & Destructor Documentation

template<class TFixedImage , class TMovingImage >

itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::MeanSquaresImageToImageMetric

(

)

[protected]

template<class TFixedImage , class TMovingImage >

virtual itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::~MeanSquaresImageToImageMetric

(

)

[protected, virtual]

template<class TFixedImage , class TMovingImage >

itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::MeanSquaresImageToImageMetric

(

const Self &

)

[private]

---

Member Function Documentation

template<class TFixedImage , class TMovingImage >

virtual::itk::LightObject::Pointer itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::CreateAnother

(

void

)

const [virtual]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

template<class TFixedImage , class TMovingImage >

void itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::GetDerivative	(	const ParametersType &	parameters,
		DerivativeType &	Derivative
	)		const [virtual]

Get the derivatives of the match measure.

Implements itk::SingleValuedCostFunction.

template<class TFixedImage , class TMovingImage >

virtual const char* itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::GetNameOfClass

(

)

const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

template<class TFixedImage , class TMovingImage >

MeasureType itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::GetValue

(

const ParametersType &

parameters

)

const [virtual]

Get the value.

Implements itk::SingleValuedCostFunction.

template<class TFixedImage , class TMovingImage >

void itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivative	(	const ParametersType &	parameters,
		MeasureType &	Value,
		DerivativeType &	Derivative
	)		const

Get the value and derivatives for single valued optimizers.

template<class TFixedImage , class TMovingImage >

bool itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivativeThreadProcessSample	(	ThreadIdType	threadID,
		SizeValueType	fixedImageSample,
		const MovingImagePointType &	mappedPoint,
		double	movingImageValue,
		const ImageDerivativesType &	movingImageGradientValue
	)		const [inline, private, virtual]

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

template<class TFixedImage , class TMovingImage >

bool itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::GetValueThreadProcessSample	(	ThreadIdType	threadID,
		SizeValueType	fixedImageSample,
		const MovingImagePointType &	mappedPoint,
		double	movingImageValue
	)		const [inline, private, virtual]

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

template<class TFixedImage , class TMovingImage >

virtual void itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::Initialize

(

void

)

throw ( ExceptionObject ) [virtual]

Initialize the Metric by (1) making sure that all the components are present and plugged together correctly, (2) uniformly select NumberOfSpatialSamples within the FixedImageRegion, and (3) allocate memory for pdf data structures.

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

template<class TFixedImage , class TMovingImage >

static Pointer itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::New

(

)

[static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TFixedImage , class TMovingImage >

void itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::operator=

(

const Self &

)

[private]

Mutex lock to protect modification to the reference count

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

template<class TFixedImage , class TMovingImage >

void itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

---

Member Data Documentation

template<class TFixedImage , class TMovingImage >

MeasureType* itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::m_ThreaderMSE [private]

Definition at line 129 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

DerivativeType* itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::m_ThreaderMSEDerivatives [private]

Definition at line 130 of file itkMeanSquaresImageToImageMetric.h.

template<class TFixedImage , class TMovingImage >

const unsigned int itk::MeanSquaresImageToImageMetric< TFixedImage, TMovingImage >::MovingImageDimension = MovingImageType::ImageDimension [static]

The moving image dimension.

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

Definition at line 80 of file itkMeanSquaresImageToImageMetric.h.

---

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

• itkMeanSquaresImageToImageMetric.h