Commit a1ac434d authored by André Anjos's avatar André Anjos 💬

Improve help message

parent 2949b5af
#!/usr/bin/env python
# vim: set fileencoding=utf-8 :
"""A TkInter-based keypoint annotation tool for images
This tool allows you to annotate images using lines and polygons. A line is
defined by a connection of points (annotations) you will click on the image.
Each annotated line can have any number of points. A point can be annotated
using the "line" mode and clicking on a single point. Polygons are similar to
lines, except they define internal and external sides. To ease annotation, the
inner side of polygons is filled using a translucid color. Connections between
line points are also drawn for the same purpose. This program does not save
anything else than hand-clicked annotations. Connections drawn and the polygon
filling are just there for semantical interpretation of hand-drawn annotations.
This tool treats any number of image inputs, one after the other. As images are
loaded, annotations for the previous image are saved on a text file, following
a simple format (y,x) keeping the order in which they where inserted.
"""A keypoint annotation tool for images
This tool allows you to annotate batches of images using keypoints. A keypoint
is placed everytime you click (left-mouse button) on the image being annotated.
The tool can be used to annotate single points and sequences of points making
up a line or a polygon. This tool does not record the type of annotation, just
the keypoints are stored. You can select during display the type of decoration
to use for highlighting the annotation (line or polygon). In this sense, the
connections drawn and the polygon filling are just there for semantical
interpretation of hand-placed keypoints.
This tool treats any number of image inputs, one after the other. As images
are loaded, annotations for the previous image are automatically saved on a
text file, following a simple format (y,x) keeping the order in which they
where inserted.
It is recommended you familiarize yourself with the keyboard and pointer (mouse
use is recommended) bellow so you can use this tool more efficiently. A few
key actions are displayed on the left of the tool canvas and provides a
faster start for new users.
You can start this application in editing (default) or viewing mode. If you
use it to view annotations only, you will not be able to edit the keypoints.
Keyboard shortcuts
------------------
? : this help message
? : opens a dialog with this help message
a | Zero | KP_Zero : places new point under pointer cursor, on the currently
active (annotation) object
......@@ -56,6 +65,7 @@ q : quits the application, saving annotations for the current image
<Esc> : Quits the application, does not save anything
Annotation displacement
-----------------------
......@@ -84,9 +94,6 @@ Wheel Down : moves to the next image
Wheel Up : moves to the previous image
Note: In read-only mode, it is not possible to modify, create or remove
existing annotations.
"""
......
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