Modal wave period

This function computes the modal period for a set of hs/tp The modal period is taken as the mean period of the top 5% of wave height

Parameters

Hsstr

Name of the column containing significant wave height.

Tp: str

Name of the column containing the wave period.

args: dict

Dictionnary with the folowing keys:

folder out: str

Path to save the output

Time blocking: str

if Time blocking=='South hemisphere(Summer/Winter)',

Statistics will be calculated for South hemisphere summer and winter seasons

if Time blocking=='South hemisphere 4 seasons',

Statistics will be calculated for each South hemisphere seasons

if Time blocking=='North hemishere(Summer/Winter)',

Statistics will be calculated for North hemisphere summer and winter seasons

if Time blocking=='North hemisphere 4 seasons',

Statistics will be calculated for each North hemisphere seasons

if Time blocking=='North hemisphere moosoon(SW,NE,Hot season)',

Statistics will be calculated for the North hemisphere moonsoon seasons

Examples:

>>> df=tf['test1']['dataframe'].Statistics.modal_wave_period(Hs='hs',Tp='tp')
>>> 

Outputs:

Modal wave period probability

	Modal wave period
January
February