Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-20 00:51:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

[wpimath] Document example of online filtering for LinearFilter.finiteDifference() (#4336)

Browse Source
This commit is contained in:
Tyler Veness
2022-07-22 10:46:33 -07:00
committed by GitHub
parent 1023c34b1c
commit 6f1e01f8bd
2 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
wpimath/src/main/java/edu/wpi/first/math/filter/LinearFilter.java
View File

@@ -144,7 +144,7 @@ public class LinearFilter {
* <p>Stencil points are the indices of the samples to use in the finite difference. 0 is the
* current sample, -1 is the previous sample, -2 is the sample before that, etc. Don't use
* positive stencil points (samples from the future) if the LinearFilter will be used for
* stream-based online filtering.
* stream-based online filtering (e.g., taking derivative of encoder samples in real-time).
*
* @param derivative The order of the derivative to compute.
* @param samples The number of samples to use to compute the given derivative. This must be one