source: sasview/fittingview/docs/sphinx/html/api/perspectives/fitting/console.html @ 09e89b7

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

edit doc
  • Property mode set to 100644
File size: 15.5 KB
RevLine 
[5a9a98f]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
[30d3a1b]6
[5a9a98f]7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
[30d3a1b]11    <title>console &mdash; sansview 0.1.0 documentation</title>
12   
[5a9a98f]13    <link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
[30d3a1b]15   
[5a9a98f]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>
[30d3a1b]28    <link rel="top" title="sansview 0.1.0 documentation" href="../../../index.html" />
[5a9a98f]29    <link rel="up" title="Reference" href="index.html" />
[30d3a1b]30    <link rel="next" title="fitpage" href="fitpage.html" />
31    <link rel="prev" title="batchfitpage" href="batchfitpage.html" /> 
[5a9a98f]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" >
[30d3a1b]44          <a href="fitpage.html" title="fitpage"
[5a9a98f]45             accesskey="N">next</a> |</li>
46        <li class="right" >
[30d3a1b]47          <a href="batchfitpage.html" title="batchfitpage"
[5a9a98f]48             accesskey="P">previous</a> |</li>
[30d3a1b]49        <li><a href="../../../index.html">sansview 0.1.0 documentation</a> &raquo;</li>
[5a9a98f]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="console">
60<h1>console<a class="headerlink" href="#console" title="Permalink to this headline">¶</a></h1>
[30d3a1b]61<div class="section" id="sans-perspectives-fitting-console">
62<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="#sans-perspectives-fitting-console" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.perspectives.fitting.console"></span><dl class="class">
[5a9a98f]64<dt id="sans.perspectives.fitting.console.ConsoleUpdate">
[30d3a1b]65<em class="property">class </em><tt class="descclassname">sans.perspectives.fitting.console.</tt><tt class="descname">ConsoleUpdate</tt><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate" title="Permalink to this definition">¶</a></dt>
[5a9a98f]66<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">park.fitresult.FitHandler</span></tt></p>
67<p>Print progress to the console.</p>
[30d3a1b]68<dl class="attribute">
69<dt id="sans.perspectives.fitting.console.ConsoleUpdate.__class__">
70<tt class="descname">__class__</tt><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.__class__" title="Permalink to this definition">¶</a></dt>
71<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
72</dd></dl>
73
74<dl class="attribute">
75<dt id="sans.perspectives.fitting.console.ConsoleUpdate.__delattr__">
76<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.__delattr__" title="Permalink to this definition">¶</a></dt>
77<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
78</dd></dl>
79
80<dl class="attribute">
81<dt id="sans.perspectives.fitting.console.ConsoleUpdate.__dict__">
82<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x06CF05D0&gt;</em><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.__dict__" title="Permalink to this definition">¶</a></dt>
83<dd></dd></dl>
84
85<dl class="attribute">
86<dt id="sans.perspectives.fitting.console.ConsoleUpdate.__getattribute__">
87<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.__getattribute__" title="Permalink to this definition">¶</a></dt>
88<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
89</dd></dl>
90
91<dl class="attribute">
92<dt id="sans.perspectives.fitting.console.ConsoleUpdate.__hash__">
93<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.__hash__" title="Permalink to this definition">¶</a></dt>
94<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
95</dd></dl>
96
97<dl class="method">
98<dt id="sans.perspectives.fitting.console.ConsoleUpdate.__init__">
99<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.__init__" title="Permalink to this definition">¶</a></dt>
100<dd><p>If quiet is true, only print out final summary, not progress and
101improvements.</p>
102<table class="docutils field-list" frame="void" rules="none">
103<col class="field-name" />
104<col class="field-body" />
105<tbody valign="top">
106<tr class="field-odd field"><th class="field-name">Attr parent:</th><td class="field-body">the object that handle the messages</td>
107</tr>
108</tbody>
109</table>
110</dd></dl>
111
112<dl class="attribute">
113<dt id="sans.perspectives.fitting.console.ConsoleUpdate.__module__">
114<tt class="descname">__module__</tt><em class="property"> = 'sans.perspectives.fitting.console'</em><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.__module__" title="Permalink to this definition">¶</a></dt>
115<dd></dd></dl>
116
117<dl class="staticmethod">
118<dt id="sans.perspectives.fitting.console.ConsoleUpdate.__new__">
119<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.__new__" title="Permalink to this definition">¶</a></dt>
120<dd></dd></dl>
121
122<dl class="method">
123<dt id="sans.perspectives.fitting.console.ConsoleUpdate.__reduce__">
124<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.__reduce__" title="Permalink to this definition">¶</a></dt>
125<dd><p>helper for pickle</p>
126</dd></dl>
127
128<dl class="method">
129<dt id="sans.perspectives.fitting.console.ConsoleUpdate.__reduce_ex__">
130<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
131<dd><p>helper for pickle</p>
132</dd></dl>
133
134<dl class="attribute">
135<dt id="sans.perspectives.fitting.console.ConsoleUpdate.__repr__">
136<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.__repr__" title="Permalink to this definition">¶</a></dt>
137<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
138</dd></dl>
139
140<dl class="attribute">
141<dt id="sans.perspectives.fitting.console.ConsoleUpdate.__setattr__">
142<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.__setattr__" title="Permalink to this definition">¶</a></dt>
143<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
144</dd></dl>
145
146<dl class="attribute">
147<dt id="sans.perspectives.fitting.console.ConsoleUpdate.__str__">
148<tt class="descname">__str__</tt><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.__str__" title="Permalink to this definition">¶</a></dt>
149<dd><p>x.__str__() &lt;==&gt; str(x)</p>
150</dd></dl>
151
152<dl class="attribute">
153<dt id="sans.perspectives.fitting.console.ConsoleUpdate.__weakref__">
154<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.__weakref__" title="Permalink to this definition">¶</a></dt>
155<dd><p>list of weak references to the object (if defined)</p>
156</dd></dl>
157
[5a9a98f]158<dl class="method">
159<dt id="sans.perspectives.fitting.console.ConsoleUpdate.abort">
160<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>
161<dd></dd></dl>
162
[30d3a1b]163<dl class="attribute">
164<dt id="sans.perspectives.fitting.console.ConsoleUpdate.done">
165<tt class="descname">done</tt><em class="property"> = False</em><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.done" title="Permalink to this definition">¶</a></dt>
166<dd></dd></dl>
167
[5a9a98f]168<dl class="method">
169<dt id="sans.perspectives.fitting.console.ConsoleUpdate.error">
[30d3a1b]170<tt class="descname">error</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.error" title="Permalink to this definition">¶</a></dt>
[5a9a98f]171<dd><p>Model had an error; print traceback</p>
172</dd></dl>
173
174<dl class="method">
175<dt id="sans.perspectives.fitting.console.ConsoleUpdate.finalize">
176<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>
177<dd></dd></dl>
178
179<dl class="method">
180<dt id="sans.perspectives.fitting.console.ConsoleUpdate.get_result">
181<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>
182<dd></dd></dl>
183
184<dl class="method">
185<dt id="sans.perspectives.fitting.console.ConsoleUpdate.improvement">
186<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>
187<dd><p>Called when a result is observed which is better than previous
188results from the fit.</p>
189</dd></dl>
190
191<dl class="attribute">
192<dt id="sans.perspectives.fitting.console.ConsoleUpdate.improvement_delta">
[30d3a1b]193<tt class="descname">improvement_delta</tt><em class="property"> = 5</em><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.improvement_delta" title="Permalink to this definition">¶</a></dt>
[5a9a98f]194<dd><p>Number of seconds between improvement updates</p>
195</dd></dl>
196
197<dl class="attribute">
198<dt id="sans.perspectives.fitting.console.ConsoleUpdate.isbetter">
[30d3a1b]199<tt class="descname">isbetter</tt><em class="property"> = False</em><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.isbetter" title="Permalink to this definition">¶</a></dt>
[5a9a98f]200<dd><p>Record whether results improved since last update</p>
201</dd></dl>
202
203<dl class="method">
[30d3a1b]204<dt id="sans.perspectives.fitting.console.ConsoleUpdate.print_result">
205<tt class="descname">print_result</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.print_result" title="Permalink to this definition">¶</a></dt>
206<dd><p>Print result object</p>
207</dd></dl>
208
209<dl class="method">
[5a9a98f]210<dt id="sans.perspectives.fitting.console.ConsoleUpdate.progress">
[30d3a1b]211<tt class="descname">progress</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.progress" title="Permalink to this definition">¶</a></dt>
[5a9a98f]212<dd><p>Report on progress.</p>
213</dd></dl>
214
215<dl class="attribute">
216<dt id="sans.perspectives.fitting.console.ConsoleUpdate.progress_delta">
[30d3a1b]217<tt class="descname">progress_delta</tt><em class="property"> = 60</em><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.progress_delta" title="Permalink to this definition">¶</a></dt>
[5a9a98f]218<dd><p>Number of seconds between progress updates</p>
219</dd></dl>
220
[30d3a1b]221<dl class="attribute">
222<dt id="sans.perspectives.fitting.console.ConsoleUpdate.result">
223<tt class="descname">result</tt><em class="property"> = None</em><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.result" title="Permalink to this definition">¶</a></dt>
224<dd></dd></dl>
225
[5a9a98f]226<dl class="method">
227<dt id="sans.perspectives.fitting.console.ConsoleUpdate.set_result">
[30d3a1b]228<tt class="descname">set_result</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.set_result" title="Permalink to this definition">¶</a></dt>
[5a9a98f]229<dd></dd></dl>
230
231<dl class="method">
232<dt id="sans.perspectives.fitting.console.ConsoleUpdate.starting_fit">
233<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>
234<dd></dd></dl>
235
236<dl class="method">
237<dt id="sans.perspectives.fitting.console.ConsoleUpdate.update_fit">
[30d3a1b]238<tt class="descname">update_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.console.ConsoleUpdate.update_fit" title="Permalink to this definition">¶</a></dt>
[5a9a98f]239<dd></dd></dl>
240
241</dd></dl>
242
243</div>
244</div>
245
246
247          </div>
248        </div>
249      </div>
250      <div class="sphinxsidebar">
251        <div class="sphinxsidebarwrapper">
252  <h3><a href="../../../index.html">Table Of Contents</a></h3>
253  <ul>
254<li><a class="reference internal" href="#">console</a><ul>
[30d3a1b]255<li><a class="reference internal" href="#sans-perspectives-fitting-console"><tt class="docutils literal"><span class="pre">sans.perspectives.fitting.console</span></tt></a></li>
[5a9a98f]256</ul>
257</li>
258</ul>
259
260  <h4>Previous topic</h4>
[30d3a1b]261  <p class="topless"><a href="batchfitpage.html"
262                        title="previous chapter">batchfitpage</a></p>
[5a9a98f]263  <h4>Next topic</h4>
[30d3a1b]264  <p class="topless"><a href="fitpage.html"
265                        title="next chapter">fitpage</a></p>
[5a9a98f]266  <h3>This Page</h3>
267  <ul class="this-page-menu">
268    <li><a href="../../../_sources/api/perspectives/fitting/console.txt"
269           rel="nofollow">Show Source</a></li>
270  </ul>
271<div id="searchbox" style="display: none">
272  <h3>Quick search</h3>
273    <form class="search" action="../../../search.html" method="get">
[30d3a1b]274      <input type="text" name="q" />
[5a9a98f]275      <input type="submit" value="Go" />
276      <input type="hidden" name="check_keywords" value="yes" />
277      <input type="hidden" name="area" value="default" />
278    </form>
279    <p class="searchtip" style="font-size: 90%">
280    Enter search terms or a module, class or function name.
281    </p>
282</div>
283<script type="text/javascript">$('#searchbox').show(0);</script>
284        </div>
285      </div>
286      <div class="clearer"></div>
287    </div>
288    <div class="related">
289      <h3>Navigation</h3>
290      <ul>
291        <li class="right" style="margin-right: 10px">
292          <a href="../../../genindex.html" title="General Index"
293             >index</a></li>
294        <li class="right" >
295          <a href="../../../py-modindex.html" title="Python Module Index"
296             >modules</a> |</li>
297        <li class="right" >
[30d3a1b]298          <a href="fitpage.html" title="fitpage"
[5a9a98f]299             >next</a> |</li>
300        <li class="right" >
[30d3a1b]301          <a href="batchfitpage.html" title="batchfitpage"
[5a9a98f]302             >previous</a> |</li>
[30d3a1b]303        <li><a href="../../../index.html">sansview 0.1.0 documentation</a> &raquo;</li>
[5a9a98f]304          <li><a href="index.html" >Reference</a> &raquo;</li> 
305      </ul>
306    </div>
307    <div class="footer">
308        &copy; Copyright 2010, sans group.
[30d3a1b]309      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
[5a9a98f]310    </div>
311  </body>
312</html>
Note: See TracBrowser for help on using the repository browser.