diff --git a/README.md b/README.md index 559040129..fba3d70f9 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ In this context, OSI defines generic interfaces to ensure modularity, integrabil For more information on OSI see the [official documentation](https://opensimulationinterface.github.io/osi-documentation/) or the [official reference documentation](https://opensimulationinterface.github.io/open-simulation-interface/) for defined protobuf messages. -[[1]](https://www.hot.ei.tum.de/forschung/automotive-veroeffentlichungen/) *A generic interface for the environment perception of automated driving functions in virtual scenarios.(Dated 03.02.2017) T. Hanke, N. Hirsenkorn, C. van-Driesten, P. Garcia-Ramos, M. Schiementz, S. Schneider, E. Biebl* +[1] Hanke, T., Hirsenkorn, N., van-Driesten, C., Garcia-Ramos, P., Schiementz, M., Schneider, S. & Biebl, E. (2017, February 03). *A generic interface for the environment perception of automated driving functions in virtual scenarios.* Retrieved January 25, 2020, from https://www.hot.ei.tum.de/forschung/automotive-veroeffentlichungen/ ## Usage ##### Example of writing and reading an OSI message in `Python` diff --git a/doc/commenting.rst b/doc/commenting.rst index d08f3b998..cb1ec68a9 100644 --- a/doc/commenting.rst +++ b/doc/commenting.rst @@ -7,9 +7,8 @@ During the building process of open simulation interface (using the `proto2cpp < For any additional comment styles see `list `_ of doxygen commands. -Reference for writing values and units: ISO 80000-1: 2009, Quantities and units – Part 1: General -Nice summary: [Rohde & Schwarz: Der korrekte Umgang mit Größen, Einheiten und Gleichungen ](https://karriere.rohde-schwarz.de/fileadmin/customer/downloads/PDF/Der_korrekte_Umgang_mit_Groessen_Einheiten_und_Gleichungen_bro_de_01.pdf -) +Reference for writing values and units: ISO 80000-1:2013-08, Quantities and units – Part 1: General +Nice summary in German: `Rohde & Schwarz: Der korrekte Umgang mit Groessen, Einheiten und Gleichungen `_ Commenting with block syntax @@ -150,7 +149,7 @@ Then you describe the field by adding an explanation. // message EnvironmentalConditions { - // Atmospheric pressure in Pascal at z=0.0 in world frame (about 101325 Pa). + // Atmospheric pressure in Pascal at z = 0.0 m in world frame (about 101325 Pa). // optional double atmospheric_pressure = 1; } @@ -169,7 +168,7 @@ Next you decide the unit of the field. // message EnvironmentalConditions { - // Atmospheric pressure in Pascal at z=0.0 in world frame (about 101325 Pa). + // Atmospheric pressure in Pascal at z = 0.0 m in world frame (about 101325 Pa). // // Unit: Pa // @@ -190,7 +189,7 @@ You can optionally add a note to the field to describe the field better. // message EnvironmentalConditions { - // Atmospheric pressure in Pascal at z=0.0 in world frame (about 101325 Pa). + // Atmospheric pressure in Pascal at z = 0.0 m in world frame (about 101325 Pa). // // Unit: Pa // @@ -199,7 +198,32 @@ You can optionally add a note to the field to describe the field better. optional double atmospheric_pressure = 1; } -If you want to provide a reference to a DIN or to web page which helps in understanding the field you can add a reference. +To help understanding the field, you should add a reference. +Every OSI message should be defined properly and should have a well cited reference. + +**Citation style for different sources:** + +- Within the text, the number system is used with the number of the source in brackets [#] for mentioning. +- We use the so called `"APA style" `_ from the American Psychological Association for referencing. +- In the references list, the number in brackets [#] is followed by a full citation. +- For writing the title in italic, use title. +- If the list contains more than one entry, add " \n " at the end of the line to create a line break within the list. +- Author names are written as , like Authorname, A. A. +- Editor names are written as like B. B. Editorname. +- Naming pages at the end is optional to enable finding in long texts or for direct citations. +- All citations should be primary citations. Sources like Wikipedia et al. are not allowed. +- Find filled-out examples under `https://apastyle.apa.org `_ and in existing entries. +- The scheme of popular sources for the reference list is as follows (replace tags with corresponding values): + +.. [#] , , & . (). Contribution in a compilation title. . . . . . . . +.. [#] , & . (). . . . . . +.. [#] & . (). . In & (Eds.), (). . . . +.. [#] & . (). . . . . . . +.. [#] . (). . Phd. thesis. . . . . +.. [#] . (, ). . Retrieved , , from . +.. [#] . (). </em>. (<standard identifier>). <location>. +.. [#] <author>. (<year>). <em><patent title and id></em>. <location>. <organisation>. + .. code-block:: protobuf @@ -213,14 +237,15 @@ If you want to provide a reference to a DIN or to web page which helps in unders // message EnvironmentalConditions { - // Atmospheric pressure in Pascal at z=0.0 in world frame (about 101325 Pa). + // Atmospheric pressure in Pascal at z = 0.0 m in world frame (about 101325 Pa) [1, 2]. // // Unit: Pa // // \note 100000 Pa = 1 bar // - // \par Reference: - // - [1] [Definition atmospheric pressure](https://en.wikipedia.org/wiki/Atmospheric_pressure) + // \par References: + // [1] DIN Deutsches Institut fuer Normung e. V. (1982). <em>DIN 5031-3 Strahlungsphysik im optischen Bereich und Lichttechnik - Groessen, Formelzeichen und Einheiten der Lichttechnik</em>. (DIN 5031-3:1982-03). Berlin, Germany. \n + // [2] Rapp, C. (2017). Grundlagen der Physik. In <em>Hydraulik fuer Ingenieure und Naturwissenschaftler</em> (pp.23-36). Springer Vieweg. Wiesbaden, Germany. https://doi.org/10.1007/978-3-658-18619-7_3. p. 105. // optional double atmospheric_pressure = 1; } @@ -239,14 +264,15 @@ Finally you can provide a set of rules which this field needs to be followed. Th // message EnvironmentalConditions { - // Atmospheric pressure in Pascal at z=0.0 in world frame (about 101325 Pa). + // Atmospheric pressure in Pascal at z = 0.0 m in world frame (about 101325 Pa) [1, 2]. // // Unit: Pa // // \note 100000 Pa = 1 bar // - // \par Reference: - // - [1] [Definition atmospheric pressure](https://en.wikipedia.org/wiki/Atmospheric_pressure) + // \par References: + // [1] DIN Deutsches Institut fuer Normung e. V. (1982). <em>DIN 5031-3 Strahlungsphysik im optischen Bereich und Lichttechnik - Groessen, Formelzeichen und Einheiten der Lichttechnik</em>. (DIN 5031-3:1982-03). Berlin, Germany. \n + // [2] Rapp, C. (2017). Grundlagen der Physik. In <em>Hydraulik fuer Ingenieure und Naturwissenschaftler</em> (pp.23-36). Springer Vieweg. Wiesbaden, Germany. https://doi.org/10.1007/978-3-658-18619-7_3. p. 105. // // \rules // is_optional @@ -318,8 +344,8 @@ If you want to reference message fields and enums add '#' to the enum/field name // A reference to a enum e.g. \c #COLOR_GREEN. -Commenting with links ----------------------- +Commenting with links (e.g. in references) +------------------------------------------ With ``[<add name of your link>](<add url of your link>)`` you can integrate a link to a certain homepage while commenting. Commenting with images diff --git a/osi_common.proto b/osi_common.proto index 213dc99ba..e4c22a21b 100644 --- a/osi_common.proto +++ b/osi_common.proto @@ -166,8 +166,8 @@ message Dimension3d // \attention This definition changed in OSI version 3.0.0. Previous OSI // versions (V2.xx) had an other definition. // -// \par References: -// - [1] DIN ISO 8855:2013-11 +// \par Reference: +// [1] DIN Deutsches Institut fuer Normung e. V. (2013). <em>DIN ISO 8855 Strassenfahrzeuge - Fahrzeugdynamik und Fahrverhalten - Begriffe</em>. (DIN ISO 8855:2013-11). Berlin, Germany. // message Orientation3d { diff --git a/osi_detectedobject.proto b/osi_detectedobject.proto index 27fb6a069..5ecf79eb4 100644 --- a/osi_detectedobject.proto +++ b/osi_detectedobject.proto @@ -15,7 +15,7 @@ package osi3; message DetectedItemHeader { // Specific ID of the detected item as assigned by the sensor internally. - // Need not match with \c #ground_truth_id. + // Needs not to match with \c #ground_truth_id. // optional Identifier tracking_id = 1; @@ -215,28 +215,28 @@ message DetectedMovingObject // Additional data that is specific to radar sensors. // - // \note Field need not be set if simulated sensor is not a radar + // \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 need not be set if simulated sensor is not a lidar + // \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 need not be set if simulated sensor is not a camera + // \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 need not be set if simulated sensor is not an ultrasonic + // \note Field needs not to be set if simulated sensor is not an ultrasonic // sensor. // optional UltrasonicSpecificObjectData ultrasonic_specifics = 103; @@ -275,9 +275,8 @@ message DetectedMovingObject // 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 and the z-axis is - // pointing upwards (cranial direction [1] i.e. to pedestrian's skull - // cap). + // 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`` @@ -285,17 +284,18 @@ message DetectedMovingObject // \note This field is mandatory if the \c CandidateMovingObject.type is // \c MovingObject::TYPE_PEDESTRIAN // - // \par References: - // - [1] https://en.wikipedia.org/wiki/Anatomical_terms_of_location + // \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 direction [2] (i.e. usually - // pedestrian's intended moving direction) and the z-axis is pointing - // upwards (to pedestrian's head). + // 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`` @@ -303,8 +303,8 @@ message DetectedMovingObject // \note This field is mandatory if the \c CandidateMovingObject::type // is \c MovingObject::TYPE_PEDESTRIAN // - // \par References: - // - [2] https://en.wikipedia.org/wiki/Anatomical_terms_of_location + // \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; } diff --git a/osi_environment.proto b/osi_environment.proto index e6139d4ca..be5d830a8 100644 --- a/osi_environment.proto +++ b/osi_environment.proto @@ -23,19 +23,20 @@ message EnvironmentalConditions // The Unix epoch (or Unix time or POSIX time or Unix timestamp) is // the number of seconds that have elapsed since January 1, 1970 - // (midnight UTC/GMT), not counting leap seconds - // (in ISO 8601: 1970-01-01T00:00:00Z). Literally speaking the epoch + // (midnight UTC/GMT [1]), not counting leap seconds [2]. + // Historically, the origin of UNIX system time was referred to as + // "00:00:00 GMT, January 1, 1970" [2]. Literally speaking the epoch // is Unix time 0 (midnight 1/1/1970), but 'epoch' is often used as // a synonym for 'Unix time'. Many Unix systems store epoch dates as // a signed 32-bit integer, which might cause problems on January 19, // 2038 (known as the Year 2038 problem or Y2038). // // \note You can convert the timestamp using the following [routines - // sorted by languages](https://www.epochconverter.com/#code) + // sorted by languages](https://www.epochconverter.com/#code). // // \par References: - // - [1] [Epoch & Unix Timestamp Conversion Tools](https://www.epochconverter.com/) - // - [2] [Wikipedia: Coordinated Universal Time] (https://en.wikipedia.org/wiki/Coordinated_Universal_Time) + // [1] ITU Radiocommunication Assembly. (2002). <em>Recommondation ITU-R TF.460-6 Standard-frequency and time-signal emissions</em>. (Rec. ITU-R TF.460-6). Retrieved January 25, 2020, from http://www.itu.int/dms_pubrec/itu-r/rec/tf/R-REC-TF.460-6-200202-I!!PDF-E.pdf \n + // [2] The Open Group. (2018). <em>POSIX.1-2017</em> The Open Group Base Specifications Issue 7, 2018 edition. IEEE Std 1003.1-2017 (Revision of IEEE Std 1003.1-2008). Retrieved January 25, 2020, from https://pubs.opengroup.org/onlinepubs/9699919799/xrat/contents.html // optional int64 unix_timestamp = 8; @@ -88,10 +89,8 @@ message EnvironmentalConditions // Definition of discretized precipitation states according to [1]. // (I = Intensity of precipitation in mm per hour mm/h) // - // \par References: - // - [1] PAULAT, Marcus, et al. A gridded dataset of hourly precipitation - // in Germany: Its construction, climatology and application. - // Meteorologische Zeitschrift, 2008, 17. Jg. Nr. 6, S. 719-732. + // \par Reference: + // [1] Paulat, M., Frei, C., Hagen, M. & Wernli, H. (2008). A gridded dataset of hourly precipitation in Germany: Its construction, climatology and application. <em>Meteorologische Zeitschrift</em>. Vol. 17, No. 6. pp. 719-732. Berlin, Stuttgart, Germany. https://doi.org/10.1127/0941-2948/2008/0332 // enum Precipitation { @@ -133,10 +132,10 @@ message EnvironmentalConditions PRECIPITATION_EXTREME = 8; } - // Definition of discretized fog states according to [2]. + // Definition of discretized fog states according to [1]. // The bandwidth of thick and dense fog was adjusted to fit the German StVO - // regarding rear fog lights [3]. - // (V = Visibility in meters m) + // regarding rear fog lights [2, 3]. + // (V = Visibility in m) // // Visibility is defined as the length of the atmosphere over which a beam // of light travels before its luminous flux is reduced to 5% of its @@ -145,12 +144,10 @@ message EnvironmentalConditions // contrast of a distant object against its background. // // \par References: - // - [2] SHEPARD, Frank D. Reduced visibility due to fog on the highway. - // Transportation Research Board, 1996. - // - [3] [StVO 17 chapter - // 3](https://www.stvo.de/strassenverkehrsordnung/101-17-beleuchtung) - // - [4] [Homepage of the Meteorological - // Office](http://www.metoffice.gov.uk/guide/weather/observations-guide/how-we-measure-visibility) + // [1] Shepard, F. D. (1996). <em>Reduced visibility due to fog on the highway.</em> Transportation Research Board, National Research Council (Ed.). National Academy Press. Washington, D.C., USA. ISBN 0-309-06006-0. \n + // [2] Strassenverkehrs-Ordnung (StVO) as of dated March 06, 2013 (BGBl. I S. 367), lastly changed by article 4a of the order from June 06, 2019 (BGBl. I S. 756). \n + // [3] stvo.de. (2013, April 01). <em>StVO Par. 17 Beleuchtung</em>. Retrieved January 25, 2020, from https://www.stvo.de/strassenverkehrsordnung/101-17-beleuchtung \n + // [4] Meteorological Office UK. (2020). <em>Homepage of the Meteorological Office - How we measure visibility</em>. Retrieved January 25, 2020, from http://www.metoffice.gov.uk/guide/weather/observations-guide/how-we-measure-visibility // enum Fog { @@ -201,30 +198,24 @@ message EnvironmentalConditions // emitted by the vehicle itself. It can include sun/moon light, light from // other cars, street lights etc. // - // lx ("Lux") is the SI unit of luminance or illumination of an area of exact + // lx ("lux") is the SI unit of luminance or illumination of an area of exact // one square meter, which is equal to one lumen per square meter 1 lx = - // 1 lm/m^2 [5]. + // 1 lm/m^2 [1]. // lm ("lumen") is the SI derived unit of luminous flux and a measure of // the total quantity of visible light emitted by a source. The lumen is // defined in relation to cd ("candela") as 1 lm = 1 cd sr, where sr // denotes steradian, the unit of solid angle used in 3D geometry analogous - // to the radian. + // to the radian [1]. // // Categorization is done based on natural day/night time illuminance levels - // [6] and standards for required lighting levels on roads [6, 7, 8, 9]. + // [2] and standards for required lighting levels on roads [2, 3, 4, 5]. // // \par References: - // - [5] [The NIST Reference on Constants, Units, and - // Uncertainty](https://physics.nist.gov/cuu/Units/units.html) - // - [6] [National Optical Astronomy - // Observatory](https://www.noao.edu/education/QLTkit/ACTIVITY_Documents/Safety/LightLevels_outdoor+indoor.pdf) - // - [7] [Standards for required street lighting in the - // USA](http://www.wsdot.wa.gov/research/reports/fullreports/847.1.pdf) - // - [8] [Canadian IES-RP-8 standards for road lighting - municipality of - // Saint-Gedeon-de-. - // Beauce] (http://sslnet.ca/wp-content/uploads/2011/10/LTE-RT-2011-0076-Anglais.pdf) - // - [9] [European standards for road - // lighting] (http://courtneystrong.com/wp-content/uploads/2017/07/css-sl1-class-and-quality-of-street-lighting.pdf) + // [1] DIN Deutsches Institut fuer Normung e. V. (1982). <em>DIN 5031-3 Strahlungsphysik im optischen Bereich und Lichttechnik - Groessen, Formelzeichen und Einheiten der Lichttechnik</em>. (DIN 5031-3:1982-03). Berlin, Germany. \n + // [2] National Optical Astronomy Observatory. (2015, December 02). <em>Recommended Light Levels</em>. Retrieved January 25, 2020, from https://www.noao.edu/education/QLTkit/ACTIVITY_Documents/Safety/LightLevels_outdoor+indoor.pdf \n + // [3] Wang, Y. & Zou, Y., (2016, March). <em>Study on Illumination for State Highways</em>. Washington State Department of Transportation. Retrieved January 25, 2020, from http://www.wsdot.wa.gov/research/reports/fullreports/847.1.pdf \n + // [4] Laperriere, A. (2011, May). <em>LED street lighting in the municipality of Saint-Gedeon-de-Beauce within the framework of advanced lighting technologies</em>. Retrieved January 25, 2020, from http://sslnet.ca/wp-content/uploads/2011/10/LTE-RT-2011-0076-Anglais.pdf \n + // [5] Crabb, G. I., Beaumont, R. & Webster, D. (2008, October 17). <em>Review of the class and quality of street lighting</em>. Transport Research Laboratory. Retrieved January 25, 2020, from http://courtneystrong.com/wp-content/uploads/2017/07/css-sl1-class-and-quality-of-street-lighting.pdf // enum AmbientIllumination { diff --git a/osi_featuredata.proto b/osi_featuredata.proto index df274561b..18c90ad52 100644 --- a/osi_featuredata.proto +++ b/osi_featuredata.proto @@ -98,8 +98,8 @@ message SensorDetectionHeader // identical to sensor detection frame's origin. Detections are defined in // the sensor detection frame which uses e.g. spherical coordinates. // - // \par References: - // - [1] DIN ISO 8855:2013-11 + // \par Reference: + // [1] DIN Deutsches Institut fuer Normung e. V. (2013). <em>DIN ISO 8855 Strassenfahrzeuge - Fahrzeugdynamik und Fahrverhalten - Begriffe</em>. (DIN ISO 8855:2013-11). Berlin, Germany. // optional MountingPosition mounting_position = 3; diff --git a/osi_groundtruth.proto b/osi_groundtruth.proto index 77c084d28..e72a68cff 100644 --- a/osi_groundtruth.proto +++ b/osi_groundtruth.proto @@ -125,14 +125,11 @@ message GroundTruth optional EnvironmentalConditions environmental_conditions = 12; // The ISO country code in 3 digit numeric format according to: - // ISO Code 3166/1 [1,2]. + // ISO Code 3166/1 [1]. // E.g. Germany = 276, USA = 840. // - // \par References: - // - [1] [International Standard ISO 3166-1: Codes for the representation of - // names of countries and their subdivisions - Part 1: Country codes, third - // ed., 2013] (https://www.iso.org/obp/ui/) - // - [2] [Wikipedia ISO 3166/1] (https://en.wikipedia.org/wiki/ISO_3166-1) + // \par Reference: + // [1] ISO International Organization for Standardization. (2013). <em>ISO 3166-1 Codes for the representation of names of countries and their subdivisions - Part 1: Country codes</em>. (ISO 3166-1:2013). Geneva, Switzerland. // // \rules // is_iso_country_code: @@ -143,10 +140,10 @@ message GroundTruth // Projection string that allows to transform all coordinates in GroundTruth // into a different cartographic projection. // - // The string follows the PROJ.4 project rules for projections [1]. + // The string follows the PROJ rules for projections [1]. // - // \par References: - // - [1] [Proj.4 Projections] (https://proj4.org/usage/projections.html) + // \par Reference: + // [1] PROJ contributors. (2019). <em>PROJ coordinate transformation software library</em>. Open Source Geospatial Foundation. Retrieved January 25, 2019, from https://proj.org/usage/projections.html // optional string proj_string = 14; diff --git a/osi_lane.proto b/osi_lane.proto index 56ef288e1..91bd68cc3 100644 --- a/osi_lane.proto +++ b/osi_lane.proto @@ -442,9 +442,8 @@ message Lane // // Unit: mm/m // - // \par References: - // - [1] SAYERS, M.W.; KARAMIHAS, S.M. Little Book of Profiling, - // University of Michigan Transportation Research Institute, 1998. + // \par Reference: + // [1] Sayers, M. W. & Karamihas, S. M. (1998). <em>Little Book of Profiling</em>. University of Michigan Transportation Research Institute. Retrieved January 25, 2020, from http://www.umtri.umich.edu/content/LittleBook98R.pdf pp. 45 ff. // // \rules // is_greater_than_or_equal_to: 0 @@ -455,19 +454,15 @@ message Lane // The surface texture or fine roughness // // Whereas the IRI-based roughness or unevenness measure only takes - // into account road wavelengths around 0.5m - 100m, the surface - // texture or fine roughness [2] measures only wavelengths below - // 0.5m. It is given as the standard height deviation of fine + // into account road wavelengths around 0.5 m - 100 m, the surface + // texture or fine roughness [1] measures only wavelengths below + // 0.5 m. It is given as the standard height deviation of fine // roughness // // Unit: m // - // \par References: - // - [1] SAYERS, M.W.; KARAMIHAS, S.M. Little Book of Profiling, - // University of Michigan Transportation Research Institute, 1998. - // - [2] SCHNEIDER, R.: Modellierung der Wellenausbreitung fuer - // ein bildgebendes Kfz-Radar, Dissertation, Universitaet Karlsruhe, - // Mai 1998. + // \par Reference: + // [1] Schneider, R. (1998). <em>Modellierung der Wellenausbreitung fuer ein bildgebendes Kfz-Radar</em>. PhD thesis. Karlsruhe, Germany. Universitaet Karlsruhe, Fak. f. Elektrotechnik. // optional double surface_texture = 6; } diff --git a/osi_object.proto b/osi_object.proto index e65654375..90fe0e2fe 100644 --- a/osi_object.proto +++ b/osi_object.proto @@ -384,8 +384,8 @@ message MovingObject // right-handed. Therefore the positive y-axis points to the left of the // vehicle. // - // \par References: - // - [1] DIN ISO 8855:2013-11 + // \par Reference: + // [1] DIN Deutsches Institut fuer Normung e. V. (2013). <em>DIN ISO 8855 Strassenfahrzeuge - Fahrzeugdynamik und Fahrverhalten - Begriffe</em>. (DIN ISO 8855:2013-11). Berlin, Germany. // message VehicleAttributes { diff --git a/osi_sensordata.proto b/osi_sensordata.proto index ad5909a99..2aa70e65f 100644 --- a/osi_sensordata.proto +++ b/osi_sensordata.proto @@ -172,8 +172,8 @@ message SensorData // \arg \b y-direction of sensor coordinate system: perpendicular to x and z // right hand system // - // \par References: - // - [1] DIN ISO 8855:2013-11 + // \par Reference: + // [1] DIN Deutsches Institut fuer Normung e. V. (2013). <em>DIN ISO 8855 Strassenfahrzeuge - Fahrzeugdynamik und Fahrverhalten - Begriffe</em>. (DIN ISO 8855:2013-11). Berlin, Germany. // // \note This field is usually static during the simulation. // \note The origin of vehicle's coordinate system in world frame is diff --git a/osi_sensorview.proto b/osi_sensorview.proto index dd9276acf..e6331cb76 100644 --- a/osi_sensorview.proto +++ b/osi_sensorview.proto @@ -77,8 +77,8 @@ message SensorView // \arg \b y-direction of sensor coordinate system: perpendicular to x and z // right hand system // - // \par References: - // - [1] DIN ISO 8855:2013-11 + // \par Reference: + // [1] DIN Deutsches Institut fuer Normung e. V. (2013). <em>DIN ISO 8855 Strassenfahrzeuge - Fahrzeugdynamik und Fahrverhalten - Begriffe</em>. (DIN ISO 8855:2013-11). Berlin, Germany. // // \note This field is usually static during the simulation. // \note The origin of vehicle's coordinate system in world frame is diff --git a/osi_sensorviewconfiguration.proto b/osi_sensorviewconfiguration.proto index 419f11168..0e133b2b1 100644 --- a/osi_sensorviewconfiguration.proto +++ b/osi_sensorviewconfiguration.proto @@ -94,8 +94,8 @@ message SensorViewConfiguration // \arg \b y-direction of sensor coordinate system: perpendicular to x and z // right hand system // - // \par References: - // - [1] DIN ISO 8855:2013-11 + // \par Reference: + // [1] DIN Deutsches Institut fuer Normung e. V. (2013). <em>DIN ISO 8855 Strassenfahrzeuge - Fahrzeugdynamik und Fahrverhalten - Begriffe</em>. (DIN ISO 8855:2013-11). Berlin, Germany. // // \note The origin of vehicle's coordinate system in world frame is // ( \c MovingObject::base . \c BaseMoving::position + @@ -253,8 +253,8 @@ message GenericSensorViewConfiguration // \arg \b y-direction of sensor coordinate system: perpendicular to x and z // right hand system // - // \par References: - // - [1] DIN ISO 8855:2013-11 + // \par Reference: + // [1] DIN Deutsches Institut fuer Normung e. V. (2013). <em>DIN ISO 8855 Strassenfahrzeuge - Fahrzeugdynamik und Fahrverhalten - Begriffe</em>. (DIN ISO 8855:2013-11). Berlin, Germany. // // \note The origin of vehicle's coordinate system in world frame is // ( \c MovingObject::base . \c BaseMoving::position + @@ -324,8 +324,8 @@ message RadarSensorViewConfiguration // \arg \b y-direction of sensor coordinate system: perpendicular to x and z // right hand system // - // \par References: - // - [1] DIN ISO 8855:2013-11 + // \par Reference: + // [1] DIN Deutsches Institut fuer Normung e. V. (2013). <em>DIN ISO 8855 Strassenfahrzeuge - Fahrzeugdynamik und Fahrverhalten - Begriffe</em>. (DIN ISO 8855:2013-11). Berlin, Germany. // // \note The origin of vehicle's coordinate system in world frame is // ( \c MovingObject::base . \c BaseMoving::position + @@ -480,8 +480,8 @@ message LidarSensorViewConfiguration // \arg \b y-direction of sensor coordinate system: perpendicular to x and z // right hand system // - // \par References: - // - [1] DIN ISO 8855:2013-11 + // \par Reference: + // [1] DIN Deutsches Institut fuer Normung e. V. (2013). <em>DIN ISO 8855 Strassenfahrzeuge - Fahrzeugdynamik und Fahrverhalten - Begriffe</em>. (DIN ISO 8855:2013-11). Berlin, Germany. // // \note The origin of vehicle's coordinate system in world frame is // ( \c MovingObject::base . \c BaseMoving::position + @@ -624,8 +624,8 @@ message CameraSensorViewConfiguration // \arg \b y-direction of sensor coordinate system: perpendicular to x and z // right hand system // - // \par References: - // - [1] DIN ISO 8855:2013-11 + // \par Reference: + // [1] DIN Deutsches Institut fuer Normung e. V. (2013). <em>DIN ISO 8855 Strassenfahrzeuge - Fahrzeugdynamik und Fahrverhalten - Begriffe</em>. (DIN ISO 8855:2013-11). Berlin, Germany. // // \note The origin of vehicle's coordinate system in world frame is // ( \c MovingObject::base . \c BaseMoving::position + @@ -804,8 +804,8 @@ message UltrasonicSensorViewConfiguration // \arg \b y-direction of sensor coordinate system: perpendicular to x and z // right hand system // - // \par References: - // - [1] DIN ISO 8855:2013-11 + // \par Reference: + // [1] DIN Deutsches Institut fuer Normung e. V. (2013). <em>DIN ISO 8855 Strassenfahrzeuge - Fahrzeugdynamik und Fahrverhalten - Begriffe</em>. (DIN ISO 8855:2013-11). Berlin, Germany. // // \note The origin of vehicle's coordinate system in world frame is // ( \c MovingObject::base . \c BaseMoving::position + diff --git a/osi_version.proto.in b/osi_version.proto.in index c416dc2a7..1170d1e58 100644 --- a/osi_version.proto.in +++ b/osi_version.proto.in @@ -25,10 +25,11 @@ package osi3; // properly set the version components prior to sending. // // Increments will happen as part of changes to the whole interface. -// The meaning of different InterfaceVersions is defined [1]. +// The meaning of different InterfaceVersions is defined in [1]. +// +// \par Reference: +// [1] Open Simulation Interface. (2020, January 25). <em>README</em>. Retrieved January 25, 2020, from https://opensimulationinterface.github.io/osi-documentation/open-simulation-interface/README.html // -// \par References: -// [1] Open Simulation Interface: README.md message InterfaceVersion { // Major version number.