Skip to content

Commit d62699a

Browse files
Change ray tracer spelling and minor fixes
Signed-off-by: Thomas Sedlmayer <tsedlmayer@pmsfit.de>
1 parent 501a1e6 commit d62699a

File tree

1 file changed

+24
-25
lines changed

1 file changed

+24
-25
lines changed

osi_sensorviewconfiguration.proto

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -237,10 +237,9 @@ message SensorViewConfiguration
237237
repeated UltrasonicSensorViewConfiguration
238238
ultrasonic_sensor_view_configuration = 1004;
239239

240-
// Raytracer-specific View Configuration(s).
240+
// Ray tracer-specific View Configuration(s).
241241
//
242-
repeated RaytracerViewConfiguration
243-
raytracer_view_configuration = 1005;
242+
repeated RayTracerViewConfiguration ray_tracer_view_configuration = 1005;
244243
}
245244

246245
//
@@ -981,10 +980,10 @@ message UltrasonicSensorViewConfiguration
981980

982981

983982
//
984-
// \brief The configuration settings for the Raytracer View to be
983+
// \brief The configuration settings for the \c RayTracerView to be
985984
// provided by the environment simulation.
986985
//
987-
message RaytracerViewConfiguration
986+
message RayTracerViewConfiguration
988987
{
989988
// The ID of the sensor origin at host vehicle's mounting_position.
990989
//
@@ -1023,16 +1022,16 @@ message RaytracerViewConfiguration
10231022
// mounting position (based on the vehicle configuration) when setting the
10241023
// view configuration.
10251024
//
1026-
// All raytracing results e.g. Hitpoint positions are given in this
1025+
// All ray tracing results e.g. Hitpoint positions are given in this
10271026
// sensor coordinate system.
10281027
//
10291028
optional MountingPosition mounting_position = 2;
10301029

1031-
// Position of the raytracer`s receiver in the sensor coordinate system.
1030+
// Position of the ray tracer's receiver in the sensor coordinate system.
10321031
//
10331032
repeated MountingPosition receiver_position = 3;
10341033

1035-
// Position of the raytracer`s transmitter in the sensor coordinate system.
1034+
// Position of the ray tracer's transmitter in the sensor coordinate system.
10361035
//
10371036
repeated MountingPosition transmitter_position = 4;
10381037

@@ -1042,8 +1041,8 @@ message RaytracerViewConfiguration
10421041
//
10431042
optional double emitter_wavelength = 5;
10441043

1045-
// When reaching the maximmum signal loss during raytracing further
1046-
// raytracing is aborted. The maximum signal loss is the relation between
1044+
// When reaching the maximum signal loss during ray tracing further
1045+
// ray tracing is aborted. The maximum signal loss is the relation between
10471046
// current calculated signal strength and the emitted signal strength at the
10481047
// ray generation.
10491048
//
@@ -1065,7 +1064,7 @@ message RaytracerViewConfiguration
10651064
//
10661065
optional uint32 max_number_of_interactions = 8;
10671066

1068-
// Format of raytracer data (includes number, kind and format of channels).
1067+
// Format of ray tracer data (includes number, kind and format of channels).
10691068
//
10701069
// The \c RayTracerFormat is used to facilitate information exchange between
10711070
// different modules within a shared context. The ray tracing provider
@@ -1086,25 +1085,25 @@ message RaytracerViewConfiguration
10861085
// data being provided by the simulation environment - which must
10871086
// be one of the values the sensor model requested - or there
10881087
// must be no value, indicating that the simulation environment
1089-
// cannot provide raytracer data in one of the requested formats.
1088+
// cannot provide ray tracer data in one of the requested formats.
10901089
//
1091-
repeated RaytracerFormat raytracer_format = 9;
1090+
repeated RayTracerFormat ray_tracer_format = 9;
10921091

1093-
// Different predefined raytracer formats
1092+
// Different predefined ray tracer formats
10941093
//
1095-
enum RaytracerFormat
1094+
enum RayTracerFormat
10961095
{
10971096
// Type of channel format is unknown (must not be used).
10981097
//
1099-
RAYTRACER_FORMAT_UNKNOWN = 0;
1098+
RAY_TRACER_FORMAT_UNKNOWN = 0;
11001099

11011100
// Unspecified but known channel format.
11021101
// Consider proposing an additional format if using
1103-
// \c #RAYTRACER_FORMAT_OTHER.
1102+
// \c #RAY_TRACER_FORMAT_OTHER.
11041103
//
1105-
RAYTRACER_FORMAT_OTHER = 1;
1104+
RAY_TRACER_FORMAT_OTHER = 1;
11061105

1107-
// Raytracer format for Shoot and Bounce Approach (adapted for
1106+
// Ray tracer format for Shoot and Bounce Approach (adapted for
11081107
// electromagnetic wave propagation) [1]
11091108
//
11101109
// The 64-byte message consists of the fields in the described order,
@@ -1145,29 +1144,29 @@ message RaytracerViewConfiguration
11451144
//
11461145
// * \c direction_of_arrival_hitpoint - float32[3] (meters):
11471146
//
1148-
// Coordinates of the DoA (last hitpoint) in the raytracer's
1147+
// Coordinates of the DoA (last hitpoint) in the ray tracer's
11491148
// coordinate system defined by the mounting position.
11501149
//
11511150
// Order: x, y, z
11521151
//
1153-
// Coordinate system: right-handed ([see OSI coordinate system definition](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/interface/usecases/transforming_coordinate_systems.html))
1152+
// Coordinate system: right-handed (<a href="https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/interface/usecases/transforming_coordinate_systems.html">see OSI coordinate system definition</a>)
11541153
//
11551154
// Offset: 40 (12 bytes)
11561155
//
11571156
// * \c direction_of_departure_hitpoint - float32[3] (meters):
11581157
//
1159-
// Coordinates of the DoD (first hitpoint) in the raytracer's
1158+
// Coordinates of the DoD (first hitpoint) in the ray tracer's
11601159
// coordinate system defined by the mounting position.
11611160
//
11621161
// Order: x, y, z
11631162
//
1164-
// Coordinate system: right-handed ([see OSI coordinate system definition](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/interface/usecases/transforming_coordinate_systems.html))
1163+
// Coordinate system: right-handed (<a href="https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/interface/usecases/transforming_coordinate_systems.html">see OSI coordinate system definition</a>)
11651164
//
11661165
// Offset: 52 (12 bytes)
11671166
//
11681167
// /par Reference
11691168
// [1] Brem, R., & Eibert, T. F. (2015, August). A Shooting and Bouncing Ray (SBR) Modeling Framework Involving Dielectrics and Perfect Conductors. IEEE Transactions on Antennas and Propagation, 63(8), 3599-3609. https://doi.org/10.1109/TAP.2015.2438318
11701169
//
1171-
RAYTRACER_FORMAT_SBR = 2;
1172-
}
1170+
RAY_TRACER_FORMAT_SBR = 2;
1171+
}
11731172
}

0 commit comments

Comments
 (0)