## On this page

  

 

 # vss Namespace Reference

 Last update: 14.01.2025 

## <a name="namespaces"></a>Namespaces

 [data\_access](namespacevss_1_1data__access.xhtml)  [feedback\_control](namespacevss_1_1feedback__control.xhtml)  [ground\_truth\_access](namespacevss_1_1ground__truth__access.xhtml)  [lighting\_system\_control](namespacevss_1_1lighting__system__control.xhtml)  [sensor\_data](namespacevss_1_1sensor__data.xhtml)  [simulation](namespacevss_1_1simulation.xhtml) ## <a name="nested-classes"></a>Classes

struct [Color](structvss_1_1_color.xhtml) Defines a color in RGB format. [More...](structvss_1_1_color.xhtml#details)  
 struct [EulerAngles](structvss_1_1_euler_angles.xhtml) Euler angles. [More...](structvss_1_1_euler_angles.xhtml#details)  
 struct [ObjectIdentifier](structvss_1_1_object_identifier.xhtml) Represents the unique identifier for a simulation object. [More...](structvss_1_1_object_identifier.xhtml#details)  
 struct [PixelSegmentationMapping](structvss_1_1_pixel_segmentation_mapping.xhtml) Defines a mapping table of tags and colors. [More...](structvss_1_1_pixel_segmentation_mapping.xhtml#details)  
 struct [ResourceIdentifier](structvss_1_1_resource_identifier.xhtml) This message is used to define a unique identifier for any element in the simulation. [More...](structvss_1_1_resource_identifier.xhtml#details)  
 struct [Status](structvss_1_1_status.xhtml) The status message returned by AVX for any procedure call. [More...](structvss_1_1_status.xhtml#details)  
 struct [Vector3D](structvss_1_1_vector3_d.xhtml) Vector in a 3D referential. [More...](structvss_1_1_vector3_d.xhtml#details)  
 ## <a name="enum-members"></a>Enumerations

enum [CameraDataFormat](namespacevss.xhtml#a8c661563bd9c39718be7609437c5d26d) {   
 [UNDEFINED\_CAMERA\_FORMAT](namespacevss.xhtml#a8c661563bd9c39718be7609437c5d26da773b055768d77704e6bee0075290f7a0) = 0, [RAW](namespacevss.xhtml#a8c661563bd9c39718be7609437c5d26dac67bd435283ffb113ac842e3c6562b72) = 1, [BMP](namespacevss.xhtml#a8c661563bd9c39718be7609437c5d26daee5946d753c8ebd97da668ee7d734efb) = 2, [GIF](namespacevss.xhtml#a8c661563bd9c39718be7609437c5d26daef864013b19cb7c87b1c324411fa2caa) = 3,   
 [JPEG](namespacevss.xhtml#a8c661563bd9c39718be7609437c5d26dadc0e42e8c0c75708fb9293b340ed414a) = 4, [PNG](namespacevss.xhtml#a8c661563bd9c39718be7609437c5d26da8dc5b395bd031d8254bd7d32bf7e57dc) = 5, [TEMPERATURE\_MAP](namespacevss.xhtml#a8c661563bd9c39718be7609437c5d26da8863bedc6153a0a74a1a077115f5a873) = 6, [SPECTRAL\_IRRADIANCE\_MAP](namespacevss.xhtml#a8c661563bd9c39718be7609437c5d26dae35f582da69ccd7f33bf7142713c80e1) = 7,   
 [CUSTOM\_DATA](namespacevss.xhtml#a8c661563bd9c39718be7609437c5d26da13305f1fd06fc89d8fc7527896f24592) = 8   
 } Types and formats of data produced by a camera. [More...](namespacevss.xhtml#a8c661563bd9c39718be7609437c5d26d)  
 enum [PixelFormat](namespacevss.xhtml#af6b1d8e6c244507e7c39dcd5532d2647) {   
 [UNDEFINED\_PIXEL\_FORMAT](namespacevss.xhtml#af6b1d8e6c244507e7c39dcd5532d2647a8553bbad31576dae041ecf5804c87d07) = 0, [RGBA32](namespacevss.xhtml#af6b1d8e6c244507e7c39dcd5532d2647a2b41118c2e81b90c1808cc9f9c521fd7) = 1, [RGB24](namespacevss.xhtml#af6b1d8e6c244507e7c39dcd5532d2647aa2c79adf62ea17a21d5568111da0f324) = 3, [GRAY8](namespacevss.xhtml#af6b1d8e6c244507e7c39dcd5532d2647aff0723dfc42b0df218f551cb3350389a) = 2,   
 [FLOAT32](namespacevss.xhtml#af6b1d8e6c244507e7c39dcd5532d2647a0ccaab1d9282158c57fd1e4e7ea6446d) = 4, [FLOAT64](namespacevss.xhtml#af6b1d8e6c244507e7c39dcd5532d2647a9206fef8d3af09ed70c2625ee86a92bd) = 5, [FLOAT128](namespacevss.xhtml#af6b1d8e6c244507e7c39dcd5532d2647adef81a174c25a839e17341593e5c3299) = 6   
 } Pixel format of data generated by a camera. [More...](namespacevss.xhtml#af6b1d8e6c244507e7c39dcd5532d2647)  
 enum [LidarDataFormat](namespacevss.xhtml#a70a46645d44ade7dadccebfb101468e6) {   
 [UNDEFINED\_LIDAR\_FORMAT](namespacevss.xhtml#a70a46645d44ade7dadccebfb101468e6a3b1650db2f3c4e84923b9078507b20a4) = 0, [POINT\_CLOUD](namespacevss.xhtml#a70a46645d44ade7dadccebfb101468e6ae16f23d12c2d2e145d9575ac86501f69) = 1, [WAVEFORM](namespacevss.xhtml#a70a46645d44ade7dadccebfb101468e6a827460b62b06f18641546aaf69e00307) = 2, [CONTRIBUTIONS](namespacevss.xhtml#a70a46645d44ade7dadccebfb101468e6abca43446c62cc848995a64889bf8a7ae) = 3,   
 [LENS\_OUTPUT](namespacevss.xhtml#a70a46645d44ade7dadccebfb101468e6aaa10f873662d5da0b23a0203224630e8) = 4   
 } Types of lidar data formats. [More...](namespacevss.xhtml#a70a46645d44ade7dadccebfb101468e6)  
 enum [RadarDataFormat](namespacevss.xhtml#a6dcd76e17fe62987a17ed0965225d6d5) {   
 [UNDEFINED\_RADAR\_FORMAT](namespacevss.xhtml#a6dcd76e17fe62987a17ed0965225d6d5a541eed256d0dcdb0315a543cd905f285) = 0, [RADAR\_OUTPUT](namespacevss.xhtml#a6dcd76e17fe62987a17ed0965225d6d5a72f116cf32fae04fc4f24f7ff14fe339) = 1, [RANGE\_DOPPLER](namespacevss.xhtml#a6dcd76e17fe62987a17ed0965225d6d5a923e11bf0b2a0b2b8344faf3310c0155) = 2, [FREQUENCY\_PULSE](namespacevss.xhtml#a6dcd76e17fe62987a17ed0965225d6d5a84f619386061e3863dd82dc205c4f412) = 3,   
 [DIGITAL\_SAMPLES](namespacevss.xhtml#a6dcd76e17fe62987a17ed0965225d6d5a4af66658efb011fa832aca95f8305492) = 4   
 } Types of radar data formats. [More...](namespacevss.xhtml#a6dcd76e17fe62987a17ed0965225d6d5)  
 enum [OutputFormat](namespacevss.xhtml#aabe87be3918c8806840c4dc395642d8f) { [UNDEFINED](namespacevss.xhtml#aabe87be3918c8806840c4dc395642d8fae98592f0e5ae86973280972622edf527) = 0, [TEXT](namespacevss.xhtml#aabe87be3918c8806840c4dc395642d8fa53d2011f2559e507b2e55ea66ed1cc68) = 1, [PROTOBUF](namespacevss.xhtml#aabe87be3918c8806840c4dc395642d8faafe467b27fc7e573e7aa5fcae6b1d04c) = 2 } Types of recording formats available for radar and lidar sensors. [More...](namespacevss.xhtml#aabe87be3918c8806840c4dc395642d8f)  
 enum [CameraGroundTruthDataFormat](namespacevss.xhtml#a0742651e13f35b094f40b6f32bf288b6) { [UNDEFINED\_GROUND\_TRUTH\_FORMAT](namespacevss.xhtml#a0742651e13f35b094f40b6f32bf288b6a8b17b522af1e9628976857f981ecad11) = 0, [DEPTH\_MAP](namespacevss.xhtml#a0742651e13f35b094f40b6f32bf288b6aa1d31f3146a13d14a551eac1c3f4332b) = 1, [OPTICAL\_FLOW](namespacevss.xhtml#a0742651e13f35b094f40b6f32bf288b6a46fc20bbded2422bb5fd229352023abb) = 2, [PIXEL\_SEGMENTATION](namespacevss.xhtml#a0742651e13f35b094f40b6f32bf288b6a93ab858e53c6f5abdb48cb7492eb6950) = 3 } Types of recording formats available for GroundTruth data. [More...](namespacevss.xhtml#a0742651e13f35b094f40b6f32bf288b6)  
 enum [StatusCode](namespacevss.xhtml#aae2ce55b7c4bfb86a0f5f512d92c0c18) { [SUCCESS](namespacevss.xhtml#aae2ce55b7c4bfb86a0f5f512d92c0c18aba08d9d2db620a2054432be3589b719b) = 0, [UNKNOWN\_FAILURE](namespacevss.xhtml#aae2ce55b7c4bfb86a0f5f512d92c0c18a8b1e4d10f3d7cc9ca562c6f2e25a3ea6) = 1 } List of status code values. [More...](namespacevss.xhtml#aae2ce55b7c4bfb86a0f5f512d92c0c18)  
## Enumeration Type Documentation

<a id="a8c661563bd9c39718be7609437c5d26d"></a>## [◆ ](#a8c661563bd9c39718be7609437c5d26d)CameraDataFormat

 enum [vss::CameraDataFormat](namespacevss.xhtml#a8c661563bd9c39718be7609437c5d26d)

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<a id="a8c661563bd9c39718be7609437c5d26da773b055768d77704e6bee0075290f7a0"></a>UNDEFINED\_CAMERA\_FORMAT Undefined value (default value will apply).

<a id="a8c661563bd9c39718be7609437c5d26dac67bd435283ffb113ac842e3c6562b72"></a>RAW RAW image format (default).

NoteCan be used for dumping images or describing images stored in shared memory. <a id="a8c661563bd9c39718be7609437c5d26daee5946d753c8ebd97da668ee7d734efb"></a>BMP BMP image format.

<a id="a8c661563bd9c39718be7609437c5d26daef864013b19cb7c87b1c324411fa2caa"></a>GIF GIF image format.

<a id="a8c661563bd9c39718be7609437c5d26dadc0e42e8c0c75708fb9293b340ed414a"></a>JPEG JPEG image format.

<a id="a8c661563bd9c39718be7609437c5d26da8dc5b395bd031d8254bd7d32bf7e57dc"></a>PNG PNG image format.

<a id="a8c661563bd9c39718be7609437c5d26da8863bedc6153a0a74a1a077115f5a873"></a>TEMPERATURE\_MAP Temperature map (data type for thermal output).

<a id="a8c661563bd9c39718be7609437c5d26dae35f582da69ccd7f33bf7142713c80e1"></a>SPECTRAL\_IRRADIANCE\_MAP Spectral irradiance map (data type for camera lens output).

<a id="a8c661563bd9c39718be7609437c5d26da13305f1fd06fc89d8fc7527896f24592"></a>CUSTOM\_DATA Custom data (data type for custom GPU post-processing).





<a id="af6b1d8e6c244507e7c39dcd5532d2647"></a>## [◆ ](#af6b1d8e6c244507e7c39dcd5532d2647)PixelFormat

 enum [vss::PixelFormat](namespacevss.xhtml#af6b1d8e6c244507e7c39dcd5532d2647)

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.

NoteIn 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<a id="af6b1d8e6c244507e7c39dcd5532d2647a8553bbad31576dae041ecf5804c87d07"></a>UNDEFINED\_PIXEL\_FORMAT Undefined value (default value will apply).

<a id="af6b1d8e6c244507e7c39dcd5532d2647a2b41118c2e81b90c1808cc9f9c521fd7"></a>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.

<a id="af6b1d8e6c244507e7c39dcd5532d2647aa2c79adf62ea17a21d5568111da0f324"></a>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.

<a id="af6b1d8e6c244507e7c39dcd5532d2647aff0723dfc42b0df218f551cb3350389a"></a>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.

<a id="af6b1d8e6c244507e7c39dcd5532d2647a0ccaab1d9282158c57fd1e4e7ea6446d"></a>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.

<a id="af6b1d8e6c244507e7c39dcd5532d2647a9206fef8d3af09ed70c2625ee86a92bd"></a>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.

<a id="af6b1d8e6c244507e7c39dcd5532d2647adef81a174c25a839e17341593e5c3299"></a>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).





<a id="a70a46645d44ade7dadccebfb101468e6"></a>## [◆ ](#a70a46645d44ade7dadccebfb101468e6)LidarDataFormat

 enum [vss::LidarDataFormat](namespacevss.xhtml#a70a46645d44ade7dadccebfb101468e6)

Types of lidar data formats.

Enumerator<a id="a70a46645d44ade7dadccebfb101468e6a3b1650db2f3c4e84923b9078507b20a4"></a>UNDEFINED\_LIDAR\_FORMAT Undefined value (default value will apply).

<a id="a70a46645d44ade7dadccebfb101468e6ae16f23d12c2d2e145d9575ac86501f69"></a>POINT\_CLOUD Point cloud data format (default value).

<a id="a70a46645d44ade7dadccebfb101468e6a827460b62b06f18641546aaf69e00307"></a>WAVEFORM Waveform data format.

<a id="a70a46645d44ade7dadccebfb101468e6abca43446c62cc848995a64889bf8a7ae"></a>CONTRIBUTIONS Contributions data format.

<a id="a70a46645d44ade7dadccebfb101468e6aaa10f873662d5da0b23a0203224630e8"></a>LENS\_OUTPUT Lens output data format.





<a id="a6dcd76e17fe62987a17ed0965225d6d5"></a>## [◆ ](#a6dcd76e17fe62987a17ed0965225d6d5)RadarDataFormat

 enum [vss::RadarDataFormat](namespacevss.xhtml#a6dcd76e17fe62987a17ed0965225d6d5)

Types of radar data formats.

Enumerator<a id="a6dcd76e17fe62987a17ed0965225d6d5a541eed256d0dcdb0315a543cd905f285"></a>UNDEFINED\_RADAR\_FORMAT Undefined value (default will apply).

<a id="a6dcd76e17fe62987a17ed0965225d6d5a72f116cf32fae04fc4f24f7ff14fe339"></a>RADAR\_OUTPUT Full radar output (default).

<a id="a6dcd76e17fe62987a17ed0965225d6d5a923e11bf0b2a0b2b8344faf3310c0155"></a>RANGE\_DOPPLER Range doppler data format.

<a id="a6dcd76e17fe62987a17ed0965225d6d5a84f619386061e3863dd82dc205c4f412"></a>FREQUENCY\_PULSE Frequency pulse data format.

<a id="a6dcd76e17fe62987a17ed0965225d6d5a4af66658efb011fa832aca95f8305492"></a>DIGITAL\_SAMPLES Digital sample data format.





<a id="aabe87be3918c8806840c4dc395642d8f"></a>## [◆ ](#aabe87be3918c8806840c4dc395642d8f)OutputFormat

 enum [vss::OutputFormat](namespacevss.xhtml#aabe87be3918c8806840c4dc395642d8f)

Types of recording formats available for radar and lidar sensors.

Enumerator<a id="aabe87be3918c8806840c4dc395642d8fae98592f0e5ae86973280972622edf527"></a>UNDEFINED Undefined value (default will apply).

<a id="aabe87be3918c8806840c4dc395642d8fa53d2011f2559e507b2e55ea66ed1cc68"></a>TEXT Text format (default).

<a id="aabe87be3918c8806840c4dc395642d8faafe467b27fc7e573e7aa5fcae6b1d04c"></a>PROTOBUF Protobuf format.





<a id="a0742651e13f35b094f40b6f32bf288b6"></a>## [◆ ](#a0742651e13f35b094f40b6f32bf288b6)CameraGroundTruthDataFormat

 enum [vss::CameraGroundTruthDataFormat](namespacevss.xhtml#a0742651e13f35b094f40b6f32bf288b6)

Types of recording formats available for GroundTruth data.

Enumerator<a id="a0742651e13f35b094f40b6f32bf288b6a8b17b522af1e9628976857f981ecad11"></a>UNDEFINED\_GROUND\_TRUTH\_FORMAT Undefined value.

<a id="a0742651e13f35b094f40b6f32bf288b6aa1d31f3146a13d14a551eac1c3f4332b"></a>DEPTH\_MAP Depth map format. Represented by a byte array of 32 bits per pixel (RGBA image).

<a id="a0742651e13f35b094f40b6f32bf288b6a46fc20bbded2422bb5fd229352023abb"></a>OPTICAL\_FLOW Optical flow format. Represented by a byte array of 2 x 32 bits per pixel (horizontal speed first, then vertical speed).

<a id="a0742651e13f35b094f40b6f32bf288b6a93ab858e53c6f5abdb48cb7492eb6950"></a>PIXEL\_SEGMENTATION Pixel Segmentation format. Represented by a byte array of 24 bits per pixel (RGB image).





<a id="aae2ce55b7c4bfb86a0f5f512d92c0c18"></a>## [◆ ](#aae2ce55b7c4bfb86a0f5f512d92c0c18)StatusCode

 enum [vss::StatusCode](namespacevss.xhtml#aae2ce55b7c4bfb86a0f5f512d92c0c18)

List of status code values.

Enumerator<a id="aae2ce55b7c4bfb86a0f5f512d92c0c18aba08d9d2db620a2054432be3589b719b"></a>SUCCESS Returned when successful.

<a id="aae2ce55b7c4bfb86a0f5f512d92c0c18a8b1e4d10f3d7cc9ca562c6f2e25a3ea6"></a>UNKNOWN\_FAILURE Returned whenever there is an ERROR on AVX side.