pyPDAF.PDAF.diag_variance

pyPDAF.PDAF.diag_variance(dim_p: int, dim_ens: int, state_p: np.ndarray, ens_p: np.ndarray, do_mean: int, do_stddev: int, comm_filter: int) → Tuple[np.ndarray, np.ndarray, float, int]

Compute ensemble variance/standard deviation and mean.

Parameters:

  • dim_p (int) – state dimension

  • dim_ens (int) – Ensemble size

  • state_p (ndarray[np.float64, ndim=1]) – State vector Array shape: (dim_p)

  • ens_p (ndarray[np.float64, ndim=2]) – State ensemble Array shape: (dim_p, dim_ens)

  • do_mean (int) – Whether to compute ensemble mean

  • do_stddev (int) – Whether to compute the ensemble mean standard deviation

  • comm_filter (int) – Filter communicator

Returns:

  • state_p (ndarray[np.float64, ndim=1]) – State vector Array shape: (dim_p)

  • variance_p (ndarray[np.float64, ndim=1]) – Variance state vector Array shape: (dim_p)

  • stddev_g (double) – Global standard deviation of ensemble

  • status (int) – Status flag (0=success)