Skip to content

Commit 01154ed

Browse files
Markus Waldmannpmai
authored andcommitted
Rework cloud, sun, and wind in environment
- Remove LEVEL_NO_SKY in CloudStateLevel There will be no need for now for this state, if no sky is needed, use LEVEL_OTHER. - Describe rules within description With rules there is no greater than pi possible. Therefore, moved the rules to the description. - Change wind description Changed the range to -pi to +pi like in common.proto for Oreintation3d messages. Added a note for minding the conversation from openSCENARIO. Signed-off-by: Markus Waldmann <Markus.Waldmann@stud.hs-kempten.de>
1 parent da5f946 commit 01154ed

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

osi_environment.proto

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ message EnvironmentalConditions
105105
//
106106
optional Clouds clouds = 10;
107107

108-
// Definition of the wind properties
108+
// Definition of the wind properties.
109109
//
110110
optional Wind wind = 11;
111111

@@ -338,9 +338,9 @@ message EnvironmentalConditions
338338
}
339339

340340
//
341-
// \brief Specification of the cloud states
341+
// \brief Specification of the cloud states.
342342
//
343-
// \note within this message there is the cloud state level
343+
// \note within this message there is the cloud state level.
344344
//
345345
message Clouds
346346
{
@@ -364,7 +364,7 @@ message EnvironmentalConditions
364364
// With a little practice, the observer can easily determine the total amount of cloud cover.
365365
// Problems occur only with scattered clouds or many single clouds (cumulus).
366366
// Their cloud cover is often overestimated. On the other hand,
367-
// the coverage of thin ice clouds (cirrus) is often underestimated.[3]
367+
// the coverage of thin ice clouds (cirrus) is often underestimated [3].
368368
//
369369
// \par References:
370370
// [1] ISO 15469:2004(E) / CIE S 011/E:2003 : Spatial distribution of skylight
@@ -416,57 +416,57 @@ message EnvironmentalConditions
416416
// Covered (8/8)
417417
//
418418
CLOUD_STATE_LEVEL_COVERED = 10;
419-
420-
// No Sky
421-
//
422-
CLOUD_STATE_LEVEL_NO_SKY = 11;
423419
}
424420
}
425421

426422
//
427423
// \brief Defines wind properties.
428424
//
429-
// \note Aligns with the wind speed and direction as defined in ASAM OpenSCENARIO
425+
// \note Aligns with the wind speed and direction as defined in ASAM OpenSCENARIO.
430426
//
431427
message Wind
432428
{
433429
// The target direction of the wind (not the origin direction) in the ground/xy-plane of the \c
434430
// world coordinate system. Corresponds to the heading/yaw angle. \c
435-
// x-axis-direction is 0 rad. Unit [rad]. Range [0...2 pi[
431+
// x-axis-direction is 0 rad.
432+
//
433+
// Unit: rad
434+
//
435+
// The preferred angular range is [-pi, pi]
436+
//
437+
// \note The range in openSCENARIO is Range [0...2 pi[. Mind the conversion.
436438
//
437439
optional Vector3d direction = 1;
438440

439-
// The wind speed. Unit [m/s]. Range [0...inf[
441+
// The wind speed.
442+
//
443+
// Unit m/s
444+
//
445+
// Range [0...inf[
440446
//
441447
optional double speed = 2;
442448
}
443449

444450
//
445451
// \brief Specification of sun properties.
446452
//
447-
// \note Aligns with the specification of sun properties according to ASAM OpenSCENARIO
453+
// \note Aligns with the specification of sun properties according to ASAM OpenSCENARIO.
448454
//
449455
message Sun
450456
{
451-
// Azimuth of the sun, counted counterclockwise
457+
// Azimuth of the sun, counted counterclockwise.
452458
//
453459
// Unit: rad
454460
//
455-
// \rules
456-
// is_greater_than_or_equal_to: -PI
457-
// is_less_than_or_equal_to: 2PI
458-
// \endrules
461+
// The preferred angular range is [0, 2pi]
459462
//
460463
optional double azimuth = 1;
461464

462-
// Solar elevation angle
465+
// Solar elevation angle.
463466
//
464467
// Unit: rad
465468
//
466-
// \rules
467-
// is_greater_than_or_equal_to: -PI
468-
// is_less_than_or_equal_to: PI
469-
// \endrules
469+
// The preferred angular range is [-pi, pi]
470470
//
471471
optional double elevation = 2;
472472

0 commit comments

Comments
 (0)