3.2.2. Show Cycles

hysteresis.defaultPlotFuncs.defaultShowCycles(self, x, y, plotCycles, plotPeaks, labelCycles=[], Cycles=[])[source]

A function that plots the location of the reversal points and peaks for a curve object.

Parameters:

  • x (array) – The input x values as an numpy array.

  • y (array) – The input y values as an numpy array.

  • plotCycles (bool) – A switch that specifics if cycle reversal points should be plotted.

  • plotPeaks (bool) – A switch that specifics if peak values should be plotted.

  • labelCycles (list or 'all', optional) – A list of the cycles to be labled. A value of ‘all’ can also be specified, in which case all cucles will be plotted. The default is [], which labels no cycles

  • Cycles (kist, optional) – A list of the cycles to be plotted. If not specified, all values will be plotted. The default is [], which plots all cycles.