source: sasview/inversionview/docs/sphinx/html/api/perspectives/pr/pr_thread.html @ 40299ce

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 40299ce was 40299ce, checked in by Gervaise Alina <gervyh@…>, 13 years ago

edit doc
  • Property mode set to 100644
File size: 18.5 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>pr_thread &mdash; prview 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="prview 0.1.0 documentation" href="../../../index.html" />
29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="pr_widgets" href="pr_widgets.html" />
31    <link rel="prev" title="pr" href="pr.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="pr_widgets.html" title="pr_widgets"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="pr.html" title="pr"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../../../index.html">prview 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="pr-thread">
60<h1>pr_thread<a class="headerlink" href="#pr-thread" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-perspectives-pr-pr-thread">
62<h2><a class="reference internal" href="#module-sans.perspectives.pr.pr_thread" title="sans.perspectives.pr.pr_thread"><tt class="xref py py-mod docutils literal"><span class="pre">sans.perspectives.pr.pr_thread</span></tt></a><a class="headerlink" href="#sans-perspectives-pr-pr-thread" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.perspectives.pr.pr_thread"></span><dl class="class">
64<dt id="sans.perspectives.pr.pr_thread.CalcPr">
65<em class="property">class </em><tt class="descclassname">sans.perspectives.pr.pr_thread.</tt><tt class="descname">CalcPr</tt><a class="headerlink" href="#sans.perspectives.pr.pr_thread.CalcPr" 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>Compute P(r)</p>
68<dl class="method">
69<dt id="sans.perspectives.pr.pr_thread.CalcPr.complete">
70<tt class="descname">complete</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.CalcPr.complete" title="Permalink to this definition">¶</a></dt>
71<dd><p>Update the GUI with the completed results from a work unit.</p>
72</dd></dl>
73
74<dl class="method">
75<dt id="sans.perspectives.pr.pr_thread.CalcPr.compute">
76<tt class="descname">compute</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.CalcPr.compute" title="Permalink to this definition">¶</a></dt>
77<dd><p>Perform P(r) inversion</p>
78</dd></dl>
79
80<dl class="method">
81<dt id="sans.perspectives.pr.pr_thread.CalcPr.interrupt">
82<tt class="descname">interrupt</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.CalcPr.interrupt" title="Permalink to this definition">¶</a></dt>
83<dd><p>Stop the current work item.  To clear the work queue as
84well call the stop() method.</p>
85</dd></dl>
86
87<dl class="method">
88<dt id="sans.perspectives.pr.pr_thread.CalcPr.isquit">
89<tt class="descname">isquit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.CalcPr.isquit" title="Permalink to this definition">¶</a></dt>
90<dd><p>Check for interrupts.  Should be called frequently to
91provide user responsiveness.  Also yields to other running
92threads, which is required for good performance on OS X.</p>
93</dd></dl>
94
95<dl class="method">
96<dt id="sans.perspectives.pr.pr_thread.CalcPr.isrunning">
97<tt class="descname">isrunning</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.CalcPr.isrunning" title="Permalink to this definition">¶</a></dt>
98<dd></dd></dl>
99
100<dl class="method">
101<dt id="sans.perspectives.pr.pr_thread.CalcPr.queue">
102<tt class="descname">queue</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.CalcPr.queue" title="Permalink to this definition">¶</a></dt>
103<dd><p>Add a work unit to the end of the queue.  See the compute()
104method for details of the arguments to the work unit.</p>
105</dd></dl>
106
107<dl class="method">
108<dt id="sans.perspectives.pr.pr_thread.CalcPr.ready">
109<tt class="descname">ready</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.CalcPr.ready" title="Permalink to this definition">¶</a></dt>
110<dd><p>Ready for another update after delay=t seconds.  Call
111this for threads which can show intermediate results from
112long calculations.</p>
113</dd></dl>
114
115<dl class="method">
116<dt id="sans.perspectives.pr.pr_thread.CalcPr.requeue">
117<tt class="descname">requeue</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.CalcPr.requeue" title="Permalink to this definition">¶</a></dt>
118<dd><p>Replace the work unit on the end of the queue.  See the compute()
119method for details of the arguments to the work unit.</p>
120</dd></dl>
121
122<dl class="method">
123<dt id="sans.perspectives.pr.pr_thread.CalcPr.reset">
124<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.CalcPr.reset" title="Permalink to this definition">¶</a></dt>
125<dd><p>Clear the queue and start a new work unit.  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.pr.pr_thread.CalcPr.stop">
131<tt class="descname">stop</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.CalcPr.stop" title="Permalink to this definition">¶</a></dt>
132<dd><p>Clear the queue and stop the thread.  New items may be
133queued after stop.  To stop just the current work item, and
134continue the rest of the queue call the interrupt method</p>
135</dd></dl>
136
137<dl class="method">
138<dt id="sans.perspectives.pr.pr_thread.CalcPr.update">
139<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.CalcPr.update" title="Permalink to this definition">¶</a></dt>
140<dd><p>Update GUI with the lastest results from the current work unit.</p>
141</dd></dl>
142
143</dd></dl>
144
145<dl class="class">
146<dt id="sans.perspectives.pr.pr_thread.EstimateNT">
147<em class="property">class </em><tt class="descclassname">sans.perspectives.pr.pr_thread.</tt><tt class="descname">EstimateNT</tt><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimateNT" title="Permalink to this definition">¶</a></dt>
148<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">data_util.calcthread.CalcThread</span></tt></p>
149<dl class="method">
150<dt id="sans.perspectives.pr.pr_thread.EstimateNT.complete">
151<tt class="descname">complete</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimateNT.complete" title="Permalink to this definition">¶</a></dt>
152<dd><p>Update the GUI with the completed results from a work unit.</p>
153</dd></dl>
154
155<dl class="method">
156<dt id="sans.perspectives.pr.pr_thread.EstimateNT.compute">
157<tt class="descname">compute</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimateNT.compute" title="Permalink to this definition">¶</a></dt>
158<dd><p>Calculates the estimate</p>
159</dd></dl>
160
161<dl class="method">
162<dt id="sans.perspectives.pr.pr_thread.EstimateNT.interrupt">
163<tt class="descname">interrupt</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimateNT.interrupt" title="Permalink to this definition">¶</a></dt>
164<dd><p>Stop the current work item.  To clear the work queue as
165well call the stop() method.</p>
166</dd></dl>
167
168<dl class="method">
169<dt id="sans.perspectives.pr.pr_thread.EstimateNT.isquit">
170<tt class="descname">isquit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimateNT.isquit" title="Permalink to this definition">¶</a></dt>
171<dd></dd></dl>
172
173<dl class="method">
174<dt id="sans.perspectives.pr.pr_thread.EstimateNT.isrunning">
175<tt class="descname">isrunning</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimateNT.isrunning" title="Permalink to this definition">¶</a></dt>
176<dd></dd></dl>
177
178<dl class="method">
179<dt id="sans.perspectives.pr.pr_thread.EstimateNT.queue">
180<tt class="descname">queue</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimateNT.queue" title="Permalink to this definition">¶</a></dt>
181<dd><p>Add a work unit to the end of the queue.  See the compute()
182method for details of the arguments to the work unit.</p>
183</dd></dl>
184
185<dl class="method">
186<dt id="sans.perspectives.pr.pr_thread.EstimateNT.ready">
187<tt class="descname">ready</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimateNT.ready" title="Permalink to this definition">¶</a></dt>
188<dd><p>Ready for another update after delay=t seconds.  Call
189this for threads which can show intermediate results from
190long calculations.</p>
191</dd></dl>
192
193<dl class="method">
194<dt id="sans.perspectives.pr.pr_thread.EstimateNT.requeue">
195<tt class="descname">requeue</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimateNT.requeue" title="Permalink to this definition">¶</a></dt>
196<dd><p>Replace the work unit on the end of the queue.  See the compute()
197method for details of the arguments to the work unit.</p>
198</dd></dl>
199
200<dl class="method">
201<dt id="sans.perspectives.pr.pr_thread.EstimateNT.reset">
202<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimateNT.reset" title="Permalink to this definition">¶</a></dt>
203<dd><p>Clear the queue and start a new work unit.  See the compute()
204method for details of the arguments to the work unit.</p>
205</dd></dl>
206
207<dl class="method">
208<dt id="sans.perspectives.pr.pr_thread.EstimateNT.stop">
209<tt class="descname">stop</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimateNT.stop" title="Permalink to this definition">¶</a></dt>
210<dd><p>Clear the queue and stop the thread.  New items may be
211queued after stop.  To stop just the current work item, and
212continue the rest of the queue call the interrupt method</p>
213</dd></dl>
214
215<dl class="method">
216<dt id="sans.perspectives.pr.pr_thread.EstimateNT.update">
217<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimateNT.update" title="Permalink to this definition">¶</a></dt>
218<dd><p>Update GUI with the lastest results from the current work unit.</p>
219</dd></dl>
220
221</dd></dl>
222
223<dl class="class">
224<dt id="sans.perspectives.pr.pr_thread.EstimatePr">
225<em class="property">class </em><tt class="descclassname">sans.perspectives.pr.pr_thread.</tt><tt class="descname">EstimatePr</tt><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimatePr" title="Permalink to this definition">¶</a></dt>
226<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">data_util.calcthread.CalcThread</span></tt></p>
227<p>Estimate P(r)</p>
228<dl class="method">
229<dt id="sans.perspectives.pr.pr_thread.EstimatePr.complete">
230<tt class="descname">complete</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimatePr.complete" title="Permalink to this definition">¶</a></dt>
231<dd><p>Update the GUI with the completed results from a work unit.</p>
232</dd></dl>
233
234<dl class="method">
235<dt id="sans.perspectives.pr.pr_thread.EstimatePr.compute">
236<tt class="descname">compute</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimatePr.compute" title="Permalink to this definition">¶</a></dt>
237<dd><p>Calculates the estimate</p>
238</dd></dl>
239
240<dl class="method">
241<dt id="sans.perspectives.pr.pr_thread.EstimatePr.interrupt">
242<tt class="descname">interrupt</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimatePr.interrupt" title="Permalink to this definition">¶</a></dt>
243<dd><p>Stop the current work item.  To clear the work queue as
244well call the stop() method.</p>
245</dd></dl>
246
247<dl class="method">
248<dt id="sans.perspectives.pr.pr_thread.EstimatePr.isquit">
249<tt class="descname">isquit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimatePr.isquit" title="Permalink to this definition">¶</a></dt>
250<dd><p>Check for interrupts.  Should be called frequently to
251provide user responsiveness.  Also yields to other running
252threads, which is required for good performance on OS X.</p>
253</dd></dl>
254
255<dl class="method">
256<dt id="sans.perspectives.pr.pr_thread.EstimatePr.isrunning">
257<tt class="descname">isrunning</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimatePr.isrunning" title="Permalink to this definition">¶</a></dt>
258<dd></dd></dl>
259
260<dl class="method">
261<dt id="sans.perspectives.pr.pr_thread.EstimatePr.queue">
262<tt class="descname">queue</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimatePr.queue" title="Permalink to this definition">¶</a></dt>
263<dd><p>Add a work unit to the end of the queue.  See the compute()
264method for details of the arguments to the work unit.</p>
265</dd></dl>
266
267<dl class="method">
268<dt id="sans.perspectives.pr.pr_thread.EstimatePr.ready">
269<tt class="descname">ready</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimatePr.ready" title="Permalink to this definition">¶</a></dt>
270<dd><p>Ready for another update after delay=t seconds.  Call
271this for threads which can show intermediate results from
272long calculations.</p>
273</dd></dl>
274
275<dl class="method">
276<dt id="sans.perspectives.pr.pr_thread.EstimatePr.requeue">
277<tt class="descname">requeue</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimatePr.requeue" title="Permalink to this definition">¶</a></dt>
278<dd><p>Replace the work unit on the end of the queue.  See the compute()
279method for details of the arguments to the work unit.</p>
280</dd></dl>
281
282<dl class="method">
283<dt id="sans.perspectives.pr.pr_thread.EstimatePr.reset">
284<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimatePr.reset" title="Permalink to this definition">¶</a></dt>
285<dd><p>Clear the queue and start a new work unit.  See the compute()
286method for details of the arguments to the work unit.</p>
287</dd></dl>
288
289<dl class="method">
290<dt id="sans.perspectives.pr.pr_thread.EstimatePr.stop">
291<tt class="descname">stop</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimatePr.stop" title="Permalink to this definition">¶</a></dt>
292<dd><p>Clear the queue and stop the thread.  New items may be
293queued after stop.  To stop just the current work item, and
294continue the rest of the queue call the interrupt method</p>
295</dd></dl>
296
297<dl class="method">
298<dt id="sans.perspectives.pr.pr_thread.EstimatePr.update">
299<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.pr.pr_thread.EstimatePr.update" title="Permalink to this definition">¶</a></dt>
300<dd><p>Update GUI with the lastest results from the current work unit.</p>
301</dd></dl>
302
303</dd></dl>
304
305</div>
306</div>
307
308
309          </div>
310        </div>
311      </div>
312      <div class="sphinxsidebar">
313        <div class="sphinxsidebarwrapper">
314  <h3><a href="../../../index.html">Table Of Contents</a></h3>
315  <ul>
316<li><a class="reference internal" href="#">pr_thread</a><ul>
317<li><a class="reference internal" href="#sans-perspectives-pr-pr-thread"><tt class="docutils literal"><span class="pre">sans.perspectives.pr.pr_thread</span></tt></a></li>
318</ul>
319</li>
320</ul>
321
322  <h4>Previous topic</h4>
323  <p class="topless"><a href="pr.html"
324                        title="previous chapter">pr</a></p>
325  <h4>Next topic</h4>
326  <p class="topless"><a href="pr_widgets.html"
327                        title="next chapter">pr_widgets</a></p>
328  <h3>This Page</h3>
329  <ul class="this-page-menu">
330    <li><a href="../../../_sources/api/perspectives/pr/pr_thread.txt"
331           rel="nofollow">Show Source</a></li>
332  </ul>
333<div id="searchbox" style="display: none">
334  <h3>Quick search</h3>
335    <form class="search" action="../../../search.html" method="get">
336      <input type="text" name="q" />
337      <input type="submit" value="Go" />
338      <input type="hidden" name="check_keywords" value="yes" />
339      <input type="hidden" name="area" value="default" />
340    </form>
341    <p class="searchtip" style="font-size: 90%">
342    Enter search terms or a module, class or function name.
343    </p>
344</div>
345<script type="text/javascript">$('#searchbox').show(0);</script>
346        </div>
347      </div>
348      <div class="clearer"></div>
349    </div>
350    <div class="related">
351      <h3>Navigation</h3>
352      <ul>
353        <li class="right" style="margin-right: 10px">
354          <a href="../../../genindex.html" title="General Index"
355             >index</a></li>
356        <li class="right" >
357          <a href="../../../py-modindex.html" title="Python Module Index"
358             >modules</a> |</li>
359        <li class="right" >
360          <a href="pr_widgets.html" title="pr_widgets"
361             >next</a> |</li>
362        <li class="right" >
363          <a href="pr.html" title="pr"
364             >previous</a> |</li>
365        <li><a href="../../../index.html">prview 0.1.0 documentation</a> &raquo;</li>
366          <li><a href="index.html" >Reference</a> &raquo;</li> 
367      </ul>
368    </div>
369    <div class="footer">
370        &copy; Copyright 2010, sans group.
371      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
372    </div>
373  </body>
374</html>
Note: See TracBrowser for help on using the repository browser.