Add Vector Object server documentation

configuration/index.rst

@@ -34,3 +34,4 @@ the best navigation performance.
  packages/configuring-velocity-smoother.rst
  packages/configuring-collision-monitor.rst
  packages/configuring-waypoint-follower.rst
+ packages/configuring-vector-object-server.rst

configuration/packages/configuring-vector-object-server.rst

@@ -0,0 +1,323 @@
+.. _configuring_vector_object_server:
+
+Vector Object Server
+####################
+
+Vector Object server - is a node that puts vector objects (such as polygons and circles) on OccupancyGrid raster map. The output raster map is being published by Vector Object server, and it could be used anywhere in the Nav2 stack or outside it.
+
+The main application of Vector Object server - is to combine output raster maps with existing costmaps of environment, targeting for robot navigation purposes (for example for dynamic obstacles simulation/highlighting, sensors noise removal, black-out areas on maps, synthetic testing purposes, and much more).
+Typical set-up model for this - is Nav2 stack with enabled Costmap Filters in it, which is operating along with Vector Object server producing vectorized OccupancyGrid maps as an input mask for Costmap Filters:
+
+.. image:: images/vector_object_server/vo_design.png
+ :width: 1000px
+ :align: center
+
+These vector shapes could be added by using input ROS-parameters as well as being handled by the following service calls: ``AddShapes.srv`` which adds new or modifies existing shapes, ``RemoveShapes.srv`` that removes any or all shapes from map and ``GetShapes.srv`` which reports back all shapes on map.
+
+Each vector shape is being handled by its UUID which is of ``unique_identifier_msgs/UUID`` type. Final developer could choose whether to specify it manually for a new shape, or it will be generated automatically by the Vector Object server. The UUID can be always obtained by making a ``GetShapes.srv`` request and getting the response with all shapes' UUID-s and their properties.
+
+During its work, Vector Object server puts shapes on map. Each vector object has its own value in the range from ``{-1}, [0..100]`` that is meeting OccupancyGrid values. Vector objects could be overlapped with each other by using one of the global overlapping rules: sequential overlay in the same order as vector objects have been arrived to server, or taking the maximum / minimum value from all vector objects and the map background (if it is known).
+
+This page describes all configuration parameters of the Vector Object server. For more information how to navigate with your own Vector Object server, please refer to the :ref:`navigation2_with_vector_objects` tutorial.
+
+Features
+********
+
+- The following vector shapes are currently supported to be put on map:
+
+ - Polygons
+ - Circles
+
+- Polygons could be filled with any value or drawn as polygonal chain, if it is not supposed to be a closed shape:
+
+.. image:: images/vector_object_server/polygon_closed.png
+ :width: 400px
+ :height: 200px
+ :align: center
+
+- Circles could be filled with some value or drawn without any fill (only circle border being put on map):
+
+.. image:: images/vector_object_server/circle_fill.png
+ :width: 400px
+ :height: 200px
+ :align: center
+
+- Vector shapes could be set once during the Vector Object server startup as ROS-parameters, and added/modified/removed over the time using the following service calls:
+
+ - ``AddShapes.srv`` - adds new or modifies existing shapes
+ - ``RemoveShapes.srv`` - removes any or all shapes from map
+ - ``GetShapes.srv`` - obtains all shapes and their properties
+
+- Vector shapes are being identified by their UUID (``unique_identifier_msgs/UUID``), which is generating automatically for a new shape, or could be given manually by developer
+- Vector shapes could be set in any frame:
+
+ - If at least one of the shape is set in different than map's frame, dynamic update model to be enabled: this shape can move over the time, output map will be published dynamically with a given rate.
+ - If all shapes are set in the same as map frame, map is being published/updated once: during Vector Object server startup and per each shape changing call (``AddShapes.srv`` or ``RemoveShapes.srv``).
+
+Covered use-cases
+*****************
+
+Using Vector Object server publishing an output map as input mask to :ref:`Costmap Filters <foxy_migration>` allows covering following (not restricted only to) use-cases:
+
+- No-access zone
+- Speed-restriction areas
+- Virtual obstacles on costmap
+- Flying zone for UAV-s with outer boundary and inner virtual obstacles
+- Robot footprint (or any other moving objects) replacement
+- Hiding some areas from costmap
+- Sensors noise removal
+- Dynamic objects simulation/highlighting
+- Other testing purposes
+
+Parameters
+**********
+
+:map_topic:
+
+ ============== =============================
+ Type Default
+ -------------- -----------------------------
+ string "vo_map"
+ ============== =============================
+
+ Description:
+ Output topic, publishing an OccupancyGrid map with vector objects put on it.
+
+:global_frame_id:
+
+ ============== =============================
+ Type Default
+ -------------- -----------------------------
+ string "map"
+ ============== =============================
+
+ Description:
+ The name of the coordinate frame where the map is being published at.
+
+:resolution:
+
+ ============== =============================
+ Type Default
+ -------------- -----------------------------
+ double 0.05
+ ============== =============================
+
+ Description:
+ Output map resolution in meters.
+
+:default_value:
+
+ ============== =============================
+ Type Default
+ -------------- -----------------------------
+ int -1 (unknown)
+ ============== =============================
+
+ Description:
+ Default OccupancyGrid value to fill the background of output map with.
+
+:overlay_type:
+
+ ============== =============================
+ Type Default
+ -------------- -----------------------------
+ int 0
+ ============== =============================
+
+ Description:
+ How one vector object to be overlaid with other and the map.
+ The following values are supported:
+
+ - 0 (``OVERLAY_SEQ``): Vector objects are superimposed in the order in which they have arrived.
+ - 1 (``OVERLAY_MAX``): Maximum value from vector objects and map is being chosen.
+ - 2 (``OVERLAY_MIN``): Minimum value from vector objects and map is being chosen. Unknown OccupancyGrid value is always being overrode, when it is possible.
+
+:update_frequency:
+
+ ============== =============================
+ Type Default
+ -------------- -----------------------------
+ double 1.0
+ ============== =============================
+
+ Description:
+ Output map update frequency (when dynamic update model is switched-on).
+
+:transform_tolerance:
+
+ ============== =============================
+ Type Default
+ -------------- -----------------------------
+ double 0.1
+ ============== =============================
+
+ Description:
+ Transform tolerance for the case when any of the shapes are placed in different than map's frame.
+
+:shapes:
+
+ ============== =============================
+ Type Default
+ -------------- -----------------------------
+ vector<string> {}
+ ============== =============================
+
+ Description:
+ List of vector objects (polygons and circles). Empty by-default.
+
+Shapes parameters
+=================
+
+``<shape_name>`` - is the corresponding shape name string selected for this vector object.
+
+:``<shape_name>``.type:
+
+ ============== =============================
+ Type Default
+ -------------- -----------------------------
+ string N/A
+ ============== =============================
+
+ Description:
+ Type of vector object shape. Available values are ``polygon`` and ``circle``. Causes an error, if not specialized.
+
+:``<shape_name>``.uuid:
+
+ ============== =============================
+ Type Default
+ -------------- -----------------------------
+ string N/A
+ ============== =============================
+
+ Description:
+ UUID of the shape specified in ``12345678-9abc-def0-1234-56789abcdef0`` format. Parameter is optional and could be skipped: if not specialized, Vector Object server will automatically generate a new one for the shape.
+
+:``<shape_name>``.frame_id:
+
+ ============== =============================
+ Type Default
+ -------------- -----------------------------
+ string ""
+ ============== =============================
+
+ Description:
+ Frame ID of the given shape. Empty value is being treated as map's global frame.
+
+:``<shape_name>``.value:
+
+ ============== =============================
+ Type Default
+ -------------- -----------------------------
+ int 100 (occupied)
+ ============== =============================
+
+ Description:
+ Shape's value to be put on map with.
+
+Parameters applicable for polygons only
+---------------------------------------
+
+:``<shape_name>``.points:
+
+ ============== =============================
+ Type Default
+ -------------- -----------------------------
+ vector<double> N/A
+ ============== =============================
+
+ Description:
+ Polygon vertexes, listed in ``{p1.x, p1.y, p2.x, p2.y, p3.x, p3.y, ...}`` format (e.g. ``{0.5, 0.5, 0.5, -0.5, -0.5, -0.5, -0.5, 0.5}`` for the square). Minimum 3 points for a triangle polygon. Causes an error, if not specialized incorrectly (less than 6 or odd number of items in the vector) or not specialized.
+
+:``<shape_name>``.closed:
+
+ ============== =============================
+ Type Default
+ -------------- -----------------------------
+ bool true
+ ============== =============================
+
+ Description:
+ Whether the polygon is closed (and filled), or drawn as polygonal chain otherwise.
+
+Parameters applicable for circles only
+--------------------------------------
+
+:``<shape_name>``.center:
+
+ ============== =============================
+ Type Default
+ -------------- -----------------------------
+ vector<double> N/A
+ ============== =============================
+
+ Description:
+ Center of the circle, listed in ``{center.x, center.y}`` format (e.g. ``{0.2, 0.3}``). Should contain exactly 2 items: X and Y coordinate of the circle's center in a given frame. Otherwise, causes an error.
+
+:``<shape_name>``.radius:
+
+ ============== =============================
+ Type Default
+ -------------- -----------------------------
+ double N/A
+ ============== =============================
+
+ Description:
+ Circle radius. Causes an error, if less than zero or not specialized.
+
+:``<shape_name>``.fill:
+
+ ============== =============================
+ Type Default
+ -------------- -----------------------------
+ bool true
+ ============== =============================
+
+ Description:
+ Whether the circle to be filled with a given value, or drawn only circle's border otherwise.
+
+Example
+*******
+
+Here is an example of configuration YAML for the Vector Object server:
+
+.. code-block:: yaml
+
+ vector_object_server:
+ ros__parameters:
+ map_topic: "vo_map"
+ global_frame_id: "map"
+ resolution: 0.05
+ default_value: -1
+ overlay_type: 0
+ update_frequency: 1.0
+ transform_tolerance: 0.1
+ shapes: ["Poly", "CircleA", "CircleB"]
+ Poly:
+ type: "polygon"
+ frame_id: "map"
+ closed: True
+ value: 100
+ points: [0.3, 0.3, 0.3, -0.3, 0.0, -0.3, 0.0, 0.3]
+ CircleA:
+ type: "circle"
+ frame_id: "map"
+ fill: True
+ value: 10
+ center: [3.0, 3.0]
+ radius: 0.5
+ uuid: "7b3f3d7d-135c-4b6c-aca1-7a84d1050505"
+ CircleB:
+ type: "circle"
+ frame_id: "map"
+ fill: False
+ value: 90
+ center: [3.5, 3.5]
+ radius: 1.5
+
+For this, Vector Object server will produce the following map:
+
+
+.. image:: images/vector_object_server/vo_config_map.png
+ :width: 636px
+ :height: 638px
+ :align: center

migration/Iron.rst

@@ -146,7 +146,7 @@ New features ``allow_primitive_interpolation`` which allows for more primitives
 New node in nav2_collision_monitor: Collision Detector
 ******************************************************
 
-In this `PR #3693 <https://github.com/ros-planning/navigation2/pull/3500>`_ A new node was introduced in the nav2_collision_monitor: Collision Detector. 
+In this `PR #3500 <https://github.com/ros-planning/navigation2/pull/3500>`_ A new node was introduced in the nav2_collision_monitor: Collision Detector. 
 It works similarly to the Collision Monitor, but does not affect the robot's velocity. It will only inform that data from the configured sources has been detected within the configured polygons via message to the ``collision_detector_state`` topic that might be used by any external module (e.g. switching LED or sound alarm in case of collision).
 
 Dynamic enabling/disabling of sources/polygons in Collision Monitor/Detector
@@ -254,3 +254,16 @@ In the GIF, it can be seen that there are two controller_ids namely, `FollowPath
 In this case, the `FollowPath` is the default controller_id. The difference between the two controller_ids is that HighSpeedFollowPath has a higher max velocity compared to the FollowPath. This difference can be well noted in the GIF.
 
 .. attention:: If a server is unavailable, then the combo box or the drop down list of the particular component will be empty.
+
+Vector Objects were Supported for Raster Maps
+*********************************************
+
+`PR #3930 <https://github.com/ros-planning/navigation2/pull/3930>`_ adds new Vector Object server into ``nav2_map_server`` package.
+It reads vector objects (polygons and polygonal chains as ``PolygonObject.msg``; and circles as ``CircleObject.msg``) from input parameters, handles them by service calls (``AddShapes.srv``/``GetShapes.srv``/``RemoveShapes.srv``) and finally puts them on output raster OccupancyGrid map.
+This map is typically used with costmaps by acting as an input mask for Costmap Filters.
+This allows to cover such use-cases as:
+adding virtual obstacles on maps, dynamic objects simulation/highlighting, hiding some areas or sticking-out robot parts, sensors noise removal, blacking-out areas on maps, adding keep-out or maximum speed restricted areas on vector basis, synthetic testing purposes, and much more.
+
+To run Vector Object server a new ``vector_object_server.launch.py`` launch-file is being supplied.
+:ref:`navigation2_with_vector_objects` tutorial explains how launch Vector Object server and navigate with vector objects added to raster costmaps.
+The information about Vector Object server parameters set-up could be found at :ref:`configuring_vector_object_server` configuration guide.

tutorials/docs/navigation2_with_keepout_filter.rst

@@ -284,7 +284,7 @@ After Costmap Filter Info Publisher Server and Map Server were launched and Keep
 
 .. code-block:: bash
 
- ros2 launch nav2_bringup tb3_simulation_launch.py
+ ros2 launch nav2_bringup tb3_simulation_launch.py headless:=False
 
 And check that filter is working properly as in the pictures below (first picture shows keepout filter enabled for the global costmap, second - differently-sized ``keepout_mask.pgm`` filter mask):
 

tutorials/docs/navigation2_with_speed_filter.rst

@@ -296,7 +296,7 @@ After Costmap Filter Info Publisher Server and Map Server were launched and Spee
 
 .. code-block:: bash
 
- ros2 launch nav2_bringup tb3_simulation_launch.py
+ ros2 launch nav2_bringup tb3_simulation_launch.py headless:=False
 
 For better visualization of speed filter mask, in RViz in the left ``Displays`` pane unfold ``Map`` and change ``Topic`` from ``/map`` -> to ``/speed_filter_mask``.
 Set the goal behind the speed restriction areas and check that the filter is working properly: robot should slow down when going through a speed restricting areas. Below is how it might look (first picture shows speed filter enabled for the global costmap, second - ``speed_mask.pgm`` filter mask):