open_iA 2021.08
A tool for the visual analysis and processing of volumetric datasets, with a focus on industrial computed tomography.
Public Types | Public Member Functions | Protected Member Functions | List of all members
itk::Statistics::KernelInducedDistanceMetric< TVector > Class Template Referenceabstract

Base class for kernel distance metrics. More...

#include <itkKernelInducedDistanceMetric.h>

Inheritance diagram for itk::Statistics::KernelInducedDistanceMetric< TVector >:
[legend]
Collaboration diagram for itk::Statistics::KernelInducedDistanceMetric< TVector >:
[legend]

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::MeasurementVectorSizeType MeasurementVectorSizeType
 Typedef to represent the length of each measurement vector. More...
 
typedef Superclass::MeasurementVectorType MeasurementVectorType
 Typedef to represent the measurement vector type. More...
 
typedef Superclass::OriginType OriginType
 Type of the origin. More...
 
typedef SmartPointer< SelfPointer
 
typedef KernelInducedDistanceMetric Self
 Standard class typedefs. More...
 
typedef DistanceMetric< TVector > Superclass
 
typedef itk::Statistics::MeasurementVectorTraitsTypes< MeasurementVectorType >::ValueType ValueType
 Typedef for the component of a vector. More...
 

Public Member Functions

double Evaluate (const MeasurementVectorType &x) const override=0
 Gets the distance between the origin and x. More...
 
virtual double Evaluate (const MeasurementVectorType &x1, const MeasurementVectorType &x2) const override=0
 Gets the distance between x1 and x2. More...
 
virtual double Evaluate (const ValueType &a, const ValueType &b) const =0
 Gets the coordinate distance between a and b. More...
 
 itkTypeMacro (KernelInducedDistanceMetric, DistanceMetric)
 Run-time type information (and related methods). More...
 

Protected Member Functions

 KernelInducedDistanceMetric ()
 Constructor. More...
 
virtual ~KernelInducedDistanceMetric ()
 Destructor. More...
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 Write the name-value pairs of the class data members to the supplied output stream. More...
 

Detailed Description

template<class TVector>
class itk::Statistics::KernelInducedDistanceMetric< TVector >

Base class for kernel distance metrics.

This class is derived from DistanceMetric class and declares common interfaces for kernel distance metrics.

As a function derived from DistanceMetric, users use Evaluate() method to get result.

Version
0.1
Author
Alberto Rey, Alfonso Castro and Bernardino Arcay. University of A Coruña. Spain
See also
DistanceMetric
RBFKernelInducedDistanceMetric
GRBFKernelInducedDistanceMetric
PolynomialKernelInducedDistanceMetric

Member Typedef Documentation

◆ ConstPointer

template<class TVector >
typedef SmartPointer< const Self > itk::Statistics::KernelInducedDistanceMetric< TVector >::ConstPointer

◆ MeasurementVectorSizeType

template<class TVector >
typedef Superclass::MeasurementVectorSizeType itk::Statistics::KernelInducedDistanceMetric< TVector >::MeasurementVectorSizeType

Typedef to represent the length of each measurement vector.

◆ MeasurementVectorType

template<class TVector >
typedef Superclass::MeasurementVectorType itk::Statistics::KernelInducedDistanceMetric< TVector >::MeasurementVectorType

Typedef to represent the measurement vector type.

◆ OriginType

template<class TVector >
typedef Superclass::OriginType itk::Statistics::KernelInducedDistanceMetric< TVector >::OriginType

Type of the origin.

◆ Pointer

template<class TVector >
typedef SmartPointer< Self > itk::Statistics::KernelInducedDistanceMetric< TVector >::Pointer

◆ Self

Standard class typedefs.

◆ Superclass

template<class TVector >
typedef DistanceMetric< TVector > itk::Statistics::KernelInducedDistanceMetric< TVector >::Superclass

◆ ValueType

template<class TVector >
typedef itk::Statistics::MeasurementVectorTraitsTypes<MeasurementVectorType>::ValueType itk::Statistics::KernelInducedDistanceMetric< TVector >::ValueType

Typedef for the component of a vector.

Constructor & Destructor Documentation

◆ KernelInducedDistanceMetric()

template<class TVector >
itk::Statistics::KernelInducedDistanceMetric< TVector >::KernelInducedDistanceMetric ( )
protected

Constructor.

◆ ~KernelInducedDistanceMetric()

template<class TVector >
virtual itk::Statistics::KernelInducedDistanceMetric< TVector >::~KernelInducedDistanceMetric ( )
inlineprotectedvirtual

Destructor.

Member Function Documentation

◆ Evaluate() [1/3]

template<class TVector >
double itk::Statistics::KernelInducedDistanceMetric< TVector >::Evaluate ( const MeasurementVectorType x) const
overridepure virtual

◆ Evaluate() [2/3]

template<class TVector >
virtual double itk::Statistics::KernelInducedDistanceMetric< TVector >::Evaluate ( const MeasurementVectorType x1,
const MeasurementVectorType x2 
) const
overridepure virtual

◆ Evaluate() [3/3]

template<class TVector >
virtual double itk::Statistics::KernelInducedDistanceMetric< TVector >::Evaluate ( const ValueType a,
const ValueType b 
) const
pure virtual

Gets the coordinate distance between a and b.

NOTE: a and b should be type of component.

Implemented in itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >, and itk::Statistics::RBFKernelInducedDistanceMetric< TVector >.

◆ itkTypeMacro()

template<class TVector >
itk::Statistics::KernelInducedDistanceMetric< TVector >::itkTypeMacro ( KernelInducedDistanceMetric< TVector >  ,
DistanceMetric   
)

Run-time type information (and related methods).

◆ PrintSelf()

template<class TVector >
void itk::Statistics::KernelInducedDistanceMetric< TVector >::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
overrideprotected

Write the name-value pairs of the class data members to the supplied output stream.


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