From: Paul Brossier Date: Thu, 17 Oct 2013 11:34:46 +0000 (+0200) Subject: src/spectral/filterbank.h: improve documentation X-Git-Tag: 0.4.0-beta1~110^2~4 X-Git-Url: https://git.aubio.org/?a=commitdiff_plain;h=b0706d8796cd10d463cf2a52888d3befa17a69e7;p=aubio.git src/spectral/filterbank.h: improve documentation --- diff --git a/src/spectral/filterbank.h b/src/spectral/filterbank.h index 6813faf4..d43fd08a 100644 --- a/src/spectral/filterbank.h +++ b/src/spectral/filterbank.h @@ -54,30 +54,30 @@ aubio_filterbank_t *new_aubio_filterbank (uint_t n_filters, uint_t win_s); /** destroy filterbank object - \param fb filterbank, as returned by new_aubio_filterbank() method + \param f filterbank object, as returned by new_aubio_filterbank() */ -void del_aubio_filterbank (aubio_filterbank_t * fb); +void del_aubio_filterbank (aubio_filterbank_t * f); /** compute filterbank - \param fb filterbank containing nfilt x win_s filter coefficients - \param in input spectrum containing chans x win_s spectrum - \param out output vector containing chans x nfilt output values + \param f filterbank object, as returned by new_aubio_filterbank() + \param in input spectrum containing an input spectrum of length `win_s` + \param out output vector containing the energy found in each band, `nfilt` output values */ -void aubio_filterbank_do (aubio_filterbank_t * fb, cvec_t * in, fvec_t * out); +void aubio_filterbank_do (aubio_filterbank_t * f, cvec_t * in, fvec_t * out); -/** return a pointer to the matrix object containing all filter coefficients +/** return a pointer to the matrix object containing all filter coefficients - \param f filterbank object to get coefficients from + \param f filterbank object, as returned by new_aubio_filterbank() */ fmat_t *aubio_filterbank_get_coeffs (aubio_filterbank_t * f); /** copy filter coefficients to the filterbank - \param f filterbank object to set coefficients + \param f filterbank object, as returned by new_aubio_filterbank() \param filters filter bank coefficients to copy from */