Skip to content
physioKIT
API Reference
HELIA

smooth

Machine-readable model

function

Smooths signal using savitzky-golay filter

physiokit/signal/smooth.py:7

signal_smooth_savgol(
data: npt.NDArray,
window_length: int | None = None,
polyorder: int = 3,
sample_rate: float = 1000,
axis: int = -1,
) -> npt.NDArray

Smooths signal using savitzky-golay filter

Parameters of signal_smooth_savgol
NameTypeDefaultDescription
datanpt.NDArrayRequiredSignal
window_lengthint | NoneNoneFilter window length. Defaults to None.
polyorderint3Poly fit order. Defaults to 3.
sample_ratefloat1000Sampling rate in Hz. Defaults to 1000 Hz.
axisint-1Axis to filter along. Defaults to -1.
Returns of signal_smooth_savgol
TypeDescription
npt.NDArraynpt.NDArray: Smoothed signal
function

Smooth signal using boxcar method.

physiokit/signal/smooth.py:37

signal_smooth_boxcar(data: npt.NDArray, size: int = 10) -> npt.NDArray

Smooth signal using boxcar method.

Parameters of signal_smooth_boxcar
NameTypeDefaultDescription
datanpt.NDArrayRequiredSignal
sizeint10Kernel size. Defaults to 10.
Returns of signal_smooth_boxcar
TypeDescription
npt.NDArraynpt.NDArray: Smoothed signal
function

Smooth signal using boxzen method.

physiokit/signal/smooth.py:51

signal_smooth_boxzen(data: npt.NDArray, size: int = 10) -> npt.NDArray

Smooth signal using boxzen method.

Parameters of signal_smooth_boxzen
NameTypeDefaultDescription
datanpt.NDArrayRequiredSignal
sizeint10Kernel size. Defaults to 10.
Returns of signal_smooth_boxzen
TypeDescription
npt.NDArraynpt.NDArray: Smoothed signal
function

Smooth signal using median filter.

physiokit/signal/smooth.py:69

signal_smooth_median(data: npt.NDArray, size: int = 5) -> npt.NDArray

Smooth signal using median filter.

Parameters of signal_smooth_median
NameTypeDefaultDescription
datanpt.NDArrayRequiredSignal
sizeint5Kernel size. Defaults to 5.
Returns of signal_smooth_median
TypeDescription
npt.NDArraynpt.NDArray: Smoothed signal
function

Smooth signal using convolution.

physiokit/signal/smooth.py:86

signal_smooth_conv(data: npt.NDArray, kernel: str, size: int = 5) -> npt.NDArray

Smooth signal using convolution.

Parameters of signal_smooth_conv
NameTypeDefaultDescription
datanpt.NDArrayRequiredSignal
kernelstrRequiredKernel type
sizeint5Kernel size. Defaults to 10.
Returns of signal_smooth_conv
TypeDescription
npt.NDArraynpt.NDArray: Smoothed signal