pypomp.Pomp.ESS

Pomp.ESS(index: int = -1, average: bool = False) → DataFrame

Return effective sample sizes from a particle filter run.

Parameters:

  • index (int, optional) – Position in results_history to retrieve. Defaults to -1 (the most recent run). The indexed result must be a pfilter() result with ESS=True.

  • average (bool, optional) – If True, average the ESS over replicates using arithmetic mean. Defaults to False.

Returns:

Tidy DataFrame of ESS values. The columns appear in the following order:

  1. theta_idx: The index of the parameter set.

  2. rep: The replicate index (only if average=False).

  3. time: The observation time point.

  4. ESS: The Effective Sample Size value.

Return type:

pd.DataFrame