Mercurial > hg > massef

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial beta release.
author Christopher Hummersone <c.hummersone@surrey.ac.uk>
date Thu, 02 Mar 2017 09:44:08 +0000
parents
children aea77872f608
comparison
equal deleted inserted replaced
-1:000000000000 0:e34a535b9af0
1 %% MASSEF.execute
2 % Run MASSEF using input mixtures and separators.
3 %
4 %% Syntax
5 %
6 % massef.execute(mixtures,separators)
7 % massef.execute(mixtures)
8 %
9 % |massef.execute(mixtures,separators)| runs the multichannel audio source
10 % separation evaluation framework (MASSEF) using the <help_MASSEF.html
11 % MASSEF> instance |massef|, the array of |iosr.bss.mixture| objects
12 % |mixtures| and the array (or cell array) of instances of separation
13 % algorithms contained in |separators|. Separation is performed for all
14 % combinations of separators and mixtures. The separation algorithm
15 % instances contained in |separators| should conform to the
16 % <help_Separators.html required format>.
17 %
18 % The |execute| method performs evaluations of the algorithm according to
19 % the data returned by the algorithm, and the options provided to
20 % <help_MASSEF.html MASSEF>.
21 %
22 % If the separation algorithm returns a signal, then |MASSEF.execute|
23 % evaluates:
24 %
25 % * signal-to-noise ratio (SNR);
26 % * signal-to-ideal-noise ratio (SINR) (the SNR with respect to the signal
27 % reconstructed using the ideal binary and ratio masks).
28 %
29 % In addition, if |evalPEASS| is true, then PEASS and BSSeval evaluation is
30 % performed. If |evalSTOI| is true, then STOI evaluation is performed.
31 %
32 % If the separation algorithm returns a mask, and if the ideal mask
33 % dimensions match the estimated mask dimensions, then |MASSEF.execute|
34 % evaluates:
35 %
36 % * ideal mask ratio (IMR) with respect to the ideal binary and ratio
37 % masks.
38 %
39 % If the separation algorithm returns a mask but no signals, then MASSEF
40 % attempts to calculate the estimate signal in order to calculate the
41 % signal-related metrics mentioned above.
42 %
43 % The |execute| method also calculates and evaluates the ideal binary and
44 % ratio masks using the signal-related metrics utilised for the algorithm
45 % evaluation. The masks are calculated using the settings that are local to
46 % each |iosr.bss.mixture| object.
47 %
48 % Lastly, the framework captures the estimated azimuth and elevation of the
49 % targets and interferer(s), if they are returned.
50 %
51 % Once the evaluation is complete, the <help_MASSEF.html MASSEF> object,
52 % which contains the results data in |MASSEF.results| as a
53 % <help_MASSEFresults.html MASSEFresults> object, is saved to the file
54 % given by |MASSEF.results_filename|. The separation and mixture objects
55 % are also saved.
56 %
57 % |massef.execute(mixtures)| evaluates only the ideal masks.
58 %
59 %% See also
60 % <help_MASSEF.html MASSEF>, <help_MASSEF_evaluate.html MASSEF.evaluate>,
61 % <help_MASSEFresults.html MASSEFresults>,
62 % <matlab:doc('iosr.bss.generateMixtures') iosr.bss.generateMixtures>,
63 % <matlab:doc('iosr.bss.resynthesise') iosr.bss.resynthesise>.
64 %
65 % <html>
66 % <hr>
67 % <p>Copyright &copy; 2017 <a href="http://www.surrey.ac.uk">University of Surrey</a><br>
68 % <a href="http://iosr.uk">Institute of Sound Recording, University of Surrey, UK</a></p>
69 % </html>