ITK  4.9.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::Statistics::WeightedCentroidKdTreeGenerator< TSample > Class Template Reference

#include <itkWeightedCentroidKdTreeGenerator.h>

+ Inheritance diagram for itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >:
+ Collaboration diagram for itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >:

Detailed Description

template<typename TSample>
class itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >

This class generates a KdTree object with 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 KdTreeGenerator class.

This class is derived from the KdTreeGenerator class. The only difference between this class and the KdTreeGenerator class is that the nonterminal node type of this class is KdTreeWeightedCentroidNonterminalNode and that of the KdTreeGenerator is KdTreeNonterminalNode. Therefore, the public interface is identical to each other. The nonterminal node generation routines differ.

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

See Also
KdTree, KdTreeNode, KdTreeWeightedCentroidNonterminalNode, KdTreeTerminalNode, KdTreeGenerator
Examples:
Examples/Statistics/KdTree.cxx, Examples/Statistics/KdTreeBasedKMeansClustering.cxx, Examples/Statistics/ScalarImageKmeansModelEstimator.cxx, WikiExamples/Statistics/KdTreeBasedKMeansClustering1D.cxx, and WikiExamples/Statistics/KdTreeBasedKMeansClustering3D.cxx.

Definition at line 66 of file itkWeightedCentroidKdTreeGenerator.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::KdTreeNodeType KdTreeNodeType
 
typedef Superclass::KdTreeType KdTreeType
 
typedef Superclass::MeasurementType MeasurementType
 
typedef
Superclass::MeasurementVectorType 
MeasurementVectorType
 
typedef SmartPointer< SelfPointer
 
typedef
WeightedCentroidKdTreeGenerator 
Self
 
typedef
Superclass::SubsamplePointer 
SubsamplePointer
 
typedef Superclass::SubsampleType SubsampleType
 
typedef KdTreeGenerator< TSample > Superclass
 
- Public Types inherited from itk::Statistics::KdTreeGenerator< TSample >
typedef SmartPointer< const SelfConstPointer
 
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< SelfPointer
 
typedef KdTreeGenerator Self
 
typedef SubsampleType::Pointer SubsamplePointer
 
typedef Subsample< TSample > SubsampleType
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::Statistics::KdTreeGenerator< TSample >
void GenerateData ()
 
virtual unsigned int GetMeasurementVectorSize () 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () 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::Statistics::KdTreeGenerator< TSample >
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 KdTreeNodeTypeGenerateNonterminalNode (unsigned int beginIndex, unsigned int endIndex, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound, unsigned int level) override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 WeightedCentroidKdTreeGenerator ()
 
virtual ~WeightedCentroidKdTreeGenerator ()
 
- Protected Member Functions inherited from itk::Statistics::KdTreeGenerator< TSample >
KdTreeNodeTypeGenerateTreeLoop (unsigned int beginIndex, unsigned int endIndex, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound, unsigned int level)
 
SubsamplePointer GetSubsample ()
 
 KdTreeGenerator ()
 
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

void operator= (const Self &) ITK_DELETE_FUNCTION
 
 WeightedCentroidKdTreeGenerator (const Self &) ITK_DELETE_FUNCTION
 

Private Attributes

MeasurementVectorType m_TempLowerBound
 
MeasurementVectorType m_TempMean
 
MeasurementVectorType m_TempUpperBound
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TSample >
typedef SmartPointer< const Self > itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::ConstPointer

Definition at line 74 of file itkWeightedCentroidKdTreeGenerator.h.

template<typename TSample >
typedef Superclass::KdTreeNodeType itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::KdTreeNodeType

Definition at line 88 of file itkWeightedCentroidKdTreeGenerator.h.

template<typename TSample >
typedef Superclass::KdTreeType itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::KdTreeType

Definition at line 87 of file itkWeightedCentroidKdTreeGenerator.h.

template<typename TSample >
typedef Superclass::MeasurementType itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::MeasurementType

Definition at line 84 of file itkWeightedCentroidKdTreeGenerator.h.

typedef alias for the source data container

Definition at line 80 of file itkWeightedCentroidKdTreeGenerator.h.

template<typename TSample >
typedef SmartPointer< Self > itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::Pointer

Definition at line 73 of file itkWeightedCentroidKdTreeGenerator.h.

Standard class typedefs

Definition at line 71 of file itkWeightedCentroidKdTreeGenerator.h.

template<typename TSample >
typedef Superclass::SubsamplePointer itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::SubsamplePointer

Definition at line 86 of file itkWeightedCentroidKdTreeGenerator.h.

template<typename TSample >
typedef Superclass::SubsampleType itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::SubsampleType

Definition at line 85 of file itkWeightedCentroidKdTreeGenerator.h.

template<typename TSample >
typedef KdTreeGenerator< TSample > itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::Superclass

Definition at line 72 of file itkWeightedCentroidKdTreeGenerator.h.

Constructor & Destructor Documentation

template<typename TSample >
itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::WeightedCentroidKdTreeGenerator ( )
protected

Constructor

template<typename TSample >
virtual itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::~WeightedCentroidKdTreeGenerator ( )
inlineprotectedvirtual

Destructor

Definition at line 95 of file itkWeightedCentroidKdTreeGenerator.h.

template<typename TSample >
itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::WeightedCentroidKdTreeGenerator ( const Self )
private

Member Function Documentation

template<typename TSample >
virtual::itk::LightObject::Pointer itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::CreateAnother ( ) 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::Statistics::KdTreeGenerator< TSample >.

template<typename TSample >
virtual KdTreeNodeType* itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::GenerateNonterminalNode ( unsigned int  beginIndex,
unsigned int  endIndex,
MeasurementVectorType lowerBound,
MeasurementVectorType upperBound,
unsigned int  level 
)
overrideprotectedvirtual

Nonterminal node generation routine

Reimplemented from itk::Statistics::KdTreeGenerator< TSample >.

template<typename TSample >
virtual const char* itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods)

Reimplemented from itk::Statistics::KdTreeGenerator< TSample >.

template<typename TSample >
static Pointer itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::New ( )
static

Method for creation through the object factory.

template<typename TSample >
void itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::operator= ( const Self )
private
template<typename TSample >
void itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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::KdTreeGenerator< TSample >.

Member Data Documentation

template<typename TSample >
MeasurementVectorType itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::m_TempLowerBound
private

Definition at line 112 of file itkWeightedCentroidKdTreeGenerator.h.

template<typename TSample >
MeasurementVectorType itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::m_TempMean
private

Definition at line 114 of file itkWeightedCentroidKdTreeGenerator.h.

template<typename TSample >
MeasurementVectorType itk::Statistics::WeightedCentroidKdTreeGenerator< TSample >::m_TempUpperBound
private

Definition at line 113 of file itkWeightedCentroidKdTreeGenerator.h.


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