array2sampled/std array2sampled/std#
Description#
array2sampled transform: sample a gridded model field at observation locations.
Converts a model output array of shape (time, lev, lat, lon) to a
sparse observation-indexed DataFrame by extracting the model value at
each observation’s (i, j, level, tstep) index.
Forward: grid array → sparse simulated observations. Adjoint: scatter observation-space sensitivities back onto the grid
(atomic add via
np.add.at).
This transform is typically placed between loadfromoutputs and
toobsvect when the model provides gridded output fields.
The output tracer is the same (component, parameter) as the input by
default; it can be renamed via component_out / parameter_out.
YAML arguments#
The following arguments are used to configure the plugin. pyCIF will return an exception at the initialization if mandatory arguments are not specified, or if any argument does not fit accepted values or type:
Optional arguments#
- parameter : str, optional
Parameter name on which the transform works on
- component : str, optional
Component name on which the transform works on
- orig_parameter_plg : Plugin, optional
Plugin object on which the transform works on
- orig_component_plg : Plugin, optional
Corresponding component object on which the transform works on
- successor : str, optional
Name of the successor transform
- precursor : str, optional
Name of the precursor transform
- component_out : str, optional
Component of the output (sampled) tracer. Defaults to the input component if not specified.
- parameter_out : str, optional
Name of the output (sampled) tracer. Defaults to the input parameter if not specified.
YAML template#
Please find below a template for a YAML configuration:
1transform:
2 plugin:
3 name: array2sampled
4 version: std
5 type: transform
6
7 # Optional arguments
8 parameter: XXXXX # str
9 component: XXXXX # str
10 orig_parameter_plg: XXXXX # Plugin
11 orig_component_plg: XXXXX # Plugin
12 successor: XXXXX # str
13 precursor: XXXXX # str
14 component_out: XXXXX # str
15 parameter_out: XXXXX # str
See also