#include <itkPointSetToPointSetMetricv4.h>

Inheritance diagram for itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >:

Collaboration diagram for itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef PointType::CoordRepType	CoordRepType
typedef Superclass::DerivativeType	DerivativeType
typedef DerivativeType::ValueType	DerivativeValueType
typedef Superclass::DimensionType	DimensionType
typedef Superclass::FixedInputPointType	FixedInputPointType
typedef Superclass::FixedOutputPointType	FixedOutputPointType
typedef TFixedPointSet::PixelType	FixedPixelType
typedef TFixedPointSet::PointsContainer	FixedPointsContainer
typedef TFixedPointSet	FixedPointSetType
typedef TFixedPointSet::PointType	FixedPointType
typedef PointSet < FixedPixelType, itkGetStaticConstMacro(PointDimension)>	FixedTransformedPointSetType
typedef Superclass::FixedTransformJacobianType	FixedTransformJacobianType
typedef Superclass::FixedTransformParametersType	FixedTransformParametersType
typedef Superclass::FixedTransformPointer	FixedTransformPointer
typedef Superclass::FixedTransformType	FixedTransformType
typedef Superclass::JacobianType	JacobianType
typedef FixedArray < DerivativeValueType, itkGetStaticConstMacro(PointDimension)>	LocalDerivativeType
typedef Superclass::MeasureType	MeasureType
typedef Superclass::MovingInputPointType	MovingInputPointType
typedef Superclass::MovingOutputPointType	MovingOutputPointType
typedef TMovingPointSet::PixelType	MovingPixelType
typedef TMovingPointSet::PointsContainer	MovingPointsContainer
typedef TMovingPointSet	MovingPointSetType
typedef TMovingPointSet::PointType	MovingPointType
typedef PointSet < MovingPixelType, itkGetStaticConstMacro(PointDimension)>	MovingTransformedPointSetType
typedef Superclass::MovingTransformJacobianType	MovingTransformJacobianType
typedef Superclass::MovingTransformParametersType	MovingTransformParametersType
typedef Superclass::MovingTransformPointer	MovingTransformPointer
typedef Superclass::MovingTransformType	MovingTransformType
typedef PointsLocatorType::NeighborsIdentifierType	NeighborsIdentifierType
typedef Superclass::NumberOfParametersType	NumberOfParametersType
typedef Superclass::ParametersType	ParametersType
typedef Superclass::ParametersValueType	ParametersValueType
typedef SmartPointer< Self >	Pointer
typedef PointsContainer::ElementIdentifier	PointIdentifier
typedef PointsContainer::ConstIterator	PointsConstIterator
typedef FixedPointsContainer	PointsContainer
typedef PointsLocator < PointIdentifier, itkGetStaticConstMacro(PointDimension), CoordRepType, PointsContainer >	PointsLocatorType
typedef FixedPointType	PointType
typedef PointSetToPointSetMetricv4	Self
typedef ObjectToObjectMetric < TFixedPointSet::PointDimension, TMovingPointSet::PointDimension >	Superclass
typedef Superclass::VirtualDirectionType	VirtualDirectionType
typedef Superclass::VirtualImagePointer	VirtualImagePointer
typedef Superclass::VirtualImageType	VirtualImageType
typedef Superclass::VirtualIndexType	VirtualIndexType
typedef Superclass::VirtualPointType	VirtualOriginType
typedef Superclass::VirtualPixelType	VirtualPixelType
typedef Superclass::VirtualPointSetPointer	VirtualPointSetPointer
typedef Superclass::VirtualPointSetType	VirtualPointSetType
typedef Superclass::VirtualPointType	VirtualPointType
typedef Superclass::VirtualSizeType	VirtualRadiusType
typedef Superclass::VirtualRegionType	VirtualRegionType
typedef Superclass::VirtualSizeType	VirtualSizeType
typedef Superclass::VirtualSpacingType	VirtualSpacingType
Public Types inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension >
typedef Superclass::ParametersValueType	CoordinateRepresentationType
typedef Superclass::InternalComputationValueType	InternalComputationValueType
typedef DisplacementFieldTransform < CoordinateRepresentationType, itkGetStaticConstMacro(MovingDimension) >	MovingDisplacementFieldTransformType
typedef VirtualImageType::ConstPointer	VirtualImageConstPointer
Public Types inherited from itk::ObjectToObjectMetricBase
enum	GradientSourceType { GRADIENT_SOURCE_FIXED = 0, GRADIENT_SOURCE_MOVING, GRADIENT_SOURCE_BOTH }
Public Types inherited from itk::SingleValuedCostFunctionv4
Public Types inherited from itk::CostFunction
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual void	GetDerivative (DerivativeType &) const
virtual const FixedPointSetType *	GetFixedPointSet ()
virtual const FixedTransformedPointSetType *	GetFixedTransformedPointSet ()
virtual LocalDerivativeType	GetLocalNeighborhoodDerivative (const PointType &) const
virtual MeasureType	GetLocalNeighborhoodValue (const PointType &) const =0
virtual void	GetLocalNeighborhoodValueAndDerivative (const PointType &, MeasureType &, LocalDerivativeType &) const =0
virtual const MovingPointSetType *	GetMovingPointSet ()
virtual const MovingTransformedPointSetType *	GetMovingTransformedPointSet ()
virtual const char *	GetNameOfClass () const
SizeValueType	GetNumberOfComponents () const
virtual MeasureType	GetValue () const
virtual void	GetValueAndDerivative (MeasureType &, DerivativeType &) const
const VirtualPointSetType *	GetVirtualTransformedPointSet ()
virtual void	Initialize (void) throw ( ExceptionObject )
virtual void	SetFixedPointSet (const FixedPointSetType *_arg)
virtual void	SetMovingPointSet (MovingPointSetType *_arg)
virtual bool	SupportsArbitraryVirtualDomainSamples (void) const
Public Member Functions inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension >
OffsetValueType	ComputeParameterOffsetFromVirtualIndex (const VirtualIndexType &index, const NumberOfParametersType &numberOfLocalParameters) const
OffsetValueType	ComputeParameterOffsetFromVirtualPoint (const VirtualPointType &point, const NumberOfParametersType &numberOfLocalParameters) const
virtual const FixedTransformType *	GetFixedTransform ()
virtual const MovingTransformType *	GetMovingTransform ()
virtual NumberOfParametersType	GetNumberOfLocalParameters () const
virtual NumberOfParametersType	GetNumberOfParameters () const
virtual SizeValueType	GetNumberOfValidPoints () const
virtual const ParametersType &	GetParameters () const
const MovingTransformType *	GetTransform ()
VirtualDirectionType	GetVirtualDirection (void) const
virtual const TimeStamp &	GetVirtualDomainTimeStamp (void) const
virtual const VirtualImageType *	GetVirtualImage ()
VirtualOriginType	GetVirtualOrigin (void) const
const VirtualRegionType &	GetVirtualRegion (void) const
VirtualSpacingType	GetVirtualSpacing (void) const
virtual bool	HasLocalSupport () const
virtual void	SetFixedTransform (FixedTransformType *_arg)
virtual void	SetMovingTransform (MovingTransformType *_arg)
virtual void	SetParameters (ParametersType &params)
void	SetTransform (MovingTransformType *transform)
void	SetVirtualDomain (const VirtualSpacingType &spacing, const VirtualOriginType &origin, const VirtualDirectionType &direction, const VirtualRegionType &region)
virtual void	UpdateTransformParameters (const DerivativeType &derivative, ParametersValueType factor)
void	SetVirtualDomainFromImage (VirtualImageType *virtualImage)
void	SetVirtualDomainFromImage (const VirtualImageType *virtualImage)
bool	IsInsideVirtualDomain (const VirtualPointType &point) const
bool	IsInsideVirtualDomain (const VirtualIndexType &index) const
Public Member Functions inherited from itk::ObjectToObjectMetricBase
MeasureType	GetCurrentValue () const
virtual GradientSourceType	GetGradientSource () const
bool	GetGradientSourceIncludesFixed () const
bool	GetGradientSourceIncludesMoving () const
virtual void	GetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const =0
virtual void	SetGradientSource (GradientSourceType _arg)
Public Member Functions inherited from itk::SingleValuedCostFunctionv4
virtual void	GetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const =0

Static Public Attributes
static const DimensionType	FixedPointDimension = Superclass::FixedDimension
static const DimensionType	MovingPointDimension = Superclass::MovingDimension
static const DimensionType	PointDimension = Superclass::FixedDimension
Static Public Attributes inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension >
static const DimensionType	FixedDimension
static const DimensionType	MovingDimension
static const DimensionType	VirtualDimension

Protected Member Functions
virtual SizeValueType	CalculateNumberOfValidFixedPoints (void) const
void	CalculateValueAndDerivative (MeasureType &value, DerivativeType &derivative, bool calculateValue) const
virtual void	InitializeForIteration (void) const
virtual void	InitializePointSets (void) const
void	InitializePointsLocators () const
	PointSetToPointSetMetricv4 ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	StorePointDerivative (const VirtualPointType &, const DerivativeType &, DerivativeType &) const
void	TransformFixedAndCreateVirtualPointSet () const
void	TransformMovingPointSet () const
virtual	~PointSetToPointSetMetricv4 ()
Protected Member Functions inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension >
MovingDisplacementFieldTransformType *	GetMovingDisplacementFieldTransform () const
	ObjectToObjectMetric ()
bool	TransformPhysicalPointToVirtualIndex (const VirtualPointType &, VirtualIndexType &) const
void	TransformVirtualIndexToPhysicalPoint (const VirtualIndexType &, VirtualPointType &) const
virtual void	VerifyDisplacementFieldSizeAndPhysicalSpace ()
bool	VerifyNumberOfValidPoints (MeasureType &value, DerivativeType &derivative) const
virtual	~ObjectToObjectMetric ()
Protected Member Functions inherited from itk::ObjectToObjectMetricBase
	ObjectToObjectMetricBase ()
virtual	~ObjectToObjectMetricBase ()
Protected Member Functions inherited from itk::SingleValuedCostFunctionv4
	SingleValuedCostFunctionv4 ()
virtual	~SingleValuedCostFunctionv4 ()
Protected Member Functions inherited from itk::CostFunction
	CostFunction ()
virtual	~CostFunction ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
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
FixedPointSetType::ConstPointer	m_FixedPointSet
FixedTransformedPointSetType::Pointer	m_FixedTransformedPointSet
PointsLocatorType::Pointer	m_FixedTransformedPointsLocator
MovingPointSetType::ConstPointer	m_MovingPointSet
MovingTransformedPointSetType::Pointer	m_MovingTransformedPointSet
PointsLocatorType::Pointer	m_MovingTransformedPointsLocator
VirtualPointSetPointer	m_VirtualTransformedPointSet
Protected Attributes inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension >
FixedTransformPointer	m_FixedTransform
MovingTransformPointer	m_MovingTransform
SizeValueType	m_NumberOfValidPoints
bool	m_UserHasSetVirtualDomain
VirtualImagePointer	m_VirtualImage
Protected Attributes inherited from itk::ObjectToObjectMetricBase
GradientSourceType	m_GradientSource
MeasureType	m_Value

Private Member Functions
void	operator= (const Self &)
	PointSetToPointSetMetricv4 (const Self &)

Private Attributes
unsigned long	m_FixedTransformedPointSetTime
bool	m_FixedTransformPointLocatorsNeedInitialization
bool	m_HaveWarnedAboutNumberOfValidPoints
unsigned long	m_MovingTransformedPointSetTime
bool	m_MovingTransformPointLocatorsNeedInitialization

Detailed Description

template<class TFixedPointSet, class TMovingPointSet>
class itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet >

Computes similarity between two point sets.

This class is templated over the type of the two point-sets. It expects a Transform to be plugged in for each of fixed and moving point sets. The transforms default to IdenityTransform types. This particular class is the base class for a hierarchy of point-set to point-set metrics.

This class computes a value that measures the similarity between the fixed point-set and the moving point-set in the moving domain. The fixed point set is transformed into the virtual domain by computing the inverse of the fixed transform, then transformed into the moving domain using the moving transform.

If a virtual domain is not defined by the user, one of two things happens: 1) If the moving transform is a global type, then the virtual domain is left undefined and every point is considered to be within the virtual domain. 2) If the moving transform is a local-support type, then the virtual domain is taken during initialization from the moving transform displacement field, and all fixed points are verified to be within the virtual domain after transformation by the inverse fixed transform. Points outside the virtual domain are not used. See GetNumberOfValidPoints() to verify how many fixed points were used during evaluation.

See ObjectToObjectMetric documentation for more discussion on the virutal domain.

Note:: When used with an RegistrationParameterScalesEstimator estimator, a VirtualDomainPointSet must be defined and assigned to the estimator, for use in shift estimation. The virtual domain point set can be retrieved from the metric using the GetVirtualTransformedPointSet() method.

Definition at line 64 of file itkPointSetToPointSetMetricv4.h.