Skip to content

Commit 7a54ed5

Browse files
committed
Changes in the description based on the CCB review.
Signed-off-by: @lukas.elster <lukas.elster@tu-darmstadt.de>
1 parent d2457f2 commit 7a54ed5

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

osi_object.proto

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -275,51 +275,61 @@ message StationaryObject
275275
}
276276

277277
//
278-
// \brief Attributes of type emitting structure
278+
// \brief Attributes of type emitting structure. The horizontal_angle and the vertical_angle in
279+
// emitted_spatial_intensity are symmetrical across the normal, which is defined by the mounting position
280+
// of the emitting structure.
279281
//
280282
message EmittingStructureAttribute
281283
{
282-
// This message determines the range of the wavelength and its
284+
// This message determines the range of the emitted wavelength and its
283285
// desired number of samples.
284286
//
285287
repeated WavelengthData wavelength_data = 1;
286288

287289
// Original intensities of emitted electromagnetic wave referred to a discrete
288-
// wavelength defined in WavelengthData. This maximum value is weighted based on the IntensityDistribution.
290+
// wavelength defined in WavelengthData. This maximum value is weighted based
291+
// on the emitted spatial intensity. The size of max_intensitiy_per_wavelength has to be
292+
// equal to the samples in wavelength_data.
289293
//
290294
// Unit: W/m^2
291295
//
292296
// \note max_intensity_per_wavelength.size() = WavelengthData.samples_number.size()
293297
//
294298
repeated double max_intensity_per_wavelength = 2;
295299

296-
// Distribution of the emitted electromagnetic wave's intensity based on the intensity_per_wavelength as
297-
// maximum value.
300+
// Spatial distribution of the emitted electromagnetic wave's intensity based on the intensity_per_wavelength as
301+
// maximum value. For every sample in wavelength_data an emitted_spatial_intensity has to be defined.
298302
//
299-
repeated IntensityDistribution emitted_intensity_distribution = 3;
303+
// \note emitted_spatial_intensity.size() = WavelengthData.samples_number.size()
304+
//
305+
repeated SpatialIntensity emitted_spatial_intensity = 3;
300306

301307
//
302-
// \brief Definition of a intensity distribution with a horizontal and a vertical angle
303-
// and the corresponding intensity
308+
// \brief Definition of a spatial intensity distribution with a horizontal and a vertical angle
309+
// and the corresponding intensity related to a maximum intensity.
304310
//
305-
message IntensityDistribution
311+
message SpatialIntensity
306312
{
307313
// Horizontal deflection (azimuth) of emission in emitting object
308314
// coordinate system.
309315
//
310316
// Unit: rad
317+
//
311318
optional double horizontal_angle = 1;
312319

313320
// Vertical deflection (elevation) of emission in emitting object
314321
// coordinate system.
315322
//
316323
// Unit: rad
324+
//
317325
optional double vertical_angle = 2;
318326

319-
// Emitted intensity of emitting object at this point for one specific wavelength.
320-
// The value corresponds to the intensity defined in max_intensity_per_wavelength.
327+
// Emitted intensity of emitting object at the previously defined horizontal_angle and
328+
// vertical angle for one specific wavelength. The value corresponds to the intensity
329+
// defined in max_intensity_per_wavelength.
321330
//
322331
// Unit: %
332+
//
323333
optional double relative_intensity = 3;
324334
}
325335
}

0 commit comments

Comments
 (0)