oemStateCovmatCorrelateConstant

Workspace.oemStateCovmatCorrelateConstant(self, oem: OptimalEstimationData = self.oem, jac_targets: JacobianTargets = self.jac_targets, atm_field: AtmField = self.atm_field, target1: AtmKey | QuantumLevelIdentifier | ScatteringSpeciesProperty | SpeciesEnum | SpeciesIsotope, target2: AtmKey | QuantumLevelIdentifier | ScatteringSpeciesProperty | SpeciesEnum | SpeciesIsotope, correlation: Numeric) → None

Correlate matching grid points of two atmospheric retrieval targets with a constant coefficient.

Requires finalized targets, identical physical grids and diagonal marginal covariances, with one state coordinate per grid point. The cross covariance is correlation times the product of the existing standard deviations. The coefficient is the same at every grid point; the covariance can vary with the marginal variances. Different grid points are not cross-correlated. Marginal variances are unchanged. The coefficient refers to retrieval coordinates: for logarithmic water it correlates temperature with log-water.

The coefficient must be finite and strictly between -1 and 1. An existing cross block for this pair is replaced; zero removes it. The complete candidate covariance is validated before assignment. Failure leaves the input unchanged; success discards cached inverses. Other existing correlations are preserved.

Warning

Automatic size constraints are not checked for this method. Group-invariant checks on read-only inputs still apply.

Author: Richard Larsson

Parameters: