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
Contents:
- Getting Started
- API Reference
- Examples
- How to read this page
- Scenario: The Shortest Useful Script
- Scenario: Nudge The Ego And Submit
- Scenario: Several Variants From One Baseline
- Scenario: Ego Shift
- Scenario: Editing Part Of The Trajectory
- Scenario: Ego Translate
- Scenario: Ego Rotate
- Scenario: Ego Transform
- Scenario: Ego Resample And Offset
- Scenario: Ego Apply T Sequence
- Scenario: Reaching An Actor
- Scenario: Actor Shift, Translate And Rotate
- Scenario: Actor Speed And Move Forward
- Scenario: Actor Stop And Make Static
- Scenario: Trajectory Slice, Resample And Offset
- Scenario: Actor Transform And Apply T Sequence
- Scenario: Fluent Chains
- Scenario: Insert Actor
- Scenario: Insert Static Actor
- Scenario: Insert Actor On Ego Trajectory
- Scenario: Crossing
- Scenario: Removing Actors
- Scenario: Object Appearance
- Scenario: Moving A Sensor
- Scenario: Sensor Conventions And Resolution
- Scenario: Pedestrian Crossing In Front Of The Ego
- Scenario: Lead Vehicle Brake Check
- Scenario: Roadworks Cone Corridor
- Scenario: Convoy On The Ego Path
- Scenario: Occlusion Study
- Scenario: Sensor Rig Rebuild
- Scenario: Parameter Sweep
- Scenario: DataFrame Driven Schedule
- Where to go next