root/doc/html/ui.html @ 324

Revision 323, 4.4 kB (checked in by smidl, 16 years ago)

doc

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: User Infos and their use</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li class="current"><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="navpath"><a class="el" href="manual.html">User Manual</a>
60  </div>
61</div>
62<div class="contents">
63<h1><a class="anchor" name="ui">User Infos and their use </a></h1>For easier interaction with users, experiments can be configured via structures called User Info. These structures contain information about details of the experiment that is to be performed. Since experiments involve the use of basic BDM classes and their compositions, the experiment description is also hierarchical with specific user info for each object or class.<p>
64The User Infos are designed using customized version of the libconfig library (link!). It is specialized for BDM so as to recognize basic mathematical objects, such as vectors and matrices, see ... for details.<p>
65(Technically it can be made compatible with matlab structures!)<p>
66For example a simple experiment can be configures in a following way: <div class="fragment"><pre class="fragment">ndat = 100;                <span class="comment">//number of data points</span>
67prior = {type=<span class="stringliteral">"enorm"</span>;
68        mu = [1, 2, 3];
69        R = [1, 0, 0,
70             0, 1, 0,
71             0, 0, 1];
72};
73</pre></div> Exact meaning of root fields in this structure (i.e. ndat and prior) is defined by the application (or mex file) that is using this configuration file. It will look for expected fields and it will ignore any other structures. When it does not find what it is looking for, it terminates with an appropriate error message.<p>
74A structure with field <code>type="identifier"</code> is special. Such a structure will be parsed by an appropriate class <a class="el" href="classbdm_1_1UIbuilder.html" title="Builds computational object from a UserInfo structure.">bdm::UIbuilder</a> which will construct the desired object, in this instance of an object of the class <a class="el" href="classbdm_1_1enorm.html" title="Gaussian density with positive definite (decomposed) covariance matrix.">bdm::enorm</a>. For a detailed example how this mechanism works in practice see <a class="el" href="arx_ui.html">Running experiment <code>estimator</code> with ARX data fields</a>. </div>
75<hr size="1"><address style="text-align: right;"><small>Generated on Thu Apr 23 21:06:43 2009 for mixpp by&nbsp;
76<a href="http://www.doxygen.org/index.html">
77<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
78</body>
79</html>
Note: See TracBrowser for help on using the browser.