source: sasview/sansview/docs/sphinx/_build/html/api/perspectives/fitting/pagestate.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: 10.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"><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>Create a new copy of the current object</dd></dl>
69
70<dl class="method">
71<dt id="sans.perspectives.fitting.pagestate.PageState.fromXML">
72<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>
73<dd><p>Load fitting state from a file</p>
74<table class="docutils field-list" frame="void" rules="none">
75<col class="field-name" />
76<col class="field-body" />
77<tbody valign="top">
78<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
79<li><strong>file</strong> &#8211; .fitv file</li>
80<li><strong>node</strong> &#8211; node of a XML document to read from</li>
81</ul>
82</td>
83</tr>
84</tbody>
85</table>
86</dd></dl>
87
88<dl class="method">
89<dt id="sans.perspectives.fitting.pagestate.PageState.toXML">
90<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>
91<dd><p>Writes the state of the InversionControl panel to file, as XML.</p>
92<p>Compatible with standalone writing, or appending to an
93already existing XML document. In that case, the XML document
94is required. An optional entry node in the XML document may also be given.</p>
95<table class="docutils field-list" frame="void" rules="none">
96<col class="field-name" />
97<col class="field-body" />
98<tbody valign="top">
99<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
100<li><strong>file</strong> &#8211; file to write to</li>
101<li><strong>doc</strong> &#8211; XML document object [optional]</li>
102<li><strong>entry_node</strong> &#8211; XML node within the XML document at which we will append the data [optional]</li>
103</ul>
104</td>
105</tr>
106</tbody>
107</table>
108</dd></dl>
109
110</dd></dl>
111
112<dl class="class">
113<dt id="sans.perspectives.fitting.pagestate.Reader">
114<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>
115<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">DataLoader.readers.cansas_reader.Reader</span></tt></p>
116<p>Class to load a .fitv fitting file</p>
117<dl class="method">
118<dt id="sans.perspectives.fitting.pagestate.Reader.read">
119<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>
120<dd><p>Load a new P(r) inversion state from file</p>
121<table class="docutils field-list" frame="void" rules="none">
122<col class="field-name" />
123<col class="field-body" />
124<tbody valign="top">
125<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
126<li><strong>path</strong> &#8211; file path</li>
127</ul>
128</td>
129</tr>
130</tbody>
131</table>
132</dd></dl>
133
134<dl class="method">
135<dt id="sans.perspectives.fitting.pagestate.Reader.write">
136<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>
137<dd><p>Write the content of a Data1D as a CanSAS XML file</p>
138<table class="docutils field-list" frame="void" rules="none">
139<col class="field-name" />
140<col class="field-body" />
141<tbody valign="top">
142<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
143<li><strong>filename</strong> &#8211; name of the file to write</li>
144<li><strong>datainfo</strong> &#8211; Data1D object</li>
145<li><strong>fitstate</strong> &#8211; PageState object</li>
146</ul>
147</td>
148</tr>
149</tbody>
150</table>
151</dd></dl>
152
153</dd></dl>
154
155</div>
156</div>
157
158
159          </div>
160        </div>
161      </div>
162      <div class="sphinxsidebar">
163        <div class="sphinxsidebarwrapper">
164  <h3><a href="../../../index.html">Table Of Contents</a></h3>
165  <ul>
166<li><a class="reference internal" href="#">pagestate</a><ul>
167<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>
168</ul>
169</li>
170</ul>
171
172  <h4>Previous topic</h4>
173  <p class="topless"><a href="models.html"
174                        title="previous chapter">models</a></p>
175  <h4>Next topic</h4>
176  <p class="topless"><a href="simfitpage.html"
177                        title="next chapter">simfitpage</a></p>
178  <h3>This Page</h3>
179  <ul class="this-page-menu">
180    <li><a href="../../../_sources/api/perspectives/fitting/pagestate.txt"
181           rel="nofollow">Show Source</a></li>
182  </ul>
183<div id="searchbox" style="display: none">
184  <h3>Quick search</h3>
185    <form class="search" action="../../../search.html" method="get">
186      <input type="text" name="q" size="18" />
187      <input type="submit" value="Go" />
188      <input type="hidden" name="check_keywords" value="yes" />
189      <input type="hidden" name="area" value="default" />
190    </form>
191    <p class="searchtip" style="font-size: 90%">
192    Enter search terms or a module, class or function name.
193    </p>
194</div>
195<script type="text/javascript">$('#searchbox').show(0);</script>
196        </div>
197      </div>
198      <div class="clearer"></div>
199    </div>
200    <div class="related">
201      <h3>Navigation</h3>
202      <ul>
203        <li class="right" style="margin-right: 10px">
204          <a href="../../../genindex.html" title="General Index"
205             >index</a></li>
206        <li class="right" >
207          <a href="../../../py-modindex.html" title="Python Module Index"
208             >modules</a> |</li>
209        <li class="right" >
210          <a href="simfitpage.html" title="simfitpage"
211             >next</a> |</li>
212        <li class="right" >
213          <a href="models.html" title="models"
214             >previous</a> |</li>
215        <li><a href="../../../index.html">sansview v0.1.0 documentation</a> &raquo;</li>
216          <li><a href="index.html" >Reference</a> &raquo;</li> 
217      </ul>
218    </div>
219    <div class="footer">
220        &copy; Copyright 2010, sans group.
221      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
222    </div>
223  </body>
224</html>
Note: See TracBrowser for help on using the repository browser.