#include <itkImageToSpatialObjectMetric.h>

Inheritance diagram for itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >:

Collaboration diagram for itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >:

Detailed Description

template<typename TFixedImage, typename TMovingSpatialObject>
class itk::ImageToSpatialObjectMetric< TFixedImage, TMovingSpatialObject >

Computes similarity between a moving spatial obejct and an Image to be registered.

The ImageToSpatialObjectMetric is different from the rest of the registration framework in ITK regarding the interpretation of the Transform with respect to the Fixed and Moving objects. In most of the ITK registration framework, the Transform computed by the optimizer is the one that maps points from the space of the Fixed object into the space of the Moving object. This direction of the transform is the one that makes easier to resample the Moving object into the space of the Fixed object.

In the particular case of the ImageToSpatialObject registration, the Transform to be computed is the one mapping points from the SpatialObject into the Image, despite the fact that the SpatialObject is called the "Moving" object and the image is called the "Fixed" object. This change of reference system is the consequence of using this type of registration in applications that are based on Visualization. In the context of such visualizations it is simpler to think in terms of the Transform that can be used for displaying the SpatialObject in the appropriate position with respect to the image. Since this process does not involve resampling, but providing a Transform to a visualization routine, it is usually more natural to use the Transform that maps points from the SpatialObject space the image space.

A full discussion of the Transform directions in the ITK registration framework can be found in the ITK Software Guide.

Examples:: Examples/RegistrationITKv3/ModelToImageRegistration1.cxx, and Examples/RegistrationITKv4/ModelToImageRegistration1.cxx.

Definition at line 61 of file itkImageToSpatialObjectMetric.h.

Public Types
using	ConstPointer = SmartPointer< const Self >

using	CoordinateRepresentationType = Superclass::ParametersValueType

using	DerivativeType = Superclass::DerivativeType

using	FixedImageConstPointer = typename FixedImageType::ConstPointer

using	FixedImagePointer = typename FixedImageType::Pointer

using	FixedImageType = TFixedImage

using	InputPointType = typename TransformType::InputPointType

using	InterpolatorPointer = typename InterpolatorType::Pointer

using	InterpolatorType = LinearInterpolateImageFunction< TFixedImage, CoordinateRepresentationType >

using	MeasureType = Superclass::MeasureType

using	MovingSpatialObjectConstPointer = typename MovingSpatialObjectType::ConstPointer

using	MovingSpatialObjectPointer = typename MovingSpatialObjectType::Pointer

using	MovingSpatialObjectType = TMovingSpatialObject

using	OutputPointType = typename TransformType::OutputPointType

using	ParametersType = Superclass::ParametersType

using	Pointer = SmartPointer< Self >

using	Self = ImageToSpatialObjectMetric

using	Superclass = SingleValuedCostFunction

using	TransformJacobianType = typename TransformType::JacobianType

using	TransformParametersType = typename TransformType::ParametersType

using	TransformPointer = typename TransformType::Pointer

using	TransformType = Transform< CoordinateRepresentationType, Self::ObjectDimension, Self::ImageDimension >

using	VectorType = vnl_vector_fixed< double, Self::ObjectDimension >

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

using	DerivativeType = Array< ParametersValueType >

using	MeasureType = double

using	ParametersType = Superclass::ParametersType

using	ParametersValueType = Superclass::ParametersValueType

using	Pointer = SmartPointer< Self >

using	Self = SingleValuedCostFunction

using	Superclass = CostFunction

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

using	ParametersType = OptimizerParameters< TInternalComputationValueType >

using	ParametersValueType = TInternalComputationValueType

using	Pointer = SmartPointer< Self >

using	Self = CostFunctionTemplate

using	Superclass = Object

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
virtual const InterpolatorType *	GetInterpolator () const

virtual const ParametersType &	GetLastTransformParameters () const

virtual InterpolatorType *	GetModifiableInterpolator ()

virtual const char *	GetNameOfClass () const

unsigned int	GetNumberOfParameters () const override

void	GetValueAndDerivative (const ParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const override=0

virtual void	Initialize ()

virtual void	SetInterpolator (InterpolatorType *_arg)

virtual void	SetTransform (TransformType *_arg)


virtual void	SetFixedImage (const FixedImageType *_arg)

virtual const FixedImageType *	GetFixedImage () const


virtual void	SetMovingSpatialObject (const MovingSpatialObjectType *_arg)

virtual const MovingSpatialObjectType *	GetMovingSpatialObject () const

Public Member Functions inherited from itk::SingleValuedCostFunction
virtual void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0

virtual MeasureType	GetValue (const ParametersType &parameters) const =0

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

unsigned long	AddObserver (const EventObject &event, Command *) 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

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexceptoverride

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

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

Static Public Attributes
static constexpr unsigned int	ImageDimension = FixedImageType::ImageDimension

static constexpr unsigned int	ObjectDimension = MovingSpatialObjectType::ObjectDimension

Protected Member Functions
	ImageToSpatialObjectMetric ()

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

	~ImageToSpatialObjectMetric () override=default

Protected Member Functions inherited from itk::SingleValuedCostFunction
	SingleValuedCostFunction ()=default

	~SingleValuedCostFunction () override

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

	~CostFunctionTemplate () override=default

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

	~Object () override

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

	LightObject ()

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

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

virtual	~LightObject ()

Protected Attributes
FixedImageConstPointer	m_FixedImage

InterpolatorPointer	m_Interpolator

ParametersType	m_LastTransformParameters

MeasureType	m_MatchMeasure {0}

DerivativeType	m_MatchMeasureDerivatives

MovingSpatialObjectConstPointer	m_MovingSpatialObject

TransformPointer	m_Transform

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

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

static Pointer	New ()