source: sasview/fittingview/docs/sphinx/html/api/perspectives/fitting/console.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: 9.6 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" title="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>manager=None</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><p>Model had an error; print traceback</p>
74</dd></dl>
75
76<dl class="method">
77<dt id="sans.perspectives.fitting.console.ConsoleUpdate.finalize">
78<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>
79<dd></dd></dl>
80
81<dl class="method">
82<dt id="sans.perspectives.fitting.console.ConsoleUpdate.get_result">
83<tt class="descname">get_result</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.get_result" title="Permalink to this definition">¶</a></dt>
84<dd></dd></dl>
85
86<dl class="method">
87<dt id="sans.perspectives.fitting.console.ConsoleUpdate.improvement">
88<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>
89<dd><p>Called when a result is observed which is better than previous
90results from the fit.</p>
91</dd></dl>
92
93<dl class="attribute">
94<dt id="sans.perspectives.fitting.console.ConsoleUpdate.improvement_delta">
95<tt class="descname">improvement_delta</tt><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.improvement_delta" title="Permalink to this definition">¶</a></dt>
96<dd><p>Number of seconds between improvement updates</p>
97</dd></dl>
98
99<dl class="attribute">
100<dt id="sans.perspectives.fitting.console.ConsoleUpdate.isbetter">
101<tt class="descname">isbetter</tt><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.isbetter" title="Permalink to this definition">¶</a></dt>
102<dd><p>Record whether results improved since last update</p>
103</dd></dl>
104
105<dl class="method">
106<dt id="sans.perspectives.fitting.console.ConsoleUpdate.progress">
107<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>
108<dd><p>Report on progress.</p>
109</dd></dl>
110
111<dl class="attribute">
112<dt id="sans.perspectives.fitting.console.ConsoleUpdate.progress_delta">
113<tt class="descname">progress_delta</tt><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.progress_delta" title="Permalink to this definition">¶</a></dt>
114<dd><p>Number of seconds between progress updates</p>
115</dd></dl>
116
117<dl class="method">
118<dt id="sans.perspectives.fitting.console.ConsoleUpdate.set_result">
119<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>
120<dd></dd></dl>
121
122<dl class="method">
123<dt id="sans.perspectives.fitting.console.ConsoleUpdate.starting_fit">
124<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>
125<dd></dd></dl>
126
127<dl class="method">
128<dt id="sans.perspectives.fitting.console.ConsoleUpdate.update_fit">
129<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>
130<dd></dd></dl>
131
132</dd></dl>
133
134</div>
135</div>
136
137
138          </div>
139        </div>
140      </div>
141      <div class="sphinxsidebar">
142        <div class="sphinxsidebarwrapper">
143  <h3><a href="../../../index.html">Table Of Contents</a></h3>
144  <ul>
145<li><a class="reference internal" href="#">console</a><ul>
146<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>
147</ul>
148</li>
149</ul>
150
151  <h4>Previous topic</h4>
152  <p class="topless"><a href="basepage.html"
153                        title="previous chapter">basepage</a></p>
154  <h4>Next topic</h4>
155  <p class="topless"><a href="fit_thread.html"
156                        title="next chapter">fit_thread</a></p>
157  <h3>This Page</h3>
158  <ul class="this-page-menu">
159    <li><a href="../../../_sources/api/perspectives/fitting/console.txt"
160           rel="nofollow">Show Source</a></li>
161  </ul>
162<div id="searchbox" style="display: none">
163  <h3>Quick search</h3>
164    <form class="search" action="../../../search.html" method="get">
165      <input type="text" name="q" size="18" />
166      <input type="submit" value="Go" />
167      <input type="hidden" name="check_keywords" value="yes" />
168      <input type="hidden" name="area" value="default" />
169    </form>
170    <p class="searchtip" style="font-size: 90%">
171    Enter search terms or a module, class or function name.
172    </p>
173</div>
174<script type="text/javascript">$('#searchbox').show(0);</script>
175        </div>
176      </div>
177      <div class="clearer"></div>
178    </div>
179    <div class="related">
180      <h3>Navigation</h3>
181      <ul>
182        <li class="right" style="margin-right: 10px">
183          <a href="../../../genindex.html" title="General Index"
184             >index</a></li>
185        <li class="right" >
186          <a href="../../../py-modindex.html" title="Python Module Index"
187             >modules</a> |</li>
188        <li class="right" >
189          <a href="fit_thread.html" title="fit_thread"
190             >next</a> |</li>
191        <li class="right" >
192          <a href="basepage.html" title="basepage"
193             >previous</a> |</li>
194        <li><a href="../../../index.html">sansview v0.1.0 documentation</a> &raquo;</li>
195          <li><a href="index.html" >Reference</a> &raquo;</li> 
196      </ul>
197    </div>
198    <div class="footer">
199        &copy; Copyright 2010, sans group.
200      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
201    </div>
202  </body>
203</html>
Note: See TracBrowser for help on using the repository browser.