eradiate.pipelines.Gather
eradiate.pipelines.Gather#
- class eradiate.pipelines.Gather(prefix='.*', sensor_dims=_Nothing.NOTHING, var='img')[source]#
Bases:
eradiate.pipelines._core.PipelineStep
Gather raw kernel results (output as nested dictionaries) into an xarray dataset.
This pipeline step takes a nested dictionary produced by the spectral loop of an
Experiment
and repackages it as aDataset
. The top-level spectral index is mapped to mode-dependent spectral coordinates. Results from the sensors part of a single measurement are mapped to specified sensor dimensions, which can then be further processed by aggregation steps. Film dimensions are left unmodified and retain their metadata.An
img
variable holds sensor values. Anspp
variable holds sample count.- Parameters
prefix (
str
, optional, default:".*"
) – Prefix string used to match sensor IDs. The default value will match anything.sensor_dims (
list
of(str
ortuple)
, optional, default:[]
) – List of sensor dimensions. Each list item can be a string or a (dimension, metadata) pair.var (
str
ortuple[str
,dict]
, optional, default:"img"
) – Name of the variable containing sensor data. Optionally, a (name, metadata) pair can be passed.
- Fields