Changeset 76ac373


Ignore:
Timestamp:
Sep 25, 2009, 11:46:19 PM (10 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master, pitchshift, sampler, timestretch, yinfft+
Children:
a6db140
Parents:
c698d1b
Message:

src/temporal/: improve documentation for a and c-design filters

Location:
src/temporal
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • src/temporal/adesign.h

    rc698d1b r76ac373  
    1818*/
    1919
    20 /** create a new A-design filter
     20/** \file
     21
     22  Create a new A-design filter
     23
     24  This file creates an IIR filter object with A-design coefficients.
     25
     26*/
     27
     28/** create new A-design filter
    2129
    2230  \param samplerate sampling-rate of the signal to filter
     31  \param channels number of channels to allocate
    2332
    2433*/
    2534aubio_filter_t * new_aubio_adsgn_filter(uint_t samplerate, uint_t channels);
    2635
     36/** filter input vector (in-place) */
    2737#define aubio_adsgn_filter_do aubio_filter_do
     38/** delete a-design filter object */
    2839#define del_aubio_adsgn_filter del_aubio_filter
  • src/temporal/cdesign.h

    rc698d1b r76ac373  
    2020#include "filter.h"
    2121
    22 /** create a new C-design filter
     22/** \file
     23
     24  Create a new C-design filter
     25
     26  This file creates an IIR filter object with A-design coefficients.
     27
     28*/
     29
     30/** create new C-design filter
    2331
    2432  \param samplerate sampling-rate of the signal to filter
     33  \param channels number of channels to allocate
    2534
    2635*/
    2736aubio_filter_t * new_aubio_cdsgn_filter(uint_t samplerate, uint_t channels);
    2837
     38/** filter input vector (in-place) */
    2939#define aubio_cdsgn_filter_do aubio_filter_do
     40/** delete c-design filter object */
    3041#define del_aubio_cdsgn_filter del_aubio_filter
Note: See TracChangeset for help on using the changeset viewer.