HCplane#
- peccary.HCplots.HCplane(H=None, C=None, ax=None, n=5, nsteps=1000, fontsize=12, showAxLabels=True, showBoundaries=True, annotatePlane=False, savePlot=False, savePath='', kwargsFig={'figsize': (8, 6)}, kwargsHC={'color': 'k', 'ls': '-', 'zorder': 0}, kwargsBnds={}, kwargsPts={}, annotateFontsize=None)[source]#
Plot \(HC\)-plane upper and lower allowed bounds, as well as \([H,C]\) coordinates and/or region annotations, if specified. If no Matplotlib axis is specified, it will return Matplotlib figure and axis instances.
- Parameters:
- Hndarray, optional
Permutation Entropy values, by default None
- Cndarray, optional
Statistical Complexity values, by default None
- axMatplotlib axis
Axis on which to plot empty HC curves
- nint, optional
Sampling size, by default 5
- nstepsint, optional
Number of steps to use for generating HC bounding curves, by default 1000
- fontsizeinteger or float, optional
Fontsize of axis labels, by default 12
- showAxLabelsbool, optional
Show pre-defined axis labels, by default True
- showBoundariesbool, optional
Show HC plane boundary lines, by default True
- annotatePlanebool, optional
Annotate HC plane regions, by default False
- savePlotbool, optional
Saves HC 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 HC plane figure and axis passed to
matplotlib.pyplot.subplots, if none given uses PECCARY defaults- kwargsHCdict, optional
Style arguments for HC plane envelope lines passed to
matplotlib.pyplot.plot, if none given uses PECCARY defaults- kwargsBndsdict, optional
Style arguments for region boundary lines passed to
matplotlib.pyplot.plot, 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- annotateFontsizefloat, optional
Fontsize for HC plane regions annotations, by default None