wavespectra.SpecArray.stats#

SpecArray.stats(stats, fmin=None, fmax=None, dmin=None, dmax=None, names=None)[source]#

Calculate multiple spectral stats into a Dataset.

Parameters:
  • stats (-) – strings specifying stats to be calculated. (dict): keys are stats names, vals are dicts with kwargs to use with corresponding method.

  • fmin (-) – lower frequencies for splitting spectra before calculating stats.

  • fmax (-) – upper frequencies for splitting spectra before calculating stats.

  • dmin (-) – lower directions for splitting spectra before calculating stats.

  • dmax (-) – upper directions for splitting spectra before calculating stats.

  • names (-) – strings to rename each stat in output Dataset.

Returns:

  • Dataset with all spectral statistics specified.

Note

  • All stats names must correspond to methods implemented in this class.

  • If names is provided, its length must correspond to the length of stats.