HCcurves#
- peccary.HCplots.HCcurves(H=None, C=None, sampInts=None, axes=None, fontsize=12, showAxLabels=True, savePlot=False, savePath='', kwargsFig={'figsize': (10, 4)}, kwargsPts={}, orientation='horizontal', tPatAx=False, dt=None, n=5)[source]#
Plots H- and C-curves or sets up blank figure for plotting H- and C- curves.
- Parameters:
- Hndarray, optional
Permutation Entropy values corresponding to array of sampling intervals, by default None
- Cndarray, optional
Statistical Complexity values corresponding to array of sampling intervals, by default None
- sampIntsndarray, optional
Array of sampling intervals, by default None
- axesList of Matplotlib axess
Axes H- and C- curves
- fontsizeinteger or float, optional
Fontsize of axis labels, by default 12
- showAxLabelsbool, optional
Show pre-defined axis labels, by default True
- savePlotbool, optional
Saves plot if set to True, by default False
- savePathstr, optional
Path to save plot if savePlot set to True, by default ‘’ Note: Use only forward slashes in savePath
- kwargsFigdict, optional
Style arguments for figure and axis passed to
matplotlib.pyplot.subplots, if none given uses PECCARY defaults- kwargsPtsdict, optional
Style arguments for [H,C] values plotted on HC-plane with
matplotlib.pyplot.scatter, if none given uses PECCARY defaults- orientationstr, optional
Choose between 1 row x 2 column orientation (‘horizontal’) or 2 rows x 1 column (and shared x axis) orientation (‘vertical’), by default ‘horizontal’
- tPatAxboolean, optional
Choose whether to plot secondary x-axis with pattern timescale values, by default False
- dtfloat, optional
Timestep or timeseries resolution, only needed if tPatAx is True, by default None
- nint, optional
Sampling size, only needed if tPatAx is True, by default 5
- Raises:
- TypeError
If tPatAx is True, dt must be a float