src/spectral/*.h: add link to examples
authorPaul Brossier <piem@piem.org>
Sun, 3 Mar 2013 03:53:15 +0000 (22:53 -0500)
committerPaul Brossier <piem@piem.org>
Sun, 3 Mar 2013 03:53:15 +0000 (22:53 -0500)
src/spectral/fft.h
src/spectral/filterbank.c
src/spectral/filterbank.h
src/spectral/filterbank_mel.h
src/spectral/mfcc.h
src/spectral/phasevoc.h

index 3ae4be8c56de86d6ccff2d48aaf671fab49a3f47..c61963c57009f4e1f317b245176bbd959c6dc98a 100644 (file)
@@ -22,6 +22,8 @@
 
   Fast Fourier Transform object
 
+  \example src/spectral/test-fft.c
+
 */
 
 #ifndef FFT_H_
index 13d7f6ea20e9614fe77c7548704b224212c2c10c..39dfa5da4f61b33fe01a74df55838da8440d51ab 100644 (file)
@@ -69,7 +69,6 @@ aubio_filterbank_do (aubio_filterbank_t * f, cvec_t * in, fvec_t * out)
 
   /* for each filter */
   for (fn = 0; fn < max_filters; fn++) {
-
     /* for each sample */
     for (j = 0; j < max_length; j++) {
       out->data[fn] += in->norm[j] * f->filters->data[fn][j];
index 0799dc2a0ef3b87c5af6687f04ba001f470acba2..6813faf4c8efc09f90bec62f96062b7148d4e891 100644 (file)
@@ -25,6 +25,8 @@
 
   General-purpose spectral filterbank object.
 
+  \example spectral/test-filterbank.c
+
 */
 
 #ifndef FILTERBANK_H
@@ -35,7 +37,11 @@ extern "C"
 {
 #endif
 
-/** filterbank object */
+/** filterbank object
+
+  This object stores a matrix of spectral filter coefficients.
+
+ */
 typedef struct _aubio_filterbank_t aubio_filterbank_t;
 
 /** create filterbank object
index 6d338cdd26aff684a3bbf4b17bfdf68fab84cc88..d2e8876c6ac18bec5905da9dcf737e60b5e900bd 100644 (file)
@@ -27,6 +27,8 @@
     - ::aubio_filterbank_set_triangle_bands: overlapping triangular bands,
     - ::aubio_filterbank_set_mel_coeffs_slaney: Mel frequency bands.
 
+  \example spectral/test-filterbank_mel.c
+
 */
 
 #ifndef FILTERBANK_MEL_H
index a0d43c9bf47c18e111a40123525886799b7b4ad6..004c0113e3426c3c8999b83ebd2f125c0a822fd4 100644 (file)
@@ -23,6 +23,8 @@
 
   Mel-frequency cepstrum coefficients object
 
+  \example spectral/test-mfcc.h
+
 */
 
 #ifndef MFCC_H
index 17f85d463933e7edd9b6f8d3a9154e625bfd2962..cd4f739f6412639206d2393a22bdc97afa64a2bc 100644 (file)
@@ -27,6 +27,8 @@
   phase relationships across frames. The window sizes and overlap are specified
   at creation time.
 
+  \example spectral/test-phasevoc.c
+
 */
 
 #ifndef _PHASEVOC_H