annotate examples/puredata/xtract/xtract-help.pd @ 62:1222cd753029

Improvements an fixes to PD example and help files
author Jamie Bullock <jamie@postlude.co.uk>
date Mon, 12 Mar 2007 18:20:43 +0000
parents 43332188a780
children ca40a0dc29d6
rev   line source
jamie@25 1 #N canvas 685 60 450 725 10;
jamie@25 2 #X text 21 12 [xtract~];
jamie@25 3 #X text 24 19 ________;
jamie@25 4 #X text 22 52 [xtract~] provides a wrapper for the feature extraction
jamie@25 5 library: LibXtract. Please refer to the documentation at libxtract.sourceforge.net
jamie@25 6 \, for a full explanation of the library and the functions it provides.
jamie@25 7 Only the operation of the PD external will be explained here along
jamie@25 8 with a few use case scenarios.;
jamie@25 9 #X text 20 148 [xtract~] must always be called with one argument \,
jamie@25 10 in the following form: [xtract~ <feature>] \, where <feature> is a
jamie@25 11 feature supported by the LibXtract library. A complete list of features
jamie@25 12 may be obtained by sending the external a |help( message:;
jamie@25 13 #X obj 27 262 xtract~;
jamie@25 14 #X msg 27 233 help;
jamie@25 15 #X text 26 298 Other than this help message \, the data sent to the
jamie@25 16 left inlet should always be a 'signal' (i.e. audio rate). This is the
jamie@25 17 data from a which a given feature will be extracted.;
jamie@25 18 #X obj 182 490 xtract~ mean;
jamie@25 19 #X floatatom 132 586 10 0 0 0 - - -;
jamie@25 20 #X floatatom 253 523 5 0 0 0 - - -;
jamie@25 21 #X msg 182 522 list \$1;
jamie@25 22 #X obj 132 556 xtract~ variance;
jamie@25 23 #X obj 181 466 phasor~ 0.1;
jamie@25 24 #X text 39 641 Below are some possible use cases (click to open):;
jamie@25 25 #X text 26 352 The outlet may be a scalar (control rate) \, or a vector
jamie@25 26 (audio rate) \, depending on the nature of the feature that is being
jamie@25 27 extracted.;
jamie@27 28 #X obj 42 665 f0;
jamie@27 29 #X obj 83 665 mfcc;
jamie@62 30 #X text 27 405 Any additional arguments that need to be passed to the
jamie@62 31 feature extraction function must be provided as a list to the right
jamie@62 32 inlet \, e.g.;
jamie@25 33 #X connect 5 0 4 0;
jamie@62 34 #X connect 7 0 9 0;
jamie@62 35 #X connect 7 0 10 0;
jamie@62 36 #X connect 10 0 11 1;
jamie@62 37 #X connect 11 0 8 0;
jamie@62 38 #X connect 12 0 7 0;
jamie@62 39 #X connect 12 0 11 0;