played around a bit more

allthatsounds · Nov 8, 2023 · dfc19d3 · dfc19d3
1 parent a1f05fb
commit dfc19d3
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 52 deletions.
diff --git a/filterbank/Contents.m b/filterbank/Contents.m
@@ -2,7 +2,7 @@
 %
 %  Peter L. Søndergaard, 2011 - 2023.
 %
-%  Transforms and basic routines
+%  Basic transform routines
 %    FILTERBANK             - Filter bank
 %    UFILTERBANK            - Uniform Filter bank
 %    IFILTERBANK            - Inverse normal/uniform filter bank
@@ -43,7 +43,7 @@
 %    FILTERBANKREASSIGN       - Reassign filterbank spectrogram
 %    FILTERBANKSYNCHROSQUEEZE - Synchrosqueeze filterbank spectrogram  
 %
-%  Phase reconstruction
+%  Phase reconstruction (should go to PHASERET)
 %    FILTERBANKCONSTPHASE     - Construct suitable phase from the coefficient magnitude
 %    
 %

diff --git a/gabor/Contents.m b/gabor/Contents.m
@@ -2,7 +2,7 @@
 %
 %  Peter L. Søndergaard, 2007 - 2023.
 %
-%  Gabor systems
+%  Basic transform routines
 %    DGT            -  Discrete Gabor transform
 %    IDGT           -  Inverse discrete Gabor transform
 %    ISGRAM         -  Iterative reconstruction from spectrogram
@@ -15,7 +15,13 @@
 %    PROJKERN	    -  Projection of Gabor coefficients onto kernel space
 %    DGTLENGTH      -  Length of Gabor system to expand a signal
 %
-%  Reconstructing windows
+%  Advanced transform routines: Non-separable lattices
+%    MATRIX2LATTICETYPE - Matrix form to standard lattice description
+%    LATTICETYPE2MATRIX - Standard lattice description to matrix form
+%    SHEARFIND      -  Shears to transform a general lattice to a separable
+%    NOSHEARLENGTH  -  Next transform side not requiring a frequency side shear
+%
+%  Window construction
 %    GABDUAL        -  Canonical dual window
 %    GABTIGHT       -  Canonical tight window
 %    GABFIRDUAL     -  FIR optimized dual window 
@@ -28,12 +34,23 @@
 %    PTPFUNDUAL     -  Dual window for |PTPFUN|
 %    PEBFUNDUAL     -  Dual window for |PEBFUN|
 %
-%  Conditions numbers
+%  Bounds
 %    GABFRAMEBOUNDS -  Frame bounds of Gabor system
 %    GABRIESZBOUNDS -  Riesz sequence/basis bounds of Gabor system
 %    GABDUALNORM    -  Test if two windows are dual
 %    GABFRAMEDIAG   -  Diagonal of Gabor frame operator
 %
+%  Plots
+%    TFPLOT         -  Plot coefficients on the time-frequency plane
+%    PLOTDGT        -  Plot |dgt| coefficients
+%    PLOTDGTREAL    -  Plot |dgtreal| coefficients
+%    SGRAM          -  Spectrogram based on |dgt|
+%    GABIMAGEPARS   -  Choose parameters for nice Gabor image
+%    RESGRAM        -  Reassigned spectrogram
+%    INSTFREQPLOT   -  Plot of the instantaneous frequency
+%    PHASEPLOT      -  Plot of STFT phase
+%    plottfjigsawsep  - Plot the output of |tfjigsawsep|
+%
 %  Phase gradient methods and reassignment
 %    GABPHASEGRAD   -  Instantaneous time/frequency from signal
 %    GABPHASEDERIV  -  Phase derivatives
@@ -53,27 +70,11 @@
 %    PHASEUNLOCKREAL -  Same as |phaseunlock| for |idgtreal|
 %    SYMPHASE        -  Convert to symmetric phase
 %
-%  Support for non-separable lattices
-%    MATRIX2LATTICETYPE - Matrix form to standard lattice description
-%    LATTICETYPE2MATRIX - Standard lattice description to matrix form
-%    SHEARFIND      -  Shears to transform a general lattice to a separable
-%    NOSHEARLENGTH  -  Next transform side not requiring a frequency side shear
-%
-%  Applications
+%  General applications
 %    MULTIDGTREALMP -  Matching pursuit decomposition in Multi-Gabor system 
 %    tfjigsawsep      - Tonal-transient-residual separation using the T-F jigsaw puzzle algorithm.
 %    GABMULAPPR        - Best approximation by a Gabor multiplier
 %
-%  Plots
-%    TFPLOT         -  Plot coefficients on the time-frequency plane
-%    PLOTDGT        -  Plot |dgt| coefficients
-%    PLOTDGTREAL    -  Plot |dgtreal| coefficients
-%    SGRAM          -  Spectrogram based on |dgt|
-%    GABIMAGEPARS   -  Choose parameters for nice Gabor image
-%    RESGRAM        -  Reassigned spectrogram
-%    INSTFREQPLOT   -  Plot of the instantaneous frequency
-%    PHASEPLOT      -  Plot of STFT phase
-%    plottfjigsawsep  - Plot the output of |tfjigsawsep|
 %
 %  For help, bug reports, suggestions etc. please visit 
 %  http://github.com/ltfat/ltfat/issues
diff --git a/nonstatgab/Contents.m b/nonstatgab/Contents.m
@@ -2,7 +2,7 @@
 %
 %  Florent Jaillet and Peter L. Søndergaard, 2011 - 2023.
 %
-%  Transforms
+%  Basic transform routines
 %    NSDGT                - Non-stationary DGT
 %    UNSDGT               - Uniform non-stationary DGT
 %    INSDGT               - Inverse NSDGT and UNSDGT

diff --git a/sigproc/Contents.m b/sigproc/Contents.m
@@ -2,36 +2,36 @@
 %
 %  Peter L. Søndergaard, 2007 - 2023.
 %
-%  General
-%    RMS            -  Root Mean Square norm of signal.
-%    SETNORM        -  Normalize signal by specified norm.
-%    GAINDB         -  Scale input signal.
-%    CRESTFACTOR    -  Compute the crest factor of a signal.
-%    LOWDISCREPANCY -  Compute a low discrepancy sequence.
-%    UQUANT         -  Simulate uniform quantization.
-%    POSTPAD        -  Pad or truncate a vector.
-%    COL2DIAG       -  Move columns of a matrix to diagonals
-%    S0NORM         -  S0-norm
-%
-%  Window functions
+%  Windows and wavelets
 %    FIRWIN         -  FIR windows (Hanning,Hamming,Blackman,...).
 %    FIRKAISER      -  FIR Kaiser-Bessel window.
 %    FIR2LONG       -  Extend FIR window to LONG window.
 %    LONG2FIR       -  Cut LONG window to FIR window.
 %    FREQWIN        -  Freq responses (Gauss,Gammatone,Butterworth,...)
-%
-%  Wavelet functions
 %    FREQWAVELET    -  Frequency responses of wavelets (Cauchy, Morse)
+%    for further wavelet functions, see https://allthatsounds.github.io/doc/wavelets/
 %
-%  Filtering
+%  Filters
 %    FIRFILTER      -  Construct an FIR filter.
 %    BLFILTER       -  Construct a band-limited filter.
 %    WARPEDBLFILTER -  Warped, band-limited filter.
 %    FREQFILTER     -  Construct a full length frequency side filter.
 %    PFILT          -  Apply filter with periodic boundary conditions.
 %    MAGRESP        -  Magnitude response plot.
+%    PGRPDELAY      -  Periodic Group Delay.
 %    TRANSFERFUNCTION - Compute the transfer function of a filter.
-%    PGRPDELAY      -  Periodic Group Delay
+%
+%  Signal analysis and synthesis
+%    RMS            -  Root Mean Square norm of signal.
+%    SETNORM        -  Normalize signal by specified norm.
+%    GAINDB         -  Scale input signal.
+%    CRESTFACTOR    -  Compute the crest factor of a signal.
+%    LOWDISCREPANCY -  Compute a low discrepancy sequence.
+%    UQUANT         -  Simulate uniform quantization.
+%    POSTPAD        -  Pad or truncate a vector.
+%    S0NORM         -  S0-norm
+%    RANGECOMPRESS  - Compress range of signal (mu-law etc).
+%    RANGEEXPAND    - Expand range of signal.
 %
 %  Ramping
 %    RAMPUP         -  Rising ramp.
@@ -45,14 +45,6 @@
 %    DYNLIMIT       -  Limit the dynamical range.
 %    GROUPTHRESH    -  Group thresholding.
 %
-%  Image processing
-%    RGB2JPEG       -  Convert RGB values to the JPEG colour model
-%    JPEG2RGB       -  Convert values from the JPEG colour model to RGB
-%
-%  Tools for OFDM
-%    QAM4           -  Quadrature amplitude modulation, order 4
-%    IQAM4          -  Inverse QAM of order 4
-%
 %  Auditory processing
 %     AUDTOFREQ        - Auditory unit to frequency conversion.
 %     FREQTOAUD        - Frequency to auditory unit conversion.
@@ -66,9 +58,16 @@
 %     GAMMATONEFIR     - Gammatone FIR approximation.
 %     SEMIAUDPLOT      - 2D plot on auditory scale.
 %
-%  Range compression
-%     RANGECOMPRESS    - Compress range of signal (mu-law etc).
-%     RANGEEXPAND      - Expand range of signal.
+%  Image processing
+%    RGB2JPEG       -  Convert RGB values to the JPEG colour model
+%    JPEG2RGB       -  Convert values from the JPEG colour model to RGB
+%
+%  Tools for OFDM
+%    QAM4           -  Quadrature amplitude modulation, order 4
+%    IQAM4          -  Inverse QAM of order 4
+%
+%   Auxiliary
+%    COL2DIAG       -  Move columns of a matrix to diagonals
 %
 %  For help, bug reports, suggestions etc. please visit 
 %  http://github.com/ltfat/ltfat/issues

diff --git a/wavelets/Contents.m b/wavelets/Contents.m
@@ -8,7 +8,7 @@
 %   Time-Frequency Analysis Toolbox for MATLAB/GNU Octave.” ACM Trans. Math. Softw. 42, 4,
 %   Article 32, 2016. DOI: 10.1145/2839298
 %   
-%   Basic analysis/synthesis
+%   Basic transform routines
 %      FWT               - Fast Wavelet Transform 
 %      IFWT              - Inverse Fast Wavelet Transform
 %      FWT2              - 2D Fast Wavelet Transform 
@@ -18,7 +18,7 @@
 %      FWTLENGTH         - Length of Wavelet system to expand a signal
 %      FWTCLENGTH        - Lengths of the wavelet coefficient subbands
 %
-%   Advanced analysis/synthesis
+%   Advanced transform routines
 %      WFBT              - Transform using general Wavelet Filter Bank Tree 
 %      IWFBT             - Inverse transform using general Wavelet Filter Bank Tree
 %      UWFBT             - Undecimated transform using general Wavelet Filter Bank Tree