_images/calypso.png

Percentage of occurence plot

This function provides percentage of occurnce from any variable. plot are directional if direction is supplied

Parameters

magstr

Name of the column from which to get stats.

drrstr

Column name representing the directions.

args: dict

Dictionnary with the folowing keys: title: str

Graph title

magnitude interval (optional): list

interval to use for the magnitude

X label: str

Label for the X axis

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

display: str

On or Off to display image

folder out: str

Path to save the output

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 South hemisphere seasons

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

Statistics will be calculated for North hemisphere seasons

if Time blocking=='Monthly',

Statistics will be calculated for each month.

Examples:

>>> df=tf['test1']['dataframe'].StatPlots.Percentage_of_occurence(mag='U',drr='drr',args={'time blocking':'Yearly'})
>>>