Changeset 2d1d5ce

Timestamp:

Oct 21, 2009, 3:56:16 PM (15 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:

a8aaef3

Parents:

3ad2ef6

Message:

src/temporal: improve documentation

Location:

src/temporal

Files:

• a_weighting.h (modified) (2 diffs)
• biquad.h (modified) (2 diffs)
• c_weighting.h (modified) (2 diffs)
• filter.h (modified) (3 diffs)

src/temporal/a_weighting.h

@@ -61 +61 @@
 /** create new A-design filter
 
+  \param channels number of channels to allocate
   \param samplerate sampling frequency of the signal to filter. Should be one of 
   8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, 88200, 96000, and
   192000 Hz
-  \param channels number of channels to allocate
 
   \return a new filter object
@@ -75 +75 @@
 
   \param f filter object to get coefficients from
+  \param samplerate sampling frequency of the signal to filter. Should be one of 
+  8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, 88200, 96000, and
+  192000 Hz
 
 */

src/temporal/biquad.h

@@ -43 +43 @@
 /** set coefficients of a biquad filter
 
+  \param f filter object as returned by new_aubio_filter()
   \param b0 forward filter coefficient
   \param b1 forward filter coefficient
@@ -61 +62 @@
   \param a1 feedback filter coefficient
   \param a2 feedback filter coefficient
+  \param channels number of channels to allocate
 
 */

src/temporal/c_weighting.h

@@ -61 +61 @@
 /** create new C-design filter
 
+  \param channels number of channels to allocate
   \param samplerate sampling frequency of the signal to filter. Should be one of 
   8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, 88200, 96000, and
   192000 Hz
-  \param channels number of channels to allocate
 
   \return a new filter object
@@ -74 +74 @@
 
   \param f filter object to get coefficients from
+  \param samplerate sampling frequency of the signal to filter. Should be one of 
+  8000, 11025, 16000, 22050, 24000, 32000, 44100, 48000, 88200, 96000, and
+  192000 Hz
 
 */

src/temporal/filter.h

@@ -57 +57 @@
     - new_aubio_filter_a_weighting() and aubio_filter_set_a_weighting(),
     - new_aubio_filter_c_weighting() and aubio_filter_set_c_weighting().
+    - new_aubio_filter_biquad() and aubio_filter_set_biquad().
  
 */
@@ -141 +142 @@
 uint_t aubio_filter_set_samplerate (aubio_filter_t * f, uint_t samplerate);
 
-/** reset filter memory */
+/** reset filter memory
+
+  \param f filter object as returned by new_aubio_filter()
+
+*/
 void aubio_filter_do_reset (aubio_filter_t * f);
 
@@ -149 +154 @@
   and a specific number of channels.
 
-  \param samplerate signal sampling rate
   \param order order of the filter (number of coefficients)
   \param channels number of channels to allocate