Reformatted and enhanced the cyclone help-patches.

svn path=/trunk/externals/miXed/; revision=17422

1 files changed, 82 insertions, 46 deletions

diff --git a/doc/help/cyclone/average~-help.pd b/doc/help/cyclone/average~-help.pd
index 00560a5..e37ea55 100644
--- a/doc/help/cyclone/average~-help.pd
+++ b/doc/help/cyclone/average~-help.pd
@@ -1,52 +1,88 @@
-#N canvas 0 26 590 632 10;
-#X text 29 515 rms--computes the square root of the average of the
-sample values squared.;
-#X text 29 490 absolute--averages the absolute values of the samples.
+#N canvas 524 79 569 531 10;
+#X obj 0 602 cnv 15 552 21 empty empty empty 20 12 0 14 -233017 -33289
+0;
+#X obj 1 295 cnv 3 550 3 empty empty inlets 8 12 0 13 -228856 -1 0
 ;
-#X text 29 476 bipolar--averages the sample values.;
-#X text 15 35 reports various forms of average value of signal;
-#X obj 202 71 cycle~ 2;
-#X obj 135 71 cycle~ 100;
-#X floatatom 311 174 0 0 0 0 - - -;
-#X msg 358 132 rms;
-#X msg 242 132 bipolar;
-#X msg 298 132 absolute;
-#X obj 172 115 *~;
-#X text 337 174 int sets averaging interval \, in samples;
-#X text 385 132 change modes with messages:;
-#X text 20 374 optional arguments: int - sets maximum averaging interval.
-default is 100 symbol - sets mode \, as shown above. default is bipolar.
+#N canvas 640 421 399 237 META 0;
+#X text 1 20 LICENSE SIBSD;
+#X text 1 100 LIBRARY cyclone;
+#X text 1 60 INLET_0 signal message float;
+#X text 1 80 OUTLET_0 float;
+#X text 1 40 DESCRIPTION reports various forms of average value of
+signal;
+#X text 1 0 KEYWORDS average mean audio signal;
+#X text 0 119 VERSION 0.1-alpha57;
+#X text 0 137 AUTHOR Krzysztof Czaja;
+#X text 1 155 RELEASE_DATE 2002;
+#X text 2 174 WEBSITE http://suita.chopin.edu.pl/~czaja/miXed/externs/cyclone.html
 ;
-#X text 20 424 average~ reports the running mean amplitude of a signal
-\, averaged over a specified number of samples. There are three methods
-of averaging available:;
-#X text 19 552 RMS values are often used to measure signal levels.
+#X text 2 206 HELP_PATCH_AUTHORS Christoph Kummerer. Revised by Jonathan
+Wilkes for Pd-extended 0.42 to conform to the PDDP template. Alex Cleveland
+updated this patch for Pd-l2ork version 2013.05.28. Fred Jan Kraan
+adapted the patch to pd-extended 2015-02-02;
+#X restore 500 605 pd META;
+#X obj 1 406 cnv 3 550 3 empty empty outlets 8 12 0 13 -228856 -1 0
+;
+#X obj 1 467 cnv 3 550 3 empty empty arguments 8 12 0 13 -228856 -1
+0;
+#X obj 1 521 cnv 3 550 3 empty empty more_info 8 12 0 13 -228856 -1
+0;
+#N canvas 155 571 428 92 Related_objects 0;
+#X obj 0 0 cnv 15 425 20 empty empty empty 3 12 0 14 -204280 -1 0;
+#X text 6 1 Related Objects;
+#X obj 6 29 cyclone/avg~;
+#X restore 199 605 pd Related_objects;
+#X obj 77 421 cnv 17 3 17 empty empty 0 5 9 0 16 -228856 -162280 0
+;
+#X obj 1 0 cnv 15 552 40 empty empty average~ 3 12 0 18 -204280 -1
+0;
+#X text 102 308 signal;
+#X text 102 420 float;
+#X text 90 537 RMS values are often used to measure signal levels.
 The RMS mode of the average~ object is considerably more CPU intensive
 than the absolute mode. The absolute mode often works as well as the
 RMS mode in many level-detection tasks.;
-#X obj 22 224 Scope~ 130 130 256 3 128 -1 1 0 0 0 0 102 255 51 135
-135 135 0;
-#X obj 172 201 average~ 1000;
-#X floatatom 172 236 5 0 0 0 - - -;
-#N canvas 311 282 494 386 META 0;
-#X text 12 155 HELP_PATCH_AUTHORS Christoph Kummerer. Revised by Jonathan
-Wilkes for Pd-extended 0.42 to conform to the PDDP template.;
-#X text 12 125 WEBSITE http://suita.chopin.edu.pl/~czaja/miXed/externs/cyclone.html
+#X text 12 23 reports various forms of average value of signal;
+#X obj 165 73 cycle~ 2;
+#X obj 148 48 cycle~ 100;
+#X floatatom 311 111 0 0 0 0 - - -;
+#X msg 354 73 rms;
+#X msg 238 73 bipolar;
+#X msg 294 73 absolute;
+#X obj 149 99 *~;
+#X floatatom 149 268 5 0 0 0 - - -;
+#X text 102 329 message;
+#X text 169 414 average~ reports the running mean amplitude of a signal
+\, averaged over a specified number of samples. There are three methods
+of averaging available:;
+#X obj 495 2 average~;
+#X text 89 479 1) float - sets maximum averaging interval. default
+is 100 2) message - sets mode \, as shown above. default is bipolar.
 ;
-#X text 12 5 KEYWORDS signal max_compatible conversion;
-#X text 12 45 DESCRIPTION report various forms of average value of
-signal;
-#X text 12 65 INLET_0 signal float bipolar absolute rms;
-#X text 12 85 OUTLET_0 float;
-#X text 12 25 LICENSE SIBSD;
-#X text 12 105 AUTHOR Krzysztof Czaja;
-#X restore 541 612 pd META;
-#X connect 4 0 10 1;
-#X connect 5 0 10 0;
-#X connect 6 0 17 0;
-#X connect 7 0 17 0;
-#X connect 8 0 17 0;
-#X connect 9 0 17 0;
-#X connect 10 0 16 0;
-#X connect 10 0 17 0;
-#X connect 17 0 18 0;
+#X obj 77 311 cnv 17 3 80 empty empty 0 5 9 0 16 -228856 -162280 0
+;
+#X text 102 377 float;
+#X obj 83 153 vsl 15 128 -1 1 0 0 empty empty empty 0 -9 0 10 -262144
+-1 -1 4663 1;
+#X msg 343 137 500;
+#X msg 375 137 1000;
+#X msg 311 137 10;
+#X obj 149 209 cyclone/average~ 1000;
+#X obj 520 260 dspSwitch~;
+#X text 169 328 - bipolar: -sets bipolar average mode.;
+#X text 169 344 - absolute: -sets absolute average mode.;
+#X text 169 359 - rms: -sets roor mean square (RMS) average mode.;
+#X text 169 307 - the signal to average;
+#X text 169 377 - the number of samples the average is applied to;
+#X connect 13 0 19 1;
+#X connect 14 0 19 0;
+#X connect 15 0 31 0;
+#X connect 16 0 31 0;
+#X connect 17 0 31 0;
+#X connect 18 0 31 0;
+#X connect 19 0 31 0;
+#X connect 28 0 31 0;
+#X connect 29 0 31 0;
+#X connect 30 0 31 0;
+#X connect 31 0 20 0;
+#X connect 31 0 27 0;