Orfeo Toolbox  3.16
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Private 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 >:
+ Collaboration diagram for itk::Statistics::KdTree< TSample >:

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

Public Member Functions

unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const
bool BallWithinBounds (const MeasurementVectorType &query, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound, double radius) const
Iterator Begin ()
ConstIterator Begin () const
bool BoundsOverlapBall (const MeasurementVectorType &query, MeasurementVectorType &lowerBound, MeasurementVectorType &upperBound, double radius) const
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
void DeleteNode (KdTreeNodeType *node)
Iterator End ()
ConstIterator End () const
CommandGetCommand (unsigned long tag)
bool GetDebug () const
DistanceMetricTypeGetDistanceMetric ()
KdTreeNodeTypeGetEmptyTerminalNode ()
FrequencyType GetFrequency (InstanceIdentifier id) const
const MeasurementVectorTypeGetMeasurementVector (InstanceIdentifier id) const
virtual MeasurementVectorSizeType GetMeasurementVectorSize () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long GetMTime () const
virtual const char * GetNameOfClass () const
int GetNumberOfVisits () const
virtual int GetReferenceCount () const
KdTreeNodeTypeGetRoot ()
const TSample * GetSample () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void Modified () 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
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void Search (const MeasurementVectorType &query, unsigned int numberOfNeighborsRequested, InstanceIdentifierVectorType &result) const
void Search (const MeasurementVectorType &query, double radius, InstanceIdentifierVectorType &result) const
void SetBucketSize (unsigned int size)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
void SetRoot (KdTreeNodeType *root)
void SetSample (const TSample *sample)
unsigned long Size () const
virtual void UnRegister () const

Static Public Member Functions

static void BreakOnError ()
static bool GetGlobalWarningDisplay ()
static void GlobalWarningDisplayOff ()
static void GlobalWarningDisplayOn ()
static Pointer New ()
static void SetGlobalWarningDisplay (bool flag)

Protected Types

typedef int InternalReferenceCountType

Protected Member Functions

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

Protected Attributes

InternalReferenceCountType m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock

Private Member Functions

 KdTree (const Self &)
void operator= (const Self &)

Private Attributes

int m_BucketSize
DistanceMetricType::Pointer m_DistanceMetric
KdTreeNodeTypem_EmptyTerminalNode
bool m_IsNearestNeighborSearch
MeasurementVectorType m_LowerBound
MeasurementVectorSizeType m_MeasurementVectorSize
NearestNeighbors m_NearestNeighbors
InstanceIdentifierVectorType m_Neighbors
int m_NumberOfVisits
KdTreeNodeTypem_Root
const TSample * m_Sample
double m_SearchRadius
bool m_StopSearch
NeighborType m_TempNeighbor
MeasurementVectorType m_UpperBound

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 373 of file itkKdTree.h.


Member Typedef Documentation

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

Definition at line 594 of file itkKdTree.h.

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

Reimplemented from itk::Object.

Definition at line 380 of file itkKdTree.h.

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

DistanceMetric type for the distance calculation and comparison

Definition at line 399 of file itkKdTree.h.

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

Definition at line 393 of file itkKdTree.h.

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

Definition at line 392 of file itkKdTree.h.

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

Definition at line 412 of file itkKdTree.h.

typedef int itk::LightObject::InternalReferenceCountType
protectedinherited

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

Definition at line 137 of file itkLightObject.h.

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

Definition at line 593 of file itkKdTree.h.

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

Node type of the KdTree

Definition at line 405 of file itkKdTree.h.

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

Definition at line 391 of file itkKdTree.h.

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

Definition at line 395 of file itkKdTree.h.

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

Definition at line 390 of file 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 410 of file itkKdTree.h.

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

Reimplemented from itk::Object.

Definition at line 379 of file itkKdTree.h.

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

typedef alias for the source data container

Definition at line 386 of file itkKdTree.h.

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

Standard class typedefs

Reimplemented from itk::Object.

Definition at line 377 of file itkKdTree.h.

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

Reimplemented from itk::Object.

Definition at line 378 of file itkKdTree.h.


Constructor & Destructor Documentation

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

Constructor

Definition at line 81 of file itkKdTree.txx.

template<class TSample >
itk::Statistics::KdTree< TSample >::~KdTree ( )
protectedvirtual

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

Definition at line 95 of file itkKdTree.txx.

template<class TSample >
itk::Statistics::KdTree< TSample >::KdTree ( const Self )
private

Member Function Documentation

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

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver ( const EventObject event,
Command cmd 
) const
inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

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

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.

Definition at line 470 of file itkKdTree.txx.

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

Definition at line 596 of file itkKdTree.h.

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

Definition at line 608 of file itkKdTree.h.

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

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.

Definition at line 494 of file itkKdTree.txx.

void itk::LightObject::BreakOnError ( )
staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 149 of file itkLightObject.cxx.

template<class TSample >
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::Object::DebugOff ( ) const
virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const
virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )
virtualinherited

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.

Delete a 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.

Definition at line 88 of file itkLightObject.cxx.

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

Definition at line 602 of file itkKdTree.h.

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

Definition at line 614 of file 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.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::Object::GetDebug ( ) const
inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

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

Get the pointer to the distance metric.

Definition at line 538 of file 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 509 of file 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 534 of file itkKdTree.h.

bool itk::Object::GetGlobalWarningDisplay ( )
staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

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 529 of file 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.

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void  )
inherited
Returns:
A reference to this objects MetaDataDictionary.
Warning:
This reference may be changed.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 532 of file itkObject.cxx.

References NULL.

Referenced by otb::RenderingImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData(), itk::Brains2MaskImageIO::CanReadFile(), otb::DataNode< TPrecision, VDimension, TValuePrecision >::CopyFieldList(), otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), otb::Image< TPixel, VImageDimension >::CopyInformation(), itk::GDCMImageIO::GetBodyPart(), itk::GDCMImageIO::GetInstitution(), itk::GDCMImageIO::GetManufacturer(), itk::GDCMImageIO::GetModality(), itk::GDCMImageIO::GetModel(), itk::GDCMImageIO::GetNumberOfSeriesInStudy(), itk::GDCMImageIO::GetNumberOfStudyRelatedSeries(), itk::GDCMImageIO::GetPatientAge(), itk::GDCMImageIO::GetPatientDOB(), itk::GDCMImageIO::GetPatientID(), itk::GDCMImageIO::GetPatientName(), itk::GDCMImageIO::GetPatientSex(), itk::GDCMImageIO::GetScanOptions(), itk::GDCMImageIO::GetStudyDate(), itk::GDCMImageIO::GetStudyDescription(), itk::GDCMImageIO::GetStudyID(), itk::GDCMImageIO::GetValueFromTag(), otb::GDALImageIO::InternalReadImageInformation(), itk::GDCMImageIO::InternalReadImageInformation(), otb::GDALImageIO::InternalWriteImageInformation(), otb::RAMDrivenAdaptativeStreamingManager< TImage >::PrepareStreaming(), itk::DICOMImageIO2::Read(), itk::DICOMImageIO2::ReadImageInformation(), itk::NrrdImageIO::ReadImageInformation(), otb::JPEG2000ImageIO::ReadImageInformation(), itk::MetaImageIO::ReadImageInformation(), itk::VoxBoCUBImageIO::ReadImageInformation(), itk::MRCImageIO::ReadImageInformation(), itk::IPLCommonImageIO::ReadImageInformation(), itk::PhilipsRECImageIO::ReadImageInformation(), itk::AnalyzeImageIO::ReadImageInformation(), itk::Bruker2DSEQImageIO::ReadImageInformation(), otb::ImageMetadataInterfaceBase::SetImage(), itk::NiftiImageIO::SetImageIOMetadataFromNIfTI(), otb::VectorDataToLabelImageFilter< TVectorData, TOutputImage >::SetOutputParametersFromImage(), itk::NrrdImageIO::Write(), itk::GDCMImageIO::Write(), and itk::PolygonGroupSpatialObjectXMLFileWriter::WriteFile().

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void  ) const
inherited
Returns:
A constant reference to this objects MetaDataDictionary.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 543 of file itkObject.cxx.

References NULL.

unsigned long itk::Object::GetMTime ( void  ) const
virtualinherited

Return this objects modified time.

Return the modification for this object.

Reimplemented in itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, otb::Accessor::VectorImageToASPixelAccessor< TImage::PixelType::ValueType > >, 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::ShiftScalePixelAccessor< 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::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::SpatialObject< TDimension >, itk::SpatialObject< 3 >, itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >, itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >, itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >, itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >, itk::DeformationFieldSource< TOutputImage >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::ImageSpatialObject< TDimension, unsigned char >, itk::MeshSpatialObject< TMesh >, and itk::SceneSpatialObject< TSpaceDimension >.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

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 553 of file itkKdTree.h.

virtual int itk::LightObject::GetReferenceCount ( ) const
inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

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

Returns the pointer to the root node.

Definition at line 524 of file itkKdTree.h.

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

Returns the pointer to the input sample

Definition at line 499 of file itkKdTree.h.

static void itk::Object::GlobalWarningDisplayOff ( )
inlinestaticinherited
static void itk::Object::GlobalWarningDisplayOn ( )
inlinestaticinherited

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.

Definition at line 467 of file itkObject.cxx.

void itk::Object::InvokeEvent ( const EventObject event)
inherited
void itk::Object::InvokeEvent ( const EventObject event) const
inherited

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

Definition at line 457 of file itkObject.cxx.

void itk::Object::Modified ( void  ) const
virtualinherited

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Make sure this object's modified time is greater than all others.

Reimplemented in otb::SVMModel< TValue, TLabel >, otb::SurfaceAdjacencyEffect6SCorrectionSchemeFilter< TInputImage, TOutputImage >, itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, otb::Accessor::VectorImageToASPixelAccessor< TImage::PixelType::ValueType > >, 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::ShiftScalePixelAccessor< 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 > >, otb::GenericRSTransform< TScalarType, NInputDimensions, NOutputDimensions >, otb::MeanShiftImageFilter< TInputImage, TOutputImage, TLabeledOutput, TBufferConverter >, otb::MeanShiftImageFilter< TInputImage, TOutputImage, TLabeledOutput, MeanShift::VectorBufferConverter >, otb::GCPsToRPCSensorModelImageFilter< TImage >, otb::Polygon< TValue >, otb::ImageRegionAdaptativeSplitter< VImageDimension >, otb::GenericInterpolateImageFunction< TInputImage, TFunction, TBoundaryCondition, TCoordRep >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, otb::PolyLineParametricPathWithValue< TValue, VDimension >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, otb::PolyLineParametricPathWithValue< TValue, 2 >, itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, otb::PhysicalToRPCSensorModelImageFilter< TImage >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, RankImageFilter< TInputImage, TInputImage, FlatStructuringElement< ::itk::GetImageDimension< TInputImage >::ImageDimension > > >, itk::NormalizeImageFilter< TInputImage, TOutputImage >, and otb::StatisticsXMLFileReader< TMeasurementVector >.

Definition at line 297 of file itkObject.cxx.

Referenced by otb::Wrapper::InputImageListParameter::AddFromFileName(), otb::Wrapper::InputVectorDataListParameter::AddFromFileName(), otb::Wrapper::InputImageListParameter::AddImage(), otb::Wrapper::InputImageListParameter::AddNullElement(), otb::Wrapper::InputVectorDataListParameter::AddNullElement(), otb::Wrapper::StringListParameter::AddNullElement(), otb::VectorDataModel::AddPointToGeometry(), otb::Wrapper::InputVectorDataListParameter::AddVectorData(), otb::Wrapper::InputImageListParameter::ClearValue(), otb::Wrapper::InputVectorDataListParameter::ClearValue(), otb::VectorDataModel::DeleteGeometry(), otb::VectorDataModel::EndGeometry(), otb::Wrapper::InputImageListParameter::Erase(), otb::Wrapper::InputVectorDataListParameter::Erase(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), otb::ImageWidget< TInputImage >::LinearInterpolationOff(), otb::ImageWidget< TInputImage >::LinearInterpolationOn(), itk::MatrixOffsetTransformBase< TScalarType, NInputDimensions, NOutputDimensions >::MatrixOffsetTransformBase(), otb::ogr::ImageReference< double >::Modified(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetAutoMinMax(), otb::BlendingImageFilter< TInputImage1, TInputImage2, TOutputImage >::SetBlendingFunction(), otb::ImageLayerGenerator< TImageLayer >::SetBlendingFunction(), otb::TileMapImageIO::SetCacheDirectory(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetChannelList(), itk::LBFGSBOptimizer::SetCostFunction(), itk::MINC2ImageIO::SetDimensionName(), itk::ImageIOBase::SetDimensions(), itk::ImageIOBase::SetDirection(), otb::Wrapper::InputImageListParameter::SetImageList(), itk::GDCMSeriesFileNames::SetInputDirectory(), otb::HistogramStatisticsFunction< TInputHistogram, TOutput >::SetInputHistogram(), otb::ImageToGenericRSOutputParameters< TImage >::SetInputKeywordList(), otb::Wrapper::InputVectorDataListParameter::SetListFromFileName(), otb::Wrapper::InputImageListParameter::SetListFromFileName(), otb::Function::RenderingFunction< TPixel, TRGBPixel >::SetListSample(), 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(), otb::Wrapper::InputImageListParameter::SetNthFileName(), otb::Wrapper::InputVectorDataListParameter::SetNthFileName(), itk::ImageIOBase::SetNumberOfDimensions(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ImageIOBase::SetOrigin(), otb::ImageToGenericRSOutputParameters< TImage >::SetOutputProjectionRef(), otb::MapProjectionAdapter::SetParameter(), otb::Function::GaussianRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetParameters(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::SetParameters(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), otb::ImageLayerGenerator< TImageLayer >::SetRenderingFunction(), otb::RenderingImageFilter< TInputImage, TOutputImage >::SetRenderingFunction(), itk::ImageIOBase::SetSpacing(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation(), otb::Wrapper::OutputFilenameParameter::SetValue(), otb::Wrapper::InputFilenameParameter::SetValue(), otb::Wrapper::ListViewParameter::SetValue(), otb::Wrapper::ChoiceParameter::SetValue(), otb::Wrapper::InputVectorDataListParameter::SetVectorDataList(), and otb::MapProjectionAdapter::SetWkt().

template<class TSample >
int itk::Statistics::KdTree< TSample >::NearestNeighborSearchLoop ( const KdTreeNodeType node,
const MeasurementVectorType query,
MeasurementVectorType lowerBound,
MeasurementVectorType upperBound 
) const
inlineprotected
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 >::operator= ( const Self )
private

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.

Definition at line 592 of file itkKdTree.txx.

template<class TSample >
void itk::Statistics::KdTree< TSample >::PlotTree ( KdTreeNodeType node,
std::ostream &  os = std::cout 
) const
void itk::LightObject::Print ( std::ostream &  os,
Indent  indent = 0 
) const
inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader ( std::ostream &  os,
Indent  indent 
) const
protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

bool itk::Object::PrintObservers ( std::ostream &  os,
Indent  indent 
) const
protectedinherited

Definition at line 478 of file itkObject.cxx.

template<class TSample >
void itk::Statistics::KdTree< TSample >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
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.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::Object.

Definition at line 108 of file itkKdTree.txx.

void itk::LightObject::PrintTrailer ( std::ostream &  os,
Indent  indent 
) const
protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

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

Prints out the tree information

Definition at line 534 of file itkKdTree.txx.

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

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

void itk::Object::RemoveAllObservers ( )
inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::Object::RemoveObserver ( unsigned long  tag)
inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

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

Searches the k-nearest neighbors

Definition at line 191 of file itkKdTree.txx.

References itk::MeasurementVectorTraits::SetLength().

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

Searches the neighbors fallen into a hypersphere

Definition at line 342 of file itkKdTree.txx.

References itk::MeasurementVectorTraits::SetLength().

template<class TSample >
int itk::Statistics::KdTree< TSample >::SearchLoop ( const KdTreeNodeType node,
const MeasurementVectorType query,
MeasurementVectorType lowerBound,
MeasurementVectorType upperBound 
) const
inlineprotected
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

Definition at line 182 of file itkKdTree.txx.

void itk::Object::SetDebug ( bool  debugFlag) const
inherited

Set the value of the debug flag. A non-zero value turns debugging on.

Definition at line 275 of file itkObject.cxx.

void itk::Object::SetGlobalWarningDisplay ( bool  val)
staticinherited

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

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary rhs)
inherited
void itk::Object::SetReferenceCount ( int  ref)
virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

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 514 of file 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

Definition at line 170 of file itkKdTree.txx.

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

Definition at line 502 of file itkKdTree.h.

void itk::Object::UnRegister ( ) const
virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

Referenced by itk::Object::New(), and itk::ObjectFactoryBase::UnRegisterFactory().


Member Data Documentation

template<class TSample >
int itk::Statistics::KdTree< TSample >::m_BucketSize
private

Number of measurement vectors can be stored in a terminal node.

Definition at line 647 of file itkKdTree.h.

template<class TSample >
DistanceMetricType::Pointer itk::Statistics::KdTree< TSample >::m_DistanceMetric
private

Distance metric smart pointer

Definition at line 656 of file itkKdTree.h.

template<class TSample >
KdTreeNodeType* itk::Statistics::KdTree< TSample >::m_EmptyTerminalNode
private

Pointer to the empty terminal node

Definition at line 653 of file itkKdTree.h.

template<class TSample >
bool itk::Statistics::KdTree< TSample >::m_IsNearestNeighborSearch
mutableprivate

Definition at line 658 of file itkKdTree.h.

template<class TSample >
MeasurementVectorType itk::Statistics::KdTree< TSample >::m_LowerBound
mutableprivate

Temporary lower bound in the SearchLoop.

Definition at line 668 of file itkKdTree.h.

template<class TSample >
MeasurementVectorSizeType itk::Statistics::KdTree< TSample >::m_MeasurementVectorSize
private

Measurement vector size

Definition at line 683 of file itkKdTree.h.

template<class TSample >
NearestNeighbors itk::Statistics::KdTree< TSample >::m_NearestNeighbors
mutableprivate

k-nearest neighbors

Definition at line 665 of file itkKdTree.h.

template<class TSample >
InstanceIdentifierVectorType itk::Statistics::KdTree< TSample >::m_Neighbors
mutableprivate

Definition at line 662 of file itkKdTree.h.

template<class TSample >
int itk::Statistics::KdTree< TSample >::m_NumberOfVisits
mutableprivate

Number of measurment vectors to find k-nearest neighbors.

Definition at line 674 of file itkKdTree.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount
mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock
mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

template<class TSample >
KdTreeNodeType* itk::Statistics::KdTree< TSample >::m_Root
private

Pointer to the root node

Definition at line 650 of file itkKdTree.h.

template<class TSample >
const TSample* itk::Statistics::KdTree< TSample >::m_Sample
private

Pointer to the input sample

Definition at line 644 of file itkKdTree.h.

template<class TSample >
double itk::Statistics::KdTree< TSample >::m_SearchRadius
mutableprivate

Definition at line 660 of file itkKdTree.h.

template<class TSample >
bool itk::Statistics::KdTree< TSample >::m_StopSearch
mutableprivate

Flag to stop the SearchLoop.

Definition at line 677 of file itkKdTree.h.

template<class TSample >
NeighborType itk::Statistics::KdTree< TSample >::m_TempNeighbor
mutableprivate

Temporary neighbor

Definition at line 680 of file itkKdTree.h.

template<class TSample >
MeasurementVectorType itk::Statistics::KdTree< TSample >::m_UpperBound
mutableprivate

Temporary upper bound in the SearchLoop.

Definition at line 671 of file itkKdTree.h.


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

Generated at Sun Feb 3 2013 03:02:09 for Orfeo Toolbox with doxygen 1.8.1.1