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

#include <itkPointLocator.h>

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

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

[legend]List of all members.

---

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.

Public Types
typedef BoundingBoxType::Pointer	BoundingBoxPointer
typedef BoundingBox< PointIdentifier, VPointDimension, CoordRepType, PointsContainer >	BoundingBoxType
typedef SmartPointer< const Self >	ConstPointer
typedef TCoordRep	CoordRepType
typedef SmartPointer< Self >	Pointer
typedef TPointIdentifier	PointIdentifier
typedef TPointsContainer	PointsContainer
typedef PointsContainer::Pointer	PointsContainerPointer
typedef Point< CoordRepType, VPointDimension >	PointType
typedef PointLocator	Self
typedef Object	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual unsigned long *	GetDivisions () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual unsigned long	GetNumberOfPointsPerBucket ()
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InitIncrementalPointInsertion (PointsContainer *newPts, BoundingBoxPointer bbox)
void	InitPointInsertion (PointsContainer *newPts, BoundingBoxPointer bbox)
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (PointDimension, unsigned int, VPointDimension)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
Set the number of divisions in each axis direction *virtual void	SetDivisions (unsigned long data[])
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
Specify the average number of points in each bucket *virtual void	SetNumberOfPointsPerBucket (unsigned long _arg)
virtual void	SetReferenceCount (int)
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
	PointLocator ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	~PointLocator ()
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

---

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

static void itk::LightObject::BreakOnError (   )  [static, inherited]

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

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]

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.

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

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.

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.

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

Get the value of the debug flag.

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]

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

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]

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

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.

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.

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

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

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

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.

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

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

Method for creation through the object factory. Reimplemented from itk::Object.

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

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.

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

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

Remove the observer with this tag value.

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

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

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >> Set the number of divisions in each axis direction* virtual void itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::SetDivisions (  unsigned long  data[]  )  [virtual]

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

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

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

template<typename TPointIdentifier = unsigned long, int VPointDimension = 3, typename TCoordRep = float, typename TPointsContainer = VectorContainer< TPointIdentifier,Point<TCoordRep,VPointDimension> >> Specify the average number of points in each bucket* virtual void itk::PointLocator< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::SetNumberOfPointsPerBucket (  unsigned long  _arg  )  [virtual]

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

---

Member Data Documentation

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 itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

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 itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkPointLocator.h

---