Changeset 57ce9b2


Ignore:
Timestamp:
Oct 26, 2018, 6:10:43 PM (14 months ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master
Children:
7df8df7
Parents:
e3c4d00
Message:

[python] add docstrings to bintomidi and miditobin

File:
1 edited

Legend:

Unmodified
Added
Removed
  • python/ext/aubiomodule.c

    re3c4d00 r57ce9b2  
    2121
    2222static char Py_bintomidi_doc[] = ""
    23 "bintomidi(float, samplerate = integer, fftsize = integer) -> float\n"
    24 "\n"
    25 "Convert bin (float) to midi (float), given the sampling rate and the FFT size\n"
    26 "\n"
    27 "Example\n"
    28 "-------\n"
    29 "\n"
    30 ">>> midi = bintomidi(float, samplerate = 44100, fftsize = 1024)";
     23"bintomidi(fftbin, samplerate, fftsize)\n"
     24"\n"
     25"Convert FFT bin to frequency in midi note, given the sampling rate\n"
     26"and the size of the FFT.\n"
     27"\n"
     28"Parameters\n"
     29"----------\n"
     30"fftbin : float\n"
     31"   input frequency bin\n"
     32"samplerate : float\n"
     33"   sampling rate of the signal\n"
     34"fftsize : float\n"
     35"   size of the FFT\n"
     36"\n"
     37"Returns\n"
     38"-------\n"
     39"float\n"
     40"   Frequency converted to midi note.\n"
     41"\n"
     42"Example\n"
     43"-------\n"
     44"\n"
     45">>> aubio.bintomidi(10, 44100, 1024)\n"
     46"68.62871551513672\n"
     47"";
    3148
    3249static char Py_miditobin_doc[] = ""
    33 "miditobin(float, samplerate = integer, fftsize = integer) -> float\n"
    34 "\n"
    35 "Convert midi (float) to bin (float), given the sampling rate and the FFT size\n"
    36 "\n"
    37 "Example\n"
    38 "-------\n"
    39 "\n"
    40 ">>> bin = miditobin(midi, samplerate = 44100, fftsize = 1024)";
     50"miditobin(midi, samplerate, fftsize)\n"
     51"\n"
     52"Convert frequency in midi note to FFT bin, given the sampling rate\n"
     53"and the size of the FFT.\n"
     54"\n"
     55"Parameters\n"
     56"----------\n"
     57"midi : float\n"
     58"   input frequency, in midi note\n"
     59"samplerate : float\n"
     60"   sampling rate of the signal\n"
     61"fftsize : float\n"
     62"   size of the FFT\n"
     63"\n"
     64"Returns\n"
     65"-------\n"
     66"float\n"
     67"   Frequency converted to FFT bin.\n"
     68"\n"
     69"Examples\n"
     70"--------\n"
     71"\n"
     72">>> aubio.miditobin(69, 44100, 1024)\n"
     73"10.216779708862305\n"
     74">>> aubio.miditobin(75.08, 32000, 512)\n"
     75"10.002175331115723\n"
     76"";
    4177
    4278static char Py_bintofreq_doc[] = ""
Note: See TracChangeset for help on using the changeset viewer.