Skip to content

Commit e55da98

Browse files
committed
Improve grid filter base comment
1 parent dea8e98 commit e55da98

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

filters/include/pcl/filters/experimental/transform_filter.h

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,16 @@ namespace experimental {
1818

1919
/**
2020
* \brief Filter point clouds based on a templated grid structure
21-
* \details Used as the base class for filters based on grid structure, e.g. VoxelGrid,
22-
* ApproximateVoxelGrid. The grid structure has two main components: member functions
23-
* for filtering opterations, Grid member attribute for storing the information of
24-
* smaller spaces divided by the grid (e.g. voxels in VoxelGrid).
21+
* \details Used as the base class for grid based filters, e.g. VoxelGrid,
22+
* ApproximateVoxelGrid. For grid based filters with different behavior, one can
23+
* implement a custom grid structure and pass to this class. The templated grid
24+
* structure should have two main components: member functions for filtering
25+
* opterations, Grid member attribute for storing the information of the smaller spaces
26+
* divided by the grid (e.g. voxels in VoxelGrid).
2527
*
2628
* Requirements of the grid structure:
27-
* 1. Several member functions of the grid structure are called in applyFilter and
28-
* thus required to declare: setUp, addPointToGrid, filterGrid
29+
* 1. Three member functions (setUp, addPointToGrid, filterGrid) the grid structure are
30+
* called in applyFilter and thus required to declare.
2931
* 2. A Grid member attribute is required, it can be any type with built-in iterator,
3032
* e.g. STL container or custom grid with iterator
3133
* \ingroup filters

0 commit comments

Comments
 (0)