Skip to main content

DeepScenario Toolkit for visualizing and working with DeepScenario datasets

Project description

DeepScenario Toolkit

A Python toolkit for visualizing and working with DeepScenario datasets, which can be downloaded at app.deepscenario.com.

Overview

DeepScenario provides a platform to virtualize real-world recordings into:

  • a 3D reconstruction of the static environment
  • 3D trajectories of the dynamic objects

This toolkit provides easy-to-use tools for visualizing and working with DeepScenario datasets, including:

  • visualization of the object annotations in 3D or in OpenStreetMap
  • creation of an orthophoto from the 3D reconstruction

Installation

From PyPI (Recommended)

pip install dsc-toolkit

From Source (Development)

This project uses uv for dependency management. Make sure you have uv installed first.

# Clone the repository
git clone https://github.com/deepscenario/dsc-toolkit.git
cd dsc-toolkit

# Install the package and dependencies
uv sync

Quick Start

The toolkit provides a command-line tool with several commands. Each command has detailed help available using the --help option, for example:

dsc-toolkit plot_annotations_3d --help

plot_annotations_3d

Interactive 3D visualization of the object annotations:

dsc-toolkit plot_annotations_3d \
	--data_dir tests/assets/data \
	--recording 2000-12-31T23-59-59 \
	--mesh tests/assets/data/textured_mesh/textured_mesh.obj

plot_annotations_georeferenced

Interactive visualization of the object annotations in OpenStreetMap:

dsc-toolkit plot_annotations_georeferenced \
	--data_dir tests/assets/data \
	--recording 2000-12-31T23-59-59 \
	--save_dir /tmp/output

render_orthophoto

Render a georeferenced orthophoto from the textured mesh:

dsc-toolkit render_orthophoto \
	--data_dir tests/assets/data \
	--mesh tests/assets/data/textured_mesh/textured_mesh.obj \
	--save_dir /tmp/output

OpenDRIVE Map Visualization

To visualize an OpenDRIVE map in plot_annotations_3d, you need to first convert it to OBJ format. Choose one of the following methods:

Method 1: Online Conversion

  1. Navigate to odrviewer.io
  2. In "Parse Options", disable "Center Map"
  3. Click "Open .xodr" and select your OpenDRIVE file
  4. Click "Export .obj" to download the converted file

Method 2: Offline Conversion

This method relies on esmini and OpenSceneGraph:

Prerequisites

# Install OpenSceneGraph
sudo apt install openscenegraph

# Download and set up esmini
wget https://github.com/esmini/esmini/releases/latest/download/esmini-demo_ubuntu-latest.zip
unzip esmini-demo_ubuntu-latest.zip
export PATH=$PATH:$(pwd)/esmini/bin

Conversion Steps

  1. Generate OpenSceneGraph model from your OpenDRIVE file:

    odrviewer --odr map.xodr --save_generated_model --headless --duration 0 --disable_log --disable_stdout
    
  2. Convert to OBJ format:

    osgconv generated_road.osgb map.obj --use-world-frame
    

The resulting map.obj file can now be used with plot_annotations_3d.

License

This project is licensed under the Apache License 2.0. See LICENSE.txt for details.

Support

For questions, issues, or contributions, please:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dsc_toolkit-1.0.4.tar.gz (399.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dsc_toolkit-1.0.4-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

Details for the file dsc_toolkit-1.0.4.tar.gz.

File metadata

  • Download URL: dsc_toolkit-1.0.4.tar.gz
  • Upload date:
  • Size: 399.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dsc_toolkit-1.0.4.tar.gz
Algorithm Hash digest
SHA256 a12d6d6525c7c5d6372ff61800d2101dfe4171685b8496d7fbf095cb9597b3b5
MD5 cd6ffabea0b67971ab014f5b94284176
BLAKE2b-256 6302741e366193d0432582f935039a95ada5bb9321aea5af112d0bae93979c63

See more details on using hashes here.

Provenance

The following attestation bundles were made for dsc_toolkit-1.0.4.tar.gz:

Publisher: publish.yml on deepscenario/dsc-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dsc_toolkit-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: dsc_toolkit-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 17.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for dsc_toolkit-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 35107711ef8e3e2c941d3956af80fc7f24916e038ec24f48d95167b801f5046d
MD5 7c7e701a7565a9fc9820ddec6ea1a526
BLAKE2b-256 95e0e4ccdd3e377d6ba1f95f19c78af5ffddd9a7d40e5a0647b2eacd3383f01f

See more details on using hashes here.

Provenance

The following attestation bundles were made for dsc_toolkit-1.0.4-py3-none-any.whl:

Publisher: publish.yml on deepscenario/dsc-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page