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

Updated documentation for v0.2.0 #63

Merged
merged 7 commits into from
Sep 20, 2018
Merged

Updated documentation for v0.2.0 #63

merged 7 commits into from
Sep 20, 2018

Conversation

nmanovic
Copy link
Contributor

New version of documentation for Release 0.2.0

@nmanovic nmanovic added the documentation Documentation should be updated label Sep 19, 2018
@nmanovic nmanovic added this to the Release 0.2.0 milestone Sep 19, 2018

- __Unique__: immutable and isn't changed from frame to frame (e.g age, gender, color, etc)
- __Temporary__: mutable and can be changed on any frame (e.g. quality, pose, truncated, etc)
![](static/documentation/images/image073.jpg)
Copy link
Member

Choose a reason for hiding this comment

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

There is not immutable attribute on the image.

---
__Filter__ input box

__[All about Filters](./documentation/user_guide.html#filter)__
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The link doesn't work


``Other Settings`` contain:
- ``Show All Interpolation Tracks`` checkbox — shows hidden object card on Side panel for every interpolated object (turned off by default)
- ``AAM Zoom Margin`` slider — allow to choose the size of bounding box on new frame
Copy link
Member

Choose a reason for hiding this comment

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

AAM Zoom Margin defines margins for shape in attribute annotation mode.

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

---
You can change this objects' annotation is displayed on this frame. It could be Hide, Shows Only Box, Shows Box and Title. ``H`` is for this object, ``T+H`` for all objects on this frame.
Copy link
Member

Choose a reason for hiding this comment

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

This setting is independents by frame. Also: it could be Hide, Shows Only Shape, Shows Shape and Title

You can change this objects' annotation is displayed on this frame. It could be Hide, Shows Only Box, Shows Box and Title. ``H`` is for this object, ``T+H`` for all objects on this frame.

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

---
The type of a bounding box can be changed by selecting __Label__ property. For instance, it can look like on the figure below:
Copy link
Member

Choose a reason for hiding this comment

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

The type of a shape ...

You can change this objects' annotation is displayed on this frame. It could be Hide, Shows Only Box, Shows Box and Title. ``H`` is for this object, ``T+H`` for all objects on this frame.

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

---
The type of a bounding box can be changed by selecting __Label__ property. For instance, it can look like on the figure below:

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

To change a type of a bounding box using keyboard you need to press ``Shift+<number>``.
Copy link
Member

Choose a reason for hiding this comment

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

To change a type of highlighted shape using keyboard you need to press ..


![](static/documentation/images/image051.jpg)
- ``Create Shape`` — ``N`` — start/stop draw new bounding box mode
Copy link
Member

Choose a reason for hiding this comment

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

start/stop the drawing mode of a new shape


![](static/documentation/images/image051.jpg)
- ``Create Shape`` — ``N`` — start/stop draw new bounding box mode
- ``Merge Shapes`` — ``M`` — start/stop merge boxes mode
Copy link
Member

@bsekachev bsekachev Sep 19, 2018

Choose a reason for hiding this comment

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

start/stop the merging mode of shapes

![](static/documentation/images/image051.jpg)
- ``Create Shape`` — ``N`` — start/stop draw new bounding box mode
- ``Merge Shapes`` — ``M`` — start/stop merge boxes mode
- ``Group Shapes`` — ``G`` — start/stop grouping boxes mode
Copy link
Member

Choose a reason for hiding this comment

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

start/stop the grouping mode of shapes

- ``Merge Shapes`` — ``M`` — start/stop merge boxes mode
- ``Group Shapes`` — ``G`` — start/stop grouping boxes mode
- ``Label Type`` — choosing on of the created with a task ``Labels`` (Face, Person, Vehicle)
- ``Working Mode`` — Annotation or Interpolation modes. You can't interpolate Polygons/Polylines/Points, but you can propagate them using ``Ctrl+B``.
Copy link
Member

Choose a reason for hiding this comment

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

... and merge to a track.


![](static/documentation/images/image053.jpg)
![](static/documentation/images/image065.jpg)

Example: both cars on the figure below should be labeled as __occluded__.

![](static/documentation/images/image054.jpg)
Copy link
Member

Choose a reason for hiding this comment

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

There is not second annotated car on an image

- ``Tab`` - go to the next object
- ``Shift+Tab`` - go to the previous object.
- ``Tab`` go to the next object
- ``Shift+Tab`` go to the previous object.

By default in the mode objects are zoomed. To disable the functionality uncheck the corresponding setting: ``Open Menu`` —> ``Settings`` —> ``Zoom boxes in Attribute Annotation Mode``.
Copy link
Member

Choose a reason for hiding this comment

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

This setting has been removed. There is 'AAM Zoom Margin' instead.


By default in the mode objects are zoomed. To disable the functionality uncheck the corresponding setting: ``Open Menu`` —> ``Settings`` —> ``Zoom boxes in Attribute Annotation Mode``.

By default other objects are hidden. To change the behaviour uncheck the corresponding setting: ``Open Menu`` —> ``Setting`` —> ``Hide Other in Attribute Annotation Mode``.
By default other objects are hidden. To change the behavior uncheck the corresponding setting: ``Open Menu`` —> ``Setting`` —> ``Hide Other in Attribute Annotation Mode``.
Copy link
Member

Choose a reason for hiding this comment

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

This setting also has been removed.

It is used for semantic / instance segmentation.

Be sure ``Z-Order`` flag in ``Create task`` dialog is enabled if you want annotate polygons.

Copy link
Member

Choose a reason for hiding this comment

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

We need add:
Z-Order flag defines order of drawing. It need in order to get right annotation mask without extra work (additional drawing of borders).

Copy link
Member

Choose a reason for hiding this comment

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

And we can switch it by '+' and '-' shortkeys.

Copy link
Member

Choose a reason for hiding this comment

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

Which set maximum and minimum z-order respectively.

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

Click ``N`` for entering drawing mode. Now you can start your polygon. You can zoom in/out while drawing. Click ``N`` again for completing the shape. You can fix a position of an individual points after finishing the object. You can not add/delete points after finishing.

Copy link
Member

Choose a reason for hiding this comment

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

Click N for entering drawing mode. Now you can start your polygon. You can zoom in/out (on mouse wheel scroll) and move (on mouse wheel press and mouse move) while drawing. Click N again for completing the shape. Also you can set fixed number of points in the field "Poly Shape Size", then drawing will be stopped automatically. You can drag object after it was drawn and fix a position of an individual points after finishing the object. You can add/delete points after finishing with help points context menu.


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

Click ``N`` for entering drawing mode. Now you can start your polyline. You can zoom in/out while drawing. Click ``N`` again for completing the line. You can fix a position of an individual points after finishing the object. You can not add/delete points after finishing.
Copy link
Member

Choose a reason for hiding this comment

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

The same like above.


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

Click ``N`` for entering drawing mode. Now you can start marking a needed area. Click ``N`` again for finishing marking an area. Points are automatically grouped — between individual start and finish all points will be considered linked. You can zoom in/out while drawing. You can fix a position of an individual points after finishing the object. You can not add/delete points after finishing.
Copy link
Member

Choose a reason for hiding this comment

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

The same like above.


There are several reasons to use the feature:

1. When use a filter objects which don't correspond to the filter will be hidden. Use ``Settings`` —> ``Hide Filtered Tracks`` or ``K`` shortcut if you want to change the behaviour.
1. When use a filter objects which don't correspond to the filter will be hidden. Use ``Settings`` —> ``Hide Filtered Tracks`` or ``K`` shortcut if you want to change the behavior.
Copy link
Member

Choose a reason for hiding this comment

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

There aren't 'Hide Filtered Tracks' option and shortcut.


There are several reasons to use the feature:

1. When use a filter objects which don't correspond to the filter will be hidden. Use ``Settings`` —> ``Hide Filtered Tracks`` or ``K`` shortcut if you want to change the behaviour.
1. When use a filter objects which don't correspond to the filter will be hidden. Use ``Settings`` —> ``Hide Filtered Tracks`` or ``K`` shortcut if you want to change the behavior.
2. Fast navigation between frames which have an object of interest. Use ``Left Arrow/Right Arrow`` keys for the purpose. If the filter is empty the mentioned arrows will go to previous/next frames.
Copy link
Member

Choose a reason for hiding this comment

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

... will go to previous/next frames which contain any objects.

```//person[attr/race="asian"] | //car[attr/model="bmw" or attr/model="mazda"]``` | asian persons or bmw or mazda cars.
``person[attr/age>="25" and attr/age<="35"]`` | people with age between 25 and 35.
``face[attr/glass="sunglass" or attr/glass="no"]`` | faces with sunglasses or without glasses at all.
```person[attr/race="asian"] | car[attr/model="bmw" or attr/model="mazda"]``` | asian persons or bmw or mazda cars.
Copy link
Member

Choose a reason for hiding this comment

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

Is there bad table?

| | __Filter__ |
``Left Arrow`` | go to the previous frame which corresponds to the specified filter value
``Right Arrow`` | go to the next frame which corresponds to the specified filter value
``K`` | hide all objects which don't correspond to the specified filter value
``K`` | hide all shapes which don't correspond to the specified filter value

Copy link
Member

Choose a reason for hiding this comment

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

I don't see shortcuts for z-order changing in the table. It has been added to shortcut table if task has 'z_order' == true flag.

@nmanovic nmanovic merged commit 59f9722 into release-0.2 Sep 20, 2018
nmanovic pushed a commit that referenced this pull request Sep 20, 2018
- Cuda installation has been fixed (#71)
- Updated documentation for v0.2.0 (#63)
- Player navigation has been fixed if window was scrolled (#66)
@nmanovic nmanovic deleted the doc branch September 20, 2018 16:24
TOsmanov pushed a commit to TOsmanov/cvat that referenced this pull request Aug 23, 2021
* update version

* update changelog
TOsmanov pushed a commit to TOsmanov/cvat that referenced this pull request Aug 23, 2021
* Relax importer for Pascal VOC dataset (search in subdirectories) (cvat-ai#50)

In some cases developers don't want to specify the exact path to Pascal VOC.
Now you have to specify VOCtrainval_11-May-2012/VOCdevkit/VOC2012/. After the
patch it will be possible to specify VOCtrainval_11-May-2012/.

* Allow missing supercategory in COCO annotations (cvat-ai#54)

Now it is possible to load coco_instances dataset even if the annotation file doesn't have supercategory

* Add CamVid format support (cvat-ai#55)

Co-authored-by: Maxim Zhiltsov <[email protected]>

* Fix CamVid format (cvat-ai#57)

* Fix ImageNet format

* Fix CamVid format

* ability to install opencv-python-headless instead opencv-python (cvat-ai#62)

Allow to choose `opencv=python-headless` as dependency with `DATUMARO_HEADLESS=1` env. variable when installing

* Release 0.1.4 (cvat-ai#63)

* update version

* update changelog

Co-authored-by: Nikita Manovich <[email protected]>
Co-authored-by: Anastasia Yasakova <[email protected]>
Co-authored-by: Andrey Zhavoronkov <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation should be updated
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants