Skip to content

Commit ef363bf

Browse files
AhmedMzidAhmedMzid
committed
Edit the fog definition
1 parent 2de1092 commit ef363bf

File tree

1 file changed

+67
-50
lines changed

1 file changed

+67
-50
lines changed

‎osi_environment.proto‎

Lines changed: 67 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -4,109 +4,126 @@ option optimize_for = SPEED;
44

55
package osi;
66

7-
///
8-
/// The conditions of the environment.
9-
///
7+
//
8+
// \brief The conditions of the environment.
9+
//
10+
1011
message EnvironmentalConditions
1112
{
12-
/// The ambient illumination of the environment.
13+
// The ambient illumination of the environment.
14+
//
1315
optional AmbientIllumination ambient_illumination = 1;
1416

15-
/// The time of day.
17+
// The time of day.
18+
//
1619
optional TimeOfDay time_of_day = 2;
1720

18-
/// Atmospheric pressure in Pascal at z=0.0 in world frame
21+
// Atmospheric pressure in Pascal at z=0.0 in world frame.
22+
//
1923
optional double atmospheric_pressure = 3;
2024

21-
/// Temperature in Kelvin at z=0.0 in world frame
25+
// Temperature in Kelvin at z=0.0 in world frame.
26+
//
2227
optional double temperature = 4;
2328

24-
/// Precipitation
29+
// Precipitation
30+
//
2531
optional Precipitation precipitation = 5;
2632

27-
/// Fog
33+
// Fog
34+
//
2835
optional Fog fog = 6;
2936

30-
/// Definition of precipitation states
31-
/// I = Intensity of precipitation in mm per hour
32-
/// Quote: 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.
37+
// Definition of precipitation states according to [1].
38+
// (I = Intensity of precipitation in mm per hour)
39+
//
40+
// \par References:
41+
// [1] PAULAT, Marcus, et al. A gridded dataset of hourly precipitation in Germany: Its construction, climatology and application.
42+
// Meteorologische Zeitschrift, 2008, 17. Jg. Nr. 6, S. 719-732.
3343
enum Precipitation
3444
{
35-
/// Intensity of precipitation is unknown (must not be used in ground truth).
45+
// Intensity of precipitation is unknown (must not be used in ground truth).
3646
PRECIPITATION_UNKNOWN = 0;
37-
/// Other (unspecified but known) intensity of precipitation
47+
// Other (unspecified but known) intensity of precipitation
3848
PRECIPITATION_OTHER = 1;
39-
/// No precipitation, when I = [0 ; 0.1[
49+
// No precipitation, when I = [0 ; 0.1[
4050
PRECIPITATION_NONE = 2;
41-
/// Very light intensity of precipitation, when I = [0.1 ;0.5[
51+
// Very light intensity of precipitation, when I = [0.1 ;0.5[
4252
PRECIPITATION_VERY_LIGHT = 3;
43-
/// Light intensity of precipitation, when I = [0.5 ;1.9[
53+
// Light intensity of precipitation, when I = [0.5 ;1.9[
4454
PRECIPITATION_LIGHT = 4;
45-
/// Moderate intensity of precipitation, when I = [1.9 ; 8.1[
55+
// Moderate intensity of precipitation, when I = [1.9 ; 8.1[
4656
PRECIPITATION_MODERATE = 5;
47-
/// Heavy intensity of precipitation, when I = [8.1 ; 34[
57+
// Heavy intensity of precipitation, when I = [8.1 ; 34[
4858
PRECIPITATION_HEAVY = 6;
49-
/// Very heavy intensity of precipitation, when I = [34 ;149[
59+
// Very heavy intensity of precipitation, when I = [34 ;149[
5060
PRECIPITATION_VERY_HEAVY = 7;
51-
/// Extreme intensity of precipitation, when I = [149 ; infinity[
61+
// Extreme intensity of precipitation, when I = [149 ; infinity[
5262
PRECIPITATION_EXTREME = 8;
5363
}
5464

55-
/// Definition of fog states by visibility
56-
/// V = Visibility in meters is the greatest distance at which a black object of suitable dimensions may be seen and recognized against the horizon, sky, or in the case of night observation, could be seen and recognized if the general illumination were raised to the normal daylight level. (Meteorological Office 1969)
57-
/// Quote: SHEPARD, Frank D. Reduced visibility due to fog on the highway. Transportation Research Board, 1996.
65+
// Definition of fog states according to [2] the bandwith of thick and dense fog was adjusted to fit the german StVo regarding rear fog lights [3].
66+
// (V = Visibility in meters)
67+
//
68+
// Visability is defined as the lenght of the atmosphere over which a beam of light travels before its luminous flux is reduced to 5% of its original value (definition used by the Meteorological Office [4]).
69+
// This is approximately equivalent to visibility measured by the contrast of a distant object against its background.
70+
//
71+
// \par References:
72+
// [2] SHEPARD, Frank D. Reduced visibility due to fog on the highway. Transportation Research Board, 1996.
73+
// [3] [StVO § 17 chapter 3](https://www.stvo.de/strassenverkehrsordnung/101-17-beleuchtung)
74+
// [4] [Homepage of the Meteorological Office](http://www.metoffice.gov.uk/guide/weather/observations-guide/how-we-measure-visibility)
5875
enum Fog
5976
{
60-
/// Visibility is unknown (must not be used in ground truth)
77+
// Visibility is unknown (must not be used in ground truth)
6178
FOG_UNKOWN = 0;
62-
/// Other (unspecified but known) fog intensity
79+
// Other (unspecified but known) fog intensity
6380
FOG_OTHER = 1;
64-
/// Excellent visibility, when V = [40,000 ; infinity[
81+
// Excellent visibility, when V = [40,000 ; infinity[
6582
FOG_EXCELLENT_VISIBILITY = 2;
66-
/// Good visibility, when V = [10,000 ; 40,000[
83+
// Good visibility, when V = [10,000 ; 40,000[
6784
FOG_GOOD_VISIBILITY = 3;
68-
/// Moderate visibility, when V = [4000 ; 10,000[
85+
// Moderate visibility, when V = [4000 ; 10,000[
6986
FOG_MODERATE_VISIBILITY = 4;
70-
/// Poor visibility, when V = [2000 ; 4000[
87+
// Poor visibility, when V = [2000 ; 4000[
7188
FOG_POOR_VISIBILITY = 5;
72-
/// Mist, when V = [1000 ; 2000[
89+
// Mist, when V = [1000 ; 2000[
7390
FOG_MIST = 6;
74-
/// Fog, when V = [200 ; 1000[
91+
// Fog, when V = [200 ; 1000[
7592
FOG_LIGHT = 7;
76-
/// Thick fog, when V = [40 ; 200[
93+
// Thick fog, when V = [50 ; 200[
7794
FOG_THICK = 8;
78-
/// Dense fog, when V = [0 ; 40[
95+
// Dense fog, when V = [0 ; 50[ (allowed to use rear fog light)
7996
FOG_DENSE = 9;
8097
}
8198

82-
/// Definition of ambient illumination states.
99+
// Definition of ambient illumination states.
83100
enum AmbientIllumination
84101
{
85-
/// Ambient illumination is unknown (must not be used in ground truth).
102+
// Ambient illumination is unknown (must not be used in ground truth).
86103
AMBIENT_ILLUMINATION_UNKNOWN = 0;
87-
/// Other (unspecified but known) ambient illumination.
104+
// Other (unspecified but known) ambient illumination.
88105
AMBIENT_ILLUMINATION_OTHER = 1;
89-
/// Ambient illumination index is "bright".
90-
/// E.g. daytime with sunshine.
106+
// Ambient illumination index is "bright".
107+
// E.g. daytime with sunshine.
91108
AMBIENT_ILLUMINATION_BRIGHT = 2;
92-
/// Ambient illumination index is "medium".
93-
/// E.g. daytime with overcast sky.
109+
// Ambient illumination index is "medium".
110+
// E.g. daytime with overcast sky.
94111
AMBIENT_ILLUMINATION_MEDIUM = 3;
95-
/// Ambient illumination index is "low".
96-
/// E.g. during twilight (dawn/dusk) or in a tunnel.
112+
// Ambient illumination index is "low".
113+
// E.g. during twilight (dawn/dusk) or in a tunnel.
97114
AMBIENT_ILLUMINATION_LOW = 4;
98-
/// Ambient illumination index is "dark".
99-
/// E.g. night time, no sunlight.
115+
// Ambient illumination index is "dark".
116+
// E.g. night time, no sunlight.
100117
AMBIENT_ILLUMINATION_DARK = 5;
101118
}
102119

103-
///
104-
/// The time of day at the location of the vehicle.
105-
///
120+
//
121+
// \brief The time of day at the location of the vehicle.
122+
//
106123
message TimeOfDay
107124
{
108-
/// The number of seconds that have passed since midnight local time.
109-
/// Used for determining the current state of the circadian rhythm of a driver.
125+
// The number of seconds that have passed since midnight local time.
126+
// Used for determining the current state of the circadian rhythm of a driver.
110127
optional uint32 seconds_from_midnight = 1;
111128
}
112129
}

0 commit comments

Comments
 (0)