# HG changeset patch
# User Christopher Hummersone <c.hummersone@surrey.ac.uk>
# Date 1488888509 0
# Node ID aea77872f608ad7e8f25a12db01b5d87a94b17b5
# Parent  fd166bee962b1900fe1b23fc25e1bb1e40dc8acb
Added links to iosr.bss.mixture documentation.

diff -r fd166bee962b -r aea77872f608 help_html/source/help_Index.m
--- a/help_html/source/help_Index.m	Tue Mar 07 11:50:55 2017 +0000
+++ b/help_html/source/help_Index.m	Tue Mar 07 12:08:29 2017 +0000
@@ -12,8 +12,9 @@
 % evaluate the ideal masks for the purposes of comparison.
 % 
 % Sources may have any number of channels; the framework evaluates each
-% channel. The use of iosr.bss.mixture objects facilitate the evaluation of
-% spatialised mixtures (e.g. binaural).
+% channel. The use of <matlab:doc('iosr.bss.mixture') |iosr.bss.mixture|>
+% objects facilitate the evaluation of spatialised mixtures (e.g.
+% binaural).
 % 
 % The framework comprises two main classes:
 % 
@@ -40,7 +41,8 @@
 % 
 % The framework can be run in two ways:
 % 
-% # by providing |iosr.bss.mixture| objects and separation algorithms, or
+% # by providing <matlab:doc('iosr.bss.mixture') |iosr.bss.mixture|>
+%   objects and separation algorithms, or
 % # by providing estimate and true source wav files.
 %   
 % If 1), the framework operates as described above. In addition, the
diff -r fd166bee962b -r aea77872f608 help_html/source/help_MASSEF_execute.m
--- a/help_html/source/help_MASSEF_execute.m	Tue Mar 07 11:50:55 2017 +0000
+++ b/help_html/source/help_MASSEF_execute.m	Tue Mar 07 12:08:29 2017 +0000
@@ -8,12 +8,12 @@
 % 
 % |massef.execute(mixtures,separators)| runs the multichannel audio source
 % separation evaluation framework (MASSEF) using the <help_MASSEF.html
-% MASSEF> instance |massef|, the array of |iosr.bss.mixture| objects
-% |mixtures| and the array (or cell array) of instances of separation
-% algorithms contained in |separators|. Separation is performed for all
-% combinations of separators and mixtures. The separation algorithm
-% instances contained in |separators| should conform to the
-% <help_Separators.html required format>.
+% MASSEF> instance |massef|, the array of <matlab:doc('iosr.bss.mixture')
+% |iosr.bss.mixture|> objects |mixtures| and the array (or cell array) of
+% instances of separation algorithms contained in |separators|. Separation
+% is performed for all combinations of separators and mixtures. The
+% separation algorithm instances contained in |separators| should conform
+% to the <help_Separators.html required format>.
 % 
 % The |execute| method performs evaluations of the algorithm according to
 % the data returned by the algorithm, and the options provided to
@@ -43,7 +43,7 @@
 % The |execute| method also calculates and evaluates the ideal binary and
 % ratio masks using the signal-related metrics utilised for the algorithm
 % evaluation. The masks are calculated using the settings that are local to
-% each |iosr.bss.mixture| object.
+% each <matlab:doc('iosr.bss.mixture') |iosr.bss.mixture|> object.
 % 
 % Lastly, the framework captures the estimated azimuth and elevation of the
 % targets and interferer(s), if they are returned.