eradiate.scenes.illumination.DirectionalIllumination
eradiate.scenes.illumination.DirectionalIllumination#
- class eradiate.scenes.illumination.DirectionalIllumination(id='illumination', zenith=<Quantity(0.0, 'degree')>, azimuth=<Quantity(0.0, 'degree')>, azimuth_convention=None, irradiance=_Nothing.NOTHING)[source]#
Bases:
eradiate.scenes.illumination._core.Illumination
Directional illumination scene element [
directional
].The illumination is oriented based on the classical angular convention used in Earth observation.
- Parameters
id (
str
, optional, default:"illumination"
) – User-defined object identifier.zenith (
quantity
orfloat
, default:0.0 deg
) – Zenith angle.Unit-enabled field (default units: ucc[angle]).
azimuth (
quantity
orfloat
, default:0.0 deg
) – Azimuth angle value.Unit-enabled field (default units: ucc[angle]).
azimuth_convention (
AzimuthConvention
orstr
, optional, default:None
) – Azimuth convention. IfNone
, the global default configuration is used (seeEradiateConfig
).irradiance (
Spectrum
ordict
orfloat
, default:SolarIrradianceSpectrum()
) – Emitted power flux in the plane orthogonal to the illumination direction. Must be an irradiance spectrum (in W/m²/nm or compatible unit). Can be initialised with a dictionary processed bySpectrumFactory.convert()
.
- Fields
- kernel_dict(ctx)[source]#
Return a dictionary suitable for kernel scene configuration.
- Parameters
ctx (
KernelDictContext
) – A context data structure containing parameters relevant for kernel dictionary generation.- Returns
KernelDict
– Kernel dictionary which can be loaded as a Mitsuba object.
- property direction#
Illumination direction as an array of shape (3,), pointing inwards.