Jet  v1.3.3
Classes | Public Member Functions | Static Public Member Functions | List of all members
jet::PointHashGridSearcher3 Class Referencefinal

Hash grid-based 3-D point searcher. More...

#include <jet/point_hash_grid_searcher3.h>

Inheritance diagram for jet::PointHashGridSearcher3:
jet::PointNeighborSearcher3 jet::Serializable

Classes

class  Builder
 Front-end to create PointHashGridSearcher3 objects step by step. More...
 

Public Member Functions

 PointHashGridSearcher3 (const Size3 &resolution, double gridSpacing)
 Constructs hash grid with given resolution and grid spacing. More...
 
 PointHashGridSearcher3 (size_t resolutionX, size_t resolutionY, size_t resolutionZ, double gridSpacing)
 Constructs hash grid with given resolution and grid spacing. More...
 
 PointHashGridSearcher3 (const PointHashGridSearcher3 &other)
 Copy constructor. More...
 
void build (const ConstArrayAccessor1< Vector3D > &points) override
 Builds internal acceleration structure for given points list. More...
 
void forEachNearbyPoint (const Vector3D &origin, double radius, const ForEachNearbyPointFunc &callback) const override
 
bool hasNearbyPoint (const Vector3D &origin, double radius) const override
 
void add (const Vector3D &point)
 Adds a single point to the hash grid. More...
 
const std::vector< std::vector< size_t > > & buckets () const
 Returns the internal bucket. More...
 
size_t getHashKeyFromBucketIndex (const Point3I &bucketIndex) const
 
Point3I getBucketIndex (const Vector3D &position) const
 
PointNeighborSearcher3Ptr clone () const override
 Creates a new instance of the object with same properties than original. More...
 
PointHashGridSearcher3operator= (const PointHashGridSearcher3 &other)
 Assignment operator. More...
 
void set (const PointHashGridSearcher3 &other)
 Copy from the other instance. More...
 
void serialize (std::vector< uint8_t > *buffer) const override
 Serializes the neighbor searcher into the buffer. More...
 
void deserialize (const std::vector< uint8_t > &buffer) override
 Deserializes the neighbor searcher from the buffer. More...
 
- Public Member Functions inherited from jet::PointNeighborSearcher3
 PointNeighborSearcher3 ()
 Default constructor. More...
 
virtual ~PointNeighborSearcher3 ()
 Destructor. More...
 
virtual std::string typeName () const =0
 Returns the type name of the derived class. More...
 
- Public Member Functions inherited from jet::Serializable
 Serializable ()=default
 
virtual ~Serializable ()=default
 

Static Public Member Functions

static Builder builder ()
 Returns builder fox PointHashGridSearcher3. More...
 

Additional Inherited Members

- Public Types inherited from jet::PointNeighborSearcher3
typedef std::function< void(size_t, const Vector3D &)> ForEachNearbyPointFunc
 

Detailed Description

Hash grid-based 3-D point searcher.

This class implements 3-D point searcher by using hash grid for its internal acceleration data structure. Each point is recorded to its corresponding bucket where the hashing function is 3-D grid mapping.

Constructor & Destructor Documentation

◆ PointHashGridSearcher3() [1/3]

jet::PointHashGridSearcher3::PointHashGridSearcher3 ( const Size3 resolution,
double  gridSpacing 
)

Constructs hash grid with given resolution and grid spacing.

This constructor takes hash grid resolution and its grid spacing as its input parameters. The grid spacing must be 2x or greater than search radius.

Parameters
[in]resolutionThe resolution.
[in]gridSpacingThe grid spacing.

◆ PointHashGridSearcher3() [2/3]

jet::PointHashGridSearcher3::PointHashGridSearcher3 ( size_t  resolutionX,
size_t  resolutionY,
size_t  resolutionZ,
double  gridSpacing 
)

Constructs hash grid with given resolution and grid spacing.

This constructor takes hash grid resolution and its grid spacing as its input parameters. The grid spacing must be 2x or greater than search radius.

Parameters
[in]resolutionXThe resolution x.
[in]resolutionYThe resolution y.
[in]resolutionYThe resolution z.
[in]gridSpacingThe grid spacing.

◆ PointHashGridSearcher3() [3/3]

jet::PointHashGridSearcher3::PointHashGridSearcher3 ( const PointHashGridSearcher3 other)

Copy constructor.

Member Function Documentation

◆ add()

void jet::PointHashGridSearcher3::add ( const Vector3D point)

Adds a single point to the hash grid.

This function adds a single point to the hash grid for future queries. It can be used for a hash grid that is already built by calling function PointHashGridSearcher3::build.

Parameters
[in]pointThe point to be added.

◆ buckets()

const std::vector<std::vector<size_t> >& jet::PointHashGridSearcher3::buckets ( ) const

Returns the internal bucket.

A bucket is a list of point indices that has same hash value. This function returns the (immutable) internal bucket structure.

Returns
List of buckets.

◆ build()

void jet::PointHashGridSearcher3::build ( const ConstArrayAccessor1< Vector3D > &  points)
overridevirtual

Builds internal acceleration structure for given points list.

Implements jet::PointNeighborSearcher3.

◆ builder()

static Builder jet::PointHashGridSearcher3::builder ( )
static

Returns builder fox PointHashGridSearcher3.

◆ clone()

PointNeighborSearcher3Ptr jet::PointHashGridSearcher3::clone ( ) const
overridevirtual

Creates a new instance of the object with same properties than original.

Returns
Copy of this object.

Implements jet::PointNeighborSearcher3.

◆ deserialize()

void jet::PointHashGridSearcher3::deserialize ( const std::vector< uint8_t > &  buffer)
overridevirtual

Deserializes the neighbor searcher from the buffer.

Implements jet::Serializable.

◆ forEachNearbyPoint()

void jet::PointHashGridSearcher3::forEachNearbyPoint ( const Vector3D origin,
double  radius,
const ForEachNearbyPointFunc callback 
) const
overridevirtual

Invokes the callback function for each nearby point around the origin within given radius.

Parameters
[in]originThe origin position.
[in]radiusThe search radius.
[in]callbackThe callback function.

Implements jet::PointNeighborSearcher3.

◆ getBucketIndex()

Point3I jet::PointHashGridSearcher3::getBucketIndex ( const Vector3D position) const

Gets the bucket index from a point.

Parameters
[in]positionThe position of the point.
Returns
The bucket index.

◆ getHashKeyFromBucketIndex()

size_t jet::PointHashGridSearcher3::getHashKeyFromBucketIndex ( const Point3I bucketIndex) const

Returns the hash value for given 3-D bucket index.

Parameters
[in]bucketIndexThe bucket index.
Returns
The hash key from bucket index.

◆ hasNearbyPoint()

bool jet::PointHashGridSearcher3::hasNearbyPoint ( const Vector3D origin,
double  radius 
) const
overridevirtual

Returns true if there are any nearby points for given origin within radius.

Parameters
[in]originThe origin.
[in]radiusThe radius.
Returns
True if has nearby point, false otherwise.

Implements jet::PointNeighborSearcher3.

◆ operator=()

PointHashGridSearcher3& jet::PointHashGridSearcher3::operator= ( const PointHashGridSearcher3 other)

Assignment operator.

◆ serialize()

void jet::PointHashGridSearcher3::serialize ( std::vector< uint8_t > *  buffer) const
overridevirtual

Serializes the neighbor searcher into the buffer.

Implements jet::Serializable.

◆ set()

void jet::PointHashGridSearcher3::set ( const PointHashGridSearcher3 other)

Copy from the other instance.


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