# doc-cache created by Octave 11.3.0
# name: cache
# type: cell
# rows: 3
# columns: 22
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 14
dsp_audio_demo


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 235
 -- Function File: dsp_audio_demo (PARENT_FIG, B, A, FS_FILTER)
     Open an audio demo window.  Load a WAV file, apply the designed filter,
     play original / filtered audio, and display waveforms and spectrograms side
     by side.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 26
Open an audio demo window.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 19
dsp_check_stability


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 785
 -- Function File: S = dsp_check_stability (B, A)
     Analyse the BIBO stability of a discrete-time filter given its
     transfer-function coefficients B (numerator) and A (denominator).

     Returns a struct S with the fields:
     ‘poles’
          Column vector of filter poles (roots of A).
     ‘radii’
          Absolute values of each pole.
     ‘max_radius’
          Radius of the pole closest to or outside the unit circle.
     ‘margin’
          Distance from the largest-radius pole to the unit circle (1 -
          max_radius).
     ‘stable’
          Boolean — true when every pole lies strictly inside the unit circle.
     ‘status’
          Human-readable string: ‘"STABLE"’, ‘"MARGINALLY STABLE"’, or
          ‘"UNSTABLE"’.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Analyse the BIBO stability of a discrete-time filter given its transfer-funct...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 15
dsp_code_export


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 215
 -- Function File: dsp_code_export (H)
     Open an export window to generate and save filter coefficients as
     MATLAB/Octave, C, or Python code.  The window shows a live preview and
     allows saving to a file.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Open an export window to generate and save filter coefficients as MATLAB/Octa...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 18
dsp_compare_window


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 233
 -- Function File: dsp_compare_window (MAIN_H)
     Open a comparison window that overlays the responses of two filters.  Each
     filter can be sourced from the current design or loaded from a previously
     saved ‘.mat’ file.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 68
Open a comparison window that overlays the responses of two filters.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 16
dsp_compute_f3db


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 307
 -- Function File: STR = dsp_compute_f3db (H, WN)
     Return a human-readable string describing the -3 dB crossing frequencies of
     a frequency response H sampled at normalized frequencies WN (in units of
     \\times\\pi rad/sample, so wn \\in [0, 1] where 1 corresponds to the
     Nyquist frequency).


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Return a human-readable string describing the -3 dB crossing frequencies of a...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 18
dsp_compute_filter


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 525
 -- Function File: [B, A] = dsp_compute_filter (FS, FC, FC2, N, TYPE_IDX,
          TOPO_IDX, ARCH_IDX, RP, RS)
     Compute filter coefficients from UI parameters.  ARCH_IDX: 1=IIR (default),
     2=FIR TYPE_IDX: 1=lowpass, 2=highpass, 3=bandpass, 4=bandstop IIR TOPO_IDX:
     1=Butterworth, 2=Chebyshev I, 3=Chebyshev II, 4=Elliptic FIR TOPO_IDX:
     1=Hamming, 2=Hanning, 3=Blackman, 4=Kaiser, 5=Parks-McClellan,
     6=Least-Squares RP: passband ripple in dB (default 3) RS: stopband
     attenuation in dB (default 40)


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 47
Compute filter coefficients from UI parameters.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 19
dsp_design_callback


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 189
 -- Function File: dsp_design_callback (H)
     Design button handler.  Reads filter parameters from the GUI, computes the
     filter, plots responses, and updates the stability indicator.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 22
Design button handler.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 13
dsp_draw_mask


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 263
 -- Function File: dsp_draw_mask (AX, B, A, FS, FC, FC2, TYPE_IDX, RP, RS)
     Redraw the magnitude response with a specification mask overlay.  Forbidden
     zones are shaded light red; allowed passband is light green.  The response
     curve is drawn on top.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 64
Redraw the magnitude response with a specification mask overlay.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 15
dsp_draw_zplane


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 235
 -- Function File: dsp_draw_zplane (AX, ZEROS_Z, POLES_Z, TITLE_STR)
     Draw the unit circle, guide lines, zeros, and poles on the given axes
     handle.  Used by both the integrated P/Z editor and the standalone
     ‘pz_tool’.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 77
Draw the unit circle, guide lines, zeros, and poles on the given axes handle.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 19
dsp_export_callback


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 170
 -- Function File: dsp_export_callback (H)
     Export the current filter coefficients to the base workspace as
     ‘num_coeffs’, ‘den_coeffs’, and ‘fs_val’.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 84
Export the current filter coefficients to the base workspace as ‘num_coeffs’,...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 16
dsp_freq_axis_hz


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 818
 -- Function File: [HZ, LABEL] = dsp_freq_axis_hz ()
 -- Function File: [HZ, LABEL] = dsp_freq_axis_hz (NEW_VAL)
     Query or set the tool-wide frequency-axis unit mode.

     When HZ is false (the default) frequency axes are labelled in normalized
     radians per sample, 0 to \pi.  When true they are labelled in absolute
     frequency, 0 to Fs/2 Hz.  The flag is stored as appdata on the root object
     so every dsppack window (main screen, detailed analysis) shares the same
     mode; it is applied by ‘dsp_freq_xticks’, which falls back to \pi units for
     axes that have no sampling frequency associated with them (e.g.  the
     compare window, whose two filters may use different sampling rates).

     LABEL is the matching caption for the toggle buttons, describing the mode
     currently shown.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 52
Query or set the tool-wide frequency-axis unit mode.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 15
dsp_freq_xticks


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 978
 -- Function File: dsp_freq_xticks ()
 -- Function File: dsp_freq_xticks (AX)
 -- Function File: dsp_freq_xticks (AX, FS)
     Relabel the frequency x-axis of AX (default ‘gca’) according to the
     tool-wide unit mode (‘dsp_freq_axis_hz’).

     The frequency responses are plotted in \times\pi units (data range [0, 1],
     i.e.  w/\pi), and that data is never rescaled - only the tick positions and
     labels change:

        • Normalized mode (default): ticks at 0, \pi/4, \pi/2, 3\pi/4, \pi with
          a matching \omega (rad/sample) label.
        • Hz mode: ticks at round Hz values (1/2/5 steps) between 0 and the
          Nyquist frequency FS/2, labelled in Hz (or kHz when Nyquist is at
          least 1 kHz), each placed at its normalized position f/(Fs/2).

     Hz mode only applies when a valid FS is supplied; callers that omit it
     (compare window, report, P/Z preview) always get the normalized labels
     regardless of the mode toggle.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 84
Relabel the frequency x-axis of AX (default ‘gca’) according to the tool-wide...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 19
dsp_generate_report


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 185
 -- Function File: dsp_generate_report (H)
     Generate a self-contained HTML report of the current filter design with
     specifications, stability analysis, plots, and coefficients.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Generate a self-contained HTML report of the current filter design with
speci...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 17
dsp_load_callback


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 115
 -- Function File: dsp_load_callback (H)
     Load a filter design from a .mat file, restore UI fields, and replot.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 69
Load a filter design from a .mat file, restore UI fields, and replot.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 14
dsp_new_window


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 934
 -- Function File: FIG = dsp_new_window (NAME)
     Create a standard dsppack application window and return its handle.

     The figure is sized to the screen (capped at 1920x1080), centred, fixed
     (non-resizable), and has no menubar or default number-title.  Every dsppack
     window is created through this helper so their look and behaviour stay
     consistent, and so each one carries the ‘"dsppack_window"’ tag that lets
     ‘dsppack_launch’'s EXIT button close only this tool's own figures (leaving
     unrelated Octave figures untouched).

     Windows are deliberately non-resizable: the interactive click-to-place
     tools (‘fda_pz_editor’, ‘pz_tool’) hit-test clicks against the figure
     geometry, which a resizable native window reports inconsistently, and
     Octave's qt toolkit applies native hover styling to resizable windows that
     can render the coloured control buttons unreadable.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 67
Create a standard dsppack application window and return its handle.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 17
dsp_plot_response


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 161
 -- Function File: dsp_plot_response (AX_MAG, AX_PHASE, B, A, FS)
     Plot the magnitude and phase responses of a digital filter on the given
     axes handles.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Plot the magnitude and phase responses of a digital filter on the given axes
...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 17
dsp_result_window


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 68
undocumented function: [] = dsp_result_window (parent_fig, b, a, Fs)


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 68
undocumented function: [] = dsp_result_window (parent_fig, b, a, Fs)



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 17
dsp_save_callback


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 127
 -- Function File: dsp_save_callback (H)
     Save the current filter design (parameters and coefficients) to a .mat
     file.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 76
Save the current filter design (parameters and coefficients) to a .mat file.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 20
dsp_update_stability


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 183
 -- Function File: dsp_update_stability (TXT_HANDLE, B, A)
     Run a BIBO stability check and update the given text UI control with the
     result (green for stable, red otherwise).


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Run a BIBO stability check and update the given text UI control with the resu...



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 14
dsppack_launch


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 91
 -- Function File: dsppack_launch ()
     Launches the Filter Design and Analysis Tool GUI.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 49
Launches the Filter Design and Analysis Tool GUI.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 13
fda_pz_editor


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 340
 -- Function File: fda_pz_editor (MAIN_FIG, FS)
     Interactive Z-Plane pole-zero editor.  Places poles and zeros by typing
     magnitude (r) and angle (deg) into the Manual Entry panel.  Enforces
     complex-conjugate symmetry so the resulting filter has real coefficients,
     then submits the design back to the main FDA Tool window.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 37
Interactive Z-Plane pole-zero editor.



# name: <cell-element>
# type: sq_string
# elements: 1
# length: 7
pz_tool


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 237
 -- Function File: pz_tool ()
     Interactive Pole-Zero placement tool with live magnitude frequency
     response.  Click on the Z-plane to place poles or zeros.  Complex
     conjugates are placed automatically for any off-axis click.


# name: <cell-element>
# type: sq_string
# elements: 1
# length: 76
Interactive Pole-Zero placement tool with live magnitude frequency response.





