Skip to content

Commit 6154ce8

Browse files
committed
docs: explain invalid point remove
1 parent bc5036a commit 6154ce8

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -226,9 +226,23 @@ Parameters shared by all supported models:
226226
| invalid_point_remove | bool | false | true, false | Enable ring based filter* |
227227
| invalid_regions | string | | | Invalid point regions to remove* |
228228

229-
*Ring based filter to remove reflected points and vehicle points.
230-
Points will be removed from specified rings within the corresponding angle ranges.
229+
*`invalid_point_remove` activates the ring based filter which removes points if they are within specified angle ranges.
231230

231+
*The format for an invalid region is [ring_id, start_angle, end_angle]
232+
233+
*Angles are given in degrees and multiplied by 100. For instance, 34.44 degrees is represented as 3444.
234+
235+
*Invalid regions are specified as a string containing a list of invalid regions. Ensure that you have quotation marks to make it string. For example:
236+
```xml
237+
<node pkg="nebula_ros" exec="velodyne_driver_ros_wrapper_node"
238+
name="velodyne_cloud" output="screen">
239+
...
240+
<param name="invalid_point_remove" value="true"/>
241+
<param name="invalid_regions" value="'[[0, 3500, 6900], [1, 3400, 6500], [2, 3200, 4600], [3, 3200, 4600]]'"/>
242+
</node>
243+
```
244+
245+
*Multiple invalid regions are possible for the same ring.
232246

233247
## Software design overview
234248

0 commit comments

Comments
 (0)