Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

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

#include <itkEuclideanDistance.h>

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

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

Collaboration graph
[legend]
List of all members.

Detailed Description

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

Euclidean distance function.

This class is derived from DistanceMetric class. In addition to the two Evaluate methods in the base class, this class has a method (Evaluate) to compute the coordinate distance between two vector component (not vectors), and a method to tell if a measurement vector is whithin the range (defined by a radius value) from the origin (set by SetOrigin mehtod).

The class can be templated over any container that holds data elements. The containter is expected to provide access to its elements with the [] operator. It must also implement a Size() that returns the length of the container. It must also contain a typedef "ValueType" that defines the data-type held by the container. (In other words it will support itk::Vector, FixedArray, Array ).

Recent API changes: The static const macro to get the length of a measurement vector, VectorLength has been removed to allow the length of a measurement vector to be specified at run time. Please use the function GetMeasurementVectorSize() instead.

Definition at line 52 of file itkEuclideanDistance.h.

Public Types

typedef SmartPointer< const
Self
ConstPointer
typedef TVector InputType
typedef Superclass::MeasurementVectorSizeType MeasurementVectorSizeType
typedef Array< double > OriginType
typedef double OutputType
typedef SmartPointer< SelfPointer
typedef EuclideanDistance Self
typedef DistanceMetric< TVector > Superclass
typedef TVector::ValueType ValueType

Public Member Functions

virtual LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
double Evaluate (const ValueType &a, const ValueType &b) const
double Evaluate (const TVector &x1, const TVector &x2) const
double Evaluate (const TVector &x) const
CommandGetCommand (unsigned long tag)
bool GetDebug () const
const MetaDataDictionaryGetMetaDataDictionary (void) const
MetaDataDictionaryGetMetaDataDictionary (void)
virtual unsigned long GetMTime () const
virtual const char * GetNameOfClass () const
virtual int GetReferenceCount () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &) const
void InvokeEvent (const EventObject &)
bool IsWithinRange (const TVector &x, const double radius) const
virtual void Modified () const
void Print (std::ostream &os, Indent indent=0) const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
virtual void SetMeasurementVectorSize (const MeasurementVectorSizeType)
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
unsigned long AddObserver (const EventObject &event, Command *) const
unsigned long AddObserver (const EventObject &event, Command *)
virtual MeasurementVectorSizeType GetMeasurementVectorSize () const
virtual void SetMeasurementVectorSize (MeasurementVectorSizeType _arg)
virtual const OriginTypeGetOrigin ()
void SetOrigin (const OriginType &x)

Static Public Member Functions

static void BreakOnError ()
static Pointer New ()
static bool GetGlobalWarningDisplay ()
static void GlobalWarningDisplayOff ()
static void GlobalWarningDisplayOn ()
static void SetGlobalWarningDisplay (bool flag)

Protected Member Functions

 EuclideanDistance ()
bool PrintObservers (std::ostream &os, Indent indent) const
void PrintSelf (std::ostream &os, Indent indent) const
virtual ~EuclideanDistance ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const

Protected Attributes

MeasurementVectorSizeType m_MeasurementVectorSize
OriginType m_Origin
int m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock


Member Typedef Documentation

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

Reimplemented from itk::Statistics::MembershipFunctionBase< TVector >.

Definition at line 60 of file itkEuclideanDistance.h.

typedef TVector itk::FunctionBase< TVector , double >::InputType [inherited]

Input type

Definition at line 54 of file itkFunctionBase.h.

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

Typedef for the length of each measurement vector

Reimplemented from itk::Statistics::DistanceMetric< TVector >.

Definition at line 61 of file itkEuclideanDistance.h.

template<class TVector>
typedef Array< double > itk::Statistics::DistanceMetric< TVector >::OriginType [inherited]

Definition at line 66 of file itkDistanceMetric.h.

typedef double itk::FunctionBase< TVector , double >::OutputType [inherited]

Output type

Definition at line 60 of file itkFunctionBase.h.

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

Reimplemented from itk::Statistics::MembershipFunctionBase< TVector >.

Definition at line 59 of file itkEuclideanDistance.h.

template<class TVector>
typedef EuclideanDistance itk::Statistics::EuclideanDistance< TVector >::Self

Standard "Self" typedef.

Reimplemented from itk::Statistics::DistanceMetric< TVector >.

Definition at line 57 of file itkEuclideanDistance.h.

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

Reimplemented from itk::Statistics::DistanceMetric< TVector >.

Definition at line 58 of file itkEuclideanDistance.h.

template<class TVector>
typedef TVector::ValueType itk::Statistics::EuclideanDistance< TVector >::ValueType

Type of the component of a vector

Definition at line 67 of file itkEuclideanDistance.h.


Constructor & Destructor Documentation

template<class TVector>
itk::Statistics::EuclideanDistance< TVector >::EuclideanDistance (  )  [inline, protected]

Definition at line 87 of file itkEuclideanDistance.h.

template<class TVector>
virtual itk::Statistics::EuclideanDistance< TVector >::~EuclideanDistance (  )  [inline, protected, virtual]

Definition at line 88 of file itkEuclideanDistance.h.


Member Function Documentation

unsigned long itk::Object::AddObserver ( const EventObject event,
Command  
) const [inherited]

unsigned long itk::Object::AddObserver ( const EventObject event,
Command  
) [inherited]

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

static void itk::LightObject::BreakOnError (  )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual LightObject::Pointer itk::Object::CreateAnother (  )  const [virtual, inherited]

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

virtual void itk::Object::DebugOff (  )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (  )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (  )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

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

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

template<class TVector>
double itk::Statistics::EuclideanDistance< TVector >::Evaluate ( const TVector &  x1,
const TVector &  x2 
) const [virtual]

Gets the distance between x1 and x2

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

template<class TVector>
double itk::Statistics::EuclideanDistance< TVector >::Evaluate ( const TVector &  x  )  const [virtual]

Gets the distance between the origin and x

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

Command* itk::Object::GetCommand ( unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug (  )  const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay (  )  [static, inherited]

template<class TVector>
virtual MeasurementVectorSizeType itk::Statistics::MembershipFunctionBase< TVector >::GetMeasurementVectorSize (  )  const [virtual, inherited]

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void   )  const [inherited]

Returns:
A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void   )  [inherited]

Returns:
A reference to this objects MetaDataDictionary.
Warning:
This reference may be changed.

virtual unsigned long itk::Object::GetMTime (  )  const [virtual, inherited]

Return this objects modified time.

Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >, itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >, itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >, itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::ImageAdaptor< TImage, TAccessor >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::MeshSpatialObject< TMesh >, itk::SceneSpatialObject< TSpaceDimension >, itk::SpatialObject< TDimension >, itk::ImageAdaptor< TImage, itk::Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< itk::VectorImage< TPixelType, Dimension >, itk::Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, itk::PixelAccessor< TInternalType, TExternalType > >, itk::ImageAdaptor< TImage, itk::Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, itk::Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageSpatialObject< TDimension, unsigned char >, itk::SpatialObject< 3 >, and itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

template<class TVector>
virtual const char* itk::Statistics::EuclideanDistance< TVector >::GetNameOfClass (  )  const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::Statistics::DistanceMetric< TVector >.

template<class TVector>
virtual const OriginType& itk::Statistics::DistanceMetric< TVector >::GetOrigin (  )  [virtual, inherited]

virtual int itk::LightObject::GetReferenceCount (  )  const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 98 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff (  )  [inline, static, inherited]

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (  )  [inline, static, inherited]

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject event  )  const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent ( const EventObject  )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject  )  [inherited]

Call Execute on all the Commands observing this event id.

template<class TVector>
bool itk::Statistics::EuclideanDistance< TVector >::IsWithinRange ( const TVector &  x,
const double  radius 
) const

Returns true if the distance between x and the origin is less than radius

virtual void itk::Object::Modified (  )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Reimplemented in itk::NormalizeImageFilter< TInputImage, TOutputImage >, itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, itk::Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageAdaptor< itk::VectorImage< TPixelType, Dimension >, itk::Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, itk::PixelAccessor< TInternalType, TExternalType > >, itk::ImageAdaptor< TImage, itk::Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, itk::Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, itk::Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, and itk::ImageAdaptor< TImage, itk::Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TVector>
static Pointer itk::Statistics::EuclideanDistance< TVector >::New (  )  [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

void itk::LightObject::Print ( std::ostream &  os,
Indent  indent = 0 
) const [inherited]

Cause the object to print itself out.

Referenced by itk::WeakPointer< itk::ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader ( std::ostream &  os,
Indent  indent 
) const [protected, virtual, inherited]

bool itk::Object::PrintObservers ( std::ostream &  os,
Indent  indent 
) const [protected, inherited]

template<class TVector>
void itk::Statistics::DistanceMetric< TVector >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual, inherited]

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::Statistics::MembershipFunctionBase< TVector >.

virtual void itk::LightObject::PrintTrailer ( std::ostream &  os,
Indent  indent 
) const [protected, virtual, inherited]

virtual void itk::Object::Register (  )  const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (  )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

void itk::Object::SetDebug ( bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

static void itk::Object::SetGlobalWarningDisplay ( bool  flag  )  [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

template<class TVector>
virtual void itk::Statistics::MembershipFunctionBase< TVector >::SetMeasurementVectorSize ( MeasurementVectorSizeType  _arg  )  [virtual, inherited]

Set/Get Macros to set the length of each measurement vector.

template<class TVector>
virtual void itk::Statistics::DistanceMetric< TVector >::SetMeasurementVectorSize ( const   MeasurementVectorSizeType  )  [virtual, inherited]

Set the length of each measurement vector.

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary rhs  )  [inherited]

Returns:
Set the MetaDataDictionary

template<class TVector>
void itk::Statistics::DistanceMetric< TVector >::SetOrigin ( const OriginType x  )  [inherited]

Sets the origin point that will be used for the single point version Evaluate() function. This function is necessary part of implementing MembershipFunctionBase's Evaluate() interface

virtual void itk::Object::SetReferenceCount ( int   )  [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::Object::UnRegister (  )  const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.


Member Data Documentation

template<class TVector>
MeasurementVectorSizeType itk::Statistics::MembershipFunctionBase< TVector >::m_MeasurementVectorSize [protected, inherited]

Definition at line 74 of file itkMembershipFunctionBase.h.

template<class TVector>
OriginType itk::Statistics::DistanceMetric< TVector >::m_Origin [protected, inherited]

Definition at line 92 of file itkDistanceMetric.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 122 of file itkLightObject.h.


The documentation for this class was generated from the following file:
Generated at Mon Mar 12 12:00:51 2007 for ITK by doxygen 1.5.1 written by Dimitri van Heesch, © 1997-2000