Skip to main content

AVxcelerate Sensors Simulator API 2023 R2

vss::simulation Namespace Reference

Last update: 16.07.2025

Classes

struct  AssetInfo
 Describes one asset. More...
 
struct  AutomaticBatching
 Automatic batching: the number of batches on rays and on rx channels is computed by the system, taking into account the specified constraints. More...
 
struct  CameraGroundTruthParameters
 Describes the ground truth parameters for a physics-based camera. More...
 
struct  CartesianGrid
 Cartesian grid message. More...
 
struct  Configuration
 Configuration message containing all parameters needed to load resources in AVX. 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 binary lighting system data. More...
 
struct  LightingSystemParameters
 Contains lighting system simulation parameters. More...
 
struct  LocalNodes
 The deploy parameters of the local workstation. More...
 
struct  ManualBatching
 Manual batching: the number of batches for rays and rx channels is specified by the user. 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
 The output data splitting configuration. More...
 
struct  PbCameraSimulation
 Describes the simulation parameters for a physics-based camera. More...
 
struct  PolarGrid
 Polar grid message. More...
 
struct  RadarDebugViewParameters
 Describes the parameters for the radar's debug view. More...
 
struct  RadarOutputSplitting
 The radar output data splitting configuration. More...
 
struct  RadarSimulation
 Describes the simulation parameters for a radar and the type of batching method. More...
 
struct  RecordingFormat
 Possible values for the recording output format. More...
 
struct  RenderingParameters
 Sets the rendering engine parameters for a camera. More...
 
class  ResourceUploader
 Upload Service. More...
 
struct  RxBatching
 Batching on rx channels: applies independently for each radar mode. 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
 Simulation parameters for a given sensor id. More...
 
class  Simulation
 This service provides the simulation control procedures. More...
 
struct  SimulationParameters
 Contains 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
}
 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

◆ ColorMode

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

Enumerator
BLACKWHITE 

Default value. Shade of gray by the angle of incidence between the surface and viewing direction.

COATING 

Color by the dielectric properties of the material. Optionally shaded (see enable_material_shading).

VELOCITY 

Color by the relative velocity. The RGB values correspond respectively to the velocities in XYZ direction.

NORMAL 

Color by the normal of the surface converted to RGB.

◆ Qualities

Possible values for quality factors.

Enumerator
UNDEFINED 

Undefined value (default value will apply).

LOW 

Low quality.

MEDIUM 

Medium quality.

HIGH 

High quality.

EXTREME 

Extreme quality.

◆ 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