 |
ITK
4.0.0
Insight Segmentation and Registration Toolkit
|
|
ITK
4.0.0
Insight Segmentation and Registration Toolkit
|
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 >: Collaboration diagram for 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.
Definition at line 482 of file itkKdTree.h.
| typedef TSample::AbsoluteFrequencyType itk::Statistics::KdTree< TSample >::AbsoluteFrequencyType |
Definition at line 502 of file itkKdTree.h.
| typedef TSample::ConstIterator itk::Statistics::KdTree< TSample >::ConstIterator |
Definition at line 717 of file itkKdTree.h.
| typedef SmartPointer< const Self > itk::Statistics::KdTree< TSample >::ConstPointer |
Reimplemented from itk::Object.
Definition at line 489 of file itkKdTree.h.
| typedef EuclideanDistanceMetric< MeasurementVectorType > itk::Statistics::KdTree< TSample >::DistanceMetricType |
DistanceMetric type for the distance calculation and comparison
Definition at line 508 of file itkKdTree.h.
| typedef TSample::InstanceIdentifier itk::Statistics::KdTree< TSample >::InstanceIdentifier |
Definition at line 501 of file itkKdTree.h.
| typedef std::vector< InstanceIdentifier > itk::Statistics::KdTree< TSample >::InstanceIdentifierVectorType |
Definition at line 521 of file itkKdTree.h.
| typedef TSample::Iterator itk::Statistics::KdTree< TSample >::Iterator |
Definition at line 716 of file itkKdTree.h.
| typedef KdTreeNode<TSample> itk::Statistics::KdTree< TSample >::KdTreeNodeType |
Node type of the KdTree
Definition at line 514 of file itkKdTree.h.
| typedef TSample::MeasurementType itk::Statistics::KdTree< TSample >::MeasurementType |
Definition at line 500 of file itkKdTree.h.
| typedef unsigned int itk::Statistics::KdTree< TSample >::MeasurementVectorSizeType |
Definition at line 504 of file itkKdTree.h.
| typedef TSample::MeasurementVectorType itk::Statistics::KdTree< TSample >::MeasurementVectorType |
Definition at line 499 of file itkKdTree.h.
| 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 519 of file itkKdTree.h.
| typedef SmartPointer< Self > itk::Statistics::KdTree< TSample >::Pointer |
Reimplemented from itk::Object.
Definition at line 488 of file itkKdTree.h.
| typedef TSample itk::Statistics::KdTree< TSample >::SampleType |
typedef alias for the source data container
Definition at line 495 of file itkKdTree.h.
| typedef KdTree itk::Statistics::KdTree< TSample >::Self |
| typedef Object itk::Statistics::KdTree< TSample >::Superclass |
Reimplemented from itk::Object.
Definition at line 487 of file itkKdTree.h.
| itk::Statistics::KdTree< TSample >::KdTree | ( | ) | [protected] |
Constructor
| virtual itk::Statistics::KdTree< TSample >::~KdTree | ( | ) | [protected, virtual] |
Destructor: deletes the root node and the empty terminal node.
| itk::Statistics::KdTree< TSample >::KdTree | ( | const Self & | ) | [private] |
| bool itk::Statistics::KdTree< TSample >::BallWithinBounds | ( | const MeasurementVectorType & | , |
| MeasurementVectorType & | , | ||
| MeasurementVectorType & | , | ||
| double | |||
| ) | 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.
| bool itk::Statistics::KdTree< TSample >::BoundsOverlapBall | ( | const MeasurementVectorType & | , |
| MeasurementVectorType & | , | ||
| MeasurementVectorType & | , | ||
| double | |||
| ) | 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.
| virtual::itk::LightObject::Pointer itk::Statistics::KdTree< TSample >::CreateAnother | ( | void | ) | const [virtual] |
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::Object.
| void itk::Statistics::KdTree< TSample >::DeleteNode | ( | KdTreeNodeType * | ) |
Deletes the node recursively
| DistanceMetricType* itk::Statistics::KdTree< TSample >::GetDistanceMetric | ( | ) | [inline] |
Get the pointer to the distance metric.
Definition at line 672 of file itkKdTree.h.
| 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 633 of file itkKdTree.h.
| 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 666 of file itkKdTree.h.
| 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 658 of file itkKdTree.h.
| 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.
| virtual const char* itk::Statistics::KdTree< TSample >::GetNameOfClass | ( | ) | const [virtual] |
Run-time type information (and related methods)
Reimplemented from itk::Object.
| KdTreeNodeType* itk::Statistics::KdTree< TSample >::GetRoot | ( | ) | [inline] |
Returns the pointer to the root node.
Definition at line 651 of file itkKdTree.h.
| const TSample* itk::Statistics::KdTree< TSample >::GetSample | ( | ) | const [inline] |
Returns the pointer to the input sample
Definition at line 619 of file itkKdTree.h.
| int itk::Statistics::KdTree< TSample >::NearestNeighborSearchLoop | ( | const KdTreeNodeType * | , |
| const MeasurementVectorType & | , | ||
| MeasurementVectorType & | , | ||
| MeasurementVectorType & | , | ||
| NearestNeighbors & | |||
| ) | const [protected] |
search loop
| static Pointer itk::Statistics::KdTree< TSample >::New | ( | ) | [static] |
Method for creation through the object factory.
Reimplemented from itk::Object.
| void itk::Statistics::KdTree< TSample >::operator= | ( | const Self & | ) | [private] |
Mutex lock to protect modification to the reference count
Reimplemented from itk::Object.
| 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.
| void itk::Statistics::KdTree< TSample >::PlotTree | ( | KdTreeNodeType * | node, |
| std::ostream & | os = std::cout |
||
| ) | const |
Prints out the tree information
| 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.
| void itk::Statistics::KdTree< TSample >::PrintTree | ( | std::ostream & | ) | const |
Prints out the tree information
| void itk::Statistics::KdTree< TSample >::PrintTree | ( | KdTreeNodeType * | , |
| unsigned | int, | ||
| unsigned | int, | ||
| std::ostream & | os = std::cout |
||
| ) | const |
Prints out the tree information
| void itk::Statistics::KdTree< TSample >::Search | ( | const MeasurementVectorType & | , |
| double | , | ||
| InstanceIdentifierVectorType & | |||
| ) | const |
Searches the neighbors fallen into a hypersphere
| void itk::Statistics::KdTree< TSample >::Search | ( | const MeasurementVectorType & | , |
| unsigned | int, | ||
| InstanceIdentifierVectorType & | |||
| ) | const |
Searches the k-nearest neighbors
| int itk::Statistics::KdTree< TSample >::SearchLoop | ( | const KdTreeNodeType * | , |
| const MeasurementVectorType & | , | ||
| double | , | ||
| MeasurementVectorType & | , | ||
| MeasurementVectorType & | , | ||
| InstanceIdentifierVectorType & | |||
| ) | const [protected] |
search loop
| void itk::Statistics::KdTree< TSample >::SetBucketSize | ( | unsigned | int | ) |
Sets the number of measurement vectors that can be stored in a terminal node
| 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 640 of file itkKdTree.h.
| void itk::Statistics::KdTree< TSample >::SetSample | ( | const TSample * | ) |
Sets the input sample that provides the measurement vectors to the k-d tree
| SizeValueType itk::Statistics::KdTree< TSample >::Size | ( | void | ) | const [inline] |
Definition at line 624 of file itkKdTree.h.
int itk::Statistics::KdTree< TSample >::m_BucketSize [private] |
Number of measurement vectors can be stored in a terminal node.
Definition at line 746 of file itkKdTree.h.
DistanceMetricType::Pointer itk::Statistics::KdTree< TSample >::m_DistanceMetric [private] |
Distance metric smart pointer
Definition at line 755 of file itkKdTree.h.
KdTreeNodeType* itk::Statistics::KdTree< TSample >::m_EmptyTerminalNode [private] |
Pointer to the empty terminal node
Definition at line 752 of file itkKdTree.h.
MeasurementVectorSizeType itk::Statistics::KdTree< TSample >::m_MeasurementVectorSize [private] |
Measurement vector size
Definition at line 758 of file itkKdTree.h.
KdTreeNodeType* itk::Statistics::KdTree< TSample >::m_Root [private] |
Pointer to the root node
Definition at line 749 of file itkKdTree.h.
const TSample* itk::Statistics::KdTree< TSample >::m_Sample [private] |
Pointer to the input sample
Definition at line 743 of file itkKdTree.h.
1.7.4
