Ignore:
Timestamp:
Jul 10, 2015, 2:25:47 AM (5 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:
31a09d2
Parents:
4615886a
Message:

ext/py-musicutils.h: add doc for level_lin and db_spl

File:
1 edited

Legend:

Unmodified
Added
Removed
  • python/ext/py-musicutils.h

    r4615886a r665b711  
    1616PyObject * Py_aubio_window(PyObject *self, PyObject *args);
    1717
     18static char Py_aubio_level_lin_doc[] = ""
     19"level_lin(fvec) -> fvec\n"
     20"\n"
     21"Compute sound level on a linear scale.\n"
     22"\n"
     23"This gives the average of the square amplitudes.\n"
     24"\n"
     25"Example\n"
     26"-------\n"
     27"\n"
     28">>> level_Lin(numpy.ones(1024))\n"
     29"1.0";
     30
     31PyObject * Py_aubio_level_lin(PyObject *self, PyObject *args);
     32
     33static char Py_aubio_db_spl_doc[] = ""
     34"Compute sound pressure level (SPL) in dB\n"
     35"\n"
     36"This quantity is often wrongly called 'loudness'.\n"
     37"\n"
     38"This gives ten times the log10 of the average of the square amplitudes.\n"
     39"\n"
     40"Example\n"
     41"-------\n"
     42"\n"
     43">>> db_spl(numpy.ones(1024))\n"
     44"1.0";
     45
     46PyObject * Py_aubio_db_spl(PyObject *self, PyObject *args);
     47
    1848#endif /* _PY_AUBIO_MUSICUTILS_H_ */
Note: See TracChangeset for help on using the changeset viewer.