Changeset d91566e for python


Ignore:
Timestamp:
Dec 7, 2018, 1:14:58 PM (12 months ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/timestretch, master
Children:
e45345d
Parents:
a4df8aa
Message:

[py] improve specdesc dosctring

File:
1 edited

Legend:

Unmodified
Added
Removed
  • python/ext/aubio-docstrings.h

    ra4df8aa rd91566e  
    7777    "specdesc(method=\"default\", buf_size=1024)\n"\
    7878    "\n"\
    79     "Spectral descriptor.\n"\
     79    "Spectral description functions. Creates a callable that takes a\n"\
     80    ":class:`cvec` as input, typically created by :class:`pvoc` for\n"\
     81    "overlap and windowing, and returns a single float.\n"\
    8082    "\n"\
    81     "Onset novelty methods: `energy`, `hfc`, `complex`, `phase`, `wphase`,\n"\
    82     "`specdiff`, `kl`, `mkl`, `specflux`.\n"\
     83    "`method` can be any of the values listed below. If `default` is used\n"\
     84    "the `hfc` function will be selected.\n"\
    8385    "\n"\
    84     "Shape description methods: `centroid`, `spread`, `skewness`,\n"\
    85     "`slope`, `decrease`, `rolloff`.\n"\
     86    "Onset novelty functions:\n"\
     87    "\n"\
     88    "- `energy`: local energy,\n"\
     89    "- `hfc`: high frequency content,\n"\
     90    "- `complex`: complex domain,\n"\
     91    "- `phase`: phase-based method,\n"\
     92    "- `wphase`: weighted phase deviation,\n"\
     93    "- `specdiff`: spectral difference,\n"\
     94    "- `kl`: Kullback-Liebler,\n"\
     95    "- `mkl`: modified Kullback-Liebler,\n"\
     96    "- `specflux`: spectral flux.\n"\
     97    "\n"\
     98    "Spectral shape functions:\n"\
     99    "\n"\
     100    "- `centroid`: spectral centroid (barycenter of the norm vector),\n"\
     101    "- `spread`: variance around centroid,\n"\
     102    "- `skewness`: third order moment,\n"\
     103    "- `kurtosis`: a measure of the flatness of the spectrum,\n"\
     104    "- `slope`: decreasing rate of the amplitude,\n"\
     105    "- `decrease`: perceptual based measurement of the decreasing rate,\n"\
     106    "- `rolloff`: 95th energy percentile.\n"\
    86107    "\n"\
    87108    "Parameters\n"\
    88109    "----------\n"\
    89110    "method : str\n"\
    90     "    Onset novelty or shape description method.\n"\
     111    "    Onset novelty or spectral shape function.\n"\
    91112    "buf_size : int\n"\
    92     "    Length of the input frame.\n"
     113    "    Length of the input frame.\n"\
     114    "\n"\
     115    "Example\n"\
     116    "-------\n"\
     117    ">>> win_s = 1024; hop_s = win_s // 2\n"\
     118    ">>> pv = aubio.pvoc(win_s, hop_s)\n"\
     119    ">>> sd = aubio.specdesc(\"mkl\", win_s)\n"\
     120    ">>> sd(pv(aubio.fvec(hop_s))).shape\n"\
     121    "(1,)\n"\
     122    "\n"\
     123    "References\n"\
     124    "----------\n"\
     125    "`Detailed description "\
     126    "<https://aubio.org/doc/latest/specdesc_8h.html#details>`_ in\n"\
     127    "`aubio API documentation <https://aubio.org/doc/latest/index.html>`_.\n"\
     128    ""
    93129
    94130#define PYAUBIO_tempo_doc \
Note: See TracChangeset for help on using the changeset viewer.