5.2. getAvgBackbone function

hysteresis.envelope.getAvgBackbone(hystersis, LPsteps=[], returnPeaks=False, returnEnd=False, skipStart=0, skipEnd=0)[source]

Returns the average, positve, and negative backbone curve of a hysteresis.

By default all reversal points on the backbone curve are returned. This will not be appropriate for some types of hysteresis where the load drops between cycles. The user can output only the first cycle of each load step by specifying the number of loading cycles there are at each load step. By default the final point (the right most point) is returned for each cycle. The user can return the peak and final point by setting returnPeaks = True.

Parameters:

  • hysteresis (Hysteresis class) – The input Hysteresis to calculate the backbone of.

  • LPsteps (list, optional) –

    The list of the number of cycles at each load point. The default is [].

    For example, if the input loading is as follows:

    0, 1, -1, 1, -1, 1 , -1, 2, -2, 3,-3, 3, -3

    Then the input should be [3, 1, 2].

  • returnPeaks (bool, optional) – A switch that when toggled on will cause the function to return the peak points of each cycle in additon to the end points.

  • skipStart (int, optional) – The number of cycles to skip from the start of the the backbone curve. The default is 0 which skips no cycles.

  • skipEnd (int, optional) – The number of cycles to skip from the end of the the backbone curve. The default is 0 which skips no cycles.

Returns:

avg, pos, neg – A simpleCycle object of the output backbone curve.

Return type:

SimpleCycle