_images/calypso.png

Exceedence coincidence probability

Exceedence and non-exceedence analysis co-incident with another parameter, similar to Joint-probability function but includes a cumulative sum to obtain exceedence or non-exceedence(in %).

Parameters

datastr

Name of the column from which to get stats.

coincident_with_dirstr

Column name representing the directions.

coincident_nodirstr

Column name representing another magnitude.

args: dict
Dictionnary with the folowing keys:
method: str

Name of the method to use, can be: exceedence non-exceedence

direction binning: str

Can be centered or not-centered depending if the directionnal are centered over 0

direction interval: int

Dirctionnal interval for the bins in degrees

folder out: str

Path to save the output

Probablity expressed in: str

This can be percent or per thoushand

Exceedance bins: Min Res Max(optional): list

Minimum, resolution and maximum value of X axis use in the join probability

Coincidence bins: Min Res Max(optional): list

Minimum, resolution and maximum value of Y axis use in the join probability

Time blocking: str
if Time blocking=='Annual',

Statistics will be calculated for the whole timeserie

if Time blocking=='Seasonal (South hemisphere)',

Statistics will be calculated for each South hemisphere seasons

if Time blocking=='Seasonal (North hemisphere)',

Statistics will be calculated for each North hemisphere seasons

if Time blocking=='Monthly',

Statistics will be calculated for each month

Examples:

>>> df=tf['test1']['dataframe'].Statistics.excedence_coincidence_probability(data='U',coincident_with_dir='drr',args={'direction interval':45,Time blocking':'Yearly'})
>>> 

Outputs:

Excedence coincidence probability

exceedence %

0.0-0.2

0.2-0.4

0.4-0.6

0.6-0.8

Total

>0.0

>0.2

>0.4