eradiate.experiments.Experiment#
- class eradiate.experiments.Experiment(measures=NOTHING, integrator=AUTO, results=NOTHING, background_spectral_grid=AUTO, ckd_quad_config=NOTHING)[source]#
Bases:
ABC
Abstract base class for all Eradiate experiments. An experiment consists of a high-level scene specification parametrized by natural user input, a processing and post-processing pipeline, and a result storage data structure.
- 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
orAUTO
, default:AUTO
) – Monte Carlo integration algorithm specification. This parameter can be specified as a dictionary which will be interpreted byintegrator_factory
.The integrator defaults toAUTO
, which will choose the appropriate integrator depending on the experiment’s configuration.background_spectral_grid (
SpectralGrid
orAUTO
, default:AUTO
) – Background spectral grid. If the value isAUTO
, the background spectral grid is automatically generated depending on the active mode and internal experiment constraints. Otherwise, the value must be convertible to aSpectralGrid
instance.ckd_quad_config (
CKDQuadConfig
ordict
) – CKD quadrature rule generation configuration.
- Fields:
measures (
list
ofMeasure
) – List of measure specifications.integrator (
Integrator
orAUTO
) – Monte Carlo integration algorithm specification.ckd_quad_config (
CKDQuadConfig
) – CKD quadrature rule generation configuration.
- abstract pipeline(measure)[source]#
Return the post-processing pipeline for a given measure.
- abstract process(spp=0, seed_state=None)[source]#
Run simulation and collect raw results.
- Parameters:
- property ckd_quads#
A dictionary mapping measure index to the associated CKD quadrature rule (if relevant).
- abstract property context_init#
Return a single context used for scene initialization.
- abstract property contexts#
Return a list of contexts used for processing.
- property results#
Post-processed simulation results.
- Returns:
dict[str
,Dataset]
– Dictionary mapping measure IDs to xarray datasets.
- property spectral_grids#
A dictionary mapping measure index to the associated spectral grid.