From deaea10765927dd35717231ccb4739cfde18ed04 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mehmet=20Emin=20BA=C5=9EO=C4=9ELU?=
 <mehmeteminbasoglu@hotmail.com>
Date: Fri, 8 Mar 2024 12:44:49 +0300
Subject: [PATCH] docs: explain invalid point remove

---
 README.md | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 65d4b473d..914394462 100644
--- a/README.md
+++ b/README.md
@@ -226,9 +226,23 @@ Parameters shared by all supported models:
 | invalid_point_remove   | bool   | false    | true, false      | Enable ring based filter*        |
 | invalid_regions        | string |          |                  | Invalid point regions to remove* |
 
-*Ring based filter to remove reflected points and vehicle points.
-Points will be removed from specified rings within the corresponding angle ranges.
+*`invalid_point_remove` activates the ring based filter which removes points if they are within specified angle ranges. 
 
+*The format for an invalid region is [ring_id, start_angle, end_angle]
+
+*Angles are given in degrees and multiplied by 100. For instance, 34.44 degrees is represented as 3444. 
+
+*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:
+```xml
+<node pkg="nebula_ros" exec="velodyne_driver_ros_wrapper_node"
+          name="velodyne_cloud" output="screen">
+        ...
+        <param name="invalid_point_remove" value="true"/>
+        <param name="invalid_regions" value="'[[0, 3500, 6900], [1, 3400, 6500], [2, 3200, 4600], [3, 3200, 4600]]'"/>
+    </node>
+```
+
+*Multiple invalid regions are possible for the same ring.
 
 ## Software design overview