Add requirements to readme and add rules accordingly

Signed-off-by: ClemensLinnhoff <[email protected]>

README.md

@@ -34,24 +34,28 @@ The detection of moving objects, stationary objects, traffic signs and traffic l
 
 ### Input: Required Fields in OSI3::SensorView
 
-- `sensor_view.mounting_position`
-- `sensor_view.global_ground_truth.timestamp`
-- `sensor_view.global_ground_truth.host_vehicle_id`
-- `sensor_view.global_ground_truth.stationary_object.id`
-- `sensor_view.global_ground_truth.stationary_object.base.position`
-- `sensor_view.global_ground_truth.stationary_object.base.orientation`
-- `sensor_view.global_ground_truth.stationary_object.base.dimension`
+| OSI Message                                                      | Required / Optional |
+|------------------------------------------------------------------|---------------------|
+| `sensor_view.mounting_position`                                  | required            |
+| `sensor_view.global_ground_truth.timestamp`                      | required            |
+| `sensor_view.global_ground_truth.host_vehicle_id`                | required            |
+| `sensor_view.global_ground_truth.moving_object.id`               | required            |
+| `sensor_view.global_ground_truth.moving_object.base.position`    | required            |
+| `sensor_view.global_ground_truth.moving_object.base.orientation` | required            |
+| `sensor_view.global_ground_truth.moving_object.base.dimension`   | required            |
 
 ### Output: Fields in OSI3::SensorData Filled by the Sensor Model
 
-- `sensor_data.timestamp`
-- `sensor_data.moving_object.header.ground_truth_id`
-- `sensor_data.moving_object.header.tracking_id`
-- `sensor_data.moving_object.header.existence_probability`
-- `sensor_data.moving_object.header.measurement_state`
-- `sensor_data.moving_object.header.sensor_id`
-- `sensor_data.moving_object.base.position`
-- `sensor_data.moving_object.base.dimension`
+| OSI Message                                              | Required / Optional |
+|----------------------------------------------------------|---------------------|
+| `sensor_data.timestamp`                                  | required            |
+| `sensor_data.moving_object.header.ground_truth_id`       | required            |
+| `sensor_data.moving_object.header.tracking_id`           | required            |
+| `sensor_data.moving_object.header.existence_probability` | required            |
+| `sensor_data.moving_object.header.measurement_state`     | required            |
+| `sensor_data.moving_object.header.sensor_id`             | required            |
+| `sensor_data.moving_object.base.position`                | required            |
+| `sensor_data.moving_object.base.dimension`               | required            |
 
 ## Build Instructions
 

rules/input_rules/osi_common.yml

@@ -0,0 +1,131 @@
+Vector3d:
+  x:
+  y:
+  z:
+Vector2d:
+  x:
+  y:
+Timestamp:
+  seconds:
+    - is_greater_than_or_equal_to: 0
+  nanos:
+    - is_greater_than_or_equal_to: 0
+    - is_less_than_or_equal_to: 999999999
+Dimension3d:
+  length:
+    - is_greater_than_or_equal_to: 0
+  width:
+    - is_greater_than_or_equal_to: 0
+  height:
+    - is_greater_than_or_equal_to: 0
+Orientation3d:
+  roll:
+  pitch:
+  yaw:
+Identifier:
+  value:
+    - is_greater_than_or_equal_to: 0
+ExternalReference:
+  reference:
+  type:
+    - is_set:
+  identifier:
+MountingPosition:
+  position:
+  orientation:
+Spherical3d:
+  distance:
+    - is_greater_than_or_equal_to: 0
+  azimuth:
+  elevation:
+LogicalLaneAssignment:
+  assigned_lane_id:
+    - refers_to: LogicalLane
+  s_position:
+  t_position:
+  angle_to_lane:
+BoundingBox:
+  dimension:
+  position:
+  orientation:
+  contained_object_type:
+  model_reference:
+BaseStationary:
+  dimension:
+  position:
+  orientation:
+  base_polygon:
+  bounding_box_section:
+BaseMoving:
+  dimension:
+    - is_set:
+  position:
+    - is_set:
+  orientation:
+    - is_set:
+  velocity:
+  acceleration:
+  orientation_rate:
+  orientation_acceleration:
+  base_polygon:
+  bounding_box_section:
+StatePoint:
+  timestamp:
+  position:
+  orientation:
+WavelengthData:
+  start:
+  end:
+  samples_number:
+SpatialSignalStrength:
+  horizontal_angle:
+  vertical_angle:
+  signal_strength:
+ColorDescription:
+  grey:
+  rgb:
+  rgbir:
+  hsv:
+  luv:
+  cmyk:
+ColorGrey:
+  grey:
+ColorRGB:
+  red:
+  green:
+  blue:
+ColorRGBIR:
+  red:
+  green:
+  blue:
+  infrared:
+ColorHSV:
+  hue:
+  saturation:
+  value:
+ColorLUV:
+  luminance:
+  u:
+  v:
+ColorCMYK:
+  cyan:
+  magenta:
+  yellow:
+  key:
+Pedalry:
+  pedal_position_acceleration:
+  pedal_position_brake:
+  pedal_position_clutch:
+VehicleSteeringWheel:
+  angle:
+  angular_speed:
+  torque:
+GeodeticPosition:
+  longitude:
+  latitude:
+  altitude:
+KeyValuePair:
+  key:
+  value:
+Polygon3d:
+  vertex:

rules/input_rules/osi_datarecording.yml

@@ -0,0 +1,4 @@
+SensorDataSeries:
+  sensor_data:
+SensorDataSeriesList:
+  sensor:

rules/input_rules/osi_detectedlane.yml

@@ -0,0 +1,22 @@
+DetectedLane:
+  header:
+  candidate:
+  CandidateLane:
+    probability:
+      - is_less_than_or_equal_to: 1
+      - is_greater_than_or_equal_to: 0
+    classification:
+DetectedLaneBoundary:
+  header:
+  candidate:
+  boundary_line:
+  boundary_line_rmse:
+  boundary_line_confidences:
+    - is_greater_than_or_equal_to: 0
+    - is_less_than_or_equal_to: 1
+  color_description:
+  CandidateLaneBoundary:
+    probability:
+      - is_greater_than_or_equal_to: 0
+      - is_less_than_or_equal_to: 1
+    classification:

rules/input_rules/osi_detectedobject.yml

@@ -0,0 +1,66 @@
+DetectedItemHeader:
+  tracking_id:
+    - is_set:
+  ground_truth_id:
+  existence_probability:
+    - is_greater_than_or_equal_to: 0
+    - is_less_than_or_equal_to: 1
+  age:
+  measurement_state:
+  sensor_id:
+DetectedStationaryObject:
+  header:
+  base:
+  base_rmse:
+  candidate:
+  color_description:
+  radar_specifics:
+  lidar_specifics:
+  camera_specifics:
+  ultrasonic_specifics:
+  CandidateStationaryObject:
+    probability:
+      - is_greater_than_or_equal_to: 0
+      - is_less_than_or_equal_to: 1
+    classification:
+DetectedMovingObject:
+  header:
+  base:
+  base_rmse:
+  reference_point:
+  movement_state:
+  percentage_side_lane_left:
+    - is_greater_than_or_equal_to: 0
+    - is_less_than_or_equal_to: 100
+  percentage_side_lane_right:
+    - is_greater_than_or_equal_to: 0
+    - is_less_than_or_equal_to: 100
+  candidate:
+  color_description:
+  radar_specifics:
+  lidar_specifics:
+  camera_specifics:
+  ultrasonic_specifics:
+  CandidateMovingObject:
+    probability:
+      - is_greater_than_or_equal_to: 0
+      - is_less_than_or_equal_to: 1
+    type:
+    vehicle_classification:
+      - check_if:
+        - is_equal_to: 2
+          target: this.type
+        do_check:
+        - is_set:
+    head_pose:
+      - check_if:
+        - is_equal_to: 3
+          target: this.type
+        do_check:
+        - is_set:
+    upper_body_pose:
+      - check_if:
+        - is_equal_to: 3
+          target: this.type
+        do_check:
+        - is_set:

rules/input_rules/osi_detectedoccupant.yml

@@ -0,0 +1,8 @@
+DetectedOccupant:
+  header:
+  candidate:
+  CandidateOccupant:
+    probability:
+      - is_greater_than_or_equal_to: 0
+      - is_less_than_or_equal_to: 1
+    classification:

rules/input_rules/osi_detectedroadmarking.yml

@@ -0,0 +1,11 @@
+DetectedRoadMarking:
+  header:
+  base:
+  base_rmse:
+  candidate:
+  color_description:
+  CandidateRoadMarking:
+    probability:
+      - is_less_than_or_equal_to: 1
+      - is_greater_than_or_equal_to: 0
+    classification:

rules/input_rules/osi_detectedtrafficlight.yml

@@ -0,0 +1,11 @@
+DetectedTrafficLight:
+  header:
+  base:
+  base_rmse:
+  candidate:
+  color_description:
+  CandidateTrafficLight:
+    probability:
+      - is_less_than_or_equal_to: 1
+      - is_greater_than_or_equal_to: 0
+    classification:

rules/input_rules/osi_detectedtrafficsign.yml

@@ -0,0 +1,23 @@
+DetectedTrafficSign:
+  header:
+  main_sign:
+  supplementary_sign:
+  DetectedMainSign:
+    candidate:
+    base:
+    base_rmse:
+    geometry:
+    CandidateMainSign:
+      probability:
+        - is_less_than_or_equal_to: 1
+        - is_greater_than_or_equal_to: 0
+      classification:
+  DetectedSupplementarySign:
+    candidate:
+    base:
+    base_rmse:
+    CandidateSupplementarySign:
+      probability:
+        - is_less_than_or_equal_to: 1
+        - is_greater_than_or_equal_to: 0
+      classification:

rules/input_rules/osi_environment.yml

@@ -0,0 +1,34 @@
+EnvironmentalConditions:
+  ambient_illumination:
+  time_of_day:
+  unix_timestamp:
+  atmospheric_pressure:
+    - is_greater_than_or_equal_to: 80000
+    - is_less_than_or_equal_to: 120000
+  temperature:
+    - is_greater_than_or_equal_to: 170
+    - is_less_than_or_equal_to: 340
+  relative_humidity:
+    - is_greater_than_or_equal_to: 0
+    - is_less_than_or_equal_to: 100
+  precipitation:
+  fog:
+  source_reference:
+  clouds:
+  wind:
+  sun:
+  TimeOfDay:
+    seconds_since_midnight:
+      - is_greater_than_or_equal_to: 0
+      - is_less_than: 86400
+  CloudLayer:
+    fractional_cloud_cover:
+  Wind:
+    origin_direction:
+    speed:
+      - is_greater_than_or_equal_to: 0
+  Sun:
+    azimuth:
+    elevation:
+    intensity:
+      - is_greater_than_or_equal_to: 0