Changeset c0608bd


Ignore:
Timestamp:
Mar 2, 2013, 8:18:00 PM (7 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, pitchshift, sampler, timestretch, yinfft+
Children:
2a2636a
Parents:
867084e
Message:

src/spectral/: improve documentation

Location:
src/spectral
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • src/spectral/filterbank_mel.h

    r867084e rc0608bd  
    2222/** \file
    2323
    24   Mel frequency filter bankd coefficients
     24  Filterbank object coefficients initialization
    2525
    26   Set filter bank coefficients to Mel frequency bands.
    27 
    28   The filter coefficients are built according to Malcolm Slaney's Auditory
    29   Toolbox available at http://cobweb.ecn.purdue.edu/~malcolm/interval/1998-010/
    30   (see the file mfcc.m).
     26  Functions to create set the ::aubio_filterbank_t coefficients to
     27    - ::aubio_filterbank_set_triangle_bands: overlapping triangular bands,
     28    - ::aubio_filterbank_set_mel_coeffs_slaney: Mel frequency bands.
    3129
    3230*/
     
    5856  \param samplerate audio sampling rate
    5957
    60   This function fills the filterbank coefficients according to Malcolm Slaney.
     58  The filter coefficients are built according to Malcolm Slaney's Auditory
     59  Toolbox, available at http://cobweb.ecn.purdue.edu/~malcolm/interval/1998-010/
     60  (see file mfcc.m).
    6161
    6262*/
     
    6868#endif
    6969
    70 #endif                          // FILTERBANK_MEL_H
     70#endif // FILTERBANK_MEL_H
  • src/spectral/specdesc.h

    r867084e rc0608bd  
    2727  buffer (stored in a vector of size [1]).
    2828 
     29  \section specdesc Spectral description functions
     30
    2931  A list of the spectral description methods currently available follows.
    3032
    31   \section onsetdesc Onset detection functions
     33  \subsection onsetdesc Onset detection functions
    3234
    3335  These functions are designed to raise at notes attacks in music signals.
     
    8284  Canada, 2006.
    8385
    84   \section shapedesc Spectral shape descriptors
     86  \subsection shapedesc Spectral shape descriptors
    8587
    8688  The following descriptors are described in:
     
    139141  is found.
    140142
     143  \example spectral/test-specdesc.c
     144
    141145*/
    142146
     
    169173  \param buf_size length of the input spectrum frame
    170174
     175  The parameter \p method is a string that can be any of:
     176
     177    - `energy`, `hfc`, `complex`, `phase`, `specdiff`, `kl`, `mkl`, `specflux`
     178    - `centroid`, `spread`, `skewness`, `kurtosis`, `slope`, `decrease`, `rolloff`
     179
    171180*/
    172181aubio_specdesc_t *new_aubio_specdesc (char_t * method, uint_t buf_size);
Note: See TracChangeset for help on using the changeset viewer.