Public Member Functions | Public Attributes | List of all members
savitzky.savitzky_golay Class Reference

Public Member Functions

def __init__ (self, window_size, order, deriv=0, rate=1)
 
def filter (self, y)
 

Public Attributes

 deriv
 
 order
 
 order_range
 
 rate
 
 window_size
 

Detailed Description

Smooth (and optionally differentiate) data with a Savitzky-Golay filter.
The Savitzky-Golay filter removes high frequency noise from data.
It has the advantage of preserving the original shape and
features of the signal better than other types of filtering
approaches, such as moving averages techniques.
Parameters
----------
y : array_like, shape (N,)
    the values of the time history of the signal.
window_size : int
    the length of the window. Must be an odd integer number.
order : int
    the order of the polynomial used in the filtering.
    Must be less then `window_size` - 1.
deriv: int
    the order of the derivative to compute (default = 0 means only smoothing)
Returns
-------
ys : ndarray, shape (N)
    the smoothed signal (or it's n-th derivative).
Notes
-----
The Savitzky-Golay is a type of low-pass filter, particularly
suited for smoothing noisy data. The main idea behind this
approach is to make for each point a least-square fit with a
polynomial of high order over a odd-sized window centered at
the point.
Examples
--------
t = np.linspace(-4, 4, 500)
y = np.exp( -t**2 ) + np.random.normal(0, 0.05, t.shape)
ysg = savitzky_golay(y, window_size=31, order=4)
import matplotlib.pyplot as plt
plt.plot(t, y, label='Noisy signal')
plt.plot(t, np.exp(-t**2), 'k', lw=1.5, label='Original signal')
plt.plot(t, ysg, 'r', label='Filtered signal')
plt.legend()
plt.show()
References
----------
.. [1] A. Savitzky, M. J. E. Golay, Smoothing and Differentiation of
   Data by Simplified Least Squares Procedures. Analytical
   Chemistry, 1964, 36 (8), pp 1627-1639.
.. [2] Numerical Recipes 3rd Edition: The Art of Scientific Computing
   W.H. Press, S.A. Teukolsky, W.T. Vetterling, B.P. Flannery
   Cambridge University Press ISBN-13: 9780521880688

Definition at line 22 of file savitzky.py.

Constructor & Destructor Documentation

◆ __init__()

def savitzky.savitzky_golay.__init__ (   self,
  window_size,
  order,
  deriv = 0,
  rate = 1 
)

Definition at line 71 of file savitzky.py.

Member Function Documentation

◆ filter()

def savitzky.savitzky_golay.filter (   self,
  y 
)

Definition at line 88 of file savitzky.py.

Member Data Documentation

◆ deriv

savitzky.savitzky_golay.deriv

Definition at line 75 of file savitzky.py.

◆ order

savitzky.savitzky_golay.order

Definition at line 74 of file savitzky.py.

◆ order_range

savitzky.savitzky_golay.order_range

Definition at line 90 of file savitzky.py.

◆ rate

savitzky.savitzky_golay.rate

Definition at line 76 of file savitzky.py.

◆ window_size

savitzky.savitzky_golay.window_size

Definition at line 73 of file savitzky.py.


The documentation for this class was generated from the following file:


cob_voltage_control
Author(s): Alexander Bubeck
autogenerated on Thu Nov 17 2022 03:17:47