ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | List of all members
itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType > Class Template Referenceabstract

#include <itkPointSetToPointSetMetricv4.h>

Detailed Description

template<typename TFixedPointSet, typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
class itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >

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

Since the PointSet class permits each Point to be associated with a PixelType, there are potential applications which could make use of this additional information. For example, the derived LabeledPointSetToPointSetMetric class uses the PixelType as a LabelEnum for estimating total metric values and gradients from the individual label-wise point subset metric and derivatives

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 virtual 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 68 of file itkPointSetToPointSetMetricv4.h.

+ Inheritance diagram for itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >:
+ Collaboration diagram for itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using CoordRepType = typename PointType::CoordRepType
 
using DisplacementFieldTransformType = typename Superclass::MovingDisplacementFieldTransformType
 
using FixedPixelType = typename TFixedPointSet::PixelType
 
using FixedPointsContainer = typename TFixedPointSet::PointsContainer
 
using FixedPointSetType = TFixedPointSet
 
using FixedPointType = typename TFixedPointSet::PointType
 
using MovingPixelType = typename TMovingPointSet::PixelType
 
using MovingPointsContainer = typename TMovingPointSet::PointsContainer
 
using MovingPointSetType = TMovingPointSet
 
using MovingPointType = typename TMovingPointSet::PointType
 
using NeighborsIdentifierType = typename PointsLocatorType::NeighborsIdentifierType
 
using Pointer = SmartPointer< Self >
 
using PointsConstIterator = typename PointsContainer::ConstIterator
 
using PointsContainer = FixedPointsContainer
 
using Self = PointSetToPointSetMetricv4
 
using Superclass = PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >
 
using VirtualImageType = typename Superclass::VirtualImageType
 
using VirtualOriginType = typename Superclass::VirtualPointType
 
using VirtualRadiusType = typename Superclass::VirtualSizeType
 
- Public Types inherited from itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >
using ConstPointer = SmartPointer< const Self >
 
using CoordRepType = typename PointType::CoordRepType
 
using DerivativeValueType = typename DerivativeType::ValueType
 
using DisplacementFieldTransformType = typename Superclass::MovingDisplacementFieldTransformType
 
using FixedPixelType = typename TFixedPointSet::PixelType
 
using FixedPointsContainer = typename TFixedPointSet::PointsContainer
 
using FixedPointSetType = TFixedPointSet
 
using FixedPointType = typename TFixedPointSet::PointType
 
using FixedTransformedPointSetType = PointSet< FixedPixelType, Self::PointDimension >
 
using LocalDerivativeType = FixedArray< DerivativeValueType, Self::PointDimension >
 
using MovingPixelType = typename TMovingPointSet::PixelType
 
using MovingPointsContainer = typename TMovingPointSet::PointsContainer
 
using MovingPointSetType = TFixedPointSet
 
using MovingPointType = typename TMovingPointSet::PointType
 
using MovingTransformedPointSetType = PointSet< MovingPixelType, Self::PointDimension >
 
using NeighborsIdentifierType = typename PointsLocatorType::NeighborsIdentifierType
 
using ObjectType = typename Superclass::ObjectType
 
using PixelType = FixedPixelType
 
using Pointer = SmartPointer< Self >
 
using PointIdentifier = typename PointsContainer::ElementIdentifier
 
using PointsConstIterator = typename PointsContainer::ConstIterator
 
using PointsContainer = FixedPointsContainer
 
using PointsLocatorType = PointsLocator< PointsContainer >
 
using PointType = FixedPointType
 
using Self = PointSetToPointSetMetricWithIndexv4
 
using Superclass = ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< double, TFixedPointSet::PointDimension >, double >
 
using VirtualImageType = typename Superclass::VirtualImageType
 
using VirtualOriginType = typename Superclass::VirtualPointType
 
using VirtualRadiusType = typename Superclass::VirtualSizeType
 
- Public Types inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< double, TFixedPointSet::PointDimension >, double >
using ConstPointer = SmartPointer< const Self >
 
using CoordinateRepresentationType = double
 
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< double, TVirtualImage::ImageDimension, TFixedDimension >
 
using InternalComputationValueType = double
 
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< double, TVirtualImage::ImageDimension, TMovingDimension >
 
using ObjectType = typename Superclass::Object
 
using Pointer = SmartPointer< Self >
 
using Self = ObjectToObjectMetric
 
using Superclass = ObjectToObjectMetricBaseTemplate< double >
 
using VirtualDirectionType = typename VirtualImageType::DirectionType
 
using VirtualImageConstPointer = typename VirtualImageType::ConstPointer
 
using VirtualImagePointer = typename VirtualImageType::Pointer
 
using VirtualImageType = Image< double, TFixedPointSet::PointDimension >
 
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

virtual LocalDerivativeType GetLocalNeighborhoodDerivative (const PointType &, const PixelType &pixel) const
 
virtual MeasureType GetLocalNeighborhoodValue (const PointType &, const PixelType &pixel) const =0
 
virtual void GetLocalNeighborhoodValueAndDerivative (const PointType &, MeasureType &, LocalDerivativeType &, const PixelType &pixel) const =0
 
const char * GetNameOfClass () const override
 
- Public Member Functions inherited from itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >
void GetDerivative (DerivativeType &) const override
 
virtual FixedTransformedPointSetTypeGetModifiableFixedTransformedPointSet ()
 
virtual MovingTransformedPointSetTypeGetModifiableMovingTransformedPointSet ()
 
const char * GetNameOfClass () const override
 
SizeValueType GetNumberOfComponents () const
 
MeasureType GetValue () const override
 
void GetValueAndDerivative (MeasureType &, DerivativeType &) const override
 
const VirtualPointSetTypeGetVirtualTransformedPointSet () const
 
void Initialize () override
 
bool SupportsArbitraryVirtualDomainSamples () const override
 
void SetFixedObject (const ObjectType *object) override
 
void SetMovingObject (const ObjectType *object) override
 
virtual void SetFixedPointSet (const FixedPointSetType *_arg)
 
virtual const FixedPointSetTypeGetFixedPointSet () const
 
virtual void SetMovingPointSet (const MovingPointSetType *_arg)
 
virtual const MovingPointSetTypeGetMovingPointSet () const
 
virtual void SetStoreDerivativeAsSparseFieldForLocalSupportTransforms (bool _arg)
 
virtual bool GetStoreDerivativeAsSparseFieldForLocalSupportTransforms () const
 
virtual void StoreDerivativeAsSparseFieldForLocalSupportTransformsOn ()
 
virtual void SetCalculateValueAndDerivativeInTangentSpace (bool _arg)
 
virtual bool GetCalculateValueAndDerivativeInTangentSpace () const
 
virtual void CalculateValueAndDerivativeInTangentSpaceOn ()
 
- Public Member Functions inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< double, TFixedPointSet::PointDimension >, double >
OffsetValueType ComputeParameterOffsetFromVirtualIndex (const VirtualIndexType &index, const NumberOfParametersType &numberOfLocalParameters) const
 
OffsetValueType ComputeParameterOffsetFromVirtualPoint (const VirtualPointType &point, const NumberOfParametersType &numberOfLocalParameters) const
 
MetricCategoryType GetMetricCategory () const override
 
virtual FixedTransformTypeGetModifiableFixedTransform ()
 
virtual MovingTransformTypeGetModifiableMovingTransform ()
 
virtual VirtualImageTypeGetModifiableVirtualImage ()
 
const char * GetNameOfClass () const override
 
NumberOfParametersType GetNumberOfLocalParameters () const override
 
NumberOfParametersType GetNumberOfParameters () const override
 
virtual SizeValueType GetNumberOfValidPoints () const
 
const ParametersTypeGetParameters () const override
 
const MovingTransformTypeGetTransform ()
 
VirtualDirectionType GetVirtualDirection () const
 
virtual const TimeStampGetVirtualDomainTimeStamp () const
 
VirtualOriginType GetVirtualOrigin () const
 
const VirtualRegionTypeGetVirtualRegion () 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, double 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 ParametersTypeGetParameters () 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 ObjectTypeGetFixedObject () const
 
virtual void SetMovingObject (const ObjectType *_arg)
 
virtual const ObjectTypeGetMovingObject () const
 
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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStampGetTimeStamp () 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 FixedPointDimension = Superclass::FixedPointDimension
 
static constexpr DimensionType MovingPointDimension = Superclass::MovingPointDimension
 
static constexpr DimensionType PointDimension = Superclass::PointDimension
 
- Static Public Attributes inherited from itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >
static constexpr DimensionType FixedPointDimension
 
static constexpr DimensionType MovingPointDimension
 
static constexpr DimensionType PointDimension
 
- Static Public Attributes inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< double, TFixedPointSet::PointDimension >, double >
static constexpr DimensionType FixedDimension
 
static constexpr DimensionType MovingDimension
 
static constexpr DimensionType VirtualDimension
 

Protected Member Functions

 PointSetToPointSetMetricv4 ()=default
 
 ~PointSetToPointSetMetricv4 () override=default
 
- Protected Member Functions inherited from itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >
virtual SizeValueType CalculateNumberOfValidFixedPoints () const
 
void CalculateValueAndDerivative (MeasureType &calculatedValue, DerivativeType &derivative, bool calculateValue) const
 
virtual LocalDerivativeType GetLocalNeighborhoodDerivativeWithIndex (const PointIdentifier &, const PointType &, const PixelType &pixel) const
 
virtual void GetLocalNeighborhoodValueAndDerivativeWithIndex (const PointIdentifier &, const PointType &, MeasureType &, LocalDerivativeType &, const PixelType &pixel) const=0
 
virtual MeasureType GetLocalNeighborhoodValueWithIndex (const PointIdentifier &, const PointType &, const PixelType &pixel) const=0
 
MetricCategoryType GetMetricCategory () const override
 
virtual void InitializeForIteration () const
 
virtual void InitializePointSets () const
 
void InitializePointsLocators () const
 
 PointSetToPointSetMetricWithIndexv4 ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual bool RequiresFixedPointsLocator () const
 
virtual bool RequiresMovingPointsLocator () const
 
void StorePointDerivative (const VirtualPointType &, const DerivativeType &, DerivativeType &) const
 
void TransformFixedAndCreateVirtualPointSet () const
 
void TransformMovingPointSet () const
 
 ~PointSetToPointSetMetricWithIndexv4 () override=default
 
- Protected Member Functions inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< double, TFixedPointSet::PointDimension >, double >
const MovingDisplacementFieldTransformTypeGetMovingDisplacementFieldTransform () 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 ()
 

Private Member Functions

LocalDerivativeType GetLocalNeighborhoodDerivativeWithIndex (const PointIdentifier &, const PointType &point, const PixelType &pixel) const override
 
void GetLocalNeighborhoodValueAndDerivativeWithIndex (const PointIdentifier &, const PointType &point, MeasureType &measure, LocalDerivativeType &derivative, const PixelType &pixel) const override
 
MeasureType GetLocalNeighborhoodValueWithIndex (const PointIdentifier &, const PointType &point, const PixelType &pixel) const override
 

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 ()
 
- Protected Attributes inherited from itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >
bool m_CalculateValueAndDerivativeInTangentSpace
 
FixedPointSetType::ConstPointer m_FixedPointSet
 
FixedTransformedPointSetType::Pointer m_FixedTransformedPointSet
 
PointsLocatorType::Pointer m_FixedTransformedPointsLocator
 
MovingPointSetType::ConstPointer m_MovingPointSet
 
MovingTransformedPointSetType::Pointer m_MovingTransformedPointSet
 
PointsLocatorType::Pointer m_MovingTransformedPointsLocator
 
bool m_UsePointSetData
 
VirtualPointSetPointer m_VirtualTransformedPointSet
 
- Protected Attributes inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< double, TFixedPointSet::PointDimension >, double >
FixedTransformPointer m_FixedTransform
 
MovingTransformPointer m_MovingTransform
 
SizeValueType m_NumberOfValidPoints
 
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 {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::ConstPointer = SmartPointer<const Self>

Definition at line 79 of file itkPointSetToPointSetMetricv4.h.

◆ CoordRepType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::CoordRepType = typename PointType::CoordRepType

Definition at line 143 of file itkPointSetToPointSetMetricv4.h.

◆ DisplacementFieldTransformType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::DisplacementFieldTransformType = typename Superclass::MovingDisplacementFieldTransformType

Definition at line 112 of file itkPointSetToPointSetMetricv4.h.

◆ FixedPixelType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::FixedPixelType = typename TFixedPointSet::PixelType

Definition at line 120 of file itkPointSetToPointSetMetricv4.h.

◆ FixedPointsContainer

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::FixedPointsContainer = typename TFixedPointSet::PointsContainer

Definition at line 121 of file itkPointSetToPointSetMetricv4.h.

◆ FixedPointSetType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::FixedPointSetType = TFixedPointSet

Type of the fixed point set.

Definition at line 118 of file itkPointSetToPointSetMetricv4.h.

◆ FixedPointType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::FixedPointType = typename TFixedPointSet::PointType

Definition at line 119 of file itkPointSetToPointSetMetricv4.h.

◆ MovingPixelType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::MovingPixelType = typename TMovingPointSet::PixelType

Definition at line 128 of file itkPointSetToPointSetMetricv4.h.

◆ MovingPointsContainer

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::MovingPointsContainer = typename TMovingPointSet::PointsContainer

Definition at line 129 of file itkPointSetToPointSetMetricv4.h.

◆ MovingPointSetType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::MovingPointSetType = TMovingPointSet

Type of the moving point set.

Definition at line 126 of file itkPointSetToPointSetMetricv4.h.

◆ MovingPointType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::MovingPointType = typename TMovingPointSet::PointType

Definition at line 127 of file itkPointSetToPointSetMetricv4.h.

◆ NeighborsIdentifierType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::NeighborsIdentifierType = typename PointsLocatorType::NeighborsIdentifierType

Definition at line 150 of file itkPointSetToPointSetMetricv4.h.

◆ Pointer

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::Pointer = SmartPointer<Self>

Definition at line 78 of file itkPointSetToPointSetMetricv4.h.

◆ PointsConstIterator

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::PointsConstIterator = typename PointsContainer::ConstIterator

Definition at line 145 of file itkPointSetToPointSetMetricv4.h.

◆ PointsContainer

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::PointsContainer = FixedPointsContainer

Definition at line 144 of file itkPointSetToPointSetMetricv4.h.

◆ Self

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::Self = PointSetToPointSetMetricv4

Standard class type aliases.

Definition at line 75 of file itkPointSetToPointSetMetricv4.h.

◆ Superclass

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::Superclass = PointSetToPointSetMetricWithIndexv4<TFixedPointSet, TMovingPointSet, TInternalComputationValueType>

Definition at line 76 of file itkPointSetToPointSetMetricv4.h.

◆ VirtualImageType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::VirtualImageType = typename Superclass::VirtualImageType

Types for the virtual domain

Definition at line 159 of file itkPointSetToPointSetMetricv4.h.

◆ VirtualOriginType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::VirtualOriginType = typename Superclass::VirtualPointType

Definition at line 165 of file itkPointSetToPointSetMetricv4.h.

◆ VirtualRadiusType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::VirtualRadiusType = typename Superclass::VirtualSizeType

Definition at line 168 of file itkPointSetToPointSetMetricv4.h.

Constructor & Destructor Documentation

◆ PointSetToPointSetMetricv4()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::PointSetToPointSetMetricv4 ( )
protecteddefault

◆ ~PointSetToPointSetMetricv4()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::~PointSetToPointSetMetricv4 ( )
overrideprotecteddefault

Member Function Documentation

◆ GetLocalNeighborhoodDerivative()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
virtual LocalDerivativeType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetLocalNeighborhoodDerivative ( const PointType ,
const PixelType pixel 
) const
virtual

Calculates the local derivative for a single point. The default implementation calls GetLocalNeighborhoodValueAndDerivative. The PixelType may or may not be used. See class description for further explanation. Default implementation calls GetLocalNeighborhoodValueAndDerivative.

◆ GetLocalNeighborhoodDerivativeWithIndex()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
LocalDerivativeType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetLocalNeighborhoodDerivativeWithIndex ( const PointIdentifier ,
const PointType ,
const PixelType pixel 
) const
inlineoverrideprivatevirtual

Function to be defined in the appropriate derived classes. Calculates the local metric value for a single point. The PixelType may or may not be used. See class description for further explanation. Default implementation calls GetLocalNeighborhoodValueAndDerivative.

Reimplemented from itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >.

Definition at line 216 of file itkPointSetToPointSetMetricv4.h.

References itk::point().

◆ GetLocalNeighborhoodValue()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
virtual MeasureType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetLocalNeighborhoodValue ( const PointType ,
const PixelType pixel 
) const
pure virtual

◆ GetLocalNeighborhoodValueAndDerivative()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetLocalNeighborhoodValueAndDerivative ( const PointType ,
MeasureType ,
LocalDerivativeType ,
const PixelType pixel 
) const
pure virtual

◆ GetLocalNeighborhoodValueAndDerivativeWithIndex()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetLocalNeighborhoodValueAndDerivativeWithIndex ( const PointIdentifier ,
const PointType ,
MeasureType ,
LocalDerivativeType ,
const PixelType pixel 
) const
inlineoverrideprivatevirtual

Function to be defined in the appropriate derived classes. Calculates the local metric value for a single point. The PixelType may or may not be used. See class description for further explanation.

Implements itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >.

Definition at line 224 of file itkPointSetToPointSetMetricv4.h.

References itk::point().

◆ GetLocalNeighborhoodValueWithIndex()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
MeasureType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetLocalNeighborhoodValueWithIndex ( const PointIdentifier ,
const PointType ,
const PixelType pixel 
) const
inlineoverrideprivatevirtual

Function to be defined in the appropriate derived classes. Calculates the local metric value for a single point. The PixelType may or may not be used. See class description for further explanation.

Implements itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TFixedPointSet, double >.

Definition at line 208 of file itkPointSetToPointSetMetricv4.h.

References itk::point().

◆ GetNameOfClass()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
const char * itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

Member Data Documentation

◆ FixedPointDimension

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
constexpr DimensionType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::FixedPointDimension = Superclass::FixedPointDimension
staticconstexpr

Definition at line 123 of file itkPointSetToPointSetMetricv4.h.

◆ MovingPointDimension

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
constexpr DimensionType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::MovingPointDimension = Superclass::MovingPointDimension
staticconstexpr

Definition at line 131 of file itkPointSetToPointSetMetricv4.h.

◆ PointDimension

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
constexpr DimensionType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::PointDimension = Superclass::PointDimension
staticconstexpr

typedefs for the data types used in the point set metric calculations. It is assumed that the constants of the fixed point set, such as the point dimension, are the same for the "common space" in which the metric calculation occurs.

Definition at line 139 of file itkPointSetToPointSetMetricv4.h.


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