help/aubioonset~-help.pd: document new parameters
[pd-aubio.git] / help / aubioonset~-help.pd
1 #N canvas 341 200 770 398 10;
2 #X obj 20 53 adc~;
3 #X obj 20 137 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
4 -1;
5 #X floatatom 94 65 5 0 0 0 - - -, f 5;
6 #X obj 20 107 aubioonset~;
7 #X text 55 278 - hopsize: block size of each analysis;
8 #X text 156 94 Low values will increase the number of detections. High
9 values will reduce them.;
10 #X text 50 134 This is somewhat similar to the bonk~ object \, though
11 it may work on non-percussive attacks.;
12 #X msg 516 188 debug;
13 #X obj 516 250 aubioonset~ mkl;
14 #X obj 516 230 aubioonset~ 0.7;
15 #X obj 516 270 aubioonset~ specdiff 0.8;
16 #X obj 516 290 aubioonset~ 0.6 specflux;
17 #X obj 516 310 aubioonset~ 9 centroid 1024;
18 #X text 50 348 If hopsize is not specified \, it will be set to half
19 of bufsize.;
20 #X text 156 64 The right inlet can be used to set the onset detection
21 threshold. Values between 0 and 10 are accepted.;
22 #X text 51 309 All arguments are optional. 'threshold' and 'method'
23 \, the first and second arguments \, can be swapped.;
24 #X text 416 232 Some examples;
25 #X obj 516 330 aubioonset~ complex 0.9 512 32;
26 #X obj 516 351 aubioonset~ 0.3 phase 4096 2048;
27 #X text 55 258 - bufsize: length of fft window [1024];
28 #X text 55 237 - method: could be any specdesc [default];
29 #X text 54 217 - threshold: initial threshold [0.3];
30 #X text 52 181 The creation arguments can be used to set the onset
31 detection parameters.;
32 #X text 51 16 aubioonset~ takes an input signal and outputs a bang
33 when an 'onset' has been detected.;
34 #X connect 0 0 3 0;
35 #X connect 0 1 3 0;
36 #X connect 2 0 3 1;
37 #X connect 3 0 1 0;
38 #X connect 7 0 9 0;
39 #X connect 7 0 8 0;
40 #X connect 7 0 10 0;
41 #X connect 7 0 11 0;
42 #X connect 7 0 12 0;
43 #X connect 7 0 17 0;
44 #X connect 7 0 18 0;