open_simulation_interface  master (2c3953b)
osi3::EnvironmentalConditions::Sun Struct Reference

Properties of the sun. More...

Collaboration diagram for osi3::EnvironmentalConditions::Sun:

Public Attributes

optional double azimuth = 1
 Azimuth of the sun, counted counterclockwise. More...
 
optional double elevation = 2
 Solar elevation angle. More...
 
optional double intensity = 3
 Illuminance of the sun, direct sunlight is around 100000 lx. More...
 

Detailed Description

Properties of the sun.

Member Data Documentation

◆ azimuth

optional double osi3::EnvironmentalConditions::Sun::azimuth = 1

Azimuth of the sun, counted counterclockwise.

0 pointing north. If north is not explicitly defined via osi3::GroundTruth::proj_string, then north is pointing in y-axis direction. The default orientation (x, y, z) is easting, northing, up [1]. The point of observation is defined to be the global coordinate system's origin.

Note
0: north; +pi/2: west; pi: south, 3/2 pi: east.

Unit: rad

The preferred angular range is [0, 2pi].

References:
[1] PROJ contributors. (2019). PROJ coordinate transformation software library. Open Source Geospatial Foundation. Retrieved January 25, 2019, from https://proj.org/usage/projections.html

◆ elevation

optional double osi3::EnvironmentalConditions::Sun::elevation = 2

Solar elevation angle.

The elevation angle is positive when the sun is above the xy-plane, negative when the sun is below the xy-plane. The point of observation is defined to be the global coordinate system's origin.

Note
0: xy-plane; +pi/2: zenith; -pi/2: nadir.

Unit: rad

The preferred angular range is [-pi/2, +pi/2].

◆ intensity

optional double osi3::EnvironmentalConditions::Sun::intensity = 3

Illuminance of the sun, direct sunlight is around 100000 lx.

Unit: lx

Rules\n\code{.unparsed}
is_greater_than_or_equal_to: 0

The documentation for this struct was generated from the following file: