eradiate.experiments.EarthObservationExperiment#
- class eradiate.experiments.EarthObservationExperiment(measures=_Nothing.NOTHING, integrator=_Nothing.NOTHING, results=_Nothing.NOTHING, default_spectral_set=AUTO, quad_spec=_Nothing.NOTHING, extra_objects=None, illumination=_Nothing.NOTHING)[source]#
Bases:
Experiment
,ABC
Abstract based class for experiments illuminated by a distant directional emitter.
- Parameters:
measures (
list
ofMeasure
orlist
ofdict
orMeasure
ordict
, default:MultiDistantMeasure()
) – List of measure specifications. The passed list may contain dictionaries, which will be interpreted bymeasure_factory
. Optionally, a singleMeasure
or dictionary specification may be passed and will automatically be wrapped into a list.integrator (
Integrator
ordict
, default:PathIntegrator()
) – Monte Carlo integration algorithm specification. This parameter can be specified as a dictionary which will be interpreted byintegrator_factory
.default_spectral_set (
BinSet
orWavelengthSet
orAUTO
, default:AUTO
) – Default spectral set. This attribute is used to set the default value forspectral_set
.If the value isAUTO
, the default spectral set is selected based on the active mode. Otherwise, the value must be aBinSet
orWavelengthSet
instance.extra_objects (
dict
orNone
, default:None
) – Dictionary of extra objects to be added to the scene. The keys of this dictionary are used to identify the objects in the kernel dictionary.illumination (
DirectionalIllumination
ordict
, default:DirectionalIllumination()
) – Illumination specification. This parameter can be specified as a dictionary which will be interpreted byillumination_factory
.
- Fields:
measures (
list
ofMeasure
) – List of measure specifications.default_spectral_set (
BinSet
orWavelengthSet
) – Default spectral set.extra_objects (
dict
) – Dictionary of extra objects to be added to the scene.illumination (
DirectionalIllumination
) – Illumination specification.
- clear()#
Clear previous experiment results and reset internal state.
- pipeline(measure)[source]#
Return the post-processing pipeline for a given measure.
- spectral_indices(measure_index)[source]#
Generate spectral indices for a given measure.
- Parameters:
measure_index (
int
) – Measure index for which spectral indices are generated.- Yields:
SpectralIndex
– Spectral index.
- property context_init#
Return a single context used for scene initialization.
- property contexts#
Return a list of contexts used for processing.
- property integrator#
Integrator used to solve the radiative transfer equation.
- Type:
- property results#
Post-processed simulation results.
- Returns:
dict[str
,Dataset]
– Dictionary mapping measure IDs to xarray datasets.
- property scene#
Return a scene object used for kernel dictionary template and parameter table generation.
- property spectral_set#
A dictionary mapping measure index to the associated spectral set.