|
c@0
|
1 %% MASSEFresults
|
|
c@0
|
2 % A class for storing MASSEF results.
|
|
c@0
|
3 %
|
|
c@0
|
4 %% Syntax
|
|
c@0
|
5 %
|
|
c@0
|
6 % r = MASSEFresults
|
|
c@0
|
7 %
|
|
c@0
|
8 % |r = MASSEFresults| creates an empty MASSEFresult object. Use the
|
|
c@0
|
9 % <help_MASSEFresults_input.html MASSEFresults.input> method to add data.
|
|
c@0
|
10 % The instance has the properties described below.
|
|
c@0
|
11 %
|
|
c@0
|
12 %% Properties
|
|
c@0
|
13 % <html>
|
|
c@0
|
14 % <table>
|
|
c@0
|
15 % <tr>
|
|
c@0
|
16 % <td><tt>data</tt></td>
|
|
c@0
|
17 % <td>The full results set returned as a Table object (read only). The
|
|
c@0
|
18 % Table has the following columns:
|
|
c@0
|
19 % <ul>
|
|
c@0
|
20 % <li>algorithmNum—the algorithm number;</li>
|
|
c@0
|
21 % <li>channel—the audio channel</li>
|
|
c@0
|
22 % <li>estimateNum—the estimate number;</li>
|
|
c@0
|
23 % <li>estTag—a tag for each estimate from a given algorithm;</li>
|
|
c@0
|
24 % <li>metric—the performance metric;</li>
|
|
c@0
|
25 % <li>mixNum—the mixture number; and</li>
|
|
c@0
|
26 % <li>value—the value of the performance metric</li>
|
|
c@0
|
27 % </ul>
|
|
c@0
|
28 % Additional mixture and algorithm information is also returned in the
|
|
c@0
|
29 % results set.
|
|
c@0
|
30 % </td>
|
|
c@0
|
31 % </tr>
|
|
c@0
|
32 % <tr>
|
|
c@0
|
33 % <td><tt>estTags</tt></td>
|
|
c@0
|
34 % <td>A list of the <tt>estTags</tt>, taken from the separators, that
|
|
c@0
|
35 % feature in the results set (read only).</td>
|
|
c@0
|
36 % </tr>
|
|
c@0
|
37 % <tr>
|
|
c@0
|
38 % <td><tt>metrics</tt></td>
|
|
c@0
|
39 % <td>The metrics that feature in the results set (read only).</td>
|
|
c@0
|
40 % </tr>
|
|
c@0
|
41 % <tr>
|
|
c@0
|
42 % <td><tt>numAlgorithms</tt></td>
|
|
c@0
|
43 % <td>The number of algorithms in the results set (read-only).</td>
|
|
c@0
|
44 % </tr>
|
|
c@0
|
45 % <tr>
|
|
c@0
|
46 % <td><tt>numEstimates</tt></td>
|
|
c@0
|
47 % <td>The (maximum) number of estimates in the results set (read-only).</td>
|
|
c@0
|
48 % </tr>
|
|
c@0
|
49 % <tr>
|
|
c@0
|
50 % <td><tt>numChannels</tt></td>
|
|
c@0
|
51 % <td>The (maximum) number of channels in the results set (read-only).</td>
|
|
c@0
|
52 % </tr>
|
|
c@0
|
53 % </table>
|
|
c@0
|
54 % </html>
|
|
c@0
|
55 %
|
|
c@0
|
56 %% Methods
|
|
c@0
|
57 %
|
|
c@0
|
58 % <html>
|
|
c@0
|
59 % <table>
|
|
c@0
|
60 % <tr>
|
|
c@0
|
61 % <td>MASSEFresults</td>
|
|
c@0
|
62 % <td>Create a MASSEFresults object.</td>
|
|
c@0
|
63 % </tr>
|
|
c@0
|
64 % <tr>
|
|
c@0
|
65 % <td><a href="help_MASSEFresults_algorithmInfo.html">algorithmInfo</a></td>
|
|
c@0
|
66 % <td>Add separation algorithm information.</td>
|
|
c@0
|
67 % </tr>
|
|
c@0
|
68 % <tr>
|
|
c@0
|
69 % <td><a href="help_MASSEFresults_filter.html">filter</a></td>
|
|
c@0
|
70 % <td>Filter the results set.</td>
|
|
c@0
|
71 % </tr>
|
|
c@0
|
72 % <tr>
|
|
c@0
|
73 % <td><a href="help_MASSEFresults_input.html">input</a></td>
|
|
c@0
|
74 % <td>Add performance data.</td>
|
|
c@0
|
75 % </tr>
|
|
c@0
|
76 % <tr>
|
|
c@0
|
77 % <td><a href="help_MASSEFresults_merge.html">merge</a></td>
|
|
c@0
|
78 % <td>Combine results array into singular object.</td>
|
|
c@0
|
79 % </tr>
|
|
c@0
|
80 % <tr>
|
|
c@0
|
81 % <td><a href="help_MASSEFresults_mixtureInfo.html">mixtureInfo</a></td>
|
|
c@0
|
82 % <td>Add mixture information.</td>
|
|
c@0
|
83 % </tr>
|
|
c@0
|
84 % </table>
|
|
c@0
|
85 % </html>
|
|
c@0
|
86 %
|
|
c@0
|
87 %% See also
|
|
c@0
|
88 % <help_MASSEF.html MASSEF>.
|
|
c@0
|
89 %
|
|
c@0
|
90 % <html>
|
|
c@0
|
91 % <hr>
|
|
c@37
|
92 % <p>Copyright © 2017 <a href="http://www.surrey.ac.uk">University of Surrey</a><br>
|
|
c@0
|
93 % <a href="http://iosr.uk">Institute of Sound Recording, University of Surrey, UK</a></p>
|
|
c@0
|
94 % </html>
|
