Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes

itk::Statistics::KdTree< TSample > Class Template Reference

This class provides methods for k-nearest neighbor search and related data structures for a k-d tree. More...

#include <itkKdTree.h>

Inheritance diagram for itk::Statistics::KdTree< TSample >:
Inheritance graph
[legend]
Collaboration diagram for itk::Statistics::KdTree< TSample >:
Collaboration graph
[legend]

List of all members.

Classes

class  NearestNeighbors
 data structure for storing k-nearest neighbor search result (k number of Neighbors) More...

Public Types

typedef
TSample::AbsoluteFrequencyType 
AbsoluteFrequencyType
typedef TSample::ConstIterator ConstIterator
typedef TSample::ConstIterator ConstIterator
typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< const SelfConstPointer
typedef EuclideanDistance
< MeasurementVectorType
DistanceMetricType
typedef
EuclideanDistanceMetric
< MeasurementVectorType
DistanceMetricType
typedef TSample::FrequencyType FrequencyType
typedef TSample::InstanceIdentifier InstanceIdentifier
typedef TSample::InstanceIdentifier InstanceIdentifier
typedef std::vector
< InstanceIdentifier
InstanceIdentifierVectorType
typedef std::vector
< InstanceIdentifier
InstanceIdentifierVectorType
typedef TSample::Iterator Iterator
typedef TSample::Iterator Iterator
typedef KdTreeNode< TSample > KdTreeNodeType
typedef KdTreeNode< TSample > KdTreeNodeType
typedef TSample::MeasurementType MeasurementType
typedef TSample::MeasurementType MeasurementType
typedef unsigned int MeasurementVectorSizeType
typedef unsigned int MeasurementVectorSizeType
typedef
TSample::MeasurementVectorType 
MeasurementVectorType
typedef
TSample::MeasurementVectorType 
MeasurementVectorType
typedef std::pair
< InstanceIdentifier, double > 
NeighborType
typedef std::pair
< InstanceIdentifier, double > 
NeighborType
typedef SmartPointer< SelfPointer
typedef SmartPointer< SelfPointer
typedef TSample SampleType
typedef TSample SampleType
typedef KdTree Self
typedef KdTree Self
typedef Object Superclass
typedef Object Superclass

Public Member Functions

bool BallWithinBounds (const MeasurementVectorType &query, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound, double radius) const
bool BallWithinBounds (const MeasurementVectorType &query, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound, double radius) const
Iterator Begin ()
Iterator Begin ()
ConstIterator Begin () const
ConstIterator Begin () const
bool BoundsOverlapBall (const MeasurementVectorType &query, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound, double radius) const
bool BoundsOverlapBall (const MeasurementVectorType &query, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound, double radius) const
virtual LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
void DeleteNode (KdTreeNodeType *node)
void DeleteNode (KdTreeNodeType *node)
Iterator End ()
Iterator End ()
ConstIterator End () const
ConstIterator End () const
CommandGetCommand (unsigned long tag)
bool GetDebug () const
DistanceMetricTypeGetDistanceMetric ()
DistanceMetricTypeGetDistanceMetric ()
KdTreeNodeTypeGetEmptyTerminalNode ()
KdTreeNodeTypeGetEmptyTerminalNode ()
AbsoluteFrequencyType GetFrequency (InstanceIdentifier id) const
FrequencyType GetFrequency (InstanceIdentifier id) const
const MeasurementVectorTypeGetMeasurementVector (InstanceIdentifier id) const
const MeasurementVectorTypeGetMeasurementVector (InstanceIdentifier id) const
virtual MeasurementVectorSizeType GetMeasurementVectorSize () const
virtual MeasurementVectorSizeType GetMeasurementVectorSize () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long GetMTime () const
virtual const char * GetNameOfClass () const
virtual const char * GetNameOfClass () const
int GetNumberOfVisits () const
int GetNumberOfVisits () const
virtual int GetReferenceCount () const
KdTreeNodeTypeGetRoot ()
KdTreeNodeTypeGetRoot ()
const TSample * GetSample () const
const TSample * GetSample () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &) const
void InvokeEvent (const EventObject &)
virtual void Modified () const
void PlotTree (std::ostream &os) const
void PlotTree (KdTreeNodeType *node, std::ostream &os=std::cout) const
void PlotTree (std::ostream &os) const
void PlotTree (KdTreeNodeType *node, std::ostream &os=std::cout) const
void Print (std::ostream &os, Indent indent=0) const
void PrintTree (std::ostream &os) const
void PrintTree (KdTreeNodeType *node, unsigned int level, unsigned int activeDimension, std::ostream &os=std::cout) const
void PrintTree (std::ostream &os) const
void PrintTree (KdTreeNodeType *node, unsigned int level, unsigned int activeDimension, std::ostream &os=std::cout) const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void Search (const MeasurementVectorType &query, double radius, InstanceIdentifierVectorType &result) const
void Search (const MeasurementVectorType &query, unsigned int numberOfNeighborsRequested, InstanceIdentifierVectorType &result) const
void Search (const MeasurementVectorType &query, double radius, InstanceIdentifierVectorType &result) const
void Search (const MeasurementVectorType &query, unsigned int numberOfNeighborsRequested, InstanceIdentifierVectorType &result) const
void SetBucketSize (unsigned int size)
void SetBucketSize (unsigned int size)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
void SetSample (const TSample *sample)
void SetSample (const TSample *sample)
unsigned long Size () const
unsigned long Size () const
virtual void UnRegister () const

void SetRoot (KdTreeNodeType *root)

void SetRoot (KdTreeNodeType *root)

unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const

Static Public Member Functions

static void BreakOnError ()
static Pointer New ()
static Pointer New ()

static void SetGlobalWarningDisplay (bool flag)
static bool GetGlobalWarningDisplay ()
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()

Protected Types

typedef int InternalReferenceCountType

Protected Member Functions

 KdTree ()
 KdTree ()
int NearestNeighborSearchLoop (const KdTreeNodeType *node, const MeasurementVectorType &query, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound) const
int NearestNeighborSearchLoop (const KdTreeNodeType *node, const MeasurementVectorType &query, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound) const
bool PrintObservers (std::ostream &os, Indent indent) const
void PrintSelf (std::ostream &os, Indent indent) const
void PrintSelf (std::ostream &os, Indent indent) const
virtual ~KdTree ()
virtual ~KdTree ()

virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const

Protected Attributes

InternalReferenceCountType m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock



int SearchLoop (const KdTreeNodeType *node, const MeasurementVectorType &query, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound) const



int SearchLoop (const KdTreeNodeType *node, const MeasurementVectorType &query, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound) const

Detailed Description

template<class TSample>
class itk::Statistics::KdTree< TSample >

This class provides methods for k-nearest neighbor search and related data structures for a k-d tree.

An object of this class stores instance identifiers in a k-d tree that is a binary tree with childrens split along a dimension among k-dimensions. The dimension of the split (or partition) is determined for each nonterminal node that has two children. The split process is terminated when the node has no children (when the number of measurement vectors is less than or equal to the size set by the SetBucketSize. That is The split process is a recursive process in nature and in implementation. This implementation doesn't support dynamic insert and delete operations for the tree. Instead, we can use the KdTreeGenerator or WeightedCentroidKdTreeGenerator to generate a static KdTree object.

To search k-nearest neighbor, call the Search method with the query point in a k-d space and the number of nearest neighbors. The GetSearchResult method returns a pointer to a NearestNeighbors object with k-nearest neighbors.

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

See also:
KdTreeNode, KdTreeNonterminalNode, KdTreeWeightedCentroidNonterminalNode, KdTreeTerminalNode, KdTreeGenerator, WeightedCentroidKdTreeNode

Definition at line 375 of file Numerics/Statistics/itkKdTree.h.


Member Typedef Documentation

template<class TSample >
typedef TSample::AbsoluteFrequencyType itk::Statistics::KdTree< TSample >::AbsoluteFrequencyType

Definition at line 446 of file Review/Statistics/itkKdTree.h.

template<class TSample >
typedef TSample::ConstIterator itk::Statistics::KdTree< TSample >::ConstIterator

Definition at line 673 of file Review/Statistics/itkKdTree.h.

template<class TSample >
typedef TSample::ConstIterator itk::Statistics::KdTree< TSample >::ConstIterator

Definition at line 599 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
typedef SmartPointer<const Self> itk::Statistics::KdTree< TSample >::ConstPointer

Reimplemented from itk::Object.

Definition at line 382 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
typedef SmartPointer<const Self> itk::Statistics::KdTree< TSample >::ConstPointer

Reimplemented from itk::Object.

Definition at line 433 of file Review/Statistics/itkKdTree.h.

template<class TSample >
typedef EuclideanDistance< MeasurementVectorType > itk::Statistics::KdTree< TSample >::DistanceMetricType

DistanceMetric type for the distance calculation and comparison

Definition at line 401 of file Numerics/Statistics/itkKdTree.h.

DistanceMetric type for the distance calculation and comparison

Definition at line 452 of file Review/Statistics/itkKdTree.h.

template<class TSample >
typedef TSample::FrequencyType itk::Statistics::KdTree< TSample >::FrequencyType

Definition at line 395 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
typedef TSample::InstanceIdentifier itk::Statistics::KdTree< TSample >::InstanceIdentifier

Definition at line 394 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
typedef TSample::InstanceIdentifier itk::Statistics::KdTree< TSample >::InstanceIdentifier

Definition at line 445 of file Review/Statistics/itkKdTree.h.

template<class TSample >
typedef std::vector< InstanceIdentifier > itk::Statistics::KdTree< TSample >::InstanceIdentifierVectorType

Definition at line 414 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
typedef std::vector< InstanceIdentifier > itk::Statistics::KdTree< TSample >::InstanceIdentifierVectorType

Definition at line 465 of file Review/Statistics/itkKdTree.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

template<class TSample >
typedef TSample::Iterator itk::Statistics::KdTree< TSample >::Iterator

Definition at line 672 of file Review/Statistics/itkKdTree.h.

template<class TSample >
typedef TSample::Iterator itk::Statistics::KdTree< TSample >::Iterator

Definition at line 598 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
typedef KdTreeNode< TSample > itk::Statistics::KdTree< TSample >::KdTreeNodeType

Node type of the KdTree

Definition at line 407 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
typedef KdTreeNode< TSample > itk::Statistics::KdTree< TSample >::KdTreeNodeType

Node type of the KdTree

Definition at line 458 of file Review/Statistics/itkKdTree.h.

template<class TSample >
typedef TSample::MeasurementType itk::Statistics::KdTree< TSample >::MeasurementType

Definition at line 444 of file Review/Statistics/itkKdTree.h.

template<class TSample >
typedef TSample::MeasurementType itk::Statistics::KdTree< TSample >::MeasurementType

Definition at line 393 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
typedef unsigned int itk::Statistics::KdTree< TSample >::MeasurementVectorSizeType

Definition at line 448 of file Review/Statistics/itkKdTree.h.

template<class TSample >
typedef unsigned int itk::Statistics::KdTree< TSample >::MeasurementVectorSizeType

Definition at line 397 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
typedef TSample::MeasurementVectorType itk::Statistics::KdTree< TSample >::MeasurementVectorType

Definition at line 443 of file Review/Statistics/itkKdTree.h.

template<class TSample >
typedef TSample::MeasurementVectorType itk::Statistics::KdTree< TSample >::MeasurementVectorType

Definition at line 392 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
typedef std::pair< InstanceIdentifier, double > itk::Statistics::KdTree< TSample >::NeighborType

Neighbor type. The first element of the std::pair is the instance identifier and the second one is the distance between the measurement vector identified by the first element and the query point.

Definition at line 412 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
typedef std::pair< InstanceIdentifier, double > itk::Statistics::KdTree< TSample >::NeighborType

Neighbor type. The first element of the std::pair is the instance identifier and the second one is the distance between the measurement vector identified by the first element and the query point.

Definition at line 463 of file Review/Statistics/itkKdTree.h.

template<class TSample >
typedef SmartPointer<Self> itk::Statistics::KdTree< TSample >::Pointer

Reimplemented from itk::Object.

Definition at line 381 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
typedef SmartPointer<Self> itk::Statistics::KdTree< TSample >::Pointer

Reimplemented from itk::Object.

Definition at line 432 of file Review/Statistics/itkKdTree.h.

template<class TSample >
typedef TSample itk::Statistics::KdTree< TSample >::SampleType

typedef alias for the source data container

Definition at line 439 of file Review/Statistics/itkKdTree.h.

template<class TSample >
typedef TSample itk::Statistics::KdTree< TSample >::SampleType

typedef alias for the source data container

Definition at line 388 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
typedef KdTree itk::Statistics::KdTree< TSample >::Self

Standard class typedefs

Reimplemented from itk::Object.

Definition at line 430 of file Review/Statistics/itkKdTree.h.

template<class TSample >
typedef KdTree itk::Statistics::KdTree< TSample >::Self

Standard class typedefs

Reimplemented from itk::Object.

Definition at line 379 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
typedef Object itk::Statistics::KdTree< TSample >::Superclass

Reimplemented from itk::Object.

Definition at line 380 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
typedef Object itk::Statistics::KdTree< TSample >::Superclass

Reimplemented from itk::Object.

Definition at line 431 of file Review/Statistics/itkKdTree.h.


Constructor & Destructor Documentation

template<class TSample >
itk::Statistics::KdTree< TSample >::KdTree (  )  [protected]

Constructor

template<class TSample >
virtual itk::Statistics::KdTree< TSample >::~KdTree (  )  [protected, virtual]

Destructor: deletes the root node and the empty terminal node.

template<class TSample >
itk::Statistics::KdTree< TSample >::KdTree (  )  [protected]

Constructor

template<class TSample >
virtual itk::Statistics::KdTree< TSample >::~KdTree (  )  [protected, virtual]

Destructor: deletes the root node and the empty terminal node.


Member Function Documentation

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

unsigned long itk::Object::AddObserver ( const EventObject event,
Command  
) const [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

template<class TSample >
bool itk::Statistics::KdTree< TSample >::BallWithinBounds ( const MeasurementVectorType query,
MeasurementVectorType lowerBound,
MeasurementVectorType upperBound,
double  radius 
) const

Returns true if the intermediate k-nearest neighbors exist within the the bounding box defined by the lowerBound and the upperBound. Otherwise returns false. Returns false if the ball defined by the distance between the query point and the farthest neighbor touch the surface of the bounding box.

template<class TSample >
bool itk::Statistics::KdTree< TSample >::BallWithinBounds ( const MeasurementVectorType query,
MeasurementVectorType lowerBound,
MeasurementVectorType upperBound,
double  radius 
) const

Returns true if the intermediate k-nearest neighbors exist within the the bounding box defined by the lowerBound and the upperBound. Otherwise returns false. Returns false if the ball defined by the distance between the query point and the farthest neighbor touch the surface of the bounding box.

template<class TSample >
Iterator itk::Statistics::KdTree< TSample >::Begin ( void   )  [inline]

Definition at line 601 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
ConstIterator itk::Statistics::KdTree< TSample >::Begin ( void   )  const [inline]

Definition at line 613 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
Iterator itk::Statistics::KdTree< TSample >::Begin ( void   )  [inline]

Definition at line 675 of file Review/Statistics/itkKdTree.h.

template<class TSample >
ConstIterator itk::Statistics::KdTree< TSample >::Begin ( void   )  const [inline]

Definition at line 687 of file Review/Statistics/itkKdTree.h.

template<class TSample >
bool itk::Statistics::KdTree< TSample >::BoundsOverlapBall ( const MeasurementVectorType query,
MeasurementVectorType lowerBound,
MeasurementVectorType upperBound,
double  radius 
) const

Returns true if the ball defined by the distance between the query point and the farthest neighbor overlaps with the bounding box defined by the lower and the upper bounds.

template<class TSample >
bool itk::Statistics::KdTree< TSample >::BoundsOverlapBall ( const MeasurementVectorType query,
MeasurementVectorType lowerBound,
MeasurementVectorType upperBound,
double  radius 
) const

Returns true if the ball defined by the distance between the query point and the farthest neighbor overlaps with the bounding box defined by the lower and the upper bounds.

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]
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 TSample >
void itk::Statistics::KdTree< TSample >::DeleteNode ( KdTreeNodeType node  ) 

Deletes the node recursively

template<class TSample >
void itk::Statistics::KdTree< TSample >::DeleteNode ( KdTreeNodeType node  ) 

Deletes the node recursively

template<class TSample >
Iterator itk::Statistics::KdTree< TSample >::End ( void   )  [inline]

Definition at line 607 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
ConstIterator itk::Statistics::KdTree< TSample >::End ( void   )  const [inline]

Definition at line 619 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
Iterator itk::Statistics::KdTree< TSample >::End ( void   )  [inline]

Definition at line 681 of file Review/Statistics/itkKdTree.h.

template<class TSample >
ConstIterator itk::Statistics::KdTree< TSample >::End ( void   )  const [inline]

Definition at line 693 of file Review/Statistics/itkKdTree.h.

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.

template<class TSample >
DistanceMetricType* itk::Statistics::KdTree< TSample >::GetDistanceMetric (  )  [inline]

Get the pointer to the distance metric.

Definition at line 543 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
DistanceMetricType* itk::Statistics::KdTree< TSample >::GetDistanceMetric (  )  [inline]

Get the pointer to the distance metric.

Definition at line 613 of file Review/Statistics/itkKdTree.h.

template<class TSample >
KdTreeNodeType* itk::Statistics::KdTree< TSample >::GetEmptyTerminalNode (  )  [inline]

Returns the pointer to the empty terminal node. A KdTree object has a single empty terminal node in memory. when the split process has to create an empty terminal node, the single instance is reused for this case

Definition at line 575 of file Review/Statistics/itkKdTree.h.

template<class TSample >
KdTreeNodeType* itk::Statistics::KdTree< TSample >::GetEmptyTerminalNode (  )  [inline]

Returns the pointer to the empty terminal node. A KdTree object has a single empty terminal node in memory. when the split process has to create an empty terminal node, the single instance is reused for this case

Definition at line 513 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
AbsoluteFrequencyType itk::Statistics::KdTree< TSample >::GetFrequency ( InstanceIdentifier  id  )  const [inline]

Returns the frequency of the measurement vector identified by the instance identifier

Definition at line 607 of file Review/Statistics/itkKdTree.h.

template<class TSample >
FrequencyType itk::Statistics::KdTree< TSample >::GetFrequency ( InstanceIdentifier  id  )  const [inline]

Returns the frequency of the measurement vector identified by the instance identifier

Definition at line 539 of file Numerics/Statistics/itkKdTree.h.

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

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

template<class TSample >
const MeasurementVectorType& itk::Statistics::KdTree< TSample >::GetMeasurementVector ( InstanceIdentifier  id  )  const [inline]

Returns the measurement vector identified by the instance identifier that is an identifier defiend for the input sample

Definition at line 534 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
const MeasurementVectorType& itk::Statistics::KdTree< TSample >::GetMeasurementVector ( InstanceIdentifier  id  )  const [inline]

Returns the measurement vector identified by the instance identifier that is an identifier defiend for the input sample

Definition at line 600 of file Review/Statistics/itkKdTree.h.

template<class TSample >
virtual MeasurementVectorSizeType itk::Statistics::KdTree< TSample >::GetMeasurementVectorSize (  )  const [virtual]

Get Macro to get the length of a measurement vector in the KdTree. The length is obtained from the input sample.

template<class TSample >
virtual MeasurementVectorSizeType itk::Statistics::KdTree< TSample >::GetMeasurementVectorSize (  )  const [virtual]

Get Macro to get the length of a measurement vector in the KdTree. The length is obtained from the input sample.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void   )  [inherited]
Returns:
A reference to this objects MetaDataDictionary.
Warning:
This reference may be changed.
const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void   )  const [inherited]
Returns:
A constant reference to this objects MetaDataDictionary.
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::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::MeshSpatialObject< TMesh >, itk::SceneSpatialObject< TSpaceDimension >, itk::SpatialObject< TDimension >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, 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 TSample >
virtual const char* itk::Statistics::KdTree< TSample >::GetNameOfClass (  )  const [virtual]

Run-time type information (and related methods)

Reimplemented from itk::Object.

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

Run-time type information (and related methods)

Reimplemented from itk::Object.

template<class TSample >
int itk::Statistics::KdTree< TSample >::GetNumberOfVisits (  )  const [inline]

Returns the number of measurement vectors that have been visited to find the k-nearest neighbors.

Definition at line 558 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
int itk::Statistics::KdTree< TSample >::GetNumberOfVisits (  )  const [inline]

Returns the number of measurement vectors that have been visited to find the k-nearest neighbors.

Definition at line 630 of file Review/Statistics/itkKdTree.h.

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

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

template<class TSample >
KdTreeNodeType* itk::Statistics::KdTree< TSample >::GetRoot (  )  [inline]

Returns the pointer to the root node.

Definition at line 593 of file Review/Statistics/itkKdTree.h.

template<class TSample >
KdTreeNodeType* itk::Statistics::KdTree< TSample >::GetRoot (  )  [inline]

Returns the pointer to the root node.

Definition at line 529 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
const TSample* itk::Statistics::KdTree< TSample >::GetSample (  )  const [inline]

Returns the pointer to the input sample

Definition at line 561 of file Review/Statistics/itkKdTree.h.

template<class TSample >
const TSample* itk::Statistics::KdTree< TSample >::GetSample (  )  const [inline]

Returns the pointer to the input sample

Definition at line 503 of file Numerics/Statistics/itkKdTree.h.

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

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

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

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

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

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  )  [inherited]

Call Execute on all the Commands observing this event id.

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.

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::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, and itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, RankImageFilter< TInputImage, TInputImage, FlatStructuringElement< ::itk::GetImageDimension< TInputImage >::ImageDimension > > >.

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

template<class TSample >
int itk::Statistics::KdTree< TSample >::NearestNeighborSearchLoop ( const KdTreeNodeType node,
const MeasurementVectorType query,
MeasurementVectorType lowerBound,
MeasurementVectorType upperBound 
) const [protected]

search loop

template<class TSample >
int itk::Statistics::KdTree< TSample >::NearestNeighborSearchLoop ( const KdTreeNodeType node,
const MeasurementVectorType query,
MeasurementVectorType lowerBound,
MeasurementVectorType upperBound 
) const [protected]

search loop

template<class TSample >
static Pointer itk::Statistics::KdTree< TSample >::New (  )  [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TSample >
static Pointer itk::Statistics::KdTree< TSample >::New (  )  [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TSample >
void itk::Statistics::KdTree< TSample >::PlotTree ( std::ostream &  os  )  const

Draw out the tree information to a ostream using the format of the Graphviz dot tool.

template<class TSample >
void itk::Statistics::KdTree< TSample >::PlotTree ( KdTreeNodeType node,
std::ostream &  os = std::cout 
) const

Prints out the tree information

template<class TSample >
void itk::Statistics::KdTree< TSample >::PlotTree ( std::ostream &  os  )  const

Draw out the tree information to a ostream using the format of the Graphviz dot tool.

template<class TSample >
void itk::Statistics::KdTree< TSample >::PlotTree ( KdTreeNodeType node,
std::ostream &  os = std::cout 
) const

Prints out the tree information

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

Cause the object to print itself out.

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

virtual void itk::LightObject::PrintHeader ( 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.

bool itk::Object::PrintObservers ( std::ostream &  os,
Indent  indent 
) const [protected, inherited]
template<class TSample >
void itk::Statistics::KdTree< TSample >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

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.

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

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.

virtual void itk::LightObject::PrintTrailer ( 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.

template<class TSample >
void itk::Statistics::KdTree< TSample >::PrintTree ( KdTreeNodeType node,
unsigned int  level,
unsigned int  activeDimension,
std::ostream &  os = std::cout 
) const

Prints out the tree information

template<class TSample >
void itk::Statistics::KdTree< TSample >::PrintTree ( KdTreeNodeType node,
unsigned int  level,
unsigned int  activeDimension,
std::ostream &  os = std::cout 
) const

Prints out the tree information

template<class TSample >
void itk::Statistics::KdTree< TSample >::PrintTree ( std::ostream &  os  )  const

Prints out the tree information

template<class TSample >
void itk::Statistics::KdTree< TSample >::PrintTree ( std::ostream &  os  )  const

Prints out the tree information

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.

template<class TSample >
void itk::Statistics::KdTree< TSample >::Search ( const MeasurementVectorType query,
unsigned int  numberOfNeighborsRequested,
InstanceIdentifierVectorType result 
) const

Searches the k-nearest neighbors

template<class TSample >
void itk::Statistics::KdTree< TSample >::Search ( const MeasurementVectorType query,
double  radius,
InstanceIdentifierVectorType result 
) const

Searches the neighbors fallen into a hypersphere

template<class TSample >
void itk::Statistics::KdTree< TSample >::Search ( const MeasurementVectorType query,
double  radius,
InstanceIdentifierVectorType result 
) const

Searches the neighbors fallen into a hypersphere

template<class TSample >
void itk::Statistics::KdTree< TSample >::Search ( const MeasurementVectorType query,
unsigned int  numberOfNeighborsRequested,
InstanceIdentifierVectorType result 
) const

Searches the k-nearest neighbors

template<class TSample >
int itk::Statistics::KdTree< TSample >::SearchLoop ( const KdTreeNodeType node,
const MeasurementVectorType query,
MeasurementVectorType lowerBound,
MeasurementVectorType upperBound 
) const [protected]

search loop

template<class TSample >
int itk::Statistics::KdTree< TSample >::SearchLoop ( const KdTreeNodeType node,
const MeasurementVectorType query,
MeasurementVectorType lowerBound,
MeasurementVectorType upperBound 
) const [protected]

search loop

template<class TSample >
void itk::Statistics::KdTree< TSample >::SetBucketSize ( unsigned int  size  ) 

Sets the number of measurement vectors that can be stored in a terminal node

template<class TSample >
void itk::Statistics::KdTree< TSample >::SetBucketSize ( unsigned int  size  ) 

Sets the number of measurement vectors that can be stored in a terminal node

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().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary rhs  )  [inherited]
Returns:
Set the MetaDataDictionary
virtual void itk::Object::SetReferenceCount ( int   )  [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

template<class TSample >
void itk::Statistics::KdTree< TSample >::SetRoot ( KdTreeNodeType root  )  [inline]

Sets the root node of the KdTree that is a result of KdTreeGenerator or WeightedCentroidKdTreeGenerator.

Definition at line 518 of file Numerics/Statistics/itkKdTree.h.

template<class TSample >
void itk::Statistics::KdTree< TSample >::SetRoot ( KdTreeNodeType root  )  [inline]

Sets the root node of the KdTree that is a result of KdTreeGenerator or WeightedCentroidKdTreeGenerator.

Definition at line 582 of file Review/Statistics/itkKdTree.h.

template<class TSample >
void itk::Statistics::KdTree< TSample >::SetSample ( const TSample *  sample  ) 

Sets the input sample that provides the measurement vectors to the k-d tree

template<class TSample >
void itk::Statistics::KdTree< TSample >::SetSample ( const TSample *  sample  ) 

Sets the input sample that provides the measurement vectors to the k-d tree

template<class TSample >
unsigned long itk::Statistics::KdTree< TSample >::Size ( void   )  const [inline]

Definition at line 566 of file Review/Statistics/itkKdTree.h.

template<class TSample >
unsigned long itk::Statistics::KdTree< TSample >::Size ( void   )  const [inline]

Definition at line 506 of file Numerics/Statistics/itkKdTree.h.

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

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.


Member Data Documentation

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.


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

Generated at Tue Jul 13 2010 04:07:39 for ITK by doxygen 1.7.1 written by Dimitri van Heesch, © 1997-2000