Illumination

Illumination models that define the incoming light conditions for a simulation, supporting both directional (sun-like) and spatially constant sources.

s2gos_simulator.config.illumination.Illumination pydantic-model

Bases: BaseModel

Base illumination configuration.

Fields:

• type (str)
• id (str)

Attributes

id pydantic-field

id: str = 'illumination'

Unique identifier

type pydantic-field

type: str

Illumination type

s2gos_simulator.config.illumination.DirectionalIllumination pydantic-model

Bases: Illumination

Directional illumination.

Fields:

• id (str)
• type (Literal['directional'])
• zenith (float)
• azimuth (float)
• irradiance_dataset (str)

Attributes

azimuth pydantic-field

azimuth: float = 180.0

Solar azimuth angle in degrees

irradiance_dataset pydantic-field

irradiance_dataset: str = 'thuillier_2003'

Solar irradiance dataset

type pydantic-field

type: Literal['directional'] = 'directional'

Illumination type (always 'directional')

zenith pydantic-field

zenith: float = 30.0

Solar zenith angle in degrees

Functions

from_date_and_location classmethod

from_date_and_location(
    time: datetime,
    latitude: float,
    longitude: float,
    irradiance_dataset: str = "thuillier_2003",
) -> "DirectionalIllumination"

Creates a DirectionalIllumination instance by calculating solar angles for a given time and location, and converting them to Eradiate conventions.

Parameters:

Name	Type	Description	Default
time	datetime	The date and time of the observation.	required
latitude	float	Observer's latitude in degrees.	required
longitude	float	Observer's longitude in degrees.	required
irradiance_dataset	str	Name of the solar irradiance dataset to use.	'thuillier_2003'

Returns:

Type	Description
'DirectionalIllumination'	A new DirectionalIllumination instance with corrected zenith and azimuth.

Raises:

Type	Description
ValueError	Likely the sun is below the horizon at the specified time.

s2gos_simulator.config.illumination.ConstantIllumination pydantic-model

Bases: Illumination

Constant uniform illumination.

Fields:

• id (str)
• type (Literal['constant'])
• radiance (float)

Attributes

radiance pydantic-field

radiance: float = 1.0

Constant radiance value

type pydantic-field

type: Literal['constant'] = 'constant'

Illumination type (always 'constant')