Skip to content

← signal_processing package

SavitzkyGolayFilter

Apply a Savitzky-Golay filter to an array.

This is a 1-d filter and will be applied only to the axis specified in filt_axis. More Info... Version 0.8.0

Ports/Properties

data

Data to process.

verbose name
Data
default value
None
port type
DataPort
value type
Packet (can be None)
data direction
INOUT

window_length

The length of the filter window (i.e . the number of coefficients). window_length must be a positive odd integer.

verbose name
Sliding Window Length
default value
11
port type
FloatPort
value type
float (can be None)

unit

Unit in which the window length is given.

verbose name
Unit Of Measurement For Window Length
default value
samples
port type
EnumPort
value type
str (can be None)

polyorder

The order of the polynomial used to fit the samples. polyorder must be less than window_length (in samples).

verbose name
Order Of Polynomial
default value
3
port type
IntPort
value type
int (can be None)

deriv

The order of the derivative to compute. This must be a nonnegative integer. The default is 0, which means to filter the data without differentiating.

verbose name
Deriv
default value
0
port type
IntPort
value type
int (can be None)

filt_axis

The axis to apply the filter to. This will be the first axis of the specified type, or alternatively, a custom_label can be specified in format "myaxis.mylabel" to specifically designate the axis to which it will be applied.

verbose name
Filt Axis
default value
time
port type
ComboPort
value type
str (can be None)

mode

This determines the type of extension to use for the padded signal to which the filter is applied. When mode is ‘constant’, the padding value is given by the padding value. When the ‘interp’ mode is selected (the default), no extension is used. Instead, a degree polyorder polynomial is fit to the last window_length values of the edges, and this polynomial is used to evaluate the last window_length // 2 output values.

verbose name
Edge Padding
default value
interp
port type
EnumPort
value type
str (can be None)

cval

Value to fill past the edges of the input if mode is ‘constant’.

verbose name
Padding Value (If Constant)
default value
0.0
port type
FloatPort
value type
float (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

verbose name
Set Breakpoint (Debug Only)
default value
False
port type
BoolPort
value type
bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

verbose name
Metadata
default value
{}
port type
DictPort
value type
dict (can be None)