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:
Fields:
  • measures (list of Measure) – List of measure specifications.

  • default_spectral_set (BinSet or WavelengthSet) – 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.

init()[source]#

Generate kernel dictionary and initialise Mitsuba scene.

pipeline(measure)[source]#

Return the post-processing pipeline for a given measure.

Parameters:

measure (Measure or int) – Measure for which the pipeline is generated.

Returns:

hamilton.driver.Driver

postprocess()[source]#

Post-process raw results and store them in results.

process(spp=0, seed_state=None)[source]#

Run simulation and collect raw results.

Parameters:
  • spp (int, optional) – Sample count. If set to 0, the value set in the original scene definition takes precedence.

  • seed_state (SeedState, optional) – Seed state used to generate seeds to initialize Mitsuba’s RNG at every iteration of the parametric loop. If unset, Eradiate’s root seed state is used.

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:

Integrator

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.