Changeset b0706d8 for src

Timestamp:

Oct 17, 2013, 1:34:46 PM (11 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+

Children:

926f0f6

Parents:

3cd9fdd

Message:

src/spectral/filterbank.h: improve documentation

File:

• src/spectral/filterbank.h (modified) (2 diffs)

src/spectral/filterbank.h

@@ -55 +55 @@
 /** 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()
 
  */
@@ -78 +78 @@
 /** 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