pyPDAF.PDAF.SampleEns

pyPDAF.PDAF.SampleEns()

This function generates an ensemble from singular values and their vectors (EOF modes) centred on given mean state. The singular values and vectors are derived from the ensemble anomalies which can be obtained from a long model trajectory using pyPDAF.PDAF.eofcovar.

Parameters:

  • modes (ndarray[tuple[dim, dim_ens-1], np.float64]) –

    Array of EOF modes

    The1st-th dimension dim is Size of state vector;

  • svals (ndarray[tuple[dim_ens-1], np.float64]) – Vector of singular values

  • state (ndarray[tuple[dim], np.float64]) –

    PE-local model mean state

    The array dimension dim is Size of state vector.

  • verbose (int) – Verbosity flag

  • flag (int) – Status flag

Returns:

  • modes (ndarray[tuple[dim, dim_ens-1], np.float64]) – Array of EOF modes

    The 1st-th dimension dim is Size of state vector

  • state (ndarray[tuple[dim], np.float64]) – PE-local model mean state

    The array dimension dim is Size of state vector

  • ens (ndarray[tuple[dim, dim_ens], np.float64]) – State ensemble

    The 1st-th dimension dim is Size of state vector The 2nd-th dimension dim_ens is Size of ensemble

  • flag (int) – Status flag