Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-03 03:01:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed Doxygen comments for LinearDigitalFilter (#198)

Browse Source
This commit is contained in:
Tyler Veness
2016-08-11 22:47:51 -07:00
committed by Peter Johnson
parent 6ef4745d86
commit fd4719cb87
2 changed files with 24 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
wpilibc/shared/src/Filters/LinearDigitalFilter.cpp
View File

@@ -75,11 +75,11 @@ LinearDigitalFilter::LinearDigitalFilter(std::shared_ptr<PIDSource> source,
m_outputGains(fbGains) {}
/**
* Creates a one-pole IIR low-pass filter of the form:
* y[n] = (1-gain)*x[n] + gain*y[n-1]
* where gain = e^(-dt / T), T is the time constant in seconds
* Creates a one-pole IIR low-pass filter of the form:<br>
* y[n] = (1 - gain) * x[n] + gain * y[n-1]<br>
* where gain = e<sup>-dt / T</sup>, T is the time constant in seconds
*
* This filter is stable for time constants greater than zero
* This filter is stable for time constants greater than zero.
*
* @param source The PIDSource object that is used to get values
* @param timeConstant The discrete-time time constant in seconds
@@ -92,11 +92,11 @@ LinearDigitalFilter LinearDigitalFilter::SinglePoleIIR(
}
/**
* Creates a first-order high-pass filter of the form:
* y[n] = gain*x[n] + (-gain)*x[n-1] + gain*y[n-1]
* where gain = e^(-dt / T), T is the time constant in seconds
* Creates a first-order high-pass filter of the form:<br>
* y[n] = gain * x[n] + (-gain) * x[n-1] + gain * y[n-1]<br>
* where gain = e<sup>-dt / T</sup>, T is the time constant in seconds
*
* This filter is stable for time constants greater than zero
* This filter is stable for time constants greater than zero.
*
* @param source The PIDSource object that is used to get values
* @param timeConstant The discrete-time time constant in seconds
@@ -109,8 +109,8 @@ LinearDigitalFilter LinearDigitalFilter::HighPass(
}
/**
* Creates a K-tap FIR moving average filter of the form:
* y[n] = 1/k * (x[k] + x[k-1] + ... + x[0])
* Creates a K-tap FIR moving average filter of the form:<br>
* y[n] = 1/k * (x[k] + x[k-1] + … + x[0])
*
* This filter is always stable.
*