ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType > Class Template Reference

#include <itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h>

+ Inheritance diagram for itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >:
+ Collaboration diagram for itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >:

Detailed Description

template<typename TPointSet, class TInternalComputationValueType = double>
class itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >

Implementation of the Jensen Havrda Charvat Tsallis Point Set metric.

Given a specified transform and direction, this class calculates the value and derivative between a "fixed" and "moving" point set pair using the Havrda-Charvat-Tsallis entropy family, a generalization of the well-known Shannon entropy, and the Jensen divergence. Another way to look at the family of information-theoretic measures is that the points are used to construct the corresponding probably density functions.

In addition, we allow the user to invoke a manifold parzen windowing of the data. Instead of an isotropic Gaussian being associated with each point, we can actually calculate the covariance matrix for each point such that it reflects the locate point set structure.

To speed up the metric calculation, we use ITK's K-d tree to query the metric value only for a given neighborhood. Considering that probably only a small subset of points is needed to get a good approximation of the metric value for a single point, this is probably warranted. So what we do is transform each point (with the specified transform) and construct the k-d tree from the transformed points.

Contributed by Nicholas J. Tustison, James C. Gee in the Insight Journal paper: http://hdl.handle.net/1926/1524

Note
The original work reported in Tustison et al. 2011 optionally employed a regularization term to prevent the moving point set(s) from coalescing to a single point location. However, within the registration framework, this term is of limited utility as such regularization is dictated by the transform and any explicit regularization terms. Also note that the published work applies to multiple points sets each of which could be considered "moving" but this is also not applicable for this particular implementation.
REFERENCE

N.J. Tustison, S. P. Awate, G. Song, T. S. Cook, and J. C. Gee. "Point set registration using Havrda-Charvat-Tsallis entropy measures" IEEE Transactions on Medical Imaging, 30(2):451-60, 2011.

Definition at line 71 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::CoordRepType CoordRepType
 
typedef
DensityFunctionType::Pointer 
DensityFunctionPointer
 
typedef
ManifoldParzenWindowsPointSetFunction
< PointSetType, RealType
DensityFunctionType
 
typedef Superclass::DerivativeType DerivativeType
 
typedef
Superclass::DerivativeValueType 
DerivativeValueType
 
typedef
Superclass::FixedTransformJacobianType 
FixedTransformJacobianType
 
typedef
DensityFunctionType::GaussianType 
GaussianType
 
typedef Superclass::JacobianType JacobianType
 
typedef
Superclass::LocalDerivativeType 
LocalDerivativeType
 
typedef Superclass::MeasureType MeasureType
 
typedef
Superclass::MovingTransformJacobianType 
MovingTransformJacobianType
 
typedef
Superclass::NeighborsIdentifierType 
NeighborsIdentifierType
 
typedef
Superclass::NumberOfParametersType 
NumberOfParametersType
 
typedef Superclass::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::PointIdentifier PointIdentifier
 
typedef
PointSetType::PointsContainer 
PointsContainer
 
typedef
PointsContainer::ConstIterator 
PointsContainerConstIterator
 
typedef TPointSet PointSetType
 
typedef Superclass::PointType PointType
 
typedef MeasureType RealType
 
typedef
JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4 
Self
 
typedef
PointSetToPointSetMetricv4
< TPointSet, TPointSet,
TInternalComputationValueType > 
Superclass
 
- Public Types inherited from itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, TInternalComputationValueType >
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 TPointSet::PixelType FixedPixelType
 
typedef TPointSet::PointsContainer FixedPointsContainer
 
typedef TPointSet FixedPointSetType
 
typedef TPointSet::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 TPointSet::PixelType MovingPixelType
 
typedef TPointSet::PointsContainer MovingPointsContainer
 
typedef TPointSet MovingPointSetType
 
typedef TPointSet::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
< TPointSet::PointDimension,
TPointSet::PointDimension,
Image
< TInternalComputationValueType,
TPointSet::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< TPointSet::PointDimension, TPointSet::PointDimension, Image< TInternalComputationValueType, TPointSet::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,
TPointSet::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,
TPointSet::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,
TPointSet::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 RealType GetAlpha () const
 
virtual unsigned int GetCovarianceKNeighborhood () const
 
virtual unsigned int GetEvaluationKNeighborhood () const
 
virtual RealType GetKernelSigma () const
 
virtual MeasureType GetLocalNeighborhoodValue (const PointType &point, const PixelType &pixel=0) const override
 
virtual void GetLocalNeighborhoodValueAndDerivative (const PointType &, MeasureType &, LocalDerivativeType &, const PixelType &pixel=0) const override
 
virtual const char * GetNameOfClass () const
 
virtual RealType GetPointSetSigma () const
 
virtual bool GetUseAnisotropicCovariances () const
 
virtual void Initialize (void) override throw ( ExceptionObject )
 
virtual LightObject::Pointer InternalClone () const override
 
virtual void SetAlpha (RealType _arg)
 
virtual void SetCovarianceKNeighborhood (unsigned int _arg)
 
virtual void SetEvaluationKNeighborhood (unsigned int _arg)
 
virtual void SetKernelSigma (RealType _arg)
 
virtual void SetPointSetSigma (RealType _arg)
 
virtual void SetUseAnisotropicCovariances (bool _arg)
 
virtual void UseAnisotropicCovariancesOff ()
 
virtual void UseAnisotropicCovariancesOn ()
 
- Public Member Functions inherited from itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, TInternalComputationValueType >
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
 
SizeValueType GetNumberOfComponents () const
 
virtual MeasureType GetValue () const override
 
virtual void GetValueAndDerivative (MeasureType &, DerivativeType &) const override
 
const VirtualPointSetTypeGetVirtualTransformedPointSet () const
 
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< TPointSet::PointDimension, TPointSet::PointDimension, Image< TInternalComputationValueType, TPointSet::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 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 flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static const unsigned int PointDimension = TPointSet::PointDimension
 
- Static Public Attributes inherited from itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, TInternalComputationValueType >
static const DimensionType FixedPointDimension
 
static const DimensionType MovingPointDimension
 
static const DimensionType PointDimension
 
- Static Public Attributes inherited from itk::ObjectToObjectMetric< TPointSet::PointDimension, TPointSet::PointDimension, Image< TInternalComputationValueType, TPointSet::PointDimension >, TInternalComputationValueType >
static const DimensionType FixedDimension
 
static const DimensionType MovingDimension
 
static const DimensionType VirtualDimension
 

Protected Member Functions

void ComputeValueAndDerivative (const PointType &samplePoint, MeasureType &value, LocalDerivativeType &derivativeReturn, bool calcValue, bool calcDerivative) const
 
 JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4 ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4 ()
 
- Protected Member Functions inherited from itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, TInternalComputationValueType >
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 ()
 
- Protected Member Functions inherited from itk::ObjectToObjectMetric< TPointSet::PointDimension, TPointSet::PointDimension, Image< TInternalComputationValueType, TPointSet::PointDimension >, TInternalComputationValueType >
const
MovingDisplacementFieldTransformType
GetMovingDisplacementFieldTransform () const
 
 ObjectToObjectMetric ()
 
bool TransformPhysicalPointToVirtualIndex (const VirtualPointType &, VirtualIndexType &) const
 
void TransformVirtualIndexToPhysicalPoint (const VirtualIndexType &, VirtualPointType &) const
 
virtual void VerifyDisplacementFieldSizeAndPhysicalSpace ()
 
bool VerifyNumberOfValidPoints (MeasureType &value, DerivativeType &derivative) const
 
virtual ~ObjectToObjectMetric ()
 
- Protected Member Functions inherited from itk::ObjectToObjectMetricBaseTemplate< TInternalComputationValueType >
 ObjectToObjectMetricBaseTemplate ()
 
virtual ~ObjectToObjectMetricBaseTemplate ()
 
- Protected Member Functions inherited from itk::SingleValuedCostFunctionv4Template< TInternalComputationValueType >
 SingleValuedCostFunctionv4Template ()
 
virtual ~SingleValuedCostFunctionv4Template ()
 
- Protected Member Functions inherited from itk::CostFunctionTemplate< TInternalComputationValueType >
 CostFunctionTemplate ()
 
virtual ~CostFunctionTemplate ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

 JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4 (const Self &)
 
void operator= (const Self &)
 

Private Attributes

RealType m_Alpha
 
unsigned int m_CovarianceKNeighborhood
 
unsigned int m_EvaluationKNeighborhood
 
DensityFunctionPointer m_FixedDensityFunction
 
RealType m_KernelSigma
 
DensityFunctionPointer m_MovingDensityFunction
 
RealType m_PointSetSigma
 
RealType m_Prefactor0
 
RealType m_Prefactor1
 
RealType m_TotalNumberOfPoints
 
bool m_UseAnisotropicCovariances
 

Additional Inherited Members

- Protected Types inherited from itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, TInternalComputationValueType >
typedef
Superclass::MetricCategoryType 
MetricCategoryType
 
- Protected Attributes inherited from itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, TInternalComputationValueType >
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< TPointSet::PointDimension, TPointSet::PointDimension, Image< TInternalComputationValueType, TPointSet::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
 

Member Typedef Documentation

template<typename TPointSet , class TInternalComputationValueType = double>
typedef SmartPointer<const Self> itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::ConstPointer
template<typename TPointSet , class TInternalComputationValueType = double>
typedef Superclass::CoordRepType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::CoordRepType
template<typename TPointSet , class TInternalComputationValueType = double>
typedef DensityFunctionType::Pointer itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::DensityFunctionPointer
template<typename TPointSet , class TInternalComputationValueType = double>
typedef ManifoldParzenWindowsPointSetFunction<PointSetType, RealType> itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::DensityFunctionType

Other typedefs

Definition at line 116 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

template<typename TPointSet , class TInternalComputationValueType = double>
typedef Superclass::DerivativeType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::DerivativeType
template<typename TPointSet , class TInternalComputationValueType = double>
typedef Superclass::DerivativeValueType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::DerivativeValueType
template<typename TPointSet , class TInternalComputationValueType = double>
typedef Superclass::FixedTransformJacobianType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::FixedTransformJacobianType
template<typename TPointSet , class TInternalComputationValueType = double>
typedef DensityFunctionType::GaussianType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GaussianType
template<typename TPointSet , class TInternalComputationValueType = double>
typedef Superclass::JacobianType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::JacobianType
template<typename TPointSet , class TInternalComputationValueType = double>
typedef Superclass::LocalDerivativeType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::LocalDerivativeType
template<typename TPointSet , class TInternalComputationValueType = double>
typedef Superclass::MeasureType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::MeasureType

Types transferred from the base class

Definition at line 95 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

template<typename TPointSet , class TInternalComputationValueType = double>
typedef Superclass::MovingTransformJacobianType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::MovingTransformJacobianType
template<typename TPointSet , class TInternalComputationValueType = double>
typedef Superclass::NeighborsIdentifierType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::NeighborsIdentifierType
template<typename TPointSet , class TInternalComputationValueType = double>
typedef Superclass::NumberOfParametersType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::NumberOfParametersType
template<typename TPointSet , class TInternalComputationValueType = double>
typedef Superclass::PixelType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::PixelType
template<typename TPointSet , class TInternalComputationValueType = double>
typedef SmartPointer<Self> itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::Pointer
template<typename TPointSet , class TInternalComputationValueType = double>
typedef Superclass::PointIdentifier itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::PointIdentifier
template<typename TPointSet , class TInternalComputationValueType = double>
typedef PointSetType::PointsContainer itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::PointsContainer
template<typename TPointSet , class TInternalComputationValueType = double>
typedef PointsContainer::ConstIterator itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::PointsContainerConstIterator
template<typename TPointSet , class TInternalComputationValueType = double>
typedef TPointSet itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::PointSetType
template<typename TPointSet , class TInternalComputationValueType = double>
typedef Superclass::PointType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::PointType
template<typename TPointSet , class TInternalComputationValueType = double>
typedef MeasureType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::RealType
template<typename TPointSet , class TInternalComputationValueType = double>
typedef JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4 itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::Self

Standard class typedefs.

Definition at line 76 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

template<typename TPointSet , class TInternalComputationValueType = double>
typedef PointSetToPointSetMetricv4<TPointSet, TPointSet, TInternalComputationValueType> itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::Superclass

Constructor & Destructor Documentation

template<typename TPointSet , class TInternalComputationValueType = double>
itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4 ( )
protected
template<typename TPointSet , class TInternalComputationValueType = double>
itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::~JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4 ( )
protected
template<typename TPointSet , class TInternalComputationValueType = double>
itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4 ( const Self )
private

Member Function Documentation

template<typename TPointSet , class TInternalComputationValueType = double>
void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::ComputeValueAndDerivative ( const PointType samplePoint,
MeasureType value,
LocalDerivativeType derivativeReturn,
bool  calcValue,
bool  calcDerivative 
) const
protected
template<typename TPointSet , class TInternalComputationValueType = double>
virtual RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GetAlpha ( ) const
virtual

Get the alpha parameter used to tune the point-set metric.

template<typename TPointSet , class TInternalComputationValueType = double>
virtual unsigned int itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GetCovarianceKNeighborhood ( ) const
virtual

Get the size of the covariance neighborhood used to construct the anisotropic covariances. Only relevant if m_UseAnisotropicCovariances = true. Default = 5.

template<typename TPointSet , class TInternalComputationValueType = double>
virtual unsigned int itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GetEvaluationKNeighborhood ( ) const
virtual

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

template<typename TPointSet , class TInternalComputationValueType = double>
virtual RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GetKernelSigma ( ) const
virtual

Get the noise kernel sigma for the anistropic covariances.

template<typename TPointSet , class TInternalComputationValueType = double>
virtual MeasureType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GetLocalNeighborhoodValue ( const PointType point,
const PixelType pixel = 0 
) const
overridevirtual
template<typename TPointSet , class TInternalComputationValueType = double>
virtual void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GetLocalNeighborhoodValueAndDerivative ( const PointType ,
MeasureType ,
LocalDerivativeType ,
const PixelType pixel = 0 
) const
overridevirtual
template<typename TPointSet , class TInternalComputationValueType = double>
virtual const char* itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods)

Reimplemented from itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, TInternalComputationValueType >.

template<typename TPointSet , class TInternalComputationValueType = double>
virtual RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GetPointSetSigma ( ) const
virtual

Get the point set sigma function

template<typename TPointSet , class TInternalComputationValueType = double>
virtual bool itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::GetUseAnisotropicCovariances ( ) const
virtual

Get whether or not anisotropic covariances are determined for each Gaussian. Default = false.

template<typename TPointSet , class TInternalComputationValueType = double>
virtual void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::Initialize ( void  )
throw (ExceptionObject
)
overridevirtual

Initialize the Metric by making sure that all the components are present and plugged together correctly

Reimplemented from itk::PointSetToPointSetMetricv4< TPointSet, TPointSet, TInternalComputationValueType >.

template<typename TPointSet , class TInternalComputationValueType = double>
virtual LightObject::Pointer itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::InternalClone ( ) const
overridevirtual

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

Reimplemented from itk::LightObject.

template<typename TPointSet , class TInternalComputationValueType = double>
static Pointer itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::New ( )
static

Method for creation through the object factory.

template<typename TPointSet , class TInternalComputationValueType = double>
void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::operator= ( const Self )
private
template<typename TPointSet , class TInternalComputationValueType = double>
void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, 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 TPointSet , class TInternalComputationValueType = double>
virtual void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::SetAlpha ( RealType  _arg)
virtual

Set the alpha parameter used to tune the point-set metric from a maximum-likelihood measure (alpha = 1) to the more robust L2 solution (alpha = 2). Typically, "robustness" is associated with performance in the presence of uniform noise but in most applications the noise will be highly correlated with the point sets, therefore an alpha value close to 1, in general, provides better performance. Only values between 1 and 2 are convex.

template<typename TPointSet , class TInternalComputationValueType = double>
virtual void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::SetCovarianceKNeighborhood ( unsigned int  _arg)
virtual

Set the size of the covariance neighborhood used to construct the anisotropic covariances. Only relevant if m_UseAnisotropicCovariances = true. Default = 5.

template<typename TPointSet , class TInternalComputationValueType = double>
virtual void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::SetEvaluationKNeighborhood ( unsigned int  _arg)
virtual

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

template<typename TPointSet , class TInternalComputationValueType = double>
virtual void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::SetKernelSigma ( RealType  _arg)
virtual

Set the size of the noise kernel used to construct each covariance image. To avoid the case where the local point set structure would result in a degenerate covariance matrix, a small amount of noise is added along the diagonal represented by this variable. Only relevant if m_UseAnisotropicCovariances = true. Default = 10.0.

template<typename TPointSet , class TInternalComputationValueType = double>
virtual void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::SetPointSetSigma ( RealType  _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.

template<typename TPointSet , class TInternalComputationValueType = double>
virtual void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::SetUseAnisotropicCovariances ( bool  _arg)
virtual

Set whether or not anisotropic covariances are determined for each Gaussian. Default = false.

template<typename TPointSet , class TInternalComputationValueType = double>
virtual void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::UseAnisotropicCovariancesOff ( )
virtual
template<typename TPointSet , class TInternalComputationValueType = double>
virtual void itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::UseAnisotropicCovariancesOn ( )
virtual

Get/set whether or not anisotropic covariances are determined for each Gaussian. Default = false.

Member Data Documentation

template<typename TPointSet , class TInternalComputationValueType = double>
RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_Alpha
private
template<typename TPointSet , class TInternalComputationValueType = double>
unsigned int itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_CovarianceKNeighborhood
private
template<typename TPointSet , class TInternalComputationValueType = double>
unsigned int itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_EvaluationKNeighborhood
private
template<typename TPointSet , class TInternalComputationValueType = double>
DensityFunctionPointer itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_FixedDensityFunction
private
template<typename TPointSet , class TInternalComputationValueType = double>
RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_KernelSigma
private
template<typename TPointSet , class TInternalComputationValueType = double>
DensityFunctionPointer itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_MovingDensityFunction
private
template<typename TPointSet , class TInternalComputationValueType = double>
RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_PointSetSigma
private
template<typename TPointSet , class TInternalComputationValueType = double>
RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_Prefactor0
mutableprivate
template<typename TPointSet , class TInternalComputationValueType = double>
RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_Prefactor1
mutableprivate
template<typename TPointSet , class TInternalComputationValueType = double>
RealType itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_TotalNumberOfPoints
mutableprivate

Precomputed cached values

Definition at line 243 of file itkJensenHavrdaCharvatTsallisPointSetToPointSetMetricv4.h.

template<typename TPointSet , class TInternalComputationValueType = double>
bool itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::m_UseAnisotropicCovariances
private
template<typename TPointSet , class TInternalComputationValueType = double>
const unsigned int itk::JensenHavrdaCharvatTsallisPointSetToPointSetMetricv4< TPointSet, TInternalComputationValueType >::PointDimension = TPointSet::PointDimension
static

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