itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType > Class Template Reference

#include <itkObjectToObjectMetric.h>

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

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

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 SetFixedTranform() and SetMovingTransform().

Virtual Domain

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

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

If the virtual domain is left undefined by the user and by derived classes, then unit or zero values are returned for GetVirtualSpacing(), GetVirtualDirection() and GetVirtualOrigin(), as appropriate. The virtual region is left undefined and an attempt to retrieve it via GetVirtualRegion() will generate an exception. The m_VirtualImage member will be ITK_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 89 of file itkObjectToObjectMetric.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TParametersValueType	CoordinateRepresentationType
typedef Superclass::DerivativeType	DerivativeType
typedef Superclass::DerivativeValueType	DerivativeValueType
typedef SizeValueType	DimensionType
typedef FixedTransformType::InputPointType	FixedInputPointType
typedef FixedTransformType::OutputPointType	FixedOutputPointType
typedef FixedTransformType::JacobianType	FixedTransformJacobianType
typedef FixedTransformType::ParametersType	FixedTransformParametersType
typedef FixedTransformType::Pointer	FixedTransformPointer
typedef Transform < TParametersValueType, TVirtualImage::ImageDimension, TFixedDimension >	FixedTransformType
typedef Superclass::GradientSourceType	GradientSourceType
typedef TParametersValueType	InternalComputationValueType
typedef FixedTransformType::JacobianType	JacobianType
typedef Superclass::MeasureType	MeasureType
typedef Superclass::MetricCategoryType	MetricCategoryType
typedef DisplacementFieldTransform < CoordinateRepresentationType, itkGetStaticConstMacro(MovingDimension) >	MovingDisplacementFieldTransformType
typedef MovingTransformType::InputPointType	MovingInputPointType
typedef MovingTransformType::OutputPointType	MovingOutputPointType
typedef MovingTransformType::JacobianType	MovingTransformJacobianType
typedef MovingTransformType::ParametersType	MovingTransformParametersType
typedef MovingTransformType::Pointer	MovingTransformPointer
typedef Transform < TParametersValueType, TVirtualImage::ImageDimension, TMovingDimension >	MovingTransformType
typedef Superclass::NumberOfParametersType	NumberOfParametersType
typedef Superclass::Object	ObjectType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef ObjectToObjectMetric	Self
typedef ObjectToObjectMetricBaseTemplate < TParametersValueType >	Superclass
typedef VirtualImageType::DirectionType	VirtualDirectionType
typedef VirtualImageType::ConstPointer	VirtualImageConstPointer
typedef VirtualImageType::Pointer	VirtualImagePointer
typedef TVirtualImage	VirtualImageType
typedef VirtualImageType::IndexType	VirtualIndexType
typedef VirtualImageType::PointType	VirtualOriginType
typedef VirtualImageType::PixelType	VirtualPixelType
typedef VirtualPointSetType::Pointer	VirtualPointSetPointer
typedef PointSet < VirtualPixelType, itkGetStaticConstMacro(VirtualDimension)>	VirtualPointSetType
typedef VirtualImageType::PointType	VirtualPointType
typedef VirtualImageType::SizeType	VirtualRadiusType
typedef VirtualImageType::RegionType	VirtualRegionType
typedef VirtualRegionType::SizeType	VirtualSizeType
typedef VirtualImageType::SpacingType	VirtualSpacingType
Public Types inherited from itk::ObjectToObjectMetricBaseTemplate< TParametersValueType >
typedef SmartPointer< const Self >	ConstPointer
typedef TParametersValueType	CoordinateRepresentationType
typedef Superclass::DerivativeType	DerivativeType
typedef DerivativeType::ValueType	DerivativeValueType
enum	GradientSourceType
typedef Superclass::MeasureType	MeasureType
enum	MetricCategoryType
typedef unsigned int	NumberOfParametersType
typedef ObjectType::ConstPointer	ObjectConstPointer
typedef Object	ObjectType
typedef Superclass::ParametersType	ParametersType
typedef TParametersValueType	ParametersValueType
typedef SmartPointer< Self >	Pointer
typedef ObjectToObjectMetricBaseTemplate	Self
typedef SingleValuedCostFunctionv4Template < TParametersValueType >	Superclass
Public Types inherited from itk::SingleValuedCostFunctionv4Template< TParametersValueType >
typedef SmartPointer< const Self >	ConstPointer
typedef Array < TParametersValueType >	DerivativeType
typedef TParametersValueType	MeasureType
typedef Superclass::ParametersType	ParametersType
typedef SmartPointer< Self >	Pointer
typedef SingleValuedCostFunctionv4Template	Self
typedef CostFunctionTemplate < TParametersValueType >	Superclass
Public Types inherited from itk::CostFunctionTemplate< TParametersValueType >
typedef SmartPointer< const Self >	ConstPointer
typedef OptimizerParameters < TParametersValueType >	ParametersType
typedef TParametersValueType	ParametersValueType
typedef SmartPointer< Self >	Pointer
typedef CostFunctionTemplate	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
OffsetValueType	ComputeParameterOffsetFromVirtualIndex (const VirtualIndexType &index, const NumberOfParametersType &numberOfLocalParameters) const
OffsetValueType	ComputeParameterOffsetFromVirtualPoint (const VirtualPointType &point, const NumberOfParametersType &numberOfLocalParameters) const
virtual const FixedTransformType *	GetFixedTransform () const
virtual MetricCategoryType	GetMetricCategory () const override
virtual FixedTransformType *	GetModifiableFixedTransform ()
virtual MovingTransformType *	GetModifiableMovingTransform ()
virtual VirtualImageType *	GetModifiableVirtualImage ()
virtual const MovingTransformType *	GetMovingTransform () const
virtual const char *	GetNameOfClass () const
virtual NumberOfParametersType	GetNumberOfLocalParameters () const override
virtual NumberOfParametersType	GetNumberOfParameters () const override
virtual SizeValueType	GetNumberOfValidPoints () const
virtual 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
virtual bool	HasLocalSupport () const override
virtual void	Initialize (void) override
virtual void	SetFixedTransform (FixedTransformType *_arg)
virtual void	SetMovingTransform (MovingTransformType *_arg)
virtual 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 (void) const =0
virtual 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< TParametersValueType >
MeasureType	GetCurrentValue () const
virtual void	GetDerivative (DerivativeType &) const =0
virtual GradientSourceType	GetGradientSource () const
bool	GetGradientSourceIncludesFixed () const
bool	GetGradientSourceIncludesMoving () const
virtual MeasureType	GetValue () const override=0
virtual void	GetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const override=0
virtual void	SetGradientSource (GradientSourceType _arg)
virtual void	SetParameters (ParametersType &params)=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< TParametersValueType >
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 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
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) override
virtual void	UnRegister () const noexceptoverride
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 Attributes
static const DimensionType	FixedDimension = TFixedDimension
static const DimensionType	MovingDimension = TMovingDimension
static const 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
virtual	~ObjectToObjectMetric () override
Protected Member Functions inherited from itk::ObjectToObjectMetricBaseTemplate< TParametersValueType >
	ObjectToObjectMetricBaseTemplate ()
void	PrintSelf (std::ostream &os, Indent indent) const override
virtual	~ObjectToObjectMetricBaseTemplate () override
Protected Member Functions inherited from itk::SingleValuedCostFunctionv4Template< TParametersValueType >
	SingleValuedCostFunctionv4Template ()
virtual	~SingleValuedCostFunctionv4Template () override
Protected Member Functions inherited from itk::CostFunctionTemplate< TParametersValueType >
	CostFunctionTemplate ()
virtual	~CostFunctionTemplate () override
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~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 ()

Protected Attributes
FixedTransformPointer	m_FixedTransform
MovingTransformPointer	m_MovingTransform
SizeValueType	m_NumberOfValidPoints
bool	m_UserHasSetVirtualDomain
VirtualImagePointer	m_VirtualImage
Protected Attributes inherited from itk::ObjectToObjectMetricBaseTemplate< TParametersValueType >
ObjectConstPointer	m_FixedObject
GradientSourceType	m_GradientSource
ObjectConstPointer	m_MovingObject
MeasureType	m_Value
Protected Attributes inherited from itk::LightObject
AtomicInt< 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 flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Member Typedef Documentation

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

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

Definition at line 97 of file itkObjectToObjectMetric.h.

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

typedef TParametersValueType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::CoordinateRepresentationType

Type used for representing object components

Definition at line 100 of file itkObjectToObjectMetric.h.

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

typedef Superclass::DerivativeType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::DerivativeType

Type of the derivative.

Definition at line 115 of file itkObjectToObjectMetric.h.

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

typedef Superclass::DerivativeValueType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::DerivativeValueType

Definition at line 116 of file itkObjectToObjectMetric.h.

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

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

Dimension type

Definition at line 125 of file itkObjectToObjectMetric.h.

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

typedef FixedTransformType::InputPointType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::FixedInputPointType

Definition at line 160 of file itkObjectToObjectMetric.h.

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

typedef FixedTransformType::OutputPointType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::FixedOutputPointType

Definition at line 161 of file itkObjectToObjectMetric.h.

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

typedef FixedTransformType::JacobianType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::FixedTransformJacobianType

Definition at line 171 of file itkObjectToObjectMetric.h.

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

typedef FixedTransformType::ParametersType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::FixedTransformParametersType

Definition at line 162 of file itkObjectToObjectMetric.h.

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

typedef FixedTransformType::Pointer itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::FixedTransformPointer

Definition at line 159 of file itkObjectToObjectMetric.h.

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

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

Definition at line 157 of file itkObjectToObjectMetric.h.

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

typedef Superclass::GradientSourceType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::GradientSourceType

Definition at line 122 of file itkObjectToObjectMetric.h.

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

typedef TParametersValueType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::InternalComputationValueType

Type for internal computations

Definition at line 106 of file itkObjectToObjectMetric.h.

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

typedef FixedTransformType::JacobianType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::JacobianType

Jacobian type. This is the same for all transforms

Definition at line 170 of file itkObjectToObjectMetric.h.

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

typedef Superclass::MeasureType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::MeasureType

Type of the measure.

Definition at line 109 of file itkObjectToObjectMetric.h.

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

typedef Superclass::MetricCategoryType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::MetricCategoryType

Definition at line 293 of file itkObjectToObjectMetric.h.

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

typedef DisplacementFieldTransform<CoordinateRepresentationType, itkGetStaticConstMacro( MovingDimension ) > itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::MovingDisplacementFieldTransformType

DisplacementFieldTransform types for working with local-support transforms

Definition at line 175 of file itkObjectToObjectMetric.h.

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

typedef MovingTransformType::InputPointType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::MovingInputPointType

Definition at line 165 of file itkObjectToObjectMetric.h.

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

typedef MovingTransformType::OutputPointType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::MovingOutputPointType

Definition at line 166 of file itkObjectToObjectMetric.h.

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

typedef MovingTransformType::JacobianType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::MovingTransformJacobianType

Definition at line 172 of file itkObjectToObjectMetric.h.

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

typedef MovingTransformType::ParametersType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::MovingTransformParametersType

Definition at line 167 of file itkObjectToObjectMetric.h.

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

typedef MovingTransformType::Pointer itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::MovingTransformPointer

Definition at line 164 of file itkObjectToObjectMetric.h.

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

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

Type of the Transform Base classes

Definition at line 154 of file itkObjectToObjectMetric.h.

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

typedef Superclass::NumberOfParametersType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::NumberOfParametersType

Definition at line 120 of file itkObjectToObjectMetric.h.

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

typedef Superclass::Object itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::ObjectType

Type of object.

Definition at line 112 of file itkObjectToObjectMetric.h.

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

typedef Superclass::ParametersType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::ParametersType

Type of the parameters.

Definition at line 119 of file itkObjectToObjectMetric.h.

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

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

Definition at line 96 of file itkObjectToObjectMetric.h.

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

typedef ObjectToObjectMetric itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::Self

Standard class typedefs.

Definition at line 94 of file itkObjectToObjectMetric.h.

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

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

Definition at line 95 of file itkObjectToObjectMetric.h.

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

typedef VirtualImageType::DirectionType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualDirectionType

Definition at line 143 of file itkObjectToObjectMetric.h.

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

typedef VirtualImageType::ConstPointer itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualImageConstPointer

Definition at line 136 of file itkObjectToObjectMetric.h.

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

typedef VirtualImageType::Pointer itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualImagePointer

Definition at line 135 of file itkObjectToObjectMetric.h.

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

typedef TVirtualImage itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualImageType

Types for the virtual domain

Definition at line 134 of file itkObjectToObjectMetric.h.

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

typedef VirtualImageType::IndexType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualIndexType

Definition at line 145 of file itkObjectToObjectMetric.h.

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

typedef VirtualImageType::PointType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualOriginType

Definition at line 141 of file itkObjectToObjectMetric.h.

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

typedef VirtualImageType::PixelType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualPixelType

Definition at line 137 of file itkObjectToObjectMetric.h.

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

typedef VirtualPointSetType::Pointer itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualPointSetPointer

Definition at line 149 of file itkObjectToObjectMetric.h.

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

typedef PointSet<VirtualPixelType, itkGetStaticConstMacro(VirtualDimension)> itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualPointSetType

Point set in the virtual domain

Definition at line 148 of file itkObjectToObjectMetric.h.

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

typedef VirtualImageType::PointType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualPointType

Definition at line 142 of file itkObjectToObjectMetric.h.

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

typedef VirtualImageType::SizeType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualRadiusType

Definition at line 144 of file itkObjectToObjectMetric.h.

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

typedef VirtualImageType::RegionType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualRegionType

Definition at line 138 of file itkObjectToObjectMetric.h.

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

typedef VirtualRegionType::SizeType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualSizeType

Definition at line 139 of file itkObjectToObjectMetric.h.

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

typedef VirtualImageType::SpacingType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::VirtualSpacingType

Definition at line 140 of file itkObjectToObjectMetric.h.

Constructor & Destructor Documentation

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

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

protected

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

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

overrideprotectedvirtual

Member Function Documentation

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

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

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

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

virtual

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

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

inlineoverridevirtual

Get metric category

Reimplemented from itk::ObjectToObjectMetricBaseTemplate< TParametersValueType >.

Reimplemented in itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, TInternalComputationValueType >, and itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >.

Definition at line 296 of file itkObjectToObjectMetric.h.

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.

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.

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

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 ITK_NULLPTR.

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

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

virtual

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

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::ObjectToObjectMetricBaseTemplate< TParametersValueType >.

Reimplemented in itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >, itk::CorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, TInternalComputationValueType >, itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >, itk::DemonsImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::LabeledPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, itk::JointHistogramMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, itk::EuclideanDistancePointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, and itk::MeanSquaresImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >.

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

virtual NumberOfParametersType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::GetNumberOfLocalParameters ( void  ) 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< TParametersValueType >.

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

virtual NumberOfParametersType itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::GetNumberOfParameters ( void  ) 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< TParametersValueType >.

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.

Reimplemented in itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >.

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

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

overridevirtual

Get a const reference to the active transform's parameters

Implements itk::ObjectToObjectMetricBaseTemplate< TParametersValueType >.

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

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.

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.

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

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

virtual

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.

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.

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.

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

virtual 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< TParametersValueType >.

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

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

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< TParametersValueType >.

Reimplemented in itk::ImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, TInternalComputationValueType >, itk::ANTSNeighborhoodCorrelationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::MattesMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::JointHistogramMutualInformationImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >, itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >, itk::DemonsImageToImageMetricv4< TFixedImage, TMovingImage, TVirtualImage, TInternalComputationValueType, TMetricTraits >, itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, and itk::LabeledPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >.

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.

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.

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::CostFunctionTemplate< TParametersValueType >.

Reimplemented in itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, TInternalComputationValueType >.

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.

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.

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

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

overridevirtual

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.

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 initializaiton 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

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

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

virtual bool itk::ObjectToObjectMetric< TFixedDimension, TMovingDimension, TVirtualImage, TParametersValueType >::SupportsArbitraryVirtualDomainSamples ( void  ) 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::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >, itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, TInternalComputationValueType >, and itk::ObjectToObjectMultiMetricv4< TFixedDimension, TMovingDimension, TVirtualImage, TInternalComputationValueType >.

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

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

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

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

overridevirtual

Update the parameters of the metric's active transform. Typically this call is passed through directly to the transform. factor is a scalar multiplier for each value in update, and defaults to 1.0 . derivative must be the proper size, as retrieved from GetNumberOfParameters.

Implements itk::ObjectToObjectMetricBaseTemplate< TParametersValueType >.

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.

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

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

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

static

Object dimension accessors

Definition at line 128 of file itkObjectToObjectMetric.h.

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

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

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

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

mutableprotected

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

See Also

VerifyNumberOfValidPoints()

Definition at line 341 of file itkObjectToObjectMetric.h.

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

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

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

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

static

Object dimension accessors

Definition at line 129 of file itkObjectToObjectMetric.h.

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

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

static

Object dimension accessors

Definition at line 130 of file itkObjectToObjectMetric.h.

---

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

• itkObjectToObjectMetric.h