quickly locate points in 3-space More...

#include <vtkStaticPointLocator.h>

Inheritance diagram for vtkStaticPointLocator:

Collaboration diagram for vtkStaticPointLocator:

Public Types
enum	TraversalOrderType { POINT_ORDER = 0 , BIN_ORDER = 1 }
	Point merging is inherently an order-dependent process. More...

Public Types inherited from vtkAbstractPointLocator
typedef vtkLocator	Superclass
	Standard type and print methods.

Public Types inherited from vtkLocator
typedef vtkObject	Superclass
	Standard type and print methods.

Public Member Functions
vtkIdType	FindClosestPoint (const double x[3]) override
	Given a position x, return the id of the point closest to it, or (-1) if no point found.

void	FindClosestNPoints (int N, const double x[3], vtkIdList *result) override
	Find the closest N points to a position.

void	FindPointsWithinRadius (double R, const double x[3], vtkIdList *result) override
	Find all points within a specified radius R of position x.

int	IntersectWithLine (double a0[3], double a1[3], double tol, double &t, double lineX[3], double ptX[3], vtkIdType &ptId)
	Intersect the points contained in the locator with the line defined by (a0,a1).

void	MergePoints (double tol, vtkIdType *mergeMap)
	Merge points in the locator given a tolerance.

void	MergePointsWithData (vtkDataArray data, vtkIdType mergeMap)
	Merge points and associated data in the locator.

void	GenerateRepresentation (int level, vtkPolyData *pd) override
	Populate a polydata with the faces of the bins that potentially contain cells.

vtkIdType	GetNumberOfPointsInBucket (vtkIdType bNum)
	Given a bucket number bNum between 0 <= bNum < this->GetNumberOfBuckets(), return the number of points found in the bucket.

void	GetBucketIds (vtkIdType bNum, vtkIdList *bList)
	Given a bucket number bNum between 0 <= bNum < this->GetNumberOfBuckets(), return a list of point ids contained within the bucket.

bool	GetLargeIds ()
	Inform the user as to whether large ids are being used.

virtual void	FindClosestNPoints (int N, const double x[3], vtkIdList *result)=0
	Find the closest N points to a position.

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

virtual vtkIdType	FindClosestPoint (const double x[3])=0
	Given a position x, return the id of the point closest to it.

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

virtual void	FindPointsWithinRadius (double R, const double x[3], vtkIdList *result)=0
	Find all points within a specified radius R of position x.

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

virtual double *	GetBounds ()
	Provide an accessor to the bounds.

virtual void	GetBounds (double *)
	Provide an accessor to the bounds.


virtual void	SetNumberOfPointsPerBucket (int)
	Specify the average number of points in each bucket.

virtual int	GetNumberOfPointsPerBucket ()
	Specify the average number of points in each bucket.


virtual void	SetDivisions (int, int, int)
	Set the number of divisions in x-y-z directions.

virtual void	SetDivisions (int[3])
	Set the number of divisions in x-y-z directions.

virtual int *	GetDivisions ()
	Set the number of divisions in x-y-z directions.

virtual void	GetDivisions (int data[3])
	Set the number of divisions in x-y-z directions.


vtkIdType	FindClosestPointWithinRadius (double radius, const double x[3], double &dist2) override
	Given a position x and a radius r, return the id of the point closest to the point in that radius, or (-1) if nothing found.

virtual vtkIdType	FindClosestPointWithinRadius (double radius, const double x[3], double inputDataLength, double &dist2)
	Given a position x and a radius r, return the id of the point closest to the point in that radius, or (-1) if nothing found.


void	Initialize () override
	See vtkLocator and vtkAbstractPointLocator interface documentation.

void	FreeSearchStructure () override
	See vtkLocator and vtkAbstractPointLocator interface documentation.

void	BuildLocator () override
	See vtkLocator and vtkAbstractPointLocator interface documentation.

void	ForceBuildLocator () override
	See vtkLocator and vtkAbstractPointLocator interface documentation.

void	BuildLocator (const double *inBounds)
	See vtkLocator and vtkAbstractPointLocator interface documentation.


virtual void	SetMaxNumberOfBuckets (vtkIdType)
	Set the maximum number of buckets in the locator.

virtual vtkIdType	GetMaxNumberOfBuckets ()
	Set the maximum number of buckets in the locator.


virtual double *	GetSpacing ()
	Provide an accessor to the bucket spacing.

virtual void	GetSpacing (double spacing[3])
	Provide an accessor to the bucket spacing.


virtual void	SetTraversalOrder (int)
	Specify the manner in which points are processed when a non-zero merge tolerance is specified.

virtual int	GetTraversalOrder ()
	Specify the manner in which points are processed when a non-zero merge tolerance is specified.

void	SetTraversalOrderToPointOrder ()
	Specify the manner in which points are processed when a non-zero merge tolerance is specified.

void	SetTraversalOrderToBinOrder ()
	Specify the manner in which points are processed when a non-zero merge tolerance is specified.

Public Member Functions inherited from vtkAbstractPointLocator
virtual vtkIdType	FindClosestPointWithinRadius (double radius, const double x[3], double &dist2)=0
	Given a position x and a radius r, return the id of the point closest to the point in that radius.

vtkIdType	FindClosestPoint (double x, double y, double z)
	Given a position x, return the id of the point closest to it.

void	FindClosestNPoints (int N, double x, double y, double z, vtkIdList *result)
	Find the closest N points to a position.

void	FindPointsWithinRadius (double R, double x, double y, double z, vtkIdList *result)
	Find all points within a specified radius R of position x.

virtual vtkIdType	GetNumberOfBuckets ()
	Return the total number of buckets in the locator.

vtkAbstractPointLocator *	NewInstance () const
	Standard type and print methods.

Public Member Functions inherited from vtkLocator
virtual void	Update ()
	Cause the locator to rebuild itself if it or its input dataset has changed.

virtual void	Initialize ()
	Initialize locator.

virtual void	BuildLocator ()=0
	Build the locator from the input dataset.

virtual void	ForceBuildLocator ()
	Build the locator from the input dataset (even if UseExistingSearchStructure is on).

virtual void	FreeSearchStructure ()=0
	Free the memory required for the spatial data structure.

virtual void	GenerateRepresentation (int level, vtkPolyData *pd)=0
	Method to build a representation at a particular level.

virtual void	SetDataSet (vtkDataSet *)
	Build the locator from the points/cells defining this dataset.

virtual vtkDataSet *	GetDataSet ()
	Build the locator from the points/cells defining this dataset.

virtual void	SetMaxLevel (int)
	Set the maximum allowable level for the tree.

virtual int	GetMaxLevel ()
	Set the maximum allowable level for the tree.

virtual int	GetLevel ()
	Get the level of the locator (determined automatically if Automatic is true).

virtual void	SetAutomatic (vtkTypeBool)
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

virtual vtkTypeBool	GetAutomatic ()
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

virtual void	AutomaticOn ()
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

virtual void	AutomaticOff ()
	Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket.

virtual void	SetTolerance (double)
	Specify absolute tolerance (in world coordinates) for performing geometric operations.

virtual double	GetTolerance ()
	Specify absolute tolerance (in world coordinates) for performing geometric operations.

virtual void	SetUseExistingSearchStructure (vtkTypeBool)
	Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again.

virtual vtkTypeBool	GetUseExistingSearchStructure ()
	Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again.

virtual void	UseExistingSearchStructureOn ()
	Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again.

virtual void	UseExistingSearchStructureOff ()
	Get/Set UseExistingSearchStructure, which when enabled it allows the locator to NOT be built again.

virtual vtkMTimeType	GetBuildTime ()
	Return the time of the last data structure build.

bool	UsesGarbageCollector () const override
	Handle the PointSet <-> Locator loop.

vtkLocator *	NewInstance () const
	Standard type and print methods.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkStaticPointLocator *	New ()
	Construct with automatic computation of divisions, averaging 5 points per bucket.

Static Public Member Functions inherited from vtkAbstractPointLocator
static vtkTypeBool	IsTypeOf (const char *type)
	Standard type and print methods.

static vtkAbstractPointLocator *	SafeDownCast (vtkObjectBase *o)
	Standard type and print methods.

Static Public Member Functions inherited from vtkLocator
static vtkTypeBool	IsTypeOf (const char *type)
	Standard type and print methods.

static vtkLocator *	SafeDownCast (vtkObjectBase *o)
	Standard type and print methods.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
	vtkStaticPointLocator ()

	~vtkStaticPointLocator () override

void	BuildLocatorInternal () override
	This function is not pure virtual to maintain backwards compatibility.

Protected Member Functions inherited from vtkAbstractPointLocator
	vtkAbstractPointLocator ()

	~vtkAbstractPointLocator () override

Protected Member Functions inherited from vtkLocator
	vtkLocator ()

	~vtkLocator () override

virtual void	BuildLocatorInternal ()
	This function is not pure virtual to maintain backwards compatibility.

void	ReportReferences (vtkGarbageCollector *) override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	NumberOfPointsPerBucket

int	Divisions [3]

double	H [3]

vtkBucketList *	Buckets

vtkIdType	MaxNumberOfBuckets

bool	LargeIds

int	TraversalOrder

Protected Attributes inherited from vtkAbstractPointLocator
double	Bounds [6]

vtkIdType	NumberOfBuckets

Protected Attributes inherited from vtkLocator
vtkDataSet *	DataSet

vtkTypeBool	UseExistingSearchStructure

vtkTypeBool	Automatic

double	Tolerance

int	MaxLevel

int	Level

vtkTimeStamp	BuildTime

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkAbstractPointLocator	Superclass
	Standard type and print methods.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard type and print methods.

static vtkStaticPointLocator *	SafeDownCast (vtkObjectBase *o)
	Standard type and print methods.

virtual vtkTypeBool	IsA (const char *type)
	Standard type and print methods.

vtkStaticPointLocator *	NewInstance () const
	Standard type and print methods.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard type and print methods.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard type and print methods.

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

quickly locate points in 3-space

vtkStaticPointLocator is a spatial search object to quickly locate points in 3D. vtkStaticPointLocator works by dividing a specified region of space into a regular array of cuboid 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; or finding the N closest points.

vtkStaticPointLocator is an accelerated version of vtkPointLocator. It is threaded (via vtkSMPTools), and supports one-time static construction (i.e., incremental point insertion is not supported). If you need to incrementally insert points, use the vtkPointLocator or its kin to do so.

Warning: This class is templated. It may run slower than serial execution if the code is not optimized during compilation. Build in Release or ReleaseWithDebugInfo.; Make sure that you review the documentation for the superclasses vtkAbstactPointLocator and vtkLocator. In particular the Automatic data member can be used to automatically determine divisions based on the average number of points per bucket.; Other types of spatial locators have been developed such as octrees and kd-trees. These are often more efficient for the operations described here.; Frequently vtkStaticPointLocator is used in lieu of vtkPointLocator. They are very similar in terms of algorithmic approach, however vtkStaticCellLocator is threaded and is typically much faster for a large number of points (on the order of 3-5x faster). For small numbers of points, vtkPointLocator is just as fast as vtkStaticPointLocator.

See also: vtkPointLocator vtkCellLocator vtkLocator vtkAbstractPointLocator

Online Examples:

StaticLocatorFindPointsWithinRadiusDemo

InterpolateFieldDataDemo

Tests:: vtkStaticPointLocator (Tests)

Definition at line 88 of file vtkStaticPointLocator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAbstractPointLocator vtkStaticPointLocator::Superclass

Standard type and print methods.

Definition at line 101 of file vtkStaticPointLocator.h.

Member Enumeration Documentation

◆ TraversalOrderType

enum vtkStaticPointLocator::TraversalOrderType

Point merging is inherently an order-dependent process.

Because naive threaded execution can non-deterministically change the ordering of merged points, threaded point merging for tolerances != 0.0 requires some level of serialization of the merging process to produce deterministic results. POINT_ORDER is completely serialized: two points with ids p0,p1 are merged if they are within tolerance of one another, with p1->p0 (p1 merged to p0) if p0<p1. IN BIN_ORDER, a threaded checkerboarding approach is used so that p1->p0 when p0<p1 in the local bin neighborhood and p1 not yet merged.

Enumerator
POINT_ORDER
BIN_ORDER

Definition at line 295 of file vtkStaticPointLocator.h.

Constructor & Destructor Documentation

◆ vtkStaticPointLocator()

vtkStaticPointLocator::vtkStaticPointLocator ( )

protected

◆ ~vtkStaticPointLocator()

vtkStaticPointLocator::~vtkStaticPointLocator ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkStaticPointLocator * vtkStaticPointLocator::New ( )

static

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

◆ IsTypeOf()

static vtkTypeBool vtkStaticPointLocator::IsTypeOf ( const char * type )

static

Standard type and print methods.

◆ IsA()

virtual vtkTypeBool vtkStaticPointLocator::IsA ( const char * type )

virtual

Standard type and print methods.

Reimplemented from vtkAbstractPointLocator.

◆ SafeDownCast()

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

static

Standard type and print methods.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkStaticPointLocator::NewInstanceInternal ( ) const

protectedvirtual

Standard type and print methods.

Reimplemented from vtkAbstractPointLocator.

◆ NewInstance()

vtkStaticPointLocator * vtkStaticPointLocator::NewInstance ( ) const

Standard type and print methods.

◆ PrintSelf()

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

overridevirtual

Standard type and print methods.

Reimplemented from vtkAbstractPointLocator.

◆ SetNumberOfPointsPerBucket()

virtual void vtkStaticPointLocator::SetNumberOfPointsPerBucket ( int )

virtual

Specify the average number of points in each bucket.

This data member is used in conjunction with the Automatic data member (if enabled) to determine the number of locator x-y-z divisions.

◆ GetNumberOfPointsPerBucket()

virtual int vtkStaticPointLocator::GetNumberOfPointsPerBucket ( )

virtual

Specify the average number of points in each bucket.

This data member is used in conjunction with the Automatic data member (if enabled) to determine the number of locator x-y-z divisions.

◆ SetDivisions() [1/2]

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

virtual

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

If the Automatic data member is enabled, the Divisions are set according to the NumberOfPointsPerBucket and MaxNumberOfBuckets data members. The number of divisions must be >= 1 in each direction.

◆ SetDivisions() [2/2]

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

virtual

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

If the Automatic data member is enabled, the Divisions are set according to the NumberOfPointsPerBucket and MaxNumberOfBuckets data members. The number of divisions must be >= 1 in each direction.

◆ GetDivisions() [1/2]

virtual int * vtkStaticPointLocator::GetDivisions ( )

virtual

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

If the Automatic data member is enabled, the Divisions are set according to the NumberOfPointsPerBucket and MaxNumberOfBuckets data members. The number of divisions must be >= 1 in each direction.

◆ GetDivisions() [2/2]

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

virtual

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

If the Automatic data member is enabled, the Divisions are set according to the NumberOfPointsPerBucket and MaxNumberOfBuckets data members. The number of divisions must be >= 1 in each direction.

◆ FindClosestPoint() [1/3]

vtkIdType vtkStaticPointLocator::FindClosestPoint ( const double x[3] )

overridevirtual

Given a position x, return the id of the point closest to it, or (-1) if no point found.

An alternative method (defined in the superclass) 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.

◆ FindClosestPointWithinRadius() [1/2]

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

overridevirtual

Given a position x and a radius r, return the id of the point closest to the point in that radius, or (-1) if nothing found.

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. Note that if multiple points are located the same distance away, the actual point returned is a function in which order the points are processed (i.e., indeterminate).

Implements vtkAbstractPointLocator.

◆ FindClosestPointWithinRadius() [2/2]

virtual vtkIdType vtkStaticPointLocator::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, or (-1) if nothing found.

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. Note that if multiple points are located the same distance away, the actual point returned is a function in which order the points are processed (i.e., indeterminate).

◆ FindClosestNPoints() [1/3]

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

overridevirtual

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.

◆ FindPointsWithinRadius() [1/3]

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

overridevirtual

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.

◆ IntersectWithLine()

int vtkStaticPointLocator::IntersectWithLine	(	double	a0[3],
		double	a1[3],
		double	tol,
		double &	t,
		double	lineX[3],
		double	ptX[3],
		vtkIdType &	ptId
	)

Intersect the points contained in the locator with the line defined by (a0,a1).

Return the point within the tolerance tol that is closest to a0 (tol measured in the world coordinate system). If an intersection occurs (i.e., the method returns nonzero), then the parametric location along the line t, the closest position along the line lineX, and the coordinates of the picked ptId is returned in ptX. (This method is thread safe after the locator is built.)

◆ MergePoints()

void vtkStaticPointLocator::MergePoints	(	double	tol,
		vtkIdType *	mergeMap
	)

Merge points in the locator given a tolerance.

Return a merge map which maps all points to the points to which they were merged. Note the number of points in the merge map is the number of points the locator was built with. The user is expected to pass in an allocated mergeMap. Note that when tol!=0, the traversal order of threading can be specified using the SetTraversalOrder() method. The traversal order is needed to generate deterministic output (i.e., output independent of thread execution order).

◆ MergePointsWithData()

void vtkStaticPointLocator::MergePointsWithData	(	vtkDataArray *	data,
		vtkIdType *	mergeMap
	)

Merge points and associated data in the locator.

Return a merge map which maps all points to the points to which they were merged. Note the number of points in the merge map is the number of points the locator was built with. Merging occurs when both the points and the associated point data (represented by the data array) are equal. The user is expected to pass in an allocated mergeMap, and the size of the data array should be number of points in the locator. The data array may have an arbitrary number of components.

◆ Initialize()

void vtkStaticPointLocator::Initialize ( )

overridevirtual

See vtkLocator and vtkAbstractPointLocator interface documentation.

These methods are not thread safe.

Reimplemented from vtkLocator.

◆ FreeSearchStructure()

void vtkStaticPointLocator::FreeSearchStructure ( )

overridevirtual

See vtkLocator and vtkAbstractPointLocator interface documentation.

These methods are not thread safe.

Implements vtkLocator.

◆ BuildLocator() [1/2]

void vtkStaticPointLocator::BuildLocator ( )

overridevirtual

See vtkLocator and vtkAbstractPointLocator interface documentation.

These methods are not thread safe.

Implements vtkLocator.

◆ ForceBuildLocator()

void vtkStaticPointLocator::ForceBuildLocator ( )

overridevirtual

See vtkLocator and vtkAbstractPointLocator interface documentation.

These methods are not thread safe.

Reimplemented from vtkLocator.

◆ BuildLocator() [2/2]

void vtkStaticPointLocator::BuildLocator ( const double * inBounds )

See vtkLocator and vtkAbstractPointLocator interface documentation.

These methods are not thread safe.

◆ GenerateRepresentation()

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

overridevirtual

Populate a polydata with the faces of the bins that potentially contain cells.

Note that the level parameter has no effect on this method as there is no hierarchy built (i.e., uniform binning). Typically this is used for debugging.

Implements vtkLocator.

◆ GetNumberOfPointsInBucket()

vtkIdType vtkStaticPointLocator::GetNumberOfPointsInBucket ( vtkIdType bNum )

Given a bucket number bNum between 0 <= bNum < this->GetNumberOfBuckets(), return the number of points found in the bucket.

◆ GetBucketIds()

void vtkStaticPointLocator::GetBucketIds	(	vtkIdType	bNum,
		vtkIdList *	bList
	)

Given a bucket number bNum between 0 <= bNum < this->GetNumberOfBuckets(), return a list of point ids contained within the bucket.

The user must provide an instance of vtkIdList to contain the result.

◆ SetMaxNumberOfBuckets()

virtual void vtkStaticPointLocator::SetMaxNumberOfBuckets ( vtkIdType )

virtual

Set the maximum number of buckets in the locator.

By default the value is set to VTK_INT_MAX. Note that there are significant performance implications at work here. If the number of buckets is set very large (meaning > VTK_INT_MAX) then internal sorting may be performed using 64-bit integers (which is much slower than using a 32-bit int). Of course, memory requirements may dramatically increase as well. It is recommended that the default value be used; but for extremely large data it may be desired to create a locator with an exceptionally large number of buckets. Note also that during initialization of the locator if the MaxNumberOfBuckets threshold is exceeded, the Divisions are scaled down in such a way as not to exceed the MaxNumberOfBuckets proportionally to the size of the bounding box in the x-y-z directions.

◆ GetMaxNumberOfBuckets()

virtual vtkIdType vtkStaticPointLocator::GetMaxNumberOfBuckets ( )

virtual

Set the maximum number of buckets in the locator.

By default the value is set to VTK_INT_MAX. Note that there are significant performance implications at work here. If the number of buckets is set very large (meaning > VTK_INT_MAX) then internal sorting may be performed using 64-bit integers (which is much slower than using a 32-bit int). Of course, memory requirements may dramatically increase as well. It is recommended that the default value be used; but for extremely large data it may be desired to create a locator with an exceptionally large number of buckets. Note also that during initialization of the locator if the MaxNumberOfBuckets threshold is exceeded, the Divisions are scaled down in such a way as not to exceed the MaxNumberOfBuckets proportionally to the size of the bounding box in the x-y-z directions.

◆ GetLargeIds()

bool vtkStaticPointLocator::GetLargeIds ( )

inline

Inform the user as to whether large ids are being used.

This flag only has meaning after the locator has been built. Large ids are used when the number of binned points, or the number of bins, is >= the maximum number of buckets (specified by the user). Note that LargeIds are only available on 64-bit architectures.

Definition at line 268 of file vtkStaticPointLocator.h.

◆ GetSpacing() [1/2]

virtual double * vtkStaticPointLocator::GetSpacing ( )

inlinevirtual

Provide an accessor to the bucket spacing.

Valid after the locator is built.

Definition at line 275 of file vtkStaticPointLocator.h.

◆ GetSpacing() [2/2]

virtual void vtkStaticPointLocator::GetSpacing ( double spacing[3] )

inlinevirtual

Provide an accessor to the bucket spacing.

Valid after the locator is built.

Definition at line 276 of file vtkStaticPointLocator.h.

◆ SetTraversalOrder()

virtual void vtkStaticPointLocator::SetTraversalOrder ( int )

virtual

Specify the manner in which points are processed when a non-zero merge tolerance is specified.

By default, BIN_ORDER is used (i.e., threaded using bin checkerboard traversal) versus POINT_ORDER, which is a serial traversal.

◆ GetTraversalOrder()

virtual int vtkStaticPointLocator::GetTraversalOrder ( )

virtual

Specify the manner in which points are processed when a non-zero merge tolerance is specified.

By default, BIN_ORDER is used (i.e., threaded using bin checkerboard traversal) versus POINT_ORDER, which is a serial traversal.

◆ SetTraversalOrderToPointOrder()

void vtkStaticPointLocator::SetTraversalOrderToPointOrder ( )

inline

Specify the manner in which points are processed when a non-zero merge tolerance is specified.

By default, BIN_ORDER is used (i.e., threaded using bin checkerboard traversal) versus POINT_ORDER, which is a serial traversal.

Definition at line 310 of file vtkStaticPointLocator.h.

◆ SetTraversalOrderToBinOrder()

void vtkStaticPointLocator::SetTraversalOrderToBinOrder ( )

inline

Specify the manner in which points are processed when a non-zero merge tolerance is specified.

By default, BIN_ORDER is used (i.e., threaded using bin checkerboard traversal) versus POINT_ORDER, which is a serial traversal.

Definition at line 314 of file vtkStaticPointLocator.h.

◆ BuildLocatorInternal()

void vtkStaticPointLocator::BuildLocatorInternal ( )

overrideprotectedvirtual

This function is not pure virtual to maintain backwards compatibility.

Reimplemented from vtkLocator.

◆ FindClosestNPoints() [2/3]

virtual void vtkAbstractPointLocator::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.

◆ FindClosestNPoints() [3/3]

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

◆ FindClosestPoint() [2/3]

virtual vtkIdType vtkAbstractPointLocator::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.

◆ FindClosestPoint() [3/3]

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

◆ FindPointsWithinRadius() [2/3]

virtual void vtkAbstractPointLocator::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.

◆ FindPointsWithinRadius() [3/3]

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

◆ GetBounds() [1/2]

virtual double * vtkAbstractPointLocator::GetBounds ( )

inlinevirtual

Provide an accessor to the bounds.

Valid after the locator is built.

Reimplemented from vtkAbstractPointLocator.

Definition at line 88 of file vtkAbstractPointLocator.h.

◆ GetBounds() [2/2]

virtual void vtkAbstractPointLocator::GetBounds ( double * )

virtual

Provide an accessor to the bounds.

Valid after the locator is built.

Reimplemented from vtkAbstractPointLocator.

Member Data Documentation

◆ NumberOfPointsPerBucket

int vtkStaticPointLocator::NumberOfPointsPerBucket

protected

Definition at line 323 of file vtkStaticPointLocator.h.

◆ Divisions

int vtkStaticPointLocator::Divisions[3]

protected

Definition at line 324 of file vtkStaticPointLocator.h.

◆ H

double vtkStaticPointLocator::H[3]

protected

Definition at line 325 of file vtkStaticPointLocator.h.

◆ Buckets

vtkBucketList* vtkStaticPointLocator::Buckets

protected

Definition at line 326 of file vtkStaticPointLocator.h.

◆ MaxNumberOfBuckets

vtkIdType vtkStaticPointLocator::MaxNumberOfBuckets

protected

Definition at line 327 of file vtkStaticPointLocator.h.

◆ LargeIds

bool vtkStaticPointLocator::LargeIds

protected

Definition at line 328 of file vtkStaticPointLocator.h.

◆ TraversalOrder

int vtkStaticPointLocator::TraversalOrder

protected

Definition at line 329 of file vtkStaticPointLocator.h.

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

Common/DataModel/vtkStaticPointLocator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ TraversalOrderType

Constructor & Destructor Documentation

◆ vtkStaticPointLocator()

◆ ~vtkStaticPointLocator()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetNumberOfPointsPerBucket()

◆ GetNumberOfPointsPerBucket()

◆ SetDivisions() [1/2]

◆ SetDivisions() [2/2]

◆ GetDivisions() [1/2]

◆ GetDivisions() [2/2]

◆ FindClosestPoint() [1/3]

◆ FindClosestPointWithinRadius() [1/2]

◆ FindClosestPointWithinRadius() [2/2]

◆ FindClosestNPoints() [1/3]

◆ FindPointsWithinRadius() [1/3]

◆ IntersectWithLine()

◆ MergePoints()

◆ MergePointsWithData()

◆ Initialize()

◆ FreeSearchStructure()

◆ BuildLocator() [1/2]

◆ ForceBuildLocator()

◆ BuildLocator() [2/2]

◆ GenerateRepresentation()

◆ GetNumberOfPointsInBucket()

◆ GetBucketIds()

◆ SetMaxNumberOfBuckets()

◆ GetMaxNumberOfBuckets()

◆ GetLargeIds()

◆ GetSpacing() [1/2]

◆ GetSpacing() [2/2]

◆ SetTraversalOrder()

◆ GetTraversalOrder()

◆ SetTraversalOrderToPointOrder()

◆ SetTraversalOrderToBinOrder()

◆ BuildLocatorInternal()

◆ FindClosestNPoints() [2/3]

◆ FindClosestNPoints() [3/3]

◆ FindClosestPoint() [2/3]

◆ FindClosestPoint() [3/3]

◆ FindPointsWithinRadius() [2/3]

◆ FindPointsWithinRadius() [3/3]

◆ GetBounds() [1/2]

◆ GetBounds() [2/2]

Member Data Documentation

◆ NumberOfPointsPerBucket

◆ Divisions

◆ H

◆ Buckets

◆ MaxNumberOfBuckets

◆ LargeIds

◆ TraversalOrder