diff help_html/source/help_MASSEFresults_mixtureInfo.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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/help_html/source/help_MASSEFresults_mixtureInfo.m	Thu Mar 02 09:44:08 2017 +0000
@@ -0,0 +1,27 @@
+%% MASSEFresults.mixtureInfo
+% Add mixture information.
+% 
+%% Syntax
+% 
+%   r.mixtureInfo(mixtureNum,'name','value')
+% 
+% |r.mixtureInfo(mixtureNum,'name','value')| adds algorithm information for
+% the mixture with number |mixtureNum| to the results set contained in the
+% <help_MASSEFresults.html MASSEFresults> object |r| using the variable
+% names and values contained in the |'name'| / |'value'| pair arguments.
+% The following information can be stored about each mixture:
+% 
+% * |'azi_sep'|&mdash;azimuthal separation of widest sources (numeric);
+% * |'elevation'|&mdash;median elevation of sources (numeric);
+% * |'filename_t'|&mdash;target filename (char array);
+% * |'filename_i'|&mdash;interferer filename (char array);
+% * |'sofa_path'|&mdash;SOFA filename (char array);
+% * |'target_azi'|&mdash;the target azimuth (numeric);
+% * |'target_ele'|&mdash;the target elevation (numeric); and
+% * |'tir'|&mdash;target-to-interferer ratio (dB) (numeric).
+% 
+% <html>
+% <hr>
+% <p>Copyright &copy; 2016 <a href="http://www.surrey.ac.uk">University of Surrey</a><br>
+% <a href="http://iosr.uk">Institute of Sound Recording, University of Surrey, UK</a></p>
+% </html>