diff --git a/cvat/apps/documentation/static/documentation/images/gif001.gif b/cvat/apps/documentation/static/documentation/images/gif001.gif deleted file mode 100644 index 3196e8c16df3..000000000000 Binary files a/cvat/apps/documentation/static/documentation/images/gif001.gif and /dev/null differ diff --git a/cvat/apps/documentation/static/documentation/images/gif001_DETRAC.gif b/cvat/apps/documentation/static/documentation/images/gif001_DETRAC.gif new file mode 100644 index 000000000000..6a1f055c1b1b Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/gif001_DETRAC.gif differ diff --git a/cvat/apps/documentation/static/documentation/images/gif002.gif b/cvat/apps/documentation/static/documentation/images/gif002.gif deleted file mode 100644 index c9ecbeee5f59..000000000000 Binary files a/cvat/apps/documentation/static/documentation/images/gif002.gif and /dev/null differ diff --git a/cvat/apps/documentation/static/documentation/images/gif003.gif b/cvat/apps/documentation/static/documentation/images/gif003.gif deleted file mode 100644 index 9cad1e66fc1a..000000000000 Binary files a/cvat/apps/documentation/static/documentation/images/gif003.gif and /dev/null differ diff --git a/cvat/apps/documentation/static/documentation/images/gif003_DETRAC.gif b/cvat/apps/documentation/static/documentation/images/gif003_DETRAC.gif new file mode 100644 index 000000000000..f69e3a7bc7c7 Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/gif003_DETRAC.gif differ diff --git a/cvat/apps/documentation/static/documentation/images/gif019_DETRAC.gif b/cvat/apps/documentation/static/documentation/images/gif019_DETRAC.gif new file mode 100644 index 000000000000..e8b8b0beb4ee Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/gif019_DETRAC.gif differ diff --git a/cvat/apps/documentation/static/documentation/images/image014.jpg b/cvat/apps/documentation/static/documentation/images/image014.jpg index f2610f30d850..44f407fe0bda 100644 Binary files a/cvat/apps/documentation/static/documentation/images/image014.jpg and b/cvat/apps/documentation/static/documentation/images/image014.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image015_DETRAC.jpg b/cvat/apps/documentation/static/documentation/images/image015_DETRAC.jpg deleted file mode 100644 index c368c46eb107..000000000000 Binary files a/cvat/apps/documentation/static/documentation/images/image015_DETRAC.jpg and /dev/null differ diff --git a/cvat/apps/documentation/static/documentation/images/image016.jpg b/cvat/apps/documentation/static/documentation/images/image016.jpg index ef11a6308085..8fb65ffd8a0c 100644 Binary files a/cvat/apps/documentation/static/documentation/images/image016.jpg and b/cvat/apps/documentation/static/documentation/images/image016.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image017_DETRAC.jpg b/cvat/apps/documentation/static/documentation/images/image017_DETRAC.jpg index 4a59bfc2df38..8861fcf801dd 100644 Binary files a/cvat/apps/documentation/static/documentation/images/image017_DETRAC.jpg and b/cvat/apps/documentation/static/documentation/images/image017_DETRAC.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image018.jpg b/cvat/apps/documentation/static/documentation/images/image018.jpg deleted file mode 100644 index 0d0b1ecf5a7e..000000000000 Binary files a/cvat/apps/documentation/static/documentation/images/image018.jpg and /dev/null differ diff --git a/cvat/apps/documentation/static/documentation/images/image019.jpg b/cvat/apps/documentation/static/documentation/images/image019.jpg index 6d95ec2effda..45e30df6b586 100644 Binary files a/cvat/apps/documentation/static/documentation/images/image019.jpg and b/cvat/apps/documentation/static/documentation/images/image019.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image020.jpg b/cvat/apps/documentation/static/documentation/images/image020.jpg index f1bb96114186..13e6037666b8 100644 Binary files a/cvat/apps/documentation/static/documentation/images/image020.jpg and b/cvat/apps/documentation/static/documentation/images/image020.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image021.jpg b/cvat/apps/documentation/static/documentation/images/image021.jpg deleted file mode 100644 index e933811b2cd9..000000000000 Binary files a/cvat/apps/documentation/static/documentation/images/image021.jpg and /dev/null differ diff --git a/cvat/apps/documentation/static/documentation/images/image022.jpg b/cvat/apps/documentation/static/documentation/images/image022.jpg deleted file mode 100644 index 0458bd28dc1f..000000000000 Binary files a/cvat/apps/documentation/static/documentation/images/image022.jpg and /dev/null differ diff --git a/cvat/apps/documentation/static/documentation/images/image083.jpg b/cvat/apps/documentation/static/documentation/images/image083.jpg index 4c8de5fd0052..1ca5905b3ea6 100644 Binary files a/cvat/apps/documentation/static/documentation/images/image083.jpg and b/cvat/apps/documentation/static/documentation/images/image083.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image131.jpg b/cvat/apps/documentation/static/documentation/images/image131.jpg deleted file mode 100644 index 2aae02a17bdb..000000000000 Binary files a/cvat/apps/documentation/static/documentation/images/image131.jpg and /dev/null differ diff --git a/cvat/apps/documentation/static/documentation/images/image131_DETRAC.jpg b/cvat/apps/documentation/static/documentation/images/image131_DETRAC.jpg new file mode 100644 index 000000000000..fc72b9dd48ee Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/image131_DETRAC.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image161.jpg b/cvat/apps/documentation/static/documentation/images/image161.jpg new file mode 100644 index 000000000000..a4eb1e522699 Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/image161.jpg differ diff --git a/cvat/apps/documentation/static/documentation/images/image162_DETRAC.jpg b/cvat/apps/documentation/static/documentation/images/image162_DETRAC.jpg new file mode 100644 index 000000000000..e47d0a5fe752 Binary files /dev/null and b/cvat/apps/documentation/static/documentation/images/image162_DETRAC.jpg differ diff --git a/cvat/apps/documentation/user_guide.md b/cvat/apps/documentation/user_guide.md index 168af6ad07ae..4306c740f94f 100644 --- a/cvat/apps/documentation/user_guide.md +++ b/cvat/apps/documentation/user_guide.md @@ -8,8 +8,8 @@ - [Interface of the annotation tool](#interface-of-the-annotation-tool) - [Basic navigation](#basic-navigation) - [Types of shapes (basics)](#types-of-shapes-basics) - - [Annotation mode (basics)](#annotation-mode-basics) - - [Interpolation mode (basics)](#interpolation-mode-basics) + - [Shape mode (basics)](#shape-mode-basics) + - [Track mode (basics)](#track-mode-basics) - [Attribute annotation mode (basics)](#attribute-annotation-mode-basics) - [Downloading annotations](#downloading-annotations) - [Task synchronization with a repository](#task-synchronization-with-a-repository) @@ -255,7 +255,7 @@ Go to the [Django administration panel](http://localhost:8080/admin). There you 1. Task details is a task page which contains a preview, a progress bar and the details of the task (specified when the task was created) and the jobs section. - ![](static/documentation/images/image131.jpg) + ![](static/documentation/images/image131_DETRAC.jpg) - The next actions are available on this page: 1. Change the task’s title. @@ -267,7 +267,7 @@ Go to the [Django administration panel](http://localhost:8080/admin). There you 1. Assigned to — is used to assign a task to a person. Start typing an assignee’s name and/or choose the right person out of the dropdown list. - ``Jobs`` — is a list of all jobs for a particular task. Here you can find the next data: - - Jobs name whit a hyperlink to it. + - Jobs name with a hyperlink to it. - Frames — the frame interval. - A status of the job. The status is specified by the user in the menu inside the job. There are three types of status: annotation, validation or completed. @@ -442,39 +442,38 @@ Usage examples: Read more in the section [shape mode (advanced)](#shape-mode-advanced). -### Interpolation mode (basics) +### Track mode (basics) Usage examples: - Create new annotations for a sequence of frames. - Add/modify/delete objects for existing annotations. -- Edit tracks, merge a lot of bounding boxes into one track. +- Edit tracks, merge several rectangles into one track. -1. Before starting, you have to be sure that ``Interpolation`` is selected. +1. Like in the ``Shape mode``, you need to select a ``Rectangle`` on the sidebar, + in the appearing form, select the desired ``Label`` and the ``Drawing method``. - ![](static/documentation/images/image014.jpg) + ![](static/documentation/images/image083.jpg) -1. Create a track for an object (look at the selected car as an example): - - Annotate a bounding box on the first frame for the object. - - In ``Interpolation`` mode the bounding box will be interpolated on next frames automatically. +1. Creating a track for an object (look at the selected car as an example): + - Create a ``Rectangle`` in ``Track mode`` by clicking on ``Track``. - ![](static/documentation/images/image015_DETRAC.jpg) + ![](static/documentation/images/image014.jpg) -1. If the object starts to change its position, you need to modify bounding - boxes where it happens. It isn't necessary to change bounding boxes on each - frame. It is enough to update several key frames and frames between them - will be interpolated automatically. See an example below: - - The car starts moving on frame #630. Let's mark the frame as a key frame. - You can press ``K`` for that or push ``star`` button (see the screenshot below) + - In ``Track mode`` the rectangle will be automatically interpolated on the next frames. + - The cyclist starts moving on frame #2270. Let's mark the frame as a key frame. + You can press ``K`` for that or click the ``star`` button (see the screenshot below). ![](static/documentation/images/image016.jpg) - - Let's jump 30 frames forward and adjust boundaries of the object. + - If the object starts to change its position, you need to modify the rectangle where it happens. + It isn't necessary to change the rectangle on each frame, simply update several keyframes + and the frames between them will be interpolated automatically. + - Let's jump 30 frames forward and adjust the boundaries of the object. See an example below: ![](static/documentation/images/image017_DETRAC.jpg) - - After that, bounding boxes of the object between 630 and 660 frames - will be changed automatically. For example, frame #645 looks like on the figure below: + - After that the rectangle of the object will be changed automatically on frames 2270 to 2300: - ![](static/documentation/images/image018.jpg) + ![](static/documentation/images/gif019_DETRAC.gif) 1. When the annotated object disappears or becomes too small, you need to finish the track. You have to choose ``Outside Property``, shortcut ``O``. @@ -482,32 +481,30 @@ Usage examples: ![](static/documentation/images/image019.jpg) 1. If the object isn't visible on a couple of frames and then appears again, - you can use ``Merge Tracks`` feature to merge several individual tracks + you can use the ``Merge`` feature to merge several individual tracks into one. ![](static/documentation/images/image020.jpg) - - Let's create a track for the bus. + - Create tracks for moments when the cyclist is visible: - ![](static/documentation/images/gif001.gif) + ![](static/documentation/images/gif001_DETRAC.gif) - After that, you should create a track when it appears again on the sequence of frames. + - Click ``Merge`` button or press key ``M`` and click on any rectangle of the first track + and on any rectangle of the second track and so on: - ![](static/documentation/images/gif002.gif) + ![](static/documentation/images/image162_DETRAC.jpg) - - Press ``Merge Tracks`` button and click on any bounding box of the - first track and on any bounding box of the second track. + - Click ``Merge`` button or press ``M`` to apply changes. - ![](static/documentation/images/image021.jpg) - - - Press ``Apply Merge`` button to apply changes. - - ![](static/documentation/images/image022.jpg) + ![](static/documentation/images/image020.jpg) - The final annotated sequence of frames in ``Interpolation`` mode can look like the clip below: - ![](static/documentation/images/gif003.gif) + ![](static/documentation/images/gif003_DETRAC.gif) + + Read more in the section [track mode (advanced)](#track-mode-advanced). ### Attribute annotation mode (basics)