wavespectra.partition.partition.Partition.ptm5#

Partition.ptm5(fcut, interpolate=True)[source]#

PTM5 SWAN partitioning of sea and swell based on user-defined threshold.

PTM5 splits spectra into wind sea and swell based on a user defined static cutoff. This method differs from split in that here the output partitioned spectra dataset has an extra part dimension and the sea and swell partitions have zero-values outside the defined frequency ranges. Conversely, split returns a single partition with frequencies truncated to the defined ranges. Notice there could be slight differences when integrating the partitions generated by these two methods since in PTM5 there will be an “area” at one of the frequency adges adjacent to the zero-values.

Args:

  • fcut (float): Frequency cutoff (Hz).

  • interpolate (bool): Interpolate spectra at fcut if it is not an exact frequency in the dset.

Returns:

  • dspart (xr.Dataset): Partitioned spectra with extra part dimension where the 0th index is the wind sea and the 1st index is the swell.

Note:

  • Spectra are interpolated at fcut if this frequency is not in dset and interpolate is set to True which implies the frequency coordinates will be different between the input and the output.

References:
On this page