_images/calypso.png

Thermocline plot

This function provides a plot of parameter versus water depth. This function average the timeseries ( by mean, median …)

Notes

Variables MUST be in the format *_lev_1,*_lev_2 etc..

Parameters

maglist

Name of the column from which to get stats.

args: dict

Dictionnary with the folowing keys: function: str

Statistics to use to process each level: can be Max,`Mean`,`Median`,`Min`,`Percentile`,`Prod`,`Quantile`,`Std`,`Sum` or Var

‘percentile or Quantile’: float

Percetile or quantile to use

X label: str

Label for the X axis

display: str

On or Off to display image

table: str

On or Off to print result in a table

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.plot_thermocline(mag=['U_lev_1','U_lev_2'],args={'function':'Mean',time blocking':'Yearly'})
>>>