Skip to main content

AVxcelerate Sensors Simulator API 2023 R2

vss::simulation::SensorParameters Struct Reference

Last update: 16.07.2025

Simulation parameters for a given sensor id. More...

Collaboration diagram for vss::simulation::SensorParameters:

Public Attributes

string identifier = 1
 
RecordingFormat recording_format = 2
 
DisplayInformation display = 3
 
RadarSimulation radar_simulation = 4
 
LidarSimulation lidar_simulation = 5
 
PbCameraSimulation pb_cam_simulation = 6
 
ThermalCameraSimulation thermal_cam_simulation = 7
 
OutputSplitting output_splitting = 8
 
google::protobuf::BoolValue serialize_data = 9
 
string deploy_node_id = 10
 

Detailed Description

Simulation parameters for a given sensor id.

Note
If the type of sensor is not consistent with the sensor configuration, it will cause an error.

Member Data Documentation

◆ deploy_node_id

string vss::simulation::SensorParameters::deploy_node_id = 10

The identifier of the deploy node on which the sensor will be spawned, as defined in the deploy configuration. (optional)

Note
Multi-nodes simulation is delivered as a beta feature in the current release.

◆ display

DisplayInformation vss::simulation::SensorParameters::display = 3

If present, the camera output will be displayed on the screen in a dedicated rendering window. The resolution of the rendering window is the one defined in the sensor configuration.

Note
Only applicable to camera sensors. Ignored for other sensors.

◆ identifier

string vss::simulation::SensorParameters::identifier = 1

The unique identifier of the sensor as defined in the sensor configuration.

◆ lidar_simulation

LidarSimulation vss::simulation::SensorParameters::lidar_simulation = 5

ONEOF(sensor_parameter) Specific parameters for a lidar.

◆ output_splitting

OutputSplitting vss::simulation::SensorParameters::output_splitting = 8

Defines how the sensor output must be split.

Note
This parameter is optional: if not set, the output data is not split.

◆ pb_cam_simulation

PbCameraSimulation vss::simulation::SensorParameters::pb_cam_simulation = 6

ONEOF(sensor_parameter) Specific parameters for a physics-based camera.

◆ radar_simulation

RadarSimulation vss::simulation::SensorParameters::radar_simulation = 4

ONEOF(sensor_parameter) Specific parameters for a radar.

◆ recording_format

RecordingFormat vss::simulation::SensorParameters::recording_format = 2

This parameter indicates if the sensor must dump its outputs to disk. If not specified, no sensor data will be dumped.

◆ serialize_data

google::protobuf::BoolValue vss::simulation::SensorParameters::serialize_data = 9

Indicates if the data should be serialized during the simulation (default serialized).

Note
Only Camera Output (Image) and Imager Output (Injection) data of physics-based camera sensors can be unserialized. Camera Lens Output (Light), thermal camera, lidar and radar output data are always serialized.

◆ thermal_cam_simulation

ThermalCameraSimulation vss::simulation::SensorParameters::thermal_cam_simulation = 7

ONEOF(sensor_parameter) Specific parameters for a thermal camera.


The documentation for this struct was generated from the following file:
  • simulation_parameters.proto

Connect with Ansys