firf.m

From Spinach Documentation Wiki
Revision as of 18:48, 5 June 2026 by Kuprov (talk | contribs) (Rename Arguments section heading to Parameters)
Jump to: navigation, search

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

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

Parameters

       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

Version 2.11, authors: Ilya Kuprov