Abstract base class to provide functionality for adding arbitrary constraints, and also arbitrary ways of evaluating a derivative, both via Template Method pattern [2]. More...

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

[legend]

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

[legend]

Public Types
typedef ImageToImageMetricWithConstraint	Self

typedef ImageToImageMetric < TFixedImage, TMovingImage >	Superclass

typedef SmartPointer< Self >	Pointer

typedef SmartPointer< const Self >	ConstPointer

typedef itk::Constraint	ConstraintType

typedef ConstraintType::Pointer	ConstraintPointer

typedef MetricDerivativeBridge < TFixedImage, TMovingImage >	MetricDerivativeBridgeType

typedef MetricDerivativeBridgeType::Pointer	MetricDerivativePointer

typedef Superclass::MeasureType	MeasureType

typedef Superclass::DerivativeType	DerivativeType

typedef Superclass::ParametersType	TransformParametersType

Public Member Functions
virtual const char *	GetClassName () const

virtual void	SetDerivativeBridge (MetricDerivativeBridgeType *_arg)

virtual MetricDerivativeBridgeType *	GetDerivativeBridge ()

virtual void	SetConstraint (ConstraintType *_arg)

virtual ConstraintType *	GetConstraint ()

virtual void	SetWeightingFactor (double _arg)

virtual double	GetWeightingFactor ()

virtual void	SetUseConstraintGradient (bool _arg)

virtual bool	GetUseConstraintGradient () const

virtual void	SetPrintOutMetricEvaluation (bool _arg)

virtual bool	GetPrintOutMetricEvaluation ()

virtual MeasureType	GetValue (const TransformParametersType &parameters) const

virtual void	GetConstraintDerivative (const TransformParametersType &parameters, DerivativeType &derivative) const

virtual void	GetDerivative (const TransformParametersType &parameters, DerivativeType &derivative) const

virtual void	GetValueAndDerivative (const TransformParametersType &parameters, MeasureType &Value, DerivativeType &derivative) const

Protected Member Functions
	ImageToImageMetricWithConstraint ()

virtual	~ImageToImageMetricWithConstraint ()

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

virtual MeasureType	GetSimilarity (const TransformParametersType &parameters) const =0

virtual void	GetCostFunctionDerivative (const TransformParametersType &parameters, DerivativeType &derivative) const =0

Protected Attributes
MetricDerivativePointer	m_DerivativeBridge

ConstraintPointer	m_Constraint

double	m_WeightingFactor

bool	m_UseConstraintGradient

bool	m_PrintOutMetricEvaluation

Detailed Description

template<typename TFixedImage, typename TMovingImage>
class itk::ImageToImageMetricWithConstraint< TFixedImage, TMovingImage >

Abstract base class to provide functionality for adding arbitrary constraints, and also arbitrary ways of evaluating a derivative, both via Template Method pattern [2].

We also provide a boolean to turn the gradient of the constraint off/on, as this could be expensive, and also, an independent debugging parameter. When you evaluate the similarity measure, do you want to print out the result for debugging purposes? i.e. like:

"GetValue():Actual metric value x = similarity * (1-weighting) + constraintg * (weighting)"

This may be ok for Fluid,FFD or normal affine registration where you evaluate the similarity measure once per iteration, or once + NDOF*2 if you include the finite difference derivative. But its completely useless for block matching, where you may evaluate the similarity measure (albeit on a small block) many thousands of times per iteration. So, we can't turn this feature off/on based on logging, or else you would need different logging every time you ran a block matching. We can't turn this feature off/on using the base class, or global debug flag. So, ive added a boolean m_PrintOutMetricEvaluation, which defaults to true.