pycif.plugins.modes.footprint — API reference

Configuration reference: footprint plugin

pycif.plugins.modes.footprint.execute.execute(self, **kwargs)

Run the observation operator in adjoint (footprint / backward) mode.

Sets the observation-vector increment dy to the configured value (or to the existing sim_tl column when no explicit increment is given), zeros out non-observed locations, then calls the obs-operator in adjoint mode to propagate the sensitivity back to the control space.

Parameters:

• self (Plugin) – mode plugin providing workdir, datei, datef, use_xb, and optionally increments.

• **kwargs – forwarded verbatim to the observation operator.

Returns:

the control vector populated with adjoint sensitivities.

Return type:

ControlVect