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

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 89b7858 was 30d3a1b, checked in by Gervaise Alina <gervyh@…>, 13 years ago

edit doc
  • Property mode set to 100644
File size: 11.9 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
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>fit_thread &mdash; sansview 0.1.0 documentation</title>
12   
13    <link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '../../../',
19        VERSION:     '0.1.0',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="../../../_static/jquery.js"></script>
26    <script type="text/javascript" src="../../../_static/underscore.js"></script>
27    <script type="text/javascript" src="../../../_static/doctools.js"></script>
28    <link rel="top" title="sansview 0.1.0 documentation" href="../../../index.html" />
29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="ftol_dialog" href="ftol_dialog.html" />
31    <link rel="prev" title="fitting_widgets" href="fitting_widgets.html" /> 
32  </head>
33  <body>
34    <div class="related">
35      <h3>Navigation</h3>
36      <ul>
37        <li class="right" style="margin-right: 10px">
38          <a href="../../../genindex.html" title="General Index"
39             accesskey="I">index</a></li>
40        <li class="right" >
41          <a href="../../../py-modindex.html" title="Python Module Index"
42             >modules</a> |</li>
43        <li class="right" >
44          <a href="ftol_dialog.html" title="ftol_dialog"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="fitting_widgets.html" title="fitting_widgets"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../../../index.html">sansview 0.1.0 documentation</a> &raquo;</li>
50          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
51      </ul>
52    </div> 
53
54    <div class="document">
55      <div class="documentwrapper">
56        <div class="bodywrapper">
57          <div class="body">
58           
59  <div class="section" id="fit-thread">
60<h1>fit_thread<a class="headerlink" href="#fit-thread" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-perspectives-fitting-fit-thread">
62<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="#sans-perspectives-fitting-fit-thread" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.perspectives.fitting.fit_thread"></span><dl class="class">
64<dt id="sans.perspectives.fitting.fit_thread.FitThread">
65<em class="property">class </em><tt class="descclassname">sans.perspectives.fitting.fit_thread.</tt><tt class="descname">FitThread</tt><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread" title="Permalink to this definition">¶</a></dt>
66<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">data_util.calcthread.CalcThread</span></tt></p>
67<p>Thread performing the fit</p>
68<dl class="method">
69<dt id="sans.perspectives.fitting.fit_thread.FitThread.__init__">
70<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread.__init__" title="Permalink to this definition">¶</a></dt>
71<dd></dd></dl>
72
73<dl class="attribute">
74<dt id="sans.perspectives.fitting.fit_thread.FitThread.__module__">
75<tt class="descname">__module__</tt><em class="property"> = 'sans.perspectives.fitting.fit_thread'</em><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread.__module__" title="Permalink to this definition">¶</a></dt>
76<dd></dd></dl>
77
78<dl class="method">
79<dt id="sans.perspectives.fitting.fit_thread.FitThread._run">
80<tt class="descname">_run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread._run" title="Permalink to this definition">¶</a></dt>
81<dd><p>Internal function to manage the thread.</p>
82</dd></dl>
83
84<dl class="method">
85<dt id="sans.perspectives.fitting.fit_thread.FitThread.complete">
86<tt class="descname">complete</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread.complete" title="Permalink to this definition">¶</a></dt>
87<dd><p>Update the GUI with the completed results from a work unit.</p>
88</dd></dl>
89
90<dl class="method">
91<dt id="sans.perspectives.fitting.fit_thread.FitThread.compute">
92<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>
93<dd><p>Perform a fit</p>
94</dd></dl>
95
96<dl class="method">
97<dt id="sans.perspectives.fitting.fit_thread.FitThread.interrupt">
98<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>
99<dd><p>Stop the current work item.  To clear the work queue as
100well call the stop() method.</p>
101</dd></dl>
102
103<dl class="method">
104<dt id="sans.perspectives.fitting.fit_thread.FitThread.isquit">
105<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>
106<dd><table class="docutils field-list" frame="void" rules="none">
107<col class="field-name" />
108<col class="field-body" />
109<tbody valign="top">
110<tr class="field-odd field"><th class="field-name" colspan="2">Raises KeyboardInterrupt:</th></tr>
111<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">when the thread is interrupted</td>
112</tr>
113</tbody>
114</table>
115</dd></dl>
116
117<dl class="method">
118<dt id="sans.perspectives.fitting.fit_thread.FitThread.isrunning">
119<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>
120<dd></dd></dl>
121
122<dl class="method">
123<dt id="sans.perspectives.fitting.fit_thread.FitThread.queue">
124<tt class="descname">queue</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread.queue" title="Permalink to this definition">¶</a></dt>
125<dd><p>Add a work unit to the end of the queue.  See the compute()
126method for details of the arguments to the work unit.</p>
127</dd></dl>
128
129<dl class="method">
130<dt id="sans.perspectives.fitting.fit_thread.FitThread.ready">
131<tt class="descname">ready</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread.ready" title="Permalink to this definition">¶</a></dt>
132<dd><p>Ready for another update after delay=t seconds.  Call
133this for threads which can show intermediate results from
134long calculations.</p>
135</dd></dl>
136
137<dl class="method">
138<dt id="sans.perspectives.fitting.fit_thread.FitThread.requeue">
139<tt class="descname">requeue</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread.requeue" title="Permalink to this definition">¶</a></dt>
140<dd><p>Replace the work unit on the end of the queue.  See the compute()
141method for details of the arguments to the work unit.</p>
142</dd></dl>
143
144<dl class="method">
145<dt id="sans.perspectives.fitting.fit_thread.FitThread.reset">
146<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread.reset" title="Permalink to this definition">¶</a></dt>
147<dd><p>Clear the queue and start a new work unit.  See the compute()
148method for details of the arguments to the work unit.</p>
149</dd></dl>
150
151<dl class="method">
152<dt id="sans.perspectives.fitting.fit_thread.FitThread.stop">
153<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>
154<dd><p>Clear the queue and stop the thread.  New items may be
155queued after stop.  To stop just the current work item, and
156continue the rest of the queue call the interrupt method</p>
157</dd></dl>
158
159<dl class="method">
160<dt id="sans.perspectives.fitting.fit_thread.FitThread.update">
161<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.FitThread.update" title="Permalink to this definition">¶</a></dt>
162<dd><p>Update GUI with the lastest results from the current work unit.</p>
163</dd></dl>
164
165</dd></dl>
166
167<dl class="function">
168<dt id="sans.perspectives.fitting.fit_thread.map_apply">
169<tt class="descclassname">sans.perspectives.fitting.fit_thread.</tt><tt class="descname">map_apply</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.map_apply" title="Permalink to this definition">¶</a></dt>
170<dd></dd></dl>
171
172<dl class="function">
173<dt id="sans.perspectives.fitting.fit_thread.map_getattr">
174<tt class="descclassname">sans.perspectives.fitting.fit_thread.</tt><tt class="descname">map_getattr</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.fit_thread.map_getattr" title="Permalink to this definition">¶</a></dt>
175<dd><p>Take an instance of a class and a function name as a string.
176Execute class.function and return result</p>
177</dd></dl>
178
179</div>
180</div>
181
182
183          </div>
184        </div>
185      </div>
186      <div class="sphinxsidebar">
187        <div class="sphinxsidebarwrapper">
188  <h3><a href="../../../index.html">Table Of Contents</a></h3>
189  <ul>
190<li><a class="reference internal" href="#">fit_thread</a><ul>
191<li><a class="reference internal" href="#sans-perspectives-fitting-fit-thread"><tt class="docutils literal"><span class="pre">sans.perspectives.fitting.fit_thread</span></tt></a></li>
192</ul>
193</li>
194</ul>
195
196  <h4>Previous topic</h4>
197  <p class="topless"><a href="fitting_widgets.html"
198                        title="previous chapter">fitting_widgets</a></p>
199  <h4>Next topic</h4>
200  <p class="topless"><a href="ftol_dialog.html"
201                        title="next chapter">ftol_dialog</a></p>
202  <h3>This Page</h3>
203  <ul class="this-page-menu">
204    <li><a href="../../../_sources/api/perspectives/fitting/fit_thread.txt"
205           rel="nofollow">Show Source</a></li>
206  </ul>
207<div id="searchbox" style="display: none">
208  <h3>Quick search</h3>
209    <form class="search" action="../../../search.html" method="get">
210      <input type="text" name="q" />
211      <input type="submit" value="Go" />
212      <input type="hidden" name="check_keywords" value="yes" />
213      <input type="hidden" name="area" value="default" />
214    </form>
215    <p class="searchtip" style="font-size: 90%">
216    Enter search terms or a module, class or function name.
217    </p>
218</div>
219<script type="text/javascript">$('#searchbox').show(0);</script>
220        </div>
221      </div>
222      <div class="clearer"></div>
223    </div>
224    <div class="related">
225      <h3>Navigation</h3>
226      <ul>
227        <li class="right" style="margin-right: 10px">
228          <a href="../../../genindex.html" title="General Index"
229             >index</a></li>
230        <li class="right" >
231          <a href="../../../py-modindex.html" title="Python Module Index"
232             >modules</a> |</li>
233        <li class="right" >
234          <a href="ftol_dialog.html" title="ftol_dialog"
235             >next</a> |</li>
236        <li class="right" >
237          <a href="fitting_widgets.html" title="fitting_widgets"
238             >previous</a> |</li>
239        <li><a href="../../../index.html">sansview 0.1.0 documentation</a> &raquo;</li>
240          <li><a href="index.html" >Reference</a> &raquo;</li> 
241      </ul>
242    </div>
243    <div class="footer">
244        &copy; Copyright 2010, sans group.
245      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
246    </div>
247  </body>
248</html>
Note: See TracBrowser for help on using the repository browser.