Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update item Settings in User Guide #1508

Merged
merged 5 commits into from
May 13, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
66 changes: 30 additions & 36 deletions cvat/apps/documentation/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -645,63 +645,57 @@ Applying ``split`` into an interpolated track divides it into two separate track
---
### Settings

Press ``F2`` to access settings menu.
To open the settings open the user menu in the header and select the settings item or press ``F3``.

![](static/documentation/images/image067.jpg)

There is ``Player Settings`` which adjusts ``Workspace`` and ``Other Settings``.
``Settings`` have two tabs:

In ``Player Settings`` you can:
- Control step of ``C`` and ``V`` shortcuts
- Control speed of ``Space``/``Play`` button
- Show every image in full or zoomed out like previous
(it is enabled by default for interpolation mode and disabled for annotation mode)
- Enable ``Grid`` when you don't need small objects. ``Grid`` can have
different opacity, color and cells' size — use ``F2`` to configure settings.
In tab ``Player`` you can:
- Control step of ``C`` and ``V`` shortcuts.
- Control speed of ``Space``/``Play`` button.
- Show ``Grid``, change grid size, choose color and transparency:

![](static/documentation/images/image068.jpg)
![](static/documentation/images/image068_mapillary_vistas.jpg)

- Adjust ``Brightness``/``Contrast``/``Saturation`` of too exposing or too
dark images using ``F2`` — color settings (changes displaying and not the
- Show every image in full size or zoomed out like previous
(it is enabled by default for interpolation mode and disabled for annotation mode).
- ``Rotate all images`` checkbox — switch the rotation of all frames /an individual frame.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- ``Rotate all images`` checkbox — switch the rotation of all frames /an individual frame.
- ``Rotate all images`` checkbox — switch the rotation of all frames or an individual frame.

- Adjust ``Brightness``/``Contrast``/``Saturation`` of too exposed or too
dark images using ``F3`` — color settings (changes displaying settings and not the
image itself).

Shortcuts:
- ``Shift+B``/``Alt+B`` for brightness
- ``Shift+C``/``Alt+C`` for contrast
- ``Shift+S``/``Alt+S`` for saturation
- ``F2`` —> ``Reset Color Settings`` to default values
- ``Shift+B+=``/``Shift+B+-`` for brightness.
- ``Shift+C+=``/``Shift+C+-`` for contrast.
- ``Shift+S+=``/``Shift+S+-`` for saturation.

![](static/documentation/images/image069.jpg)
![](static/documentation/images/image164_mapillary_vistas.jpg)

``Other Settings`` contains:
- ``Show All Interpolation Tracks`` checkbox — shows hidden object on the
side panel for every interpolated object (turned off by default)
- ``AAM Zoom Margin`` slider — defines margins for shape in attribute annotation mode
- ``Enable AutoSaving`` checkbox — turned off by default
- ``AutoSaving Interval (min)`` input box — 15 minutes by default
- ``Rotate all images`` checkbox — switch the rotation of all frames / individual frame
- ``Reset Color Settings`` to default values.

---
### Bottom Panel

![](static/documentation/images/image035.jpg)
In tab ``Workspace`` you can:

---
Go to the first and latest frames.
![](static/documentation/images/image155.jpg)

![](static/documentation/images/image036.jpg)
- ``Enable Autosaving`` checkbox — turned off by default.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- ``Enable Autosaving`` checkbox — turned off by default.
- ``Enable auto save`` checkbox — turned off by default.

- ``Autosaving Interval (min)`` input box — 15 minutes by default.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- ``Autosaving Interval (min)`` input box — 15 minutes by default.
- ``Auto save interval (min)`` input box — 15 minutes by default.

- ``Show All Interpolation Tracks`` checkbox — shows hidden objects on the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- ``Show All Interpolation Tracks`` checkbox — shows hidden objects on the
- ``Show all interpolation tracks`` checkbox — shows hidden objects on the

side panel for every interpolated object (turned off by default).
- ``Always show object details`` - show text for an object on the canvas not only when the object is activated:

---
Go to the next/previous frame with a predefined step. Shortcuts:
``V`` — step backward, ``C`` — step forward. By default the step is ``10``
(change at ``Open Menu`` —> ``Settings`` —> ``Player Step``).
![](static/documentation/images/image152_DETRAC.jpg)

![](static/documentation/images/image037.jpg)
- ``Automatic bordering`` - enable automatic bordering for polygons and polylines during drawing/editing.
For more information To find out more, go to the section [annotation with polygons](#Annotation-with-polygons).
- ``Attribute annotation mode (AAM) Zoom Margin`` input box — defines margins (in px)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- ``Attribute annotation mode (AAM) Zoom Margin`` input box — defines margins (in px)
- ``Attribute annotation mode (AAM) zoom margin`` input box — defines margins (in px)

for shape in the attribute annotation mode.
- 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)

---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should it be removed (we already have one above)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nmanovic these lines should be deleted at #1509. I will fix this by adding them back to this PR and deleting in #1509

Play the sequence of frames or the set of images. Shortcut: ``Space`` (change at ``Open Menu`` —> ``Settings`` —> ``Player Speed``).
Expand Down