source: sasview/fittingview/docs/sphinx/html/api/perspectives/fitting/pagestate.html @ 89b7858

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

edit doc
  • Property mode set to 100644
File size: 27.7 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>pagestate &mdash; sansview 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="sansview 0.1.0 documentation" href="../../../index.html" />
29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="report_dialog" href="report_dialog.html" />
31    <link rel="prev" title="model_thread" href="model_thread.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="report_dialog.html" title="report_dialog"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="model_thread.html" title="model_thread"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../../../index.html">sansview 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="pagestate">
60<h1>pagestate<a class="headerlink" href="#pagestate" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-perspectives-fitting-pagestate">
62<h2><a class="reference internal" href="#module-sans.perspectives.fitting.pagestate" title="sans.perspectives.fitting.pagestate"><tt class="xref py py-mod docutils literal"><span class="pre">sans.perspectives.fitting.pagestate</span></tt></a><a class="headerlink" href="#sans-perspectives-fitting-pagestate" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.perspectives.fitting.pagestate"></span><dl class="class">
64<dt id="sans.perspectives.fitting.pagestate.PageState">
65<em class="property">class </em><tt class="descclassname">sans.perspectives.fitting.pagestate.</tt><tt class="descname">PageState</tt><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState" title="Permalink to this definition">¶</a></dt>
66<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
67<p>Contains information to reconstruct a page of the fitpanel.</p>
68<dl class="attribute">
69<dt id="sans.perspectives.fitting.pagestate.PageState.__class__">
70<tt class="descname">__class__</tt><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.__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.pagestate.PageState.__delattr__">
76<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.__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.pagestate.PageState.__dict__">
82<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x0873E610&gt;</em><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.__dict__" title="Permalink to this definition">¶</a></dt>
83<dd></dd></dl>
84
85<dl class="attribute">
86<dt id="sans.perspectives.fitting.pagestate.PageState.__getattribute__">
87<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.__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.pagestate.PageState.__hash__">
93<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.__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.pagestate.PageState.__init__">
99<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.__init__" title="Permalink to this definition">¶</a></dt>
100<dd><p>Initialize the current state</p>
101<table class="docutils field-list" frame="void" rules="none">
102<col class="field-name" />
103<col class="field-body" />
104<tbody valign="top">
105<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
106<li><strong>model</strong> &#8211; a selected model within a page</li>
107<li><strong>data</strong> &#8211; </li>
108</ul>
109</td>
110</tr>
111</tbody>
112</table>
113</dd></dl>
114
115<dl class="attribute">
116<dt id="sans.perspectives.fitting.pagestate.PageState.__module__">
117<tt class="descname">__module__</tt><em class="property"> = 'sans.perspectives.fitting.pagestate'</em><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.__module__" title="Permalink to this definition">¶</a></dt>
118<dd></dd></dl>
119
120<dl class="staticmethod">
121<dt id="sans.perspectives.fitting.pagestate.PageState.__new__">
122<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.pagestate.PageState.__new__" title="Permalink to this definition">¶</a></dt>
123<dd></dd></dl>
124
125<dl class="method">
126<dt id="sans.perspectives.fitting.pagestate.PageState.__reduce__">
127<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.__reduce__" title="Permalink to this definition">¶</a></dt>
128<dd><p>helper for pickle</p>
129</dd></dl>
130
131<dl class="method">
132<dt id="sans.perspectives.fitting.pagestate.PageState.__reduce_ex__">
133<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
134<dd><p>helper for pickle</p>
135</dd></dl>
136
137<dl class="method">
138<dt id="sans.perspectives.fitting.pagestate.PageState.__repr__">
139<tt class="descname">__repr__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.__repr__" title="Permalink to this definition">¶</a></dt>
140<dd><p>output string for printing</p>
141</dd></dl>
142
143<dl class="attribute">
144<dt id="sans.perspectives.fitting.pagestate.PageState.__setattr__">
145<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.__setattr__" title="Permalink to this definition">¶</a></dt>
146<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
147</dd></dl>
148
149<dl class="attribute">
150<dt id="sans.perspectives.fitting.pagestate.PageState.__str__">
151<tt class="descname">__str__</tt><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.__str__" title="Permalink to this definition">¶</a></dt>
152<dd><p>x.__str__() &lt;==&gt; str(x)</p>
153</dd></dl>
154
155<dl class="attribute">
156<dt id="sans.perspectives.fitting.pagestate.PageState.__weakref__">
157<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.__weakref__" title="Permalink to this definition">¶</a></dt>
158<dd><p>list of weak references to the object (if defined)</p>
159</dd></dl>
160
161<dl class="method">
162<dt id="sans.perspectives.fitting.pagestate.PageState._check_html_format">
163<tt class="descname">_check_html_format</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState._check_html_format" title="Permalink to this definition">¶</a></dt>
164<dd><p>Check string &#8216;%&#8217; for html format</p>
165</dd></dl>
166
167<dl class="method">
168<dt id="sans.perspectives.fitting.pagestate.PageState._fromXML_helper">
169<tt class="descname">_fromXML_helper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState._fromXML_helper" title="Permalink to this definition">¶</a></dt>
170<dd><p>Helper function to write state to xml</p>
171</dd></dl>
172
173<dl class="method">
174<dt id="sans.perspectives.fitting.pagestate.PageState._repr_helper">
175<tt class="descname">_repr_helper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState._repr_helper" title="Permalink to this definition">¶</a></dt>
176<dd><p>Helper method to print a state</p>
177</dd></dl>
178
179<dl class="method">
180<dt id="sans.perspectives.fitting.pagestate.PageState._toXML_helper">
181<tt class="descname">_toXML_helper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState._toXML_helper" title="Permalink to this definition">¶</a></dt>
182<dd><p>Helper method to create xml file for saving state</p>
183</dd></dl>
184
185<dl class="method">
186<dt id="sans.perspectives.fitting.pagestate.PageState.clone">
187<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.clone" title="Permalink to this definition">¶</a></dt>
188<dd><p>Create a new copy of the current object</p>
189</dd></dl>
190
191<dl class="method">
192<dt id="sans.perspectives.fitting.pagestate.PageState.fromXML">
193<tt class="descname">fromXML</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.fromXML" title="Permalink to this definition">¶</a></dt>
194<dd><p>Load fitting state from a file</p>
195<table class="docutils field-list" frame="void" rules="none">
196<col class="field-name" />
197<col class="field-body" />
198<tbody valign="top">
199<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
200<li><strong>file</strong> &#8211; .fitv file</li>
201<li><strong>node</strong> &#8211; node of a XML document to read from</li>
202</ul>
203</td>
204</tr>
205</tbody>
206</table>
207</dd></dl>
208
209<dl class="method">
210<dt id="sans.perspectives.fitting.pagestate.PageState.report">
211<tt class="descname">report</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.report" title="Permalink to this definition">¶</a></dt>
212<dd><p>Invoke report dialog panel</p>
213<p>: param figs: list of pylab figures [list]</p>
214</dd></dl>
215
216<dl class="method">
217<dt id="sans.perspectives.fitting.pagestate.PageState.set_plot_state">
218<tt class="descname">set_plot_state</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.set_plot_state" title="Permalink to this definition">¶</a></dt>
219<dd><p>Build image state that wx.html understand
220by plotting, putting it into wx.FileSystem image object</p>
221</dd></dl>
222
223<dl class="method">
224<dt id="sans.perspectives.fitting.pagestate.PageState.set_report_string">
225<tt class="descname">set_report_string</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.set_report_string" title="Permalink to this definition">¶</a></dt>
226<dd><p>Get the values (strings) from __str__ for report</p>
227</dd></dl>
228
229<dl class="method">
230<dt id="sans.perspectives.fitting.pagestate.PageState.toXML">
231<tt class="descname">toXML</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.toXML" title="Permalink to this definition">¶</a></dt>
232<dd><p>Writes the state of the InversionControl panel to file, as XML.</p>
233<p>Compatible with standalone writing, or appending to an
234already existing XML document. In that case, the XML document
235is required. An optional entry node in the XML document may also be given.</p>
236<table class="docutils field-list" frame="void" rules="none">
237<col class="field-name" />
238<col class="field-body" />
239<tbody valign="top">
240<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
241<li><strong>file</strong> &#8211; file to write to</li>
242<li><strong>doc</strong> &#8211; XML document object [optional]</li>
243<li><strong>entry_node</strong> &#8211; XML node within the XML document at which we will append the data [optional]</li>
244</ul>
245</td>
246</tr>
247</tbody>
248</table>
249</dd></dl>
250
251</dd></dl>
252
253<dl class="class">
254<dt id="sans.perspectives.fitting.pagestate.Reader">
255<em class="property">class </em><tt class="descclassname">sans.perspectives.fitting.pagestate.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader" title="Permalink to this definition">¶</a></dt>
256<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.readers.cansas_reader.Reader</span></tt></p>
257<p>Class to load a .fitv fitting file</p>
258<dl class="method">
259<dt id="sans.perspectives.fitting.pagestate.Reader.__init__">
260<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader.__init__" title="Permalink to this definition">¶</a></dt>
261<dd></dd></dl>
262
263<dl class="attribute">
264<dt id="sans.perspectives.fitting.pagestate.Reader.__module__">
265<tt class="descname">__module__</tt><em class="property"> = 'sans.perspectives.fitting.pagestate'</em><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader.__module__" title="Permalink to this definition">¶</a></dt>
266<dd></dd></dl>
267
268<dl class="method">
269<dt id="sans.perspectives.fitting.pagestate.Reader._data2d_to_xml_doc">
270<tt class="descname">_data2d_to_xml_doc</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader._data2d_to_xml_doc" title="Permalink to this definition">¶</a></dt>
271<dd><p>Create an XML document to contain the content of a Data2D</p>
272<table class="docutils field-list" frame="void" rules="none">
273<col class="field-name" />
274<col class="field-body" />
275<tbody valign="top">
276<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>datainfo</strong> &#8211; Data2D object</td>
277</tr>
278</tbody>
279</table>
280</dd></dl>
281
282<dl class="method">
283<dt id="sans.perspectives.fitting.pagestate.Reader._parse_entry">
284<tt class="descname">_parse_entry</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader._parse_entry" title="Permalink to this definition">¶</a></dt>
285<dd><p>Parse a SASentry</p>
286<table class="docutils field-list" frame="void" rules="none">
287<col class="field-name" />
288<col class="field-body" />
289<tbody valign="top">
290<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>node</strong> &#8211; SASentry node</td>
291</tr>
292<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Data1D/Data2D object</td>
293</tr>
294</tbody>
295</table>
296</dd></dl>
297
298<dl class="method">
299<dt id="sans.perspectives.fitting.pagestate.Reader._parse_state">
300<tt class="descname">_parse_state</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader._parse_state" title="Permalink to this definition">¶</a></dt>
301<dd><p>Read a fit result from an XML node</p>
302<table class="docutils field-list" frame="void" rules="none">
303<col class="field-name" />
304<col class="field-body" />
305<tbody valign="top">
306<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>entry</strong> &#8211; XML node to read from</td>
307</tr>
308<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">PageState object</td>
309</tr>
310</tbody>
311</table>
312</dd></dl>
313
314<dl class="method">
315<dt id="sans.perspectives.fitting.pagestate.Reader._read_cansas">
316<tt class="descname">_read_cansas</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader._read_cansas" title="Permalink to this definition">¶</a></dt>
317<dd><p>Load data and P(r) information from a CanSAS XML file.</p>
318<table class="docutils field-list" frame="void" rules="none">
319<col class="field-name" />
320<col class="field-body" />
321<tbody valign="top">
322<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>path</strong> &#8211; file path</p>
323</td>
324</tr>
325<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Data1D object if a single SASentry was found,
326or a list of Data1D objects if multiple entries were found,
327or None of nothing was found</p>
328</td>
329</tr>
330<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
331<li><strong>RuntimeError</strong> &#8211; when the file can&#8217;t be opened</li>
332<li><strong>ValueError</strong> &#8211; when the length of the data vectors are inconsistent</li>
333</ul>
334</td>
335</tr>
336</tbody>
337</table>
338</dd></dl>
339
340<dl class="method">
341<dt id="sans.perspectives.fitting.pagestate.Reader._store_content">
342<tt class="descname">_store_content</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader._store_content" title="Permalink to this definition">¶</a></dt>
343<dd><p>Get the content of a xpath location and store
344the result. The value is treated as a string.</p>
345<p>The xpath location might or might not exist.
346If it does not exist, nothing is done</p>
347<table class="docutils field-list" frame="void" rules="none">
348<col class="field-name" />
349<col class="field-body" />
350<tbody valign="top">
351<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
352<li><strong>location</strong> &#8211; xpath location to fetch</li>
353<li><strong>node</strong> &#8211; node to read the data from</li>
354<li><strong>variable</strong> &#8211; name of the data member to store it in [string]</li>
355<li><strong>storage</strong> &#8211; data object that has the &#8216;variable&#8217; data member</li>
356</ul>
357</td>
358</tr>
359<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">return a list of errors</p>
360</td>
361</tr>
362</tbody>
363</table>
364</dd></dl>
365
366<dl class="method">
367<dt id="sans.perspectives.fitting.pagestate.Reader._store_float">
368<tt class="descname">_store_float</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader._store_float" title="Permalink to this definition">¶</a></dt>
369<dd><p>Get the content of a xpath location and store
370the result. Check that the units are compatible
371with the destination. The value is expected to
372be a float.</p>
373<p>The xpath location might or might not exist.
374If it does not exist, nothing is done</p>
375<table class="docutils field-list" frame="void" rules="none">
376<col class="field-name" />
377<col class="field-body" />
378<tbody valign="top">
379<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
380<li><strong>location</strong> &#8211; xpath location to fetch</li>
381<li><strong>node</strong> &#8211; node to read the data from</li>
382<li><strong>variable</strong> &#8211; name of the data member to store it in [string]</li>
383<li><strong>storage</strong> &#8211; data object that has the &#8216;variable&#8217; data member</li>
384<li><strong>optional</strong> &#8211; if True, no exception will be raised
385if unit conversion can&#8217;t be done</li>
386</ul>
387</td>
388</tr>
389<tr class="field-even field"><th class="field-name" colspan="2">Raises ValueError:</th></tr>
390<tr class="field-even field"><td>&nbsp;</td><td class="field-body"><p class="first last">raised when the units are not recognized</p>
391</td>
392</tr>
393</tbody>
394</table>
395</dd></dl>
396
397<dl class="method">
398<dt id="sans.perspectives.fitting.pagestate.Reader._to_xml_doc">
399<tt class="descname">_to_xml_doc</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader._to_xml_doc" title="Permalink to this definition">¶</a></dt>
400<dd><p>Create an XML document to contain the content of a Data1D</p>
401<table class="docutils field-list" frame="void" rules="none">
402<col class="field-name" />
403<col class="field-body" />
404<tbody valign="top">
405<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>datainfo</strong> &#8211; Data1D object</td>
406</tr>
407</tbody>
408</table>
409</dd></dl>
410
411<dl class="attribute">
412<dt id="sans.perspectives.fitting.pagestate.Reader.ext">
413<tt class="descname">ext</tt><em class="property"> = ['.fitv', '.FITV', '.svs', 'SVS']</em><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader.ext" title="Permalink to this definition">¶</a></dt>
414<dd></dd></dl>
415
416<dl class="method">
417<dt id="sans.perspectives.fitting.pagestate.Reader.get_state">
418<tt class="descname">get_state</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader.get_state" title="Permalink to this definition">¶</a></dt>
419<dd></dd></dl>
420
421<dl class="method">
422<dt id="sans.perspectives.fitting.pagestate.Reader.read">
423<tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader.read" title="Permalink to this definition">¶</a></dt>
424<dd><p>Load a new P(r) inversion state from file</p>
425<table class="docutils field-list" frame="void" rules="none">
426<col class="field-name" />
427<col class="field-body" />
428<tbody valign="top">
429<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> &#8211; file path</td>
430</tr>
431</tbody>
432</table>
433</dd></dl>
434
435<dl class="attribute">
436<dt id="sans.perspectives.fitting.pagestate.Reader.type">
437<tt class="descname">type</tt><em class="property"> = ['Fitting files (*.fitv)|*.fitvSANSView file (*.svs)|*.svs']</em><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader.type" title="Permalink to this definition">¶</a></dt>
438<dd></dd></dl>
439
440<dl class="attribute">
441<dt id="sans.perspectives.fitting.pagestate.Reader.type_name">
442<tt class="descname">type_name</tt><em class="property"> = 'Fitting'</em><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader.type_name" title="Permalink to this definition">¶</a></dt>
443<dd></dd></dl>
444
445<dl class="attribute">
446<dt id="sans.perspectives.fitting.pagestate.Reader.version">
447<tt class="descname">version</tt><em class="property"> = '1.0'</em><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader.version" title="Permalink to this definition">¶</a></dt>
448<dd></dd></dl>
449
450<dl class="method">
451<dt id="sans.perspectives.fitting.pagestate.Reader.write">
452<tt class="descname">write</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader.write" title="Permalink to this definition">¶</a></dt>
453<dd><p>Write the content of a Data1D as a CanSAS XML file only for standalone</p>
454<table class="docutils field-list" frame="void" rules="none">
455<col class="field-name" />
456<col class="field-body" />
457<tbody valign="top">
458<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
459<li><strong>filename</strong> &#8211; name of the file to write</li>
460<li><strong>datainfo</strong> &#8211; Data1D object</li>
461<li><strong>fitstate</strong> &#8211; PageState object</li>
462</ul>
463</td>
464</tr>
465</tbody>
466</table>
467</dd></dl>
468
469<dl class="method">
470<dt id="sans.perspectives.fitting.pagestate.Reader.write_toXML">
471<tt class="descname">write_toXML</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader.write_toXML" title="Permalink to this definition">¶</a></dt>
472<dd><p>Write toXML, a helper for write() , could be used by guimanager._on_save()</p>
473<p>: return: xml doc</p>
474</dd></dl>
475
476</dd></dl>
477
478<dl class="function">
479<dt id="sans.perspectives.fitting.pagestate.parse_entry_helper">
480<tt class="descclassname">sans.perspectives.fitting.pagestate.</tt><tt class="descname">parse_entry_helper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.parse_entry_helper" title="Permalink to this definition">¶</a></dt>
481<dd><p>Create a numpy list from value extrated from the node</p>
482<table class="docutils field-list" frame="void" rules="none">
483<col class="field-name" />
484<col class="field-body" />
485<tbody valign="top">
486<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
487<li><strong>node</strong> &#8211; node from each the value is stored</li>
488<li><strong>item</strong> &#8211; list name of three strings.the two first are name of data
489attribute and the third one is the type of the value of that
490attribute. type can be string, float, bool, etc.</li>
491</ul>
492</td>
493</tr>
494</tbody>
495</table>
496<p>: return: numpy array</p>
497</dd></dl>
498
499</div>
500</div>
501
502
503          </div>
504        </div>
505      </div>
506      <div class="sphinxsidebar">
507        <div class="sphinxsidebarwrapper">
508  <h3><a href="../../../index.html">Table Of Contents</a></h3>
509  <ul>
510<li><a class="reference internal" href="#">pagestate</a><ul>
511<li><a class="reference internal" href="#sans-perspectives-fitting-pagestate"><tt class="docutils literal"><span class="pre">sans.perspectives.fitting.pagestate</span></tt></a></li>
512</ul>
513</li>
514</ul>
515
516  <h4>Previous topic</h4>
517  <p class="topless"><a href="model_thread.html"
518                        title="previous chapter">model_thread</a></p>
519  <h4>Next topic</h4>
520  <p class="topless"><a href="report_dialog.html"
521                        title="next chapter">report_dialog</a></p>
522  <h3>This Page</h3>
523  <ul class="this-page-menu">
524    <li><a href="../../../_sources/api/perspectives/fitting/pagestate.txt"
525           rel="nofollow">Show Source</a></li>
526  </ul>
527<div id="searchbox" style="display: none">
528  <h3>Quick search</h3>
529    <form class="search" action="../../../search.html" method="get">
530      <input type="text" name="q" />
531      <input type="submit" value="Go" />
532      <input type="hidden" name="check_keywords" value="yes" />
533      <input type="hidden" name="area" value="default" />
534    </form>
535    <p class="searchtip" style="font-size: 90%">
536    Enter search terms or a module, class or function name.
537    </p>
538</div>
539<script type="text/javascript">$('#searchbox').show(0);</script>
540        </div>
541      </div>
542      <div class="clearer"></div>
543    </div>
544    <div class="related">
545      <h3>Navigation</h3>
546      <ul>
547        <li class="right" style="margin-right: 10px">
548          <a href="../../../genindex.html" title="General Index"
549             >index</a></li>
550        <li class="right" >
551          <a href="../../../py-modindex.html" title="Python Module Index"
552             >modules</a> |</li>
553        <li class="right" >
554          <a href="report_dialog.html" title="report_dialog"
555             >next</a> |</li>
556        <li class="right" >
557          <a href="model_thread.html" title="model_thread"
558             >previous</a> |</li>
559        <li><a href="../../../index.html">sansview 0.1.0 documentation</a> &raquo;</li>
560          <li><a href="index.html" >Reference</a> &raquo;</li> 
561      </ul>
562    </div>
563    <div class="footer">
564        &copy; Copyright 2010, sans group.
565      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
566    </div>
567  </body>
568</html>
Note: See TracBrowser for help on using the repository browser.