quickly locate points in 3-space More...

#include <vtkPointLocator.h>

Inheritance diagram for vtkPointLocator:

Collaboration diagram for vtkPointLocator:

Public Types
typedef vtkIncrementalPointLocator	Superclass

Public Types inherited from vtkIncrementalPointLocator
typedef vtkAbstractPointLocator	Superclass

Public Types inherited from vtkAbstractPointLocator
typedef vtkLocator	Superclass

Public Types inherited from vtkLocator
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkPointLocator *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkIdType	FindClosestPoint (const double x[3])

virtual int	InitPointInsertion (vtkPoints *newPts, const double bounds[6])

virtual void	InsertPoint (vtkIdType ptId, const double x[3])

virtual vtkIdType	InsertNextPoint (const double x[3])

virtual int	InsertUniquePoint (const double x[3], vtkIdType &ptId)

virtual vtkIdType	FindClosestInsertedPoint (const double x[3])

virtual void	FindClosestNPoints (int N, const double x[3], vtkIdList *result)

virtual vtkIdList *	GetPointsInBucket (const double x[3], int ijk[3])


virtual void	SetDivisions (int, int, int)

virtual void	SetDivisions (int[3])

virtual int *	GetDivisions ()

virtual void	GetDivisions (int data[3])


virtual void	SetNumberOfPointsPerBucket (int)

virtual int	GetNumberOfPointsPerBucket ()


virtual vtkIdType	FindClosestPointWithinRadius (double radius, const double x[3], double &dist2)

virtual vtkIdType	FindClosestPointWithinRadius (double radius, const double x[3], double inputDataLength, double &dist2)


virtual int	InitPointInsertion (vtkPoints *newPts, const double bounds[6], vtkIdType estSize)


vtkIdType	IsInsertedPoint (double x, double y, double z)

virtual vtkIdType	IsInsertedPoint (const double x[3])


virtual void	FindDistributedPoints (int N, const double x[3], vtkIdList *result, int M)

virtual void	FindDistributedPoints (int N, double x, double y, double z, vtkIdList *result, int M)


virtual void	FindPointsWithinRadius (double R, const double x[3], vtkIdList *result)


virtual vtkPoints *	GetPoints ()


void	Initialize ()

void	FreeSearchStructure ()

void	BuildLocator ()

void	GenerateRepresentation (int level, vtkPolyData *pd)

Public Member Functions inherited from vtkIncrementalPointLocator
vtkIncrementalPointLocator *	NewInstance () const

Public Member Functions inherited from vtkAbstractPointLocator
vtkAbstractPointLocator *	NewInstance () const

vtkIdType	FindClosestPoint (double x, double y, double z)

void	FindClosestNPoints (int N, double x, double y, double z, vtkIdList *result)

void	FindPointsWithinRadius (double R, double x, double y, double z, vtkIdList *result)

virtual double *	GetBounds ()

virtual void	GetBounds (double *)

Public Member Functions inherited from vtkLocator
vtkLocator *	NewInstance () const

virtual void	Update ()

virtual void	SetDataSet (vtkDataSet *)

virtual vtkDataSet *	GetDataSet ()

virtual void	SetMaxLevel (int)

virtual int	GetMaxLevel ()

virtual int	GetLevel ()

virtual void	SetAutomatic (int)

virtual int	GetAutomatic ()

virtual void	AutomaticOn ()

virtual void	AutomaticOff ()

virtual void	SetTolerance (double)

virtual double	GetTolerance ()

virtual unsigned long	GetBuildTime ()

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkPointLocator *	New ()

static int	IsTypeOf (const char *type)

static vtkPointLocator *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkIncrementalPointLocator
static int	IsTypeOf (const char *type)

static vtkIncrementalPointLocator *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractPointLocator
static int	IsTypeOf (const char *type)

static vtkAbstractPointLocator *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkLocator
static int	IsTypeOf (const char *type)

static vtkLocator *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkPointLocator ()

virtual	~vtkPointLocator ()

void	GetBucketNeighbors (vtkNeighborPoints *buckets, const int ijk[3], const int ndivs[3], int level)

void	GetOverlappingBuckets (vtkNeighborPoints *buckets, const double x[3], const int ijk[3], double dist, int level)

void	GetOverlappingBuckets (vtkNeighborPoints *buckets, const double x[3], double dist, int prevMinLevel[3], int prevMaxLevel[3])

void	GenerateFace (int face, int i, int j, int k, vtkPoints pts, vtkCellArray polys)

double	Distance2ToBucket (const double x[3], const int nei[3])

double	Distance2ToBounds (const double x[3], const double bounds[6])


vtkIdType	GetBucketIndex (const double x[3])

void	GetBucketIndices (const double x[3], int ijk[3])

Protected Member Functions inherited from vtkIncrementalPointLocator
	vtkIncrementalPointLocator ()

virtual	~vtkIncrementalPointLocator ()

Protected Member Functions inherited from vtkAbstractPointLocator
	vtkAbstractPointLocator ()

virtual	~vtkAbstractPointLocator ()

Protected Member Functions inherited from vtkLocator
virtual void	ReportReferences (vtkGarbageCollector *)

	vtkLocator ()

	~vtkLocator ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkPoints *	Points

int	Divisions [3]

int	NumberOfPointsPerBucket

vtkIdList **	HashTable

vtkIdType	NumberOfBuckets

double	H [3]

double	InsertionTol2

vtkIdType	InsertionPointId

double	InsertionLevel

Protected Attributes inherited from vtkAbstractPointLocator
double	Bounds [6]

Protected Attributes inherited from vtkLocator
vtkDataSet *	DataSet

int	Automatic

double	Tolerance

int	MaxLevel

int	Level

vtkTimeStamp	BuildTime

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

quickly locate points in 3-space

vtkPointLocator is a spatial search object to quickly locate points in 3D. vtkPointLocator works by dividing a specified region of space into a regular array of "rectangular" buckets, and then keeping a list of points that lie in each bucket. Typical operation involves giving a position in 3D and finding the closest point.

vtkPointLocator has two distinct methods of interaction. In the first method, you supply it with a dataset, and it operates on the points in the dataset. In the second method, you supply it with an array of points, and the object operates on the array.

Warning: Many other types of spatial locators have been developed such as octrees and kd-trees. These are often more efficient for the operations described here.

See also: vtkCellPicker vtkPointPicker

Tests:: vtkPointLocator (Tests)

Definition at line 52 of file vtkPointLocator.h.

Member Typedef Documentation

typedef vtkIncrementalPointLocator vtkPointLocator::Superclass

Definition at line 59 of file vtkPointLocator.h.

Constructor & Destructor Documentation

vtkPointLocator::vtkPointLocator ( )

protected

virtual vtkPointLocator::~vtkPointLocator ( )

protectedvirtual

Member Function Documentation

static vtkPointLocator* vtkPointLocator::New ( )

static

Construct with automatic computation of divisions, averaging 25 points per bucket.

static int vtkPointLocator::IsTypeOf ( const char * type )

static

virtual int vtkPointLocator::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkIncrementalPointLocator.

Reimplemented in vtkNonMergingPointLocator, vtkSMPMergePoints, and vtkMergePoints.

static vtkPointLocator* vtkPointLocator::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkPointLocator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkIncrementalPointLocator.

Reimplemented in vtkNonMergingPointLocator, vtkSMPMergePoints, and vtkMergePoints.

vtkPointLocator* vtkPointLocator::NewInstance ( ) const

void vtkPointLocator::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

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 vtkIncrementalPointLocator.

Reimplemented in vtkSMPMergePoints.

virtual void vtkPointLocator::SetDivisions	(	int	,
		int	,
		int
	)

virtual

Set the number of divisions in x-y-z directions.

virtual void vtkPointLocator::SetDivisions ( int [3] )

virtual

Set the number of divisions in x-y-z directions.

virtual int* vtkPointLocator::GetDivisions ( )

virtual

Set the number of divisions in x-y-z directions.

virtual void vtkPointLocator::GetDivisions ( int data[3] )

virtual

Set the number of divisions in x-y-z directions.

virtual void vtkPointLocator::SetNumberOfPointsPerBucket ( int )

virtual

Specify the average number of points in each bucket.

virtual int vtkPointLocator::GetNumberOfPointsPerBucket ( )

virtual

Specify the average number of points in each bucket.

virtual vtkIdType vtkPointLocator::FindClosestPoint ( const double x[3] )

virtual

Given a position x, return the id of the point closest to it. Alternative method requires separate x-y-z values. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.

Implements vtkAbstractPointLocator.

virtual vtkIdType vtkPointLocator::FindClosestPointWithinRadius	(	double	radius,
		const double	x[3],
		double &	dist2
	)

virtual

Given a position x and a radius r, return the id of the point closest to the point in that radius. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first. dist2 returns the squared distance to the point.

Implements vtkAbstractPointLocator.

virtual vtkIdType vtkPointLocator::FindClosestPointWithinRadius	(	double	radius,
		const double	x[3],
		double	inputDataLength,
		double &	dist2
	)

virtual

Given a position x and a radius r, return the id of the point closest to the point in that radius. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first. dist2 returns the squared distance to the point.

virtual int vtkPointLocator::InitPointInsertion	(	vtkPoints *	newPts,
		const double	bounds[6]
	)

virtual

Initialize the point insertion process. The newPts is an object representing point coordinates into which incremental insertion methods place their data. Bounds are the box that the points lie in. Not thread safe.

Implements vtkIncrementalPointLocator.

virtual int vtkPointLocator::InitPointInsertion	(	vtkPoints *	newPts,
		const double	bounds[6],
		vtkIdType	estSize
	)

virtual

Initialize the point insertion process. The newPts is an object representing point coordinates into which incremental insertion methods place their data. Bounds are the box that the points lie in. Not thread safe.

Implements vtkIncrementalPointLocator.

virtual void vtkPointLocator::InsertPoint	(	vtkIdType	ptId,
		const double	x[3]
	)

virtual

Incrementally insert a point into search structure with a particular index value. You should use the method IsInsertedPoint() to see whether this point has already been inserted (that is, if you desire to prevent duplicate points). Before using this method you must make sure that newPts have been supplied, the bounds has been set properly, and that divs are properly set. (See InitPointInsertion().) Not thread safe.

Implements vtkIncrementalPointLocator.

virtual vtkIdType vtkPointLocator::InsertNextPoint ( const double x[3] )

virtual

Incrementally insert a point into search structure. The method returns the insertion location (i.e., point id). You should use the method IsInsertedPoint() to see whether this point has already been inserted (that is, if you desire to prevent duplicate points). Before using this method you must make sure that newPts have been supplied, the bounds has been set properly, and that divs are properly set. (See InitPointInsertion().) Not thread safe.

Implements vtkIncrementalPointLocator.

vtkIdType vtkPointLocator::IsInsertedPoint	(	double	x,
		double	y,
		double	z
	)

inlinevirtual

Determine whether point given by x[3] has been inserted into points list. Return id of previously inserted point if this is true, otherwise return -1. This method is thread safe.

Implements vtkIncrementalPointLocator.

Definition at line 128 of file vtkPointLocator.h.

virtual vtkIdType vtkPointLocator::IsInsertedPoint ( const double x[3] )

virtual

Determine whether point given by x[3] has been inserted into points list. Return id of previously inserted point if this is true, otherwise return -1. This method is thread safe.

Implements vtkIncrementalPointLocator.

Reimplemented in vtkNonMergingPointLocator, and vtkMergePoints.

virtual int vtkPointLocator::InsertUniquePoint	(	const double	x[3],
		vtkIdType &	ptId
	)

virtual

Determine whether point given by x[3] has been inserted into points list. Return 0 if point was already in the list, otherwise return 1. If the point was not in the list, it will be ADDED. In either case, the id of the point (newly inserted or not) is returned in the ptId argument. Note this combines the functionality of IsInsertedPoint() followed by a call to InsertNextPoint(). This method is not thread safe.

Implements vtkIncrementalPointLocator.

Reimplemented in vtkNonMergingPointLocator, and vtkMergePoints.

virtual vtkIdType vtkPointLocator::FindClosestInsertedPoint ( const double x[3] )

virtual

Given a position x, return the id of the point closest to it. This method is used when performing incremental point insertion. Note that -1 indicates that no point was found. This method is thread safe if BuildLocator() is directly or indirectly called from a single thread first.

Implements vtkIncrementalPointLocator.

virtual void vtkPointLocator::FindClosestNPoints	(	int	N,
		const double	x[3],
		vtkIdList *	result
	)

virtual

Find the closest N points to a position. This returns the closest N points to a position. A faster method could be created that returned N close points to a position, but necessarily the exact N closest. The returned points are sorted from closest to farthest. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.

Implements vtkAbstractPointLocator.

virtual void vtkPointLocator::FindDistributedPoints	(	int	N,
		const double	x[3],
		vtkIdList *	result,
		int	M
	)

virtual

Find the closest points to a position such that each octant of space around the position contains at least N points. Loosely limit the search to a maximum number of points evaluated, M. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.

virtual void vtkPointLocator::FindDistributedPoints	(	int	N,
		double	x,
		double	y,
		double	z,
		vtkIdList *	result,
		int	M
	)

virtual

Find the closest points to a position such that each octant of space around the position contains at least N points. Loosely limit the search to a maximum number of points evaluated, M. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.

virtual void vtkPointLocator::FindPointsWithinRadius	(	double	R,
		const double	x[3],
		vtkIdList *	result
	)

virtual

Find all points within a specified radius R of position x. The result is not sorted in any specific manner. These methods are thread safe if BuildLocator() is directly or indirectly called from a single thread first.

Implements vtkAbstractPointLocator.

virtual vtkIdList* vtkPointLocator::GetPointsInBucket	(	const double	x[3],
		int	ijk[3]
	)

virtual

Given a position x, return the list of points in the bucket that contains the point. It is possible that NULL is returned. The user provides an ijk array that is the indices into the locator. This method is thread safe.

virtual vtkPoints* vtkPointLocator::GetPoints ( )

virtual

Provide an accessor to the points.

void vtkPointLocator::Initialize ( )

virtual

See vtkLocator interface documentation. These methods are not thread safe.

Implements vtkIncrementalPointLocator.

void vtkPointLocator::FreeSearchStructure ( )

virtual

See vtkLocator interface documentation. These methods are not thread safe.

Implements vtkAbstractPointLocator.

void vtkPointLocator::BuildLocator ( )

virtual

See vtkLocator interface documentation. These methods are not thread safe.

Implements vtkAbstractPointLocator.

void vtkPointLocator::GenerateRepresentation	(	int	level,
		vtkPolyData *	pd
	)

virtual

See vtkLocator interface documentation. These methods are not thread safe.

Implements vtkAbstractPointLocator.

void vtkPointLocator::GetBucketNeighbors	(	vtkNeighborPoints *	buckets,
		const int	ijk[3],
		const int	ndivs[3],
		int	level
	)

protected

void vtkPointLocator::GetOverlappingBuckets	(	vtkNeighborPoints *	buckets,
		const double	x[3],
		const int	ijk[3],
		double	dist,
		int	level
	)

protected

void vtkPointLocator::GetOverlappingBuckets	(	vtkNeighborPoints *	buckets,
		const double	x[3],
		double	dist,
		int	prevMinLevel[3],
		int	prevMaxLevel[3]
	)

protected

void vtkPointLocator::GenerateFace	(	int	face,
		int	i,
		int	j,
		int	k,
		vtkPoints *	pts,
		vtkCellArray *	polys
	)

protected

double vtkPointLocator::Distance2ToBucket	(	const double	x[3],
		const int	nei[3]
	)

protected

double vtkPointLocator::Distance2ToBounds	(	const double	x[3],
		const double	bounds[6]
	)

protected

vtkIdType vtkPointLocator::GetBucketIndex ( const double x[3] )

protected

Give the bucket index that point is located in.

void vtkPointLocator::GetBucketIndices	(	const double	x[3],
		int	ijk[3]
	)

protected

Give the bucket index that point is located in.

Member Data Documentation

vtkPoints* vtkPointLocator::Points

protected

Definition at line 227 of file vtkPointLocator.h.

int vtkPointLocator::Divisions[3]

protected

Definition at line 228 of file vtkPointLocator.h.

int vtkPointLocator::NumberOfPointsPerBucket

protected

Definition at line 229 of file vtkPointLocator.h.

vtkIdList** vtkPointLocator::HashTable

protected

Definition at line 230 of file vtkPointLocator.h.

vtkIdType vtkPointLocator::NumberOfBuckets

protected

Definition at line 231 of file vtkPointLocator.h.

double vtkPointLocator::H[3]

protected

Definition at line 232 of file vtkPointLocator.h.

double vtkPointLocator::InsertionTol2

protected

Definition at line 234 of file vtkPointLocator.h.

vtkIdType vtkPointLocator::InsertionPointId

protected

Definition at line 235 of file vtkPointLocator.h.

double vtkPointLocator::InsertionLevel

protected

Definition at line 237 of file vtkPointLocator.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/DataModel/vtkPointLocator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation