comparison help_html/source/help_MASSEF_evaluate.m @ 0:e34a535b9af0

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