eradiate.pipelines.AddIllumination#
- class eradiate.pipelines.AddIllumination(illumination, measure, irradiance_var='irradiance')[source]#
Bases:
PipelineStep
Add illumination data.
This post-processing pipeline step adds illumination data:
if illumination is a
DirectionalIllumination
instance, then a data variable (holding the incoming top-of-scene flux with respect to a horizontal surface) is created, with dimensionssza
andvaa
;if illumination is a
ConstantIllumination
instance, then the created data variable has no coordinate.
- Parameters:
illumination (
DirectionalIllumination
orConstantIllumination
) – AnIllumination
instance from which the illumination data originates.measure (
Measure
) – AMeasure
instance from the data originates.irradiance_var (
str
, default:"irradiance"
) – Name of the variable storing irradiance (incoming flux) values.
- Fields:
illumination (
DirectionalIllumination
orConstantIllumination
) – AnIllumination
instance from which the illumination data originates.measure (
Measure
) – AMeasure
instance from the data originates.irradiance_var (
str
) – Name of the variable storing irradiance (incoming flux) values.