ref: 673d7e3259ce178b3b2e3228221887af026a6e78
dir: /python/ext/aubio-docstrings.h/
#define PYAUBIO_dct_doc \
"dct(size=1024)\n"\
"\n"\
"Compute Discrete Fourier Transforms of Type-II.\n"\
"\n"\
"Parameters\n"\
"----------\n"\
"size : int\n"\
" size of the DCT to compute\n"\
"\n"\
"Example\n"\
"-------\n"\
">>> d = aubio.dct(16)\n"\
">>> d.size\n"\
"16\n"\
">>> x = aubio.fvec(np.ones(d.size))\n"\
">>> d(x)\n"\
"array([4., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0., 0.],\n"\
" dtype=float32)\n"\
">>> d.rdo(d(x))\n"\
"array([1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1., 1.],\n"\
" dtype=float32)\n"\
"\n"\
"References\n"\
"----------\n"\
"`DCT-II in Discrete Cosine Transform\n"\
"<https://en.wikipedia.org/wiki/Discrete_cosine_transform#DCT-II>`_\n"\
"on Wikipedia.\n"
#define PYAUBIO_mfcc_doc \
"mfcc(buf_size=1024, n_filters=40, n_coeffs=13, samplerate=44100)\n"\
"\n"\
"Compute Mel Frequency Cepstrum Coefficients (MFCC).\n"\
"\n"\
"`mfcc` creates a callable which takes a `cvec` as input.\n"\
"\n"\
"If `n_filters = 40`, the filterbank will be initialized with\n"\
":meth:`filterbank.set_mel_coeffs_slaney`. Otherwise, if `n_filters`\n"\
"is greater than `0`, it will be initialized with\n"\
":meth:`filterbank.set_mel_coeffs` using `fmin = 0`,\n"\
"`fmax = samplerate/`.\n"\
"\n"\
"Example\n"\
"-------\n"\
">>> buf_size = 2048; n_filters = 128; n_coeffs = 13; samplerate = 44100\n"\
">>> mf = aubio.mfcc(buf_size, n_filters, n_coeffs, samplerate)\n"\
">>> fftgrain = aubio.cvec(buf_size)\n"\
">>> mf(fftgrain).shape\n"\
"(13,)\n"\
""
#define PYAUBIO_notes_doc \
"notes(method=\"default\", buf_size=1024, hop_size=512, samplerate=44100)\n"\
"\n"\
"Note detection\n"
#define PYAUBIO_onset_doc \
"onset(method=\"default\", buf_size=1024, hop_size=512, samplerate=44100)\n"\
"\n"\
"Onset detection object. `method` should be one of method supported by\n"\
":class:`specdesc`.\n"
#define PYAUBIO_pitch_doc \
"pitch(method=\"default\", buf_size=1024, hop_size=512, samplerate=44100)\n"\
"\n"\
"Pitch detection.\n"\
"\n"\
"Supported methods: `yinfft`, `yin`, `yinfast`, `fcomb`, `mcomb`,\n"\
"`schmitt`, `specacf`, `default` (`yinfft`).\n"
#define PYAUBIO_sampler_doc \
"sampler(hop_size=512, samplerate=44100)\n"\
"\n"\
"Sampler.\n"
#define PYAUBIO_specdesc_doc \
"specdesc(method=\"default\", buf_size=1024)\n"\
"\n"\
"Spectral description functions. Creates a callable that takes a\n"\
":class:`cvec` as input, typically created by :class:`pvoc` for\n"\
"overlap and windowing, and returns a single float.\n"\
"\n"\
"`method` can be any of the values listed below. If `default` is used\n"\
"the `hfc` function will be selected.\n"\
"\n"\
"Onset novelty functions:\n"\
"\n"\
"- `energy`: local energy,\n"\
"- `hfc`: high frequency content,\n"\
"- `complex`: complex domain,\n"\
"- `phase`: phase-based method,\n"\
"- `wphase`: weighted phase deviation,\n"\
"- `specdiff`: spectral difference,\n"\
"- `kl`: Kullback-Liebler,\n"\
"- `mkl`: modified Kullback-Liebler,\n"\
"- `specflux`: spectral flux.\n"\
"\n"\
"Spectral shape functions:\n"\
"\n"\
"- `centroid`: spectral centroid (barycenter of the norm vector),\n"\
"- `spread`: variance around centroid,\n"\
"- `skewness`: third order moment,\n"\
"- `kurtosis`: a measure of the flatness of the spectrum,\n"\
"- `slope`: decreasing rate of the amplitude,\n"\
"- `decrease`: perceptual based measurement of the decreasing rate,\n"\
"- `rolloff`: 95th energy percentile.\n"\
"\n"\
"Parameters\n"\
"----------\n"\
"method : str\n"\
" Onset novelty or spectral shape function.\n"\
"buf_size : int\n"\
" Length of the input frame.\n"\
"\n"\
"Example\n"\
"-------\n"\
">>> win_s = 1024; hop_s = win_s // 2\n"\
">>> pv = aubio.pvoc(win_s, hop_s)\n"\
">>> sd = aubio.specdesc(\"mkl\", win_s)\n"\
">>> sd(pv(aubio.fvec(hop_s))).shape\n"\
"(1,)\n"\
"\n"\
"References\n"\
"----------\n"\
"`Detailed description "\
"<https://aubio.org/doc/latest/specdesc_8h.html#details>`_ in\n"\
"`aubio API documentation <https://aubio.org/doc/latest/index.html>`_.\n"\
""
#define PYAUBIO_tempo_doc \
"tempo(method=\"default\", buf_size=1024, hop_size=512, samplerate=44100)\n"\
"\n"\
"Tempo detection and beat tracking.\n"
#define PYAUBIO_tss_doc \
"tss(buf_size=1024, hop_size=512)\n"\
"\n"\
"Transient/Steady-state separation.\n"
#define PYAUBIO_wavetable_doc \
"wavetable(samplerate=44100, hop_size=512)\n"\
"\n"\
"Wavetable synthesis.\n"