Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer > Class Template Reference

Accelerate geometric searches for points. More...

#include <itkPointLocator.h>

Inheritance diagram for itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >:

Inheritance graph
[legend]
Collaboration diagram for itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef PointLocator Self
typedef Object Superclass
typedef SmartPointer< SelfPointer
typedef SmartPointer< const
Self
ConstPointer
typedef TPointIdentifier PointIdentifier
typedef TCoordRep CoordRepType
typedef TPointsContainer PointsContainer
typedef PointsContainer::Pointer PointsContainerPointer
typedef Point< CoordRepType,
VPointDimension > 
PointType
typedef BoundingBox< PointIdentifier,
VPointDimension, CoordRepType,
PointsContainer
BoundingBoxType
typedef BoundingBoxType::Pointer BoundingBoxPointer

Public Member Functions

virtual const char * GetNameOfClass () const
 itkStaticConstMacro (PointDimension, unsigned int, VPointDimension)
void InitPointInsertion (PointsContainer *newPts, BoundingBoxPointer bbox)
void InitIncrementalPointInsertion (PointsContainer *newPts, BoundingBoxPointer bbox)
virtual void SetDivisions (unsigned long data[])
virtual unsigned long * GetDivisions () const
virtual void SetNumberOfPointsPerBucket (unsigned long _arg)
virtual unsigned long GetNumberOfPointsPerBucket ()

Static Public Member Functions

Pointer New ()

Protected Member Functions

 PointLocator ()
 ~PointLocator ()
virtual void PrintSelf (std::ostream &os, Indent indent) const

Detailed Description

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
class itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >

Accelerate geometric searches for points.

This class accelerates the search for n-dimensional points. The class operates by using a regular n-dimensional hypercube lattice (e.g., a 2D grid, 3D volume, etc.) into which points are inserted. Each hypercube (also called a bucket) contains a list of points that are contained within it.

Template parameters for PointLocator:

TPointIdentifier = The type used to access a particular point (i.e., a point's id)

TCoordRep = Numerical type with which to represent each coordinate value.

VPointDimension = Geometric dimension of space.

Definition at line 59 of file itkPointLocator.h.


Member Typedef Documentation

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
typedef BoundingBoxType::Pointer itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::BoundingBoxPointer
 

Definition at line 88 of file itkPointLocator.h.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
typedef BoundingBox<PointIdentifier,VPointDimension, CoordRepType,PointsContainer> itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::BoundingBoxType
 

Some convenience typedefs.

Definition at line 87 of file itkPointLocator.h.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
typedef SmartPointer<const Self> itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::ConstPointer
 

Reimplemented from itk::Object.

Definition at line 66 of file itkPointLocator.h.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
typedef TCoordRep itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::CoordRepType
 

Definition at line 80 of file itkPointLocator.h.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
typedef SmartPointer<Self> itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::Pointer
 

Reimplemented from itk::Object.

Definition at line 65 of file itkPointLocator.h.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
typedef TPointIdentifier itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointIdentifier
 

Hold on to the type information specified by the template parameters. PointIdentifier is the type that the point handles are represented by.

Definition at line 79 of file itkPointLocator.h.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
typedef TPointsContainer itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointsContainer
 

Definition at line 81 of file itkPointLocator.h.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
typedef PointsContainer::Pointer itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointsContainerPointer
 

Definition at line 82 of file itkPointLocator.h.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
typedef Point< CoordRepType, VPointDimension > itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointType
 

Definition at line 83 of file itkPointLocator.h.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
typedef PointLocator itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::Self
 

Standard class typedefs.

Reimplemented from itk::Object.

Definition at line 63 of file itkPointLocator.h.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
typedef Object itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::Superclass
 

Reimplemented from itk::Object.

Definition at line 64 of file itkPointLocator.h.


Constructor & Destructor Documentation

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PointLocator  )  [protected]
 

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::~PointLocator  )  [protected]
 


Member Function Documentation

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
virtual unsigned long* itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetDivisions  )  const [virtual]
 

Set the number of divisions in each axis direction.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
virtual const char* itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetNameOfClass  )  const [virtual]
 

Standard part of every itk Object.

Reimplemented from itk::Object.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
virtual unsigned long itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetNumberOfPointsPerBucket  )  [virtual]
 

Specify the average number of points in each bucket.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
void itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::InitIncrementalPointInsertion PointsContainer newPts,
BoundingBoxPointer  bbox
 

Initialize the incremental point insertion process. Incremental point insertion is used to insert points one at a time into the locator. The supplied PointsContainer (newPts) collects the points that can be used by other objects later. Bounds are the box that the points lie in.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
void itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::InitPointInsertion PointsContainer newPts,
BoundingBoxPointer  bbox
 

Insert all the points contained in the PointsContainer newPts into the locator. Also supply a bounding box in which the points lie. This methods differs from InitIncrementalPointInsertion() in that assumes that all the points are inserted at once.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::itkStaticConstMacro PointDimension  ,
unsigned  int,
VPointDimension 
 

Capture template parameter information.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
Pointer itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::New  )  [static]
 

Method for creation through the object factory.

Reimplemented from itk::Object.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
virtual void itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::PrintSelf std::ostream &  os,
Indent  indent
const [protected, virtual]
 

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 TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
virtual void itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::SetDivisions unsigned long  data[]  )  [virtual]
 

Set the number of divisions in each axis direction.

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >>
virtual void itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::SetNumberOfPointsPerBucket unsigned long  _arg  )  [virtual]
 

Specify the average number of points in each bucket.


The documentation for this class was generated from the following file:
Generated at Thu May 25 02:06:05 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000