MIMIC Scene Edition API Documentation

Welcome to the MIMIC Scene Edition API documentation. This library provides a powerful interface for programmatically editing driving scenes, including the ego vehicle, actors (vehicles, pedestrians), and sensors (cameras, LiDARs, radars).

Quick Start

In scene edition scripts, the SceneEditor is available as the scene variable:

# Edit the ego vehicle
scene.ego.shift(forward=5).rotate(yaw=15)

# Edit an actor
scene.actor(4).displace(forward=10).shift(left=2)

# Edit a sensor
scene.camera("FRONT").shift(up=0.05).rotate(pitch=-2)

# Insert a new actor
new_id = scene.insert_actor_on_ego_trajectory(4, forward=20, left=1.5)

Key Features

  • Fluent Interface: Chain multiple operations for concise scene editing

  • Coordinate Frames: Work in local (vehicle) or world coordinates

  • Value Limiting: Optional safety limits on transformation parameters

  • Modification Tracking: All edits are logged for debugging and auditing

Indices and tables