Skip to content

Function index

Every public function in sid exists in both Python and MATLAB/Octave with a 1:1 mapping. The tables below link to the per-function reference page in each language.

Frequency-domain estimation

Python MATLAB Description
freq_bt sidFreqBT Blackman-Tukey frequency response and noise spectrum
freq_btfdr sidFreqBTFDR Blackman-Tukey with frequency-dependent resolution
freq_etfe sidFreqETFE Empirical transfer function estimate (FFT ratio)

Time-frequency analysis

Python MATLAB Description
freq_map sidFreqMap Time-varying frequency response map
spectrogram sidSpectrogram Short-time FFT spectrogram

State-space identification (COSMIC)

Python MATLAB Description
ltv_disc sidLTVdisc Discrete LTV state-space identification
ltv_disc_io sidLTVdiscIO LTV identification from partial observations
ltv_disc_tune sidLTVdiscTune Regularization tuning
ltv_disc_frozen sidLTVdiscFrozen Frozen-time transfer function G(ω, k)
lti_freq_io sidLTIfreqIO LTI realization from I/O frequency response
ltv_state_est sidLTVStateEst Batch LTV state estimation (RTS smoother)
model_order sidModelOrder Model order estimation via Hankel SVD

Plotting

Python MATLAB Description
bode_plot sidBodePlot Bode diagram with confidence bands
spectrum_plot sidSpectrumPlot Power spectrum plot
map_plot sidMapPlot Time-frequency map plot
spectrogram_plot sidSpectrogramPlot Spectrogram color map

Analysis and preprocessing

Python MATLAB Description
detrend sidDetrend Remove mean / linear / polynomial trends
residual sidResidual Residual analysis with auto/cross-correlation
compare sidCompare Simulate model output and compute fit percentage

Result types

Every function returns a frozen dataclass (Python) or struct (MATLAB). Browse the Python result types page for field-level documentation; MATLAB struct layouts are documented inline on each function page.