Documentation
  • Introduction
  • Tutorials
    • Getting started
    • Python SDK quickstart
    • Model-assisted labeling
  • How to annotate
    • Label images
      • View and navigate in the image interfaces
      • Image interface settings
      • Image segmentation interface
      • Image vector interface
    • Label 3D point clouds
      • View and navigate in the 3D interface
      • Upload, view, and overlay images
      • 3D interface settings
      • 3D point cloud cuboid interface
      • 3D point cloud vector interface
      • 3D point cloud segmentation interface
      • Merged point cloud view (for static objects)
      • Batch mode (for dynamic objects)
      • Smart cuboid propagation
      • 3D to 2D Projection
      • Tips for labeling cuboid sequences
    • Label sequences of data
      • Use track IDs in sequences
      • Use keyframe interpolation
    • Annotate object links (beta)
    • Customize hotkeys
  • How to manage
    • Add collaborators to a dataset
    • Create an organization
    • Configure the label editor
    • Customize label queue
    • Search within a dataset
    • Clone a dataset
    • Work with issues
    • Bulk change label status
    • Manage QA processes
  • How to integrate
    • Import data
      • Cloud integrations
    • Export data
      • Structure of the release file
      • Exporting image annotations to different formats
    • Integrations
      • Hugging Face
      • W&B
      • Databricks
      • SceneBox
    • Create an API key
    • Upload model predictions
    • Set up webhooks
  • Background
    • Main concepts
    • Sequences
    • Label queue mechanics
    • Labeling metrics
    • 3D Tiles
    • Security
  • Reference
    • Python SDK
    • Task types
    • Sample formats
      • Supported file formats
    • Label formats
    • Categories and attributes
    • API
Powered by GitBook
On this page
  • View the keyframes of an object
  • Add a keyframe
  • In the current frame
  • In a different frame
  • Move a keyframe
  • Remove a keyframe
  • View the remove-keyframes of an object
  • Add a remove-keyframe
  • Move a remove-keyframe
  • Remove a remove-keyframe
  • Label occluded objects

Was this helpful?

  1. How to annotate
  2. Label sequences of data

Use keyframe interpolation

PreviousUse track IDs in sequencesNextAnnotate object links (beta)

Last updated 4 months ago

Was this helpful?

Keyframe interpolation is the process of creating intermediate values between a set of keyframes. The keyframes are specified by you and then the values in the frames between the keyframes are automatically filled in.

In Segments.ai, keyframe interpolation is used for object labels that change over time. For example, in a sequence with a moving car, the bounding box around the car moves in each frame. With keyframe interpolation, you only need to specify the label at certain key times, and the intermediate labels will be created automatically.

Keyframe interpolation is available for 2D bounding box labels, and for 3D cuboid labels.

and interpolation

Editing an object-level attribute will create a new keyframe, and attribute values are copied between keyframes. This means that if you edit an object-level attribute, its value will be copied until the next existing keyframe.

If want to change an attribute of an object with existing keyframes, make sure to change the value on all necessary keyframes.

View the keyframes of an object

In the context of interpolation, a keyframe is a marker that indicates that at that frame, the state of the object is defined by the user. In other frames (that are not keyframes), the state of the object label is calculated automatically through interpolation.

  1. Select the object.

  2. The keyframes are now visible in the timeline at the bottom of the editor. A normal keyframe is shown as a blue diamond under the frame it belongs to.

Add a keyframe

In the current frame

  1. Select the object.

  2. Make a change to the object in the editor. A keyframe containing the new changes is added automatically.

In a different frame

  1. Select the object.

  2. In the timeline, double-click the space under the frame where you want to add a keyframe. The keyframe captures the state of the object label at that frame. This means the object will not change.

Move a keyframe

  1. Select the object.

  2. In the timeline, click and drag the keyframe. When you release your mouse, the changes will be applied and the interpolation will be recalculated.

Remove a keyframe

  1. Select the object.

  2. In the timeline, click the keyframe you want to remove.

  3. Press the Backspace key to remove the keyframe. The interpolation will be recalculated immediately.

When there exists only one keyframe, this keyframe cannot be removed.

View the remove-keyframes of an object

A remove-keyframe is a visual indication of where an object was removed from the sample. A remove-keyframe means that the object is not present in that frame and all frames before the next normal keyframe.

  1. Select the object.

  2. The delete-keyframes are now visible in the timeline at the bottom of the editor. A delete-keyframe is indicated as a grey circle with a cross.

Add a remove-keyframe

  1. Select the object.

  2. Remove the object from the current frame (see Use the labeling interfaces). A remove-keyframe is added automatically.

Move a remove-keyframe

  1. Select the object.

  2. In the timeline, click and drag the remove-keyframe. When you release your mouse, the changes will be applied.

Remove a remove-keyframe

  1. Select the object.

  2. In the timeline, click the remove-keyframe you want to remove.

  3. Press the Backspace key to remove the remove-keyframe. The interpolation will be recalculated immediately.

Label occluded objects

Sometimes an object might be occluded, in which case you might want the object to not be present in certain frames and reappear in other frames. There are several ways to obtain this.

One procedure is to ...

  1. Label a cuboid

  2. Adjust the cuboid on the first frame where it reappears. This will create a keyframe.

  3. Remove the cuboid on the first frame where it starts being occluded. The removal will carry through to the next keyframe which is the first frame where it reappears.

Another procedure is to ...

  1. Label a cuboid

  2. Remove the cuboid in the first frame where it starts being occluded.

  3. Label a new cuboid in the first frame where it reappears

  4. Change the track ID of the new cuboid into the track ID of the initial cuboid. This will merge both cuboids together on a single track.

Object attributes