source: sasview/sansview/docs/sphinx/_build/html/api/perspectives/fitting/models.html @ 5062bbf

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 5062bbf was 5062bbf, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on documentation
  • Property mode set to 100644
File size: 9.0 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>models &mdash; sansview v0.1.0 documentation</title>
11    <link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
13    <script type="text/javascript">
14      var DOCUMENTATION_OPTIONS = {
15        URL_ROOT:    '../../../',
16        VERSION:     '0.1.0',
17        COLLAPSE_INDEX: false,
18        FILE_SUFFIX: '.html',
19        HAS_SOURCE:  true
20      };
21    </script>
22    <script type="text/javascript" src="../../../_static/jquery.js"></script>
23    <script type="text/javascript" src="../../../_static/underscore.js"></script>
24    <script type="text/javascript" src="../../../_static/doctools.js"></script>
25    <link rel="top" title="sansview v0.1.0 documentation" href="../../../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="next" title="pagestate" href="pagestate.html" />
28    <link rel="prev" title="model_thread" href="model_thread.html" /> 
29  </head>
30  <body>
31    <div class="related">
32      <h3>Navigation</h3>
33      <ul>
34        <li class="right" style="margin-right: 10px">
35          <a href="../../../genindex.html" title="General Index"
36             accesskey="I">index</a></li>
37        <li class="right" >
38          <a href="../../../py-modindex.html" title="Python Module Index"
39             >modules</a> |</li>
40        <li class="right" >
41          <a href="pagestate.html" title="pagestate"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="model_thread.html" title="model_thread"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../../../index.html">sansview v0.1.0 documentation</a> &raquo;</li>
47          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
48      </ul>
49    </div> 
50
51    <div class="document">
52      <div class="documentwrapper">
53        <div class="bodywrapper">
54          <div class="body">
55           
56  <div class="section" id="models">
57<h1>models<a class="headerlink" href="#models" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.perspectives.fitting.models">
59<span id="sans-perspectives-fitting-models"></span><h2><a class="reference internal" href="#module-sans.perspectives.fitting.models"><tt class="xref py py-mod docutils literal"><span class="pre">sans.perspectives.fitting.models</span></tt></a><a class="headerlink" href="#module-sans.perspectives.fitting.models" title="Permalink to this headline">¶</a></h2>
60<dl class="class">
61<dt id="sans.perspectives.fitting.models.ModelList">
62<em class="property">class </em><tt class="descclassname">sans.perspectives.fitting.models.</tt><tt class="descname">ModelList</tt><a class="headerlink" href="#sans.perspectives.fitting.models.ModelList" title="Permalink to this definition">¶</a></dt>
63<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
64<p>Contains dictionary of model and their type</p>
65<dl class="method">
66<dt id="sans.perspectives.fitting.models.ModelList.get_list">
67<tt class="descname">get_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.models.ModelList.get_list" title="Permalink to this definition">¶</a></dt>
68<dd>return all the list stored in a dictionary object</dd></dl>
69
70<dl class="method">
71<dt id="sans.perspectives.fitting.models.ModelList.set_list">
72<tt class="descname">set_list</tt><big>(</big><em>name</em>, <em>mylist</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.models.ModelList.set_list" title="Permalink to this definition">¶</a></dt>
73<dd><table class="docutils field-list" frame="void" rules="none">
74<col class="field-name" />
75<col class="field-body" />
76<tbody valign="top">
77<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
78<li><strong>name</strong> &#8211; the type of the list</li>
79<li><strong>mylist</strong> &#8211; the list to add</li>
80</ul>
81</td>
82</tr>
83</tbody>
84</table>
85</dd></dl>
86
87</dd></dl>
88
89<dl class="class">
90<dt id="sans.perspectives.fitting.models.ModelManager">
91<em class="property">class </em><tt class="descclassname">sans.perspectives.fitting.models.</tt><tt class="descname">ModelManager</tt><a class="headerlink" href="#sans.perspectives.fitting.models.ModelManager" title="Permalink to this definition">¶</a></dt>
92<dd><dl class="method">
93<dt id="sans.perspectives.fitting.models.ModelManager.get_model_list">
94<tt class="descname">get_model_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.models.ModelManager.get_model_list" title="Permalink to this definition">¶</a></dt>
95<dd>return dictionary of models for fitpanel use</dd></dl>
96
97<dl class="method">
98<dt id="sans.perspectives.fitting.models.ModelManager.populate_menu">
99<tt class="descname">populate_menu</tt><big>(</big><em>modelmenu</em>, <em>event_owner</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.models.ModelManager.populate_menu" title="Permalink to this definition">¶</a></dt>
100<dd><p>Populate a menu with our models</p>
101<table class="docutils field-list" frame="void" rules="none">
102<col class="field-name" />
103<col class="field-body" />
104<tbody valign="top">
105<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
106<li><strong>id</strong> &#8211; first menu event ID to use when binding the menu events</li>
107<li><strong>modelmenu</strong> &#8211; wx.Menu object to populate</li>
108<li><strong>event_owner</strong> &#8211; wx object to bind the menu events to</li>
109</ul>
110</td>
111</tr>
112<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the next free event ID following the new menu events</p>
113</td>
114</tr>
115</tbody>
116</table>
117</dd></dl>
118
119</dd></dl>
120
121<dl class="function">
122<dt id="sans.perspectives.fitting.models.findModels">
123<tt class="descclassname">sans.perspectives.fitting.models.</tt><tt class="descname">findModels</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.models.findModels" title="Permalink to this definition">¶</a></dt>
124<dd></dd></dl>
125
126<dl class="function">
127<dt id="sans.perspectives.fitting.models.log">
128<tt class="descclassname">sans.perspectives.fitting.models.</tt><tt class="descname">log</tt><big>(</big><em>message</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.models.log" title="Permalink to this definition">¶</a></dt>
129<dd></dd></dl>
130
131</div>
132</div>
133
134
135          </div>
136        </div>
137      </div>
138      <div class="sphinxsidebar">
139        <div class="sphinxsidebarwrapper">
140  <h3><a href="../../../index.html">Table Of Contents</a></h3>
141  <ul>
142<li><a class="reference internal" href="#">models</a><ul>
143<li><a class="reference internal" href="#module-sans.perspectives.fitting.models"><tt class="docutils literal"><span class="pre">sans.perspectives.fitting.models</span></tt></a></li>
144</ul>
145</li>
146</ul>
147
148  <h4>Previous topic</h4>
149  <p class="topless"><a href="model_thread.html"
150                        title="previous chapter">model_thread</a></p>
151  <h4>Next topic</h4>
152  <p class="topless"><a href="pagestate.html"
153                        title="next chapter">pagestate</a></p>
154  <h3>This Page</h3>
155  <ul class="this-page-menu">
156    <li><a href="../../../_sources/api/perspectives/fitting/models.txt"
157           rel="nofollow">Show Source</a></li>
158  </ul>
159<div id="searchbox" style="display: none">
160  <h3>Quick search</h3>
161    <form class="search" action="../../../search.html" method="get">
162      <input type="text" name="q" size="18" />
163      <input type="submit" value="Go" />
164      <input type="hidden" name="check_keywords" value="yes" />
165      <input type="hidden" name="area" value="default" />
166    </form>
167    <p class="searchtip" style="font-size: 90%">
168    Enter search terms or a module, class or function name.
169    </p>
170</div>
171<script type="text/javascript">$('#searchbox').show(0);</script>
172        </div>
173      </div>
174      <div class="clearer"></div>
175    </div>
176    <div class="related">
177      <h3>Navigation</h3>
178      <ul>
179        <li class="right" style="margin-right: 10px">
180          <a href="../../../genindex.html" title="General Index"
181             >index</a></li>
182        <li class="right" >
183          <a href="../../../py-modindex.html" title="Python Module Index"
184             >modules</a> |</li>
185        <li class="right" >
186          <a href="pagestate.html" title="pagestate"
187             >next</a> |</li>
188        <li class="right" >
189          <a href="model_thread.html" title="model_thread"
190             >previous</a> |</li>
191        <li><a href="../../../index.html">sansview v0.1.0 documentation</a> &raquo;</li>
192          <li><a href="index.html" >Reference</a> &raquo;</li> 
193      </ul>
194    </div>
195    <div class="footer">
196        &copy; Copyright 2010, sans group.
197      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
198    </div>
199  </body>
200</html>
Note: See TracBrowser for help on using the repository browser.