    

 ## On this page

  

 

 # vss::simulation::SensorParameters Struct Reference

 Last update: 16.07.2025 

[Simulation](a00646.xhtml "This service provides the simulation control procedures.") parameters for a given sensor id. [More...](a00654.xhtml#details)

Collaboration diagram for vss::simulation::SensorParameters:

![Collaboration graph](/sites/default/files/migrate-content/avxcelerate_sensors_simulator_api_2023_r2/a00652.png)

\[[legend](graph_legend.xhtml)\]

## <a id="pub-attribs" name="pub-attribs"></a>Public Attributes

string [identifier](a00654.xhtml#a0992e8610dd365cf41269f4e2b2d3f60) = 1 [RecordingFormat](a00722.xhtml) [recording\_format](a00654.xhtml#a038071eea4353930683fcaa95c8a8056) = 2 [DisplayInformation](a00658.xhtml) [display](a00654.xhtml#a24378052ec7597a81fd5a5f218e3f69f) = 3 [RadarSimulation](a00686.xhtml) [radar\_simulation](a00654.xhtml#a451f5bcf0184d29d997f461a99c09656) = 4 [LidarSimulation](a00706.xhtml) [lidar\_simulation](a00654.xhtml#ae2641c8ac11ba1fb88b8eef2204e1bf1) = 5 [PbCameraSimulation](a00666.xhtml) [pb\_cam\_simulation](a00654.xhtml#a62887911f25b3b86dc9ee6ad40c35564) = 6 [ThermalCameraSimulation](a00674.xhtml) [thermal\_cam\_simulation](a00654.xhtml#a4427be3505c07682546cc7bba2b4f767) = 7 [OutputSplitting](a00730.xhtml) [output\_splitting](a00654.xhtml#afb6970ba2c065b09ab2774fe0559a704) = 8 google::protobuf::BoolValue [serialize\_data](a00654.xhtml#aaf5e1ebedbe438446020f280477cd4e9) = 9 string [deploy\_node\_id](a00654.xhtml#a2b33511156f8590a64822cc74e17a1b9) = 10 <a id="details" name="details"></a>## Detailed Description

[Simulation](a00646.xhtml "This service provides the simulation control procedures.") parameters for a given sensor id.

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

## Member Data Documentation

<a id="a2b33511156f8590a64822cc74e17a1b9"></a>## [◆ ](#a2b33511156f8590a64822cc74e17a1b9)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)

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



<a id="a24378052ec7597a81fd5a5f218e3f69f"></a>## [◆ ](#a24378052ec7597a81fd5a5f218e3f69f)display

 [DisplayInformation](a00658.xhtml) 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.

NoteOnly applicable to camera sensors. Ignored for other sensors. 



<a id="a0992e8610dd365cf41269f4e2b2d3f60"></a>## [◆ ](#a0992e8610dd365cf41269f4e2b2d3f60)identifier

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

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





<a id="ae2641c8ac11ba1fb88b8eef2204e1bf1"></a>## [◆ ](#ae2641c8ac11ba1fb88b8eef2204e1bf1)lidar\_simulation

 [LidarSimulation](a00706.xhtml) vss::simulation::SensorParameters::lidar\_simulation = 5

ONEOF(sensor\_parameter) Specific parameters for a lidar.





<a id="afb6970ba2c065b09ab2774fe0559a704"></a>## [◆ ](#afb6970ba2c065b09ab2774fe0559a704)output\_splitting

 [OutputSplitting](a00730.xhtml) vss::simulation::SensorParameters::output\_splitting = 8

Defines how the sensor output must be split.

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



<a id="a62887911f25b3b86dc9ee6ad40c35564"></a>## [◆ ](#a62887911f25b3b86dc9ee6ad40c35564)pb\_cam\_simulation

 [PbCameraSimulation](a00666.xhtml) vss::simulation::SensorParameters::pb\_cam\_simulation = 6

ONEOF(sensor\_parameter) Specific parameters for a physics-based camera.





<a id="a451f5bcf0184d29d997f461a99c09656"></a>## [◆ ](#a451f5bcf0184d29d997f461a99c09656)radar\_simulation

 [RadarSimulation](a00686.xhtml) vss::simulation::SensorParameters::radar\_simulation = 4

ONEOF(sensor\_parameter) Specific parameters for a radar.





<a id="a038071eea4353930683fcaa95c8a8056"></a>## [◆ ](#a038071eea4353930683fcaa95c8a8056)recording\_format

 [RecordingFormat](a00722.xhtml) 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.





<a id="aaf5e1ebedbe438446020f280477cd4e9"></a>## [◆ ](#aaf5e1ebedbe438446020f280477cd4e9)serialize\_data

 google::protobuf::BoolValue vss::simulation::SensorParameters::serialize\_data = 9

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

NoteOnly 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. 



<a id="a4427be3505c07682546cc7bba2b4f767"></a>## [◆ ](#a4427be3505c07682546cc7bba2b4f767)thermal\_cam\_simulation

 [ThermalCameraSimulation](a00674.xhtml) 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