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

#include <itkExpectationBasedPointSetToPointSetMetricv4.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using CoordRepType = typename Superclass::CoordRepType
 
using DerivativeType = typename Superclass::DerivativeType
 
using LocalDerivativeType = typename Superclass::LocalDerivativeType
 
using MeasureType = typename Superclass::MeasureType
 
using NeighborsIdentifierType = typename Superclass::NeighborsIdentifierType
 
using PixelType = typename Superclass::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointIdentifier = typename Superclass::PointIdentifier
 
using PointType = typename Superclass::PointType
 
using Self = ExpectationBasedPointSetToPointSetMetricv4
 
using Superclass = PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >
 
- Public Types inherited from itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >
using ConstPointer = SmartPointer< const Self >
 
using CoordRepType = typename PointType::CoordRepType
 
using DerivativeType = typename Superclass::DerivativeType
 
using DerivativeValueType = typename Superclass::DerivativeValueType
 
using DimensionType = typename Superclass::DimensionType
 
using DisplacementFieldTransformType = typename Superclass::MovingDisplacementFieldTransformType
 
using FixedInputPointType = typename Superclass::FixedInputPointType
 
using FixedOutputPointType = typename Superclass::FixedOutputPointType
 
using FixedPixelType = typename TFixedPointSet::PixelType
 
using FixedPointsContainer = typename TFixedPointSet::PointsContainer
 
using FixedPointSetType = TFixedPointSet
 
using FixedPointType = typename TFixedPointSet::PointType
 
using FixedTransformedPointSetType = typename Superclass::FixedTransformedPointSetType
 
using FixedTransformJacobianType = typename Superclass::FixedTransformJacobianType
 
using FixedTransformParametersType = typename Superclass::FixedTransformParametersType
 
using FixedTransformPointer = typename Superclass::FixedTransformPointer
 
using FixedTransformType = typename Superclass::FixedTransformType
 
using JacobianType = typename Superclass::JacobianType
 
using LocalDerivativeType = typename Superclass::LocalDerivativeType
 
using MeasureType = typename Superclass::MeasureType
 
using MovingInputPointType = typename Superclass::MovingInputPointType
 
using MovingOutputPointType = typename Superclass::MovingOutputPointType
 
using MovingPixelType = typename TMovingPointSet::PixelType
 
using MovingPointsContainer = typename TMovingPointSet::PointsContainer
 
using MovingPointSetType = TMovingPointSet
 
using MovingPointType = typename TMovingPointSet::PointType
 
using MovingTransformedPointSetType = typename Superclass::MovingTransformedPointSetType
 
using MovingTransformJacobianType = typename Superclass::MovingTransformJacobianType
 
using MovingTransformParametersType = typename Superclass::MovingTransformParametersType
 
using MovingTransformPointer = typename Superclass::MovingTransformPointer
 
using MovingTransformType = typename Superclass::MovingTransformType
 
using NeighborsIdentifierType = typename PointsLocatorType::NeighborsIdentifierType
 
using NumberOfParametersType = typename Superclass::NumberOfParametersType
 
using ParametersType = typename Superclass::ParametersType
 
using ParametersValueType = typename Superclass::ParametersValueType
 
using PixelType = typename Superclass::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointIdentifier = typename Superclass::PointIdentifier
 
using PointsConstIterator = typename PointsContainer::ConstIterator
 
using PointsContainer = FixedPointsContainer
 
using PointsLocatorType = typename Superclass::PointsLocatorType
 
using PointType = typename Superclass::PointType
 
using Self = PointSetToPointSetMetricv4
 
using Superclass = PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >
 
using VirtualDirectionType = typename Superclass::VirtualDirectionType
 
using VirtualImagePointer = typename Superclass::VirtualImagePointer
 
using VirtualImageType = typename Superclass::VirtualImageType
 
using VirtualIndexType = typename Superclass::VirtualIndexType
 
using VirtualOriginType = typename Superclass::VirtualPointType
 
using VirtualPixelType = typename Superclass::VirtualPixelType
 
using VirtualPointSetPointer = typename Superclass::VirtualPointSetPointer
 
using VirtualPointSetType = typename Superclass::VirtualPointSetType
 
using VirtualPointType = typename Superclass::VirtualPointType
 
using VirtualRadiusType = typename Superclass::VirtualSizeType
 
using VirtualRegionType = typename Superclass::VirtualRegionType
 
using VirtualSizeType = typename Superclass::VirtualSizeType
 
using VirtualSpacingType = typename Superclass::VirtualSpacingType
 
- Public Types inherited from itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >
using ConstPointer = SmartPointer< const Self >
 
using CoordRepType = typename PointType::CoordRepType
 
using DerivativeType = typename Superclass::DerivativeType
 
using DerivativeValueType = typename DerivativeType::ValueType
 
using DimensionType = typename Superclass::DimensionType
 
using DisplacementFieldTransformType = typename Superclass::MovingDisplacementFieldTransformType
 
using FixedInputPointType = typename Superclass::FixedInputPointType
 
using FixedOutputPointType = typename Superclass::FixedOutputPointType
 
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 FixedTransformJacobianType = typename Superclass::FixedTransformJacobianType
 
using FixedTransformParametersType = typename Superclass::FixedTransformParametersType
 
using FixedTransformPointer = typename Superclass::FixedTransformPointer
 
using FixedTransformType = typename Superclass::FixedTransformType
 
using JacobianType = typename Superclass::JacobianType
 
using LocalDerivativeType = FixedArray< DerivativeValueType, Self::PointDimension >
 
using MeasureType = typename Superclass::MeasureType
 
using MovingInputPointType = typename Superclass::MovingInputPointType
 
using MovingOutputPointType = typename Superclass::MovingOutputPointType
 
using MovingPixelType = typename TMovingPointSet::PixelType
 
using MovingPointsContainer = typename TMovingPointSet::PointsContainer
 
using MovingPointSetType = TMovingPointSet
 
using MovingPointType = typename TMovingPointSet::PointType
 
using MovingTransformedPointSetType = PointSet< MovingPixelType, Self::PointDimension >
 
using MovingTransformJacobianType = typename Superclass::MovingTransformJacobianType
 
using MovingTransformParametersType = typename Superclass::MovingTransformParametersType
 
using MovingTransformPointer = typename Superclass::MovingTransformPointer
 
using MovingTransformType = typename Superclass::MovingTransformType
 
using NeighborsIdentifierType = typename PointsLocatorType::NeighborsIdentifierType
 
using NumberOfParametersType = typename Superclass::NumberOfParametersType
 
using ObjectType = typename Superclass::ObjectType
 
using ParametersType = typename Superclass::ParametersType
 
using ParametersValueType = typename Superclass::ParametersValueType
 
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< TInternalComputationValueType, TFixedPointSet::PointDimension >, TInternalComputationValueType >
 
using VirtualDirectionType = typename Superclass::VirtualDirectionType
 
using VirtualImagePointer = typename Superclass::VirtualImagePointer
 
using VirtualImageType = typename Superclass::VirtualImageType
 
using VirtualIndexType = typename Superclass::VirtualIndexType
 
using VirtualOriginType = typename Superclass::VirtualPointType
 
using VirtualPixelType = typename Superclass::VirtualPixelType
 
using VirtualPointSetPointer = typename Superclass::VirtualPointSetPointer
 
using VirtualPointSetType = typename Superclass::VirtualPointSetType
 
using VirtualPointType = typename Superclass::VirtualPointType
 
using VirtualRadiusType = typename Superclass::VirtualSizeType
 
using VirtualRegionType = typename Superclass::VirtualRegionType
 
using VirtualSizeType = typename Superclass::VirtualSizeType
 
using VirtualSpacingType = typename Superclass::VirtualSpacingType
 
- Public Types inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< TInternalComputationValueType, TFixedPointSet::PointDimension >, TInternalComputationValueType >
using ConstPointer = SmartPointer< const Self >
 
using CoordinateRepresentationType = TInternalComputationValueType
 
using DerivativeType = typename Superclass::DerivativeType
 
using DerivativeValueType = typename Superclass::DerivativeValueType
 
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< TInternalComputationValueType, Image< TInternalComputationValueType, TFixedPointSet::PointDimension > ::ImageDimension, TFixedDimension >
 
using GradientSourceEnum = typename Superclass::GradientSourceEnum
 
using InternalComputationValueType = TInternalComputationValueType
 
using JacobianType = typename FixedTransformType::JacobianType
 
using MeasureType = typename Superclass::MeasureType
 
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< TInternalComputationValueType, Image< TInternalComputationValueType, TFixedPointSet::PointDimension > ::ImageDimension, TMovingDimension >
 
using NumberOfParametersType = typename Superclass::NumberOfParametersType
 
using ObjectType = typename Superclass::Object
 
using ParametersType = typename Superclass::ParametersType
 
using Pointer = SmartPointer< Self >
 
using Self = ObjectToObjectMetric
 
using Superclass = ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >
 
using VirtualDirectionType = typename VirtualImageType::DirectionType
 
using VirtualImageConstPointer = typename VirtualImageType::ConstPointer
 
using VirtualImagePointer = typename VirtualImageType::Pointer
 
using VirtualImageType = Image< TInternalComputationValueType, 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
 
using MetricCategoryType = typename Superclass::MetricCategoryEnum
 
- Public Types inherited from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >
using ConstPointer = SmartPointer< const Self >
 
using CoordinateRepresentationType = TInternalComputationValueType
 
using DerivativeType = typename Superclass::DerivativeType
 
using DerivativeValueType = typename DerivativeType::ValueType
 
using MeasureType = typename Superclass::MeasureType
 
using ObjectConstPointer = typename ObjectType::ConstPointer
 
using ObjectType = Object
 
using ParametersType = typename Superclass::ParametersType
 
using ParametersValueType = TInternalComputationValueType
 
using Pointer = SmartPointer< Self >
 
using Self = ObjectToObjectMetricBaseTemplate
 
using Superclass = SingleValuedCostFunctionv4Template< TInternalComputationValueType >
 
using GradientSourceEnum = itk::ObjectToObjectMetricBaseTemplateEnums::GradientSource
 
using NumberOfParametersType = unsigned int
 
using MetricCategoryEnum = itk::ObjectToObjectMetricBaseTemplateEnums::MetricCategory
 
- Public Types inherited from itk::SingleValuedCostFunctionv4Template< TInternalComputationValueType >
using ConstPointer = SmartPointer< const Self >
 
using DerivativeType = Array< TInternalComputationValueType >
 
using MeasureType = TInternalComputationValueType
 
using ParametersType = typename Superclass::ParametersType
 
using Pointer = SmartPointer< Self >
 
using Self = SingleValuedCostFunctionv4Template
 
using Superclass = CostFunctionTemplate< TInternalComputationValueType >
 
- Public Types inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
using ConstPointer = SmartPointer< const Self >
 
using ParametersType = OptimizerParameters< TInternalComputationValueType >
 
using ParametersValueType = TInternalComputationValueType
 
using Pointer = SmartPointer< Self >
 
using Self = CostFunctionTemplate
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual unsigned int GetEvaluationKNeighborhood () const
 
MeasureType GetLocalNeighborhoodValue (const PointType &, const PixelType &pixel=0) const override
 
void GetLocalNeighborhoodValueAndDerivative (const PointType &, MeasureType &, LocalDerivativeType &, const PixelType &pixel=0) const override
 
virtual const char * GetNameOfClass () const
 
virtual CoordRepType GetPointSetSigma () const
 
void Initialize () override
 
LightObject::Pointer InternalClone () const override
 
virtual void SetEvaluationKNeighborhood (unsigned int _arg)
 
virtual void SetPointSetSigma (CoordRepType _arg)
 
- Public Member Functions inherited from itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >
virtual LocalDerivativeType GetLocalNeighborhoodDerivative (const PointType &, const PixelType &pixel) const
 
- Public Member Functions inherited from itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >
void SetFixedObject (const ObjectType *object) override
 
void SetMovingObject (const ObjectType *object) override
 
virtual void SetFixedPointSet (const FixedPointSetType *_arg)
 
virtual const FixedPointSetTypeGetFixedPointSet () const
 
virtual FixedTransformedPointSetTypeGetModifiableFixedTransformedPointSet ()
 
virtual const FixedTransformedPointSetTypeGetFixedTransformedPointSet () const
 
virtual void SetMovingPointSet (const MovingPointSetType *_arg)
 
virtual const MovingPointSetTypeGetMovingPointSet () const
 
virtual MovingTransformedPointSetTypeGetModifiableMovingTransformedPointSet ()
 
virtual const MovingTransformedPointSetTypeGetMovingTransformedPointSet () const
 
SizeValueType GetNumberOfComponents () const
 
MeasureType GetValue () const override
 
void GetDerivative (DerivativeType &) const override
 
void GetValueAndDerivative (MeasureType &, DerivativeType &) const override
 
const VirtualPointSetTypeGetVirtualTransformedPointSet () const
 
void Initialize () override
 
bool SupportsArbitraryVirtualDomainSamples () const override
 
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
 
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
 
virtual const VirtualImageTypeGetVirtualImage () 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)
 
void UpdateTransformParameters (const DerivativeType &derivative, TInternalComputationValueType factor) override
 
bool IsInsideVirtualDomain (const VirtualPointType &point) const
 
bool IsInsideVirtualDomain (const VirtualIndexType &index) const
 
MetricCategoryType GetMetricCategory () const override
 
- Public Member Functions inherited from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >
virtual const ObjectTypeGetFixedObject () const
 
virtual const ObjectTypeGetMovingObject () const
 
virtual void SetGradientSource (GradientSourceEnum _arg)
 
virtual GradientSourceEnum GetGradientSource () const
 
bool GetGradientSourceIncludesFixed () const
 
bool GetGradientSourceIncludesMoving () const
 
MeasureType GetCurrentValue () 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
 
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
 
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)
 
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 void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- 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 Member Functions

 ExpectationBasedPointSetToPointSetMetricv4 ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
bool RequiresFixedPointsLocator () const override
 
 ~ExpectationBasedPointSetToPointSetMetricv4 () override=default
 
- Protected Member Functions inherited from itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >
 PointSetToPointSetMetricv4 ()=default
 
 ~PointSetToPointSetMetricv4 () override=default
 
- Protected Member Functions inherited from itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >
 PointSetToPointSetMetricWithIndexv4 ()
 
 ~PointSetToPointSetMetricWithIndexv4 () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void InitializePointSets () const
 
virtual void InitializeForIteration () const
 
virtual SizeValueType CalculateNumberOfValidFixedPoints () const
 
void CalculateValueAndDerivative (MeasureType &calculatedValue, DerivativeType &derivative, bool calculateValue) const
 
void TransformFixedAndCreateVirtualPointSet () const
 
void TransformMovingPointSet () const
 
void InitializePointsLocators () const
 
void StorePointDerivative (const VirtualPointType &, const DerivativeType &, DerivativeType &) const
 
MetricCategoryType GetMetricCategory () const override
 
virtual bool RequiresMovingPointsLocator () const
 
virtual MeasureType GetLocalNeighborhoodValueWithIndex (const PointIdentifier &, const PointType &, const PixelType &pixel) const =0
 
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
 
- Protected Member Functions inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< TInternalComputationValueType, TFixedPointSet::PointDimension >, TInternalComputationValueType >
 ObjectToObjectMetric ()
 
 ~ObjectToObjectMetric () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void VerifyDisplacementFieldSizeAndPhysicalSpace ()
 
bool TransformPhysicalPointToVirtualIndex (const VirtualPointType &, VirtualIndexType &) const
 
void TransformVirtualIndexToPhysicalPoint (const VirtualIndexType &, VirtualPointType &) const
 
const MovingDisplacementFieldTransformTypeGetMovingDisplacementFieldTransform () const
 
bool VerifyNumberOfValidPoints (MeasureType &value, DerivativeType &derivative) const
 
- Protected Member Functions inherited from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >
 ObjectToObjectMetricBaseTemplate ()
 
 ~ObjectToObjectMetricBaseTemplate () override=default
 
- Protected Member Functions inherited from itk::SingleValuedCostFunctionv4Template< TInternalComputationValueType >
 SingleValuedCostFunctionv4Template ()=default
 
 ~SingleValuedCostFunctionv4Template () override=default
 
- Protected Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
 CostFunctionTemplate ()=default
 
 ~CostFunctionTemplate () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
- Protected Member Functions inherited from itk::LightObject
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Types

using NeighborsIterator = typename NeighborsIdentifierType::const_iterator
 
using VectorType = typename PointType::VectorType
 

Private Attributes

MeasureType m_Denominator
 
unsigned int m_EvaluationKNeighborhood { 50 }
 
CoordRepType m_PointSetSigma
 
MeasureType m_PreFactor
 

Additional Inherited Members

- Static Public Attributes inherited from itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >
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, TMovingPointSet, TInternalComputationValueType >
static constexpr DimensionType FixedPointDimension = Superclass::FixedDimension
 
static constexpr DimensionType MovingPointDimension = Superclass::MovingDimension
 
static constexpr DimensionType PointDimension = Superclass::FixedDimension
 
- Static Public Attributes inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< TInternalComputationValueType, TFixedPointSet::PointDimension >, TInternalComputationValueType >
static constexpr DimensionType FixedDimension
 
static constexpr DimensionType MovingDimension
 
static constexpr DimensionType VirtualDimension
 
- Protected Types inherited from itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >
using MetricCategoryType = typename Superclass::MetricCategoryType
 
- Protected Attributes inherited from itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >
FixedPointSetType::ConstPointer m_FixedPointSet
 
FixedTransformedPointSetType::Pointer m_FixedTransformedPointSet
 
PointsLocatorType::Pointer m_FixedTransformedPointsLocator
 
MovingPointSetType::ConstPointer m_MovingPointSet
 
MovingTransformedPointSetType::Pointer m_MovingTransformedPointSet
 
PointsLocatorType::Pointer m_MovingTransformedPointsLocator
 
VirtualPointSetPointer m_VirtualTransformedPointSet
 
bool m_UsePointSetData
 
bool m_CalculateValueAndDerivativeInTangentSpace
 
- Protected Attributes inherited from itk::ObjectToObjectMetric< TFixedPointSet::PointDimension, TMovingPointSet::PointDimension, Image< TInternalComputationValueType, TFixedPointSet::PointDimension >, TInternalComputationValueType >
FixedTransformPointer m_FixedTransform
 
MovingTransformPointer m_MovingTransform
 
VirtualImagePointer m_VirtualImage
 
bool m_UserHasSetVirtualDomain
 
SizeValueType m_NumberOfValidPoints
 
- Protected Attributes inherited from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >
ObjectConstPointer m_FixedObject
 
ObjectConstPointer m_MovingObject
 
GradientSourceEnum m_GradientSource
 
MeasureType m_Value
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

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

Computes an expectation-based metric between two point sets.

This information-theoretic point set measure models each point set as a sum of Gaussians. To speed up computation, evaluation of the local value/derivative is done in a user-specified neighborhood using the k-d tree constructed in the superclass.

Reference: Pluta J, Avants BB, Glynn S, Awate S, Gee JC, Detre JA, "Appearance and incomplete label matching for diffeomorphic template "based hippocampus segmentation", Hippocampus, 2009 Jun; 19(6):565-71.

Definition at line 46 of file itkExpectationBasedPointSetToPointSetMetricv4.h.

Member Typedef Documentation

◆ ConstPointer

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

◆ CoordRepType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::CoordRepType = typename Superclass::CoordRepType

◆ DerivativeType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::DerivativeType = typename Superclass::DerivativeType

◆ LocalDerivativeType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::LocalDerivativeType = typename Superclass::LocalDerivativeType

◆ MeasureType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::MeasureType = typename Superclass::MeasureType

Types transferred from the base class

Definition at line 66 of file itkExpectationBasedPointSetToPointSetMetricv4.h.

◆ NeighborsIdentifierType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::NeighborsIdentifierType = typename Superclass::NeighborsIdentifierType

◆ NeighborsIterator

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::NeighborsIterator = typename NeighborsIdentifierType::const_iterator
private

◆ PixelType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::PixelType = typename Superclass::PixelType

◆ Pointer

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

◆ PointIdentifier

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::PointIdentifier = typename Superclass::PointIdentifier

◆ PointType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::PointType = typename Superclass::PointType

◆ Self

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

Standard class type aliases.

Definition at line 54 of file itkExpectationBasedPointSetToPointSetMetricv4.h.

◆ Superclass

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

◆ VectorType

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
using itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::VectorType = typename PointType::VectorType
private

Constructor & Destructor Documentation

◆ ExpectationBasedPointSetToPointSetMetricv4()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::ExpectationBasedPointSetToPointSetMetricv4 ( )
protected

◆ ~ExpectationBasedPointSetToPointSetMetricv4()

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

Member Function Documentation

◆ GetEvaluationKNeighborhood()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
virtual unsigned int itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetEvaluationKNeighborhood ( ) const
virtual

Get the neighborhood size used to evaluate the measurement at each point. Default = 50.

◆ GetLocalNeighborhoodValue()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
MeasureType itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetLocalNeighborhoodValue ( const PointType ,
const PixelType pixel = 0 
) const
overridevirtual

Calculates the local metric value for a single point.

Implements itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >.

◆ GetLocalNeighborhoodValueAndDerivative()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
void itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetLocalNeighborhoodValueAndDerivative ( const PointType ,
MeasureType ,
LocalDerivativeType ,
const PixelType pixel = 0 
) const
overridevirtual

Calculates the local value and derivative for a single point.

Implements itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >.

◆ GetNameOfClass()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
virtual const char* itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::PointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >.

◆ GetPointSetSigma()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
virtual CoordRepType itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::GetPointSetSigma ( ) const
virtual

Get the point set sigma function

◆ Initialize()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
void itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::Initialize ( )
overridevirtual

Initialize the Metric by making sure that all the components are present and plugged together correctly, and initializing internal variables as required. This is for one-time initialization, e.g. before starting an optimization process.

Implements itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >.

◆ InternalClone()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
LightObject::Pointer itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::InternalClone ( ) const
overridevirtual

Clone method will clone the existing instance of this type, including its internal member variables.

Reimplemented from itk::LightObject.

◆ New()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
static Pointer itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
void itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

◆ RequiresFixedPointsLocator()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
bool itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::RequiresFixedPointsLocator ( ) const
inlineoverrideprotectedvirtual

Holds the fixed points after transformation into virtual domain.

Reimplemented from itk::PointSetToPointSetMetricWithIndexv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >.

Definition at line 125 of file itkExpectationBasedPointSetToPointSetMetricv4.h.

◆ SetEvaluationKNeighborhood()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
virtual void itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::SetEvaluationKNeighborhood ( unsigned int  _arg)
virtual

Set the neighborhood size used to evaluate the measurement at each point. Default = 50.

◆ SetPointSetSigma()

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
virtual void itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::SetPointSetSigma ( CoordRepType  _arg)
virtual

Each point is associated with a Gaussian characterized by m_PointSetSigma which provides a sense of scale for determining the similarity between two point sets. Default = 1.0.

Member Data Documentation

◆ m_Denominator

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
MeasureType itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::m_Denominator
private

◆ m_EvaluationKNeighborhood

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
unsigned int itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::m_EvaluationKNeighborhood { 50 }
private

◆ m_PointSetSigma

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
CoordRepType itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::m_PointSetSigma
private

◆ m_PreFactor

template<typename TFixedPointSet , typename TMovingPointSet = TFixedPointSet, class TInternalComputationValueType = double>
MeasureType itk::ExpectationBasedPointSetToPointSetMetricv4< TFixedPointSet, TMovingPointSet, TInternalComputationValueType >::m_PreFactor
private

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