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

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.execute
c@0 2 % Run MASSEF using input audio files.
c@0 3 %
c@0 4 %% Syntax
c@0 5 %
c@0 6 % massef.evaluate(originalFiles,estimateFile)
c@0 7 % massef.evaluate(originalFiles,estimateFile,tag)
c@0 8 % massef.evaluate(originalFiles,estimateFile,tag,mixNum)
c@0 9 % massef.evaluate(originalFiles,estimateFile,tag,mixNum,sepNum)
c@0 10 % massef.evaluate(originalFiles,estimateFile,tag,mixNum,sepNum,estNum)
c@0 11 %
c@0 12 % |massef.evaluate(originalFiles,estimateFile)| runs the framework using
c@0 13 % the true sources provided in the wav files whose filenames are contained
c@0 14 % in the cell array |originalFiles| (the target source is the first one)
c@0 15 % and the estimate provided in the wav file with filename |estimateFile|.
c@0 16 %
c@0 17 % The method may be called as many times as desired. Use |massef.save()|
c@0 18 % when finished to save the framework and its data to a file.
c@0 19 %
c@0 20 % |massef.evaluate(originalFiles,estimateFile,tag)| writes the char array
c@0 21 % |tag| to the results data. Use the tag to identify different estimates in
c@0 22 % the results data.
c@0 23 %
c@0 24 % |massef.evaluate(originalFiles,estimateFile,tag,mixNum)| uses the mixture
c@0 25 % number |mixNum| to identify the separation of a particular mixture.
c@0 26 % |mixNum| is a key that can be used with |MASSEFresults.mixtureInfo()| in
c@0 27 % order to add information about a particular mixture.
c@0 28 %
c@0 29 % |massef.evaluate(originalFiles,estimateFile,tag,mixNum,sepNum)| uses the
c@0 30 % separator number |sepNum| to identify the separation from a particular
c@0 31 % algorithm. |sepNum| is a key that can be used with
c@0 32 % |MASSEFresults.algorithmInfo()| in order to add information about a
c@0 33 % particular algorithm.
c@0 34 %
c@0 35 % |massef.evaluate(originalFiles,estimateFile,tag,mixNum,sepNum,estNum)|
c@0 36 % uses the estimate number |estNum| to identify different estimates
c@0 37 % from a given algorithm (e.g. a binary or soft mask output).
c@0 38 %
c@0 39 %% See also
c@0 40 % <help_MASSEF.html MASSEF>,
c@0 41 % <help_MASSEFresults.html MASSEFresults>.
c@0 42 %
c@0 43 % <html>
c@0 44 % <hr>
c@37 45 % <p>Copyright &copy; 2017 <a href="http://www.surrey.ac.uk">University of Surrey</a><br>
c@0 46 % <a href="http://iosr.uk">Institute of Sound Recording, University of Surrey, UK</a></p>
c@0 47 % </html>