#include <itkObjectToObjectMetric.h>

Inheritance diagram for itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage >:

Collaboration diagram for itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage >:

Detailed Description

template<unsigned int TFixedDimension, unsigned int TMovingDimension, class TVirtualImage = Image<typename ObjectToObjectMetricBase::ParametersValueType, TFixedDimension>>
class itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage >

Computes similarity between regions of two objects.

This class is templated over the dimensionality of the two input objects. This is the abstract templated base class for a hierarchy of similarity metrics that may, in derived classes, operate on meshes, images, etc. This class computes a value that measures the similarity between the two objects.

Derived classes must provide implementations for: GetValue GetDerivative GetValueAndDerivative SupportsArbitraryVirtualDomainSamples

Similarity is evaluated using fixed and moving transforms. Both transforms are initialized to an IdentityTransform, and can be set by the user using SetFixedTranform() and SetMovingTransform().

Virtual Domain

This class uses a virtual reference space. This space defines the resolution at which the evaluation is performed, as well as the physical coordinate system. This is useful for unbiased registration. The virtual domain is stored in the m_VirtualDomain member, but this is subject to change so the convenience methods GetVirtualSpacing(), GetVirtualDirection() and GetVirtualOrigin() should be used whenever possible to retrieve virtual domain information. The region over which metric evaluation is performed is taken from the virtual image buffered region.

The user can define a virtual domain by calling either SetVirtualDomain or SetVirtualDomainFromImage. See these methods for details. Derived classes may automatically assign a virtual domain if the user has not assigned one by initialization time.

If the virtual domain is left undefined by the user and by derived classes, then unit or zero values are returned for GetVirtualSpacing(), GetVirtualDirection() and GetVirtualOrigin(), as appropriate. The virtual region is left undefined and an attempt to retrieve it via GetVirtualRegion() will generate an exception. The m_VirtualImage member will be NULL.

During evaluation, derived classes should verify that points are within the virtual domain and thus valid, as appropriate for the needs of the metric. When points are deemed invalid the number of valid points returned by GetNumberOfValidPoints() should reflect this.

Note: Transform Optimization This hierarchy currently assumes only the moving transform is 'active', i.e. only the moving transform is being optimized when used in an optimizer. Methods relevant to transform optimization such as GetNumberOfParameters(), UpdateTransformParameters() are passed on to the active transform. The eventual goal however is to allow for either moving, fixed or both transforms to be active within a single metric.

Definition at line 85 of file itkObjectToObjectMetric.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::ParametersValueType	CoordinateRepresentationType

typedef Superclass::DerivativeType	DerivativeType

typedef Superclass::DerivativeValueType	DerivativeValueType

typedef SizeValueType	DimensionType

typedef FixedTransformType::InputPointType	FixedInputPointType

typedef FixedTransformType::OutputPointType	FixedOutputPointType

typedef FixedTransformType::JacobianType	FixedTransformJacobianType

typedef FixedTransformType::ParametersType	FixedTransformParametersType

typedef FixedTransformType::Pointer	FixedTransformPointer

typedef Transform < ParametersValueType, TVirtualImage::ImageDimension, TFixedDimension >	FixedTransformType

typedef Superclass::InternalComputationValueType	InternalComputationValueType

typedef FixedTransformType::JacobianType	JacobianType

typedef Superclass::MeasureType	MeasureType

typedef DisplacementFieldTransform < CoordinateRepresentationType, itkGetStaticConstMacro(MovingDimension) >	MovingDisplacementFieldTransformType

typedef MovingTransformType::InputPointType	MovingInputPointType

typedef MovingTransformType::OutputPointType	MovingOutputPointType

typedef MovingTransformType::JacobianType	MovingTransformJacobianType

typedef MovingTransformType::ParametersType	MovingTransformParametersType

typedef MovingTransformType::Pointer	MovingTransformPointer

typedef Transform < ParametersValueType, TVirtualImage::ImageDimension, TMovingDimension >	MovingTransformType

typedef Superclass::NumberOfParametersType	NumberOfParametersType

typedef Superclass::ParametersType	ParametersType

typedef Superclass::ParametersValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef ObjectToObjectMetric	Self

typedef ObjectToObjectMetricBase	Superclass

typedef VirtualImageType::DirectionType	VirtualDirectionType

typedef VirtualImageType::ConstPointer	VirtualImageConstPointer

typedef VirtualImageType::Pointer	VirtualImagePointer

typedef TVirtualImage	VirtualImageType

typedef VirtualImageType::IndexType	VirtualIndexType

typedef VirtualImageType::PointType	VirtualOriginType

typedef VirtualImageType::PixelType	VirtualPixelType

typedef VirtualPointSetType::Pointer	VirtualPointSetPointer

typedef PointSet < VirtualPixelType, itkGetStaticConstMacro(VirtualDimension)>	VirtualPointSetType

typedef VirtualImageType::PointType	VirtualPointType

typedef VirtualImageType::SizeType	VirtualRadiusType

typedef VirtualImageType::RegionType	VirtualRegionType

typedef VirtualRegionType::SizeType	VirtualSizeType

typedef VirtualImageType::SpacingType	VirtualSpacingType

Public Types inherited from itk::ObjectToObjectMetricBase
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::ParametersValueType	CoordinateRepresentationType

typedef Superclass::DerivativeType	DerivativeType

typedef DerivativeType::ValueType	DerivativeValueType

enum	GradientSourceType { GRADIENT_SOURCE_FIXED =0, GRADIENT_SOURCE_MOVING, GRADIENT_SOURCE_BOTH }

typedef double	InternalComputationValueType

typedef Superclass::MeasureType	MeasureType

typedef unsigned int	NumberOfParametersType

typedef Superclass::ParametersType	ParametersType

typedef Superclass::ParametersValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef ObjectToObjectMetricBase	Self

typedef SingleValuedCostFunctionv4	Superclass

Public Types inherited from itk::SingleValuedCostFunctionv4
typedef SmartPointer< const Self >	ConstPointer

typedef Array < ParametersValueType >	DerivativeType

typedef double	MeasureType

typedef Superclass::ParametersType	ParametersType

typedef Superclass::ParametersValueType	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef SingleValuedCostFunctionv4	Self

typedef CostFunction	Superclass

Public Types inherited from itk::CostFunction
typedef SmartPointer< const Self >	ConstPointer

typedef OptimizerParameters < ParametersValueType >	ParametersType

typedef double	ParametersValueType

typedef SmartPointer< Self >	Pointer

typedef CostFunction	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
OffsetValueType	ComputeParameterOffsetFromVirtualIndex (const VirtualIndexType &index, const NumberOfParametersType &numberOfLocalParameters) const

OffsetValueType	ComputeParameterOffsetFromVirtualPoint (const VirtualPointType &point, const NumberOfParametersType &numberOfLocalParameters) const

virtual const FixedTransformType *	GetFixedTransform () const

virtual FixedTransformType *	GetModifiableFixedTransform ()

virtual MovingTransformType *	GetModifiableMovingTransform ()

virtual VirtualImageType *	GetModifiableVirtualImage ()

virtual const MovingTransformType *	GetMovingTransform () const

virtual const char *	GetNameOfClass () const

virtual NumberOfParametersType	GetNumberOfLocalParameters () const

virtual NumberOfParametersType	GetNumberOfParameters () const

virtual SizeValueType	GetNumberOfValidPoints () const

virtual const ParametersType &	GetParameters () const

const MovingTransformType *	GetTransform ()

VirtualDirectionType	GetVirtualDirection (void) const

virtual const TimeStamp &	GetVirtualDomainTimeStamp (void) const

virtual const VirtualImageType *	GetVirtualImage () const

VirtualOriginType	GetVirtualOrigin (void) const

const VirtualRegionType &	GetVirtualRegion (void) const

VirtualSpacingType	GetVirtualSpacing (void) const

virtual bool	HasLocalSupport () const

virtual void	Initialize (void) throw ( ExceptionObject )

virtual void	SetFixedTransform (FixedTransformType *_arg)

virtual void	SetMovingTransform (MovingTransformType *_arg)

virtual void	SetParameters (ParametersType &params)

void	SetTransform (MovingTransformType *transform)

void	SetVirtualDomain (const VirtualSpacingType &spacing, const VirtualOriginType &origin, const VirtualDirectionType &direction, const VirtualRegionType &region)

virtual bool	SupportsArbitraryVirtualDomainSamples (void) const =0

virtual void	UpdateTransformParameters (const DerivativeType &derivative, ParametersValueType factor)


void	SetVirtualDomainFromImage (VirtualImageType *virtualImage)

void	SetVirtualDomainFromImage (const VirtualImageType *virtualImage)


bool	IsInsideVirtualDomain (const VirtualPointType &point) const

bool	IsInsideVirtualDomain (const VirtualIndexType &index) const

Public Member Functions inherited from itk::ObjectToObjectMetricBase
MeasureType	GetCurrentValue () const

virtual void	GetDerivative (DerivativeType &) const =0

virtual GradientSourceType	GetGradientSource () const

bool	GetGradientSourceIncludesFixed () const

bool	GetGradientSourceIncludesMoving () const

virtual MeasureType	GetValue () const =0

virtual void	GetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const =0

virtual void	SetGradientSource (GradientSourceType _arg)

Public Member Functions inherited from itk::SingleValuedCostFunctionv4
virtual void	GetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const =0

Static Public Attributes

static const DimensionType	FixedDimension = TFixedDimension

static const DimensionType	MovingDimension = TMovingDimension

static const DimensionType	VirtualDimension = TVirtualImage::ImageDimension

Protected Member Functions
MovingDisplacementFieldTransformType *	GetMovingDisplacementFieldTransform () const

	ObjectToObjectMetric ()

void	PrintSelf (std::ostream &os, Indent indent) const

bool	TransformPhysicalPointToVirtualIndex (const VirtualPointType &, VirtualIndexType &) const

void	TransformVirtualIndexToPhysicalPoint (const VirtualIndexType &, VirtualPointType &) const

virtual void	VerifyDisplacementFieldSizeAndPhysicalSpace ()

bool	VerifyNumberOfValidPoints (MeasureType &value, DerivativeType &derivative) const

virtual	~ObjectToObjectMetric ()

Protected Member Functions inherited from itk::ObjectToObjectMetricBase
	ObjectToObjectMetricBase ()

void	PrintSelf (std::ostream &os, Indent indent) const

virtual	~ObjectToObjectMetricBase ()

Protected Member Functions inherited from itk::SingleValuedCostFunctionv4
	SingleValuedCostFunctionv4 ()

virtual	~SingleValuedCostFunctionv4 ()

Protected Member Functions inherited from itk::CostFunction
	CostFunction ()

virtual	~CostFunction ()

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Protected Attributes
FixedTransformPointer	m_FixedTransform

MovingTransformPointer	m_MovingTransform

SizeValueType	m_NumberOfValidPoints

bool	m_UserHasSetVirtualDomain

VirtualImagePointer	m_VirtualImage

Protected Attributes inherited from itk::ObjectToObjectMetricBase
GradientSourceType	m_GradientSource

MeasureType	m_Value

Private Member Functions
	ObjectToObjectMetric (const Self &)

void	operator= (const Self &)

Additional Inherited Members
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType