vtkPointLocator Class Reference

#include <vtkPointLocator.h>

Inheritance diagram for vtkPointLocator:

[legend]

Collaboration diagram for vtkPointLocator:

[legend]

List of all members.

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 51 of file vtkPointLocator.h.


Public Types
typedef vtkIncrementalPointLocator	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
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)
Static Public Member Functions
static vtkPointLocator *	New ()
static int	IsTypeOf (const char *type)
static vtkPointLocator *	SafeDownCast (vtkObject *o)
Protected Member Functions
	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])
Protected Attributes
vtkPoints *	Points
int	Divisions [3]
int	NumberOfPointsPerBucket
vtkIdList **	HashTable
vtkIdType	NumberOfBuckets
double	H [3]
double	InsertionTol2
vtkIdType	InsertionPointId
double	InsertionLevel

Member Typedef Documentation

typedef vtkIncrementalPointLocator vtkPointLocator::Superclass

Reimplemented from vtkIncrementalPointLocator.

Reimplemented in vtkMergePoints, and vtkNonMergingPointLocator.

Definition at line 58 of file vtkPointLocator.h.

Constructor & Destructor Documentation

vtkPointLocator::vtkPointLocator ( ) [protected]

virtual vtkPointLocator::~vtkPointLocator ( ) [protected, virtual]

Member Function Documentation

static vtkPointLocator* vtkPointLocator::New ( ) [static]

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

Reimplemented from vtkObject.

Reimplemented in vtkMergePoints, and vtkNonMergingPointLocator.

virtual const char* vtkPointLocator::GetClassName ( ) [virtual]

Reimplemented from vtkIncrementalPointLocator.

Reimplemented in vtkMergePoints, and vtkNonMergingPointLocator.

static int vtkPointLocator::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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 vtkMergePoints, and vtkNonMergingPointLocator.

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 vtkMergePoints, and vtkNonMergingPointLocator.

static vtkPointLocator* vtkPointLocator::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkIncrementalPointLocator.

Reimplemented in vtkMergePoints, and vtkNonMergingPointLocator.

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 vtkMergePoints, and vtkNonMergingPointLocator.

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
	)			`[inline, 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 vtkMergePoints, and vtkNonMergingPointLocator.

Definition at line 127 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 vtkMergePoints, and vtkNonMergingPointLocator.

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 vtkMergePoints, and vtkNonMergingPointLocator.

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]`