itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType > Class Template Reference

#include <itkObjectToObjectMultiMetricv4.h>

Inheritance diagram for itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >:

Collaboration diagram for itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >:

Detailed Description

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>
class itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >

This class takes one ore more ObjectToObject metrics and assigns weights to their derivatives to compute a single result.

This class takes N ObjectToObject-derived component metrics and assigns a weight to each of the metrics' derivatives. It then computes a weighted measure of the metric. The GetValue() and GetValueAndDerivative() methods compute the measure and derivative using the following calculation:

metric value = Sum_j ( w_j * M_j ) (see important note below)

and the GetDerivative() method computes the derivative by computing:

derivative = Sum_j ( w_j * dM_j / ||dM_j|| ) * ( Sum_j( ||dM_j|| ) / J )

Note

The metric value is unit-less, and thus it is difficult to compute a combined metric. This metric returns the metric value in three ways: 1) GetValue() returns the computed value of only the first component metric. This result is stored in m_Value and also returned by GetCurrentValue(). 2) GetValueArray() returns an itkArray of metric values, one for each component metric. It only has meaning after a call to GetValue(), GetDerivative() or GetValueAndDerivative(). 3) GetWeightedValue() returns a combined metric value of all component metrics, using the assigned weights. It only has meaning after a call to GetValue(), GetDerivative() or GetValueAndDerivative().

The assigned weights are normalized internally to sum to one before use, and the weights default to 1/N, where N is the number of component metrics.

Note

Each component metric must use the same transform parameters object. That is, each metric must be evaluating the same parameters by evaluating the same transform. Except, if a component transform is a CompositeTransform, in which case it must be set to optimize a single transform, and that transform must be the same as the transform in other component metrics.

Each component metric must be setup independently, except for the metric transforms which can optionally be set from this class. That is, each component's images or point sets, fixed transforms and options must be set independently. The only methods in this metric for setting up the component metrics is SetMovingTransform(). The corresponding Set accesor is also available. When Set{Fixed/Moving}Transform() is not used this metric's m_{Fixed/Moving}Transform member is assigned to the fixed/moving transform assigned to the first component metric.

Each component will be initialized by this metric in the call to Initialize().

Note

When used with an itkRegistrationParameterScalesEstimator estimator, and the multi-metric holds one or more point-set metrics, the user must assign a virtual domain point set for sampling to ensure proper sampling within the point set metrics. In order to generate valid shift estimations, such a virtual domain point set must include mapped points from the fixed point set. See RegistrationParameterScalesEstimator::SetVirtualDomainPointSet() and PointSetToPointSetMetricv4::GetVirtualTransformedPointSet(). If there are two different point sets, then the virtual domain point set should be a union of the two for completeness.

If the user does not explicitly assign a virtual domain, then the first valid virtual domain found in the component metrics will be used a virtual domain for this multi-metric, which will be queried by classes such as registration parameter estimators. Each componenet metric will still use its own virtual domain for internal calculations when evaluated, so it is possible to use different virtual domains for each metric if desired. If no component metric has a virtual domain defined, then by default the virtual domain is unbounded. When the transform is high dimensional (e.g. DisplacementFieldTransform) then there must be a virtual domain that matches the space of the transform field. Note that when used with a DisplacementFieldTransform, both Image and PointSet metrics will automatically create a matching virtual domain during initialization if one has not been assigned by the user.

Definition at line 93 of file itkObjectToObjectMultiMetricv4.h.

Public Types
using	ConstPointer = SmartPointer< const Self >
using	CoordinateRepresentationType = typename Superclass::CoordinateRepresentationType
using	DerivativeType = typename Superclass::DerivativeType
using	DerivativeValueType = typename Superclass::DerivativeValueType
using	FixedTransformType = typename Superclass::FixedTransformType
using	MeasureType = typename Superclass::MeasureType
using	MetricBaseConstPointer = typename MetricType::ConstPointer
using	MetricBasePointer = typename MetricType::Pointer
using	MetricCategoryType = typename Superclass::MetricCategoryType
using	MetricQueueType = std::deque< MetricBasePointer >
using	MetricType = Superclass
using	MetricValueArrayType = Array< MeasureType >
using	MovingTransformType = typename Superclass::MovingTransformType
using	NumberOfParametersType = typename Superclass::NumberOfParametersType
using	ObjectType = typename Superclass::ObjectType
using	ParametersType = typename Superclass::ParametersType
using	ParametersValueType = typename Superclass::ParametersValueType
using	Pointer = SmartPointer< Self >
using	Self = ObjectToObjectMultiMetricv4
using	Superclass = ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >
using	WeightsArrayType = Array< WeightValueType >
using	WeightValueType = typename DerivativeType::ValueType
Public Types inherited from itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >
using	ConstPointer = SmartPointer< const Self >
using	CoordinateRepresentationType = TInternalComputationValueType
using	DerivativeType = typename Superclass::DerivativeType
using	DerivativeValueType = typename Superclass::DerivativeValueType
using	DimensionType = SizeValueType
using	FixedInputPointType = typename FixedTransformType::InputPointType
using	FixedOutputPointType = typename FixedTransformType::OutputPointType
using	FixedTransformJacobianType = typename FixedTransformType::JacobianType
using	FixedTransformParametersType = typename FixedTransformType::ParametersType
using	FixedTransformPointer = typename FixedTransformType::Pointer
using	FixedTransformType = Transform< TInternalComputationValueType, TVirtualImage::ImageDimension, TFixedDimension >
using	GradientSourceType = typename Superclass::GradientSourceType
using	InternalComputationValueType = TInternalComputationValueType
using	JacobianType = typename FixedTransformType::JacobianType
using	MeasureType = typename Superclass::MeasureType
using	MetricCategoryType = typename Superclass::MetricCategoryType
using	MovingDisplacementFieldTransformType = DisplacementFieldTransform< CoordinateRepresentationType, Self::MovingDimension >
using	MovingInputPointType = typename MovingTransformType::InputPointType
using	MovingOutputPointType = typename MovingTransformType::OutputPointType
using	MovingTransformJacobianType = typename MovingTransformType::JacobianType
using	MovingTransformParametersType = typename MovingTransformType::ParametersType
using	MovingTransformPointer = typename MovingTransformType::Pointer
using	MovingTransformType = Transform< TInternalComputationValueType, TVirtualImage::ImageDimension, TMovingDimension >
using	NumberOfParametersType = typename Superclass::NumberOfParametersType
using	ObjectType = typename Superclass::Object
using	ParametersType = typename Superclass::ParametersType
using	Pointer = SmartPointer< Self >
using	Self = ObjectToObjectMetric
using	Superclass = ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >
using	VirtualDirectionType = typename VirtualImageType::DirectionType
using	VirtualImageConstPointer = typename VirtualImageType::ConstPointer
using	VirtualImagePointer = typename VirtualImageType::Pointer
using	VirtualImageType = TVirtualImage
using	VirtualIndexType = typename VirtualImageType::IndexType
using	VirtualOriginType = typename VirtualImageType::PointType
using	VirtualPixelType = typename VirtualImageType::PixelType
using	VirtualPointSetPointer = typename VirtualPointSetType::Pointer
using	VirtualPointSetType = PointSet< VirtualPixelType, Self::VirtualDimension >
using	VirtualPointType = typename VirtualImageType::PointType
using	VirtualRadiusType = typename VirtualImageType::SizeType
using	VirtualRegionType = typename VirtualImageType::RegionType
using	VirtualSizeType = typename VirtualRegionType::SizeType
using	VirtualSpacingType = typename VirtualImageType::SpacingType
Public Types inherited from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >
using	ConstPointer = SmartPointer< const Self >
using	CoordinateRepresentationType = TInternalComputationValueType
using	DerivativeType = typename Superclass::DerivativeType
using	DerivativeValueType = typename DerivativeType::ValueType
enum	GradientSourceType {   GRADIENT_SOURCE_FIXED =0,   GRADIENT_SOURCE_MOVING,   GRADIENT_SOURCE_BOTH }
using	MeasureType = typename Superclass::MeasureType
enum	MetricCategoryType {   UNKNOWN_METRIC = 0,   OBJECT_METRIC = 1,   IMAGE_METRIC = 2,   POINT_SET_METRIC = 3,   MULTI_METRIC = 4 }
using	NumberOfParametersType = unsigned int
using	ObjectConstPointer = typename ObjectType::ConstPointer
using	ObjectType = Object
using	ParametersType = typename Superclass::ParametersType
using	ParametersValueType = TInternalComputationValueType
using	Pointer = SmartPointer< Self >
using	Self = ObjectToObjectMetricBaseTemplate
using	Superclass = SingleValuedCostFunctionv4Template< TInternalComputationValueType >
Public Types inherited from itk::SingleValuedCostFunctionv4Template< TInternalComputationValueType >
using	ConstPointer = SmartPointer< const Self >
using	DerivativeType = Array< TInternalComputationValueType >
using	MeasureType = TInternalComputationValueType
using	ParametersType = typename Superclass::ParametersType
using	Pointer = SmartPointer< Self >
using	Self = SingleValuedCostFunctionv4Template
using	Superclass = CostFunctionTemplate< TInternalComputationValueType >
Public Types inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
using	ConstPointer = SmartPointer< const Self >
using	ParametersType = OptimizerParameters< TInternalComputationValueType >
using	ParametersValueType = TInternalComputationValueType
using	Pointer = SmartPointer< Self >
using	Self = CostFunctionTemplate
using	Superclass = Object
Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = Object
using	Superclass = LightObject
Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightObject

Public Member Functions
void	AddMetric (MetricType *metric)
void	ClearMetricQueue ()
virtual ::itk::LightObject::Pointer	CreateAnother () const
void	GetDerivative (DerivativeType &) const override
MetricCategoryType	GetMetricCategory () const override
const MetricQueueType &	GetMetricQueue () const
virtual WeightsArrayType	GetMetricWeights ()
virtual const char *	GetNameOfClass () const
SizeValueType	GetNumberOfMetrics () const
MeasureType	GetValue () const override
void	GetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const override
MetricValueArrayType	GetValueArray () const
MeasureType	GetWeightedValue () const
void	Initialize () override
void	SetFixedObject (const ObjectType *) override
void	SetFixedTransform (FixedTransformType *) override
virtual void	SetMetricWeights (WeightsArrayType _arg)
void	SetMovingObject (const ObjectType *) override
void	SetMovingTransform (MovingTransformType *) override
bool	SupportsArbitraryVirtualDomainSamples () const override
Public Member Functions inherited from itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >
OffsetValueType	ComputeParameterOffsetFromVirtualIndex (const VirtualIndexType &index, const NumberOfParametersType &numberOfLocalParameters) const
OffsetValueType	ComputeParameterOffsetFromVirtualPoint (const VirtualPointType &point, const NumberOfParametersType &numberOfLocalParameters) const
virtual const FixedTransformType *	GetFixedTransform () const
MetricCategoryType	GetMetricCategory () const override
virtual FixedTransformType *	GetModifiableFixedTransform ()
virtual MovingTransformType *	GetModifiableMovingTransform ()
virtual VirtualImageType *	GetModifiableVirtualImage ()
virtual const MovingTransformType *	GetMovingTransform () const
NumberOfParametersType	GetNumberOfLocalParameters () const override
NumberOfParametersType	GetNumberOfParameters () const override
virtual SizeValueType	GetNumberOfValidPoints () const
const ParametersType &	GetParameters () const override
const MovingTransformType *	GetTransform ()
VirtualDirectionType	GetVirtualDirection () const
virtual const TimeStamp &	GetVirtualDomainTimeStamp () const
virtual const VirtualImageType *	GetVirtualImage () const
VirtualOriginType	GetVirtualOrigin () const
const VirtualRegionType &	GetVirtualRegion () const
VirtualSpacingType	GetVirtualSpacing () const
bool	HasLocalSupport () const override
void	Initialize () override
virtual void	SetFixedTransform (FixedTransformType *_arg)
virtual void	SetMovingTransform (MovingTransformType *_arg)
void	SetParameters (ParametersType &params) override
void	SetTransform (MovingTransformType *transform)
void	SetVirtualDomain (const VirtualSpacingType &spacing, const VirtualOriginType &origin, const VirtualDirectionType &direction, const VirtualRegionType &region)
void	SetVirtualDomainFromImage (const VirtualImageType *virtualImage)
void	UpdateTransformParameters (const DerivativeType &derivative, TInternalComputationValueTypefactor) override
bool	IsInsideVirtualDomain (const VirtualPointType &point) const
bool	IsInsideVirtualDomain (const VirtualIndexType &index) const
Public Member Functions inherited from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >
MeasureType	GetCurrentValue () const
virtual GradientSourceType	GetGradientSource () const
bool	GetGradientSourceIncludesFixed () const
bool	GetGradientSourceIncludesMoving () const
virtual void	SetGradientSource (GradientSourceType _arg)
virtual const ObjectType *	GetFixedObject () const
virtual const ObjectType *	GetMovingObject () const
Public Member Functions inherited from itk::SingleValuedCostFunctionv4Template< TInternalComputationValueType >
virtual void	GetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const =0
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexceptoverride
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
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)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Protected Member Functions
	ObjectToObjectMultiMetricv4 ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~ObjectToObjectMultiMetricv4 () override=default
Protected Member Functions inherited from itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >
const MovingDisplacementFieldTransformType *	GetMovingDisplacementFieldTransform () const
	ObjectToObjectMetric ()
void	PrintSelf (std::ostream &os, Indent indent) const override
bool	TransformPhysicalPointToVirtualIndex (const VirtualPointType &, VirtualIndexType &) const
void	TransformVirtualIndexToPhysicalPoint (const VirtualIndexType &, VirtualPointType &) const
virtual void	VerifyDisplacementFieldSizeAndPhysicalSpace ()
bool	VerifyNumberOfValidPoints (MeasureType &value, DerivativeType &derivative) const
	~ObjectToObjectMetric () override=default
Protected Member Functions inherited from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >
	ObjectToObjectMetricBaseTemplate ()
	~ObjectToObjectMetricBaseTemplate () override=default
Protected Member Functions inherited from itk::SingleValuedCostFunctionv4Template< TInternalComputationValueType >
	SingleValuedCostFunctionv4Template ()=default
	~SingleValuedCostFunctionv4Template () override=default
Protected Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
	CostFunctionTemplate ()=default
	~CostFunctionTemplate () override=default
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
	~Object () override
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 ()

Private Attributes
MetricQueueType	m_MetricQueue
MetricValueArrayType	m_MetricValueArray
WeightsArrayType	m_MetricWeights

Additional Inherited Members
Static Public Attributes inherited from itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >
static constexpr DimensionType	FixedDimension
static constexpr DimensionType	MovingDimension
static constexpr DimensionType	VirtualDimension
Protected Attributes inherited from itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >
FixedTransformPointer	m_FixedTransform
MovingTransformPointer	m_MovingTransform
SizeValueType	m_NumberOfValidPoints
bool	m_UserHasSetVirtualDomain
VirtualImagePointer	m_VirtualImage
Protected Attributes inherited from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >
ObjectConstPointer	m_FixedObject
GradientSourceType	m_GradientSource
ObjectConstPointer	m_MovingObject
MeasureType	m_Value
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Member Typedef Documentation

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::ConstPointer = SmartPointer<const Self>

Definition at line 103 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::CoordinateRepresentationType = typename Superclass::CoordinateRepresentationType

Definition at line 118 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::DerivativeType = typename Superclass::DerivativeType

Definition at line 113 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::DerivativeValueType = typename Superclass::DerivativeValueType

Definition at line 114 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::FixedTransformType = typename Superclass::FixedTransformType

Definition at line 120 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::MeasureType = typename Superclass::MeasureType

Types inherited from Superclass.

Definition at line 112 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::MetricBaseConstPointer = typename MetricType::ConstPointer

Definition at line 125 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::MetricBasePointer = typename MetricType::Pointer

Definition at line 124 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::MetricCategoryType = typename Superclass::MetricCategoryType

Definition at line 195 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::MetricQueueType = std::deque<MetricBasePointer>

Definition at line 126 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::MetricType = Superclass

type alias related to the metric queue

Definition at line 123 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::MetricValueArrayType = Array<MeasureType>

Definition at line 132 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::MovingTransformType = typename Superclass::MovingTransformType

Definition at line 119 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::NumberOfParametersType = typename Superclass::NumberOfParametersType

Definition at line 117 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::ObjectType = typename Superclass::ObjectType

Definition at line 128 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::ParametersType = typename Superclass::ParametersType

Definition at line 115 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::ParametersValueType = typename Superclass::ParametersValueType

Definition at line 116 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::Pointer = SmartPointer<Self>

Definition at line 102 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::Self = ObjectToObjectMultiMetricv4

Standard class type aliases

Definition at line 100 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::Superclass = ObjectToObjectMetric<TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType>

Definition at line 101 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::WeightsArrayType = Array<WeightValueType>

Definition at line 131 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

using itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::WeightValueType = typename DerivativeType::ValueType

Definition at line 130 of file itkObjectToObjectMultiMetricv4.h.

Constructor & Destructor Documentation

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::ObjectToObjectMultiMetricv4 ( )

protected

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::~ObjectToObjectMultiMetricv4 ( )

overrideprotecteddefault

Member Function Documentation

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

void itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::AddMetric

(

MetricType *

metric

)

Add a metric to the queue

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

void itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::ClearMetricQueue

(

)

Clear the metric queue

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

virtual::itk::LightObject::Pointer itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::CreateAnother ( ) 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<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

void itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::GetDerivative ( DerivativeType &  ) const

overridevirtual

This method returns the derivative based on the current transformation(s).

Implements itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

MetricCategoryType itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::GetMetricCategory ( ) const

inlineoverridevirtual

Get metric category

Reimplemented from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >.

Definition at line 198 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

const MetricQueueType& itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::GetMetricQueue

(

)

const

Get the metrics queue

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

virtual WeightsArrayType itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::GetMetricWeights ( )

virtual

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

virtual const char* itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

SizeValueType itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::GetNumberOfMetrics

(

)

const

Get the number of metrics

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

MeasureType itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::GetValue ( ) const

overridevirtual

Evaluate the metrics and return the value of only the first metric.

See Also

GetValueArray

GetWeightedValue

Implements itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

void itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::GetValueAndDerivative ( MeasureType &  value, DerivativeType &  derivative  ) const

overridevirtual

Evaluate the metric value and derivative.

Note

Parameters

value	will contain the value of only the first metric on return.
derivative	holds the combined derivative on return.

See Also

GetValueArray

GetWeightedValue

Implements itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

MetricValueArrayType itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::GetValueArray

(

)

const

Returns an itkArray of metric values, one for each component metric. It only has meaning after a call to GetValue(), GetDerivative() or GetValueAndDerivative().

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

MeasureType itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::GetWeightedValue

(

)

const

Returns a combined metric value of all component metrics, using the assigned weights. It only has meaning after a call to GetValue(), GetDerivative() or GetValueAndDerivative().

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

void itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::Initialize ( )

overridevirtual

Initialize the Metric by making sure that all the components are present and plugged together correctly, and initializing internal variables as required. This is for one-time initialization, e.g. before starting an optimization process.

Implements itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

static Pointer itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::New ( )

static

New macro for creation of through a Smart Pointer

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

void itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

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::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

void itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::SetFixedObject ( const ObjectType *  )

inlineoverridevirtual

Set fixed object (image, point set, etc.)

Reimplemented from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >.

Definition at line 149 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

void itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::SetFixedTransform ( FixedTransformType *  )

override

Set each of the component metrics to use this fixed transform.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

virtual void itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::SetMetricWeights ( WeightsArrayType  _arg )

virtual

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

void itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::SetMovingObject ( const ObjectType *  )

inlineoverridevirtual

Set moving object (image, point set, etc.)

Reimplemented from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >.

Definition at line 155 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

void itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::SetMovingTransform ( MovingTransformType *  )

override

Set each of the component metrics to use this moving transform.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

bool itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::SupportsArbitraryVirtualDomainSamples ( ) const

overridevirtual

Returns a flag. True if arbitrary virtual domain points will always correspond to data points. False if not. For example, point-set metrics return false because only some virtual domain points will correspond to points within the point sets.

Implements itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >.

Member Data Documentation

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

MetricQueueType itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::m_MetricQueue

private

Definition at line 210 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

MetricValueArrayType itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::m_MetricValueArray

mutableprivate

Definition at line 212 of file itkObjectToObjectMultiMetricv4.h.

template<unsigned int TFixedDimension, unsigned int TMovingDimension, typename TVirtualImage = Image<double, TFixedDimension>, class TInternalComputationValueType = double>

WeightsArrayType itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >::m_MetricWeights

private

Definition at line 211 of file itkObjectToObjectMultiMetricv4.h.

---

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

• itkObjectToObjectMultiMetricv4.h