-
Notifications
You must be signed in to change notification settings - Fork 3
Filters
In Scarlet, we provide a few options for input/output filters; as of now we have:
- Average Filter (computes a rolling average of inputs)
- Low Pass Filter (filters out high-frequency components of an input signal)
All of our filters are dynamically typed, but numeric typing is enforced upon construction.
An average filter computes a rolling average on a set of inputs.
Preparation: Simply construct a filter object (make sure to import Scarlet.Filters
)
Average YourFilter = new Average(FilterCount);
Where FilterCount
(an int
) represents the width of the roll. For example, 10
would setup the filter to find the average of the last 10 inputs.
Usage:
-
void Feed(T Input);
- Use this method to feed an input into the filter, the output will be calculated and updated depending on the input value.
-
void Feed(T Input, T Rate);
- Since this filter is not rate-dependent,
rate
is ignored, so this is the same operation asFeed(T input);
- Since this filter is not rate-dependent,
-
bool IsSteadyState();
- Returns whether or not the filter is in a steady state. In this case, if the output has been the same for
FilterCount
number of cycles, then it is determined to be in a steady state.
- Returns whether or not the filter is in a steady state. In this case, if the output has been the same for
-
T GetOutput()
- Returns the computed average of the inputs to the filter.
A low pass filter rejects high frequency components of an input signal. This can sound more complicated than it actually is, for more information this guide is pretty helpful: https://www.electronics-tutorials.ws/filter/filter_2.html.
The step response of a low pass filter is depicted here: https://i.stack.imgur.com/A4710.png, and is a good illustration of why we use them for our motors: they make great ramp-up functions.
Preparation: Simply construct a filter object (make sure to import Scarlet.Filters
)
LowPass YourFilter = new LowPass(LPFk, SteadyStateEpsilon);
Where LPFk
(a double
) is the low pass filter time constant, which can be thought of as a damping coefficient. The larger the number, the lower the cutoff frequency.
SteadyStateEpsilon
(a double
) is the maximum difference between the last two outputs for the system to be considered in a steady state. By default this is zero, so that the system is never considered to be in a steady state.
Usage:
-
void Feed(T Input);
- Use this method to feed an input into the filter, the output will be calculated and updated depending on the input value.
-
void Feed(T Input, T Rate);
- Since this filter is not rate-dependent,
rate
is ignored, so this is the same operation asFeed(T input);
.
- Since this filter is not rate-dependent,
-
bool IsSteadyState();
- Returns whether or not the filter is in a steady state. In this case, if the difference between the last output and the current output is less than or equal to the
SteadyStateEpsilon
supplied in the constructor, the filter is considered to be in a steady state.
- Returns whether or not the filter is in a steady state. In this case, if the difference between the last output and the current output is less than or equal to the
-
T GetOutput()
- Returns the output computed by the filter.
Quick Links:
NuGet
Pin Diagrams: RPi | BBB
Developers: CaiB, Baldstrom
General Info:
Home
Common Issues
Getting Started
Supported Devices
Sections:
Logging
DataLog
Filters
Hardware I/O:
- BeagleBone Black
- Raspberry Pi
- Pin Diagrams: RPi | BBB
- GPIO: Using | For Beginners
- PWM: Using | For Beginners
- ADC: Using | For Beginners
- I2C: Using | For Beginners
- SPI: Using | For Beginners
- UART: Using | For Beginners
- CAN: Using | For Beginners
Networking
Sensors
StateStore
Other: Interesting Case Studies