eoio.processors.s2_rut.processor module

eoio.processors.s2_rut.processor

Top-level S2 RUT processor.

This processor provides a single, stable user-facing interface (s2_rut).

User config example

processors = {

“s2_rut”: {

“data_vars”: [“B02”], },

}

class eoio.processors.s2_rut.processor.S2RUTConfig(data_vars: Sequence[str] | None = None, group_unc: bool | None = True, subset_unc: Sequence[str] | None = None, on_missing: str = 'error')

Bases: object

Parameters for the S2 RUT processor.

data_vars: Sequence[str] | None = None

group_unc: bool | None = True

on_missing: str = 'error'

subset_unc: Sequence[str] | None = None

class eoio.processors.s2_rut.processor.S2Rut(params: Dict[str, Any] | None = None, context: Dict[str, Any] | None = None)

Bases: BaseProcessor

Run Sentinel-2 Radiometric Uncertainty Tool (RUT) on a dataset.

Processor parameters

The following parameters can be provided in the params dict:

param data_vars:

List of variable names to run RUT for. If omitted, run for all measurement variables (bands) in the dataset.

param group_unc:

Whether to group uncertainty contributors in to components - random, systematic. Default is True.

param subset_unc:

List of uncertainty variables to include in the output dataset. If omitted, include all uncertainty variables.

param on_missing:

Behaviour if required metadata for conversion is missing. Supported values are "error" (default, if omitted) or "skip".

Notes

• This processor is intended to run after reading.

name = 's2_rut'

run(ds: Dataset) → Dataset

Run uncertainty tool (S2 RUT) on the dataset.

Parameters:

ds – Input dataset.

Returns:

Output obsarray dataset with uncertainty variables.