toto.plugins.woodside.woodside_statistics

class toto.plugins.woodside.woodside_statistics.Woodside(pandas_obj)

Bases: object

extreme_analysis(wind_speed10='wind_speed10', wind_drr='wind_drr', hs='hs', tp='tp', tm02='tm02', dpm='dpm', surface_current='surface_current', surface_drr='surface_drr', midwater_current='midwater_current', midwater_drr='midwater_drr', bottom_current='bottom_current', bottom_drr='bottom_drr', args={'Directional switch': {'Off': False, 'On': True}, 'Display': {'Off': False, 'On': True}, 'Water depth': 5000.0, 'folder out': '/home/docs/checkouts/readthedocs.org/user_builds/totodoc/checkouts/latest/docs', 'return_period': [1, 5, 10, 20, 50, 100, 200, 500, 1000]})

This function is used for extreme value analysis of any type. It generates return period values for Wind,Wave and Currents

joint_probability(speed='speed', direction='direction', period='period', args={'Direction binning': {'centered': True, 'not-centered': False}, 'Direction interval': 45.0, 'Probablity expressed in': {'per thoushand': True, 'percent': False}, 'Time blocking': {'Annual': True, 'Monthly': False, 'Seasonal (North hemisphere)': False, 'Seasonal (South hemisphere)': False}, 'X Min Res Max(optional)': [2, 1, 22], 'Y Min Res Max(optional)': [0, 0.5], 'folder out': '/home/docs/checkouts/readthedocs.org/user_builds/totodoc/checkouts/latest/docs', 'method': {'Mag vs Dir': True, 'Mag vs Per': False, 'Per Vs Dir': False}})

This function provides joint distribution tables for X and Y, i.e. the probability of events defined in terms of both X and Y (per 1000) It can be applied for magnitude-direction, magnitude-period or period-direction

persistence_probability(data='data', args={'Duration Min Res Max': [6, 6, 72], 'Exceedance bins: Min Res Max(optional)': [2, 1, 22], 'Time blocking': {'Annual': True, 'Monthly': False, 'Seasonal (North hemisphere)': False, 'Seasonal (South hemisphere)': False}, 'folder out': '/home/docs/checkouts/readthedocs.org/user_builds/totodoc/checkouts/latest/docs', 'method': {'exceedence': True, 'non-exceedence': False}})

This function calculates the frequency of occurrence of data: -exceeding specific values (exceedence) -non-exceeding specific values (non-exceedence) -exceeding specific values during a specific duration (persistence exceedence) -non-exceeding specific values during a specific duration (persistence non-exceedence)

woodside_statistics(mag=['mag'], drr='drr', args={'Minimum occurrence (main direction) [%]': 15, 'folder out': '/home/docs/checkouts/readthedocs.org/user_builds/totodoc/checkouts/latest/docs', 'type': {'North hemishere(Summer/Winter)': False, 'North hemisphere 4 seasons': False, 'North hemisphere moosoon(SW,NE,Hot season)': False, 'South hemisphere 4 seasons': False, 'South hemisphere(Summer/Winter)': True}})

output stats from timesereis)