Skip to main content

AVxcelerate Sensors Simulator API 2025 R1

vss::simulation::RadarSimulation Struct Reference

Last update: 14.01.2025

Describes the simulation parameters for a radar and, optionally, the type of batching method. More...

Collaboration diagram for vss::simulation::RadarSimulation:

Public Attributes

int32 number_of_ray_reflections = 1
 
int32 number_of_ray_transmissions = 2
 
double ray_density = 3 [deprecated = true]
 
RadarGridSampling grid_sampling = 11
 
ManualBatching manual_batching = 4
 
AutomaticBatching automatic_batching = 5
 
bool tx_waveform_report = 6
 
bool ego_vehicle_emission_blockage = 7
 
RadarDebugViewParameters debug_view_parameters = 8
 
map< int32, double > max_ray_path_length_by_mode = 9
 
map< int32, double > max_velocity_by_mode = 10
 

Detailed Description

Describes the simulation parameters for a radar and, optionally, the type of batching method.

Member Data Documentation

◆ number_of_ray_reflections

int32 vss::simulation::RadarSimulation::number_of_ray_reflections = 1

The maximum number of ray bounces (reflections) on the scene's objects before the ray is forced to return to the sensor.

Note
The limit applies to each individual ray.

◆ number_of_ray_transmissions

int32 vss::simulation::RadarSimulation::number_of_ray_transmissions = 2

The maximum number of transmissions on the scene's objects before the ray is forced to return to the sensor.

Note
The limit applies to each individual ray.

◆ ray_density

double vss::simulation::RadarSimulation::ray_density = 3 [deprecated = true]

The linear ray density per radar wavelength (at max distance of 100 m).

Warning
This field is marked deprecated and might be removed in later versions. Consider using grid_sampling instead.

◆ grid_sampling

RadarGridSampling vss::simulation::RadarSimulation::grid_sampling = 11

The sampling of the grid.

◆ manual_batching

ManualBatching vss::simulation::RadarSimulation::manual_batching = 4

ONEOF(batching) The configuration of the manual batching.

Note
Optional field. By default, the sensor execution is not batched.

◆ automatic_batching

AutomaticBatching vss::simulation::RadarSimulation::automatic_batching = 5

ONEOF(batching) The configuration of the automatic batching.

Note
Optional field. By default, the sensor execution is not batched.

◆ tx_waveform_report

bool vss::simulation::RadarSimulation::tx_waveform_report = 6

Activation of the tx waveform output generation by the radar.

Default value: false

◆ ego_vehicle_emission_blockage

bool vss::simulation::RadarSimulation::ego_vehicle_emission_blockage = 7

Indicates whether or not the Ego vehicle geometry will be considered in calculations upon the emission of the ray's first bounce.

When this parameter is set to true, the ego vehicle geometry is considered in calculations upon the emission of the ray's first bounce.

When this parameter is set to false (which is the default value), the ego vehicle geometry is not considered in calculations upon the emission of the ray's first bounce.

Default value: false

◆ debug_view_parameters

RadarDebugViewParameters vss::simulation::RadarSimulation::debug_view_parameters = 8

Parameters for the debug view.

Optional field. If not set, the debug view is disabled.

◆ max_ray_path_length_by_mode

map<int32, double> vss::simulation::RadarSimulation::max_ray_path_length_by_mode = 9

The maximal length for the ray path per radar mode.

Key [int32]: The mode id.

Value [double]: The maximal length for the ray path.

Unit: meters (m)

Range: ] 0, 2* max_path_length [

Default value: 200

Note
Features with total path length greater than twice the max ray path length, including the path back to the radar, will be excluded.
This parameter only applies to radars with arbitrary waveform.
Arbitrary waveform is delivered as a beta feature in the current release.

◆ max_velocity_by_mode

map<int32, double> vss::simulation::RadarSimulation::max_velocity_by_mode = 10

The maximal velocity for each radar mode.

Key [int32]: The mode id.

Value [double]: The maximal velocity.

Unit: meters per second (m/s)

Range: ] 0, double max[

Default value: 75

Note
Features with (absolute value of) relative velocity greater than the maximal velocity will be excluded.
This parameter only applies to radars with arbitrary waveform.
Arbitrary waveform is delivered as a beta feature in the current release.

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

Connect with Ansys