Filtercontinuousvariable function – Multichannel Systems NeuroExplorer User Manual
Page 260
5.5.8.30. FilterContinuousVariable Function
FilterContinuousVariable Function
Filters the specified continuous variable using the specified frequency filter.
Syntax
FilterContinuousVariable(doc, contVar, filteredVarName, filterType, filterOrder, freq1, freq2)
Parameters
Parameter
Type
Description
doc
documentReference Reference to the document.
contVar
variableReference
Reference to the variable.
filteredVarName
string
The name of the filtered variable.
filterType
string
The type of the filter. Should be "Lowpass",
"Highpass", "Bandpass", "Bandstop" or "Notch".
filterOrder
double
The number specifying the filter order. Should be
between 3 and 11 inclusive.
freq1
double
Filter frequency parameter (in Hz). See comments
below.
freq2
double
Filter frequency parameter (in Hz). See comments
below.
Returns
None
Comments
If the filter type is Lowpass or Highpass, freq1 is a cutoff frequency and freq2 is not used.
If the filter type is Bandpass or Bandstop, freq1 is a minimum of the frequency range and freq2 is a
maximum of the frequency range.
If the filter type is Notch, freq1 is the center of Notch filter and freq2 is the width of the Notch filter.
Usage
NexScript
The following sample script applies Bandpass filter to the variable ContChannel01. The result of
filtering will be saved in continuous variable Cont1BandFiltered. The filter order is 5 and the frequency
band is from 1000 Hz to 2000 Hz:
doc = GetActiveDocument()
var = GetVarByName(doc, "ContChannel01")
FilterContinuousVariable(doc, var, "Cont1BandFiltered", "Bandpass", 5, 1000, 2000)
See Also
Introduction to NexScript Programming
Page 258