Mercurial > hg > massef

comparison help_html/source/help_Index.m @ 9:063175bfe283

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Minor updates to documentation.
author Christopher Hummersone <c.hummersone@surrey.ac.uk>
date Fri, 03 Mar 2017 10:36:11 +0000
parents 3c754d051479
children aea77872f608
comparison
equal deleted inserted replaced
8:3c754d051479 9:063175bfe283
3 %% Overview 3 %% Overview
4 % 4 %
5 % <<../MASSEF.png>> 5 % <<../MASSEF.png>>
6 % 6 %
7 % The multichannel audio source separation evaluation framework is designed 7 % The multichannel audio source separation evaluation framework is designed
8 % to faciliate the development and evaluation of audio source separation 8 % to facilitate the development and evaluation of audio source separation
9 % algorithms. The framework generates the mixture(s), calculates the ideal 9 % algorithms. The framework generates the mixture(s), provides the
10 % binary and ratio masks, provides the mixture(s) to the separation 10 % mixture(s) to the separation algorithm(s), and evaluates the outputs of
11 % algorithm(s), and evaluates the outputs of the separation algorithm(s). 11 % the separation algorithm(s). The framework can also calculate and
12 % The framework also evaluates the ideal masks for the purposes of 12 % evaluate the ideal masks for the purposes of comparison.
13 % comparison.
14 % 13 %
15 % Sources may have any number of channels; the framework evaluates each 14 % Sources may have any number of channels; the framework evaluates each
16 % channel. The use of iosr.bss.mixture objects facilitate the evaluation of 15 % channel. The use of iosr.bss.mixture objects facilitate the evaluation of
17 % spatialised mixtures (e.g. binaural). 16 % spatialised mixtures (e.g. binaural).
18 % 17 %
31 % 30 %
32 %% Installation 31 %% Installation
33 % 32 %
34 % Before using the framework, you need to download and install its 33 % Before using the framework, you need to download and install its
35 % dependencies. This can be done automatically using the 34 % dependencies. This can be done automatically using the
36 % <help_MASSEF_install.html MASSEF.install> method. Before each session, 35 % <help_MASSEF_install.html MASSEF.install()> method. Before each session,
37 % MASSEF needs to be started using the <help_MASSEF_start.html 36 % MASSEF needs to be started using the <help_MASSEF_start.html
38 % MASSEF.start> method. 37 % MASSEF.start()> method.
39 % 38 %
40 %% Usage 39 %% Usage
41 % 40 %
42 % The framework can be run in two ways: 41 % The framework can be run in two ways:
43 % 42 %
44 % # by providing |iosr.bss.mixture| objects and separation algorithms, or 43 % # by providing |iosr.bss.mixture| objects and separation algorithms, or
45 % # by providing estimate and true source wav files. 44 % # by providing estimate and true source wav files.
46 % 45 %
47 % If 1), the framework generates the mixture(s), calculates the ideal 46 % If 1), the framework operates as described above. In addition, the
48 % binary and ratio masks, provides the mixture(s) to the separation 47 % framework can:
49 % algorithm(s), and evaluates the outputs of the separation algorithm(s). 48 %
50 % The framework also evaluates: the ideal masks for the purposes of 49 % * evaluate localisation accuracy (if the algorithm performs localisation)
51 % comparison, and any azimuth/elevation estimates returned by the 50 % of any azimuth/elevation estimates returned by the algorithm, and
52 % algorithm. Use the <help_MASSEF_execute.html execute> method to operate 51 % * evaluate time-frequency mask accuracy (if the algorithm calculates
53 % in this mode. 52 % one).
53 %
54 % Use the <help_MASSEF_execute.html MASSEF.execute()> method to operate in
55 % this mode.
54 % 56 %
55 % If 2), the framework evaluates only the supplied estimate(s) using 57 % If 2), the framework evaluates only the supplied estimate(s) using
56 % signal-related metrics. Use the <help_MASSEF_evaluate.html evaluate> 58 % signal-related metrics. Use the <help_MASSEF_evaluate.html
57 % method to operate in this mode. 59 % MASSEF.evaluate()> method to operate in this mode.
58 % 60 %
59 % <html> 61 % <html>
60 % <hr> 62 % <hr>
61 % <p>Copyright &copy; 2016 <a href="http://www.surrey.ac.uk">University of Surrey</a><br> 63 % <p>Copyright &copy; 2016 <a href="http://www.surrey.ac.uk">University of Surrey</a><br>
62 % <a href="http://iosr.uk">Institute of Sound Recording, University of Surrey, UK</a></p> 64 % <a href="http://iosr.uk">Institute of Sound Recording, University of Surrey, UK</a></p>