Git Product home page Git Product logo

labelcloud's Introduction

Contributions welcome!

labelCloud

A lightweight tool for labeling 3D bounding boxes in point clouds.

Overview of the Labeling Tool 🆕 We are currently evaluating labelCloud and invite you to fill this questionaire https://forms.gle/moEyjGSa1Eiiq7VT8 (~5 min)!

Setup

ℹ️ Currently labelCloud supports Python 3.6 to 3.8; Python 3.9 will be supported as soon as Open3D supports it!

git clone https://github.com/ch-sa/labelCloud.git  # 1. Clone repository
pip install -r requirements.txt  # 2. Install requirements
# 3. Copy point clouds into `pointclouds` folder.
python3 labelCloud.py  # 4. Start labelCloud

Configure the software to your needs by editing the config.ini file or settings according to the docs.

Labeling

labelCloud supports two different ways of labeling (picking & spanning) as well as multiple mouse and keyboard options for subsequent correction.

Screencast of the Labeling Methods (See also https://www.youtube.com/watch?v=8GF9n1WeR8A for a short introduction and preview of the tool.)

Picking Mode

  • Pick the location of the bounding box (front-top edge)
  • Adjust the z-rotation by scrolling with your mouse wheel

Spanning Mode

  • Subsequently span the length, width and height of the bounding box by selecting four vertices
  • The layers for for the last two vertices (width & height) will be locked to allow easy selection

Correction

  • Use the buttons on the left-hand side or shortcuts to correct the translation, dimension and rotation of the bounding box
  • Resize the bounding box by holding your cursor above one side and scrolling with the mouse wheel

By default the x- and y-rotation of bounding boxes will be prohibited. For labeling 9 DoF-Bounding Boxes deactivate z-Rotation Only Mode in the menu, settings or config.ini file. Now you will be free to rotate around all three axes.

Import & Export Options

labelCloud is built for a versatile use and aims at supporting all common point cloud file formats and label formats for storing 3D bounding boxes. The tool is designed to be easily adaptable to multiple use cases. To change the settings, simply edit the corresponding line in the config.ini (see the documentation for a description of all parameters).

Supported Import Formats

Type File Formats
Colored *.pcd, *.ply, *.pts, *.xyzrgb
Colorless *.xyz, *.xyzn, *.bin (KITTI)

Supported Export Formats

Label Format Description
centroid_rel Centroid [x, y, z]; Dimensions [length, width, height];
Relative Rotations as Euler angles in radians (-pi..+pi) [yaw, pitch, roll]
centroid_abs Centroid [x, y, z]; Dimensions [length, width, height];
Absolute Rotations as Euler angles in degrees (0..360°) [yaw, pitch, roll]
vertices 8 Vertices of the bounding box each with [x, y, z] (see documentation.md for order)
kitti Centroid; Dimensions; z-Rotation (See specification)

You can easily create your own exporter by implementing the IFormattingInterface. All rotations are counterclockwise (i.e. a z-rotation of 90°/π is from the positive x- to the negative y-axis!).

Shortcuts

Shortcut Description
Navigation
Left Mouse Button Rotates the Point Cloud
Right Mouse Button Translates the Point Cloud
Mouse Wheel Zooms into the Point Cloud
Correction
W, A, S, D
Ctrl + Right Mouse Button
Translates the Bounding Box back, left, front, right
Q, E Lifts the Bounding Box up, down
X, Y Rotates the Boundign Box around z-Axis
Scrolling with the Cursor above a Bounding Box Side ("Side Pulling") Changes the Dimension of the Bounding Box
C & V, B & N Rotates the Bounding Box around y-Axis, x-Axis
General
Del Deletes Current Bounding Box
R Resets Perspective
Esc Cancels Selected Points

See documentation.md for software conventions.

Usage & Attribution

When using the tool feel free to drop me a mail with feedback or a description of your use case (christoph.sager[at]tu-dresden.de). If you are using the tool for a scientific project please consider citing our pending publication:

# forthcoming
@article{sager_2021,
  title={labelCloud: A Lightweight Domain-Independent Labeling Tool for 3D Object Detection in Point Clouds},
  journal={Computer-Aided Design and Applications},
  author={Sager, Christoph and Zschech, Patrick and Kühl, Niklas},
  year={2021}}

# published
@misc{sager2021labelcloud,
  title={labelCloud: A Lightweight Domain-Independent Labeling Tool for 3D Object Detection in Point Clouds}, 
  author={Christoph Sager and Patrick Zschech and Niklas Kühl},
  year={2021},
  eprint={2103.04970},
  archivePrefix={arXiv},
  primaryClass={cs.CV}
}

Acknowledgment

I would like to thank the Robotron RCV-Team for the support in the preparation and user evaluation of the software. The software was developed as part of my diploma thesis titled "labelCloud: Development of a Labeling Tool for 3D Object Detection in Point Clouds" at the Chair for Business Informatics, especially Intelligent Systems of the TU Dresden. The ongoing research can be followed in our project on ResearchGate.

labelcloud's People

Contributors

ch-sa avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.