Skip to content
No description, website, or topics provided.
JavaScript CSS Python HTML Makefile CMake
Branch: master
Clone or download
Latest commit 44f960e Jul 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea updated install instructions Jan 22, 2019
assets remove lisat data Jul 24, 2019
colormaps fixed flipping of bb, draw bb only if in front of camera Nov 23, 2018
css fixed bug wrong projection of points Mar 13, 2019
fonts added download button Oct 18, 2018
input/NuScenes/ONE remove lisat data Jul 24, 2019
js remove lisat data Jul 24, 2019
my-app/src fixed interpolation bug Jan 11, 2019
output added cam images Jan 22, 2019
public fixed interpolation bug Jan 11, 2019
scripts/nuscenes_devkit remove lisat data Jul 24, 2019
src fixed interpolation bug Jan 11, 2019
tutorial_videos added reset tutorial video Jan 24, 2019
.babelrc fixed interpolation bug Jan 11, 2019
.gitignore remove paths from gitignore Jul 24, 2019
README.md remove lisat data Jul 24, 2019
camera_test.html fixed bug side views Jan 7, 2019
favicon.ico fixed interpolation bug Jan 11, 2019
index.html remove lisat data Jul 24, 2019
license remove lisat data Jul 24, 2019
manifest.json fixed interpolation bug Jan 11, 2019
mechanical_turk.html added transform controls Dec 4, 2018
multiviewport.html fixed bug side views Jan 7, 2019
package.json add jszip to package.json Jul 24, 2019
slider_test.html fixed bug: create object in 3d view Dec 8, 2018
test.json fixed bug: transparent color Feb 15, 2019
test2.json fixed bug side views Jan 7, 2019
tsconfig.json fixed interpolation bug Jan 11, 2019
webpack.config.js fixed interpolation bug Jan 11, 2019

README.md

Installation

  1. Clone repository: git clone https://github.com/walzimmer/3D_BoundingBox_Annotation_Tool_3D_BAT.git
  2. Install npm (linux): $sudo apt-get install npm
  3. Install PHP Storm (IDE with integrated server): https://www.jetbrains.com/phpstorm/download/download-thanks.html
  4. [OPTIONAL] Install WhatPulse to measure the number of clicks and key strokes while labeling: https://whatpulse.org/
  5. Open folder '3D_BoundingBox_Annotation_Tool_3D_BAT' in PHP Storm
  6. Move into directory: $cd 3D_BoundingBox_Annotation_Tool_3D_BAT
  7. Install required packages: $npm install
  8. Open index.html with chromium-browser (Linux) or Chrome (Windows) within the IDE

Overview

Overview

Paper

Paper

3D Boundingbox Annotation Instructions

  1. Step: Watch raw video (10 sec) to get familiar with the sequence and to see where interpolation makes sense
  2. Step: Watch tutorial videos to get familiar with (translation/scaling/rotating objects, interpolation and how to use helper views)
  3. Step: Start WhatPulse. Login with koyunujiju@braun4email.com and password: labeluser
  4. Step: Draw bounding box in the Bird's-Eye-View (BEV)
  5. Step: Move/Scale it in BEV using 3D arrows (drag and drop) or sliders
  6. Step: Choose one of the 5 classes (Car, Pedestrian, Cyclist, Motorbike, Truck)
  7. Step: Interpolate if necessary
    1. Select Object to interpolate by clicking on a Bounding Box
    2. Activate 'Interpolation Mode' in the menu (checkbox) -> start position will be saved
    3. Move to desired frame by skipping x frames
    4. Translate object to new position
    5. Click on the 'Interpolate' button in the menu
  8. Step: Repeat steps 4-7 for all objects in the sequence
  9. Step: Download labels to your computer (JSON file)
  10. Step: Stop the time after labeling is done.
  11. Step: Make screenshots of keyboard and mouse heat map, record number of clicks and keystrokes

Keyboard Shortcuts

Key Description
V Toggle view (3D view/Bird's-Eye-View)
W Move forward in 3D view (TODO)
A Move left in 3D view (TODO)
S Move backward in 3D view (TODO)
D Move right in 3D view (TODO)
Q Move down in 3D view (TODO)
E Move up in 3D view (TODO)
C Enlarge camera image
N Next frame
P Previous frame
I Interpolate
CTRLMOUSELEFT Snap to grid in 0.5m steps (floor alignment mode)
T Enable/Disable Translation mode
W Move selected object forward (TODO)
A Move selected object to left (TODO)
S Move selected object backward (TODO)
D Move selected object to right (TODO)
Q Move selected object down (TODO)
E Move selected object up (TODO)
R Enable/Disable Rotation mode
LEFT Rotate selected object counter-clock-wise (TODO)
RIGHT Rotate selected object clock-wise (TODO)
Y Enable/Disable Scaling mode
UP Increase length along longitudinal axis (y-axis) (TODO)
DOWN Decrease length along longitudinal axis (y-axis) (TODO)
LEFT Decrease width along lateral axis (x-axis) (TODO)
RIGHT Increase width along lateral axis (x-axis) (TODO)
SHIFTRIGHT Increase height along vertical axis (z-axis) (TODO)
CTRLRIGHT Decrease height along vertical axis (z-axis) (TODO)
PLUS Increase arrow size
MINUS Decrease arrow size
X Show/Hide X-axis
Y Show/Hide Y-axis
Z Show/Hide Z-axis (only in 3D mode)
SPACE Switch between different operation modes (translate, rotate, scale) (TODO)
TAB Select next object (TODO)
DEL OR BACKSPACE Delete selected object (TODO)
M Marking mode (TODO)
LEFT Move orientation of object counter-clock-wise (TODO)
RIGHT Move orientation of object clock-wise (TODO)
ONE Select class CAR (TODO)
TWO Select class Truck (TODO)
THREE Select class Motorcycle (TODO)
FOUR Select class Bicycle (TODO)
FIVE Select class Pedestrian (TODO)
MOUSELEFT On a 2D/3D object: Show bounding box
On a camera image: Enlarge/Shrink camera image (TODO)
On ego vehicle: Show field-of-view (TODO)
LEFTRIGHT: Switch FOV to next channel
R Reset all selected bounding boxes (TODO)
F11 Full Screen Mode
P Play video (TODO)
K Keyboard navigation (only in 3D view) (TODO)
L Toggle Lighting (TODO)
LONE Label random color (TODO)
LTWO Label class color (TODO)
T Show/Hide trajectory (TODO)
SHIFTS Save current screen into file (requires request to server) (TODO)
SHIFTD Download annotation file (TODO)
CTRLZ Undo operation (TODO)
CTRLY Redo operation (TODO)
CTRLW Close tab (exit)
G Show/Hide grid (TODO)
H Toggle aggregated pointcloud (TODO)
J Hide all labels except selected object (Press again to show all labels) (TODO)
QUESTIONMARK Show keyboard shortcuts
ESC Unselect box (TODO)
Quit fullscreen cam image (TODO)
ALTMOUSELEFT Copy bounding box (by dragging) (TODO)

Hints:

  • Select 'Copy label to next frame' checkbox if you want to keep the label (position, size, class) for next frame
  • Use helper views to align object along z-axis (no need to switch into 3D view)
  • Label one object from start to end (using interpolation) and then continue with next object
  • Do not apply more than one box to a single object.
  • Check every cuboid in every frame, to make sure all points are inside the cuboid and look reasonable in the image view.
  • The program has been quite stable in my use cases, but there is no guarantee that it won't crash. So please back up (download) your annotated scenes (~every 10 min). Saving to local storage (browser) is done automatically.
  • Download the annotation file into the following folder: 3d-bat/input/<DATASET>/<SEQUENCE>/annotations
  • Please open new issue tickets on Github for questions and bug reports or write me an email (wzimmer@eng.ucsd.edu). Thanks!

Special Rules

  • Minimum LIDAR Points :
    • Label any target object containing at least 10 LIDAR point, as long as you can be reasonably sure you know the location and shape of the object. Use your best judgment on correct cuboid position, sizing, and heading.
  • Cuboid Sizing :
    • Cuboids must be very tight. Draw the cuboid as close as possible to the edge of the object without excluding any LIDAR points. There should be almost no visible space between the cuboid border and the closest point on the object.
  • Extremities :
    • If an object has extremities (eg. arms and legs of pedestrians), then the bounding box should include the extremities.
    • Exception: Do not include vehicle side view mirrors. Also, do not include other vehicle extremities (crane arms etc.) that are above 1.5 meters high.
  • Carried Object :
    • If a pedestrian is carrying an object (bags, umbrellas, tools etc.), such object will be included in the bounding box for the pedestrian. If two or more pedestrians are carrying the same object, the bounding box of only one of them will include the object.
  • Use Pictures:
    • For objects with few LIDAR points, use the images to make sure boxes are correctly sized. If you see that a cuboid is too short in the image view, adjust it to cover the entire object based on the image view.

Labels

For every bounding box, include one of the following labels:

  1. Car: Vehicle designed primarily for personal use, e.g. sedans, hatch-backs, wagons, vans, mini-vans, SUVs, jeeps and pickup trucks (A pickup truck is a light duty truck with an enclosed cab and an open or closed cargo area. A pickup truck can be intended primarily for hauling cargo or for personal use).

  2. Truck: Vehicles primarily designed to haul cargo including lorrys, trucks.

  3. Motorcycle: Gasoline or electric powered 2-wheeled vehicle designed to move rapidly (at the speed of standard cars) on the road surface. This category includes all motorcycles, vespas and scooters. It also includes light 3-wheel vehicles, often with a light plastic roof and open on the sides, that tend to be common in Asia. If there is a rider and/or passenger, include them in the box.

  4. Bicycle: Human or electric powered 2-wheeled vehicle designed to travel at lower speeds either on road surface, sidewalks or bicycle paths. If there is a rider and/or passenger, include them in the box.

  5. Pedestrian: An adult/child pedestrian moving around the cityscape. Mannequins should also be annotated as Pedestrian.

Detailed Instructions and Examples

Bounding Box color convention in example images:

  • Green: Objects like this should be annotated

Car

  • Vehicle designed primarily for personal use, e.g. sedans, hatch-backs, wagons, vans, mini-vans, SUVs and jeeps.

    • If it is primarily designed to haul cargo it is a truck.

Truck

  • Vehicles primarily designed to haul cargo including lorrys, trucks, pickup truck (+ A pickup truck is a light duty truck with an enclosed cab and an open or closed cargo area. A pickup truck can be intended primarily for hauling cargo or for personal use).

Motorcycle

  • Gasoline or electric powered 2-wheeled vehicle designed to move rapidly (at the speed of standard cars) on the road surface. This category includes all motorcycles, vespas and scooters. It also includes light 3-wheel vehicles, often with a light plastic roof and open on the sides, that tend to be common in Asia.

    • If there is a rider, include the rider in the box.
    • If there is a passenger, include the passenger in the box.
    • If there is a pedestrian standing next to the motorcycle, do NOT include in the annotation.

Bicycle

  • Human or electric powered 2-wheeled vehicle designed to travel at lower speeds either on road surface, sidewalks or bicycle paths.

    • If there is a rider, include the rider in the box
    • If there is a passenger, include the passenger in the box
    • If there is a pedestrian standing next to the bicycle, do NOT include in the annotation

Adult/child Pedestrian

  • An adult/child pedestrian moving around the cityscape.

    • Mannequins should also be treated as pedestrian.

License

Copyright © 2019 The Regents of the University of California

All Rights Reserved. Permission to copy, modify, and distribute this tool for educational, research and non-profit purposes, without fee, and without a written agreement is hereby granted, provided that the above copyright notice, this paragraph and the following three paragraphs appear in all copies. Permission to make commercial use of this software may be obtained by contacting:

Office of Innovation and Commercialization 9500 Gilman Drive, Mail Code 0910 University of California La Jolla, CA 92093-0910 (858) 534-5815 innovation@ucsd.edu

This tool is copyrighted by The Regents of the University of California. The code is supplied “as is”, without any accompanying services from The Regents. The Regents does not warrant that the operation of the tool will be uninterrupted or error-free. The end-user understands that the tool was developed for research purposes and is advised not to rely exclusively on the tool for any reason.

IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS TOOL, EVEN IF THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE TOOL PROVIDED HEREUNDER IS ON AN “AS IS” BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

You can’t perform that action at this time.