pyPDAF.PDAF.set_smoother_ens¶
- pyPDAF.PDAF.set_smoother_ens()¶
Get a pointer to smoother ensemble.
When smoother is used, the smoothed ensemble states at earlier times are stored in an internal array of PDAF. To be able to smooth post times, the smoother algorithm must have access to the past ensembles.
In this function, the user can obtain a numpy array of smoother ensemble. This array has the same memory address as the internal PDAF smoother ensemble array. This allows for manual modification of the smoother ensemble.
In the offline mode the user has to manually fill the smoother ensemble array from ensembles read in from files. This function is typically called in
py__init_ens_pdaf()
in the call topyPDAF.PDAF.PDAF_init()
.In the online mode, the smoother array is filled automatically during the cycles of forecast phases and analysis steps.
- Parameters:
maxlag (int) – Number of past timesteps in sens
- Returns:
sens_point (ndarray[np.float64, ndim=3]) – Pointer to smoother array Array shape: (:,:,:)
status (int) – Status flag,