Update item Bottom panel in User Guide (#1509)

* Update item Bottom panel in User Guide

rename the "Bottom panel" to the "Top panel"

* Fixed typos, remove trailing spaces in user_guide.md

* Fix user_guide.md and update image051.jpg
main
TOsmanov 6 years ago committed by GitHub
parent fb380d9855
commit fc2f02a406
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 5.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 5.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 5.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 4.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 91 KiB

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.6 KiB

After

Width:  |  Height:  |  Size: 5.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.5 KiB

After

Width:  |  Height:  |  Size: 5.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

@ -681,22 +681,14 @@ In tab ``Workspace`` you can:
- Press `` Go back`` or ``F3`` to return to the annotation.
---
Go to the next/previous frame with step equals to 1. Shortcuts: ``D`` — previous, ``F`` — next.
![](static/documentation/images/image040.jpg)
### Top Panel
---
Play the sequence of frames or the set of images. Shortcut: ``Space`` (change at ``Open Menu`` —> ``Settings`` —> ``Player Speed``).
![](static/documentation/images/image041.jpg)
![](static/documentation/images/image035.jpg)
---
Go to specified frame. Press ``~`` to focus on the element.
![](static/documentation/images/image060.jpg)
---
**Open Menu** button
#### Menu button
It is the main menu of the annotation tool. It can be used to download, upload and remove annotations.
@ -704,97 +696,88 @@ It is the main menu of the annotation tool. It can be used to download, upload a
Button assignment:
- ``Open Task`` — open task in cvat dashboard
- ``RunReID Merge`` — The ReID application uses deep learning model to perform
an automatic merging of bounding boxes between neighbor frames. You can use
"Merge" and "Split" functionality to edit automatically generated annotation
[read more](/cvat/apps/reid).
- ``Dump Annotation`` — download annotations from the task
- ``Upload Annotation`` — uploading annotations to the task
- ``Remove Annotation`` — remove annotations from current task
- ``Settings`` — open the settings menu
- ``Fullscreen Player`` — fullscreen player mode
- ``Switch AAM`` — switch to attribute annotation mode
- ``Help`` — open the shortkeys
- ``Save Work`` — save annotations for the current job. The button has an
indication of the saving process
It also shows statistics about the current task, for example:
- task name
- status of the task: ``annotation``, ``validation`` or ``completed task``
- technical information about task
- number of created bounding boxes, sorted by labels (e.g. vehicle, person) and
type of annotation (polygons, boxes, etc.)
---
**Filter** input box
- ``Dump Annotations`` — downloads annotations from a task.
- ``Upload Annotations`` — uploads annotations into a task.
- ``Remove Annotations`` — removes annotations from the current job.
- ``Export as a dataset`` — download a data set from a task. Several formats are available:
- [Datumaro](https://github.com/opencv/cvat/blob/develop/datumaro/docs/design.md)
- [Pascal VOC 2012](http://host.robots.ox.ac.uk/pascal/VOC/)
- [MS COCO](http://cocodataset.org/#format-data)
- [YOLO](https://pjreddie.com/darknet/yolo/)
- ``Open the task`` — opens a page with details about the task.
- ``Run ReID merge`` — automatic merge of shapes or tracks.
It is used to combine individual objects - created by automatic annotation in a single track.
For more information click [here](cvat/apps/reid/README.md).
The way how to use filters is described in the advanced guide (below).
#### Save Work
Saves annotations for the current job. The button has an indication of the saving process.
![](static/documentation/images/image059.jpg)
![](static/documentation/images/image141.jpg)
---
**History / Undo-redo** panel
#### Undo-redo buttons
Use ``Ctrl+Z`` for undo actions and ``Ctrl+Shift+Z`` or ``Ctrl+Y`` to redo them.
Use buttons to undo actions or redo them.
![](static/documentation/images/image061.jpg)
![](static/documentation/images/image061.jpg)
---
**Propagation** input box
Allows you to select how many frames of the selected object will be copied clicking ``Ctrl+B`` (50 by default)
![](static/documentation/images/image101.jpg)
#### Player
---
**Rotation** of an image
Go to the first /the latest frames.
Buttons are used to rotate the image clockwise / counterclockwise or use ``Ctrl+R``/``Ctrl+Shift+R``
![](static/documentation/images/image036.jpg)
![](static/documentation/images/image102.jpg)
Go to the next/previous frame with a predefined step. Shortcuts:
``V`` — step backward, ``C`` — step forward. By default the step is ``10`` frames
(change at ``Account Menu`` —> ``Settings`` —> ``Player Step``).
---
**Fill Opacity** slider
![](static/documentation/images/image037.jpg)
Change opacity of every bounding box in the annotation.
Go to the next/previous frame (the step is 1 frame). Shortcuts: ``D`` — previous, ``F`` — next.
![](static/documentation/images/image086.jpg)
![](static/documentation/images/image040.jpg)
Opacity can be changed from 0% to 100% and by random colors or white. If any
white option is chosen, ``Color By`` scheme won't work.
Play the sequence of frames or the set of images.
Shortcut: ``Space`` (change at ``Account Menu`` —> ``Settings`` —> ``Player Speed``).
**Selected Fill Opacity** slider
![](static/documentation/images/image041.jpg)
Change the opacity of the selected object's fill.
Go to a specific frame. Press ``~`` to focus on the element.
![](static/documentation/images/image087.jpg)
![](static/documentation/images/image060.jpg)
Opacity can be changed from 0% to 100%.
---
**Black Stroke** checkbox
#### Fullscreen Player
The fullscreen player mode. The keyboard shortcut is ``F11``.
Change bounding box border from white/colored to black.
![](static/documentation/images/image143.jpg)
![](static/documentation/images/image088.jpg)
#### Info
Open the job info.
**Color By** options
![](static/documentation/images/image144_DETRAC.jpg)
Change the color scheme of annotation:
- ``Instance`` — every bounding box has random color
- Job status: ``annotation``, ``validation`` or ``completed`` task
![](static/documentation/images/image095.jpg)
_Overview_:
- ``Group`` — every group of boxes has its own random color, ungrouped boxes are white
- ``Assinger`` - the one to whom the job is assigned.
- ``Start Frame`` - the number of the first frame in this job.
- ``End Frame`` - the number of the last frame in this job.
- ``Frames`` - the total number of all frames in the job.
- ``Z-Order`` - z-order enable indicator.
![](static/documentation/images/image094.jpg)
_Annotations statistics_:
- ``Label`` — every label (e.g. vehicle, pedestrian, road marks) has its own random color
This is a table number of created shapes, sorted by labels (e.g. vehicle, person)
and type of annotation (shape, track). As well as the number of manual and interpolated frames.
![](static/documentation/images/image093.jpg)
#### UI switcher
Switching between user interface modes.
You can change any random color pointing on needed box on a frame or on a
side panel and press ``Enter``.
![](static/documentation/images/image145.jpg)
---
### Side panel

Loading…
Cancel
Save