Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify use of cross-correlation for FIR filters #1768

Merged
merged 1 commit into from
May 1, 2024
Merged

Clarify use of cross-correlation for FIR filters #1768

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions Bonsai.Dsp/FirFilter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
{
Expand Down
Loading