JP plot¶

This function provides joint distribution graph for X and Y, i.e. the probability of events defined in terms of both X and Y (per 1000)

Parameters¶

Xstr

Name of the column to plot on the X axis.

Ystr

Name of the column to plot on the Y axis.

args: dict

Dictionnary with the folowing keys: X Min Res Max(optional): list

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

Y Min Res Max(optional): list

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

X label: str

Label for the X axis

Y label: str

Label for the Y axis

display: str

On or Off to display image

folder out: str

Path to save the output

probablity expressed in:

Can be percent or per thoushand

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.

>>> df=tf['test1']['dataframe'].StatPlots.plot_thermocline(mag=['U_lev_1','U_lev_2'],args={'function':'Mean',time blocking':'Yearly'})
>>> 