Firf.m - Revision history

Kuprov: Update function See also links and function index membership

2026-06-06T18:36:44Z

Update function See also links and function index membership

Kuprov: Rename Arguments section heading to Parameters

2026-06-05T17:48:57Z

Rename Arguments section heading to Parameters

Kuprov: /* See also */

2026-04-25T11:43:17Z

‎See also

Kuprov: Remove obsolete redlinks

2026-04-25T11:42:03Z

Remove obsolete redlinks

Kuprov: Normalise sequential blank lines

2026-04-25T11:25:33Z

Normalise sequential blank lines

Kuprov: Fix lead description from MATLAB header (folding/hyphenation pass)

2026-02-22T20:49:31Z

Fix lead description from MATLAB header (folding/hyphenation pass)

Kuprov: Expand See also links to related Spinach functions and docs

2026-02-22T20:20:46Z

Expand See also links to related Spinach functions and docs

Kuprov: Create documentation page from Spinach function header

2026-02-22T20:04:34Z

Create documentation page from Spinach function header

New page

{{DISPLAYTITLE:firf.m}} __NOTOC__
Applies an FIR convolution filter to a Spinach optimal control module waveform. Treats odd rows of multi-row waveform arrays as real, and even rows as imaginary, components of a complex signal. The distal end of the convolution is truncated so the

==Syntax==

[w,J]=firf(w,ker)

==Arguments==

w - waveform, one time slice per column, and
rows arranged as XYXY... with respect to
in-phase and quadrature parts on each
control channel
ker - a vector of FIR filter coefficients

==Outputs==

w - distorted waveform, same dimension as the
input waveform; leaving sufficient ring-
down margin is the user's responsibility
J - Jacobian matrix with respect to vectorisa-
tions of the output and the input arrays

==Examples==
See examples in the Spinach distribution relevant to this function.

==Notes==
This page was generated from the function header in the Spinach repository.

==See also==
[[Main_Page]]

''Version 2.11, authors: [[Ilya Kuprov]]''

@@ Line 29: / Line 29: @@
 ==See also==
-* [[kernelest.m]]
+[[kernelest.m]], [[fmaxnewton.m]], [[bfgs.m]], [[spinach2hiper.m]], [[amp_root.m]], [[amp_tanh.m]], [[no_dist.m]], [[penalty.m]], [[restrans.m]], [[spf.m]], [[szf.m]], [[transfermat.m]], [[Optimal_control_module]]
 ''Version 2.11, authors: [[Ilya Kuprov]]''

@@ Line 33: / Line 33: @@
 * [[bfgs.m]]
 * [[spinach2hiper.m]]
 * [[Optimal_control_module]]
 ''Version 2.11, authors: [[Ilya Kuprov]]''

@@ Line 33: / Line 33: @@
 * [[bfgs.m]]
 * [[spinach2hiper.m]]
-* [[kuprogram.m]]
+* kuprogram.m
 * [[Optimal_control_module]]
 ''Version 2.11, authors: [[Ilya Kuprov]]''

@@ Line 35: / Line 35: @@
 * [[kuprogram.m]]
 * [[Optimal_control_module]]
 ''Version 2.11, authors: [[Ilya Kuprov]]''

@@ Line 6: / Line 6: @@
                            [w,J]=firf(w,ker)
-==Arguments==
+==Parameters==
          w     - waveform, one time slice per column, and

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:firf.m}} __NOTOC__
-Applies an FIR convolution filter to a Spinach optimal control module waveform. Treats odd rows of multi-row waveform arrays as real, and even rows as imaginary, components of a complex signal. The distal end of the convolution is truncated so the
+Applies an FIR convolution filter to a Spinach optimal control module waveform. Treats odd rows of multi-row waveform arrays as real, and even rows as imaginary, components of a complex signal. The distal end of the convolution is truncated so the output has the same number of samples as the input.
 ==Syntax==