2021-06-20 22:00:16 +00:00
---
title: Working with Frames
---
2021-10-21 06:40:53 +00:00
View and edit SingleFrames in the Dataset page. After selecting a Hyper-Dataset version, the **Version Browser** shows a sample
2023-05-17 07:39:38 +00:00
of frames and enables viewing SingleFrames and FramesGroups, and editing SingleFrames, in the [frame viewer ](#frame-viewer ).
2023-06-04 06:45:48 +00:00
Before opening the frame viewer, you can filter the frames by applying [simple ](webapp_datasets_versioning.md#simple-frame-filtering ) or [advanced ](webapp_datasets_versioning.md#advanced-frame-filtering )
2021-06-21 18:13:17 +00:00
filtering logic.
2021-06-20 22:00:16 +00:00
2022-11-15 12:17:42 +00:00
2021-06-20 22:00:16 +00:00
2021-09-09 10:17:46 +00:00
## Frame Viewer
2021-06-20 22:00:16 +00:00
2023-07-18 08:08:20 +00:00
Use the frame viewer to view and edit annotations (ROIs and frame labels), frame details (see [frames ](../frames.md )),
and frame metadata, as well as view frame masks of your dataset version frames.
2021-06-20 22:00:16 +00:00
2021-07-25 11:59:37 +00:00
2021-06-20 22:00:16 +00:00
2021-09-09 10:17:46 +00:00
### Frame Viewer Controls
2021-06-20 22:00:16 +00:00
2021-10-21 06:40:53 +00:00
Use frame viewer controls to navigate between frames in a Hyper-Dataset Version, and control frame changes and viewing.
2021-06-20 22:00:16 +00:00
2021-07-25 11:59:37 +00:00
|Control Icon|Actions|Shortcut|
|-----|------|----|
|< img src = "/docs/latest/icons/ico-skip-backward.svg" alt = "Jump backwards icon" className = "icon size-md space-sm" / > | Jumps backwards ten frames | CTRL + Left arrow |
|< img src = "/docs/latest/icons/ico-skip-previous.svg" alt = "Jump to previous unfiltered annotation" className = "icon size-md space-sm" / > |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.| < img src = "/docs/latest/icons/ico-optional-no.svg" alt = "Not applicable" className = "icon size-md center-md" / > |
|< img src = "/docs/latest/icons/ico-arrow-left.svg" alt = "Previous frame icon" className = "icon size-md space-sm" / > |Go to the previous frame | Left arrow |
|< img src = "/docs/latest/icons/ico-arrow-right.svg" alt = "Next frame icon" className = "icon size-md space-sm" / > |Go to the next frame | Right arrow |
|< img src = "/docs/latest/icons/ico-skip-next.svg" alt = "Jump to next unfiltered annotation" className = "icon size-md space-sm" / > |Go to the next frame containing a non-filtered annotation (same filter as < img src = "/docs/latest/icons/ico-skip-previous.svg" alt = "Jump to previous unfiltered annotation" className = "icon size-md space-sm" / > ).| < img src = "/docs/latest/icons/ico-optional-no.svg" alt = "Not applicable" className = "icon size-md center-md" / > |
|< img src = "/docs/latest/icons/ico-skip-forward.svg" alt = "Jump forwards icon" className = "icon size-md space-sm" / > |Jump forwards ten frames | CTRL + Right arrow |
|< img src = "/docs/latest/icons/ico-revert.svg" alt = "Reload frame icon" className = "icon size-md space-sm" / > |Reload the frame.| < img src = "/docs/latest/icons/ico-optional-no.svg" alt = "Not applicable" className = "icon size-md center-md" / > |
|< img src = "/docs/latest/icons/ico-undo.svg" alt = "Undo icon" className = "icon size-md space-sm" / > |Undo changes.|Ctrl + Z|
|< img src = "/docs/latest/icons/ico-redo.svg" alt = "Redo icon" className = "icon size-md space-sm" / > |Redo changes.|Ctrl + Y|
|< img src = "/docs/latest/icons/ico-reset_1.svg" alt = "Autofit icon" className = "icon size-md space-sm" / > |Autofit| < img src = "/docs/latest/icons/ico-optional-no.svg" alt = "Not applicable" className = "icon size-md center-md" / > |
|< img src = "/docs/latest/icons/ico-zoom-in.svg" alt = "Zoom in icon" className = "icon size-md space-sm" /> |Zoom in| ** +** or Ctrl + Mouse wheel|
|< img src = "/docs/latest/icons/ico-zoom-out.svg" alt = "Zoom out icon" className = "icon size-md space-sm" /> |Zoom out| ** -** or Ctrl + Mouse wheel |
|Percentage textbox|Zoom percentage| < img src = "/docs/latest/icons/ico-optional-no.svg" alt = "Not applicable" className = "icon size-md center-md" / > |
2023-07-18 08:08:20 +00:00
|< img src = "/docs/latest/icons/ico-shared-item.svg" alt = "Copy URL" className = "icon size-md space-sm" / > | Copy frame URL. A direct link to view the current frame|< img src = "/docs/latest/icons/ico-optional-no.svg" alt = "Not applicable" className = "icon size-md center-md" / > |
2023-11-02 08:30:12 +00:00
|< img src = "/docs/latest/icons/ico-reset.svg" alt = "Refresh" className = "icon size-md space-sm" / > |Refresh version preview|< img src = "/docs/latest/icons/ico-optional-no.svg" alt = "Not applicable" className = "icon size-md center-md" / > |
2022-01-10 09:45:29 +00:00
#### Additional Keyboard Shortcuts
2021-07-25 11:59:37 +00:00
2021-09-09 10:17:46 +00:00
**General Controls**
2021-07-25 11:59:37 +00:00
|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 |
2021-09-09 10:17:46 +00:00
**General Annotation Controls**
2021-07-25 11:59:37 +00:00
|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|
|----|-----|----|
2021-12-12 06:42:54 +00:00
| Hold Shift | Key points (< img src = "/docs/latest/icons/ico-keypoint-icon-purple.svg" alt = "Key points mode" className = "icon size-sm space-sm" / > ) | 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 (< img src = "/docs/latest/icons/ico-keypoint-icon-purple.svg" alt = "Key points mode" className = "icon size-sm space-sm" / > ) | Complete annotation |
| Esc | Key points (< img src = "/docs/latest/icons/ico-keypoint-icon-purple.svg" alt = "Key points mode" className = "icon size-sm space-sm" / > ), Polygon (< img src = "/docs/latest/icons/ico-polygon-icon-purple.svg" alt = "Polygon mode" className = "icon size-sm space-sm" / > ) | Cancel annotation process |
2021-06-20 22:00:16 +00:00
2021-09-09 10:17:46 +00:00
### Viewing and Editing Frames
2021-06-20 22:00:16 +00:00
**To view / edit a frame in the frame editor**
2023-06-04 06:45:48 +00:00
1. Locate your frame by applying a [simple frame filter ](webapp_datasets_versioning.md#simple-frame-filtering ) or [advanced frame filter ](webapp_datasets_versioning.md#advanced-frame-filtering ), and clicking **LOAD MORE** , if required.
2021-06-20 22:00:16 +00:00
1. Click the frame thumbnail. The frame editor appears.
1. Do any of the following:
* View frame details, including:
* Frame file path
* Dimensions of the image or video
* Frame details
* Frame metadata
* Annotations
* Frame objects - Labeled Regions of Interest, with confidence levels and custom metadata per frame object.
* Frame labels - Labels applied to the entire frame, not a region in the frame.
2022-01-10 09:45:29 +00:00
* Optionally, filter annotations by confidence level using the **Minimum confidence** slider.
2021-06-20 22:00:16 +00:00
* Add, change, and delete [annotations ](#annotations ) and [frame metadata ](#frame-metadata ).
2021-06-21 18:13:17 +00:00
2022-01-10 09:45:29 +00:00
:::important Saving Frame Changes
2021-06-20 22:00:16 +00:00
To save frames changes at any time, click **SAVE** (below the annotation list area).
:::
2021-06-21 18:13:17 +00:00
2021-06-20 22:00:16 +00:00
### Viewing FrameGroups
2021-06-21 18:13:17 +00:00
Viewing and editing frames in a FrameGroup is similar to viewing and editing SingleFrames.
2021-10-21 06:40:53 +00:00
Click the FrameGroup in the Hyper-Dataset. In the frame viewer, select SingleFrame to view / modify from
2021-06-20 22:00:16 +00:00
a dropdown list in the **Current Source** section.
2021-07-25 11:59:37 +00:00
2021-06-20 22:00:16 +00:00
2021-11-07 07:52:27 +00:00
## Masks
2022-04-07 08:49:11 +00:00
Use the **MASKS** panel to select which masks to apply over the frame.
2021-11-07 07:52:27 +00:00
To view / hide a specific mask, click < img src = "/docs/latest/icons/ico-show.svg" alt = "Eye Show" className = "icon size-md space-sm" / > .
In order to view all masks, click **Show all** / **Hide all** .
2022-04-07 08:49:11 +00:00
Masks are applied over the image either by pixel segmentation or as an alpha channel:
* < img src = "/docs/latest/icons/ico-segmentation.svg" alt = "Pixel segmentation mode" className = "icon size-md space-sm" /> Pixel
segmentation - Class labels are mapped onto the mask according to their pixel value definitions, and each
class is assigned a unique color.
* < img src = "/docs/latest/icons/ico-alpha-mask.svg" alt = "Alpha channel mode" className = "icon size-md space-sm" /> Alpha
channel - Mask pixel values are translated to transparency. Additionally, a color can be applied to the mask to help
distinguish multiple masks. Click < img src = "/docs/latest/icons/ico-mask-color-preview.svg" alt = "Alpha color" className = "icon size-md space-sm" / > to select
a color.
2021-11-07 07:52:27 +00:00
To adjust the transparency of a mask, use its opacity slider.
### Labels
The **Active mask labels** section displays the color mapping of the mask labels.
The panel presents labels only from masks that are currently displayed.
**To modify a label's color and opacity:**
1. Click the colored circle next to the label
1. Select a new color
1. Adjust the opacity slider
1. Click **OK**
## Annotations
2022-09-15 13:10:11 +00:00
### Adding Frame Objects (Regions of Interest)
2021-06-20 22:00:16 +00:00
2022-11-27 13:15:23 +00:00
Annotate images and video by labeling regions of interest in Dataset version frames. You can create new annotations
and copy existing annotations.
2021-06-20 22:00:16 +00:00
2022-09-15 13:10:11 +00:00
#### Creating New Frame Objects
2021-06-20 22:00:16 +00:00
2022-11-27 13:15:23 +00:00
To draw a new annotation:
2021-06-20 22:00:16 +00:00
2022-11-27 13:15:23 +00:00
1. Click one of the following modes to choose what annotation to create:
2021-06-21 18:13:17 +00:00
2022-11-27 13:15:23 +00:00
* < img src = "/docs/latest/icons/ico-rectangle-icon-purple.svg" alt = "Rectangle mode icon" className = "icon size-md space-sm" /> - Rectangle mode:
Click then drag the cursor to create a rectangle annotation on the frame.
2021-06-21 18:13:17 +00:00
2022-11-27 13:15:23 +00:00
* < img src = "/docs/latest/icons/ico-ellipse-icon-purple.svg" alt = "Ellipse mode icon" className = "icon size-md space-sm" /> - Ellipse mode:
Click then drag the cursor to create an ellipse annotation on the frame.
2021-06-21 18:13:17 +00:00
2022-11-27 13:15:23 +00:00
* < img src = "/docs/latest/icons/ico-polygon-icon-purple.svg" alt = "Polygon mode icon" className = "icon size-md space-sm" /> - Polygon mode:
Each click sets polygon vertices on the frame. Click again on the initial vertex to close the polygon.
2021-06-21 18:13:17 +00:00
2022-11-27 13:15:23 +00:00
* < img src = "/docs/latest/icons/ico-keypoint-icon-purple.svg" alt = "Key points mode icon" className = "icon size-md space-sm" /> - Key points mode:
2022-11-29 08:09:09 +00:00
Each click adds a keypoint to the frame. After clicking the last keypoint, click < img src = "/docs/latest/icons/ico-save.svg" alt = "Check mark" className = "icon size-md space-sm" / >
or < code > Enter< / code > to save the annotation. Click < code > Esc< / code > to cancel the annotation.
2021-06-21 11:57:22 +00:00
2021-06-21 18:13:17 +00:00
A new annotation is created.
2021-06-21 11:57:22 +00:00
2022-09-15 13:10:11 +00:00
1. In the newly created annotation, select or type-in a label(s). Click the circle in the label name to select a
different label color.
2021-06-20 22:00:16 +00:00
2022-09-15 13:10:11 +00:00
You can use the **Default ROI Label(s)** list to automatically set labels to all new annotations.
2021-06-20 22:00:16 +00:00
2022-09-15 13:10:11 +00:00
#### Copying Frame Objects
You can copy existing annotations, and paste them to any frame of your choice:
1. Click the annotation or bounded area in the frame.
1. Click < img src = "/docs/latest/icons/ico-copy-to-clipboard.svg" alt = "Copy annotation" className = "icon size-md space-sm" />
(copy annotation).
1. Navigate to the frame of your choice (you can remain in the same frame).
1. Click **PASTE** . The new annotation appears in the same location as the one you copied. You can paste the annotation
multiple times.
Copy all annotations in a frame by clicking the **COPY ALL** button.
2021-06-20 22:00:16 +00:00
2022-09-15 13:10:11 +00:00
### Annotation Actions
2021-06-20 22:00:16 +00:00
2022-09-15 13:10:11 +00:00
The following table describes the actions that can be performed on existing annotations. The frame editor automatically
saves changes when you move to another frame using the frame navigation controls
(< img src = "/docs/latest/icons/ico-arrow-right.svg" alt = "Next frame icon" className = "icon size-md space-sm" / > , < img src = "/docs/latest/icons/ico-skip-next.svg" alt = "Jump to next unfiltered annotation" className = "icon size-md space-sm" / > , < img src = "/docs/latest/icons/ico-skip-forward.svg" alt = "Jump forwards icon" className = "icon size-md space-sm" / > , < img src = "/docs/latest/icons/ico-arrow-left.svg" alt = "Previous frame icon" className = "icon size-md space-sm" / > , < img src = "/docs/latest/icons/ico-skip-previous.svg" alt = "Jump to previous unfiltered annotation" className = "icon size-md space-sm" / > , < img src = "/docs/latest/icons/ico-skip-backward.svg" alt = "Jump backwards icon" className = "icon size-md space-sm" / > ,
or the arrow keys on the keyboard). Closing the frame editor will prompt you to save any changes.
2021-06-20 22:00:16 +00:00
2022-09-15 13:10:11 +00:00
| Icon (when applicable) | Action | Description |
|---|---|---|
|| Move annotation | Click on a bounded area and drag it. |
2023-12-03 12:27:46 +00:00
|| Resize annotation| Select an annotation, then click on a bounded area's vertex and drag it. |
2022-09-15 13:10:11 +00:00
|< img src = "/docs/latest/icons/ico-metadata.svg" alt = "edit metadata" className = "icon size-md space-sm" / > |Edit metadata|Hover over an annotation in the list and click the icon to open the edit window. Input the metadata dictionary in JSON format. This metadata is specific to the selected annotation, not the entire frame.|
|< img src = "/docs/latest/icons/ico-lock-open.svg" alt = "Lock annotation" className = "icon size-md space-sm" / > |Lock / Unlock annotation |Click the button on a specific annotation to make it uneditable. You can also click the button on top of the annotations list to lock all annotations in the frame.|
2023-11-27 13:14:21 +00:00
|< img src = "/docs/latest/icons/ico-trash.svg" alt = "Trash" className = "icon size-md space-sm" / > |Delete annotation|Click the annotation or bounded area in the frame and then click the button to delete the annotation.|
2023-12-03 12:27:46 +00:00
|< img src = "/docs/latest/icons/ico-show.svg" alt = "Eye Show All" className = "icon size-md space-sm" / > |Show/hide all annotations |Click the button to view the frame without annotations. When annotations are hidden, they can't be modified. |
2022-09-15 13:10:11 +00:00
||Delete label |In the relevant annotation, click **x** on the label you want to remove.|
2021-06-20 22:00:16 +00:00
2022-09-15 13:10:11 +00:00
### Frame Labels
2021-06-20 22:00:16 +00:00
2022-09-15 13:10:11 +00:00
You can add labels which describe the whole frame, with no specific coordinates.
2021-06-20 22:00:16 +00:00
2022-09-15 13:10:11 +00:00
**To add frame labels:**
2021-06-20 22:00:16 +00:00
2022-09-15 13:10:11 +00:00
1. Expand the **FRAME LABELS** area (below **OBJECTS** )
1. Click ** + Add new**
1. Enter a label(s)
2021-06-20 22:00:16 +00:00
2021-09-09 10:17:46 +00:00
## Frame Metadata
2021-06-20 22:00:16 +00:00
2021-06-21 18:13:17 +00:00
**To edit frame metadata:**
2022-09-15 13:10:11 +00:00
1. Expand the **FRAME METADATA** area
1. Click edit < img src = "/docs/latest/icons/ico-metadata.svg" alt = "edit metadata" className = "icon size-md space-sm" />
which will open an editing window
1. Modify the metadata dictionary in JSON format
2021-06-20 22:00:16 +00:00
