source: sasview/fittingview/docs/sphinx/html/api/perspectives/fitting/pagestate.html @ 5a9a98f

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 5a9a98f was 5a9a98f, checked in by Jessica Tumarkin <jtumarki@…>, 13 years ago

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 13.0 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>pagestate &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="simfitpage" href="simfitpage.html" />
28    <link rel="prev" title="models" href="models.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="simfitpage.html" title="simfitpage"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="models.html" title="models"
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="pagestate">
57<h1>pagestate<a class="headerlink" href="#pagestate" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.perspectives.fitting.pagestate">
59<span id="sans-perspectives-fitting-pagestate"></span><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="#module-sans.perspectives.fitting.pagestate" title="Permalink to this headline">¶</a></h2>
60<dl class="class">
61<dt id="sans.perspectives.fitting.pagestate.PageState">
62<em class="property">class </em><tt class="descclassname">sans.perspectives.fitting.pagestate.</tt><tt class="descname">PageState</tt><big>(</big><em>parent=None</em>, <em>model=None</em>, <em>data=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState" title="Permalink to this definition">¶</a></dt>
63<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
64<p>Contains information to reconstruct a page of the fitpanel.</p>
65<dl class="method">
66<dt id="sans.perspectives.fitting.pagestate.PageState.clone">
67<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>
68<dd><p>Create a new copy of the current object</p>
69</dd></dl>
70
71<dl class="method">
72<dt id="sans.perspectives.fitting.pagestate.PageState.fromXML">
73<tt class="descname">fromXML</tt><big>(</big><em>file=None</em>, <em>node=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.fromXML" title="Permalink to this definition">¶</a></dt>
74<dd><p>Load fitting state from a file</p>
75<table class="docutils field-list" frame="void" rules="none">
76<col class="field-name" />
77<col class="field-body" />
78<tbody valign="top">
79<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
80<li><strong>file</strong> &#8211; .fitv file</li>
81<li><strong>node</strong> &#8211; node of a XML document to read from</li>
82</ul>
83</td>
84</tr>
85</tbody>
86</table>
87</dd></dl>
88
89<dl class="method">
90<dt id="sans.perspectives.fitting.pagestate.PageState.report">
91<tt class="descname">report</tt><big>(</big><em>figs=None</em>, <em>canvases=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.report" title="Permalink to this definition">¶</a></dt>
92<dd><p>Invoke report dialog panel</p>
93<p>: param figs: list of pylab figures [list]</p>
94</dd></dl>
95
96<dl class="method">
97<dt id="sans.perspectives.fitting.pagestate.PageState.set_plot_state">
98<tt class="descname">set_plot_state</tt><big>(</big><em>figs</em>, <em>canvases</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.set_plot_state" title="Permalink to this definition">¶</a></dt>
99<dd><p>Build image state that wx.html understand
100by plotting, putting it into wx.FileSystem image object</p>
101</dd></dl>
102
103<dl class="method">
104<dt id="sans.perspectives.fitting.pagestate.PageState.set_report_string">
105<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>
106<dd><p>Get the values (strings) from __str__ for report</p>
107</dd></dl>
108
109<dl class="method">
110<dt id="sans.perspectives.fitting.pagestate.PageState.toXML">
111<tt class="descname">toXML</tt><big>(</big><em>file='fitting_state.fitv'</em>, <em>doc=None</em>, <em>entry_node=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.PageState.toXML" title="Permalink to this definition">¶</a></dt>
112<dd><p>Writes the state of the InversionControl panel to file, as XML.</p>
113<p>Compatible with standalone writing, or appending to an
114already existing XML document. In that case, the XML document
115is required. An optional entry node in the XML document may also be given.</p>
116<table class="docutils field-list" frame="void" rules="none">
117<col class="field-name" />
118<col class="field-body" />
119<tbody valign="top">
120<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
121<li><strong>file</strong> &#8211; file to write to</li>
122<li><strong>doc</strong> &#8211; XML document object [optional]</li>
123<li><strong>entry_node</strong> &#8211; XML node within the XML document at which we will append the data [optional]</li>
124</ul>
125</td>
126</tr>
127</tbody>
128</table>
129</dd></dl>
130
131</dd></dl>
132
133<dl class="class">
134<dt id="sans.perspectives.fitting.pagestate.Reader">
135<em class="property">class </em><tt class="descclassname">sans.perspectives.fitting.pagestate.</tt><tt class="descname">Reader</tt><big>(</big><em>call_back=None</em>, <em>cansas=True</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader" title="Permalink to this definition">¶</a></dt>
136<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.readers.cansas_reader.Reader</span></tt></p>
137<p>Class to load a .fitv fitting file</p>
138<dl class="method">
139<dt id="sans.perspectives.fitting.pagestate.Reader.get_state">
140<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>
141<dd></dd></dl>
142
143<dl class="method">
144<dt id="sans.perspectives.fitting.pagestate.Reader.read">
145<tt class="descname">read</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader.read" title="Permalink to this definition">¶</a></dt>
146<dd><p>Load a new P(r) inversion state from file</p>
147<table class="docutils field-list" frame="void" rules="none">
148<col class="field-name" />
149<col class="field-body" />
150<tbody valign="top">
151<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> &#8211; file path</td>
152</tr>
153</tbody>
154</table>
155</dd></dl>
156
157<dl class="method">
158<dt id="sans.perspectives.fitting.pagestate.Reader.write">
159<tt class="descname">write</tt><big>(</big><em>filename</em>, <em>datainfo=None</em>, <em>fitstate=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader.write" title="Permalink to this definition">¶</a></dt>
160<dd><p>Write the content of a Data1D as a CanSAS XML file only for standalone</p>
161<table class="docutils field-list" frame="void" rules="none">
162<col class="field-name" />
163<col class="field-body" />
164<tbody valign="top">
165<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
166<li><strong>filename</strong> &#8211; name of the file to write</li>
167<li><strong>datainfo</strong> &#8211; Data1D object</li>
168<li><strong>fitstate</strong> &#8211; PageState object</li>
169</ul>
170</td>
171</tr>
172</tbody>
173</table>
174</dd></dl>
175
176<dl class="method">
177<dt id="sans.perspectives.fitting.pagestate.Reader.write_toXML">
178<tt class="descname">write_toXML</tt><big>(</big><em>datainfo=None</em>, <em>state=None</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.Reader.write_toXML" title="Permalink to this definition">¶</a></dt>
179<dd><p>Write toXML, a helper for write() , could be used by guimanager._on_save()</p>
180<p>: return: xml doc</p>
181</dd></dl>
182
183</dd></dl>
184
185<dl class="function">
186<dt id="sans.perspectives.fitting.pagestate.parse_entry_helper">
187<tt class="descclassname">sans.perspectives.fitting.pagestate.</tt><tt class="descname">parse_entry_helper</tt><big>(</big><em>node</em>, <em>item</em><big>)</big><a class="headerlink" href="#sans.perspectives.fitting.pagestate.parse_entry_helper" title="Permalink to this definition">¶</a></dt>
188<dd><p>Create a numpy list from value extrated from the node</p>
189<table class="docutils field-list" frame="void" rules="none">
190<col class="field-name" />
191<col class="field-body" />
192<tbody valign="top">
193<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
194<li><strong>node</strong> &#8211; node from each the value is stored</li>
195<li><strong>item</strong> &#8211; list name of three strings.the two first are name of data
196attribute and the third one is the type of the value of that
197attribute. type can be string, float, bool, etc.</li>
198</ul>
199</td>
200</tr>
201</tbody>
202</table>
203<p>: return: numpy array</p>
204</dd></dl>
205
206</div>
207</div>
208
209
210          </div>
211        </div>
212      </div>
213      <div class="sphinxsidebar">
214        <div class="sphinxsidebarwrapper">
215  <h3><a href="../../../index.html">Table Of Contents</a></h3>
216  <ul>
217<li><a class="reference internal" href="#">pagestate</a><ul>
218<li><a class="reference internal" href="#module-sans.perspectives.fitting.pagestate"><tt class="docutils literal"><span class="pre">sans.perspectives.fitting.pagestate</span></tt></a></li>
219</ul>
220</li>
221</ul>
222
223  <h4>Previous topic</h4>
224  <p class="topless"><a href="models.html"
225                        title="previous chapter">models</a></p>
226  <h4>Next topic</h4>
227  <p class="topless"><a href="simfitpage.html"
228                        title="next chapter">simfitpage</a></p>
229  <h3>This Page</h3>
230  <ul class="this-page-menu">
231    <li><a href="../../../_sources/api/perspectives/fitting/pagestate.txt"
232           rel="nofollow">Show Source</a></li>
233  </ul>
234<div id="searchbox" style="display: none">
235  <h3>Quick search</h3>
236    <form class="search" action="../../../search.html" method="get">
237      <input type="text" name="q" size="18" />
238      <input type="submit" value="Go" />
239      <input type="hidden" name="check_keywords" value="yes" />
240      <input type="hidden" name="area" value="default" />
241    </form>
242    <p class="searchtip" style="font-size: 90%">
243    Enter search terms or a module, class or function name.
244    </p>
245</div>
246<script type="text/javascript">$('#searchbox').show(0);</script>
247        </div>
248      </div>
249      <div class="clearer"></div>
250    </div>
251    <div class="related">
252      <h3>Navigation</h3>
253      <ul>
254        <li class="right" style="margin-right: 10px">
255          <a href="../../../genindex.html" title="General Index"
256             >index</a></li>
257        <li class="right" >
258          <a href="../../../py-modindex.html" title="Python Module Index"
259             >modules</a> |</li>
260        <li class="right" >
261          <a href="simfitpage.html" title="simfitpage"
262             >next</a> |</li>
263        <li class="right" >
264          <a href="models.html" title="models"
265             >previous</a> |</li>
266        <li><a href="../../../index.html">sansview v0.1.0 documentation</a> &raquo;</li>
267          <li><a href="index.html" >Reference</a> &raquo;</li> 
268      </ul>
269    </div>
270    <div class="footer">
271        &copy; Copyright 2010, sans group.
272      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
273    </div>
274  </body>
275</html>
Note: See TracBrowser for help on using the repository browser.