ref: 1281e5ca7d04d290951683ccc8a28fce1a34b4af
parent: bab3161a43801436e6ec80e3e5a87026e9630771
author: Paul Brossier <piem@altern.org>
date: Thu May 18 06:49:42 EDT 2006
update python manpages update python manpages
--- a/doc/aubiocut.sgml
+++ b/doc/aubiocut.sgml
@@ -109,7 +109,7 @@
<term><option>-B</option>
<option>--bufsize=BUFSIZE</option></term>
<listitem>
- <para>buffer size [default=1024]</para>
+ <para>buffer size [default=512]</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -116,7 +116,7 @@
<term><option>-H</option>
<option>--hopsize=HOPSIZE</option></term>
<listitem>
- <para>overlap size [default=512]</para>
+ <para>overlap size [default=256]</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -123,10 +123,17 @@
<term><option>-t</option>
<option>--threshold=THRESHOLD</option></term>
<listitem>
- <para>pitch threshold (for yin) [default=0.1]</para>
+ <para>onset peak picking threshold [default=0.3]</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-C</option>
+ <option>--dcthreshold=DCTHRESHOLD</option></term>
+ <listitem>
+ <para>onset peak picking DC component [default=1.]</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>-s</option>
<option>--silence=SILENCE</option></term>
<listitem>
@@ -134,11 +141,18 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-M</option>
+ <option>--mintol=MINIOI</option></term>
+ <listitem>
+ <para>minimum inter onset interval [default=0.048s]</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>-D</option>
<option>--delay=DELAY</option></term>
<listitem>
<para>number of seconds to take back [default=system]
- default system delay is 2*hopsize/samplerate</para>
+ default system delay is 3*hopsize/samplerate</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -184,10 +198,38 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-x</option>
+ <option>--xsize=SIZE</option></term>
+ <listitem>
+ <para>define horizontal plot size [default=1.]</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-y</option>
+ <option>--ysize=SIZE</option></term>
+ <listitem>
+ <para>define vertical plot size [default=1.]</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-f</option>
+ <option>--function</option></term>
+ <listitem>
+ <para>print detection function</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-n</option>
+ <option>--no-onsets</option></term>
+ <listitem>
+ <para>do not plot detected onsets, only detection functions</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>-O</option>
<option>--outplot=OUTPLOT</option></term>
<listitem>
- <para>save plot to output.{ps,png}</para>+ <para>save plot to output.{eps,ps,png,svg}</para></listitem>
</varlistentry>
<varlistentry>
@@ -208,7 +250,7 @@
<term><option>-b</option>
<option>--beat</option></term>
<listitem>
- <para>NOT IMPLEMENTED output beat locations</para>
+ <para>detect beats and output beat locations</para>
</listitem>
</varlistentry>
</variablelist>
--- a/doc/aubiopitch.sgml
+++ b/doc/aubiopitch.sgml
@@ -139,25 +139,31 @@
<term><option>-D</option>
<option>--delay=DELAY</option></term>
<listitem>
- <para>number of seconds to take back [default=system]
- default system delay is 2*hopsize/samplerate</para>
+ <para>number of seconds to take back [default=0]</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-L</option>
- <option>--localmin</option></term>
+ <term><option>-S</option>
+ <option>--smoothing=frames</option></term>
<listitem>
- <para>use local minima after peak detection</para>
+ <para>temporal smoothing using a median filter of N frames [default=0]</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-c</option>
- <option>--cut</option></term>
+ <term><option>-M</option>
+ <option>--pitchmax=max</option></term>
<listitem>
- <para>cut input sound file at detected labels (best used with option -L)</para>
+ <para>maximum pitch values to look for (Hz) [default=20000]</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-l</option>
+ <option>--pitchmin=min</option></term>
+ <listitem>
+ <para>minimum pitch values to look for (Hz) [default=20]</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>-n</option>
<option>--note</option></term>
<listitem>
@@ -168,14 +174,21 @@
<term><option>-p</option>
<option>--plot</option></term>
<listitem>
- <para>NOT IMPLEMENTED draw plot</para>
+ <para>draw plot of the pitch track</para>
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>-T</option>
+ <option>--plottruth</option></term>
+ <listitem>
+ <para>draw plot of the ground truth pitch track</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>-O</option>
<option>--outplot=OUTPLOT</option></term>
<listitem>
- <para>NOT IMPLEMENTED save plot to output.{ps,png}</para>+ <para>save plot to output.{ps,eps,png,svg} instead of displaying it</para></listitem>
</varlistentry>
<varlistentry>