annotate examples/puredata/xtract/xtract-help.pd @ 124:fc4bc58b92da

- fixed xtract_spread() -- now just calls xtract_spectral_variance()
author Jamie Bullock <jamie@postlude.co.uk>
date Thu, 31 Mar 2011 12:22:29 +0000
parents ca40a0dc29d6
children
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@98 9 #X obj 27 299 xtract~;
jamie@98 10 #X msg 27 270 help;
jamie@98 11 #X text 27 328 Other than this help message \, the data sent to the
jamie@98 12 left inlet should always be a 'signal' (i.e. audio rate). This is the
jamie@98 13 data from a which a given feature will be extracted.;
jamie@98 14 #X obj 183 520 xtract~ mean;
jamie@98 15 #X floatatom 133 616 10 0 0 0 - - -;
jamie@98 16 #X floatatom 254 553 5 0 0 0 - - -;
jamie@98 17 #X msg 183 552 list \$1;
jamie@98 18 #X obj 133 586 xtract~ variance;
jamie@98 19 #X obj 182 496 phasor~ 0.1;
jamie@98 20 #X text 40 671 Below are some possible use cases (click to open):;
jamie@98 21 #X text 27 382 The outlet may be a scalar (control rate) \, or a vector
jamie@98 22 (audio rate) \, depending on the nature of the feature that is being
jamie@98 23 extracted.;
jamie@98 24 #X obj 43 695 f0;
jamie@98 25 #X obj 84 695 mfcc;
jamie@98 26 #X text 28 435 Any additional arguments that need to be passed to the
jamie@98 27 feature extraction function must be provided as a list to the right
jamie@98 28 inlet \, e.g.;
jamie@98 29 #X text 24 231 A complete list of features may be obtained by sending
jamie@98 30 the external a |help( message:;
jamie@25 31 #X text 20 148 [xtract~] must always be called with one argument \,
jamie@25 32 in the following form: [xtract~ <feature>] \, where <feature> is a
jamie@98 33 feature supported by the LibXtract library.;
jamie@98 34 #X text 21 198 An optional second argument can be used to explicitly
jamie@98 35 set the blocksize for FFT-based features;
jamie@98 36 #X connect 4 0 3 0;
jamie@98 37 #X connect 6 0 8 0;
jamie@98 38 #X connect 6 0 9 0;
jamie@98 39 #X connect 9 0 10 1;
jamie@98 40 #X connect 10 0 7 0;
jamie@98 41 #X connect 11 0 6 0;
jamie@98 42 #X connect 11 0 10 0;