#include <itkObjectToObjectMetric.h>

Detailed Description

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

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 SetFixedTransform() 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 nullptr.

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 92 of file itkObjectToObjectMetric.h.

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	CoordinateRepresentationType = TParametersValueType

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< TParametersValueType, TVirtualImage::ImageDimension, TFixedDimension >

using	InternalComputationValueType = TParametersValueType

using	JacobianType = typename FixedTransformType::JacobianType

using	MetricCategoryType = typename Superclass::MetricCategoryEnum

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< TParametersValueType, TVirtualImage::ImageDimension, TMovingDimension >

using	ObjectType = typename Superclass::Object

using	Pointer = SmartPointer< Self >

using	Self = ObjectToObjectMetric

using	Superclass = ObjectToObjectMetricBaseTemplate< TParametersValueType >

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< double >
using	ConstPointer = SmartPointer< const Self >

using	CoordinateRepresentationType = double

using	DerivativeValueType = typename DerivativeType::ValueType

using	GradientSourceEnum = itk::ObjectToObjectMetricBaseTemplateEnums::GradientSource

using	MetricCategoryEnum = itk::ObjectToObjectMetricBaseTemplateEnums::MetricCategory

using	NumberOfParametersType = unsigned int

using	ObjectConstPointer = typename ObjectType::ConstPointer

using	ObjectType = Object

using	ParametersValueType = double

using	Pointer = SmartPointer< Self >

using	Self = ObjectToObjectMetricBaseTemplate

using	Superclass = SingleValuedCostFunctionv4Template< double >

Public Types inherited from itk::SingleValuedCostFunctionv4Template< double >
using	ConstPointer = SmartPointer< const Self >

using	DerivativeType = Array< double >

using	MeasureType = double

using	Pointer = SmartPointer< Self >

using	Self = SingleValuedCostFunctionv4Template

using	Superclass = CostFunctionTemplate< double >

Public Types inherited from itk::CostFunctionTemplate< double >
using	ConstPointer = SmartPointer< const Self >

using	ParametersType = OptimizerParameters< double >

using	ParametersValueType = double

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
OffsetValueType	ComputeParameterOffsetFromVirtualIndex (const VirtualIndexType &index, const NumberOfParametersType &numberOfLocalParameters) const

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

MetricCategoryType	GetMetricCategory () const override

virtual FixedTransformType *	GetModifiableFixedTransform ()

virtual MovingTransformType *	GetModifiableMovingTransform ()

virtual VirtualImageType *	GetModifiableVirtualImage ()

const char *	GetNameOfClass () const override

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

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)

virtual bool	SupportsArbitraryVirtualDomainSamples () const =0

void	UpdateTransformParameters (const DerivativeType &derivative, TParametersValueType factor) override


bool	IsInsideVirtualDomain (const VirtualPointType &point) const

bool	IsInsideVirtualDomain (const VirtualIndexType &index) const

Public Member Functions inherited from itk::ObjectToObjectMetricBaseTemplate< double >
MeasureType	GetCurrentValue () const

virtual void	GetDerivative (DerivativeType &) const=0

virtual GradientSourceEnum	GetGradientSource () const

bool	GetGradientSourceIncludesFixed () const

bool	GetGradientSourceIncludesMoving () const

virtual MetricCategoryEnum	GetMetricCategory () const

const char *	GetNameOfClass () const override

virtual const ParametersType &	GetParameters () const=0

MeasureType	GetValue () const override=0

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

virtual bool	HasLocalSupport () const=0

virtual void	Initialize ()=0

virtual void	SetGradientSource (GradientSourceEnum _arg)

virtual void	SetParameters (ParametersType &params)=0

virtual void	UpdateTransformParameters (const DerivativeType &derivative, ParametersValueType factor=NumericTraits< ParametersValueType >::OneValue())=0

virtual void	SetFixedObject (const ObjectType *_arg)

virtual const ObjectType *	GetFixedObject () const

virtual void	SetMovingObject (const ObjectType *_arg)

virtual const ObjectType *	GetMovingObject () const

Public Member Functions inherited from itk::SingleValuedCostFunctionv4Template< double >
const char *	GetNameOfClass () const override

virtual MeasureType	GetValue () const=0

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

const char *	GetNameOfClass () const override

virtual unsigned int	GetNumberOfParameters () const=0

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

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

const char *	GetNameOfClass () const override

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) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

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
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Attributes
static constexpr DimensionType	FixedDimension = TFixedDimension

static constexpr DimensionType	MovingDimension = TMovingDimension

static constexpr DimensionType	VirtualDimension = TVirtualImage::ImageDimension

Protected Member Functions
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< double >
	ObjectToObjectMetricBaseTemplate ()

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

	~ObjectToObjectMetricBaseTemplate () override=default

Protected Member Functions inherited from itk::SingleValuedCostFunctionv4Template< double >
	SingleValuedCostFunctionv4Template ()=default

	~SingleValuedCostFunctionv4Template () override=default

Protected Member Functions inherited from itk::CostFunctionTemplate< double >
	CostFunctionTemplate ()=default

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

	~CostFunctionTemplate () override=default

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

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~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	PrintSelf (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 { 0 }

bool	m_UserHasSetVirtualDomain {}

VirtualImagePointer	m_VirtualImage {}

Protected Attributes inherited from itk::ObjectToObjectMetricBaseTemplate< double >
ObjectConstPointer	m_FixedObject

GradientSourceEnum	m_GradientSource

ObjectConstPointer	m_MovingObject

MeasureType	m_Value

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

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 val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Member Typedef Documentation

◆ ConstPointer

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::ConstPointer = SmartPointer<const Self>

Definition at line 101 of file itkObjectToObjectMetric.h.

◆ CoordinateRepresentationType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::CoordinateRepresentationType = TParametersValueType

Type used for representing object components

Definition at line 107 of file itkObjectToObjectMetric.h.

◆ DimensionType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::DimensionType = SizeValueType

Dimension type

Definition at line 129 of file itkObjectToObjectMetric.h.

◆ FixedInputPointType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::FixedInputPointType = typename FixedTransformType::InputPointType

Definition at line 159 of file itkObjectToObjectMetric.h.

◆ FixedOutputPointType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::FixedOutputPointType = typename FixedTransformType::OutputPointType

Definition at line 160 of file itkObjectToObjectMetric.h.

◆ FixedTransformJacobianType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::FixedTransformJacobianType = typename FixedTransformType::JacobianType

Definition at line 170 of file itkObjectToObjectMetric.h.

◆ FixedTransformParametersType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::FixedTransformParametersType = typename FixedTransformType::ParametersType

Definition at line 161 of file itkObjectToObjectMetric.h.

◆ FixedTransformPointer

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::FixedTransformPointer = typename FixedTransformType::Pointer

Definition at line 158 of file itkObjectToObjectMetric.h.

◆ FixedTransformType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::FixedTransformType = Transform<TParametersValueType, TVirtualImage::ImageDimension, TFixedDimension>

Definition at line 156 of file itkObjectToObjectMetric.h.

◆ InternalComputationValueType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::InternalComputationValueType = TParametersValueType

Type for internal computations

Definition at line 110 of file itkObjectToObjectMetric.h.

◆ JacobianType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::JacobianType = typename FixedTransformType::JacobianType

Jacobian type. This is the same for all transforms

Definition at line 169 of file itkObjectToObjectMetric.h.

◆ MetricCategoryType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::MetricCategoryType = typename Superclass::MetricCategoryEnum

Definition at line 318 of file itkObjectToObjectMetric.h.

◆ MovingDisplacementFieldTransformType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::MovingDisplacementFieldTransformType = DisplacementFieldTransform<CoordinateRepresentationType, Self::MovingDimension>

DisplacementFieldTransform types for working with local-support transforms

Definition at line 174 of file itkObjectToObjectMetric.h.

◆ MovingInputPointType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::MovingInputPointType = typename MovingTransformType::InputPointType

Definition at line 164 of file itkObjectToObjectMetric.h.

◆ MovingOutputPointType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::MovingOutputPointType = typename MovingTransformType::OutputPointType

Definition at line 165 of file itkObjectToObjectMetric.h.

◆ MovingTransformJacobianType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::MovingTransformJacobianType = typename MovingTransformType::JacobianType

Definition at line 171 of file itkObjectToObjectMetric.h.

◆ MovingTransformParametersType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::MovingTransformParametersType = typename MovingTransformType::ParametersType

Definition at line 166 of file itkObjectToObjectMetric.h.

◆ MovingTransformPointer

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::MovingTransformPointer = typename MovingTransformType::Pointer

Definition at line 163 of file itkObjectToObjectMetric.h.

◆ MovingTransformType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::MovingTransformType = Transform<TParametersValueType, TVirtualImage::ImageDimension, TMovingDimension>

Type of the Transform Base classes

Definition at line 155 of file itkObjectToObjectMetric.h.

◆ ObjectType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::ObjectType = typename Superclass::Object

Type of object.

Definition at line 116 of file itkObjectToObjectMetric.h.

◆ Pointer

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::Pointer = SmartPointer<Self>

Definition at line 100 of file itkObjectToObjectMetric.h.

◆ Self

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::Self = ObjectToObjectMetric

Standard class type aliases.

Definition at line 98 of file itkObjectToObjectMetric.h.

◆ Superclass

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::Superclass = ObjectToObjectMetricBaseTemplate<TParametersValueType>

Definition at line 99 of file itkObjectToObjectMetric.h.

◆ VirtualDirectionType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualDirectionType = typename VirtualImageType::DirectionType

Definition at line 146 of file itkObjectToObjectMetric.h.

◆ VirtualImageConstPointer

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualImageConstPointer = typename VirtualImageType::ConstPointer

Definition at line 139 of file itkObjectToObjectMetric.h.

◆ VirtualImagePointer

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualImagePointer = typename VirtualImageType::Pointer

Definition at line 138 of file itkObjectToObjectMetric.h.

◆ VirtualImageType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualImageType = TVirtualImage

Types for the virtual domain

Definition at line 137 of file itkObjectToObjectMetric.h.

◆ VirtualIndexType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualIndexType = typename VirtualImageType::IndexType

Definition at line 148 of file itkObjectToObjectMetric.h.

◆ VirtualOriginType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualOriginType = typename VirtualImageType::PointType

Definition at line 144 of file itkObjectToObjectMetric.h.

◆ VirtualPixelType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualPixelType = typename VirtualImageType::PixelType

Definition at line 140 of file itkObjectToObjectMetric.h.

◆ VirtualPointSetPointer

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualPointSetPointer = typename VirtualPointSetType::Pointer

Definition at line 152 of file itkObjectToObjectMetric.h.

◆ VirtualPointSetType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualPointSetType = PointSet<VirtualPixelType, Self::VirtualDimension>

Point set in the virtual domain

Definition at line 151 of file itkObjectToObjectMetric.h.

◆ VirtualPointType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualPointType = typename VirtualImageType::PointType

Definition at line 145 of file itkObjectToObjectMetric.h.

◆ VirtualRadiusType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualRadiusType = typename VirtualImageType::SizeType

Definition at line 147 of file itkObjectToObjectMetric.h.

◆ VirtualRegionType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualRegionType = typename VirtualImageType::RegionType

Definition at line 141 of file itkObjectToObjectMetric.h.

◆ VirtualSizeType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualSizeType = typename VirtualRegionType::SizeType

Definition at line 142 of file itkObjectToObjectMetric.h.

◆ VirtualSpacingType

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

using itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualSpacingType = typename VirtualImageType::SpacingType

Definition at line 143 of file itkObjectToObjectMetric.h.

Constructor & Destructor Documentation

◆ ObjectToObjectMetric()

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

itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::ObjectToObjectMetric ( )

protected

◆ ~ObjectToObjectMetric()

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

itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::~ObjectToObjectMetric ( )

overrideprotecteddefault

Member Function Documentation

◆ ComputeParameterOffsetFromVirtualIndex()

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

OffsetValueType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::ComputeParameterOffsetFromVirtualIndex	(	const VirtualIndexType &	index,
		const NumberOfParametersType &	numberOfLocalParameters
	)		const

Computes an offset for accessing parameter data from a virtual domain index. Relevant for metrics with local-support transforms, to access parameter or derivative memory that is stored linearly in a 1D array. The result is the offset (1D array index) to the first of N parameters corresponding to the given virtual index, where N is the number of local parameters.

Parameters

index	the virtual index to convert
numberOfLocalParameters	corresponding to the transform

◆ ComputeParameterOffsetFromVirtualPoint()

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

OffsetValueType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::ComputeParameterOffsetFromVirtualPoint	(	const VirtualPointType &	point,
		const NumberOfParametersType &	numberOfLocalParameters
	)		const

Computes an offset for accessing parameter data from a virtual domain point. Relevant for metrics with local-support transforms, to access parameter or derivative memory that is stored linearly in a 1D array. The result is the offset (1D array index) to the first of N parameters corresponding to the given virtual index, where N is the number of local parameters.

Parameters

point	the virtual point to convert
numberOfLocalParameters	corresponding to the transform

◆ GetMetricCategory()

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

MetricCategoryType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::GetMetricCategory ( ) const

inlineoverridevirtual

Get metric category

Reimplemented from itk::ObjectToObjectMetricBaseTemplate< double >.

Reimplemented in itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TFixedImage, double, DefaultImageToImageMetricTraitsv4< TFixedImage, TMovingImage, TFixedImage, double > >, itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >, and itk::PointSetToPointSetMetricWithIndexv4< TPointSet, TPointSet, double >.

Definition at line 322 of file itkObjectToObjectMetric.h.

◆ GetModifiableFixedTransform()

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

virtual FixedTransformType * itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::GetModifiableFixedTransform ( )

virtual

Get a pointer to the fixed transform.

◆ GetModifiableMovingTransform()

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

virtual MovingTransformType * itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::GetModifiableMovingTransform ( )

virtual

Get a pointer to the moving transform.

◆ GetModifiableVirtualImage()

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

virtual VirtualImageType * itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::GetModifiableVirtualImage ( )

virtual

◆ GetMovingDisplacementFieldTransform()

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

const MovingDisplacementFieldTransformType * itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::GetMovingDisplacementFieldTransform ( ) const

protected

If the moving transform is a DisplacementFieldTransform, return it. If the moving transform is a CompositeTransform, the routine will check if the first (last to be added) transform is a DisplacementFieldTransform, and if so return it. Otherwise, return nullptr.

◆ GetNameOfClass()

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

const char * itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

Reimplemented in itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TFixedImage, double, DefaultImageToImageMetricTraitsv4< TFixedImage, TMovingImage, TFixedImage, double > >, itk::PointSetToPointSetMetricv4< TFixedPointSet, TFixedPointSet, double >, itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, double >, itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >, and itk::PointSetToPointSetMetricWithIndexv4< TPointSet, TPointSet, double >.

◆ GetNumberOfLocalParameters()

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

NumberOfParametersType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::GetNumberOfLocalParameters ( ) const

overridevirtual

Methods for working with the metric's 'active' transform, e.g. the transform being optimized in the case of registration. Some of these are used in non-metric classes, e.g. optimizers.

Implements itk::ObjectToObjectMetricBaseTemplate< double >.

◆ GetNumberOfParameters()

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

NumberOfParametersType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::GetNumberOfParameters ( ) const

overridevirtual

Methods for working with the metric's 'active' transform, e.g. the transform being optimized in the case of registration. Some of these are used in non-metric classes, e.g. optimizers.

Implements itk::ObjectToObjectMetricBaseTemplate< double >.

◆ GetNumberOfValidPoints()

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

virtual SizeValueType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::GetNumberOfValidPoints ( ) const

virtual

Get the number of valid points after a call to evaluate the metric.

◆ GetParameters()

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

const ParametersType & itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::GetParameters ( ) const

overridevirtual

Get a const reference to the active transform's parameters

Implements itk::ObjectToObjectMetricBaseTemplate< double >.

◆ GetTransform()

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

const MovingTransformType * itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::GetTransform ( )

Get the moving transform using a backwards-compatible name

◆ GetVirtualDirection()

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

VirtualDirectionType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::GetVirtualDirection ( ) const

Accessor for virtual domain direction. Returns unit direction if a virtual domain is undefined.

◆ GetVirtualDomainTimeStamp()

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

virtual const TimeStamp & itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::GetVirtualDomainTimeStamp ( ) const

virtual

Return a timestamp relating to the virtual domain. This returns the greater of the metric timestamp and the virtual domain image timestamp. This allows us to capture if the virtual domain image is changed by the user after being assigned to the metric.

◆ GetVirtualOrigin()

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

VirtualOriginType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::GetVirtualOrigin ( ) const

Accessor for virtual domain origin. Returns zero origin if a virtual domain is undefined.

◆ GetVirtualRegion()

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

const VirtualRegionType & itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::GetVirtualRegion ( ) const

Return the virtual domain region, which is retrieved from the m_VirtualImage buffered region.

◆ GetVirtualSpacing()

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

VirtualSpacingType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::GetVirtualSpacing ( ) const

Accessors for the virtual domain spacing. Returns unit spacing if a virtual domain is undefined.

◆ HasLocalSupport()

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

bool itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::HasLocalSupport ( ) const

overridevirtual

Return whether the metric's active transform has local support, e.g. whether it is dense/high-dimensional.

Implements itk::ObjectToObjectMetricBaseTemplate< double >.

◆ Initialize()

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

void itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::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< double >.

Reimplemented in itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TFixedImage, double, DefaultImageToImageMetricTraitsv4< TFixedImage, TMovingImage, TFixedImage, double > >, itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >, and itk::PointSetToPointSetMetricWithIndexv4< TPointSet, TPointSet, double >.

◆ IsInsideVirtualDomain() [1/2]

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

bool itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::IsInsideVirtualDomain ( const VirtualIndexType & index ) const

Determine if a point is within the virtual domain.

Note: Returns true if the virtual domain has not been defined. This allows, for example, use in point set metrics where the virtual domain is implicitly defined by the point sets and transforms.

◆ IsInsideVirtualDomain() [2/2]

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

bool itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::IsInsideVirtualDomain ( const VirtualPointType & point ) const

Determine if a point is within the virtual domain.

Note: Returns true if the virtual domain has not been defined. This allows, for example, use in point set metrics where the virtual domain is implicitly defined by the point sets and transforms.

◆ PrintSelf()

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

void itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::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::Object.

Reimplemented in itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TFixedImage, double, DefaultImageToImageMetricTraitsv4< TFixedImage, TMovingImage, TFixedImage, double > >, itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >, and itk::PointSetToPointSetMetricWithIndexv4< TPointSet, TPointSet, double >.

◆ SetFixedTransform()

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

virtual void itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::SetFixedTransform ( FixedTransformType * _arg )

virtual

Connect the fixed transform.

Reimplemented in itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >.

◆ SetMovingTransform()

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

virtual void itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::SetMovingTransform ( MovingTransformType * _arg )

virtual

Connect the moving transform.

Reimplemented in itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >.

◆ SetParameters()

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

void itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::SetParameters ( ParametersType & params )

overridevirtual

Set the active transform's parameters by value

Implements itk::ObjectToObjectMetricBaseTemplate< double >.

◆ SetTransform()

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

void itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::SetTransform ( MovingTransformType * transform )

Connect the moving transform using a backwards-compatible name. This assigns the input transform to the moving transform.

◆ SetVirtualDomain()

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

void itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::SetVirtualDomain	(	const VirtualSpacingType &	spacing,
		const VirtualOriginType &	origin,
		const VirtualDirectionType &	direction,
		const VirtualRegionType &	region
	)

Define the virtual reference space. This space defines the resolution at which the registration is performed as well as the physical coordinate system. Useful for unbiased registration. This method will allocate m_VirtualImage with the passed information, with the pixel buffer left unallocated. Metric evaluation will be performed within the constraints of the virtual domain depending on implementation in derived classes. A default domain is created during initialization in derived classes according to their need.

Parameters

spacing	spacing
origin	origin
direction	direction
region	region is used to set all image regions.

See also: SetVirtualDomainFromImage

◆ SetVirtualDomainFromImage()

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

void itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::SetVirtualDomainFromImage ( const VirtualImageType * virtualImage )

Use a virtual domain image to define the virtual reference space.

See also: SetVirtualDomain

◆ SupportsArbitraryVirtualDomainSamples()

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

virtual bool itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::SupportsArbitraryVirtualDomainSamples ( ) const

pure virtual

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.

Implemented in itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TFixedImage, double, DefaultImageToImageMetricTraitsv4< TFixedImage, TMovingImage, TFixedImage, double > >, itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >, itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >, and itk::PointSetToPointSetMetricWithIndexv4< TPointSet, TPointSet, double >.

◆ TransformPhysicalPointToVirtualIndex()

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

bool itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::TransformPhysicalPointToVirtualIndex	(	const VirtualPointType &	,
		VirtualIndexType &
	)		const

protected

◆ TransformVirtualIndexToPhysicalPoint()

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

void itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::TransformVirtualIndexToPhysicalPoint	(	const VirtualIndexType &	,
		VirtualPointType &
	)		const

protected

◆ UpdateTransformParameters()

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

void itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::UpdateTransformParameters	(	const DerivativeType &	derivative,
		TParametersValueType	factor
	)

override

◆ VerifyDisplacementFieldSizeAndPhysicalSpace()

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

virtual void itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VerifyDisplacementFieldSizeAndPhysicalSpace ( )

protectedvirtual

Verify that virtual domain and displacement field are the same size and in the same physical space.

◆ VerifyNumberOfValidPoints()

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

bool itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VerifyNumberOfValidPoints	(	MeasureType &	value,
		DerivativeType &	derivative
	)		const

protected

Check that the number of valid points is above a default minimum (zero). If not, then return false, and assign to 'value' a value indicating insufficient valid points were found during evaluation, and set the derivative to zero. A warning is also output. This functionality is provided as a separate method so derived classes can use it without hardcoding the details.

Member Data Documentation

◆ FixedDimension

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

constexpr DimensionType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::FixedDimension = TFixedDimension

staticconstexpr

Object dimension accessors

Definition at line 132 of file itkObjectToObjectMetric.h.

◆ m_FixedTransform

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

FixedTransformPointer itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::m_FixedTransform {}

protected

Transforms

Definition at line 361 of file itkObjectToObjectMetric.h.

◆ m_MovingTransform

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

MovingTransformPointer itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::m_MovingTransform {}

protected

Definition at line 362 of file itkObjectToObjectMetric.h.

◆ m_NumberOfValidPoints

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

SizeValueType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::m_NumberOfValidPoints { 0 }

mutableprotected

Store the number of points used during most recent value and derivative calculation.

See also: VerifyNumberOfValidPoints()

Definition at line 373 of file itkObjectToObjectMetric.h.

◆ m_UserHasSetVirtualDomain

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

bool itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::m_UserHasSetVirtualDomain {}

protected

Flag that is set when user provides a virtual domain, either via SetVirtualDomain() or SetVirtualDomainFromImage().

Definition at line 368 of file itkObjectToObjectMetric.h.

◆ m_VirtualImage

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

VirtualImagePointer itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::m_VirtualImage {}

protected

Definition at line 364 of file itkObjectToObjectMetric.h.

◆ MovingDimension

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

constexpr DimensionType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::MovingDimension = TMovingDimension

staticconstexpr

Definition at line 133 of file itkObjectToObjectMetric.h.

◆ VirtualDimension

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

constexpr DimensionType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualDimension = TVirtualImage::ImageDimension

staticconstexpr

Definition at line 134 of file itkObjectToObjectMetric.h.

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

itkObjectToObjectMetric.h

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ CoordinateRepresentationType

◆ DimensionType

◆ FixedInputPointType

◆ FixedOutputPointType

◆ FixedTransformJacobianType

◆ FixedTransformParametersType

◆ FixedTransformPointer

◆ FixedTransformType

◆ InternalComputationValueType

◆ JacobianType

◆ MetricCategoryType

◆ MovingDisplacementFieldTransformType

◆ MovingInputPointType

◆ MovingOutputPointType

◆ MovingTransformJacobianType

◆ MovingTransformParametersType

◆ MovingTransformPointer

◆ MovingTransformType

◆ ObjectType

◆ Pointer

◆ Self

◆ Superclass

◆ VirtualDirectionType

◆ VirtualImageConstPointer

◆ VirtualImagePointer

◆ VirtualImageType

◆ VirtualIndexType

◆ VirtualOriginType

◆ VirtualPixelType

◆ VirtualPointSetPointer

◆ VirtualPointSetType

◆ VirtualPointType

◆ VirtualRadiusType

◆ VirtualRegionType

◆ VirtualSizeType

◆ VirtualSpacingType

Constructor & Destructor Documentation

◆ ObjectToObjectMetric()

◆ ~ObjectToObjectMetric()

Member Function Documentation

◆ ComputeParameterOffsetFromVirtualIndex()

◆ ComputeParameterOffsetFromVirtualPoint()

◆ GetMetricCategory()

◆ GetModifiableFixedTransform()

◆ GetModifiableMovingTransform()

◆ GetModifiableVirtualImage()

◆ GetMovingDisplacementFieldTransform()

◆ GetNameOfClass()

◆ GetNumberOfLocalParameters()

◆ GetNumberOfParameters()

◆ GetNumberOfValidPoints()

◆ GetParameters()

◆ GetTransform()

◆ GetVirtualDirection()

◆ GetVirtualDomainTimeStamp()

◆ GetVirtualOrigin()

◆ GetVirtualRegion()

◆ GetVirtualSpacing()

◆ HasLocalSupport()

◆ Initialize()

◆ IsInsideVirtualDomain() [1/2]

◆ IsInsideVirtualDomain() [2/2]

◆ PrintSelf()

◆ SetFixedTransform()

◆ SetMovingTransform()

◆ SetParameters()

◆ SetTransform()

◆ SetVirtualDomain()

◆ SetVirtualDomainFromImage()

◆ SupportsArbitraryVirtualDomainSamples()

◆ TransformPhysicalPointToVirtualIndex()