ITK
4.6.0
Insight Segmentation and Registration Toolkit
|
#include <itkDistanceMetric.h>
this class declares common interfaces for distance functions.
As a function derived from FunctionBase, users use Evaluate method to get result.
To use this function users should first set the origin by calling SetOrigin() function, then call Evaluate() method with a point to get the distance between the origin point and the evaluation point.
Definition at line 47 of file itkDistanceMetric.h.
Public Types | |
typedef SmartPointer< const Self > | ConstPointer |
typedef unsigned int | MeasurementVectorSizeType |
typedef TVector | MeasurementVectorType |
typedef Array< double > | OriginType |
typedef SmartPointer< Self > | Pointer |
typedef DistanceMetric | Self |
typedef FunctionBase< TVector, double > | Superclass |
Public Types inherited from itk::FunctionBase< TVector, double > | |
typedef SmartPointer< const Self > | ConstPointer |
typedef TVector | InputType |
typedef double | OutputType |
typedef SmartPointer< Self > | Pointer |
typedef FunctionBase | Self |
typedef Object | Superclass |
Public Types inherited from itk::Object | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef Object | Self |
typedef LightObject | Superclass |
Public Types inherited from itk::LightObject | |
typedef SmartPointer< const Self > | ConstPointer |
typedef SmartPointer< Self > | Pointer |
typedef LightObject | Self |
Public Member Functions | |
virtual double | Evaluate (const MeasurementVectorType &x) const =0 |
virtual double | Evaluate (const MeasurementVectorType &x1, const MeasurementVectorType &x2) const =0 |
virtual MeasurementVectorSizeType | GetMeasurementVectorSize () const |
virtual const char * | GetNameOfClass () const |
virtual const OriginType & | GetOrigin () const |
virtual void | SetMeasurementVectorSize (MeasurementVectorSizeType s) |
void | SetOrigin (const OriginType &x) |
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 ITK_OVERRIDE |
virtual void | DebugOff () const |
virtual void | DebugOn () const |
Command * | GetCommand (unsigned long tag) |
bool | GetDebug () const |
MetaDataDictionary & | GetMetaDataDictionary (void) |
const MetaDataDictionary & | GetMetaDataDictionary (void) const |
virtual ModifiedTimeType | GetMTime () const |
virtual const TimeStamp & | GetTimeStamp () const |
bool | HasObserver (const EventObject &event) const |
void | InvokeEvent (const EventObject &) |
void | InvokeEvent (const EventObject &) const |
virtual void | Modified () const |
virtual void | Register () const ITK_OVERRIDE |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
virtual void | SetReferenceCount (int) ITK_OVERRIDE |
virtual void | UnRegister () const ITK_OVERRIDE |
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 |
Protected Member Functions | |
DistanceMetric () | |
void | PrintSelf (std::ostream &os, Indent indent) const |
virtual | ~DistanceMetric () |
Protected Member Functions inherited from itk::FunctionBase< TVector, double > | |
FunctionBase () | |
~FunctionBase () | |
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 | |
virtual LightObject::Pointer | InternalClone () const |
LightObject () | |
virtual void | PrintHeader (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Private Attributes | |
MeasurementVectorSizeType | m_MeasurementVectorSize |
OriginType | m_Origin |
Additional Inherited Members | |
Static Public Member Functions inherited from itk::Object | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool flag) |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
Protected Types inherited from itk::LightObject | |
typedef int | InternalReferenceCountType |
Protected Attributes inherited from itk::LightObject | |
InternalReferenceCountType | m_ReferenceCount |
SimpleFastMutexLock | m_ReferenceCountLock |
typedef SmartPointer< const Self > itk::Statistics::DistanceMetric< TVector >::ConstPointer |
Definition at line 54 of file itkDistanceMetric.h.
typedef unsigned int itk::Statistics::DistanceMetric< TVector >::MeasurementVectorSizeType |
declare Measurement vector component type Type used to represent the number of components oft he MeasurementVectorType
Definition at line 63 of file itkDistanceMetric.h.
typedef TVector itk::Statistics::DistanceMetric< TVector >::MeasurementVectorType |
declare the MeasurementVector type
Definition at line 57 of file itkDistanceMetric.h.
typedef Array< double > itk::Statistics::DistanceMetric< TVector >::OriginType |
Definition at line 66 of file itkDistanceMetric.h.
typedef SmartPointer< Self > itk::Statistics::DistanceMetric< TVector >::Pointer |
Definition at line 53 of file itkDistanceMetric.h.
typedef DistanceMetric itk::Statistics::DistanceMetric< TVector >::Self |
Standard typedefs
Definition at line 51 of file itkDistanceMetric.h.
typedef FunctionBase< TVector, double > itk::Statistics::DistanceMetric< TVector >::Superclass |
Definition at line 52 of file itkDistanceMetric.h.
|
protected |
|
inlineprotectedvirtual |
Definition at line 135 of file itkDistanceMetric.h.
|
pure virtual |
Gets the distance between the origin point and x. This function work with SetOrigin() function.
Implements itk::FunctionBase< TVector, double >.
Implemented in itk::Statistics::MahalanobisDistanceMetric< TVector >, itk::Statistics::ManhattanDistanceMetric< TVector >, itk::Statistics::EuclideanDistanceMetric< TVector >, itk::Statistics::EuclideanDistanceMetric< Array< double > >, and itk::Statistics::EuclideanSquareDistanceMetric< TVector >.
|
pure virtual |
Gets the distance between x1 and x2. This method is used by KdTreeKMeans estimators. When the estimator is refactored, this method should be removed. Distance between two measurement vectors can be computed by setting one of them as an origin of the distane and using the Evaluate method with a single argument
Implemented in itk::Statistics::MahalanobisDistanceMetric< TVector >, itk::Statistics::ManhattanDistanceMetric< TVector >, itk::Statistics::EuclideanDistanceMetric< TVector >, itk::Statistics::EuclideanDistanceMetric< Array< double > >, and itk::Statistics::EuclideanSquareDistanceMetric< TVector >.
|
virtual |
Get method for the length of the measurement vector
|
virtual |
Run-time type information (and related methods).
Reimplemented from itk::FunctionBase< TVector, double >.
Reimplemented in itk::Statistics::MahalanobisDistanceMetric< TVector >, itk::Statistics::ManhattanDistanceMetric< TVector >, itk::Statistics::EuclideanDistanceMetric< TVector >, itk::Statistics::EuclideanDistanceMetric< Array< double > >, and itk::Statistics::EuclideanSquareDistanceMetric< TVector >.
|
virtual |
|
protectedvirtual |
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::Object.
Reimplemented in itk::Statistics::MahalanobisDistanceMetric< TVector >.
|
inlinevirtual |
Set method for the length of the measurement vector
Reimplemented in itk::Statistics::MahalanobisDistanceMetric< TVector >.
Definition at line 93 of file itkDistanceMetric.h.
void itk::Statistics::DistanceMetric< TVector >::SetOrigin | ( | const OriginType & | x | ) |
Sets the origin point that will be used for the single point version Evaluate() function. This function is necessary part of implementing the Evaluate() interface. The argument of SetOrigin() must be of type DistanceMetric::OriginType, which in most cases will be different from the TVector type. This is necessary because often times the origin would be a mean, or a vector representative of a collection of vectors.
|
private |
Number of components in the MeasurementVectorType
Definition at line 143 of file itkDistanceMetric.h.
Referenced by itk::Statistics::DistanceMetric< Array< double > >::SetMeasurementVectorSize().
|
private |
Definition at line 140 of file itkDistanceMetric.h.