open_simulation_interface  v3.4.0 (2021-11-18)
osi3::LogicalDetectionDataHeader Struct Reference

The header attributes of each sensor's logical detections list. More...

Collaboration diagram for osi3::LogicalDetectionDataHeader:

Public Types

enum  DataQualifier {
  DATA_QUALIFIER_UNKNOWN = 0 , DATA_QUALIFIER_OTHER = 1 , DATA_QUALIFIER_AVAILABLE = 2 , DATA_QUALIFIER_AVAILABLE_REDUCED = 3 ,
  DATA_QUALIFIER_NOT_AVAILABLE = 4 , DATA_QUALIFIER_BLINDNESS = 5 , DATA_QUALIFIER_TEMPORARY_AVAILABLE = 6 , DATA_QUALIFIER_INVALID = 7
}
 

Public Attributes

optional Timestamp logical_detection_time = 1
 
optional DataQualifier data_qualifier = 2
 
optional uint32 number_of_valid_logical_detections = 3
 
repeated Identifier sensor_id = 4
 

Detailed Description

The header attributes of each sensor's logical detections list.

Member Enumeration Documentation

◆ DataQualifier

Data qualifier communicates the overall availability of the interface.

Enumerator
DATA_QUALIFIER_UNKNOWN 

Unknown (must not be used in ground truth).

DATA_QUALIFIER_OTHER 

Other (unspecified but known).

DATA_QUALIFIER_AVAILABLE 

Data is available.

DATA_QUALIFIER_AVAILABLE_REDUCED 

Reduced data is available.

DATA_QUALIFIER_NOT_AVAILABLE 

Data is not available.

DATA_QUALIFIER_BLINDNESS 

Sensor is blind.

DATA_QUALIFIER_TEMPORARY_AVAILABLE 

Sensor temporary available.

DATA_QUALIFIER_INVALID 

Sensor invalid.

Member Data Documentation

◆ data_qualifier

optional DataQualifier osi3::LogicalDetectionDataHeader::data_qualifier = 2

Data Qualifier expresses to what extent the content of this event can be relied on.

◆ logical_detection_time

optional Timestamp osi3::LogicalDetectionDataHeader::logical_detection_time = 1

Time stamp at which the transformation and optional fusion was finished in the global synchronized time.

Note
See SensorData::timestamp and SensorData::last_measurement_time for detailed discussions on the semantics of time-related fields.

◆ number_of_valid_logical_detections

optional uint32 osi3::LogicalDetectionDataHeader::number_of_valid_logical_detections = 3

The current number of valid detections in the logical detections list.

Note
This value has to be set if the list contains invalid logical detections.

\rules is_greater_than_or_equal_to: 0 \endrules

◆ sensor_id

repeated Identifier osi3::LogicalDetectionDataHeader::sensor_id = 4

The ID(s) of the sensor(s) that produced the detections for transformation and - in case of multiple sensors - fusion into logical detections.


The documentation for this struct was generated from the following file: