 |
ITK
4.3.0
Insight Segmentation and Registration Toolkit
|
|
ITK
4.3.0
Insight Segmentation and Registration Toolkit
|
#include <itkKdTreeGenerator.h>
Inheritance diagram for itk::Statistics::KdTreeGenerator< TSample >: Collaboration diagram for itk::Statistics::KdTreeGenerator< TSample >:This class generates a KdTree object without centroid information.
The KdTree object stores measurment vectors in a k-d tree structure that is a binary tree. The partition value is the median value of one of the k dimension (partition dimension). The partition dimension is determined by the spread of measurement values in each dimension. The partition dimension is the dimension has the widest spread. Our implementation of k-d tree doesn't have any construction or insertion logic. Users should use this class or the WeightedCentroidKdTreeGenerator class.
The number of the measurement vectors in a terminal node is set by the SetBucketSize method. If we use too small number for this, it might cause computational overhead to calculate bound conditions. However, too large number will cause more distance calculation between the measurement vectors in a terminal node and the query point.
To run this generator, users should provides the bucket size (SetBucketSize method) and the input sample (SetSample method). The Update method will run this generator. To get the resulting KdTree object, call the GetOutput method.
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. It is now obtained from the sample set as input. You may query this length using the function GetMeasurementVectorSize().
Definition at line 70 of file itkKdTreeGenerator.h.
Public Types | |
| typedef SmartPointer< const Self > | ConstPointer |
| typedef KdTreeType::KdTreeNodeType | KdTreeNodeType |
| typedef KdTree< TSample > | KdTreeType |
| typedef TSample::MeasurementType | MeasurementType |
| typedef unsigned int | MeasurementVectorSizeType |
| typedef TSample::MeasurementVectorType | MeasurementVectorType |
| typedef KdTreeType::Pointer | OutputPointer |
| typedef KdTreeType | OutputType |
| typedef SmartPointer< Self > | Pointer |
| typedef KdTreeGenerator | Self |
| typedef SubsampleType::Pointer | SubsamplePointer |
| typedef Subsample< TSample > | SubsampleType |
| 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 ::itk::LightObject::Pointer | CreateAnother (void) const |
| void | GenerateData () |
| virtual unsigned int | GetMeasurementVectorSize () const |
| virtual const char * | GetNameOfClass () const |
| OutputPointer | GetOutput () |
| void | SetBucketSize (unsigned int size) |
| void | SetSample (TSample *sample) |
| void | Update () |
| Public Member Functions inherited from itk::Object | |
| unsigned long | AddObserver (const EventObject &event, Command *) |
| unsigned long | AddObserver (const EventObject &event, Command *) const |
| 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 |
| void | RemoveAllObservers () |
| void | RemoveObserver (unsigned long tag) |
| void | SetDebug (bool debugFlag) const |
| void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
| virtual void | SetReferenceCount (int) |
| virtual void | UnRegister () 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 |
Static Public Member Functions | |
| static Pointer | New () |
| 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 Member Functions | |
| virtual KdTreeNodeType * | GenerateNonterminalNode (unsigned int beginIndex, unsigned int endIndex, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound, unsigned int level) |
| KdTreeNodeType * | GenerateTreeLoop (unsigned int beginIndex, unsigned int endIndex, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound, unsigned int level) |
| SubsamplePointer | GetSubsample () |
| KdTreeGenerator () | |
| void | PrintSelf (std::ostream &os, Indent indent) const |
| virtual | ~KdTreeGenerator () |
| 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 Member Functions | |
| KdTreeGenerator (const Self &) | |
| void | operator= (const Self &) |
Additional Inherited Members | |
| 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::KdTreeGenerator< TSample >::ConstPointer |
Definition at line 77 of file itkKdTreeGenerator.h.
| typedef KdTreeType::KdTreeNodeType itk::Statistics::KdTreeGenerator< TSample >::KdTreeNodeType |
Typedef for the k-d tree node type
Definition at line 102 of file itkKdTreeGenerator.h.
| typedef KdTree< TSample > itk::Statistics::KdTreeGenerator< TSample >::KdTreeType |
Typedef for the k-d tree
Definition at line 93 of file itkKdTreeGenerator.h.
| typedef TSample::MeasurementType itk::Statistics::KdTreeGenerator< TSample >::MeasurementType |
Definition at line 87 of file itkKdTreeGenerator.h.
| typedef unsigned int itk::Statistics::KdTreeGenerator< TSample >::MeasurementVectorSizeType |
Typedef for the length of each measurement vector
Definition at line 90 of file itkKdTreeGenerator.h.
| typedef TSample::MeasurementVectorType itk::Statistics::KdTreeGenerator< TSample >::MeasurementVectorType |
typedef alias for the source data container
Definition at line 83 of file itkKdTreeGenerator.h.
| typedef KdTreeType::Pointer itk::Statistics::KdTreeGenerator< TSample >::OutputPointer |
Typedef for the smart pointer to the k-d tree
Definition at line 99 of file itkKdTreeGenerator.h.
| typedef KdTreeType itk::Statistics::KdTreeGenerator< TSample >::OutputType |
Type alias for the k-d tree type
Definition at line 96 of file itkKdTreeGenerator.h.
| typedef SmartPointer< Self > itk::Statistics::KdTreeGenerator< TSample >::Pointer |
Definition at line 76 of file itkKdTreeGenerator.h.
| typedef KdTreeGenerator itk::Statistics::KdTreeGenerator< TSample >::Self |
Standard class typedefs
Definition at line 74 of file itkKdTreeGenerator.h.
| typedef SubsampleType::Pointer itk::Statistics::KdTreeGenerator< TSample >::SubsamplePointer |
Typedef for the smart pointer to the Subsample
Definition at line 108 of file itkKdTreeGenerator.h.
| typedef Subsample< TSample > itk::Statistics::KdTreeGenerator< TSample >::SubsampleType |
Typedef for the internal Subsample
Definition at line 105 of file itkKdTreeGenerator.h.
| typedef Object itk::Statistics::KdTreeGenerator< TSample >::Superclass |
Definition at line 75 of file itkKdTreeGenerator.h.
|
protected |
Constructor
|
inlineprotectedvirtual |
Destructor
Definition at line 141 of file itkKdTreeGenerator.h.
|
private |
|
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.
Reimplemented in itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >.
| void itk::Statistics::KdTreeGenerator< TSample >::GenerateData | ( | ) |
Runs this k-d tree construction algorithm.
|
protectedvirtual |
Nonterminal node generation routine
Reimplemented in itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >.
|
protected |
Tree generation loop
|
virtual |
Get macro to get the length of the measurement vectors that are being held in the 'sample' that is passed to this class
|
virtual |
Run-time type information (and related methods)
Reimplemented from itk::Object.
Reimplemented in itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >.
|
inline |
Returns the pointer to the generated k-d tree.
Definition at line 118 of file itkKdTreeGenerator.h.
|
inlineprotected |
Returns the smart pointer to the internal Subsample object.
Definition at line 146 of file itkKdTreeGenerator.h.
|
static |
Method for creation through the object factory.
|
private |
|
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::WeightedCentroidKdTreeGenerator< TSample >.
| void itk::Statistics::KdTreeGenerator< TSample >::SetBucketSize | ( | unsigned int | size | ) |
Sets the number of measurement vectors that can be stored in a terminal node.
| void itk::Statistics::KdTreeGenerator< TSample >::SetSample | ( | TSample * | sample | ) |
Sets the input sample that provides the measurement vectors.
|
inline |
Runs this k-d tree construction algorithm.
Definition at line 124 of file itkKdTreeGenerator.h.
|
private |
The number of measurement vectors that can be stored in a terminal node.
Definition at line 180 of file itkKdTreeGenerator.h.
|
private |
Length of a measurement vector
Definition at line 195 of file itkKdTreeGenerator.h.
|
private |
Pointer to the input (source) sample
Definition at line 171 of file itkKdTreeGenerator.h.
|
private |
Smart pointer to the internal Subsample object. This class needs a Subsample object because the partitioning process involves sorting and selection.
Definition at line 176 of file itkKdTreeGenerator.h.
|
private |
Temporary lower bound for the TreeGenerationLoop
Definition at line 186 of file itkKdTreeGenerator.h.
|
private |
Temporary mean for the TreeGenerationLoop
Definition at line 192 of file itkKdTreeGenerator.h.
|
private |
Temporary upper bound for the TreeGenerationLoop
Definition at line 189 of file itkKdTreeGenerator.h.
|
private |
Pointer to the resulting k-d tree.
Definition at line 183 of file itkKdTreeGenerator.h.
1.8.2
