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

#include <itkPointSetToPointSetMetricv4.h>

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

Detailed Description

template<typename TFixedPointSet, typename TMovingPointSet, 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 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.

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 LabelType 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 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 71 of file itkPointSetToPointSetMetricv4.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef PointType::CoordRepType CoordRepType
 
typedef Superclass::DerivativeType DerivativeType
 
typedef DerivativeType::ValueType DerivativeValueType
 
typedef Superclass::DimensionType DimensionType
 
typedef
Superclass::MovingDisplacementFieldTransformType 
DisplacementFieldTransformType
 
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::ObjectType ObjectType
 
typedef Superclass::ParametersType ParametersType
 
typedef
Superclass::ParametersValueType 
ParametersValueType
 
typedef FixedPixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef
PointsContainer::ElementIdentifier 
PointIdentifier
 
typedef
PointsContainer::ConstIterator 
PointsConstIterator
 
typedef FixedPointsContainer PointsContainer
 
typedef PointsLocator
< PointsContainer
PointsLocatorType
 
typedef FixedPointType PointType
 
typedef PointSetToPointSetMetricv4 Self
 
typedef ObjectToObjectMetric
< TFixedPointSet::PointDimension,
TMovingPointSet::PointDimension,
Image
< TInternalComputationValueType,
TFixedPointSet::PointDimension >
, TInternalComputationValueType > 
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, Image< TInternalComputationValueType, TFixedPointSet::PointDimension >, TInternalComputationValueType >
typedef SmartPointer< const SelfConstPointer
 
typedef
TInternalComputationValueType 
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
< TInternalComputationValueType,
Image
< TInternalComputationValueType,
TFixedPointSet::PointDimension >
::ImageDimension,
TFixedDimension > 
FixedTransformType
 
typedef
Superclass::GradientSourceType 
GradientSourceType
 
typedef
TInternalComputationValueType 
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
< TInternalComputationValueType,
Image
< TInternalComputationValueType,
TFixedPointSet::PointDimension >
::ImageDimension,
TMovingDimension > 
MovingTransformType
 
typedef
Superclass::NumberOfParametersType 
NumberOfParametersType
 
typedef Superclass::Object ObjectType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef ObjectToObjectMetric Self
 
typedef
ObjectToObjectMetricBaseTemplate
< TInternalComputationValueType > 
Superclass
 
typedef
VirtualImageType::DirectionType 
VirtualDirectionType
 
typedef
VirtualImageType::ConstPointer 
VirtualImageConstPointer
 
typedef VirtualImageType::Pointer VirtualImagePointer
 
typedef Image
< TInternalComputationValueType,
TFixedPointSet::PointDimension > 
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< TInternalComputationValueType >
typedef SmartPointer< const SelfConstPointer
 
typedef
TInternalComputationValueType 
CoordinateRepresentationType
 
typedef Superclass::DerivativeType DerivativeType
 
typedef DerivativeType::ValueType DerivativeValueType
 
enum  GradientSourceType {
  GRADIENT_SOURCE_FIXED =0,
  GRADIENT_SOURCE_MOVING,
  GRADIENT_SOURCE_BOTH
}
 
typedef Superclass::MeasureType MeasureType
 
enum  MetricCategoryType {
  UNKNOWN_METRIC = 0,
  OBJECT_METRIC = 1,
  IMAGE_METRIC = 2,
  POINT_SET_METRIC = 3,
  MULTI_METRIC = 4
}
 
typedef unsigned int NumberOfParametersType
 
typedef ObjectType::ConstPointer ObjectConstPointer
 
typedef Object ObjectType
 
typedef Superclass::ParametersType ParametersType
 
typedef
TInternalComputationValueType 
ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef
ObjectToObjectMetricBaseTemplate 
Self
 
typedef
SingleValuedCostFunctionv4Template
< TInternalComputationValueType > 
Superclass
 
- Public Types inherited from itk::SingleValuedCostFunctionv4Template< TInternalComputationValueType >
typedef SmartPointer< const SelfConstPointer
 
typedef Array
< TInternalComputationValueType > 
DerivativeType
 
typedef
TInternalComputationValueType 
MeasureType
 
typedef Superclass::ParametersType ParametersType
 
typedef SmartPointer< SelfPointer
 
typedef
SingleValuedCostFunctionv4Template 
Self
 
typedef CostFunctionTemplate
< TInternalComputationValueType > 
Superclass
 
- Public Types inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
typedef SmartPointer< const SelfConstPointer
 
typedef OptimizerParameters
< TInternalComputationValueType > 
ParametersType
 
typedef
TInternalComputationValueType 
ParametersValueType
 
typedef SmartPointer< SelfPointer
 
typedef CostFunctionTemplate Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual void GetDerivative (DerivativeType &) const override
 
virtual const
FixedTransformedPointSetType
GetFixedTransformedPointSet () const
 
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
 
virtual
FixedTransformedPointSetType
GetModifiableFixedTransformedPointSet ()
 
virtual
MovingTransformedPointSetType
GetModifiableMovingTransformedPointSet ()
 
virtual const
MovingTransformedPointSetType
GetMovingTransformedPointSet () const
 
virtual const char * GetNameOfClass () const
 
SizeValueType GetNumberOfComponents () const
 
virtual MeasureType GetValue () const override
 
virtual void GetValueAndDerivative (MeasureType &, DerivativeType &) const override
 
const VirtualPointSetTypeGetVirtualTransformedPointSet () const
 
virtual void Initialize (void) override
 
virtual bool SupportsArbitraryVirtualDomainSamples (void) const override
 
virtual void SetFixedObject (const ObjectType *object) override
 
virtual 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 StoreDerivativeAsSparseFieldForLocalSupportTransformsOff ()
 
virtual void SetCalculateValueAndDerivativeInTangentSpace (bool _arg)
 
virtual bool GetCalculateValueAndDerivativeInTangentSpace () const
 
virtual void CalculateValueAndDerivativeInTangentSpaceOn ()
 
virtual void CalculateValueAndDerivativeInTangentSpaceOff ()
 
- Public Member Functions inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< TInternalComputationValueType, TFixedPointSet::PointDimension >, TInternalComputationValueType >
OffsetValueType ComputeParameterOffsetFromVirtualIndex (const VirtualIndexType &index, const NumberOfParametersType &numberOfLocalParameters) const
 
OffsetValueType ComputeParameterOffsetFromVirtualPoint (const VirtualPointType &point, const NumberOfParametersType &numberOfLocalParameters) const
 
virtual const FixedTransformTypeGetFixedTransform () const
 
virtual FixedTransformTypeGetModifiableFixedTransform ()
 
virtual MovingTransformTypeGetModifiableMovingTransform ()
 
virtual VirtualImageTypeGetModifiableVirtualImage ()
 
virtual const MovingTransformTypeGetMovingTransform () const
 
virtual NumberOfParametersType GetNumberOfLocalParameters () const override
 
virtual NumberOfParametersType GetNumberOfParameters () const override
 
virtual SizeValueType GetNumberOfValidPoints () const
 
virtual const ParametersTypeGetParameters () const override
 
const MovingTransformTypeGetTransform ()
 
VirtualDirectionType GetVirtualDirection () const
 
virtual const TimeStampGetVirtualDomainTimeStamp () const
 
virtual const VirtualImageTypeGetVirtualImage () const
 
VirtualOriginType GetVirtualOrigin () const
 
const VirtualRegionTypeGetVirtualRegion () const
 
VirtualSpacingType GetVirtualSpacing () const
 
virtual bool HasLocalSupport () const 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 void UpdateTransformParameters (const DerivativeType &derivative, TInternalComputationValueTypefactor) override
 
bool IsInsideVirtualDomain (const VirtualPointType &point) const
 
bool IsInsideVirtualDomain (const VirtualIndexType &index) const
 
- Public Member Functions inherited from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >
MeasureType GetCurrentValue () const
 
virtual GradientSourceType GetGradientSource () const
 
bool GetGradientSourceIncludesFixed () const
 
bool GetGradientSourceIncludesMoving () const
 
virtual void GetValueAndDerivative (MeasureType &value, DerivativeType &derivative) const override=0
 
virtual void SetGradientSource (GradientSourceType _arg)
 
virtual const ObjectTypeGetFixedObject () const
 
virtual const ObjectTypeGetMovingObject () const
 
- Public Member Functions inherited from itk::SingleValuedCostFunctionv4Template< TInternalComputationValueType >
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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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 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, Image< TInternalComputationValueType, TFixedPointSet::PointDimension >, TInternalComputationValueType >
static const DimensionType FixedDimension
 
static const DimensionType MovingDimension
 
static const DimensionType VirtualDimension
 

Protected Types

typedef
Superclass::MetricCategoryType 
MetricCategoryType
 

Protected Member Functions

virtual SizeValueType CalculateNumberOfValidFixedPoints () const
 
void CalculateValueAndDerivative (MeasureType &value, DerivativeType &derivative, bool calculateValue) const
 
virtual MetricCategoryType GetMetricCategory () const override
 
virtual void InitializeForIteration () const
 
virtual void InitializePointSets () const
 
void InitializePointsLocators () const
 
 PointSetToPointSetMetricv4 ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void StorePointDerivative (const VirtualPointType &, const DerivativeType &, DerivativeType &) const
 
void TransformFixedAndCreateVirtualPointSet () const
 
void TransformMovingPointSet () const
 
virtual ~PointSetToPointSetMetricv4 () override
 
- Protected Member Functions inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< TInternalComputationValueType, TFixedPointSet::PointDimension >, TInternalComputationValueType >
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< TInternalComputationValueType >
 ObjectToObjectMetricBaseTemplate ()
 
virtual ~ObjectToObjectMetricBaseTemplate () override
 
- Protected Member Functions inherited from itk::SingleValuedCostFunctionv4Template< TInternalComputationValueType >
 SingleValuedCostFunctionv4Template ()
 
virtual ~SingleValuedCostFunctionv4Template () override
 
- Protected Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
 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

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< TInternalComputationValueType, TFixedPointSet::PointDimension >, TInternalComputationValueType >
FixedTransformPointer m_FixedTransform
 
MovingTransformPointer m_MovingTransform
 
SizeValueType m_NumberOfValidPoints
 
bool m_UserHasSetVirtualDomain
 
VirtualImagePointer m_VirtualImage
 
- Protected Attributes inherited from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >
ObjectConstPointer m_FixedObject
 
GradientSourceType m_GradientSource
 
ObjectConstPointer m_MovingObject
 
MeasureType m_Value
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Attributes

ModifiedTimeType m_FixedTransformedPointSetTime
 
bool m_FixedTransformPointLocatorsNeedInitialization
 
bool m_HaveWarnedAboutNumberOfValidPoints
 
ModifiedTimeType m_MovingTransformedPointSetTime
 
bool m_MovingTransformPointLocatorsNeedInitialization
 
bool m_StoreDerivativeAsSparseFieldForLocalSupportTransforms
 

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<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
typedef SmartPointer<const Self> itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::ConstPointer

Definition at line 84 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 150 of file itkPointSetToPointSetMetricv4.h.

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

Type of the derivative.

Definition at line 98 of file itkPointSetToPointSetMetricv4.h.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
typedef DerivativeType::ValueType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::DerivativeValueType

Definition at line 162 of file itkPointSetToPointSetMetricv4.h.

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

Dimension type

Definition at line 122 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 117 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 103 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 104 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 127 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 128 of file itkPointSetToPointSetMetricv4.h.

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

Type of the fixed point set.

Definition at line 125 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 126 of file itkPointSetToPointSetMetricv4.h.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
typedef PointSet<FixedPixelType, itkGetStaticConstMacro( PointDimension )> itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::FixedTransformedPointSetType

Definition at line 159 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 114 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 105 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 102 of file itkPointSetToPointSetMetricv4.h.

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

Transform types from Superclass

Definition at line 101 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 113 of file itkPointSetToPointSetMetricv4.h.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
typedef FixedArray<DerivativeValueType, itkGetStaticConstMacro( PointDimension )> itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::LocalDerivativeType

Definition at line 163 of file itkPointSetToPointSetMetricv4.h.

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

Type of the measure.

Definition at line 87 of file itkPointSetToPointSetMetricv4.h.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
typedef Superclass::MetricCategoryType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::MetricCategoryType
protected

Definition at line 412 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 109 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 110 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 135 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 136 of file itkPointSetToPointSetMetricv4.h.

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

Type of the moving point set.

Definition at line 133 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 134 of file itkPointSetToPointSetMetricv4.h.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
typedef PointSet<MovingPixelType, itkGetStaticConstMacro( PointDimension )> itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::MovingTransformedPointSetType

Definition at line 160 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 115 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 111 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 108 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 107 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 157 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 95 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 119 of file itkPointSetToPointSetMetricv4.h.

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

Type of the parameters.

Definition at line 93 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 94 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 149 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 83 of file itkPointSetToPointSetMetricv4.h.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
typedef PointsContainer::ElementIdentifier itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::PointIdentifier

Definition at line 153 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 152 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 151 of file itkPointSetToPointSetMetricv4.h.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
typedef PointsLocator< PointsContainer> itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::PointsLocatorType

Typedef for points locator class to speed up finding neighboring points

Definition at line 156 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 148 of file itkPointSetToPointSetMetricv4.h.

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

Standard class typedefs.

Definition at line 78 of file itkPointSetToPointSetMetricv4.h.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
typedef ObjectToObjectMetric<TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image<TInternalComputationValueType, TFixedPointSet::PointDimension>, TInternalComputationValueType> itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::Superclass

Definition at line 82 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 174 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 167 of file itkPointSetToPointSetMetricv4.h.

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

Types for the virtual domain

Definition at line 166 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 176 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 172 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 168 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 178 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 177 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 173 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 175 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 169 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 170 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 171 of file itkPointSetToPointSetMetricv4.h.

Constructor & Destructor Documentation

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

Member Function Documentation

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual SizeValueType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::CalculateNumberOfValidFixedPoints ( ) const
protectedvirtual

Determine the number of valid fixed points. A fixed point is valid if, when transformed into the virtual domain using the inverse of the FixedTransform, it is within the defined virtual domain bounds.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::CalculateValueAndDerivative ( MeasureType value,
DerivativeType derivative,
bool  calculateValue 
) const
protected

Helper method allows for code reuse while skipping the metric value calculation when appropriate

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::CalculateValueAndDerivativeInTangentSpaceOff ( )
virtual
template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::CalculateValueAndDerivativeInTangentSpaceOn ( )
virtual
template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual bool itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetCalculateValueAndDerivativeInTangentSpace ( ) const
virtual
template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetDerivative ( DerivativeType ) const
overridevirtual

This method returns the derivative based on the current transformation(s). This function can be redefined in derived classes but many point set metrics follow the same structure—one iterates through the points and, for each point a derivative is calculated. The set of all these local derivatives constitutes the total derivative. Note that this might not be applicable to all point set metrics. For those cases, the developer will have to redefine the GetDerivative() function.

Implements itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual const FixedPointSetType* itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetFixedPointSet ( ) const
virtual

Get/Set the fixed pointset.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual const FixedTransformedPointSetType* itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetFixedTransformedPointSet ( ) const
virtual
template<typename TFixedPointSet, typename TMovingPointSet, 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 PixelType may or may not be used. See class description for further explanation.

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

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.

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

Calculates the local value/derivative for a single point. The PixelType may or may not be used. See class description for further explanation.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual MetricCategoryType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetMetricCategory ( ) const
inlineoverrideprotectedvirtual
template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual FixedTransformedPointSetType* itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetModifiableFixedTransformedPointSet ( )
virtual

Get the fixed transformed point set.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual MovingTransformedPointSetType* itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetModifiableMovingTransformedPointSet ( )
virtual

Get the moving transformed point set.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual const MovingPointSetType* itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetMovingPointSet ( ) const
virtual

Get/Set the moving point set.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual const MovingTransformedPointSetType* itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetMovingTransformedPointSet ( ) const
virtual
template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual const char* itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetNameOfClass ( ) const
virtual
template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
SizeValueType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetNumberOfComponents ( ) const

For now return the number of points used in the value/derivative calculations.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual bool itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetStoreDerivativeAsSparseFieldForLocalSupportTransforms ( ) const
virtual

By default, the point set metric derivative for a displacement field transform is stored by saving the gradient for every voxel in the displacement field (see the function StorePointDerivative()). Since the "fixed points" will typically constitute a sparse set, this means that the field will have zero gradient values at every voxel that doesn't have a corresponding point. This might cause additional computation time for certain transforms (e.g. B-spline SyN). To avoid this, this option permits storing the point derivative only at the fixed point locations. If this variable is set to false, then the derivative array will be of length = PointDimension * m_FixedPointSet->GetNumberOfPoints().

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual MeasureType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetValue ( ) const
overridevirtual

This method returns the value of the metric based on the current transformation(s). This function can be redefined in derived classes but many point set metrics follow the same structure—one iterates through the points and, for each point a metric value is calculated. The summation of these individual point metric values gives the total value of the metric. Note that this might not be applicable to all point set metrics. For those cases, the developer will have to redefine the GetValue() function.

Implements itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetValueAndDerivative ( MeasureType ,
DerivativeType  
) const
overridevirtual

This method returns the derivative and value based on the current transformation(s). This function can be redefined in derived classes but many point set metrics follow the same structure—one iterates through the points and, for each point a derivative and value is calculated. The set of all these local derivatives/values constitutes the total derivative and value. Note that this might not be applicable to all point set metrics. For those cases, the developer will have to redefine the GetValue() and GetDerivative() functions.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
const VirtualPointSetType* itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetVirtualTransformedPointSet ( ) const

Get the virtual point set, derived from the fixed point set. If the virtual point set has not yet been derived, it will be in this call.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::Initialize ( void  )
overridevirtual
template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::InitializeForIteration ( ) const
protectedvirtual

Initialize to prepare for a particular iteration, generally an iteration of optimization. Distinct from Initialize() which is a one-time initialization.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::InitializePointSets ( ) const
protectedvirtual

Prepare point sets for use.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::InitializePointsLocators ( ) const
protected

Build point locators for the fixed and moving point sets to speed up derivative and value calculations.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::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::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::SetCalculateValueAndDerivativeInTangentSpace ( bool  _arg)
virtual
template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::SetFixedObject ( const ObjectType object)
inlineoverridevirtual

Set fixed point set

Reimplemented from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >.

Definition at line 181 of file itkPointSetToPointSetMetricv4.h.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::SetFixedPointSet ( const FixedPointSetType _arg)
virtual

Get/Set the fixed pointset.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::SetMovingObject ( const ObjectType object)
inlineoverridevirtual

Set moving point set

Reimplemented from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >.

Definition at line 196 of file itkPointSetToPointSetMetricv4.h.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::SetMovingPointSet ( const MovingPointSetType _arg)
virtual

Get/Set the moving point set.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::SetStoreDerivativeAsSparseFieldForLocalSupportTransforms ( bool  _arg)
virtual

By default, the point set metric derivative for a displacement field transform is stored by saving the gradient for every voxel in the displacement field (see the function StorePointDerivative()). Since the "fixed points" will typically constitute a sparse set, this means that the field will have zero gradient values at every voxel that doesn't have a corresponding point. This might cause additional computation time for certain transforms (e.g. B-spline SyN). To avoid this, this option permits storing the point derivative only at the fixed point locations. If this variable is set to false, then the derivative array will be of length = PointDimension * m_FixedPointSet->GetNumberOfPoints().

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

By default, the point set metric derivative for a displacement field transform is stored by saving the gradient for every voxel in the displacement field (see the function StorePointDerivative()). Since the "fixed points" will typically constitute a sparse set, this means that the field will have zero gradient values at every voxel that doesn't have a corresponding point. This might cause additional computation time for certain transforms (e.g. B-spline SyN). To avoid this, this option permits storing the point derivative only at the fixed point locations. If this variable is set to false, then the derivative array will be of length = PointDimension * m_FixedPointSet->GetNumberOfPoints().

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

By default, the point set metric derivative for a displacement field transform is stored by saving the gradient for every voxel in the displacement field (see the function StorePointDerivative()). Since the "fixed points" will typically constitute a sparse set, this means that the field will have zero gradient values at every voxel that doesn't have a corresponding point. This might cause additional computation time for certain transforms (e.g. B-spline SyN). To avoid this, this option permits storing the point derivative only at the fixed point locations. If this variable is set to false, then the derivative array will be of length = PointDimension * m_FixedPointSet->GetNumberOfPoints().

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::StorePointDerivative ( const VirtualPointType ,
const DerivativeType ,
DerivativeType  
) const
protected

Store a derivative from a single point in a field. Only relevant when active transform has local support.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
virtual bool itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::SupportsArbitraryVirtualDomainSamples ( void  ) const
inlineoverridevirtual

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.

Implements itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< TInternalComputationValueType, TFixedPointSet::PointDimension >, TInternalComputationValueType >.

Definition at line 299 of file itkPointSetToPointSetMetricv4.h.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::TransformFixedAndCreateVirtualPointSet ( ) const
protected

Warp the fixed point set into the moving domain based on the fixed transform, passing through the virtual domain and storing a virtual domain set. Note that the warped moving point set is of type FixedPointSetType since the transform takes the points from the fixed to the moving domain.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
void itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::TransformMovingPointSet ( ) const
protected

Warp the moving point set based on the moving transform. Note that the warped moving point set is of type FixedPointSetType since the transform takes the points from the moving to the fixed domain. FIXME: needs update.

Member Data Documentation

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
const DimensionType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::FixedPointDimension = Superclass::FixedDimension
static

Definition at line 130 of file itkPointSetToPointSetMetricv4.h.

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

Flag to calculate value and/or derivative at tangent space. This is needed for the diffeomorphic registration methods. The fixed and moving points are warped to the virtual domain where the metric is calculated. Derived point set metrics might have associated gradient information which will need to be warped if this flag is true. Default = false.

Definition at line 361 of file itkPointSetToPointSetMetricv4.h.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
FixedPointSetType::ConstPointer itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::m_FixedPointSet
protected

Definition at line 335 of file itkPointSetToPointSetMetricv4.h.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
FixedTransformedPointSetType::Pointer itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::m_FixedTransformedPointSet
mutableprotected

Definition at line 336 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 436 of file itkPointSetToPointSetMetricv4.h.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
PointsLocatorType::Pointer itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::m_FixedTransformedPointsLocator
mutableprotected

Definition at line 338 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 425 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 429 of file itkPointSetToPointSetMetricv4.h.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
MovingPointSetType::ConstPointer itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::m_MovingPointSet
protected

Definition at line 340 of file itkPointSetToPointSetMetricv4.h.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
MovingTransformedPointSetType::Pointer itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::m_MovingTransformedPointSet
mutableprotected

Definition at line 341 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 435 of file itkPointSetToPointSetMetricv4.h.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
PointsLocatorType::Pointer itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::m_MovingTransformedPointsLocator
mutableprotected

Definition at line 343 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 422 of file itkPointSetToPointSetMetricv4.h.

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

Definition at line 433 of file itkPointSetToPointSetMetricv4.h.

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

Bool set by derived classes on whether the point set data (i.e. PixelType) should be used. Default = false.

Definition at line 352 of file itkPointSetToPointSetMetricv4.h.

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

Holds the fixed points after transformation into virtual domain.

Definition at line 346 of file itkPointSetToPointSetMetricv4.h.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
const DimensionType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::MovingPointDimension = Superclass::MovingDimension
static

Definition at line 138 of file itkPointSetToPointSetMetricv4.h.

template<typename TFixedPointSet, typename TMovingPointSet, class TInternalComputationValueType = double>
const DimensionType itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::PointDimension = Superclass::FixedDimension
static

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


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