Mercurial > hg > massef

annotate help_html/source/help_MASSEF.m @ 38:c7d11a428a0d tip master

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge branch 'develop' * develop: Updated copyright year.
author Christopher Hummersone <c.hummersone@surrey.ac.uk>
date Tue, 16 May 2017 12:15:34 +0100
parents 8f36d7072f2f
children
rev   line source
c@0 1 %% MASSEF
c@0 2 % Multichannel audio source separation evaluation framework.
c@0 3 %
c@0 4 %% Syntax
c@0 5 %
c@0 6 % massef = MASSEF
c@0 7 % massef = MASSEF(options)
c@0 8 %
c@0 9 % |massef = MASSEF| instantiates the multichannel audio source separation
c@0 10 % evaluation framework, returning an instance to |massef|. The instance has
c@0 11 % the <help_MASSEF.html#2 properties described below>. Evaluations are
c@0 12 % performed using the <help_MASSEF_evaluate.html evaluate> or
c@0 13 % <help_MASSEF_execute.html execute> methods. See <help_MASSEF.html#3
c@0 14 % methods> below for a list of methods.
c@0 15 %
c@0 16 % |massef = MASSEF(options)| instantiates MASSEF using the options
c@0 17 % contained in the scalar structure |options|. See <help_MASSEF.html#2
c@0 18 % properties> below for a description of valid fields.
c@0 19 %
c@0 20 %% Properties
c@0 21 % <html>
c@0 22 % <table>
c@0 23 % <tr>
c@0 24 % <td><tt>blocksize</tt></td>
c@0 25 % <td>When using the parallel computing toolbox, this parameter determines
c@0 26 % the maximum number of <tt>parallel.FevalFuture</tt> objects that are
c@0 27 % considered at any one time. The default is 128.</td>
c@0 28 % </tr>
c@0 29 % <tr>
c@15 30 % <td><tt>creationDate</tt></td>
c@15 31 % <td>Date the object was created (read-only).</td>
c@15 32 % </tr>
c@15 33 % <tr>
c@0 34 % <td><tt>dir</tt></td>
c@0 35 % <td>The MASSEF installation directory (read-only).</td>
c@0 36 % </tr>
c@0 37 % <tr>
c@0 38 % <td><tt>evalPEASS</tt></td>
c@0 39 % <td>A logical value indicating whether PEASS evaluation should be
c@0 40 % executed. The default is <tt>false</tt>.</td>
c@0 41 % </tr>
c@0 42 % <tr>
c@0 43 % <td><tt>evalSTOI</tt></td>
c@0 44 % <td>A logical value indicating whether STOI evaluation should be
c@0 45 % executed. The default is <tt>false</tt>.</td>
c@0 46 % </tr>
c@0 47 % <td><tt>parpool</tt></td>
c@0 48 % <td>A <tt>parallel.Pool</tt> object on which to perform the parallel
c@0 49 % separations. If the parallel computing toolbox is available,
c@0 50 % <tt>MASSEF</tt> will use the current pool by default (as determined
c@0 51 % by <tt>gcp('nocreate')</tt>), if one is open. If the toolbox is not
c@0 52 % available, or no pool is open, separations will be performed
c@0 53 % serially.</td>
c@0 54 % </tr>
c@0 55 % <tr>
c@0 56 % <td><tt>results</tt></td>
c@0 57 % <td>A <a href="help_MASSEFresults.html">MASSEFresults</a> object containing
c@0 58 % results generated by the framework (read-only).</td>
c@0 59 % </tr>
c@0 60 % <tr>
c@0 61 % <td><tt>results_filename</tt></td> <td>The name of the results file
c@0 62 % returned when <a
c@0 63 % href="help_MASSEF_execute.html">MASSEF.execute</a> finishes.
c@0 64 % The default is <tt>'Results/results.mat'</tt>.</td>
c@0 65 % </tr>
c@15 66 % <tr>
c@15 67 % <td><tt>saveDate</tt></td>
c@15 68 % <td>Date the object was last saved (read-only).</td>
c@15 69 % </tr>
c@0 70 % </table>
c@0 71 % </html>
c@0 72 %
c@0 73 %% Methods
c@0 74 %
c@0 75 % Methods:
c@0 76 %
c@0 77 % <html>
c@0 78 % <table>
c@0 79 % <tr>
c@0 80 % <td>MASSEF</td>
c@0 81 % <td>Create an instance of MASSEF.</td>
c@0 82 % </tr>
c@0 83 % <tr>
c@0 84 % <td><a href="help_MASSEF_evaluate.html">evaluate</a></td>
c@0 85 % <td>Run the framework using the input audio files.</td>
c@0 86 % </tr>
c@0 87 % <tr>
c@0 88 % <td><a href="help_MASSEF_execute.html">execute</a></td>
c@0 89 % <td>Run the framework using the input mixtures and separators.</td>
c@0 90 % </tr>
c@15 91 % <tr>
c@15 92 % <td><a href="help_MASSEF_save.html">save</a></td>
c@15 93 % <td>Save the framework's data and results.</td>
c@15 94 % </tr>
c@0 95 % </table>
c@0 96 % </html>
c@0 97 %
c@0 98 % Static methods:
c@0 99 %
c@0 100 % <html>
c@0 101 % <table>
c@15 102 % <tr>
c@15 103 % <td><a href="help_MASSEF_doc.html">doc</a></td>
c@15 104 % <td>Display the framework documentation.</td>
c@0 105 % </tr>
c@0 106 % <tr>
c@0 107 % <td><a href="help_MASSEF_install.html">install</a></td>
c@0 108 % <td>Download and install MASSEF dependencies.</td>
c@0 109 % </tr>
c@0 110 % <tr>
c@0 111 % <td><a href="help_MASSEF_start.html">start</a></td>
c@0 112 % <td>Start the framework.</td>
c@15 113 % </tr>
c@0 114 % </table>
c@0 115 % </html>
c@0 116 %
c@0 117 %% See also
c@0 118 % <help_MASSEFresults.html MASSEFresults>.
c@0 119 %
c@0 120 % <html>
c@0 121 % <hr>
c@37 122 % <p>Copyright &copy; 2017 <a href="http://www.surrey.ac.uk">University of Surrey</a><br>
c@0 123 % <a href="http://iosr.uk">Institute of Sound Recording, University of Surrey, UK</a></p>
c@0 124 % </html>