VTK
|
quickly locate points in 3-space More...
#include <vtkStaticPointLocator.h>
Public Types | |
typedef vtkAbstractPointLocator | Superclass |
Standard type and print methods. More... | |
![]() | |
typedef vtkLocator | Superclass |
Standard type and print methods. More... | |
![]() | |
typedef vtkObject | Superclass |
Standard type and print methods. More... | |
Public Member Functions | |
virtual vtkTypeBool | 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... | |
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). More... | |
void | MergePoints (double tol, vtkIdType *mergeMap) |
Merge points in the locator given a tolerance. 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 | BuildLocator (const double *bounds) |
void | GenerateRepresentation (int level, vtkPolyData *pd) override |
Populate a polydata with the faces of the bins that potentially contain cells. 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... | |
virtual void | SetMaxNumberOfBuckets (vtkIdType) |
Set the maximum number of buckets in the locator. More... | |
virtual vtkIdType | GetMaxNumberOfBuckets () |
bool | GetLargeIds () |
Inform the user as to whether large ids are being used. More... | |
virtual double * | GetSpacing () |
Provide an accessor to the bucket spacing. More... | |
virtual void | GetSpacing (double spacing[3]) |
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 *) |
![]() | |
vtkAbstractPointLocator * | NewInstance () const |
vtkIdType | FindClosestPoint (double x, double y, double z) |
void | FindClosestNPoints (int N, double x, double y, double z, vtkIdList *result) |
void | FindPointsWithinRadius (double R, double x, double y, double z, vtkIdList *result) |
virtual double * | GetBounds () |
Provide an accessor to the bounds. More... | |
virtual void | GetBounds (double *) |
virtual vtkIdType | GetNumberOfBuckets () |
Return the total number of buckets in the locator. More... | |
![]() | |
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 (vtkTypeBool) |
Boolean controls whether locator depth/resolution of locator is computed automatically from average number of entities in bucket. More... | |
virtual vtkTypeBool | 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... | |
![]() | |
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 *) |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
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) |
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) |
![]() | |
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 vtkTypeBool | IsTypeOf (const char *type) |
static vtkStaticPointLocator * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkAbstractPointLocator * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkLocator * | SafeDownCast (vtkObjectBase *o) |
![]() | |
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 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 | |
![]() | |
vtkAbstractPointLocator () | |
~vtkAbstractPointLocator () override | |
![]() | |
vtkLocator () | |
~vtkLocator () override | |
void | ReportReferences (vtkGarbageCollector *) override |
![]() | |
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. More... | |
void | InternalReleaseFocus () |
![]() | |
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 |
vtkIdType | MaxNumberOfBuckets |
bool | LargeIds |
![]() | |
double | Bounds [6] |
vtkIdType | NumberOfBuckets |
![]() | |
vtkDataSet * | DataSet |
vtkTypeBool | Automatic |
double | Tolerance |
int | MaxLevel |
int | Level |
vtkTimeStamp | BuildTime |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
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.
Definition at line 63 of file vtkStaticPointLocator.h.
Standard type and print methods.
Definition at line 76 of file vtkStaticPointLocator.h.
|
protected |
|
overrideprotected |
|
static |
Construct with automatic computation of divisions, averaging 5 points per bucket.
|
static |
|
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.
|
static |
|
protectedvirtual |
Reimplemented from vtkAbstractPointLocator.
vtkStaticPointLocator* vtkStaticPointLocator::NewInstance | ( | ) | const |
|
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.
|
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.
|
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.
|
virtual |
|
virtual |
|
virtual |
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.
|
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.
|
virtual |
|
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.
|
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.
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.)
Merge points in the locator given a tolerance.
Return a merge map which represents the mapping of "concident" point ids to a single point. 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.
|
overridevirtual |
See vtkLocator and vtkAbstractPointLocator interface documentation.
These methods are not thread safe.
Reimplemented from vtkLocator.
|
overridevirtual |
Free the memory required for the spatial data structure.
Implements vtkLocator.
|
overridevirtual |
Build the locator from the input dataset.
Implements vtkLocator.
void vtkStaticPointLocator::BuildLocator | ( | const double * | bounds | ) |
|
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.
Given a bucket number bNum between 0 <= bNum < this->GetNumberOfBuckets(), return the number of points found in the bucket.
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.
|
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.
|
virtual |
|
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 228 of file vtkStaticPointLocator.h.
|
inlinevirtual |
Provide an accessor to the bucket spacing.
Valid after the locator is built.
Definition at line 235 of file vtkStaticPointLocator.h.
|
inlinevirtual |
Definition at line 236 of file vtkStaticPointLocator.h.
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.
vtkIdType vtkAbstractPointLocator::FindClosestPoint |
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.
void vtkAbstractPointLocator::FindClosestNPoints |
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.
void vtkAbstractPointLocator::FindPointsWithinRadius |
|
inline |
Provide an accessor to the bounds.
Valid after the locator is built.
Definition at line 103 of file vtkAbstractPointLocator.h.
virtual void vtkAbstractPointLocator::GetBounds |
|
protected |
Definition at line 244 of file vtkStaticPointLocator.h.
|
protected |
Definition at line 245 of file vtkStaticPointLocator.h.
|
protected |
Definition at line 246 of file vtkStaticPointLocator.h.
|
protected |
Definition at line 247 of file vtkStaticPointLocator.h.
|
protected |
Definition at line 248 of file vtkStaticPointLocator.h.
|
protected |
Definition at line 249 of file vtkStaticPointLocator.h.