quickly locate points in 3-space More...

#include <vtkStaticPointLocator.h>

Inheritance diagram for vtkStaticPointLocator:

Collaboration diagram for vtkStaticPointLocator:

Public Types
typedef vtkAbstractPointLocator	Superclass
	Standard type and print methods. More...

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

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

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkStaticPointLocator *	NewInstance () const

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

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

virtual int	GetNumberOfPointsPerBucket ()

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

virtual void	SetDivisions (int[3])

virtual int *	GetDivisions ()

virtual void	GetDivisions (int data[3])

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

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

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

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

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

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

void	FreeSearchStructure () override
	Free the memory required for the spatial data structure. More...

void	BuildLocator () override
	Build the locator from the input dataset. More...

void	GenerateRepresentation (int level, vtkPolyData *pd) override
	Method to build a representation at a particular level. More...

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

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

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

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

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

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

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

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

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

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

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

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 void	GetBounds (double *)

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

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

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

virtual vtkDataSet *	GetDataSet ()

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

virtual int	GetMaxLevel ()

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

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

virtual int	GetAutomatic ()

virtual void	AutomaticOn ()

virtual void	AutomaticOff ()

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

virtual double	GetTolerance ()

virtual void	Update ()
	Cause the locator to rebuild itself if it or its input dataset has changed. More...

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

void	Register (vtkObjectBase *o) override
	Handle the PointSet <-> Locator loop. More...

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

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

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

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

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

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

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

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

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)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

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)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

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

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
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

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

void	InitializeObjectBase ()

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

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

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

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

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

static int	IsTypeOf (const char *type)

static vtkStaticPointLocator *	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 vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

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

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

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

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

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkStaticPointLocator ()

	~vtkStaticPointLocator () override

Protected Member Functions inherited from vtkAbstractPointLocator
	vtkAbstractPointLocator ()

	~vtkAbstractPointLocator () override

Protected Member Functions inherited from vtkLocator
	vtkLocator ()

	~vtkLocator () override

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=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	NumberOfPointsPerBucket

int	Divisions [3]

double	H [3]

vtkBucketList *	Buckets

bool	LargeIds

Protected Attributes inherited from vtkAbstractPointLocator
double	Bounds [6]

vtkIdType	NumberOfBuckets

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

Friends
class	vtkBucketList

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.

See also: vtkPointLocator vtkCellLocator vtkLocator vtkAbstractPointLocator

Tests:: vtkStaticPointLocator (Tests)

Definition at line 63 of file vtkStaticPointLocator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAbstractPointLocator vtkStaticPointLocator::Superclass

Standard type and print methods.

Definition at line 77 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 int vtkStaticPointLocator::IsTypeOf ( const char * type )

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkStaticPointLocator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkAbstractPointLocator.

◆ NewInstance()

vtkStaticPointLocator* vtkStaticPointLocator::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

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

◆ 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 data member.

◆ SetDivisions() [2/2]

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

virtual

◆ GetDivisions() [1/2]

virtual int* vtkStaticPointLocator::GetDivisions ( )

virtual

◆ GetDivisions() [2/2]

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

virtual

◆ FindClosestPoint() [1/3]

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

overridevirtual

Given a position x, return the id of the point closest to it.

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.

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

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

◆ 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

Free the memory required for the spatial data structure.

Implements vtkLocator.

◆ BuildLocator()

void vtkStaticPointLocator::BuildLocator ( )

overridevirtual

Build the locator from the input dataset.

Implements vtkLocator.

◆ GenerateRepresentation()

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

overridevirtual

Method to build a representation at a particular level.

Note that the method GetLevel() returns the maximum number of levels available for the tree. You must provide a vtkPolyData object into which to place the data.

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.

◆ 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 signed integer max value.

Definition at line 180 of file vtkStaticPointLocator.h.

◆ FindClosestPoint() [2/3]

virtual vtkIdType vtkAbstractPointLocator::FindClosestPoint

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.

◆ FindClosestPoint() [3/3]

vtkIdType vtkAbstractPointLocator::FindClosestPoint

◆ FindClosestNPoints() [2/3]

virtual void vtkAbstractPointLocator::FindClosestNPoints

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.

◆ FindClosestNPoints() [3/3]

void vtkAbstractPointLocator::FindClosestNPoints

◆ FindPointsWithinRadius() [2/3]

virtual void vtkAbstractPointLocator::FindPointsWithinRadius

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.

◆ FindPointsWithinRadius() [3/3]

void vtkAbstractPointLocator::FindPointsWithinRadius

◆ GetBounds() [1/2]

virtual double* vtkAbstractPointLocator::GetBounds ( void )

inlinevirtual

Provide an accessor to the bounds.

Reimplemented from vtkAbstractPointLocator.

Definition at line 102 of file vtkAbstractPointLocator.h.

◆ GetBounds() [2/2]

virtual void vtkAbstractPointLocator::GetBounds ( void )

virtual

Provide an accessor to the bounds.

Reimplemented from vtkAbstractPointLocator.

Friends And Related Function Documentation

◆ vtkBucketList

friend class vtkBucketList

friend

Definition at line 65 of file vtkStaticPointLocator.h.

Member Data Documentation

◆ NumberOfPointsPerBucket

int vtkStaticPointLocator::NumberOfPointsPerBucket

protected

Definition at line 186 of file vtkStaticPointLocator.h.

◆ Divisions

int vtkStaticPointLocator::Divisions[3]

protected

Definition at line 187 of file vtkStaticPointLocator.h.

◆ H

double vtkStaticPointLocator::H[3]

protected

Definition at line 188 of file vtkStaticPointLocator.h.

◆ Buckets

vtkBucketList* vtkStaticPointLocator::Buckets

protected

Definition at line 189 of file vtkStaticPointLocator.h.

◆ LargeIds

bool vtkStaticPointLocator::LargeIds

protected

Definition at line 190 of file vtkStaticPointLocator.h.

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

dox/Common/DataModel/vtkStaticPointLocator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Superclass

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]

◆ Initialize()

◆ FreeSearchStructure()

◆ BuildLocator()

◆ GenerateRepresentation()

◆ GetNumberOfPointsInBucket()

◆ GetBucketIds()

◆ GetLargeIds()

◆ FindClosestPoint() [2/3]

◆ FindClosestPoint() [3/3]

◆ FindClosestNPoints() [2/3]

◆ FindClosestNPoints() [3/3]

◆ FindPointsWithinRadius() [2/3]

◆ FindPointsWithinRadius() [3/3]

◆ GetBounds() [1/2]

◆ GetBounds() [2/2]

Friends And Related Function Documentation

◆ vtkBucketList

Member Data Documentation

◆ NumberOfPointsPerBucket

◆ Divisions

◆ H

◆ Buckets

◆ LargeIds