/SavitzkyGolay.jl

Implementation of the 1D Savitzky-Golay filter in JuliaLang

Primary LanguageJuliaMIT LicenseMIT

SavitzkyGolay.jl

Implementation of the 1D Savitzky-Golay filter in JuliaLang.

Simple-plain implementation of the Savitzky-Golay filter in Julia.

Installation

This package is registered and can be installed in Julia with the following:

julia> ]
pkg> add SavitzkyGolay

Usage

After installation, we load the package:

using SavitzkyGolay
using Plots # This is for visualization purposes, not required in the SG package itself

Suppose we have a signal with noise that want to smooth out. The function for this is savitzky_golay, which accepts the following arguments:

sg = savitzky_golay(y::AbstractVector, window_size::Int, order::Int; deriv::Int=0, rate::Real=1.0)
  • y: The data vector with noise to be filtered.
  • window_size: The length of the filter window (i.e., the number of coefficients). Must be an odd number.
  • order: The order of the polynomial used to fit the samples. Must be less than window_size.
  • deriv: The order of the derivative to compute. This must be a non-negative integer. The default is 0, which means to filter the data without differentiating. If deriv > 0 it may need scaling which can be achieved using the rate optional argument. (optional)
  • rate: Scaling real number when using the derivative. (optional)

The solution sg is a SGolayResults type that contains four fields:

  • y with the filtered signal,
  • params type SGolay with the initial parameters
  • coeff with the computed coefficients
  • Vdm with the Vandermonde matrix

Examples

t = LinRange(-4, 4, 500)
y = exp.(-t.^2) .+ 0.05 .* (1.0 .+ randn(length(t)))
sg = savitzky_golay(y, 21, 4)
plot(t, [y sg.y], label=["Original signal" "Filtered signal"])

Example 2: SG1

Another simpler example:

t = 0:20
y = collect(0:20)
sg = savitzky_golay(y, 11, 2)
plot(t, [y sg.y], label=["Original signal" "Filtered signal"])

Example 2: SG2

Example with derivatives:

x = LinRange(-5, 15, 200)
data = 0.15*x.^3 - 2*x.^2 + x  .+ randn(length(x))
data_derivative = 0.45*x.^2 - 4*x .+ 1
sg = savitzky_golay(data, 21, 3, deriv=1)
sg_rate = savitzky_golay(data, 21, 3, deriv=1, rate=200/(15-(-5)))

Example 3: SG3

Constructor

There is an option to call the constructor SGolay to build the filter and then use it in different places. To call the constructor you need to specify at least two parameters, the full window size, and the polynomial order. The constructor accepts the following arguments:

SGolay(window_size, polynomial_order, derivative, rate)

For instance:

sgfilter = SGolay(11, 2)

sgfilter = SGolay(11, 2, 1)

sgfilter = SGolay(11, 2, 1, 0.1)

By default, if not specified, deriv=0 and rate=1.0.

The same examples above with constructors are as follows:

t = 0:20
y = collect(0:20)
sgfilter1 = SGolay(11, 2)
y1 = sgfilter1(y)
t = LinRange(-4, 4, 500)
y = exp.(-t.^2) .+ 0.05 .* (1.0 .+ randn(length(t)))
sgfilter2 = SGolay(21, 4)
y2 = sgfilter2(y)

The solutions y1 and y2 are the same type as the SGolayResults.

References