source: sasview/sansview/docs/sphinx/_build/html/api/perspectives/fitting/console.html @ 5062bbf

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 5062bbf was 5062bbf, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on documentation
  • Property mode set to 100644
File size: 9.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>console &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="fit_thread" href="fit_thread.html" />
28    <link rel="prev" title="basepage" href="basepage.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="fit_thread.html" title="fit_thread"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="basepage.html" title="basepage"
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="console">
57<h1>console<a class="headerlink" href="#console" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.perspectives.fitting.console">
59<span id="sans-perspectives-fitting-console"></span><h2><a class="reference internal" href="#module-sans.perspectives.fitting.console"><tt class="xref py py-mod docutils literal"><span class="pre">sans.perspectives.fitting.console</span></tt></a><a class="headerlink" href="#module-sans.perspectives.fitting.console" title="Permalink to this headline">¶</a></h2>
60<dl class="class">
61<dt id="sans.perspectives.fitting.console.ConsoleUpdate">
62<em class="property">class </em><tt class="descclassname">sans.perspectives.fitting.console.</tt><tt class="descname">ConsoleUpdate</tt><big>(</big><em>parent</em>, <em>quiet=False</em>, <em>progress_delta=60</em>, <em>improvement_delta=5</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate" title="Permalink to this definition">¶</a></dt>
63<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">park.fitresult.FitHandler</span></tt></p>
64<p>Print progress to the console.</p>
65<dl class="method">
66<dt id="sans.perspectives.fitting.console.ConsoleUpdate.abort">
67<tt class="descname">abort</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.abort" title="Permalink to this definition">¶</a></dt>
68<dd></dd></dl>
69
70<dl class="method">
71<dt id="sans.perspectives.fitting.console.ConsoleUpdate.error">
72<tt class="descname">error</tt><big>(</big><em>msg</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.error" title="Permalink to this definition">¶</a></dt>
73<dd>Model had an error; print traceback</dd></dl>
74
75<dl class="method">
76<dt id="sans.perspectives.fitting.console.ConsoleUpdate.finalize">
77<tt class="descname">finalize</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.finalize" title="Permalink to this definition">¶</a></dt>
78<dd></dd></dl>
79
80<dl class="method">
81<dt id="sans.perspectives.fitting.console.ConsoleUpdate.improvement">
82<tt class="descname">improvement</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.improvement" title="Permalink to this definition">¶</a></dt>
83<dd>Called when a result is observed which is better than previous
84results from the fit.</dd></dl>
85
86<dl class="attribute">
87<dt id="sans.perspectives.fitting.console.ConsoleUpdate.improvement_delta">
88<tt class="descname">improvement_delta</tt><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.improvement_delta" title="Permalink to this definition">¶</a></dt>
89<dd>Number of seconds between improvement updates</dd></dl>
90
91<dl class="attribute">
92<dt id="sans.perspectives.fitting.console.ConsoleUpdate.isbetter">
93<tt class="descname">isbetter</tt><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.isbetter" title="Permalink to this definition">¶</a></dt>
94<dd>Record whether results improved since last update</dd></dl>
95
96<dl class="method">
97<dt id="sans.perspectives.fitting.console.ConsoleUpdate.progress">
98<tt class="descname">progress</tt><big>(</big><em>k</em>, <em>n</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.progress" title="Permalink to this definition">¶</a></dt>
99<dd>Report on progress.</dd></dl>
100
101<dl class="attribute">
102<dt id="sans.perspectives.fitting.console.ConsoleUpdate.progress_delta">
103<tt class="descname">progress_delta</tt><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.progress_delta" title="Permalink to this definition">¶</a></dt>
104<dd>Number of seconds between progress updates</dd></dl>
105
106<dl class="method">
107<dt id="sans.perspectives.fitting.console.ConsoleUpdate.set_result">
108<tt class="descname">set_result</tt><big>(</big><em>result</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.set_result" title="Permalink to this definition">¶</a></dt>
109<dd></dd></dl>
110
111<dl class="method">
112<dt id="sans.perspectives.fitting.console.ConsoleUpdate.starting_fit">
113<tt class="descname">starting_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.starting_fit" title="Permalink to this definition">¶</a></dt>
114<dd></dd></dl>
115
116<dl class="method">
117<dt id="sans.perspectives.fitting.console.ConsoleUpdate.update_fit">
118<tt class="descname">update_fit</tt><big>(</big><em>msg=''</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.update_fit" title="Permalink to this definition">¶</a></dt>
119<dd></dd></dl>
120
121</dd></dl>
122
123</div>
124</div>
125
126
127          </div>
128        </div>
129      </div>
130      <div class="sphinxsidebar">
131        <div class="sphinxsidebarwrapper">
132  <h3><a href="../../../index.html">Table Of Contents</a></h3>
133  <ul>
134<li><a class="reference internal" href="#">console</a><ul>
135<li><a class="reference internal" href="#module-sans.perspectives.fitting.console"><tt class="docutils literal"><span class="pre">sans.perspectives.fitting.console</span></tt></a></li>
136</ul>
137</li>
138</ul>
139
140  <h4>Previous topic</h4>
141  <p class="topless"><a href="basepage.html"
142                        title="previous chapter">basepage</a></p>
143  <h4>Next topic</h4>
144  <p class="topless"><a href="fit_thread.html"
145                        title="next chapter">fit_thread</a></p>
146  <h3>This Page</h3>
147  <ul class="this-page-menu">
148    <li><a href="../../../_sources/api/perspectives/fitting/console.txt"
149           rel="nofollow">Show Source</a></li>
150  </ul>
151<div id="searchbox" style="display: none">
152  <h3>Quick search</h3>
153    <form class="search" action="../../../search.html" method="get">
154      <input type="text" name="q" size="18" />
155      <input type="submit" value="Go" />
156      <input type="hidden" name="check_keywords" value="yes" />
157      <input type="hidden" name="area" value="default" />
158    </form>
159    <p class="searchtip" style="font-size: 90%">
160    Enter search terms or a module, class or function name.
161    </p>
162</div>
163<script type="text/javascript">$('#searchbox').show(0);</script>
164        </div>
165      </div>
166      <div class="clearer"></div>
167    </div>
168    <div class="related">
169      <h3>Navigation</h3>
170      <ul>
171        <li class="right" style="margin-right: 10px">
172          <a href="../../../genindex.html" title="General Index"
173             >index</a></li>
174        <li class="right" >
175          <a href="../../../py-modindex.html" title="Python Module Index"
176             >modules</a> |</li>
177        <li class="right" >
178          <a href="fit_thread.html" title="fit_thread"
179             >next</a> |</li>
180        <li class="right" >
181          <a href="basepage.html" title="basepage"
182             >previous</a> |</li>
183        <li><a href="../../../index.html">sansview v0.1.0 documentation</a> &raquo;</li>
184          <li><a href="index.html" >Reference</a> &raquo;</li> 
185      </ul>
186    </div>
187    <div class="footer">
188        &copy; Copyright 2010, sans group.
189      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
190    </div>
191  </body>
192</html>
Note: See TracBrowser for help on using the repository browser.