Clarify use of cross-correlation for FIR filters

bonsai-rx · Apr 30, 2024 · 21ab771 · 21ab771
1 parent 08512e1
commit 21ab771
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/Bonsai.Dsp/FirFilter.cs b/Bonsai.Dsp/FirFilter.cs
@@ -13,6 +13,11 @@ namespace Bonsai.Dsp
     /// Represents an operator that convolves the input signal with a finite-impulse
     /// response filter kernel.
     /// </summary>
+    /// <remarks>
+    /// This operator is implemented using cross-correlation. If kernels are symmetric,
+    /// there is no difference between correlation and convolution. When using asymmetric
+    /// kernels, note the kernel needs to be flipped to obtain a true convolution.
+    /// </remarks>
     [Description("Convolves the input signal with a finite-impulse response filter kernel.")]
     public class FirFilter : Transform<Mat, Mat>
     {