Namespaces
	data_access

	feedback_control

	ground_truth_access

	lighting_system_control

	sensor_data

	simulation

Classes
struct	Color
	Defines a color in RGB format. More...

struct	EulerAngles
	Euler angles. More...

struct	ObjectIdentifier
	Represents the unique identifier for a simulation object. More...

struct	PixelSegmentationMapping
	Defines a mapping table of tags and colors. More...

struct	ResourceIdentifier
	This message is used to define a unique identifier for any element in the simulation. More...

struct	Status
	The status message returned by AVX for any procedure call. More...

struct	Vector3D
	Vector in a 3D referential. More...

Enumerations
enum	CameraDataFormat { UNDEFINED_CAMERA_FORMAT = 0, RAW = 1, BMP = 2, GIF = 3, JPEG = 4, PNG = 5, TEMPERATURE_MAP = 6, SPECTRAL_IRRADIANCE_MAP = 7, CUSTOM_DATA = 8 }
	Types and formats of data produced by a camera. More...

enum	PixelFormat { UNDEFINED_PIXEL_FORMAT = 0, RGBA32 = 1, RGB24 = 3, GRAY8 = 2, FLOAT32 = 4, FLOAT64 = 5, FLOAT128 = 6 }
	Pixel format of data generated by a camera. More...

enum	LidarDataFormat { UNDEFINED_LIDAR_FORMAT = 0, POINT_CLOUD = 1, WAVEFORM = 2, CONTRIBUTIONS = 3, LENS_OUTPUT = 4 }
	Types of lidar data formats. More...

enum	RadarDataFormat { UNDEFINED_RADAR_FORMAT = 0, RADAR_OUTPUT = 1, RANGE_DOPPLER = 2, FREQUENCY_PULSE = 3, DIGITAL_SAMPLES = 4 }
	Types of radar data formats. More...

enum	OutputFormat { UNDEFINED = 0, TEXT = 1, PROTOBUF = 2 }
	Types of recording formats available for radar and lidar sensors. More...

enum	CameraGroundTruthDataFormat { UNDEFINED_GROUND_TRUTH_FORMAT = 0, DEPTH_MAP = 1, OPTICAL_FLOW = 2, PIXEL_SEGMENTATION = 3 }
	Types of recording formats available for GroundTruth data. More...

enum	StatusCode { SUCCESS = 0, UNKNOWN_FAILURE = 1 }
	List of status code values. More...

Enumeration Type Documentation

◆ CameraDataFormat

enum vss::CameraDataFormat

Types and formats of data produced by a camera.

The data types correspond to the image types (irradiance map, temperature map, etc.) and are only used to describe images stored in shared memory.

Data formats correspond to the file format of the images (bmp, gif, etc.) and are only used to write images to disk. These data formats are therefore not available for storing data in shared memory.

Enumerator
UNDEFINED_CAMERA_FORMAT	Undefined value (default value will apply).
RAW	RAW image format (default). Note Can be used for dumping images or describing images stored in shared memory.
BMP	BMP image format.
GIF	GIF image format.
JPEG	JPEG image format.
PNG	PNG image format.
TEMPERATURE_MAP	Temperature map (data type for thermal output).
SPECTRAL_IRRADIANCE_MAP	Spectral irradiance map (data type for camera lens output).
CUSTOM_DATA	Custom data (data type for custom GPU post-processing).

◆ PixelFormat

enum vss::PixelFormat

Pixel format of data generated by a camera.

This format describes the type of data stored (byte or float) as well as how the data is arranged.

Note: In addition to the usages mentioned below, each pixel format is possible for the output of a camera with custom post-processing, based on the Custom Output Format defined in the camera model.

Enumerator
UNDEFINED_PIXEL_FORMAT	Undefined value (default value will apply).
RGBA32	Rgba32 represents the sRGB format with an alpha channel and 32 bits per pixel. Each channel (red, green, blue, and alpha) is assigned 8 bits per pixel. (This is the default value.) Format used for Camera Output (Image) and Imager Output (Injection) when alpha channel is enabled in the simulation parameters.
RGB24	Rgb24 represents the sRGB format with 24 bits per pixel. Each channel (red, green, blue) is assigned 8 bits per pixel. Format used for Camera Output (Image) and Imager Output (Injection) when alpha channel is disabled in the simulation parameters, as well as for ground truth pixel segmentation output.
GRAY8	Gray8 pixel format which displays one grayscale channel with 8 bits per pixel, allowing 256 shades of gray. Format used for thermal camera image output.
FLOAT32	The Float32 pixel format represents a float channel with 32 bits per pixel. Format used for thermal camera temperature map output and ground truth depth map output.
FLOAT64	The Float64 pixel format represents 2 channels of floating point numbers* with 32 bits per pixel. Each channel is assigned 32 bits per pixel. Format used for ground truth optical flow output.
FLOAT128	The Float128 pixel format represents 4 channels of floating point numbers with 32 bits per pixel. Each channel is assigned 32 bits per pixel. Format used for Lens Output (Light).

◆ LidarDataFormat

enum vss::LidarDataFormat

Types of lidar data formats.

Enumerator
UNDEFINED_LIDAR_FORMAT	Undefined value (default value will apply).
POINT_CLOUD	Point cloud data format (default value).
WAVEFORM	Waveform data format.
CONTRIBUTIONS	Contributions data format.
LENS_OUTPUT	Lens output data format.

◆ RadarDataFormat

enum vss::RadarDataFormat

Types of radar data formats.

Enumerator
UNDEFINED_RADAR_FORMAT	Undefined value (default will apply).
RADAR_OUTPUT	Full radar output (default).
RANGE_DOPPLER	Range doppler data format.
FREQUENCY_PULSE	Frequency pulse data format.
DIGITAL_SAMPLES	Digital sample data format.

◆ OutputFormat

enum vss::OutputFormat

Types of recording formats available for radar and lidar sensors.

Enumerator
UNDEFINED	Undefined value (default will apply).
TEXT	Text format (default).
PROTOBUF	Protobuf format.

◆ CameraGroundTruthDataFormat

enum vss::CameraGroundTruthDataFormat

Types of recording formats available for GroundTruth data.

Enumerator
UNDEFINED_GROUND_TRUTH_FORMAT	Undefined value.
DEPTH_MAP	Depth map format. Represented by a byte array of 32 bits per pixel (RGBA image).
OPTICAL_FLOW	Optical flow format. Represented by a byte array of 2 x 32 bits per pixel (horizontal speed first, then vertical speed).
PIXEL_SEGMENTATION	Pixel Segmentation format. Represented by a byte array of 24 bits per pixel (RGB image).

◆ StatusCode

enum vss::StatusCode

List of status code values.

Enumerator
SUCCESS	Returned when successful.
UNKNOWN_FAILURE	Returned whenever there is an ERROR on AVX side.

AVxcelerate Sensors Simulator API 2025 R1

vss Namespace Reference

Namespaces

Classes

Enumerations