an octree spatial decomposition of a set of points More...

#include <vtkOctreePointLocator.h>

Inheritance diagram for vtkOctreePointLocator:

Collaboration diagram for vtkOctreePointLocator:

Public Types
typedef vtkAbstractPointLocator	Superclass

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
virtual vtkTypeBool	IsA (const char *type)
	Standard type and print methods.

vtkOctreePointLocator *	NewInstance () const

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

void	GetRegionBounds (int regionID, double bounds[6])
	Get the spatial bounds of octree region.

void	GetRegionDataBounds (int leafNodeID, double bounds[6])
	Get the bounds of the data within the leaf node.

int	GetRegionContainingPoint (double x, double y, double z)
	Get the id of the leaf region containing the specified location.

void	BuildLocator () override
	Create the octree decomposition of the cells of the data set or data sets.

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

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.

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

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

vtkIdTypeArray *	GetPointsInRegion (int leafNodeId)
	Get a list of the original IDs of all points in a leaf node.

void	FreeSearchStructure () override
	Delete the octree data structure.

void	GenerateRepresentation (int level, vtkPolyData *pd) override
	Create a polydata representation of the boundaries of the octree regions.

void	FindPointsInArea (double area, vtkIdTypeArray ids, bool clearArray=true)
	Fill ids with points found in area.


virtual void	SetMaximumPointsPerRegion (int)
	Maximum number of points per spatial region.

virtual int	GetMaximumPointsPerRegion ()
	Maximum number of points per spatial region.


virtual void	SetCreateCubicOctants (int)
	Get/Set macro for CreateCubicOctants.

virtual int	GetCreateCubicOctants ()
	Get/Set macro for CreateCubicOctants.


virtual double	GetFudgeFactor ()
	Some algorithms on octrees require a value that is a very small distance relative to the diameter of the entire space divided by the octree.

virtual void	SetFudgeFactor (double)
	Some algorithms on octrees require a value that is a very small distance relative to the diameter of the entire space divided by the octree.


double *	GetBounds () override
	Get the spatial bounds of the entire octree space.

void	GetBounds (double *bounds) override
	Get the spatial bounds of the entire octree space.


virtual int	GetNumberOfLeafNodes ()
	The number of leaf nodes of the tree, the spatial regions.


vtkIdType	FindClosestPoint (const double x[3]) override
	Return the Id of the point that is closest to the given point.

vtkIdType	FindClosestPoint (double x, double y, double z, double &dist2)
	Return the Id of the point that is closest to the given point.


vtkIdType	FindClosestPointInRegion (int regionId, double *x, double &dist2)
	Find the Id of the point in the given leaf region which is closest to the given point.

vtkIdType	FindClosestPointInRegion (int regionId, double x, double y, double z, double &dist2)
	Find the Id of the point in the given leaf region which is closest to the given point.

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 vtkTypeBool	IsTypeOf (const char *type)

static vtkOctreePointLocator *	SafeDownCast (vtkObjectBase *o)

static vtkOctreePointLocator *	New ()

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
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard type and print methods.

	vtkOctreePointLocator ()

	~vtkOctreePointLocator () override

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

void	BuildLeafNodeList (vtkOctreePointLocatorNode *node, int &index)

void	FindPointsWithinRadius (vtkOctreePointLocatorNode node, double radiusSquared, const double x[3], vtkIdList ids)
	Recursive helper for public FindPointsWithinRadius.

void	AddAllPointsInRegion (vtkOctreePointLocatorNode node, vtkIdList ids)

void	FindPointsInArea (vtkOctreePointLocatorNode node, double area, vtkIdTypeArray *ids)

void	AddAllPointsInRegion (vtkOctreePointLocatorNode node, vtkIdTypeArray ids)

void	DivideRegion (vtkOctreePointLocatorNode node, int ordering, int level)

int	DivideTest (int size, int level)

void	AddPolys (vtkOctreePointLocatorNode node, vtkPoints pts, vtkCellArray *polys)

int	FindClosestPointInRegion_ (int leafNodeId, double x, double y, double z, double &dist2)
	Given a leaf node id and point, return the local id and the squared distance between the closest point and the given point.

int	FindClosestPointInSphere (double x, double y, double z, double radius, int skipRegion, double &dist2)
	Given a location and a radiues, find the closest point within this radius.

	vtkOctreePointLocator (const vtkOctreePointLocator &)=delete

void	operator= (const vtkOctreePointLocator &)=delete


int	FindRegion (vtkOctreePointLocatorNode *node, float x, float y, float z)
	Given a point and a node return the leaf node id that contains the point.

int	FindRegion (vtkOctreePointLocatorNode *node, double x, double y, double z)
	Given a point and a node return the leaf node id that contains the point.

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

Static Protected Member Functions
static void	SetDataBoundsToSpatialBounds (vtkOctreePointLocatorNode *node)

static void	DeleteAllDescendants (vtkOctreePointLocatorNode *octant)

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
vtkOctreePointLocatorNode *	Top

vtkOctreePointLocatorNode **	LeafNodeList

double	FudgeFactor

int	NumberOfLocatorPoints

float *	LocatorPoints

int *	LocatorIds

float	MaxWidth

int	CreateCubicOctants
	If CreateCubicOctants is non-zero, the bounding box of the points will be expanded such that all octants that are created will be cube-shaped (e.g.


int	MaximumPointsPerRegion
	The maximum number of points in a region/octant before it is subdivided.

int	NumberOfLeafNodes
	The maximum number of points in a region/octant before it is subdivided.

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

Detailed Description

an octree spatial decomposition of a set of points

Given a vtkDataSet, create an octree that is locally refined such that all leaf octants contain less than a certain amount of points. Note that there is no size constraint that a leaf octant in relation to any of its neighbors.

This class can also generate a PolyData representation of the boundaries of the spatial regions in the decomposition.

See also: vtkLocator vtkPointLocator vtkOctreePointLocatorNode

Online Examples:

BuildOctree

DataStructureComparison

OctreeClosestPoint

OctreeFindPointsWithinRadius

OctreeFindPointsWithinRadiusDemo

OctreeKClosestPoints

OctreeTimingDemo

OctreeVisualize

Tests:: vtkOctreePointLocator (Tests)

Definition at line 127 of file vtkOctreePointLocator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkAbstractPointLocator vtkOctreePointLocator::Superclass

Definition at line 130 of file vtkOctreePointLocator.h.

Constructor & Destructor Documentation

◆ vtkOctreePointLocator() [1/2]

vtkOctreePointLocator::vtkOctreePointLocator ( )

protected

◆ ~vtkOctreePointLocator()

vtkOctreePointLocator::~vtkOctreePointLocator ( )

overrideprotected

◆ vtkOctreePointLocator() [2/2]

vtkOctreePointLocator::vtkOctreePointLocator ( const vtkOctreePointLocator & )

protecteddelete

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Standard type and print methods.

Reimplemented from vtkAbstractPointLocator.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkOctreePointLocator::NewInstanceInternal ( ) const

protectedvirtual

Standard type and print methods.

Reimplemented from vtkAbstractPointLocator.

◆ NewInstance()

vtkOctreePointLocator * vtkOctreePointLocator::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

Standard type and print methods.

Reimplemented from vtkAbstractPointLocator.

◆ New()

static vtkOctreePointLocator * vtkOctreePointLocator::New ( )

static

◆ SetMaximumPointsPerRegion()

virtual void vtkOctreePointLocator::SetMaximumPointsPerRegion ( int )

virtual

Maximum number of points per spatial region.

Default is 100.

◆ GetMaximumPointsPerRegion()

virtual int vtkOctreePointLocator::GetMaximumPointsPerRegion ( )

virtual

Maximum number of points per spatial region.

Default is 100.

◆ SetCreateCubicOctants()

virtual void vtkOctreePointLocator::SetCreateCubicOctants ( int )

virtual

Get/Set macro for CreateCubicOctants.

◆ GetCreateCubicOctants()

virtual int vtkOctreePointLocator::GetCreateCubicOctants ( )

virtual

Get/Set macro for CreateCubicOctants.

◆ GetFudgeFactor()

virtual double vtkOctreePointLocator::GetFudgeFactor ( )

virtual

Some algorithms on octrees require a value that is a very small distance relative to the diameter of the entire space divided by the octree.

This factor is the maximum axis-aligned width of the space multiplied by 10e-6.

◆ SetFudgeFactor()

virtual void vtkOctreePointLocator::SetFudgeFactor ( double )

virtual

Some algorithms on octrees require a value that is a very small distance relative to the diameter of the entire space divided by the octree.

This factor is the maximum axis-aligned width of the space multiplied by 10e-6.

◆ GetBounds() [1/2]

double * vtkOctreePointLocator::GetBounds ( )

overridevirtual

Get the spatial bounds of the entire octree space.

Sets bounds array to xmin, xmax, ymin, ymax, zmin, zmax.

Reimplemented from vtkAbstractPointLocator.

◆ GetBounds() [2/2]

void vtkOctreePointLocator::GetBounds ( double * bounds )

overridevirtual

Get the spatial bounds of the entire octree space.

Sets bounds array to xmin, xmax, ymin, ymax, zmin, zmax.

Reimplemented from vtkAbstractPointLocator.

◆ GetNumberOfLeafNodes()

virtual int vtkOctreePointLocator::GetNumberOfLeafNodes ( )

virtual

The number of leaf nodes of the tree, the spatial regions.

◆ GetRegionBounds()

void vtkOctreePointLocator::GetRegionBounds	(	int	regionID,
		double	bounds[6]
	)

Get the spatial bounds of octree region.

◆ GetRegionDataBounds()

void vtkOctreePointLocator::GetRegionDataBounds	(	int	leafNodeID,
		double	bounds[6]
	)

Get the bounds of the data within the leaf node.

◆ GetRegionContainingPoint()

int vtkOctreePointLocator::GetRegionContainingPoint	(	double	x,
		double	y,
		double	z
	)

Get the id of the leaf region containing the specified location.

◆ BuildLocator()

void vtkOctreePointLocator::BuildLocator ( )

overridevirtual

Create the octree decomposition of the cells of the data set or data sets.

Cells are assigned to octree spatial regions based on the location of their centroids.

This will NOT do anything if UseExistingSearchStructure is on.

Implements vtkLocator.

◆ ForceBuildLocator()

void vtkOctreePointLocator::ForceBuildLocator ( )

overridevirtual

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

Reimplemented from vtkLocator.

◆ FindClosestPoint() [1/2]

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

overridevirtual

Return the Id of the point that is closest to the given point.

Set the square of the distance between the two points.

Implements vtkAbstractPointLocator.

◆ FindClosestPoint() [2/2]

vtkIdType vtkOctreePointLocator::FindClosestPoint	(	double	x,
		double	y,
		double	z,
		double &	dist2
	)

Return the Id of the point that is closest to the given point.

Set the square of the distance between the two points.

◆ FindClosestPointWithinRadius()

vtkIdType vtkOctreePointLocator::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.

dist2 returns the squared distance to the point.

Implements vtkAbstractPointLocator.

◆ FindClosestPointInRegion() [1/2]

vtkIdType vtkOctreePointLocator::FindClosestPointInRegion	(	int	regionId,
		double *	x,
		double &	dist2
	)

Find the Id of the point in the given leaf region which is closest to the given point.

Return the ID of the point, and set the square of the distance of between the points.

◆ FindClosestPointInRegion() [2/2]

vtkIdType vtkOctreePointLocator::FindClosestPointInRegion	(	int	regionId,
		double	x,
		double	y,
		double	z,
		double &	dist2
	)

Find the Id of the point in the given leaf region which is closest to the given point.

Return the ID of the point, and set the square of the distance of between the points.

◆ FindPointsWithinRadius() [1/2]

void vtkOctreePointLocator::FindPointsWithinRadius	(	double	radius,
		const double	x[3],
		vtkIdList *	result
	)

overridevirtual

Find all points within a specified radius of position x.

The result is not sorted in any specific manner.

Implements vtkAbstractPointLocator.

◆ FindClosestNPoints()

void vtkOctreePointLocator::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 not 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.

◆ GetPointsInRegion()

vtkIdTypeArray * vtkOctreePointLocator::GetPointsInRegion ( int leafNodeId )

Get a list of the original IDs of all points in a leaf node.

◆ FreeSearchStructure()

void vtkOctreePointLocator::FreeSearchStructure ( )

overridevirtual

Delete the octree data structure.

Implements vtkLocator.

◆ GenerateRepresentation()

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

overridevirtual

Create a polydata representation of the boundaries of the octree regions.

Implements vtkLocator.

◆ FindPointsInArea() [1/2]

void vtkOctreePointLocator::FindPointsInArea	(	double *	area,
		vtkIdTypeArray *	ids,
		bool	clearArray = `true`
	)

Fill ids with points found in area.

The area is a 6-tuple containing (xmin, xmax, ymin, ymax, zmin, zmax). This method will clear the array by default. To append ids to an array, set clearArray to false.

◆ BuildLocatorInternal()

void vtkOctreePointLocator::BuildLocatorInternal ( )

overrideprotectedvirtual

This function is not pure virtual to maintain backwards compatibility.

Reimplemented from vtkLocator.

◆ BuildLeafNodeList()

void vtkOctreePointLocator::BuildLeafNodeList	(	vtkOctreePointLocatorNode *	node,
		int &	index
	)

protected

◆ FindRegion() [1/2]

int vtkOctreePointLocator::FindRegion	(	vtkOctreePointLocatorNode *	node,
		float	x,
		float	y,
		float	z
	)

protected

Given a point and a node return the leaf node id that contains the point.

The function returns -1 if no nodes contain the point.

◆ FindRegion() [2/2]

int vtkOctreePointLocator::FindRegion	(	vtkOctreePointLocatorNode *	node,
		double	x,
		double	y,
		double	z
	)

protected

Given a point and a node return the leaf node id that contains the point.

The function returns -1 if no nodes contain the point.

◆ SetDataBoundsToSpatialBounds()

static void vtkOctreePointLocator::SetDataBoundsToSpatialBounds ( vtkOctreePointLocatorNode * node )

staticprotected

◆ DeleteAllDescendants()

static void vtkOctreePointLocator::DeleteAllDescendants ( vtkOctreePointLocatorNode * octant )

staticprotected

◆ FindPointsWithinRadius() [2/2]

void vtkOctreePointLocator::FindPointsWithinRadius	(	vtkOctreePointLocatorNode *	node,
		double	radiusSquared,
		const double	x[3],
		vtkIdList *	ids
	)

protected

Recursive helper for public FindPointsWithinRadius.

radiusSquared is the square of the radius and is used in order to avoid the expensive square root calculation.

◆ AddAllPointsInRegion() [1/2]

void vtkOctreePointLocator::AddAllPointsInRegion	(	vtkOctreePointLocatorNode *	node,
		vtkIdList *	ids
	)

protected

◆ FindPointsInArea() [2/2]

void vtkOctreePointLocator::FindPointsInArea	(	vtkOctreePointLocatorNode *	node,
		double *	area,
		vtkIdTypeArray *	ids
	)

protected

◆ AddAllPointsInRegion() [2/2]

void vtkOctreePointLocator::AddAllPointsInRegion	(	vtkOctreePointLocatorNode *	node,
		vtkIdTypeArray *	ids
	)

protected

◆ DivideRegion()

void vtkOctreePointLocator::DivideRegion	(	vtkOctreePointLocatorNode *	node,
		int *	ordering,
		int	level
	)

protected

◆ DivideTest()

int vtkOctreePointLocator::DivideTest	(	int	size,
		int	level
	)

protected

◆ AddPolys()

void vtkOctreePointLocator::AddPolys	(	vtkOctreePointLocatorNode *	node,
		vtkPoints *	pts,
		vtkCellArray *	polys
	)

protected

◆ FindClosestPointInRegion_()

int vtkOctreePointLocator::FindClosestPointInRegion_	(	int	leafNodeId,
		double	x,
		double	y,
		double	z,
		double &	dist2
	)

protected

Given a leaf node id and point, return the local id and the squared distance between the closest point and the given point.

◆ FindClosestPointInSphere()

int vtkOctreePointLocator::FindClosestPointInSphere	(	double	x,
		double	y,
		double	z,
		double	radius,
		int	skipRegion,
		double &	dist2
	)

protected

Given a location and a radiues, find the closest point within this radius.

The function does not examine the region with Id equal to skipRegion (do not set skipRegion to -1 as all non-leaf octants have -1 as their Id). The Id is returned along with the distance squared for success and -1 is returned for failure.

◆ operator=()

void vtkOctreePointLocator::operator= ( const vtkOctreePointLocator & )

protecteddelete

Member Data Documentation

◆ Top

vtkOctreePointLocatorNode* vtkOctreePointLocator::Top

protected

Definition at line 279 of file vtkOctreePointLocator.h.

◆ LeafNodeList

vtkOctreePointLocatorNode** vtkOctreePointLocator::LeafNodeList

protected

Definition at line 280 of file vtkOctreePointLocator.h.

◆ MaximumPointsPerRegion

int vtkOctreePointLocator::MaximumPointsPerRegion

protected

The maximum number of points in a region/octant before it is subdivided.

Definition at line 340 of file vtkOctreePointLocator.h.

◆ NumberOfLeafNodes

int vtkOctreePointLocator::NumberOfLeafNodes

protected

The maximum number of points in a region/octant before it is subdivided.

Definition at line 341 of file vtkOctreePointLocator.h.

◆ FudgeFactor

double vtkOctreePointLocator::FudgeFactor

protected

Definition at line 344 of file vtkOctreePointLocator.h.

◆ NumberOfLocatorPoints

int vtkOctreePointLocator::NumberOfLocatorPoints

protected

Definition at line 345 of file vtkOctreePointLocator.h.

◆ LocatorPoints

float* vtkOctreePointLocator::LocatorPoints

protected

Definition at line 346 of file vtkOctreePointLocator.h.

◆ LocatorIds

int* vtkOctreePointLocator::LocatorIds

protected

Definition at line 347 of file vtkOctreePointLocator.h.

◆ MaxWidth

float vtkOctreePointLocator::MaxWidth

protected

Definition at line 349 of file vtkOctreePointLocator.h.

◆ CreateCubicOctants

int vtkOctreePointLocator::CreateCubicOctants

protected

If CreateCubicOctants is non-zero, the bounding box of the points will be expanded such that all octants that are created will be cube-shaped (e.g.

have equal lengths on each side). This may make the tree deeper but also results in better shaped octants for doing searches. The default is to have this set on.

Definition at line 358 of file vtkOctreePointLocator.h.

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

Common/DataModel/vtkOctreePointLocator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkOctreePointLocator() [1/2]

◆ ~vtkOctreePointLocator()

◆ vtkOctreePointLocator() [2/2]

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ SetMaximumPointsPerRegion()

◆ GetMaximumPointsPerRegion()

◆ SetCreateCubicOctants()

◆ GetCreateCubicOctants()

◆ GetFudgeFactor()

◆ SetFudgeFactor()

◆ GetBounds() [1/2]

◆ GetBounds() [2/2]

◆ GetNumberOfLeafNodes()

◆ GetRegionBounds()

◆ GetRegionDataBounds()

◆ GetRegionContainingPoint()

◆ BuildLocator()

◆ ForceBuildLocator()

◆ FindClosestPoint() [1/2]

◆ FindClosestPoint() [2/2]

◆ FindClosestPointWithinRadius()

◆ FindClosestPointInRegion() [1/2]

◆ FindClosestPointInRegion() [2/2]

◆ FindPointsWithinRadius() [1/2]

◆ FindClosestNPoints()

◆ GetPointsInRegion()

◆ FreeSearchStructure()

◆ GenerateRepresentation()

◆ FindPointsInArea() [1/2]

◆ BuildLocatorInternal()

◆ BuildLeafNodeList()

◆ FindRegion() [1/2]

◆ FindRegion() [2/2]

◆ SetDataBoundsToSpatialBounds()

◆ DeleteAllDescendants()

◆ FindPointsWithinRadius() [2/2]

◆ AddAllPointsInRegion() [1/2]

◆ FindPointsInArea() [2/2]

◆ AddAllPointsInRegion() [2/2]

◆ DivideRegion()

◆ DivideTest()

◆ AddPolys()

◆ FindClosestPointInRegion_()

◆ FindClosestPointInSphere()

◆ operator=()

Member Data Documentation

◆ Top

◆ LeafNodeList

◆ MaximumPointsPerRegion

◆ NumberOfLeafNodes

◆ FudgeFactor

◆ NumberOfLocatorPoints

◆ LocatorPoints

◆ LocatorIds

◆ MaxWidth

◆ CreateCubicOctants