source: sasview/fittingview/docs/sphinx/html/api/perspectives/fitting/fit_thread.html @ bb46557

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

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 11.2 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>fit_thread &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="fitpage" href="fitpage.html" />
28    <link rel="prev" title="console" href="console.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="fitpage.html" title="fitpage"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="console.html" title="console"
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="fit-thread">
57<h1>fit_thread<a class="headerlink" href="#fit-thread" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.perspectives.fitting.fit_thread">
59<span id="sans-perspectives-fitting-fit-thread"></span><h2><a class="reference internal" href="#module-sans.perspectives.fitting.fit_thread" title="sans.perspectives.fitting.fit_thread"><tt class="xref py py-mod docutils literal"><span class="pre">sans.perspectives.fitting.fit_thread</span></tt></a><a class="headerlink" href="#module-sans.perspectives.fitting.fit_thread" title="Permalink to this headline">¶</a></h2>
60<dl class="class">
61<dt id="sans.perspectives.fitting.fit_thread.FitThread">
62<em class="property">class </em><tt class="descclassname">sans.perspectives.fitting.fit_thread.</tt><tt class="descname">FitThread</tt><big>(</big><em>fn</em>, <em>page_id</em>, <em>handler</em>, <em>pars=None</em>, <em>completefn=None</em>, <em>updatefn=None</em>, <em>yieldtime=0.01</em>, <em>worktime=0.01</em>, <em>ftol=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread" title="Permalink to this definition">¶</a></dt>
63<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">data_util.calcthread.CalcThread</span></tt></p>
64<p>Thread performing the fit</p>
65<dl class="method">
66<dt id="sans.perspectives.fitting.fit_thread.FitThread.complete">
67<tt class="descname">complete</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread.complete" title="Permalink to this definition">¶</a></dt>
68<dd><p>Update the GUI with the completed results from a work unit.</p>
69</dd></dl>
70
71<dl class="method">
72<dt id="sans.perspectives.fitting.fit_thread.FitThread.compute">
73<tt class="descname">compute</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread.compute" title="Permalink to this definition">¶</a></dt>
74<dd><p>Perform a fit</p>
75</dd></dl>
76
77<dl class="method">
78<dt id="sans.perspectives.fitting.fit_thread.FitThread.interrupt">
79<tt class="descname">interrupt</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread.interrupt" title="Permalink to this definition">¶</a></dt>
80<dd><p>Stop the current work item.  To clear the work queue as
81well call the stop() method.</p>
82</dd></dl>
83
84<dl class="method">
85<dt id="sans.perspectives.fitting.fit_thread.FitThread.isquit">
86<tt class="descname">isquit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread.isquit" title="Permalink to this definition">¶</a></dt>
87<dd><table class="docutils field-list" frame="void" rules="none">
88<col class="field-name" />
89<col class="field-body" />
90<tbody valign="top">
91<tr class="field"><th class="field-name" colspan="2">Raises KeyboardInterrupt:</th></tr>
92<tr><td>&nbsp;</td><td class="field-body">when the thread is interrupted</td>
93</tr>
94</tbody>
95</table>
96</dd></dl>
97
98<dl class="method">
99<dt id="sans.perspectives.fitting.fit_thread.FitThread.isrunning">
100<tt class="descname">isrunning</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread.isrunning" title="Permalink to this definition">¶</a></dt>
101<dd></dd></dl>
102
103<dl class="method">
104<dt id="sans.perspectives.fitting.fit_thread.FitThread.queue">
105<tt class="descname">queue</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread.queue" title="Permalink to this definition">¶</a></dt>
106<dd><p>Add a work unit to the end of the queue.  See the compute()
107method for details of the arguments to the work unit.</p>
108</dd></dl>
109
110<dl class="method">
111<dt id="sans.perspectives.fitting.fit_thread.FitThread.ready">
112<tt class="descname">ready</tt><big>(</big><em>delay=0.0</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread.ready" title="Permalink to this definition">¶</a></dt>
113<dd><p>Ready for another update after delay=t seconds.  Call
114this for threads which can show intermediate results from
115long calculations.</p>
116</dd></dl>
117
118<dl class="method">
119<dt id="sans.perspectives.fitting.fit_thread.FitThread.requeue">
120<tt class="descname">requeue</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread.requeue" title="Permalink to this definition">¶</a></dt>
121<dd><p>Replace the work unit on the end of the queue.  See the compute()
122method for details of the arguments to the work unit.</p>
123</dd></dl>
124
125<dl class="method">
126<dt id="sans.perspectives.fitting.fit_thread.FitThread.reset">
127<tt class="descname">reset</tt><big>(</big><em>*args</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread.reset" title="Permalink to this definition">¶</a></dt>
128<dd><p>Clear the queue and start a new work unit.  See the compute()
129method for details of the arguments to the work unit.</p>
130</dd></dl>
131
132<dl class="method">
133<dt id="sans.perspectives.fitting.fit_thread.FitThread.stop">
134<tt class="descname">stop</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread.stop" title="Permalink to this definition">¶</a></dt>
135<dd><p>Clear the queue and stop the thread.  New items may be
136queued after stop.  To stop just the current work item, and
137continue the rest of the queue call the interrupt method</p>
138</dd></dl>
139
140<dl class="method">
141<dt id="sans.perspectives.fitting.fit_thread.FitThread.update">
142<tt class="descname">update</tt><big>(</big><em>**kwargs</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread.update" title="Permalink to this definition">¶</a></dt>
143<dd><p>Update GUI with the lastest results from the current work unit.</p>
144</dd></dl>
145
146</dd></dl>
147
148<dl class="function">
149<dt id="sans.perspectives.fitting.fit_thread.map_apply">
150<tt class="descclassname">sans.perspectives.fitting.fit_thread.</tt><tt class="descname">map_apply</tt><big>(</big><em>arguments</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.map_apply" title="Permalink to this definition">¶</a></dt>
151<dd></dd></dl>
152
153<dl class="function">
154<dt id="sans.perspectives.fitting.fit_thread.map_getattr">
155<tt class="descclassname">sans.perspectives.fitting.fit_thread.</tt><tt class="descname">map_getattr</tt><big>(</big><em>classInstance</em>, <em>classFunc</em>, <em>*args</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.map_getattr" title="Permalink to this definition">¶</a></dt>
156<dd><p>Take an instance of a class and a function name as a string.
157Execute class.function and return result</p>
158</dd></dl>
159
160</div>
161</div>
162
163
164          </div>
165        </div>
166      </div>
167      <div class="sphinxsidebar">
168        <div class="sphinxsidebarwrapper">
169  <h3><a href="../../../index.html">Table Of Contents</a></h3>
170  <ul>
171<li><a class="reference internal" href="#">fit_thread</a><ul>
172<li><a class="reference internal" href="#module-sans.perspectives.fitting.fit_thread"><tt class="docutils literal"><span class="pre">sans.perspectives.fitting.fit_thread</span></tt></a></li>
173</ul>
174</li>
175</ul>
176
177  <h4>Previous topic</h4>
178  <p class="topless"><a href="console.html"
179                        title="previous chapter">console</a></p>
180  <h4>Next topic</h4>
181  <p class="topless"><a href="fitpage.html"
182                        title="next chapter">fitpage</a></p>
183  <h3>This Page</h3>
184  <ul class="this-page-menu">
185    <li><a href="../../../_sources/api/perspectives/fitting/fit_thread.txt"
186           rel="nofollow">Show Source</a></li>
187  </ul>
188<div id="searchbox" style="display: none">
189  <h3>Quick search</h3>
190    <form class="search" action="../../../search.html" method="get">
191      <input type="text" name="q" size="18" />
192      <input type="submit" value="Go" />
193      <input type="hidden" name="check_keywords" value="yes" />
194      <input type="hidden" name="area" value="default" />
195    </form>
196    <p class="searchtip" style="font-size: 90%">
197    Enter search terms or a module, class or function name.
198    </p>
199</div>
200<script type="text/javascript">$('#searchbox').show(0);</script>
201        </div>
202      </div>
203      <div class="clearer"></div>
204    </div>
205    <div class="related">
206      <h3>Navigation</h3>
207      <ul>
208        <li class="right" style="margin-right: 10px">
209          <a href="../../../genindex.html" title="General Index"
210             >index</a></li>
211        <li class="right" >
212          <a href="../../../py-modindex.html" title="Python Module Index"
213             >modules</a> |</li>
214        <li class="right" >
215          <a href="fitpage.html" title="fitpage"
216             >next</a> |</li>
217        <li class="right" >
218          <a href="console.html" title="console"
219             >previous</a> |</li>
220        <li><a href="../../../index.html">sansview v0.1.0 documentation</a> &raquo;</li>
221          <li><a href="index.html" >Reference</a> &raquo;</li> 
222      </ul>
223    </div>
224    <div class="footer">
225        &copy; Copyright 2010, sans group.
226      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
227    </div>
228  </body>
229</html>
Note: See TracBrowser for help on using the repository browser.