pyesmda.get_ensemble_variance#

pyesmda.get_ensemble_variance(ensemble: ndarray[tuple[Any, ...], dtype[float64]]) ndarray[tuple[Any, ...], dtype[float64]][source]#

Get the given ensemble variance (diagonal terms of the covariance matrix).

Parameters:

ensemble (NDArrayFloat) – Ensemble of realization with diemnsions (\(N_{m}, N_{e}\)), $N_{m}$) and $N_{e}$ being the ensemble size and one member size respectively.

Returns:

The variance as a 1d array.

Return type:

NDArrayFloat

Raises:

ValueError – If the ensemble is not a 2D matrix.