itk::Statistics::GRBFKernelInducedDistanceMetric< TVector > Class Template Reference

Gaussian radial basis kernel distance function. More...

#include <itkGRBFKernelInducedDistanceMetric.h>

Inheritance diagram for itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >:

Collaboration diagram for itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
	Typedef for the length of each measurement vector.
typedef itk::Statistics::MeasurementVectorTraits	MeasurementVectorTraitsType
	Vector information.
typedef Superclass::MeasurementVectorType	MeasurementVectorType
	Typedef for the type of vector.
typedef Superclass::OriginType	OriginType
	Type of the origin.
typedef SmartPointer< Self >	Pointer
typedef GRBFKernelInducedDistanceMetric	Self
typedef KernelInducedDistanceMetric< TVector >	Superclass
typedef Superclass::ValueType	ValueType
	Type of the component of a vector.
Public Types inherited from itk::Statistics::KernelInducedDistanceMetric< TVector >
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
	Typedef to represent the length of each measurement vector.
typedef Superclass::MeasurementVectorType	MeasurementVectorType
	Typedef to represent the measurement vector type.
typedef Superclass::OriginType	OriginType
	Type of the origin.
typedef SmartPointer< Self >	Pointer
typedef KernelInducedDistanceMetric	Self
	Standard class typedefs.
typedef DistanceMetric< TVector >	Superclass
typedef itk::Statistics::MeasurementVectorTraitsTypes< MeasurementVectorType >::ValueType	ValueType
	Typedef for the component of a vector.

Public Member Functions
double	Evaluate (const MeasurementVectorType &x) const
	Gets the distance between the origin and x.
double	Evaluate (const MeasurementVectorType &x1, const MeasurementVectorType &x2) const
	Gets the distance between x1 and x2.
double	Evaluate (const ValueType &a, const ValueType &b) const
	Gets the coordinate distance between a and b. NOTE: a and b should be type of component.
	itkGetConstMacro (A, double)
	Get the a value.
	itkGetConstMacro (B, double)
	Get the b value.
	itkGetConstMacro (Sigma, double)
	Get the sigma value.
	itkNewMacro (Self)
	Method for creation through the object factory.
	itkSetClampMacro (A, double, 0.0, itk::NumericTraits< double >::max())
	Set the a value. This value must be greater than 0.
	itkSetClampMacro (B, double, 1.0, 2.0)
	Set the b value. This value is constrained between 1 and 2.
	itkSetMacro (Sigma, double)
	Set the sigma value.
	itkTypeMacro (GRBFKernelInducedDistanceMetric, KernelInducedDistanceMetric)
	Run-time type information (and related methods).
Public Member Functions inherited from itk::Statistics::KernelInducedDistanceMetric< TVector >
	itkTypeMacro (KernelInducedDistanceMetric, DistanceMetric)
	Run-time type information (and related methods).

Protected Member Functions
	GRBFKernelInducedDistanceMetric (void)
virtual	~GRBFKernelInducedDistanceMetric (void)
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.
Protected Member Functions inherited from itk::Statistics::KernelInducedDistanceMetric< TVector >
	KernelInducedDistanceMetric ()
	Constructor.
virtual	~KernelInducedDistanceMetric ()
	Destructor.
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.

Detailed Description

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

Gaussian radial basis kernel distance function.

This class is derived from KernelInducedDistanceMetric class and implements the overloaded Evaluate() methods.

Version

0.1

Author

Alberto Rey, Alfonso Castro and Bernardino Arcay. University of A Coruña. Spain

See also

KernelInducedDistanceMetric

RBFKernelInducedDistanceMetric

PolynomialKernelInducedDistanceMetric

Member Typedef Documentation

ConstPointer

template<class TVector >

typedef SmartPointer< const Self > itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::ConstPointer

MeasurementVectorSizeType

template<class TVector >

typedef Superclass::MeasurementVectorSizeType itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::MeasurementVectorSizeType

Typedef for the length of each measurement vector.

MeasurementVectorTraitsType

template<class TVector >

typedef itk::Statistics::MeasurementVectorTraits itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::MeasurementVectorTraitsType

Vector information.

MeasurementVectorType

template<class TVector >

typedef Superclass::MeasurementVectorType itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::MeasurementVectorType

Typedef for the type of vector.

OriginType

template<class TVector >

typedef Superclass::OriginType itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::OriginType

Type of the origin.

Pointer

template<class TVector >

typedef SmartPointer< Self > itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::Pointer

Self

template<class TVector >

typedef GRBFKernelInducedDistanceMetric itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::Self

Superclass

template<class TVector >

typedef KernelInducedDistanceMetric< TVector > itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::Superclass

ValueType

template<class TVector >

typedef Superclass::ValueType itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::ValueType

Type of the component of a vector.

Constructor & Destructor Documentation

GRBFKernelInducedDistanceMetric()

template<class TVector >

itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::GRBFKernelInducedDistanceMetric ( void )

protected

~GRBFKernelInducedDistanceMetric()

template<class TVector >

virtual itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::~GRBFKernelInducedDistanceMetric ( void )

inlineprotectedvirtual

Member Function Documentation

Evaluate() [1/3]

template<class TVector >

double itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::Evaluate ( const MeasurementVectorType & x ) const

virtual

Gets the distance between the origin and x.

Implements itk::Statistics::KernelInducedDistanceMetric< TVector >.

Evaluate() [2/3]

template<class TVector >

double itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::Evaluate ( const MeasurementVectorType & x1, const MeasurementVectorType & x2 ) const

virtual

Gets the distance between x1 and x2.

Implements itk::Statistics::KernelInducedDistanceMetric< TVector >.

Evaluate() [3/3]

template<class TVector >

double itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::Evaluate ( const ValueType & a, const ValueType & b ) const

virtual

Gets the coordinate distance between a and b. NOTE: a and b should be type of component.

Implements itk::Statistics::KernelInducedDistanceMetric< TVector >.

itkGetConstMacro() [1/3]

template<class TVector >

itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::itkGetConstMacro	(	A	,
		double	)

Get the a value.

itkGetConstMacro() [2/3]

template<class TVector >

itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::itkGetConstMacro	(	B	,
		double	)

Get the b value.

itkGetConstMacro() [3/3]

template<class TVector >

itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::itkGetConstMacro	(	Sigma	,
		double	)

Get the sigma value.

itkNewMacro()

template<class TVector >

itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::itkNewMacro

(

Self

)

Method for creation through the object factory.

itkSetClampMacro() [1/2]

template<class TVector >

itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::itkSetClampMacro	(	A	,
		double	,
		0.	0,
		itk::NumericTraits< double >	::max() )

Set the a value. This value must be greater than 0.

itkSetClampMacro() [2/2]

template<class TVector >

itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::itkSetClampMacro	(	B	,
		double	,
		1.	0,
		2.	0 )

Set the b value. This value is constrained between 1 and 2.

itkSetMacro()

template<class TVector >

itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::itkSetMacro	(	Sigma	,
		double	)

Set the sigma value.

itkTypeMacro()

template<class TVector >

itk::Statistics::GRBFKernelInducedDistanceMetric< TVector >::itkTypeMacro	(	GRBFKernelInducedDistanceMetric< TVector >	,
		KernelInducedDistanceMetric	)

Run-time type information (and related methods).

PrintSelf()

template<class TVector >

void itk::Statistics::GRBFKernelInducedDistanceMetric< 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:

• Toolkit/FuzzyCMeans/itkGRBFKernelInducedDistanceMetric.h