From 21ab771e447366c74dc33c0941776638b2d02e82 Mon Sep 17 00:00:00 2001
From: glopesdev <glopesdev@users.noreply.github.com>
Date: Tue, 30 Apr 2024 23:59:58 +0100
Subject: [PATCH] Clarify use of cross-correlation for FIR filters

---
 Bonsai.Dsp/FirFilter.cs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Bonsai.Dsp/FirFilter.cs b/Bonsai.Dsp/FirFilter.cs
index ab25e83bb..444c9a203 100644
--- 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>
     {