From: Paul Brossier <piem@piem.org>
Date: Fri, 30 Sep 2016 12:48:18 +0000 (+0200)
Subject: help/aubioonset~-help.pd: improve documentation
X-Git-Url: https://git.aubio.org/?p=pd-aubio.git;a=commitdiff_plain;h=5abde1d4f40353e49da9d79b54eefb145f3822eb

help/aubioonset~-help.pd: improve documentation
---

diff --git a/help/aubioonset~-help.pd b/help/aubioonset~-help.pd
index 776aa37..df46e8e 100644
--- a/help/aubioonset~-help.pd
+++ b/help/aubioonset~-help.pd
@@ -1,10 +1,9 @@
-#N canvas 341 200 770 398 10;
+#N canvas 59 183 770 398 10;
 #X obj 20 53 adc~;
 #X obj 20 137 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
 -1;
 #X floatatom 94 65 5 0 0 0 - - -, f 5;
 #X obj 20 107 aubioonset~;
-#X text 55 278 - hopsize: block size of each analysis;
 #X text 156 94 Low values will increase the number of detections. High
 values will reduce them.;
 #X text 50 134 This is somewhat similar to the bonk~ object \, though
@@ -15,13 +14,10 @@ it may work on non-percussive attacks.;
 #X obj 516 270 aubioonset~ specdiff 0.8;
 #X obj 516 290 aubioonset~ 0.6 specflux;
 #X obj 516 310 aubioonset~ 9 centroid 1024;
-#X text 50 348 If hopsize is not specified \, it will be set to half
-of bufsize.;
 #X text 156 64 The right inlet can be used to set the onset detection
 threshold. Values between 0 and 10 are accepted.;
 #X text 51 309 All arguments are optional. 'threshold' and 'method'
 \, the first and second arguments \, can be swapped.;
-#X text 416 232 Some examples;
 #X obj 516 330 aubioonset~ complex 0.9 512 32;
 #X obj 516 351 aubioonset~ 0.3 phase 4096 2048;
 #X text 55 258 - bufsize: length of fft window [1024];
@@ -31,14 +27,18 @@ threshold. Values between 0 and 10 are accepted.;
 detection parameters.;
 #X text 51 16 aubioonset~ takes an input signal and outputs a bang
 when an 'onset' has been detected.;
+#X text 55 278 - hopsize: block size of each analysis [bufsize/2];
+#X text 440 232 Examples:;
+#X text 50 348 If not specified \, hopsize will be set to half of bufsize.
+Otherwise it should be at most 'bufsize'.;
 #X connect 0 0 3 0;
 #X connect 0 1 3 0;
 #X connect 2 0 3 1;
 #X connect 3 0 1 0;
-#X connect 7 0 9 0;
-#X connect 7 0 8 0;
-#X connect 7 0 10 0;
-#X connect 7 0 11 0;
-#X connect 7 0 12 0;
-#X connect 7 0 17 0;
-#X connect 7 0 18 0;
+#X connect 6 0 8 0;
+#X connect 6 0 7 0;
+#X connect 6 0 9 0;
+#X connect 6 0 10 0;
+#X connect 6 0 11 0;
+#X connect 6 0 14 0;
+#X connect 6 0 15 0;