Filters
Interface Filter

All Known Implementing Classes:
AbstractFilter, IirfFilter, MovingAverageFilter

public interface Filter


Method Summary
 int getFilterDelay()
          Gets the delay of the filter - rarely used, but can be important for some processing tasks.
 void prepareFilter()
          Calculates the poles and zeros for the filter and sets up any memory buffers required during real time operation.
 double runFilter(double aData)
          Runs the filter on a single data value
 void runFilter(double[] inputData)
          Runs the filter on an array of data
 void runFilter(double[] inputData, double[] outputData)
          Runs the filter on an array of data
 

Method Detail

prepareFilter

void prepareFilter()
Calculates the poles and zeros for the filter and sets up any memory buffers required during real time operation.


runFilter

void runFilter(double[] inputData)
Runs the filter on an array of data

New values overwrite the old values in the array.

Parameters:
inputData -

runFilter

void runFilter(double[] inputData,
               double[] outputData)
Runs the filter on an array of data

New values write into the output data array.

Parameters:
inputData -

runFilter

double runFilter(double aData)
Runs the filter on a single data value

Parameters:
aData -
Returns:
New data value

getFilterDelay

int getFilterDelay()
Gets the delay of the filter - rarely used, but can be important for some processing tasks. For an IIRF filter, this would be half the number of poles, for a moving average or median filter it would be half the filter length.

Returns:
filter delay in samples.