SPOD

modulo_vki.modulo.ModuloVKI.SPOD(self, mode: str, F_S: float, n_Modes: int = 10, SAVE_SPOD: bool = True, **kwargs)

Unified Spectral POD interface.

Parameters:
  • mode ({'sieber', 'towne'}) – Which SPOD algorithm to run.

  • F_S (float) – Sampling frequency [Hz].

  • n_Modes (int, optional) – Number of modes to compute, by default 10.

  • SAVE_SPOD (bool, optional) – Whether to save outputs, by default True.

  • **kwargs

    For mode=’sieber’, accepts:
    • N_O (int): semi-order of the diagonal filter

    • f_c (float): cutoff frequency

    For mode=’towne’, accepts:
    • L_B (int): block length

    • O_B (int): block overlap

    • n_processes (int): number of parallel workers

Returns:

  • Phi (ndarray) – Spatial modes.

  • Sigma (ndarray) – Modal amplitudes.

  • Aux (tuple) – Additional outputs.