Changeset 1281e5c for doc


Ignore:
Timestamp:
May 18, 2006, 12:49:42 PM (19 years ago)
Author:
Paul Brossier <piem@altern.org>
Branches:
feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+
Children:
6e35163
Parents:
bab3161
Message:

update python manpages
update python manpages

Location:
doc
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • doc/aubiocut.sgml

    rbab3161 r1281e5c  
    110110  <option>--bufsize=BUFSIZE</option></term>
    111111  <listitem>
    112   <para>buffer size [default=1024]</para>
     112  <para>buffer size [default=512]</para>
    113113  </listitem>
    114114  </varlistentry>
    … …  
    117117  <option>--hopsize=HOPSIZE</option></term>
    118118  <listitem>
    119   <para>overlap size [default=512]</para>
     119  <para>overlap size [default=256]</para>
    120120  </listitem>
    121121  </varlistentry>
    … …  
    124124  <option>--threshold=THRESHOLD</option></term>
    125125  <listitem>
    126   <para>pitch threshold (for yin) [default=0.1]</para>
     126  <para>onset peak picking threshold [default=0.3]</para>
     127  </listitem>
     128  </varlistentry>
     129  <varlistentry>
     130  <term><option>-C</option>
     131  <option>--dcthreshold=DCTHRESHOLD</option></term>
     132  <listitem>
     133  <para>onset peak picking DC component [default=1.]</para>
    127134  </listitem>
    128135  </varlistentry>
    … …  
    135142  </varlistentry>
    136143  <varlistentry>
     144  <term><option>-M</option>
     145  <option>--mintol=MINIOI</option></term>
     146  <listitem>
     147  <para>minimum inter onset interval [default=0.048s]</para>
     148  </listitem>
     149  </varlistentry>
     150  <varlistentry>
    137151  <term><option>-D</option>
    138152  <option>--delay=DELAY</option></term>
    139153  <listitem>
    140154  <para>number of seconds to take back [default=system]
    141   default system delay is 2*hopsize/samplerate</para>
     155  default system delay is 3*hopsize/samplerate</para>
    142156  </listitem>
    143157  </varlistentry>
    … …  
    185199  </varlistentry>
    186200  <varlistentry>
     201  <term><option>-x</option>
     202  <option>--xsize=SIZE</option></term>
     203  <listitem>
     204  <para>define horizontal plot size [default=1.]</para>
     205  </listitem>
     206  </varlistentry>
     207  <varlistentry>
     208  <term><option>-y</option>
     209  <option>--ysize=SIZE</option></term>
     210  <listitem>
     211  <para>define vertical plot size [default=1.]</para>
     212  </listitem>
     213  </varlistentry>
     214  <varlistentry>
     215  <term><option>-f</option>
     216  <option>--function</option></term>
     217  <listitem>
     218  <para>print detection function</para>
     219  </listitem>
     220  </varlistentry>
     221  <varlistentry>
     222  <term><option>-n</option>
     223  <option>--no-onsets</option></term>
     224  <listitem>
     225  <para>do not plot detected onsets, only detection functions</para>
     226  </listitem>
     227  </varlistentry>
     228  <varlistentry>
    187229  <term><option>-O</option>
    188230  <option>--outplot=OUTPLOT</option></term>
    189231  <listitem>
    190   <para>save plot to output.{ps,png}</para>
     232  <para>save plot to output.{eps,ps,png,svg}</para>
    191233  </listitem>
    192234  </varlistentry>
    … …  
    209251  <option>--beat</option></term>
    210252  <listitem>
    211   <para>NOT IMPLEMENTED output beat locations</para>
     253  <para>detect beats and output beat locations</para>
    212254  </listitem>
    213255  </varlistentry>

  • doc/aubiopitch.sgml

    rbab3161 r1281e5c  
    140140  <option>--delay=DELAY</option></term>
    141141  <listitem>
    142   <para>number of seconds to take back [default=system]
    143   default system delay is 2*hopsize/samplerate</para>
    144   </listitem>
    145   </varlistentry>
    146   <varlistentry>
    147   <term><option>-L</option>
    148   <option>--localmin</option></term>
    149   <listitem>
    150   <para>use local minima after peak detection</para>
    151   </listitem>
    152   </varlistentry>
    153   <varlistentry>
    154   <term><option>-c</option>
    155   <option>--cut</option></term>
    156   <listitem>
    157   <para>cut input sound file at detected labels (best used with option -L)</para>
     142  <para>number of seconds to take back [default=0]</para>
     143  </listitem>
     144  </varlistentry>
     145  <varlistentry>
     146  <term><option>-S</option>
     147  <option>--smoothing=frames</option></term>
     148  <listitem>
     149  <para>temporal smoothing using a median filter of N frames [default=0]</para>
     150  </listitem>
     151  </varlistentry>
     152  <varlistentry>
     153  <term><option>-M</option>
     154  <option>--pitchmax=max</option></term>
     155  <listitem>
     156  <para>maximum pitch values to look for (Hz) [default=20000]</para>
     157  </listitem>
     158  </varlistentry>
     159  <varlistentry>
     160  <term><option>-l</option>
     161  <option>--pitchmin=min</option></term>
     162  <listitem>
     163  <para>minimum pitch values to look for (Hz) [default=20]</para>
    158164  </listitem>
    159165  </varlistentry>
    … …  
    169175  <option>--plot</option></term>
    170176  <listitem>
    171   <para>NOT IMPLEMENTED draw plot</para>
     177  <para>draw plot of the pitch track</para>
     178  </listitem>
     179  </varlistentry>
     180  <varlistentry>
     181  <term><option>-T</option>
     182  <option>--plottruth</option></term>
     183  <listitem>
     184  <para>draw plot of the ground truth pitch track</para>
    172185  </listitem>
    173186  </varlistentry>
    … …  
    176189  <option>--outplot=OUTPLOT</option></term>
    177190  <listitem>
    178   <para>NOT IMPLEMENTED save plot to output.{ps,png}</para>
     191  <para>save plot to output.{ps,eps,png,svg} instead of displaying it</para>
    179192  </listitem>
    180193  </varlistentry>
Note: See TracChangeset for help on using the changeset viewer.