Documentation
Search…
Introduction
Tutorials
Getting started
Python SDK quickstart
Model-assisted labeling
How to integrate
Import data
Export data
Integrate with Hugging Face
Create an API key
Upload model predictions
Upload sample embeddings
Set up webhooks
How to manage and annotate
Add collaborators to a dataset
Create an organization
Configure the label editor
Customize hotkeys
Customize label queue priority
Search within a dataset
Clone a dataset
Work with issues
Bulk change label status
Use the labeling interfaces
3D point cloud segmentation interface
3D point cloud cuboid interface
Image segmentation interface
Image vector interface
Text named entities interface
Text span categorization interface
Use track IDs in sequences
Use keyframe interpolation
Background
Main concepts
Sequences
Label queue mechanics
Security
Reference
Python SDK
Task types
Sample formats
Label formats
Categories and task attributes
API
Python SDK (old v0.x)
Powered By GitBook
3D point cloud cuboid interface
When creating a dataset through the Python SDK, choose pointcloud-cuboid or pointcloud-cuboid-sequence as the task_type to use this labeling interface.

Cuboid editing

Create a new cuboid

Create a cuboid with default dimensions

If you've set up the default dimensions for your categories (see Categories), you can create a cuboid with default dimensions in one click.
  1. 1.
    Select the "Create cuboid" tool by clicking on the box icon in the toolbar on the left, or by pressing the hotkey (b by default).
  2. 2.
    Click in the perspective view or in the top view to create a new cuboid. This cuboid will have the default dimensions of the current category. When you change the category, the dimensions of the cuboid will change as well, given that you have not altered the dimensions of the cuboid yet.

Draw a cuboid with custom dimensions

  1. 1.
    Select the "Create cuboid" tool by clicking on the box icon in the toolbar on the left, or by pressing the hotkey (b by default).
  2. 2.
    Click and drag in the perspective view or in the top view to draw a new cuboid. When you release the mouse, the new cuboid is added to the objects sidebar on the right.

Remove a cuboid

  1. 1.
    Select the cuboid you want to remove.
  2. 2.
    Press the hotkey (Backspace by default) or click the trash icon next to the object in the objects sidebar on the right.

Select a cuboid

Using the "Select and edit" tool

  1. 1.
    Select the "Select and edit" tool by clicking on the pointer icon in the toolbar on the left, or by pressing the hotkey (Esc by default).
  2. 2.
    Click on the cuboid in any view.

Using the objects sidebar

  1. 1.
    Click on the object in the objects sidebar to select it.

Change the dimensions of a cuboid

  1. 1.
    Select the "Select and edit" tool by clicking on the pointer icon in the toolbar on the left, or by pressing the hotkey (Esc by default).
  2. 2.
    Select the cuboid you want to change.
  3. 3.
    Change the cuboid's dimensions:
    • In the perspective view: click and drag a face of the cuboid.
    • In a side view: click and drag one of the edges of the cuboid.

Translate a cuboid

  1. 1.
    Select the "Select and edit" tool by clicking on the pointer icon in the toolbar on the left, or by pressing the hotkey (Esc by default).
  2. 2.
    Select the cuboid you want to translate.
  3. 3.
    Click and drag the yellow cube in the middle of the cuboid to translate the cuboid freely. Hover over the yellow cube in the middle to see the translation axe. Click and drag on an axis to translate the cuboid along the selected axis.

Rotate a cuboid

  1. 1.
    Select the "Select and edit" tool by clicking on the pointer icon in the toolbar on the left, or by pressing the hotkey (Esc by default).
  2. 2.
    Select the cuboid you want to rotate.
  3. 3.
    Click and drag the red rotation plane in front of the cuboid to rotate the cuboid, or use the hotkeys:
    • Rotate 1° counterclockwise: f by default
    • Rotate 1° clockwise: g by default
    • Rotate 45° counterclockwise: Shift + F by default
    • Rotate 45° clockwise: Shift + G by default

Change the heading of a cuboid

  1. 1.
    Select the "Select and edit" tool by clicking on the pointer icon in the toolbar on the left, or by pressing the hotkey (Esc by default).
  2. 2.
    Select the cuboid you want to change.
  3. 3.
    Change the heading of the cuboid (indicated by a red arrow):
    • In the perspective view: double-click the face where you want the heading to be.
    • In a side view: double-click the edge where you want the heading to be.

Change the category of a cuboid

If the selected cuboid was created with default dimensions, the dimensions of the cuboid will change to the default dimensions of the new category.

Using the category dropdown

  1. 1.
    Select the cuboid.
  2. 2.
    Open the category dropdown by clicking on the category name in the objects sidebar on the right, or by pressing the hotkey (c by default).
  3. 3.
    Select a category by clicking on the desired category, or by using the arrow keys and pressing Enter to confirm.

Using the category hotkey

  1. 1.
    Select the cuboid.
  2. 2.
    Press the hotkey of the desired category (1 - 9).

Cycle between cuboids / select the next cuboid

Press the hotkey (Tab by default).

Viewing

Move the camera

Hold the hotkey (Ctrl/cmd by default) and click and drag.

Only in the perspective view

  • Use the keyboard navigation (by default: w to move forward, a to move left, s to move backward, and d to move right).

Rotate/orbit the camera in the perspective view

Hold the hotkey (Shift by default) and click and drag.

Zoom to a cuboid

  1. 1.
    Select the cuboid.
  2. 2.
    Press the hotkey (t by default).

Enable intensity coloring

  1. 1.
    Upload a point cloud with intensity labels.
  2. 2.
    Press the sun icon in the toolbar on the right to toggle intensity coloring.

Pan to a bird's eye view in the perspective view

Press the hotkey (Ctrl/cmd + b by default).

Change the size of the points

  1. 1.
    Click/hover over the dot icon in the toolbar on the right.
  2. 2.
    Drag the slider to adjust the point size.

Change the key pan speed

  1. 1.
    Click/hover over the tachometer icon in the toolbar on the right.
  2. 2.
    Drag the slider to adjust the key pan speed, i.e. the speed the camera moves when using keyboard navigation.
Previous
3D point cloud segmentation interface
Next
Image segmentation interface
Last modified 1mo ago
Copy link
Outline
Cuboid editing
Create a new cuboid
Remove a cuboid
Select a cuboid
Change the dimensions of a cuboid
Translate a cuboid
Rotate a cuboid
Change the heading of a cuboid
Change the category of a cuboid
Cycle between cuboids / select the next cuboid
Viewing
Move the camera
Rotate/orbit the camera in the perspective view
Zoom to a cuboid
Enable intensity coloring
Pan to a bird's eye view in the perspective view
Change the size of the points
Change the key pan speed