Skip to content

Commit dad1324

Browse files
committed
Small doc update
Signed-off-by: Thomas Bleher <thomas.tb.bleher@bmw.de>
1 parent 6958044 commit dad1324

File tree

2 files changed

+18
-15
lines changed

2 files changed

+18
-15
lines changed

osi_common.proto

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@ message Spherical3d
348348
//
349349
// As an exception to this, \c TrafficSign and \c TrafficLight are assigned to
350350
// a logical lane if they control traffic on that lane. For \c TrafficSign and
351-
// \c TrafficLight , s_position refers to the position where the sign or light
351+
// \c TrafficLight , #s_position refers to the position where the sign or light
352352
// is valid (e.g. where vehicles should stop in case of a red traffic light),
353353
// not the physical position (where the sign or light is in the world).
354354
// Typically, t_position and angle_to_lane do not have any meaning in this
@@ -367,7 +367,7 @@ message LogicalLaneAssignment
367367
// S position of the object reference point on the lane, in the ST
368368
// coordinate system of the lane.
369369
//
370-
// s_position might be outside [s_start,s_end] of the lane (and even
370+
// #s_position might be outside [s_start,s_end] of the lane (and even
371371
// outside [startS,endS] of the reference line) if the reference point is
372372
// outside the lane, but the object overlaps the lane or a TrafficSign or
373373
// TrafficLight is assigned to a lane.

osi_logicallane.proto

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ package osi3;
3535
// - No centerline of the lane is necessary, since this can very easily be
3636
// generated from the boundaries.
3737
// Disadvantages of this decision:
38-
// - Lane boundaries cannot be shared with physical lanes. This results in
38+
// - %Lane boundaries cannot be shared with physical lanes. This results in
3939
// more data needed. This can mostly be mitigated by only transmitting the
4040
// lane boundaries during initialization (e.g. via the OSMP GroundTruthInit
4141
// message).
@@ -359,6 +359,11 @@ message LogicalLane
359359
// reference_line, so that vehicles that are next to each other on
360360
// neighbouring lanes have comparable S positions.
361361
//
362+
// The S coordinate of the reference line makes it easy to find e.g. which
363+
// object is next on a lane, using the LogicalLaneAssignment of the
364+
// objects.
365+
//
366+
//
362367
// \rules
363368
// refers_to: ReferenceLine
364369
// \endrules
@@ -372,7 +377,8 @@ message LogicalLane
372377

373378
// End S position of the lane. Must be in range [sStart,sEnd] of the
374379
// reference line.
375-
// end_s > start_s
380+
//
381+
// Requirement: #end_s > #start_s
376382
//
377383
optional double end_s = 7;
378384

@@ -386,7 +392,7 @@ message LogicalLane
386392
// Lanes that are directly right of this lane, without gap or overlap.
387393
// "Right" is in definition direction (not driving direction), so right lanes
388394
// have smaller T coordinates.
389-
// Entries must be ordered: first by start_s, then by end_s.
395+
// Entries must be ordered: first by #start_s, then by #end_s.
390396
//
391397
// The XY positions of the polyline generated by the LogicalLaneBoundaries
392398
// of adjacent lanes must match up to a small error (5cm).
@@ -402,7 +408,7 @@ message LogicalLane
402408
// Lanes that are directly left of this lane, without gap or overlap.
403409
// "Left" is in definition direction (not driving direction), so left lanes
404410
// have larger T coordinates.
405-
// Entries must be ordered: first by start_s, then by end_s.
411+
// Entries must be ordered: first by #start_s, then by #end_s.
406412
//
407413
// The XY positions of the polyline generated by the LogicalLaneBoundaries
408414
// of adjacent lanes must match up to a small error (5cm).
@@ -418,7 +424,7 @@ message LogicalLane
418424
// Lanes that partially or completely overlap this lane. Only overlaps
419425
// laterally larger than 5cm are considered overlaps for the purpose of
420426
// this relation.
421-
// Entries must be ordered: first by start_s, then by end_s.
427+
// Entries must be ordered: first by #start_s, then by #end_s.
422428
//
423429
repeated LaneRelation overlapping_lane = 11;
424430

@@ -579,7 +585,7 @@ message LogicalLane
579585

580586
// S position on the logical lane where the physical lane ends
581587
//
582-
// Requirement: end_s > start_s
588+
// Requirement: #end_s > #start_s
583589
//
584590
optional double end_s = 3;
585591
}
@@ -623,28 +629,25 @@ message LogicalLane
623629

624630
// End s position of the relation
625631
//
626-
// Requirement: end_s > start_s
632+
// Requirement: #end_s > #start_s
627633
//
628634
optional double end_s = 3;
629635

630636
// Start s position of the relation on the other lane.
631637
//
632-
// This is the same place as start_s, but measured along the reference
638+
// This is the same place as #start_s, but measured along the reference
633639
// line of the other lane.
634640
//
635641
optional double start_s_other = 4;
636642

637643
// End s position of the relation on the other lane.
638644
//
639-
// This is the same place as end_s, but measured along the reference
645+
// This is the same place as #end_s, but measured along the reference
640646
// line of the other lane.
641647
//
642-
// Note: end_s_other might be smaller than start_s_other
648+
// Note: #end_s_other might be smaller than #start_s_other
643649
//
644650
optional double end_s_other = 5;
645651
}
646652
}
647653

648-
// TODO Traffic Agents also need the physical area of an intersection. This
649-
// should be added to physical lanes of type TYPE_INTERSECTION.
650-

0 commit comments

Comments
 (0)