eradiate.pipelines.AddIllumination#

class eradiate.pipelines.AddIllumination(illumination, measure, irradiance_var='irradiance')[source]#

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 dimensions sza and vaa;
if illumination is a ConstantIllumination instance, then the created data variable has no coordinate.

Parameters

illumination (DirectionalIllumination or ConstantIllumination) – An Illumination instance from which the illumination data originates.
measure (Measure) – A Measure instance from the data originates.
irradiance_var (str, default: "irradiance") – Name of the variable storing irradiance (incoming flux) values.

Fields

illumination (DirectionalIllumination or ConstantIllumination) – An Illumination instance from which the illumination data originates.
measure (Measure) – A Measure instance from the data originates.
irradiance_var (str) – Name of the variable storing irradiance (incoming flux) values.

transform(x)[source]#

Apply the pipeline step to a given data.