Interface for voxel masker for the VoxelMap class. More...
#include <voxel_map.hpp>
Public Types | |
| typedef CoordType_ | CoordType |
| the coordinate type More... | |
| typedef Tiny::Vector< CoordType_, dim_ > | PointType |
| the point type More... | |
Public Member Functions | |
| virtual | ~VoxelMasker () |
| virtual destructor More... | |
| virtual void | mask_line (std::vector< int > &mask, const CoordType x_min, const CoordType x_max, const PointType &point)=0 |
| Computes the mask for an entire X-coordinate row. More... | |
Static Public Member Functions | |
| static CoordType | x_coord (const CoordType x_min, const CoordType x_max, const std::size_t i, const std::size_t n) |
| Computes the X-coordinate for a given point. More... | |
Detailed Description
class FEAT::Geometry::VoxelMasker< CoordType_, dim_ >
Interface for voxel masker for the VoxelMap class.
A voxel masker is basically an object that performs an inside-outside-test for some sort of geometrical object for a given point in X/Y/Z coordinates. To reduce the overhead introduced by virtual function calls, this class provides an abstract method mask_line that will perform the I/O-test for an entire row/line of points with common Y/Z coordinates at once rather than for a single point.
Definition at line 70 of file voxel_map.hpp.
Member Typedef Documentation
◆ CoordType
| typedef CoordType_ FEAT::Geometry::VoxelMasker< CoordType_, dim_ >::CoordType |
the coordinate type
Definition at line 74 of file voxel_map.hpp.
◆ PointType
| typedef Tiny::Vector<CoordType_, dim_> FEAT::Geometry::VoxelMasker< CoordType_, dim_ >::PointType |
the point type
Definition at line 76 of file voxel_map.hpp.
Constructor & Destructor Documentation
◆ ~VoxelMasker()
|
inlinevirtual |
virtual destructor
Definition at line 79 of file voxel_map.hpp.
Member Function Documentation
◆ mask_line()
|
pure virtual |
Computes the mask for an entire X-coordinate row.
This function is called by the VoxelMap class to perform the inside/outside-test for a line of points with common Y/Z coordinates, where the X coordinates of the points have to be computed from the X-coordinate range and the number points by calling the x_coord helper function.
- Attention
- This function must be implemented in a thread-safe fashion, since the VoxelMap class makes use of OpenMP parallelization to speed up the map computation time.
- Parameters
-
[in,out] mask The mask vector for the current X-row. Is allocated to correct size, but its contents are undefined upon entry. Assuming that the length of this vector is n, then the i-th entry of the mask vector is to be set to 1 if the point with the X-coordinate equal to x_coord(x_min, x_max, i, mask.size()) is inside the mask, otherwise it is to be set to 0. [in] x_min,x_max The minimal and maximal X-coordinate of the X-line for which the mask is to be computed. [in] point The point that contains the Y- and (in 3D) Z-coordinates of the X-line that for which the mask is to be computed. The first coordinate, i.e. point[0], is undefined, so only point[1] and (in 3D) point[2] are set to the Y-/Z-coords.
Implemented in FEAT::Geometry::VoxelCGALMasker< CoordType_ >, FEAT::Geometry::VoxelLambdaMasker< Lambda_, CoordType_, dim_ >, and FEAT::Geometry::VoxelFormulaMasker< dim_ >.
Referenced by FEAT::Geometry::VoxelMap::_compute_voxel_map_lines().
◆ x_coord()
|
inlinestatic |
Computes the X-coordinate for a given point.
This helper function can be used by derived classes to compute the X-coordinate for a single point on the mask line.
- Parameters
-
[in] x_min,x_max The minimal and maximal X-coordinate of the X-line for which the mask is to be computed. [in] i The index of the current point in the X-line that is being tested [in] n The number of points in the line; corresponds to mask.size()
- Returns
- The X-coordinate of the current point
Definition at line 101 of file voxel_map.hpp.
Referenced by FEAT::Geometry::VoxelLambdaMasker< Lambda_, CoordType_, dim_ >::mask_line().
The documentation for this class was generated from the following file:
- kernel/geometry/voxel_map.hpp
