VTK  9.1.0
vtkPointLocator.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkPointLocator.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
88#ifndef vtkPointLocator_h
89#define vtkPointLocator_h
90
91#include "vtkCommonDataModelModule.h" // For export macro
93
94class vtkCellArray;
95class vtkIdList;
96class vtkNeighborPoints;
97class vtkPoints;
98
99class VTKCOMMONDATAMODEL_EXPORT vtkPointLocator : public vtkIncrementalPointLocator
100{
101public:
107
109
113 void PrintSelf(ostream& os, vtkIndent indent) override;
115
117
120 vtkSetVector3Macro(Divisions, int);
121 vtkGetVectorMacro(Divisions, int, 3);
123
125
128 vtkSetClampMacro(NumberOfPointsPerBucket, int, 1, VTK_INT_MAX);
129 vtkGetMacro(NumberOfPointsPerBucket, int);
131
132 // Re-use any superclass signatures that we don't override.
134
141 vtkIdType FindClosestPoint(const double x[3]) override;
142
144
151 vtkIdType FindClosestPointWithinRadius(double radius, const double x[3], double& dist2) override;
153 double radius, const double x[3], double inputDataLength, double& dist2);
155
162 int InitPointInsertion(vtkPoints* newPts, const double bounds[6]) override;
163
170 int InitPointInsertion(vtkPoints* newPts, const double bounds[6], vtkIdType estNumPts) override;
171
181 void InsertPoint(vtkIdType ptId, const double x[3]) override;
182
193 vtkIdType InsertNextPoint(const double x[3]) override;
194
196
201 vtkIdType IsInsertedPoint(double x, double y, double z) override
202 {
203 double xyz[3];
204 xyz[0] = x;
205 xyz[1] = y;
206 xyz[2] = z;
207 return this->IsInsertedPoint(xyz);
208 };
209 vtkIdType IsInsertedPoint(const double x[3]) override;
211
221 int InsertUniquePoint(const double x[3], vtkIdType& ptId) override;
222
230 vtkIdType FindClosestInsertedPoint(const double x[3]) override;
231
240 void FindClosestNPoints(int N, const double x[3], vtkIdList* result) override;
241
243
250 virtual void FindDistributedPoints(int N, const double x[3], vtkIdList* result, int M);
251 virtual void FindDistributedPoints(int N, double x, double y, double z, vtkIdList* result, int M);
253
260 void FindPointsWithinRadius(double R, const double x[3], vtkIdList* result) override;
261
268 virtual vtkIdList* GetPointsInBucket(const double x[3], int ijk[3]);
269
271
274 vtkGetObjectMacro(Points, vtkPoints);
276
278
282 void Initialize() override;
283 void FreeSearchStructure() override;
284 void BuildLocator() override;
285 void GenerateRepresentation(int level, vtkPolyData* pd) override;
287
288protected:
291
292 // place points in appropriate buckets
294 vtkNeighborPoints* buckets, const int ijk[3], const int ndivs[3], int level);
296 vtkNeighborPoints* buckets, const double x[3], const int ijk[3], double dist, int level);
297 void GetOverlappingBuckets(vtkNeighborPoints* buckets, const double x[3], double dist,
298 int prevMinLevel[3], int prevMaxLevel[3]);
299 void GenerateFace(int face, int i, int j, int k, vtkPoints* pts, vtkCellArray* polys);
300 double Distance2ToBucket(const double x[3], const int nei[3]);
301 double Distance2ToBounds(const double x[3], const double bounds[6]);
302
303 vtkPoints* Points; // Used for merging points
304 int Divisions[3]; // Number of sub-divisions in x-y-z directions
305 int NumberOfPointsPerBucket; // Used with previous boolean to control subdivide
306 vtkIdList** HashTable; // lists of point ids in buckets
307 double H[3]; // width of each bucket in x-y-z directions
308
312
313 // These are inlined methods and data members for performance reasons
314 double HX, HY, HZ;
315 double FX, FY, FZ, BX, BY, BZ;
316 vtkIdType XD, YD, ZD, SliceSize;
317
318 void GetBucketIndices(const double* x, int ijk[3]) const
319 {
320 // Compute point index. Make sure it lies within range of locator.
321 vtkIdType tmp0 = static_cast<vtkIdType>(((x[0] - this->BX) * this->FX));
322 vtkIdType tmp1 = static_cast<vtkIdType>(((x[1] - this->BY) * this->FY));
323 vtkIdType tmp2 = static_cast<vtkIdType>(((x[2] - this->BZ) * this->FZ));
324
325 ijk[0] = tmp0 < 0 ? 0 : (tmp0 >= this->XD ? this->XD - 1 : tmp0);
326 ijk[1] = tmp1 < 0 ? 0 : (tmp1 >= this->YD ? this->YD - 1 : tmp1);
327 ijk[2] = tmp2 < 0 ? 0 : (tmp2 >= this->ZD ? this->ZD - 1 : tmp2);
328 }
329
330 vtkIdType GetBucketIndex(const double* x) const
331 {
332 int ijk[3];
333 this->GetBucketIndices(x, ijk);
334 return ijk[0] + ijk[1] * this->XD + ijk[2] * this->SliceSize;
335 }
336
338
339private:
340 vtkPointLocator(const vtkPointLocator&) = delete;
341 void operator=(const vtkPointLocator&) = delete;
342};
343
344#endif
virtual vtkIdType FindClosestPoint(const double x[3])=0
Given a position x, return the id of the point closest to it.
object to represent cell connectivity
Definition: vtkCellArray.h:290
list of point or cell ids
Definition: vtkIdList.h:140
Abstract class in support of both point location and point insertion.
virtual vtkIdType IsInsertedPoint(double x, double y, double z)=0
Determine whether or not a given point has been inserted.
a simple class to control print indentation
Definition: vtkIndent.h:113
quickly locate points in 3-space
void InsertPoint(vtkIdType ptId, const double x[3]) override
Incrementally insert a point into search structure with a particular index value.
int InitPointInsertion(vtkPoints *newPts, const double bounds[6]) override
Initialize the point insertion process.
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.
vtkIdType IsInsertedPoint(double x, double y, double z) override
Determine whether point given by x[3] has been inserted into points list.
void BuildLocator() override
See vtkLocator interface documentation.
void FindClosestNPoints(int N, const double x[3], vtkIdList *result) override
Find the closest N points to a position.
virtual void FindDistributedPoints(int N, double x, double y, double z, vtkIdList *result, int M)
Find the closest points to a position such that each octant of space around the position contains at ...
virtual vtkIdList * GetPointsInBucket(const double x[3], int ijk[3])
Given a position x, return the list of points in the bucket that contains the point.
static vtkPointLocator * New()
Construct with automatic computation of divisions, averaging 25 points per bucket.
void GetBucketIndices(const double *x, int ijk[3]) const
void GetBucketNeighbors(vtkNeighborPoints *buckets, const int ijk[3], const int ndivs[3], int level)
virtual void FindDistributedPoints(int N, const double x[3], vtkIdList *result, int M)
Find the closest points to a position such that each octant of space around the position contains at ...
void FreeSearchStructure() override
See vtkLocator interface documentation.
vtkIdList ** HashTable
void Initialize() override
See vtkLocator interface documentation.
vtkIdType FindClosestPoint(const double x[3]) override
Given a position x, return the id of the point closest to it.
double Distance2ToBucket(const double x[3], const int nei[3])
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for type management and printing.
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.
void ComputePerformanceFactors()
vtkIdType IsInsertedPoint(const double x[3]) override
Determine whether point given by x[3] has been inserted into points list.
~vtkPointLocator() override
void GenerateRepresentation(int level, vtkPolyData *pd) override
See vtkLocator interface documentation.
void GenerateFace(int face, int i, int j, int k, vtkPoints *pts, vtkCellArray *polys)
vtkIdType InsertionPointId
void GetOverlappingBuckets(vtkNeighborPoints *buckets, const double x[3], double dist, int prevMinLevel[3], int prevMaxLevel[3])
void GetOverlappingBuckets(vtkNeighborPoints *buckets, const double x[3], const int ijk[3], double dist, int level)
vtkPoints * Points
vtkIdType GetBucketIndex(const double *x) const
vtkIdType InsertNextPoint(const double x[3]) override
Incrementally insert a point into search structure.
int InsertUniquePoint(const double x[3], vtkIdType &ptId) override
Determine whether point given by x[3] has been inserted into points list.
void FindPointsWithinRadius(double R, const double x[3], vtkIdList *result) override
Find all points within a specified radius R of position x.
double Distance2ToBounds(const double x[3], const double bounds[6])
int InitPointInsertion(vtkPoints *newPts, const double bounds[6], vtkIdType estNumPts) override
Initialize the point insertion process.
vtkIdType FindClosestInsertedPoint(const double x[3]) override
Given a position x, return the id of the point closest to it.
represent and manipulate 3D points
Definition: vtkPoints.h:143
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:195
int vtkIdType
Definition: vtkType.h:332
#define VTK_INT_MAX
Definition: vtkType.h:155