Skip to content

Docu/remove note on singular plural #610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions doc/architecture/architecture_overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,16 @@ The `HostVehicleData` interface describes the measured internal states of a traf
OSI currently provides only limited support for data structures that describe measured internal states of traffic participants.
Actuator intentions are currently not covered by OSI and must be handled using a different data description format.

All fields in an interface are set to `optional`.
NOTE: OSI uses singular instead of plural for `repeated` field names.

NOTE: All fields in an interface are set to `optional`.
`required` is not used.

This has been done to allow backward-compatible changes in the field.
Additionally, this is the default behavior in Protocol Buffer version 3 that no longer has the `required` type.
Setting all fields to `optional` thus ensures update compatibility.
However, this does not mean that it is optional to fill the field.
For the purpose of providing a complete interface, all existing fields should be set, unless not setting a field carries a specific meaning, as indicated in the accompanying comment.

All field numbers equal to or greater than 10000 are available for user-specific extensions via custom fields.
NOTE: All field numbers equal to or greater than 10000 are available for user-specific extensions via custom fields.
No future evolution of OSI will therefore use field numbers equal to or greater than 10000.
4 changes: 0 additions & 4 deletions osi_datarecording.proto
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ message SensorDataSeries
{
// List of sensor data messages for subsequent time steps.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated SensorData sensor_data = 1;
}

Expand All @@ -27,7 +25,5 @@ message SensorDataSeriesList
{
// List of sensor data for multiple sensors at subsequent time steps.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated SensorDataSeries sensor = 1;
}
4 changes: 0 additions & 4 deletions osi_detectedlane.proto
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ message DetectedLane

// A list of candidates for this lane as estimated by the sensor.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated CandidateLane candidate = 2;

//
Expand Down Expand Up @@ -65,8 +63,6 @@ message DetectedLaneBoundary
// A list of candidates for this lane boundary as estimated by the
// sensor.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated CandidateLaneBoundary candidate = 2;

// The list of individual points defining the location of the lane boundary
Expand Down
8 changes: 0 additions & 8 deletions osi_detectedobject.proto
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ message DetectedItemHeader

// The ID of the original detected item in the ground truth.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated Identifier ground_truth_id = 2;

// The estimated probability that this detected item really exists, not
Expand Down Expand Up @@ -63,8 +61,6 @@ message DetectedItemHeader
// detections ( \c ...Detection::object_id = 'this detected item' ) and
// the sensors (their IDs) to which these detections belong.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated Identifier sensor_id = 6;

// Definition of measurement states.
Expand Down Expand Up @@ -116,8 +112,6 @@ message DetectedStationaryObject
// A list of candidates for this stationary object as estimated by the
// sensor.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated CandidateStationaryObject candidate = 4;

// The dominating color of the material of the structure.
Expand Down Expand Up @@ -221,8 +215,6 @@ message DetectedMovingObject
// A list of candidates for this moving object as estimated by the
// sensor (e.g. pedestrian, car).
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated CandidateMovingObject candidate = 8;

// The dominating color of the material of the moving object.
Expand Down
2 changes: 0 additions & 2 deletions osi_detectedoccupant.proto
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ message DetectedOccupant
// A list of candidates for this occupant as estimated by the
// sensor.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated CandidateOccupant candidate = 2;

//
Expand Down
2 changes: 0 additions & 2 deletions osi_detectedroadmarking.proto
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,6 @@ message DetectedRoadMarking
// A list of candidates for this road marking as estimated by the
// sensor.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated CandidateRoadMarking candidate = 4;

// The visual color of the material of the road marking.
Expand Down
2 changes: 0 additions & 2 deletions osi_detectedtrafficlight.proto
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,6 @@ message DetectedTrafficLight
// A list of candidates for this traffic light as estimated by the
// sensor.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated CandidateTrafficLight candidate = 4;

// The visual color of the traffic light.
Expand Down
2 changes: 0 additions & 2 deletions osi_detectedtrafficsign.proto
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@ message DetectedTrafficSign

// A list of additional supplementary sign(s) as detected by the sensor.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated DetectedSupplementarySign supplementary_sign = 3;

//
Expand Down
20 changes: 0 additions & 20 deletions osi_featuredata.proto
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,14 @@ message FeatureData

// Radar detections for multiple radar sensors (sensor fusion).
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated RadarDetectionData radar_sensor = 2;

// Lidar detections for multiple lidar sensors (sensor fusion).
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated LidarDetectionData lidar_sensor = 3;

// Ultrasonic detections for multiple ultrasonic sensors (sensor fusion).
//
// \note OSI uses singular instead of plural for repeated field names.
//
// \note Required for ultrasonic sensors: Detections will be send by the
// emitting ultrasonic sensor, including all indirect detections received
// by neighbouring sensors.
Expand All @@ -48,8 +42,6 @@ message FeatureData

// Camera detections for multiple camera sensors (sensor fusion).
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated CameraDetectionData camera_sensor = 5;
}

Expand Down Expand Up @@ -249,8 +241,6 @@ message RadarDetectionData

// List of radar detections constituting the radar detection list.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated RadarDetection detection = 2;
}

Expand Down Expand Up @@ -358,8 +348,6 @@ message LidarDetectionData

// List of lidar detections.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated LidarDetection detection = 2;
}

Expand Down Expand Up @@ -519,15 +507,11 @@ message UltrasonicDetectionData

// List of ultrasonic detections.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated UltrasonicDetection detection = 2;

// List of ultrasonic indirect detections (sender and receiver sensors are
// not the same).
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated UltrasonicIndirectDetection indirect_detection = 4;
}

Expand Down Expand Up @@ -676,14 +660,10 @@ message CameraDetectionData

// List of camera detections.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated CameraDetection detection = 2;

// List of points which are used by detections.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated CameraPoint point = 4;
}

Expand Down
16 changes: 0 additions & 16 deletions osi_groundtruth.proto
Original file line number Diff line number Diff line change
Expand Up @@ -75,51 +75,35 @@ message GroundTruth
// The list of stationary objects (excluding traffic signs and traffic
// lights).
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated StationaryObject stationary_object = 4;

// The list of all other moving objects including all (host) vehicles.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated MovingObject moving_object = 5;

// The list of traffic signs.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated TrafficSign traffic_sign = 6;

// The list of traffic lights.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated TrafficLight traffic_light = 7;

// The list of road surface markings (lane markings are excluded and
// defined as \c LaneBoundary).
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated RoadMarking road_marking = 8;

// The list of lane boundaries.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated LaneBoundary lane_boundary = 9;

// The list of lanes forming a road network.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated Lane lane = 10;

// The list of passengers in the (host) vehicle(s).
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated Occupant occupant = 11;

// Conditions of the environment.
Expand Down
2 changes: 0 additions & 2 deletions osi_logicaldetectiondata.proto
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@ message LogicalDetectionData
// Logical detections are given with respect to the reference frame of the logical/virtual sensor
// \c SensorView::mounting_position (e.g. center of rear axle of the ego car)
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated LogicalDetection logical_detection = 3;
}

Expand Down
2 changes: 0 additions & 2 deletions osi_object.proto
Original file line number Diff line number Diff line change
Expand Up @@ -408,8 +408,6 @@ message MovingObject
// \note Might be multiple if the object is switching lanes or moving from
// one lane into another following lane.
//
// \note OSI uses singular instead of plural for repeated field names.
//
// \note DEPRECATED: Use assigned_lane_id in MovingObjectClassification
// instead.
//
Expand Down
16 changes: 0 additions & 16 deletions osi_sensordata.proto
Original file line number Diff line number Diff line change
Expand Up @@ -198,8 +198,6 @@ message SensorData
// for reference purposes. For complex sensors or logic models this
// can be multiple copies.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated SensorView sensor_view = 8;

// The timestamp of the last real-world measurement (e.g. GT input) that
Expand All @@ -226,8 +224,6 @@ message SensorData
// The list of moving objects detected by the sensor as perceived by
// the sensor.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated DetectedMovingObject moving_object = 13;

// General information about the \c DetectedTrafficSign .
Expand All @@ -236,8 +232,6 @@ message SensorData

// The list of traffic signs detected by the sensor.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated DetectedTrafficSign traffic_sign = 15;

// General information about the \c DetectedTrafficLight .
Expand All @@ -246,8 +240,6 @@ message SensorData

// The list of traffic lights detected by the sensor.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated DetectedTrafficLight traffic_light = 17;

// General information about the \c DetectedRoadMarking .
Expand All @@ -257,8 +249,6 @@ message SensorData
// The list of road markings detected by the sensor.
// This excludes lane boundary markings.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated DetectedRoadMarking road_marking = 19;

// General information about the \c DetectedLaneBoundary .
Expand All @@ -267,8 +257,6 @@ message SensorData

// The list of lane boundary markings detected by the sensor.
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated DetectedLaneBoundary lane_boundary = 21;

// General information about the \c DetectedLane .
Expand All @@ -277,8 +265,6 @@ message SensorData

// The list of lanes detected by the sensor
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated DetectedLane lane = 23;

// General information about the \c DetectedOccupant .
Expand All @@ -287,8 +273,6 @@ message SensorData

// The list of occupants of the host vehicle
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated DetectedOccupant occupant = 25;

// Low level feature data interface.
Expand Down
14 changes: 0 additions & 14 deletions osi_sensorview.proto
Original file line number Diff line number Diff line change
Expand Up @@ -131,32 +131,22 @@ message SensorView

// Generic SensorView(s).
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated GenericSensorView generic_sensor_view = 1000;

// Radar-specific SensorView(s).
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated RadarSensorView radar_sensor_view = 1001;

// Lidar-specific SensorView(s).
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated LidarSensorView lidar_sensor_view = 1002;

// Camera-specific SensorView(s).
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated CameraSensorView camera_sensor_view = 1003;

// Ultrasonic-specific SensorView(s).
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated UltrasonicSensorView ultrasonic_sensor_view = 1004;
}

Expand Down Expand Up @@ -188,8 +178,6 @@ message RadarSensorView
// This field includes one entry for each ray, in left-to-right,
// top-to-bottom order (think of scan lines in a TV).
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated Reflection reflection = 2;

//
Expand Down Expand Up @@ -261,8 +249,6 @@ message LidarSensorView
// This field includes one entry for each ray, in left-to-right,
// top-to-bottom order (think of scan lines in a TV).
//
// \note OSI uses singular instead of plural for repeated field names.
//
repeated Reflection reflection = 2;

//
Expand Down
Loading