Changeset b0706d8


Ignore:
Timestamp:
Oct 17, 2013, 1:34:46 PM (6 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:
926f0f6
Parents:
3cd9fdd
Message:

src/spectral/filterbank.h: improve documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/spectral/filterbank.h

    r3cd9fdd rb0706d8  
    5555/** destroy filterbank object
    5656
    57   \param fb filterbank, as returned by new_aubio_filterbank() method
     57  \param f filterbank object, as returned by new_aubio_filterbank()
    5858
    5959*/
    60 void del_aubio_filterbank (aubio_filterbank_t * fb);
     60void del_aubio_filterbank (aubio_filterbank_t * f);
    6161
    6262/** compute filterbank
    6363
    64   \param fb filterbank containing     nfilt x win_s filter coefficients
    65   \param in input spectrum containing chans x win_s spectrum
    66   \param out output vector containing chans x nfilt output values
     64  \param f filterbank object, as returned by new_aubio_filterbank()
     65  \param in input spectrum containing an input spectrum of length `win_s`
     66  \param out output vector containing the energy found in each band, `nfilt` output values
    6767
    6868*/
    69 void aubio_filterbank_do (aubio_filterbank_t * fb, cvec_t * in, fvec_t * out);
     69void aubio_filterbank_do (aubio_filterbank_t * f, cvec_t * in, fvec_t * out);
    7070
    71 /** return a pointer to the matrix object containing all filter coefficients 
     71/** return a pointer to the matrix object containing all filter coefficients
    7272
    73   \param f filterbank object to get coefficients from
     73  \param f filterbank object, as returned by new_aubio_filterbank()
    7474
    7575 */
     
    7878/** copy filter coefficients to the filterbank
    7979
    80   \param f filterbank object to set coefficients
     80  \param f filterbank object, as returned by new_aubio_filterbank()
    8181  \param filters filter bank coefficients to copy from
    8282
Note: See TracChangeset for help on using the changeset viewer.