source: sasview/fittingview/docs/sphinx/html/api/perspectives/fitting/models.html @ 5a9a98f

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 5a9a98f was 5a9a98f, checked in by Jessica Tumarkin <jtumarki@…>, 13 years ago

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 12.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" title="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><p>return all the list stored in a dictionary object</p>
69</dd></dl>
70
71<dl class="method">
72<dt id="sans.perspectives.fitting.models.ModelList.set_list">
73<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>
74<dd><table class="docutils field-list" frame="void" rules="none">
75<col class="field-name" />
76<col class="field-body" />
77<tbody valign="top">
78<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
79<li><strong>name</strong> &#8211; the type of the list</li>
80<li><strong>mylist</strong> &#8211; the list to add</li>
81</ul>
82</td>
83</tr>
84</tbody>
85</table>
86</dd></dl>
87
88</dd></dl>
89
90<dl class="class">
91<dt id="sans.perspectives.fitting.models.ModelManager">
92<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>
93<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
94<p>implement model</p>
95<dl class="method">
96<dt id="sans.perspectives.fitting.models.ModelManager.findModels">
97<tt class="descname">findModels</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.models.ModelManager.findModels" title="Permalink to this definition">¶</a></dt>
98<dd></dd></dl>
99
100<dl class="method">
101<dt id="sans.perspectives.fitting.models.ModelManager.get_model_list">
102<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>
103<dd></dd></dl>
104
105<dl class="method">
106<dt id="sans.perspectives.fitting.models.ModelManager.is_changed">
107<tt class="descname">is_changed</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.models.ModelManager.is_changed" title="Permalink to this definition">¶</a></dt>
108<dd></dd></dl>
109
110<dl class="method">
111<dt id="sans.perspectives.fitting.models.ModelManager.populate_menu">
112<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>
113<dd></dd></dl>
114
115<dl class="method">
116<dt id="sans.perspectives.fitting.models.ModelManager.update">
117<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.models.ModelManager.update" title="Permalink to this definition">¶</a></dt>
118<dd></dd></dl>
119
120</dd></dl>
121
122<dl class="class">
123<dt id="sans.perspectives.fitting.models.ModelManagerBase">
124<em class="property">class </em><tt class="descclassname">sans.perspectives.fitting.models.</tt><tt class="descname">ModelManagerBase</tt><a class="headerlink" href="#sans.perspectives.fitting.models.ModelManagerBase" title="Permalink to this definition">¶</a></dt>
125<dd><dl class="method">
126<dt id="sans.perspectives.fitting.models.ModelManagerBase.findModels">
127<tt class="descname">findModels</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.models.ModelManagerBase.findModels" title="Permalink to this definition">¶</a></dt>
128<dd><p>find  plugin model in directory of plugin .recompile all file
129in the directory if file were modified</p>
130</dd></dl>
131
132<dl class="method">
133<dt id="sans.perspectives.fitting.models.ModelManagerBase.get_model_list">
134<tt class="descname">get_model_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.models.ModelManagerBase.get_model_list" title="Permalink to this definition">¶</a></dt>
135<dd><p>return dictionary of models for fitpanel use</p>
136</dd></dl>
137
138<dl class="method">
139<dt id="sans.perspectives.fitting.models.ModelManagerBase.is_changed">
140<tt class="descname">is_changed</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.models.ModelManagerBase.is_changed" title="Permalink to this definition">¶</a></dt>
141<dd><dl class="docutils">
142<dt>check the last time the plugin dir has changed and return true</dt>
143<dd>is the directory was modified else return false</dd>
144</dl>
145</dd></dl>
146
147<dl class="method">
148<dt id="sans.perspectives.fitting.models.ModelManagerBase.populate_menu">
149<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.ModelManagerBase.populate_menu" title="Permalink to this definition">¶</a></dt>
150<dd><p>Populate a menu with our models</p>
151<table class="docutils field-list" frame="void" rules="none">
152<col class="field-name" />
153<col class="field-body" />
154<tbody valign="top">
155<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
156<li><strong>id</strong> &#8211; first menu event ID to use when binding the menu events</li>
157<li><strong>modelmenu</strong> &#8211; wx.Menu object to populate</li>
158<li><strong>event_owner</strong> &#8211; wx object to bind the menu events to</li>
159</ul>
160</td>
161</tr>
162<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>
163</td>
164</tr>
165</tbody>
166</table>
167</dd></dl>
168
169<dl class="method">
170<dt id="sans.perspectives.fitting.models.ModelManagerBase.update">
171<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.models.ModelManagerBase.update" title="Permalink to this definition">¶</a></dt>
172<dd><p>return a dictionary of model if
173new models were added else return empty dictionary</p>
174</dd></dl>
175
176</dd></dl>
177
178<dl class="function">
179<dt id="sans.perspectives.fitting.models.log">
180<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>
181<dd></dd></dl>
182
183</div>
184</div>
185
186
187          </div>
188        </div>
189      </div>
190      <div class="sphinxsidebar">
191        <div class="sphinxsidebarwrapper">
192  <h3><a href="../../../index.html">Table Of Contents</a></h3>
193  <ul>
194<li><a class="reference internal" href="#">models</a><ul>
195<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>
196</ul>
197</li>
198</ul>
199
200  <h4>Previous topic</h4>
201  <p class="topless"><a href="model_thread.html"
202                        title="previous chapter">model_thread</a></p>
203  <h4>Next topic</h4>
204  <p class="topless"><a href="pagestate.html"
205                        title="next chapter">pagestate</a></p>
206  <h3>This Page</h3>
207  <ul class="this-page-menu">
208    <li><a href="../../../_sources/api/perspectives/fitting/models.txt"
209           rel="nofollow">Show Source</a></li>
210  </ul>
211<div id="searchbox" style="display: none">
212  <h3>Quick search</h3>
213    <form class="search" action="../../../search.html" method="get">
214      <input type="text" name="q" size="18" />
215      <input type="submit" value="Go" />
216      <input type="hidden" name="check_keywords" value="yes" />
217      <input type="hidden" name="area" value="default" />
218    </form>
219    <p class="searchtip" style="font-size: 90%">
220    Enter search terms or a module, class or function name.
221    </p>
222</div>
223<script type="text/javascript">$('#searchbox').show(0);</script>
224        </div>
225      </div>
226      <div class="clearer"></div>
227    </div>
228    <div class="related">
229      <h3>Navigation</h3>
230      <ul>
231        <li class="right" style="margin-right: 10px">
232          <a href="../../../genindex.html" title="General Index"
233             >index</a></li>
234        <li class="right" >
235          <a href="../../../py-modindex.html" title="Python Module Index"
236             >modules</a> |</li>
237        <li class="right" >
238          <a href="pagestate.html" title="pagestate"
239             >next</a> |</li>
240        <li class="right" >
241          <a href="model_thread.html" title="model_thread"
242             >previous</a> |</li>
243        <li><a href="../../../index.html">sansview v0.1.0 documentation</a> &raquo;</li>
244          <li><a href="index.html" >Reference</a> &raquo;</li> 
245      </ul>
246    </div>
247    <div class="footer">
248        &copy; Copyright 2010, sans group.
249      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
250    </div>
251  </body>
252</html>
Note: See TracBrowser for help on using the repository browser.