Skip to content

Commit

Permalink
doc/jsk_rviz_plugins/plugins/bounding_box_array.rst: add properties
Browse files Browse the repository at this point in the history
  • Loading branch information
k-okada committed Dec 11, 2024
1 parent d44e590 commit 044421b
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions doc/jsk_rviz_plugins/plugins/bounding_box_array.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,37 @@ What is this?
Visualize ``jsk_recognition_msgs/BoundingBoxArray.msg``.

.. image:: images/bounding_box_array.png

Properties
**********

.. image:: images/bounding_box_array_rviz.gif


- `Topic`

Name of topic of `jsk_recognition_msgs/BoundingBoxArray`

- `coloring`

`Flat Color` applies the same color to all boxes. `Label` uses the
label value of each box for coloring, and `Value` applies the alpha
value from the box message.

- `alpha method`

`flat` applies the same alpha value to all boxes. You can set this
value in the `alpha` field. `value` uses the box message data, and the
alpha can be scaled by setting the `alpha min` and `alpha max` fields.

- `only edge`

If it is true, only the edges of the boxes will be displayed.

- `show coords`

If it is true, the coordinates of the boxes will be displayed.

- `value threshold`

Display only boxes with alpha value avobe this threshold.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 044421b

Please sign in to comment.