osi_detectedobject.proto

syntax = "proto2";

option optimize_for = SPEED;

import "osi_common.proto";
import "osi_object.proto";
import "osi_sensorspecific.proto";

package osi3;

//
// \brief The common information for a detected item as estimated by the
// sensor.
//
message DetectedItemHeader
{
    // Specific ID of the detected item as assigned by the sensor internally.
    // Needs not to match with \c #ground_truth_id.
    //
    // \rules
    // is_set
    // \endrules
    //
    optional Identifier tracking_id = 1;

    // The ID of the original detected item in the ground truth.
    //
    repeated Identifier ground_truth_id = 2;

    // The estimated probability that this detected item really exists, not
    // based on history.
    //
    // \note Use as confidence measure where a low value means less confidence
    // and a high value indicates strong confidence.
    //
    // \rules
    // is_greater_than_or_equal_to: 0
    // is_less_than_or_equal_to: 1
    // \endrules
    //
    optional double existence_probability = 3;

    // The amount of time that this detected object has been continuously
    // observed/tracked.
    //
    // \note
    // \f$ Timestamp - Age := \f$ 'point in time' when the object has
    // been observed for the first time.
    //
    // Unit: s
    //
    optional double age = 4;

    // The measurement state.
    //
    optional MeasurementState measurement_state = 5;

    // A list of physical sensors which detected this detected item.
    //
    // If \c SensorData has detected entities and all detections are missing,
    // then e.g. the number of sensors can confirm the
    // \c #existence_probability.
    //
    // \note This information can be determined via the detected entities'
    // detections ( \c ...Detection::object_id = 'this detected item' ) and
    // the sensors (their IDs) to which these detections belong.
    //
    repeated Identifier sensor_id = 6;

    // Definition of measurement states.
    //
    enum MeasurementState
    {
        // Measurement state is unknown (must not be used in ground truth).
        //
        MEASUREMENT_STATE_UNKNOWN = 0;

        // Measurement state is unspecified (but known, i.e. value is not part
        // of this enum list).
        //
        MEASUREMENT_STATE_OTHER = 1;

        // Entity has been measured by the sensor in the current time step.
        //
        MEASUREMENT_STATE_MEASURED = 2;

        // Entity has not been measured by the sensor in the current time step.
        // Values provided by tracking only.
        //
        MEASUREMENT_STATE_PREDICTED = 3;
    }
}

//
// \brief A stationary object (e.g. landmark) in the environment as detected by
// the sensor.
//
// \image html OSI_DetectedStationaryObject.svg
//
// The parent frame of a detected stationary object is the virtual sensor
// coordinate system.
//
// /note The virtual sensor coordinate system is relative to the vehicle coordinate
// system which has its origin in the center of the rear axle of the ego
// vehicle. This means if virtual sensor mounting position and orientation are
// set to (0,0,0) the virtual sensor coordinate system coincides with the
// vehicle coordinate system.
//
message DetectedStationaryObject
{
    // Common information of one detected item.
    //
    optional DetectedItemHeader header = 1;

    // The base parameters of the stationary object.
    //
    optional BaseStationary base = 2;

    // The root mean squared error of the base parameters of the detected
    // stationary object (e.g. landmark). \c StationaryObject::base has to be
    // identical for all \c #candidate stationary objects.
    //
    optional BaseStationary base_rmse = 3;

    // A list of candidates for this stationary object as estimated by the
    // sensor.
    //
    repeated CandidateStationaryObject candidate = 4;

    // The dominating color of the material of the structure.
    //
    optional ColorDescription color_description = 5;

    // Additional data that is specific to radar sensors.
    //
    // \note Field needs not to be set if simulated sensor is not a radar
    // sensor.
    //
    optional RadarSpecificObjectData radar_specifics = 100;

    // Additional data that is specific to lidar sensors.
    //
    // \note Field needs not to be set if simulated sensor is not a lidar
    // sensor.
    //
    optional LidarSpecificObjectData lidar_specifics = 101;

    // Additional data that is specific to camera sensors.
    //
    // \note Field needs not to be set if simulated sensor is not a camera
    // sensor.
    //
    optional CameraSpecificObjectData camera_specifics = 102;

    // Additional data that is specific to ultrasonic sensors.
    //
    // \note Field needs not to be set if simulated sensor is not an ultrasonic
    // sensor.
    //
    optional UltrasonicSpecificObjectData ultrasonic_specifics = 103;

    //
    // \brief A candidate for a detected stationary object as estimated
    // by the sensor.
    //
    message CandidateStationaryObject
    {
        // The estimated probability that this candidate is the true value.
        //
        // \note The sum of all \c #probability must be one. This probability is
        // given under the condition of
        // \c DetectedItemHeader::existence_probability.
        //
        // \rules
        // is_greater_than_or_equal_to: 0
        // is_less_than_or_equal_to: 1
        // \endrules
        //
        optional double probability = 1;

        // The classification of the stationary object (e.g. landmark).
        //
        optional StationaryObject.Classification classification = 2;
    }
}

//
// \brief Moving object in the environment as detected and perceived by the
// sensor.
//
// The parent frame of a detected moving object is the virtual sensor coordinate
// system.
//
// /note The virtual sensor coordinate system is relative to the vehicle coordinate
// system which has its origin in the center of the rear axle of the ego
// vehicle. This means if virtual sensor mounting position and orientation are
// set to (0,0,0) the virtual sensor coordinate system coincides with the
// vehicle coordinate system.
//
message DetectedMovingObject
{
    // Common information of one detected item.
    //
    optional DetectedItemHeader header = 1;

    // The base parameters of the moving object.
    //
    // \note The bounding box does NOT include mirrors for vehicles.
    // \note The height includes the ground_clearance. It always goes from the
    // top to the ground.
    //
    optional BaseMoving base = 2;

    // The root mean squared error of the base parameters of the detected
    // moving object (e.g. car). \c MovingObject::base has to be
    // identical for all \c #candidate moving objects.
    //
    optional BaseMoving base_rmse = 3;

    // Reference point location specification of the sensor measurement
    // (required to decouple sensor measurement, position and bounding box
    // estimation) as used by the sensor (model).
    //
    // \note Note that the value of this field has no impact on the value of
    // object::position, which always references the center of the object /
    // bounding box.
    //
    optional ReferencePoint reference_point = 4;

    // Actual movement state w.r.t. the moving object history.
    //
    optional MovementState movement_state = 5;

    // Percentage side lane left.
    //
    // Percentage value of the object width in the corresponding lane.
    //
    // \note DEPRECATED: Use assigned_lane_percentage in MovingObjectClassification
    // instead.
    //
    // \rules
    // is_greater_than_or_equal_to: 0
    // is_less_than_or_equal_to: 100
    // \endrules
    //
    optional double percentage_side_lane_left = 6;

    // Percentage side lane right.
    //
    // Percentage value of the object width in the corresponding lane.
    //
    // \note DEPRECATED: Use assigned_lane_percentage in MovingObjectClassification
    // instead.
    //
    // \rules
    // is_greater_than_or_equal_to: 0
    // is_less_than_or_equal_to: 100
    // \endrules
    //
    optional double percentage_side_lane_right = 7;

    // A list of candidates for this moving object as estimated by the
    // sensor (e.g. pedestrian, car).
    //
    repeated CandidateMovingObject candidate = 8;

    // The dominating color of the material of the moving object.
    //
    optional ColorDescription color_description = 9;

    // Additional data that is specific to radar sensors.
    //
    // \note Field needs not to be set if simulated sensor is not a radar
    // sensor.
    //
    optional RadarSpecificObjectData radar_specifics = 100;

    // Additional data that is specific to lidar sensors.
    //
    // \note Field needs not to be set if simulated sensor is not a lidar
    // sensor.
    //
    optional LidarSpecificObjectData lidar_specifics = 101;

    // Additional data that is specific to camera sensors.
    //
    // \note Field needs not to be set if simulated sensor is not a camera
    // sensor.
    //
    optional CameraSpecificObjectData camera_specifics = 102;

    // Additional data that is specific to ultrasonic sensors.
    //
    // \note Field needs not to be set if simulated sensor is not an ultrasonic
    // sensor.
    //
    optional UltrasonicSpecificObjectData ultrasonic_specifics = 103;

    //
    // \brief A candidate for a detected moving object as estimated by the
    // sensor.
    //
    message CandidateMovingObject
    {
        // The estimated probability that this candidate is the true value.
        //
        // \note The sum of all \c #probability must be one. This probability is
        // given under the condition of
        // \c DetectedItemHeader::existence_probability.
        //
        // \rules
        // is_greater_than_or_equal_to: 0
        // is_less_than_or_equal_to: 1
        // \endrules
        //
        optional double probability = 1;

        // The description of the moving object (e.g. car).
        //
        optional MovingObject.Type type = 2;

        // Specific information about the classification of the vehicle.
        //
        //
        // \note This field is mandatory if the \c CandidateMovingObject::type
        // is \c MovingObject::TYPE_VEHICLE .
        //
        // \rules
        // check_if this.type is_equal_to 2 else do_check is_set
        // \endrules
        //
        optional MovingObject.VehicleClassification vehicle_classification = 3;

        // Pedestrian head pose for behavior prediction. Describes the head
        // orientation w.r.t. the host vehicle orientation.
        // The x-axis of the right-handed head frame is pointing along the
        // pedestrian's straight ahead viewing direction (anterior), the y-axis lateral to the left,
        // and the z-axis is pointing upwards (superior) [1].
        //
        // ``View_normal_base_coord_system =
        // Inverse_Rotation(#head_pose)*Unit_vector_x``
        //
        // \note This field is mandatory if the \c CandidateMovingObject.type is
        // \c MovingObject::TYPE_PEDESTRIAN
        //
        // \rules
        // check_if this.type is_equal_to 3 else do_check is_set
        // \endrules
        //
        // \par Reference:
        //
        // [1] Patton, K. T. & Thibodeau, G. A. (2015). <em>Anatomy & Physiology</em>. 9th Edition. Elsevier. Missouri, U.S.A. ISBN 978-0-323-34139-4. p. 1229.
        //
        optional Orientation3d head_pose = 4;

        // Pedestrian upper body pose for behavior prediction. Describes the
        // upper body orientation w.r.t. the host vehicle orientation.
        // The x-axis of the right-handed upper body frame is pointing along the
        // pedestrian's upper body ventral (anterior) direction (i.e. usually
        // pedestrian's intended moving direction), the y-axis lateral to the left,
        // and the z-axis is pointing upwards (superior, to the pedestrian's head) [1].
        //
        // ``View_normal_base_coord_system =
        // Inverse_Rotation(#upper_body_pose)*Unit_vector_x``
        //
        // \note This field is mandatory if the \c CandidateMovingObject::type
        // is \c MovingObject::TYPE_PEDESTRIAN
        //
        // \rules
        // check_if this.type is_equal_to 3 else do_check is_set
        // \endrules
        //
        // \par Reference:
        // [1] Patton, K. T. & Thibodeau, G. A. (2015). <em>Anatomy & Physiology</em>. 9th Edition. Elsevier. Missouri, U.S.A. ISBN 978-0-323-34139-4. p. 1229.
        //
        optional Orientation3d upper_body_pose = 5;

        // Specific information about the classification of a moving object.
        //
        optional MovingObject.MovingObjectClassification moving_object_classification = 6;        
    }

    // Definition of available reference points. Left/middle/right and
    // front/middle/rear indicate the position in y- and x-direction
    // respectively. The z position is always considered as middle.
    //
    enum ReferencePoint
    {
        // Reference point is unknown, i.e. sensor does not report a reference
        // point for the position coordinate.
        // Value must not be used in ground truth data.
        // Usually this means that the reference point for the given position
        // coordinates is a largely arbitrary point within the bounding volume
        // unknown to the sensor. If this value is set, the center of the
        // bounding box should be used as reference point by convention, unless
        // the specific use case requires otherwise.
        //
        REFERENCE_POINT_UNKNOWN = 0;

        // Other (unspecified but known) reference point.
        //
        REFERENCE_POINT_OTHER = 1;

        // Center of the bounding box.
        //
        REFERENCE_POINT_CENTER = 2;

        // Middle-Left of the bounding box.
        //
        REFERENCE_POINT_MIDDLE_LEFT = 3;

        // Middle-Right of the bounding box.
        //
        REFERENCE_POINT_MIDDLE_RIGHT = 4;

        // Rear-Middle of the bounding box.
        //
        REFERENCE_POINT_REAR_MIDDLE = 5;

        // Rear-Left of the bounding box.
        //
        REFERENCE_POINT_REAR_LEFT = 6;

        // Rear-Right of the bounding box.
        //
        REFERENCE_POINT_REAR_RIGHT = 7;

        // Front-Middle of the bounding box.
        //
        REFERENCE_POINT_FRONT_MIDDLE = 8;

        // Front-Left of the bounding box.
        //
        REFERENCE_POINT_FRONT_LEFT = 9;

        // Front-Right of the bounding box.
        //
        REFERENCE_POINT_FRONT_RIGHT = 10;
    }

    // Information about a possible movement of the object during tracking.
    //
    enum MovementState
    {
        // Movement state is unknown.
        //
        MOVEMENT_STATE_UNKNOWN = 0;

        // Other (unspecified but known).
        //
        MOVEMENT_STATE_OTHER = 1;

        // Until now no object movement was detected in tracking history.
        //
        MOVEMENT_STATE_STATIONARY = 2;

        // Object moves currently.
        //
        MOVEMENT_STATE_MOVING = 3;

        // Object movement was detected in tracking history, but object is
        // currently not moving.
        //
        MOVEMENT_STATE_STOPPED = 4;
    }
}