Changeset 11c899b

Timestamp:

Nov 17, 2018, 3:02:00 PM (6 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

Children:

195e22e4

Parents:

d66d2ac

Message:

[mfcc] add scale documentation

File:

• src/spectral/mfcc.h (modified) (1 diff)

src/spectral/mfcc.h

@@ -95 +95 @@
 uint_t aubio_mfcc_get_power (aubio_mfcc_t *mf);
 
+/** set scaling parameter
+
+  \param mf mfcc object, as returned by new_aubio_mfcc()
+  \param scale Scaling value to apply.
+
+  Scales the output of the filterbank after taking its logarithm and before
+  computing the DCT. Defaults to `1`.
+
+*/
 uint_t aubio_mfcc_set_scale (aubio_mfcc_t *mf, smpl_t scale);
+
+/** get scaling parameter
+
+  \param mf mfcc object, as returned by new_aubio_mfcc()
+  \return current scaling parameter. Defaults to `1`.
+
+ */
 uint_t aubio_mfcc_get_scale (aubio_mfcc_t *mf);