Hysteresis data processing tools
Project description
Hysteresis: Tools for Nonfunctional Curves.
Hysteresis is a Python library made for analyzing nonfunctional curves, with an emphasis on forcedeformation hystereses. While functions only have one direction, nonfunctional curves change direction, and each 'x' can be is mapped to more than one 'y'. Hysteresis can break up these curves into a number of functions that can be easily analyzed.
A overview of the functions currently availible to users can be found here: https://hysteresis.readthedocs.io/en/latest/
Examples can be found here: https://github.com/cslotboom/hysteresis/tree/master/examples
Contents
Basic Demo
Hysteresis objects are created by passing a xy curve to one of the base classes. The resulting object has many useful methods that help with analyzing the data. Here we plot the data, seeing the the reversal points have been detected.
import numpy as np
import hysteresis as hys
t = np.linspace(0,4,1000)*np.pi
x = np.sin(t)
y = np.cos(t)*t
xy = np.column_stack([x,y])
myHys = hys.Hysteresis(xy)
myHys.plot(plotCycles = True)
Install
Hysteresis is pip installable via:
pip install hysteresis
Features
Using Hysteresis, it's possible to:
Find peaks or reversal points in data:
Using a Hysteresis object, it's possible to find the reversal points in your data, and break curves up into a series of "SimpleCycles" that are all functions. Experimental data is often messy, and the Hysteresis package comes with a number of ways to filter the peaks of data.
Filtering peaks in data:
Finding reversal points in data (Ex. 2.1):
Easily display data
All Hysteresis objects come with built in plotting functionality, built off matplotlib. It's possible to plot a variatety of features about the curve, and make publication ready plots.
fig, ax = plt.subplots()
line = myHys.plot(plotCycles=True)
ax.set_xlabel('Actuator Displacement (mm)')
ax.set_ylabel('Applied Force (kN)')
Find the backbone of a hysteresis
Using the Hysteresis module, it's possible to find the backbone of a hysteresis, then fit a curve to that data. (Ex. 3.2). Data provided by Dr. Thomas Tannert of UNBC: Drexler M, Dires S, Tannert T (2021), "Internal perforatedsteelplate connections for CLT shear walls.", In proceedings of World Conference for Timber Engineering, Santiago de Chile.
Find the area or slope of a hysteresis:
If the area or slope has been set it's possible to return the slope or area of a curve. Assuming your units are correct, the area under each hysteresis curve is the energy contained by the curve!
area = myHys.area
netArea = myHys.getNetArea()
cumulativeArea = myHys.getCumArea()
slope = DamperHys.slope
Down sample a hysteresis:
It's also possible to reduce the number of points in a curve, using the resample functions. These functions use linear interpolation to make a new curve with less data points than the original.
Compare two hystereses:
If two hystereses have the same load protocol, the hysteresis package allows you to "compare" the curves. This operation will take two hystereses, resample them, then find the average "difference" between each point on the curve.
Tutorials
Youtube tutorials coming soon.
Terminology
Hysteresis objects are curves that change directions in both the x axis and y axis, i.e. the change from leftright to right left. They are made up of a number of "SimpleCycle" objects, which only go one direction.
The use of the term "Cycle" in this package is a little nebulus, as it implies that we return to where we started. In this package, a cycle is a curve that goes between two extreme values in the x axis and (roughly) does not change direction, i.e. they only go leftright or rightleft. The SimpleCycle object is used to represent these curves. Note that changes in direction left or right that are not detected as peaks are still allowed.
MonotonicCurve is a "SimpleCycle" object that is, you guessed it, monotonic. Similar to Small jitters up or down that are not considered peaks are still allowed.
Project details
Release history Release notifications  RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hysteresis2.0.1py3noneany.whl
Algorithm  Hash digest  

SHA256  f5e01aa1f674319afa4d167990803ba32845d9fabfbdaf2b840ca0eb153e7c8a 

MD5  803d36fb01f3f6e521e8dd2238196ad7 

BLAKE2b256  78efd96cc18d134d7603abfe03bfe97aef2f8804a33db772f811d0c728b8df58 