Ignore:
Timestamp:
Oct 24, 2011 1:15:13 PM (13 years ago)
Author:
Gervaise Alina <gervyh@…>
Branches:
master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
89b7858
Parents:
63edfb2
Message:

edit doc

File:
1 edited

Legend:

Unmodified
Added
Removed

  • fittingview/docs/sphinx/html/api/perspectives/fitting/fit_thread.html

    r5a9a98f r30d3a1b  
    33<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
    44  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
     5 
    56 
    67<html xmlns="http://www.w3.org/1999/xhtml"> 
    … …  
    89    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 
    910     
    10     <title>fit_thread &mdash; sansview v0.1.0 documentation</title> 
     11    <title>fit_thread &mdash; sansview 0.1.0 documentation</title> 
     12     
    1113    <link rel="stylesheet" href="../../../_static/default.css" type="text/css" /> 
    1214    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> 
     15     
    1316    <script type="text/javascript"> 
    1417      var DOCUMENTATION_OPTIONS = { 
    … …  
    2326    <script type="text/javascript" src="../../../_static/underscore.js"></script> 
    2427    <script type="text/javascript" src="../../../_static/doctools.js"></script> 
    25     <link rel="top" title="sansview v0.1.0 documentation" href="../../../index.html" /> 
     28    <link rel="top" title="sansview 0.1.0 documentation" href="../../../index.html" /> 
    2629    <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" />  
     30    <link rel="next" title="ftol_dialog" href="ftol_dialog.html" /> 
     31    <link rel="prev" title="fitting_widgets" href="fitting_widgets.html" />  
    2932  </head> 
    3033  <body> 
    … …  
    3942             >modules</a> |</li> 
    4043        <li class="right" > 
    41           <a href="fitpage.html" title="fitpage" 
     44          <a href="ftol_dialog.html" title="ftol_dialog" 
    4245             accesskey="N">next</a> |</li> 
    4346        <li class="right" > 
    44           <a href="console.html" title="console" 
     47          <a href="fitting_widgets.html" title="fitting_widgets" 
    4548             accesskey="P">previous</a> |</li> 
    46         <li><a href="../../../index.html">sansview v0.1.0 documentation</a> &raquo;</li> 
     49        <li><a href="../../../index.html">sansview 0.1.0 documentation</a> &raquo;</li> 
    4750          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li>  
    4851      </ul> 
    … …  
    5659  <div class="section" id="fit-thread"> 
    5760<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<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"> 
    6164<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> 
     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> 
    6366<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">data_util.calcthread.CalcThread</span></tt></p> 
    6467<p>Thread performing the fit</p> 
    6568<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"> 
    6685<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> 
     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> 
    6887<dd><p>Update the GUI with the completed results from a work unit.</p> 
    6988</dd></dl> 
    … …  
    89108<col class="field-body" /> 
    90109<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> 
     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> 
    93112</tr> 
    94113</tbody> 
    … …  
    103122<dl class="method"> 
    104123<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> 
     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> 
    106125<dd><p>Add a work unit to the end of the queue.  See the compute() 
    107126method for details of the arguments to the work unit.</p> 
    … …  
    110129<dl class="method"> 
    111130<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> 
     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> 
    113132<dd><p>Ready for another update after delay=t seconds.  Call 
    114133this for threads which can show intermediate results from 
    … …  
    118137<dl class="method"> 
    119138<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> 
     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> 
    121140<dd><p>Replace the work unit on the end of the queue.  See the compute() 
    122141method for details of the arguments to the work unit.</p> 
    … …  
    125144<dl class="method"> 
    126145<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> 
     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> 
    128147<dd><p>Clear the queue and start a new work unit.  See the compute() 
    129148method for details of the arguments to the work unit.</p> 
    … …  
    140159<dl class="method"> 
    141160<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> 
     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> 
    143162<dd><p>Update GUI with the lastest results from the current work unit.</p> 
    144163</dd></dl> 
    … …  
    148167<dl class="function"> 
    149168<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> 
     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> 
    151170<dd></dd></dl> 
    152171 
    153172<dl class="function"> 
    154173<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> 
     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> 
    156175<dd><p>Take an instance of a class and a function name as a string. 
    157176Execute class.function and return result</p> 
    … …  
    170189  <ul> 
    171190<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> 
     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> 
    173192</ul> 
    174193</li> 
    … …  
    176195 
    177196  <h4>Previous topic</h4> 
    178   <p class="topless"><a href="console.html" 
    179                         title="previous chapter">console</a></p> 
     197  <p class="topless"><a href="fitting_widgets.html" 
     198                        title="previous chapter">fitting_widgets</a></p> 
    180199  <h4>Next topic</h4> 
    181   <p class="topless"><a href="fitpage.html" 
    182                         title="next chapter">fitpage</a></p> 
     200  <p class="topless"><a href="ftol_dialog.html" 
     201                        title="next chapter">ftol_dialog</a></p> 
    183202  <h3>This Page</h3> 
    184203  <ul class="this-page-menu"> 
    … …  
    189208  <h3>Quick search</h3> 
    190209    <form class="search" action="../../../search.html" method="get"> 
    191       <input type="text" name="q" size="18" /> 
     210      <input type="text" name="q" /> 
    192211      <input type="submit" value="Go" /> 
    193212      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    213232             >modules</a> |</li> 
    214233        <li class="right" > 
    215           <a href="fitpage.html" title="fitpage" 
     234          <a href="ftol_dialog.html" title="ftol_dialog" 
    216235             >next</a> |</li> 
    217236        <li class="right" > 
    218           <a href="console.html" title="console" 
     237          <a href="fitting_widgets.html" title="fitting_widgets" 
    219238             >previous</a> |</li> 
    220         <li><a href="../../../index.html">sansview v0.1.0 documentation</a> &raquo;</li> 
     239        <li><a href="../../../index.html">sansview 0.1.0 documentation</a> &raquo;</li> 
    221240          <li><a href="index.html" >Reference</a> &raquo;</li>  
    222241      </ul> 
    … …  
    224243    <div class="footer"> 
    225244        &copy; Copyright 2010, sans group. 
    226       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     245      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    227246    </div> 
    228247  </body> 
Note: See TracChangeset for help on using the changeset viewer.