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

#include <itkPointsLocator.h>

+ Inheritance diagram for itk::PointsLocator< TPointsContainer >:
+ Collaboration diagram for itk::PointsLocator< TPointsContainer >:

Detailed Description

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
class itk::PointsLocator< TPointsContainer >

Accelerate geometric searches for points.

This class accelerates the search for the closest point to a user-provided point, by using constructing a Kd-Tree structure for the PointSetContainer.

Definition at line 44 of file itkPointsLocator.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
TreeType::InstanceIdentifierVectorType 
NeighborsIdentifierType
 
typedef SmartPointer< SelfPointer
 
typedef
PointsContainer::ElementIdentifier 
PointIdentifier
 
typedef TPointsContainer PointsContainer
 
typedef
PointsContainer::ConstIterator 
PointsContainerConstIterator
 
typedef
PointsContainer::ConstPointer 
PointsContainerConstPointer
 
typedef PointsContainer::Iterator PointsContainerIterator
 
typedef PointsContainer::Pointer PointsContainerPointer
 
typedef PointsContainer::Element PointType
 
typedef SampleAdaptorType::Pointer SampleAdaptorPointer
 
typedef
Statistics::VectorContainerToListSampleAdaptor
< PointsContainer
SampleAdaptorType
 
typedef PointsLocator Self
 
typedef Object Superclass
 
typedef TreeType::ConstPointer TreeConstPointer
 
typedef TreeGeneratorType::Pointer TreeGeneratorPointer
 
typedef
Statistics::KdTreeGenerator
< SampleAdaptorType
TreeGeneratorType
 
typedef
TreeGeneratorType::KdTreeType 
TreeType
 
- 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
 
void FindClosestNPoints (const PointType &, unsigned int, NeighborsIdentifierType &) const
 
PointIdentifier FindClosestPoint (const PointType &query) const
 
void FindPointsWithinRadius (const PointType &, double, NeighborsIdentifierType &) const
 
virtual PointsContainerGetModifiablePoints ()
 
virtual const char * GetNameOfClass () const
 
virtual const PointsContainerGetPoints () const
 
void Initialize ()
 
void Search (const PointType &, unsigned int, NeighborsIdentifierType &) const
 
void Search (const PointType &, double, NeighborsIdentifierType &) const
 
virtual void SetPoints (PointsContainer *_arg)
 
- 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::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 ()
 

Static Public Attributes

static const unsigned int PointDimension = PointType::PointDimension
 

Protected Member Functions

 PointsLocator ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~PointsLocator ()
 
- 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
 
 PointsLocator (const Self &) ITK_DELETE_FUNCTION
 

Private Attributes

TreeGeneratorPointer m_KdTreeGenerator
 
PointsContainerPointer m_Points
 
SampleAdaptorPointer m_SampleAdaptor
 
TreeConstPointer m_Tree
 

Additional Inherited Members

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

Member Typedef Documentation

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
typedef SmartPointer<const Self> itk::PointsLocator< TPointsContainer >::ConstPointer

Definition at line 51 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
typedef TreeType::InstanceIdentifierVectorType itk::PointsLocator< TPointsContainer >::NeighborsIdentifierType

Definition at line 83 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
typedef SmartPointer<Self> itk::PointsLocator< TPointsContainer >::Pointer

Definition at line 50 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
typedef PointsContainer::ElementIdentifier itk::PointsLocator< TPointsContainer >::PointIdentifier

Definition at line 63 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
typedef TPointsContainer itk::PointsLocator< TPointsContainer >::PointsContainer

Hold on to the type information specified by the template parameters.

Definition at line 57 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
typedef PointsContainer::ConstIterator itk::PointsLocator< TPointsContainer >::PointsContainerConstIterator

Convenient typedefs.

Definition at line 70 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
typedef PointsContainer::ConstPointer itk::PointsLocator< TPointsContainer >::PointsContainerConstPointer

Definition at line 62 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
typedef PointsContainer::Iterator itk::PointsLocator< TPointsContainer >::PointsContainerIterator

Definition at line 71 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
typedef PointsContainer::Pointer itk::PointsLocator< TPointsContainer >::PointsContainerPointer

Definition at line 61 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
typedef PointsContainer::Element itk::PointsLocator< TPointsContainer >::PointType

Definition at line 64 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
typedef SampleAdaptorType::Pointer itk::PointsLocator< TPointsContainer >::SampleAdaptorPointer

Definition at line 76 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
typedef Statistics::VectorContainerToListSampleAdaptor<PointsContainer> itk::PointsLocator< TPointsContainer >::SampleAdaptorType

Type of the PointsContainer to List Adaptor.

Definition at line 75 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
typedef PointsLocator itk::PointsLocator< TPointsContainer >::Self

Standard class typedefs.

Definition at line 48 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
typedef Object itk::PointsLocator< TPointsContainer >::Superclass

Definition at line 49 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
typedef TreeType::ConstPointer itk::PointsLocator< TPointsContainer >::TreeConstPointer

Definition at line 82 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
typedef TreeGeneratorType::Pointer itk::PointsLocator< TPointsContainer >::TreeGeneratorPointer

Definition at line 80 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
typedef Statistics::KdTreeGenerator<SampleAdaptorType> itk::PointsLocator< TPointsContainer >::TreeGeneratorType

Types fo the KdTreeGenerator

Definition at line 79 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
typedef TreeGeneratorType::KdTreeType itk::PointsLocator< TPointsContainer >::TreeType

Definition at line 81 of file itkPointsLocator.h.

Constructor & Destructor Documentation

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
itk::PointsLocator< TPointsContainer >::PointsLocator ( )
protected
template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
itk::PointsLocator< TPointsContainer >::~PointsLocator ( )
protected
template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
itk::PointsLocator< TPointsContainer >::PointsLocator ( const Self )
private

Member Function Documentation

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
virtual::itk::LightObject::Pointer itk::PointsLocator< TPointsContainer >::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::Object.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
void itk::PointsLocator< TPointsContainer >::FindClosestNPoints ( const PointType ,
unsigned  int,
NeighborsIdentifierType  
) const

Find the closest N points. Returns the point ids.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
PointIdentifier itk::PointsLocator< TPointsContainer >::FindClosestPoint ( const PointType query) const

Find the closest point

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
void itk::PointsLocator< TPointsContainer >::FindPointsWithinRadius ( const PointType ,
double  ,
NeighborsIdentifierType  
) const

Find all the points within a specified radius. Returns the point ids.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
virtual PointsContainer* itk::PointsLocator< TPointsContainer >::GetModifiablePoints ( )
virtual

Set/Get the points from which the bounding box should be computed.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
virtual const char* itk::PointsLocator< TPointsContainer >::GetNameOfClass ( ) const
virtual

Standard part of every itk Object.

Reimplemented from itk::Object.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
virtual const PointsContainer* itk::PointsLocator< TPointsContainer >::GetPoints ( ) const
virtual
template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
void itk::PointsLocator< TPointsContainer >::Initialize ( )

Compute the kd-tree that will facilitate the querying the points.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
static Pointer itk::PointsLocator< TPointsContainer >::New ( )
static

Method for creation through the object factory.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
void itk::PointsLocator< TPointsContainer >::operator= ( const Self )
private
template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
virtual void itk::PointsLocator< TPointsContainer >::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::Object.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
void itk::PointsLocator< TPointsContainer >::Search ( const PointType ,
unsigned  int,
NeighborsIdentifierType  
) const

Find the k-nearest neighbors. Returns the point ids.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
void itk::PointsLocator< TPointsContainer >::Search ( const PointType ,
double  ,
NeighborsIdentifierType  
) const

Find all the points within a specified radius. Returns the point ids.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
virtual void itk::PointsLocator< TPointsContainer >::SetPoints ( PointsContainer _arg)
virtual

Set/Get the points from which the bounding box should be computed.

Member Data Documentation

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
TreeGeneratorPointer itk::PointsLocator< TPointsContainer >::m_KdTreeGenerator
private

Definition at line 123 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
PointsContainerPointer itk::PointsLocator< TPointsContainer >::m_Points
private

Definition at line 121 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
SampleAdaptorPointer itk::PointsLocator< TPointsContainer >::m_SampleAdaptor
private

Definition at line 122 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
TreeConstPointer itk::PointsLocator< TPointsContainer >::m_Tree
private

Definition at line 124 of file itkPointsLocator.h.

template<typename TPointsContainer = VectorContainer< IdentifierType, Point< float, 3 > >>
const unsigned int itk::PointsLocator< TPointsContainer >::PointDimension = PointType::PointDimension
static

Hold on to the dimensions specified by the template parameters.

Definition at line 67 of file itkPointsLocator.h.


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