Changeset c0608bd for src/spectral/specdesc.h

Timestamp:

Mar 2, 2013, 8:18:00 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:

2a2636a

Parents:

867084e

Message:

src/spectral/: improve documentation

File:

• src/spectral/specdesc.h (modified) (4 diffs)

src/spectral/specdesc.h

@@ -27 +27 @@
   buffer (stored in a vector of size [1]).
  
+  \section specdesc Spectral description functions
+
   A list of the spectral description methods currently available follows.
 
-  \section onsetdesc Onset detection functions
+  \subsection onsetdesc Onset detection functions
 
   These functions are designed to raise at notes attacks in music signals.
@@ -82 +84 @@
   Canada, 2006. 
 
-  \section shapedesc Spectral shape descriptors
+  \subsection shapedesc Spectral shape descriptors
 
   The following descriptors are described in:
@@ -139 +141 @@
   is found.
 
+  \example spectral/test-specdesc.c
+
 */
 
@@ -169 +173 @@
   \param buf_size length of the input spectrum frame
 
+  The parameter \p method is a string that can be any of:
+
+    - `energy`, `hfc`, `complex`, `phase`, `specdiff`, `kl`, `mkl`, `specflux`
+    - `centroid`, `spread`, `skewness`, `kurtosis`, `slope`, `decrease`, `rolloff`
+
 */
 aubio_specdesc_t *new_aubio_specdesc (char_t * method, uint_t buf_size);