Hysteresis data processing tools.
Project description
Hysteresis: Analysis 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(showReversals = 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(showReversals=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
A curve is a sequence of xy points, i.e. [xy0, xy1, ..., xyN]
Portions of a curve will have a direction in both x and y, depending on if values are increasing or decreasing. The direction of a curve section depends on the overall curve trends, and small imperfections in the data can be ignored. Points where the x values change direction are called reversal points. Points where the y values change direction are called peaks.
The Hysteresis package has a number of objects to represent curves with different properties
The most basic type of curve is the MonotonicCurve. onotonicCurves do not change direction in x or y. They have two revesal points, and two peaks (the first and last point for both)
Next are SimpleCurves. These are curves where x does not change direction, but y can. They will have two reversal points (the first and last point), and multiple peaks. Between peak points, they can be broken into a number of "Subcycles" represented by of MonotonicCurves.
Finally, a Hysteresis is a curve where that changes direction in both the x and y. They can have any number of reversal points and peaks. The Hysteresis are broken into a number of cycles between reversal points. These cycles are represented by a SimpleCurve.
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.5py3noneany.whl
Algorithm  Hash digest  

SHA256  a315e7f0b52fd0dbb6726a1368d7437216b2d3b5d3ee4ddd9c7376913477a336 

MD5  4a15939804c23be4f038f7d85d32a260 

BLAKE2b256  79c3236d48f84ef6ef42a7936917929b8a438cd9de0b7dbc05490554cfdca205 