Skip to main content

AVxcelerate Sensors Simulator API 2025 R1

vss::simulation Namespace Reference

Last update: 14.01.2025

Classes

struct  AssetInfo
 Describes one asset. More...
 
struct  AutomaticBatching
 Defines the automatic batching configuration. More...
 
struct  CameraGroundTruthParameters
 Defines the types of ground truth output data the physics-based camera simulation will generate. More...
 
struct  CartesianGrid
 Defines the Cartesian grid. More...
 
struct  Configuration
 Configuration message containing all parameters needed to load resources in AVX. More...
 
struct  DataAccessSettings
 Defines the mechanisms for accessing and managing sensor data. It supports configurations for storing data either on disk or in shared memory. More...
 
struct  DeployConfiguration
 Describes the parameters used to configure AVX deployment. More...
 
struct  DeployHost
 Defines the deploy nodes on a remote host. More...
 
struct  DeployNode
 Defines the deploy node parameters. More...
 
struct  DisplayInformation
 Defines the display settings of a camera sensor. More...
 
struct  EndPointRange
 Describes the parameters used to configure AVX deployment. More...
 
struct  EnvironmentUpdate
 Applies an update to the environment. More...
 
struct  GpuIdentifier
 Represents an identifier for a GPU. More...
 
struct  Grid
 Describes the type of lidar sensor grid. More...
 
struct  KinematicProperties
 Properties that define the motion of a solid. More...
 
struct  LidarSimulation
 Describes simulation parameters for a lidar. More...
 
struct  LightingSystem
 Describes a lighting system with its identifier and either a data buffer or the identifier of the uploaded resource. More...
 
struct  LightingSystemConfiguration
 
struct  LightingSystemParameters
 Contains lighting system simulation parameters. More...
 
struct  LocalNodes
 The deploy parameters of the local workstation. More...
 
struct  ManualBatching
 Defines the manual batching configuration. More...
 
struct  ObjectKey
 Object key used to identify the nodes on which the update shall be applied. More...
 
struct  ObjectUpdate
 Update to be applied on an object. More...
 
struct  OutputSplitting
 Defines the output data splitting configuration. More...
 
struct  PbCameraSimulation
 Describes the simulation parameters for a physics-based camera. More...
 
struct  PolarGrid
 Defines the polar grid. More...
 
struct  RadarDebugViewParameters
 Describes the parameters for the radar's debug view. More...
 
struct  RadarGridSampling
 Radar grid sampling specifies the global sampling and the adaptive sampling to be applied to the scene. More...
 
struct  RadarGridSamplingParameters
 Radar grid sampling parameters, which consist of the ray spacing parameter. More...
 
struct  RadarOutputSplitting
 Defines the radar output data splitting configuration. More...
 
struct  RadarSimulation
 Describes the simulation parameters for a radar and, optionally, the type of batching method. More...
 
struct  RecordingFormat
 Defines the format for recording the sensor's outputs. More...
 
struct  RemoteDirectMemoryAccess
 Data access using Remote Direct Memory Access (RDMA) technology is delivered as a beta feature in the current release. More...
 
struct  RenderingParameters
 Sets the rendering engine parameters for a camera. More...
 
class  ResourceUploader
 Upload Service. More...
 
struct  RxBatching
 Sets the batching on rx channels. More...
 
struct  SceneInfo
 Contains all components that make up a scene: the assets and the track. More...
 
struct  SensorConfig
 Describes a binary sensor configuration data. More...
 
struct  SensorParameters
 Contains the simulation parameters for a given sensor id. More...
 
class  Simulation
 This service provides the simulation control procedures. More...
 
struct  SimulationParameters
 Contains general simulation parameters, as well as simulation parameters per sensor id. These parameters define the accuracy of the simulation, the types of sensor outputs to be generated and how they will be generated/stored. More...
 
struct  State
 State defined on an object node. More...
 
struct  Tag
 Definition of the tag using or not an index. More...
 
struct  ThermalCameraSimulation
 Describes the simulation parameters for a thermal camera. More...
 
struct  TopLeftCornerPosition
 Describes the top left corner position of the rendering window relative to the top left corner of the monitor. More...
 
struct  UploadMetaData
 Provides information on the data to upload. More...
 
struct  UploadRequest
 Upload request message. More...
 
struct  WorldUpdate
 Contains an update of the world to be applied to AVX. More...
 

Enumerations

enum  Qualities {
  UNDEFINED = 0, LOW = 1, MEDIUM = 2, HIGH = 3,
  EXTREME = 4
}
 The possible values for quality factors. More...
 
enum  ColorMode { BLACKWHITE = 0, COATING = 1, VELOCITY = 2, NORMAL = 3 }
 The available color modes for the radar's debug view output. More...
 
enum  RadarOutputSplittingLevel { DEFAULT = 0, MODE = 1, TRANSMITTER = 2 }
 The radar output splitting level. More...
 

Variables

import avx vss simulation deploy_parameters proto
 

Enumeration Type Documentation

◆ Qualities

The possible values for quality factors.

Enumerator
UNDEFINED 

Undefined value. (The default value will apply.)

LOW 

Low quality.

MEDIUM 

Medium quality.

HIGH 

High quality.

EXTREME 

Extreme quality. (Default value.)

◆ ColorMode

The available color modes for the radar's debug view output.

Enumerator
BLACKWHITE 

Color in shades of gray by the angle of incidence between the surface and viewing direction. (Default value.)

COATING 

Color by the dielectric properties of the materials.

Note
Color assignment is determined by the material indices of each radar simulation instance and is not deterministic.

Optionally shaded (when enable_material_shading is set to true in RadarDebugViewParameters).

VELOCITY 

Color by the relative velocities.

The R, G and B values correspond respectively to the velocities in the X, Y and Z direction.

NORMAL 

Color by the normal of the surfaces converted to RGB.

◆ RadarOutputSplittingLevel

The radar output splitting level.

Enumerator
DEFAULT 

Default value. Output data is not split.

MODE 

Split by radar mode.

TRANSMITTER 

Split by transmitter.

Variable Documentation

◆ proto

import google protobuf wrappers vss::simulation::proto

Connect with Ansys