Documentation update (#3464)

* update documentation add approximation and done button

* fix linter error and mistakes

* documentation update and fix mistakes

* delete unused image

* rename an images to resolve a conflict

* Update site/content/en/docs/manual/basics/top-panel.md

Co-authored-by: Boris Sekachev <boris.sekachev@intel.com>
main
Timur Osmanov 5 years ago committed by GitHub
parent 0ea4897b1c
commit bc2c85a9d3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -27,13 +27,19 @@ In most cases specifying positive points alone is enough to build a polygon.
Left click creates a positive point and right click creates a negative point.
`Deep extreme cut` model requires a minimum of 4 points. After you set 4 positive points,
a request will be sent to the server and when the process is complete a polygon will be created.
If you are not satisfied with the result, you can set additional points or remove points by left-clicking on it.
If you are not satisfied with the result, you can set additional points or remove points.
To delete a point, hover over the point you want to delete, if the point can be deleted,
it will enlarge and the cursor will turn into a cross, then left-click on the point.
If you want to postpone the request and create a few more points, hold down `Ctrl` and continue,
the request will be sent after the key is released.
![](/images/image188_detrac.jpg)
- To finish interaction, click on the icon on the controls sidebar or press `N` on your keyboard.
- In the process of drawing, you can select the number of points in the polygon using the switch.
![](/images/image224.jpg)
- To finish interaction, click on the `Done` button on the top panel or press `N` on your keyboard.
- When the object is finished, you can edit it like a polygon.
You can read about editing polygons in the [Annotation with polygons](/docs/manual/advanced/annotation-with-polygons/) section.

@ -13,9 +13,10 @@ in the `Number of points` field, then drawing will be stopped automatically.
Click `Shape` to entering the drawing mode. Now you can start annotation of the necessary area.
Points are automatically grouped — all points will be considered linked between each start and finish.
Press `N` again to finish marking the area. You can delete a point by clicking with pressed `Ctrl`
or right-clicking on a point and selecting `Delete point`. Clicking with pressed `Shift` will open the points
shape editor. There you can add new points into an existing shape. You can zoom in/out (when scrolling the mouse wheel)
Press `N` again or click the `Done` button on the top panel to finish marking the area.
You can delete a point by clicking with pressed `Ctrl` or right-clicking on a point and selecting `Delete point`.
Clicking with pressed `Shift` will open the points shape editor.
There you can add new points into an existing shape. You can zoom in/out (when scrolling the mouse wheel)
and move (when clicking the mouse wheel and moving the mouse) while drawing. You can drag an object after
it has been drawn and change the position of individual points after finishing an object.

@ -28,7 +28,7 @@ the outline of polygons existing in the annotation.
![](/images/image159_mapillary_vistas.jpg)
- Сlick on the last point and the outline to this point will be built automatically.
- Click on the last point and the outline to this point will be built automatically.
![](/images/image160_mapillary_vistas.jpg)

@ -20,6 +20,6 @@ Before starting, you need to select `Polygon` on the controls sidebar and choose
- When `Shift` isn't pressed, you can zoom in/out (when scrolling the mouse
wheel) and move (when clicking the mouse wheel and moving the mouse), you can also
delete the previous point by right-clicking on it.
- Press `N` again for completing the shape.
- Press `N` again or click the `Done` button on the top panel for completing the shape.
- After creating the polygon, you can move the points or delete them by right-clicking and selecting `Delete point`
or clicking with pressed `Alt` key in the context menu.

@ -12,7 +12,7 @@ Polygons in the track mode allow you to mark moving objects more accurately othe
![](/images/image184.jpg)
1. Create a polygon the same way as in the case of [Annotation with polygons](/docs/manual/advanced/annotation-with-polygons/).
Press `N` to complete the polygon.
Press `N` or click the `Done` button on the top panel to complete the polygon.
1. Pay attention to the fact that the created polygon has a starting point and a direction,
these elements are important for annotation of the following frames.

@ -14,7 +14,8 @@ Click `Shape` to enter drawing mode. There are two ways to draw a polyline —
you either create points by clicking or by dragging a mouse on the screen while holding `Shift`.
When `Shift` isn't pressed, you can zoom in/out (when scrolling the mouse wheel)
and move (when clicking the mouse wheel and moving the mouse), you can delete
previous points by right-clicking on it. Press `N` again to complete the shape.
previous points by right-clicking on it.
Press `N` again or click the `Done` button on the top panel to complete the shape.
You can delete a point by clicking on it with pressed `Ctrl` or right-clicking on a point
and selecting `Delete point`. Click with pressed `Shift` will open a polyline editor.
There you can create new points(by clicking or dragging) or delete part of a polygon closing

@ -36,7 +36,12 @@ displayed as a red square which is tied to the cursor.
Increasing action threshold will affect the performance.
During the drawing process you can remove the last point by clicking on it with the left mouse button.
- Once all the points are placed, you can complete the creation of the object by clicking on the icon or clicking `N`.
- In the process of drawing, you can select the number of points in the polygon using the switch.
![](/images/image224.jpg)
- Once all the points are placed, you can complete the creation of the object
by clicking on the `Done` button on the top panel or press `N` on your keyboard.
As a result, a polygon will be created (read more about the polygons in the [annotation with polygons](/docs/manual/advanced/annotation-with-polygons/)).
### Histogram Equalization

@ -62,7 +62,7 @@ Many UI elements have shortcut hints. Put your pointer to a required element to
| `Ctrl+C` | Copy shape to CVAT internal clipboard |
| `Ctrl+V` | Paste a shape from internal CVAT clipboard |
| Hold `Ctrl` while pasting | When pasting shape from the buffer for multiple pasting. |
| `Crtl+B` | Make a copy of the object on the following frames |
| `Ctrl+B` | Make a copy of the object on the following frames |
| `Ctrl+(0..9)` | Changes a label for an activated object or for the next drawn object if no objects are activated |
| | _Operations are available only for track_ |
| `K` | Change keyframe property for an active track |

@ -41,3 +41,7 @@ In tab `Workspace` you can:
for shape in the attribute annotation mode.
- Click `Save` to save settings (settings will be saved on the server and will not change after the page is refreshed).
Click `Cancel` or press `F2` to return to the annotation.
- `Default number of points in polygon approximation`
With this setting, you can choose the default number of points in polygon.
Works for serverless interactors and OpenCV scissors.

@ -43,6 +43,14 @@ Use buttons to undo actions or redo them.
---
## Done
![](/images/image223.jpg)
Used to complete the creation of the object. This button appears only when the object is being created.
---
## Player
Go to the first /the latest frames.
@ -93,7 +101,7 @@ Open the job info.
_Overview_:
- `Assinger` - the one to whom the job is assigned.
- `Assignee` - the one to whom the job is assigned.
- `Reviewer` a user assigned to carry out the review,
read more in the [review](/docs/manual/advanced/review) section.
- `Start Frame` - the number of the first frame in this job.

@ -34,3 +34,10 @@ Tracks are created in `Track mode`
- _Manual_ which is created by a person
- _Semi-automatic_ which is created mainly automatically, but the user provides some data (e.g. interpolation)
- _Automatic_ which is created automatically without a person in the loop
---
**Approximation** allows you to reduce the number of points in the polygon.
Can be used to reduce the annotation file and to facilitate editing polygons.
![](/images/approximation_accuracy.gif)

Binary file not shown.

After

Width:  |  Height:  |  Size: 920 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.8 KiB

Loading…
Cancel
Save