Skip to content

Annotation Quickstart

Before following the quickstart, it could be helpful to skim the User Interface Guide

Single Frame Detections

How to quickly create multiple detections on a single image frame.

  1. Click (creation settings menu) in the Track List area.
    1. From the Mode dropdown, choose Detection.
    2. From the Type dropdown, choose or enter a default name that all new detections will have. If the type doesn't exist yet, enter a name to create a new one.
    3. Turn on the Continuous Mode switch if you would like to automatically re-enter the creation state so you can click-and-drag repeatedly to quickly create many detections.
  2. Enter the annotation creation state by clicking Detection or pressing the N key.
  3. Create your first detection by clicking and dragging to draw a rectangle.
  4. If you are in continuous mode, click and drag again to create the next detection.
    1. Press Esc to exit continuous creation mode.

Single Detection Mode Demo

The demo below shows how to use Detection mode to quickly create numerous detections of the same type.

Detection Mode Demo

Track Annotations

How to quickly create track annotations for a video or image sequence.

Interpolation Mode

Linear interpolation is a kind of spatio-temporal annotation that allows the inference of bounding boxes between keyframes. Interpolation mode is the fastest and easiest way to generate track annotations.

Interpolation editing for existing tracks will only be enabled on tracks that span more than one frame. It is enabled on new tracks by default.

  1. Click (creation settings menu) in the Track List area.
    1. From the Mode dropdown, choose Track.
    2. Also ensure that the Interpolate switch is turned on.
  2. Enter the annotation creation state by clicking Track or pressing the N key.
  3. Create your first detection by clicking and dragging to draw a rectangle around the object you want to track.
  4. You can now go forward one or more frames by pressing F or Right or by using the Timeline controls and an outline of the previous annotation will remain.
    1. Interpolated Editing
  5. To set another keyframe, either move or resize the transparent annotation or press K. There are also controls on for the currently selected track to add/remove keyframes.
    1. and will allow you to add and remove the current keyframe.
    2. and will turn on or off interpolation for the current keyframe interval region you are in.
    3. Interpolate Track Settings

Visualizing interpolated tracks

Click Events in the Timeline controls to see where interpolation occurs and where the keyframes are located.

  • Keyframes are indicated by solid rectangular blue tick marks in the highlighted track.
  • Interpolated regions are indicated by a thin yellow line between keyframes.
  • Gap regions are indicated by areas with neither interpolated frames nor keyframes. Typically means that a track is off-camera or occluded.

Interpolated EventViewer

Interpolation Mode Demo

Detection Mode Demo

Advance Frame Mode

This mode keeps you editing the same track while automatically advancing the frame each time a detection is drawn. In most cases interpolation mode will be easier.

  1. Click (creation settings menu) in the Track List area.
    1. From the Mode dropdown, choose Track.
    2. Also ensure that the Interpolate switch is turned off.
  2. Enter the annotation creation state by clicking Track or pressing the N key.
  3. Create your first detection by clicking and dragging to draw a rectangle around the object you want to track.
  4. Now each time an individual detection is drawn the frame will automatically advance to the next frame. Press Esc to end creation of the track.

Advance Frame Mode Demo

The demo below shows how to use AdvanceFrame mode to travel through the video while creating annotations.

Detection Mode Demo

Head Tail Annotations

Adding Head/Tail points to existing annotations

  1. Right-click an existing detection to enter edit mode.
  2. Enter head/tail creation mode
    1. In the Edit bar, click
    2. Or Press H to create a head point.
    3. Or press T to create a tail point.
  3. The mouse cursor will become a crosshair. Click in the annotator to place each point.
  4. Once the first marker is placed it automatically transitions to the second marker. If you start with head, the second one will be the tail and vice versa.

Creating new annotations using Head/Tail points

You can create a track by starting with a head/tail annotation or just a single point.

  1. Enter the annotation creation state by clicking Track or pressing the N key.
  2. In the Edit bar, click to switch to head/tail creation mode or press H, T, or 3.
  3. The mouse cursor will become a crosshair. Click in the annotator to place each point.
  4. Press Esc to finish creation after one or both points have been placed.

Other notes on Head/Tail

  • The head point is denoted by a filled circle, while the tail point is denoted by a hollow circle.

    Tail Mode

  • You don't have to place both markers. Press Esc on your keyboard at anytime to exit out of the line creation mode.

  • You can modify an existing head/tail marker by placing the annotation into 'Edit Mode' and then selecting the line tool from the editing options.
  • You can delete a head/tail pair by selecting a detection with existing markers, entering edit mode, and clicking Delete Linestring

Fish Head Tail Demo

Head Tail Annotation Demo

Polygon Annotations

Every track is required to have a bounding box, but a polygon region may be added. When a polygon is created or edited it will generate or adjust the bounding box to fit the size of the polygon.

Polygon Creation

  1. Enter the annotation creation state by clicking Track or pressing the N key.
  2. In the Edit bar, click or press 2 to enter polygon creation mode.
  3. Place each point on the polygon by clicking.
  4. Right-Click to automatically close the polygon or press Esc to cancel creation.

Polygon Editing

  1. Right click an annotation to enter edit mode.
  2. In the Edit bar, click or press 2 to enter polygon edit mode.
  3. Click and drag any large circle handle to move it. This will move the point to a new position and recalculate the bounding box.
  4. Click and drag any small circle handle to create new points. This can be used to adjust the polygon and make it appear smoother.
  5. To delete the whole polygon, in the Edit bar, click Del polygon
  6. To delete a single keypoint, click its handle then click Del Point N

Polygon Demo

Polygon Demo