Changeset 6b46a4e for src


Ignore:
Timestamp:
Nov 17, 2018, 12:21:39 PM (13 months ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master
Children:
831f702
Parents:
0e30a12
Message:

[filterbank] add docs for norm and power

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/spectral/filterbank.h

    r0e30a12 r6b46a4e  
    8484uint_t aubio_filterbank_set_coeffs (aubio_filterbank_t * f, const fmat_t * filters);
    8585
     86/** set norm parameter
     87
     88  \param f filterbank object, as returned by new_aubio_filterbank()
     89  \param norm `1` to norm the filters, `0` otherwise.
     90
     91  If set to `0`, the filters will not be normalized. If set to `1`,
     92  each filter will be normalized to one. Defaults to `1`.
     93
     94  This function should be called *before* setting the filters with one of
     95  aubio_filterbank_set_triangle_bands(), aubio_filterbank_set_mel_coeffs(),
     96  aubio_filterbank_set_mel_coeffs_htk(), or
     97  aubio_filterbank_set_mel_coeffs_slaney().
     98
     99 */
    86100uint_t aubio_filterbank_set_norm (aubio_filterbank_t *f, smpl_t norm);
    87101
     102/** get norm parameter
     103
     104  \param f filterbank object, as returned by new_aubio_filterbank()
     105  \returns `1` if norm is set, `0` otherwise. Defaults to `1`.
     106
     107 */
    88108smpl_t aubio_filterbank_get_norm (aubio_filterbank_t *f);
    89109
     110/** set power parameter
     111
     112  \param f filterbank object, as returned by new_aubio_filterbank()
     113  \param power Raise norm of the input spectrum norm to this power before
     114  computing filterbank.  Defaults to `1`.
     115
     116 */
    90117uint_t aubio_filterbank_set_power (aubio_filterbank_t *f, smpl_t power);
    91118
     119/** get power parameter
     120
     121  \param f filterbank object, as returned by new_aubio_filterbank()
     122  \return current power parameter. Defaults to `1`.
     123
     124 */
    92125smpl_t aubio_filterbank_get_power (aubio_filterbank_t *f);
    93126
Note: See TracChangeset for help on using the changeset viewer.