Method ao/filter
FILTER overrides the filter function for analysis objects.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
DESCRIPTION: FILTER overrides the filter function for analysis objects.
Applies the input digital IIR/FIR filter to the input analysis
object. If the input analysis object contains a
time-series (tsdata) then the filter is applied using the normal
recursion algorithm. The output analysis object contains a tsdata
object.
If the input analysis object contains a frequency-series (fsdata)
then the response of the filter is computed and then multiplied
with the input frequency series. The output analysis object
contains a frequency series.
CALL: >> b = filter(a,pl)
>> b = filter(a,filt,pl)
>> b = filter(a,pl)
INPUTS: pl - a parameter list
a - input analysis object
OUTPUTS:
b - output analysis object containing the filtered data.
PROCINFO: The input filter object with the history values filled in are
always stored with a plist in the 'procinfo' property of the AO.
The key of the plist to get the filter is 'FILTER'.
Parameters Description
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details |
|
Access |
public |
Defining Class |
ao |
Sealed |
0 |
Static |
0 |
Parameter Description
Sets for this method … |
Default |
Default |
no description |
Key |
Default Value |
Options |
Description |
FILTER |
'' |
none |
The filter(s) to apply to the data. |
GDOFF |
0 |
|
Switch off correction for group delay. |
BANK |
'parallel' |
|
Specify what type of filter bank is being applied. |
INITIALIZE |
0 |
|
Initialize the filter to avoid startup transients. |
back to top
Some information of the method ao/filter are listed below: |
Class name |
ao |
Method name |
filter |
Category |
Signal Processing |
Package name |
ltpda |
VCS Version |
3f8d61c792503a5b5ec8a0a153efb23b65da24a9 |
Min input args |
1 |
Max input args |
-1 |
Min output args |
1 |
Max output args |
-1 |
|
Method: ao/filtSubtract |
|
Method: ao/filtfilt |
 |
©LTP Team