#include <itkKdTreeBasedKmeansEstimator.h>
Inheritance diagram for itk::Statistics::KdTreeBasedKmeansEstimator< TKdTree >:


It returns k mean vectors that are centroids of k-clusters using pre-generated k-d tree. k-d tree generation is done by the WeightedCentroidKdTreeGenerator. The tree construction needs to be done only once. The resulting k-d tree's non-terminal nodes that have their children nodes have vector sums of measurement vectors that belong to the nodes and the number of measurement vectors in addition to the typical node boundary information and pointers to children nodes. Instead of reassigning every measurement vector to the nearest cluster centroid and recalculating centroid, it maintain a set of cluster centroid candidates and using pruning algorithm that utilizes k-d tree, it updates the means of only relevant candidates at each iterations. It would be faster than traditional implementation of k-means algorithm. However, the k-d tree consumes a large amount of memory. The tree construction time and pruning algorithm's performance are important factors to the whole process's performance. If users want to use k-d tree for some purpose other than k-means estimation, they can use the KdTreeGenerator instead of the WeightedCentroidKdTreeGenerator. It will save the tree construction time and memory usage.
Note: There is a second implementation of k-means algorithm in ITK under the While the Kd tree based implementation is more time efficient, the GLA/LBG based algorithm is more memory efficient.
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 KdTree set as input. You may query this length using the function GetMeasurementVectorSize().
Definition at line 67 of file itkKdTreeBasedKmeansEstimator.h.
Public Types | |
| typedef KdTreeNodeType::CentroidType | CentroidType |
| typedef itk::hash_map< InstanceIdentifier, unsigned int > | ClusterLabelsType |
| typedef SmartPointer< const Self > | ConstPointer |
| typedef TKdTree::InstanceIdentifier | InstanceIdentifier |
| typedef std::vector< ParameterType > | InternalParametersType |
| typedef TKdTree::KdTreeNodeType | KdTreeNodeType |
| typedef TKdTree::MeasurementType | MeasurementType |
| typedef unsigned int | MeasurementVectorSizeType |
| typedef TKdTree::MeasurementVectorType | MeasurementVectorType |
| typedef Array< double > | ParametersType |
| typedef Array< double > | ParameterType |
| typedef SmartPointer< Self > | Pointer |
| typedef TKdTree::SampleType | SampleType |
| typedef KdTreeBasedKmeansEstimator | Self |
| typedef Object | Superclass |
Public Member Functions | |
| virtual LightObject::Pointer | CreateAnother () const |
| virtual void | DebugOff () const |
| virtual void | DebugOn () const |
| virtual void | Delete () |
| virtual const double & | GetCentroidPositionChanges () |
| virtual const double & | GetCentroidPositionChangesThreshold () |
| ClusterLabelsType * | GetClusterLabels () |
| Command * | GetCommand (unsigned long tag) |
| virtual const int & | GetCurrentIteration () |
| bool | GetDebug () const |
| TKdTree * | GetKdTree () |
| virtual const int & | GetMaximumIteration () |
| virtual const MeasurementVectorSizeType & | GetMeasurementVectorSize () |
| const MetaDataDictionary & | GetMetaDataDictionary (void) const |
| MetaDataDictionary & | GetMetaDataDictionary (void) |
| virtual unsigned long | GetMTime () const |
| virtual const char * | GetNameOfClass () const |
| ParametersType & | GetParameters () |
| virtual int | GetReferenceCount () const |
| bool | HasObserver (const EventObject &event) const |
| void | InvokeEvent (const EventObject &) const |
| void | InvokeEvent (const EventObject &) |
| virtual void | Modified () const |
| void | Print (std::ostream &os, Indent indent=0) const |
| virtual void | Register () const |
| void | RemoveAllObservers () |
| void | RemoveObserver (unsigned long tag) |
| Set Get the termination threshold for the squared sum *of changes in centroid postions after one iteration *virtual void | SetCentroidPositionChangesThreshold (double _arg) |
| void | SetDebug (bool debugFlag) const |
| Set Get the pointer to the KdTree *void | SetKdTree (TKdTree *tree) |
| Set Get maximum iteration limit *virtual void | SetMaximumIteration (int _arg) |
| void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
| void | SetParameters (ParametersType ¶ms) |
| virtual void | SetReferenceCount (int) |
| void | SetUseClusterLabels (bool flag) |
| void | StartOptimization () |
| virtual void | UnRegister () const |
Static Public Member Functions | |
| static void | BreakOnError () |
| static bool | GetGlobalWarningDisplay () |
| static void | GlobalWarningDisplayOff () |
| static void | GlobalWarningDisplayOn () |
| static Pointer | New () |
| This is a global flag that controls whether any warning *or error messages are displayed *static void | SetGlobalWarningDisplay (bool flag) |
Public Attributes | |
| 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 unsigned lon | AddObserver )(const EventObject &event, Command *) const |
| This is a global flag that controls whether any | debug |
Protected Member Functions | |
| void | CopyParameters (InternalParametersType &source, ParametersType &target) |
| void | CopyParameters (ParametersType &source, InternalParametersType &target) |
| void | CopyParameters (InternalParametersType &source, InternalParametersType &target) |
| void | FillClusterLabels (KdTreeNodeType *node, int closestIndex) |
| void | Filter (KdTreeNodeType *node, std::vector< int > validIndexes, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound) |
| int | GetClosestCandidate (ParameterType &measurements, std::vector< int > &validIndexes) |
| imports the measurements measurement vector data to the point *void | GetPoint (ParameterType &point, MeasurementVectorType measurements) |
| double | GetSumOfSquaredPositionChanges (InternalParametersType &previous, InternalParametersType ¤t) |
| bool | IsFarther (ParameterType &pointA, ParameterType &pointB, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound) |
| KdTreeBasedKmeansEstimator () | |
| bool | PrintObservers (std::ostream &os, Indent indent) const |
| void | PrintPoint (ParameterType &point) |
| void | PrintSelf (std::ostream &os, Indent indent) const |
| virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
| virtual | ~KdTreeBasedKmeansEstimator () |
Protected Attributes | |
| int | m_ReferenceCount |
| SimpleFastMutexLock | m_ReferenceCountLock |
| Methods invoked by virtual 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.*/virtual void PrintSelf(std voi | PrintHeader )(std::ostream &os, Indent indent) const |
Classes | |
| class | CandidateVector |
|
|||||
|
Definition at line 89 of file itkKdTreeBasedKmeansEstimator.h. |
|
|||||
|
Definition at line 145 of file itkKdTreeBasedKmeansEstimator.h. |
|
|||||
|
Reimplemented from itk::Object. Definition at line 75 of file itkKdTreeBasedKmeansEstimator.h. |
|
|||||
|
Definition at line 87 of file itkKdTreeBasedKmeansEstimator.h. |
|
|||||
|
Definition at line 98 of file itkKdTreeBasedKmeansEstimator.h. |
|
|||||
|
Types for the KdTree data structure Definition at line 81 of file itkKdTreeBasedKmeansEstimator.h. |
|
|||||
|
Definition at line 85 of file itkKdTreeBasedKmeansEstimator.h. |
|
|||||
|
Typedef for the length of a measurement vector Definition at line 93 of file itkKdTreeBasedKmeansEstimator.h. |
|
|||||
|
Definition at line 86 of file itkKdTreeBasedKmeansEstimator.h. |
|
|||||
|
Definition at line 99 of file itkKdTreeBasedKmeansEstimator.h. |
|
|||||
|
Parameters type. It defines a position in the optimization search space. Definition at line 97 of file itkKdTreeBasedKmeansEstimator.h. |
|
|||||
|
Reimplemented from itk::Object. Definition at line 74 of file itkKdTreeBasedKmeansEstimator.h. |
|
|||||
|
Definition at line 88 of file itkKdTreeBasedKmeansEstimator.h. |
|
|||||
|
Standard "Self" typedef. Reimplemented from itk::Object. Definition at line 72 of file itkKdTreeBasedKmeansEstimator.h. |
|
|||||
|
Reimplemented from itk::Object. Definition at line 73 of file itkKdTreeBasedKmeansEstimator.h. |
|
|||||||||
|
|
|
|||||||||
|
Definition at line 155 of file itkKdTreeBasedKmeansEstimator.h. |
|
|
This method is called when itkExceptionMacro executes. It allows the debugger to break on error. |
|
||||||||||||||||
|
copies the source parameters (k-means) to the target |
|
||||||||||||||||
|
copies the source parameters (k-means) to the target |
|
||||||||||||||||
|
copies the source parameters (k-means) to the target |
|
|
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. |
|
|
Turn debugging output off. |
|
|
Turn debugging output on. |
|
|
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. |
|
||||||||||||||||
|
|
|
||||||||||||||||||||||||
|
recursive pruning algorithm. the "validIndexes" vector contains only the indexes of the surviving candidates for the "node" |
|
|||||||||
|
|
|
|||||||||
|
|
|
||||||||||||||||
|
get the index of the closest candidate to the "measurements" measurement vector |
|
|||||||||
|
Definition at line 150 of file itkKdTreeBasedKmeansEstimator.h. |
|
|
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. |
|
|||||||||
|
|
|
|
Get the value of the debug flag. |
|
|
|
|
|||||||||
|
Definition at line 130 of file itkKdTreeBasedKmeansEstimator.h. |
|
|||||||||
|
|
|
|||||||||
|
Get the length of measurement vectors in the KdTree |
|
|
|
|
|
|
|
|
|||||||||
|
Run-time type information (and related methods). Reimplemented from itk::Object. |
|
||||||||||
|
Get current position of the optimization. Definition at line 106 of file itkKdTreeBasedKmeansEstimator.h. |
|
||||||||||||||||
|
Definition at line 279 of file itkKdTreeBasedKmeansEstimator.h. |
|
|
Gets the reference count on this object. Definition at line 98 of file itkLightObject.h. |
|
||||||||||||||||
|
gets the sum of squared difference between the previous position and current postion of all centroid. This is the primary termination condition for this algorithm. If the return value is less than the value that was set by the SetCentroidPositionChangesThreshold method. |
|
|
Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay(). |
|
|
Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay(). |
|
|
Return true if an observer is registered for this event. |
|
|
Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object. |
|
|
Call Execute on all the Commands observing this event id. |
|
||||||||||||||||||||||||
|
returns true if the "pointA is farther than pointB to the boundary |
|
|
|||||||||
|
Method for creation through the object factory. Reimplemented from itk::Object. |
|
||||||||||||
|
Cause the object to print itself out. |
|
||||||||||||
|
|
|
||||||||||
|
Definition at line 289 of file itkKdTreeBasedKmeansEstimator.h. |
|
||||||||||||||||
|
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. |
|
||||||||||||
|
|
|
|
Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject. |
|
|
Remove all observers . |
|
|
Remove the observer with this tag value. |
|
||||||||||
|
|
|
|
Set the value of the debug flag. A non-zero value turns debugging on. |
|
|
Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn(). |
|
||||||||||
|
Definition at line 121 of file itkKdTreeBasedKmeansEstimator.h. References itk::MeasurementVectorTraits::SetLength(). |
|
||||||||||
|
|
|
|
|
|
||||||||||
|
Set the position to initialize the optimization. Definition at line 102 of file itkKdTreeBasedKmeansEstimator.h. |
|
|
Sets the reference count (use with care) Reimplemented from itk::LightObject. |
|
||||||||||
|
Definition at line 147 of file itkKdTreeBasedKmeansEstimator.h. |
|
|||||||||
|
Start optimization Optimization will stop when it meets either of two termination conditions, the maximum iteration limit or epsilon (minimal changes in squared sum of changes in centroid positions) |
|
|
Decrease the reference count (release by another object). Reimplemented from itk::LightObject. |
|
|
|
|
|
Definition at line 94 of file itkObject.h. |
|
|
Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h. |
|
|
Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h. |
|
|
|
1.4.2 written by Dimitri van Heesch,
© 1997-2000