Skip to content

Commit 560ee5a

Browse files
committed
feat: update cropbox filter README
Signed-off-by: yoshiri <yoshiyoshidetteiu@gmail.com>
1 parent 555be5f commit 560ee5a

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

sensing/pointcloud_preprocessor/docs/crop-box-filter.md

+37-1
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,15 @@
44

55
The `crop_box_filter` is a node that removes points with in a given box region. This filter is used to remove the points that hit the vehicle itself.
66

7+
There are two nodes belongs to this package.
8+
9+
- `crop_box_filter_node`: This node is a ROS2 node that subscribes to a point cloud topic and publishes the filtered point cloud topic.
10+
- `crop_boxes_filter_node`: This node has same functionality as `crop_box_filter_node`, but it can handle multiple crop boxes.
11+
712
## Inner-workings / Algorithms
813

9-
`pcl::CropBox` is used, which filters all points inside a given box.
14+
Crop box filter is a simple filter that removes points inside a given box.
15+
Remember cropbox coordinate is defined in the `input_frame` frame.
1016

1117
## Inputs / Outputs
1218

@@ -20,6 +26,8 @@ This implementation inherit `pointcloud_preprocessor::Filter` class, please refe
2026

2127
### Core Parameters
2228

29+
For `crop_box_filter_node` and `crop_boxes_filter_node`, the following parameters are used to describe each cropbox.
30+
2331
| Name | Type | Default Value | Description |
2432
| ------- | ------ | ------------- | ----------------------------------------- |
2533
| `min_x` | double | -1.0 | x-coordinate minimum value for crop range |
@@ -29,6 +37,34 @@ This implementation inherit `pointcloud_preprocessor::Filter` class, please refe
2937
| `min_z` | double | -1.0 | z-coordinate minimum value for crop range |
3038
| `max_z` | double | 1.0 | z-coordinate maximum value for crop range |
3139

40+
For multiple crop boxes in `crop_boxes_filter_node`, the following parameters are used to describe each cropbox.
41+
42+
| Name | Type | Default Value | Description |
43+
| ------------------ | -------- | ------------- | --------------------------------------------------------------------- |
44+
| `crop_boxes_names` | string[] | [] | Names of crop boxes |
45+
| `crop_boxes` | map | {} | Map of crop boxes. Each crop box is described by the above parameters |
46+
47+
Example of `crop_boxes` parameter is:
48+
49+
```yaml
50+
crop_boxes_names: ["right", "left"]
51+
crop_boxes:
52+
right:
53+
min_longitudinal_offset: 4.8
54+
max_longitudinal_offset: 5.3
55+
min_lateral_offset: -1.3
56+
max_lateral_offset: -1.05
57+
min_height_offset: 1.85
58+
max_height_offset: 2.59
59+
left:
60+
min_longitudinal_offset: 4.83
61+
max_longitudinal_offset: 6.0
62+
min_lateral_offset: 0.95
63+
max_lateral_offset: 1.28
64+
min_height_offset: 1.95
65+
max_height_offset: 2.6
66+
```
67+
3268
## Assumptions / Known limits
3369
3470
## (Optional) Error detection and handling

0 commit comments

Comments
 (0)