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 Documentation. Add documentation about ellipses #4172

Merged
merged 8 commits into from
Jan 14, 2022
22 changes: 22 additions & 0 deletions site/content/en/docs/manual/advanced/annotation-with-ellipses.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: 'Annotation with ellipses'
linkTitle: 'Annotation with ellipses'
weight: 11
description: 'Guide to annotating tasks using ellipses.'
---

It is used for road sign annotation etc.

First of all you need to select the `ellipse` on the controls sidebar.

![](/images/image239.jpg)

Choose a `Label` and click `Shape` or `Track` to start drawing. An ellipse can be created the same way as
a [rectangle](/docs/manual/advanced/annotation-with-rectangles/), you need to specify two opposite points,
and the ellipse will be inscribed in an imaginary rectangle. Press `N` or click the `Done` button on the top panel
to complete the shape.

![](/images/image240_mapillary_vistas.jpg)

You can rotate ellipses using a rotation point in the same way as
[rectangles](/docs/manual/advanced/annotation-with-rectangles/#rotation-rectangle).
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Annotation with points'
linkTitle: 'Annotation with points'
weight: 8
weight: 10
description: 'Guide to annotating tasks using single points or shapes containing multiple points.'
---
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Annotation with polygons'
linkTitle: 'Annotation with polygons'
weight: 10
weight: 8
description: 'Guide to creating and editing polygons.'
---
6 changes: 3 additions & 3 deletions site/content/en/docs/manual/advanced/annotation-with-tags.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Annotation with Tags'
linkTitle: 'Annotation with Tags'
weight: 11
title: 'Annotation with tags'
linkTitle: 'Annotation with tags'
weight: 13
---

It is used to annotate frames, tags are not displayed in the workspace.
Expand Down
7 changes: 4 additions & 3 deletions site/content/en/docs/manual/basics/controls-sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ description: 'Overview of available functions on the controls sidebar of the ann
|![](/images/image168.jpg)|`Polygon`|[Annotation with polygons](/docs/manual/advanced/annotation-with-polygons/); [Track mode with polygons](/docs/manual/advanced/annotation-with-polygons/track-mode-with-polygons/)|
|![](/images/image169.jpg)|`Polyline`|[Annotation with polylines](/docs/manual/advanced/annotation-with-polylines/)|
|![](/images/image170.jpg)|`Points`|[Annotation with points](/docs/manual/advanced/annotation-with-points/)|
|![](/images/image241.jpg)|`Ellipses`|[Annotation with ellipses](/docs/manual/advanced/annotation-with-ellipses/)|
|![](/images/image176.jpg)|`Cuboid`|[Annotation with cuboids](/docs/manual/advanced/annotation-with-cuboids/)|
|![](/images/image171.jpg)|`Tag`|[Annotation with tags](/docs/manual/advanced/annotation-with-tags/)|
|![](/images/image195.jpg)|`Open an issue`|[Review](/docs/manual/advanced/review/) (available only in review mode)|
Expand All @@ -48,8 +49,8 @@ description: 'Overview of available functions on the controls sidebar of the ann
**Edit block** - contains tools for editing tracks and shapes.
|Icon |Description |Links to section |
|-- |-- |-- |
|![](/images/image172.jpg)|`Merge Shapes`(`M`) starts/stops the merging shapes mode. |[Track mode (basics)](/docs/manual/basics/track-mode-basics/)|
|![](/images/image173.jpg)|`Group Shapes` (`G`) starts/stops the grouping shapes mode.|[Shape grouping](/docs/manual/advanced/shape-grouping/)|
|![](/images/image174.jpg)|`Split` splits a track. |[Track mode (advanced)](/docs/manual/advanced/track-mode-advanced/)|
|![](/images/image172.jpg)|`Merge Shapes`(`M`) - starts/stops the merging shapes mode. |[Track mode (basics)](/docs/manual/basics/track-mode-basics/)|
|![](/images/image173.jpg)|`Group Shapes` (`G`) - starts/stops the grouping shapes mode.|[Shape grouping](/docs/manual/advanced/shape-grouping/)|
|![](/images/image174.jpg)|`Split` - splits a track. |[Track mode (advanced)](/docs/manual/advanced/track-mode-advanced/)|

---
5 changes: 3 additions & 2 deletions site/content/en/docs/manual/basics/types-of-shapes.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ There are five shapes which you can annotate your images with:
- `Polygon`
- `Polyline`
- `Points`
- `Ellipse`
Copy link
Member

Choose a reason for hiding this comment

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

Only one comment, line above is:
There are five shapes which you can annotate your images with:

But this list has 8 annotation types

- `Cuboid`
- `Cuboid in 3d task`
- `Tag`
Expand All @@ -20,8 +21,8 @@ And there is how they all look like:

![](/images/image009_mapillary_vistas.jpg 'Polyline') ![](/images/image010_affectnet.jpg 'Points')

![](/images/image015_detrac.jpg 'Cuboid') ![](/images/image218_carla_town3.jpg 'Cuboid in 3d task')
![](/images/image240_mapillary_vistas.jpg 'Ellipse') ![](/images/image015_detrac.jpg 'Cuboid')

![](/images/image135.jpg 'Tag')
![](/images/image218_carla_town3.jpg 'Cuboid in 3d task') ![](/images/image135.jpg 'Tag')

`Tag` - has no shape in the workspace, but is displayed in objects sidebar.
Binary file added site/content/en/images/image239.jpg
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.
Binary file added site/content/en/images/image241.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.