Commit 7a24a87b authored by André Anjos's avatar André Anjos

[doc] Improve documentation guide

parent 88e4625c
Pipeline #26581 canceled with stage
in 5 minutes and 15 seconds
......@@ -45,19 +45,50 @@ and, finally *Help*. The *Objects* section show how many objects have been
annotated on the image. You may annotate any number of objects in each image.
Each annotation is just a set of points clicked on the screen. The sequence in
which the points are clicked is preserved. By pressing the ``ALT`` key on your
keyboard (any of the two normally available), the application draws on the
screen either a line or polygon connecting such dots so you can better
visualize annotated objects. The choice between drawing a line or polygon on
connecting annotated objects can be selected using the button that says *mode*
on the left pane. You may optionally press the keyboard shortcut ``m`` to
switch modes. Notice that lines and polygons drawn at the screen are drawn
only for informational purposes - such information is not recorded to the
keyboard (any of the two normally available), the application *temporarily*
draws on the screen either a line or polygon connecting such dots so you can
better visualize annotated objects. The choice between drawing a line or
polygon on connecting annotated objects can be selected using the button that
says *mode* on the left pane. You may optionally press the keyboard shortcut
``m`` to switch modes. Notice that lines and polygons drawn at the screen are
drawn only for informational purposes - such information is not recorded to the
output files, which only preserve points and the order in which points were
annotated.
.. tip::
By using the check-button "Decorations" on the left pane, you may switch ON
or OFF the drawing of line/polygon connectors on the screen. The keyboard
shortcuts ``t`` and ``T`` can be used to switch ON or OFF this functionality
as well.
To annotate the image, click on the image using a mouse or trackpad. If using
a mouse, use its left button to add a key point to the current object being
annotated. You may switch between the objects annotated using the keyboard
a mouse, use its left button to append a key point to the current object being
annotated. Alternatively, use the ``a`` keyboard key to append a new keypoint,
under the pointer cursor, to the active annotation set. When you append a new
keypoint, it becomes automatically the last keypoint on the set. You may also
*insert* a new keypoint **before** another existing keypoint (notice order is
an important factor here). If you wish to insert a new keypoint **before** an
existing one, in the middle of a sequence, move the cursor so it highlights the
closest keypoint that will come **after** the keypoint you wish to insert.
Once you have it highlit, press ``i`` or use the ``SHIFT`` key combined with a
left-mouse button or trackpad click.
.. warning::
Currently, keypoint insertion only works this way. If you wish to insert a
keypoint such that it would be closer to an existing keypoint that must come
before the new entry, highlight the keypoint that comes immediately after,
insert the keypoint using the keyboard, mouse or trackpad and then move it
to the desired location.
To better visualize the order of keypoints, enable drawing of
``Decorations`` by either click the check-button on the left pane or pushing
the keyboard key ``t``.
You may switch between the objects annotated using the keyboard
shortcuts ``o`` (next) or ``O`` (previous), or use the pane on the left. If
you'd like to annotate a new object on the current image, click on ``create``
or use the keyboard shortcut ``c``. To delete an object use the keyboard
......@@ -81,11 +112,11 @@ the left pane. Once an annotation set is highlit (in yellow), a single
keypoint will be indicated in red - that is the *active* keypoint. Keyboard
commands apply only to the active keypoint. To delete a single keypoint, use
the ``d`` keyboard shortcut, or the right-button of your mouse. To do so,
first select the keypoint by simply approaching it with your mouse pointer,
first select the keypoint by simply approaching it with your pointer cursor,
*without* clicking. Once you get close enough, the point of interest becomes
red. Once the point is red, you may delete it using the ``d`` keyboard
shortcut. You may also move the point using the arrow keys on your keyboard.
The point from the current active set closest to the pointer is always the
The point from the current active set closest to the cursor is always the
active one.
.. _annotate-objects:
......@@ -202,7 +233,8 @@ Adaptive Histogram Equalization using
size and clipping parameters using the text boxes under the filter heading. If
the filter is already on, and you wish to change its parameters, then click it
off and then on back again. Once the filter is active, it will remain active
for the next images as well.
for the next images as well. Alternatively use the keyboard shortcuts ``f`` to
toggle the filter ON or ``F`` to toggle it off.
Further help
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment