diff --git a/docs/hyperdatasets/webapp/webapp_datasets_frames.md b/docs/hyperdatasets/webapp/webapp_datasets_frames.md index efd167f5..19e9d574 100644 --- a/docs/hyperdatasets/webapp/webapp_datasets_frames.md +++ b/docs/hyperdatasets/webapp/webapp_datasets_frames.md @@ -7,7 +7,7 @@ of frames and enables viewing SingleFrames and FramesGroups, and edit SingleFram Before opening the frame viewer, you can filter the frames by applying [simple](#simple-frame-filtering) or [advanced](#advanced-frame-filtering) filtering logic. -![image](../../img/hyperdatasets/frames_01.png) +![Dataset page](../../img/hyperdatasets/frames_01.png) ## Frame viewer @@ -15,27 +15,53 @@ Frame viewer allows you to view and edit annotations which can be FrameGroup obj labels applied to the entire frame not a region of the frame, the frame details (see [frames](../frames.md)), frame metadata, the raw data source URI, as well as providing navigation and viewing tools. -![image](../../img/hyperdatasets/web-app/dataset_example_frame_editor.png) +![Frame viewer](../../img/hyperdatasets/web-app/dataset_example_frame_editor.png) ### Frame viewer controls Use frame viewer controls to navigate between frames in a Dataset Version, and control frame changes and viewing. -|Control Icon|Actions| -|-----|------| -||Jump backwards (CTRL + Left). Jumps backwards by five frames.| -||Go to the previous frame containing a non-filtered annotation. The filter is the minimum confidence level setting. If the confidence level filter is set to zero, any frame containing annotations matches the filter.| -||Go to the previous frame (Left Arrow).| -||Go to the next frame (Right Arrow).| -||Go to the next frame containing a non-filtered annotation (same filter as ).| -||Jump forwards (CTRL + Right). Jumps 5 frames forwards.| -||Reload the frame.| -||Undo changes.| -||Redo changes.| -||Autofit| -||Zoom in| -||Zoom out| -|Percentage textbox|Zoom percentage| +|Control Icon|Actions|Shortcut| +|-----|------|----| +|Jump backwards icon| Jumps backwards ten frames | CTRL + Left arrow | +|Jump to previous unfiltered annotation|Go to the previous frame containing a non-filtered annotation. The filter is the minimum confidence level setting. If the confidence level filter is set to zero, any frame containing annotations matches the filter.| Not applicable | +|Previous frame icon|Go to the previous frame | Left arrow | +|Next frame icon|Go to the next frame | Right arrow | +|Jump to next unfiltered annotation|Go to the next frame containing a non-filtered annotation (same filter as Jump to previous unfiltered annotation).| Not applicable | +|Jump forwards icon|Jump forwards ten frames | CTRL + Right arrow | +|Reload frame icon|Reload the frame.| Not applicable | +|Undo icon|Undo changes.|Ctrl + Z| +|Redo icon|Redo changes.|Ctrl + Y| +|Autofit icon|Autofit| Not applicable | +|Zoom in icon|Zoom in| **+** or Ctrl + Mouse wheel| +|Zoom out icon|Zoom out| **-** or Ctrl + Mouse wheel | +|Percentage textbox|Zoom percentage| Not applicable | + +#### Additional keyboard shortcuts + +**General controls** + +|Control|Action| +|----|-----| +|Hold Spacebar + Press and hold image + Drag| Move around image. NOTE: If using a touchpad, this only works if the *Disable touchpad while typing* setting is turned off | +|Esc | Escape frame viewer and return to dataset page | + +**General annotation controls** + +|Control|Action| +|----|-----| +| Delete | Remove annotation | +| Alt + ] / [ | Choose a default ROI label by navigating between previous / next labels | +| Shift + M | Edit metadata | +| Shift + Tab | Previous annotation (use after clicking an annotation) | + +**Mode-specific annotation controls** + +|Control |Mode |Action| +|----|-----|----| +| Hold Shift | Key points (Key points mode) | While holding Shift, add new points to the ROI by left clicking, and move a single point by dragging it with your mouse | +| Enter | Key points (Key points mode) | Complete annotation | +| Esc | Key points (Key points mode), Polygon (Polygon mode) | Cancel annotation process | ### Viewing and editing frames @@ -66,7 +92,7 @@ Viewing and editing frames in a FrameGroup is similar to viewing and editing Sin Click the FrameGroup in the Dataset. In the frame viewer, select SingleFrame to view / modify from a dropdown list in the **Current Source** section. -![image](../../img/hyperdatasets/framegroup_01.png) +![Frame dropdown menu in FrameGroup](../../img/hyperdatasets/framegroup_01.png) ## Filtering frames ### Simple frame filtering @@ -86,7 +112,7 @@ For example:
-![image](../../img/hyperdatasets/frame_filtering_01.png) +![Unfiltered version browser](../../img/hyperdatasets/frame_filtering_01.png)
@@ -99,7 +125,7 @@ For example: View a screenshot
-![image](../../img/hyperdatasets/frame_filtering_02.png) +![Filtered version browser](../../img/hyperdatasets/frame_filtering_02.png)
@@ -138,7 +164,7 @@ where each frame filter can be a combination of ROI, frame, and source rules. View a screenshot
- ![image](../../img/hyperdatasets/frame_filtering_03.png) + ![Adding an ROI rule](../../img/hyperdatasets/frame_filtering_03.png)
@@ -149,7 +175,7 @@ where each frame filter can be a combination of ROI, frame, and source rules. View a screenshot
- ![image](../../img/hyperdatasets/frame_filtering_04.png) + ![Add label to ROI rule](../../img/hyperdatasets/frame_filtering_04.png)
@@ -161,7 +187,7 @@ where each frame filter can be a combination of ROI, frame, and source rules. View a screenshot
- ![image](../../img/hyperdatasets/frame_filtering_05.png) + ![Labeled ROIs in frame viewer](../../img/hyperdatasets/frame_filtering_05.png)
@@ -178,7 +204,7 @@ Filter by metadata using Lucene queries. View a screenshot
- ![image](../../img/hyperdatasets/frame_filtering_08.png) + ![Filter by metadata ](../../img/hyperdatasets/frame_filtering_08.png)
@@ -190,7 +216,7 @@ Filter by metadata using Lucene queries. View a screenshot
- ![image](../../img/hyperdatasets/frame_filtering_09.png) + ![Frame metadata in frame viewer](../../img/hyperdatasets/frame_filtering_09.png)
@@ -207,7 +233,7 @@ Filter by sources using Lucene queries. View a screenshot
- ![image](../../img/hyperdatasets/frame_filtering_10.png) + ![Filter by source](../../img/hyperdatasets/frame_filtering_10.png)
@@ -227,16 +253,16 @@ You can add annotations by drawing new bounding areas, and copying existing anno 1. Click one of the following modes and create a bounding area in the frame: - * - Rectangle mode: Drag a + * Rectangle mode icon - Rectangle mode: Drag a rectangle onto the frame. - * - Ellipse mode: Drag an ellipse + * Ellipse mode icon - Ellipse mode: Drag an ellipse onto the frame. - * - Polygon mode: Click the polygon + * Polygon mode icon - Polygon mode: Click the polygon vertices onto the frame. - * - Key points mode: Click each + * Key points mode icon - Key points mode: Click each keypoint onto the frame. After the clicking the last keypoint, click the first again to close the bounding area. A new annotation is created. @@ -250,6 +276,8 @@ You can add annotations by drawing new bounding areas, and copying existing anno **To copy an annotation:** 1. Click the annotation or bounded area in the image or video clip. +1. In the annotation, click Copy annotation icon + (copy annotation) 1. Optionally, navigate to a different frame. 1. Click **PASTE**. The new annotation appears in the same location as the one you copied. 1. Optionally, to paste the same annotation, click **PASTE** again in the desired frame.