source: sasview/sansmodels/docs/sphinx/html/api/ModelIO.html @ 325743d

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 325743d was c0d873f, checked in by Gervaise Alina <gervyh@…>, 13 years ago

edit docs for models
  • Property mode set to 100644
File size: 8.4 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>ModelIO &mdash; sansmodels 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="sansmodels 0.1.0 documentation" href="../index.html" />
29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="MulComponent" href="MulComponent.html" />
31    <link rel="prev" title="ModelFactory" href="ModelFactory.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="MulComponent.html" title="MulComponent"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="ModelFactory.html" title="ModelFactory"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../index.html">sansmodels 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="modelio">
60<h1>ModelIO<a class="headerlink" href="#modelio" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-models-modelio">
62<h2><a class="reference internal" href="#module-sans.models.ModelIO" title="sans.models.ModelIO"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.ModelIO</span></tt></a><a class="headerlink" href="#sans-models-modelio" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.models.ModelIO"></span><p>Model IO
64Class that saves and loads composite models from files
65The parameters of the models are not set. The loaded
66model object will have the default parameters for all
67sub-models.</p>
68<p>&#64;author: Mathieu Doucet / UTK
69&#64;contact: <a class="reference external" href="mailto:mathieu&#46;doucet&#37;&#52;&#48;nist&#46;gov">mathieu<span>&#46;</span>doucet<span>&#64;</span>nist<span>&#46;</span>gov</a></p>
70<dl class="class">
71<dt id="sans.models.ModelIO.ModelIO">
72<em class="property">class </em><tt class="descclassname">sans.models.ModelIO.</tt><tt class="descname">ModelIO</tt><a class="headerlink" href="#sans.models.ModelIO.ModelIO" title="Permalink to this definition">¶</a></dt>
73<dd><p>Class to create composite models from file or save a model</p>
74<dl class="method">
75<dt id="sans.models.ModelIO.ModelIO.__init__">
76<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ModelIO.ModelIO.__init__" title="Permalink to this definition">¶</a></dt>
77<dd><p>Initizalization
78&#64;param factory: ModelFactory object</p>
79</dd></dl>
80
81<dl class="attribute">
82<dt id="sans.models.ModelIO.ModelIO.__module__">
83<tt class="descname">__module__</tt><em class="property"> = 'sans.models.ModelIO'</em><a class="headerlink" href="#sans.models.ModelIO.ModelIO.__module__" title="Permalink to this definition">¶</a></dt>
84<dd></dd></dl>
85
86<dl class="method">
87<dt id="sans.models.ModelIO.ModelIO.load">
88<tt class="descname">load</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ModelIO.ModelIO.load" title="Permalink to this definition">¶</a></dt>
89<dd><p>Load a model from a file
90&#64;param file: file to load
91&#64;return: a new BaseComponent</p>
92</dd></dl>
93
94<dl class="method">
95<dt id="sans.models.ModelIO.ModelIO.lookupComponentNodes">
96<tt class="descname">lookupComponentNodes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ModelIO.ModelIO.lookupComponentNodes" title="Permalink to this definition">¶</a></dt>
97<dd><p>Look up a component node among the children of a node
98&#64;param node: the minidom node to investigate
99&#64;return: the model object described by the component node, None otherwise</p>
100</dd></dl>
101
102<dl class="method">
103<dt id="sans.models.ModelIO.ModelIO.modelToXML">
104<tt class="descname">modelToXML</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ModelIO.ModelIO.modelToXML" title="Permalink to this definition">¶</a></dt>
105<dd><p>Saves XML representation of the component
106&#64;param model: model to save
107&#64;param file: name of file to write to (if None, a string is returned)</p>
108</dd></dl>
109
110<dl class="method">
111<dt id="sans.models.ModelIO.ModelIO.processComponentNode">
112<tt class="descname">processComponentNode</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ModelIO.ModelIO.processComponentNode" title="Permalink to this definition">¶</a></dt>
113<dd><p>Process an XML &#8216;Component&#8217; node in a model file
114&#64;param node: XML minidom node to process
115&#64;param model: model object to build from</p>
116</dd></dl>
117
118<dl class="method">
119<dt id="sans.models.ModelIO.ModelIO.save">
120<tt class="descname">save</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ModelIO.ModelIO.save" title="Permalink to this definition">¶</a></dt>
121<dd><p>Save the XML representation of a model to a file
122&#64;param model: XML representation of the model
123&#64;param filename: the path of the file to write to
124&#64;return: True if everything went well</p>
125</dd></dl>
126
127</dd></dl>
128
129</div>
130</div>
131
132
133          </div>
134        </div>
135      </div>
136      <div class="sphinxsidebar">
137        <div class="sphinxsidebarwrapper">
138  <h3><a href="../index.html">Table Of Contents</a></h3>
139  <ul>
140<li><a class="reference internal" href="#">ModelIO</a><ul>
141<li><a class="reference internal" href="#sans-models-modelio"><tt class="docutils literal"><span class="pre">sans.models.ModelIO</span></tt></a></li>
142</ul>
143</li>
144</ul>
145
146  <h4>Previous topic</h4>
147  <p class="topless"><a href="ModelFactory.html"
148                        title="previous chapter">ModelFactory</a></p>
149  <h4>Next topic</h4>
150  <p class="topless"><a href="MulComponent.html"
151                        title="next chapter">MulComponent</a></p>
152  <h3>This Page</h3>
153  <ul class="this-page-menu">
154    <li><a href="../_sources/api/ModelIO.txt"
155           rel="nofollow">Show Source</a></li>
156  </ul>
157<div id="searchbox" style="display: none">
158  <h3>Quick search</h3>
159    <form class="search" action="../search.html" method="get">
160      <input type="text" name="q" />
161      <input type="submit" value="Go" />
162      <input type="hidden" name="check_keywords" value="yes" />
163      <input type="hidden" name="area" value="default" />
164    </form>
165    <p class="searchtip" style="font-size: 90%">
166    Enter search terms or a module, class or function name.
167    </p>
168</div>
169<script type="text/javascript">$('#searchbox').show(0);</script>
170        </div>
171      </div>
172      <div class="clearer"></div>
173    </div>
174    <div class="related">
175      <h3>Navigation</h3>
176      <ul>
177        <li class="right" style="margin-right: 10px">
178          <a href="../genindex.html" title="General Index"
179             >index</a></li>
180        <li class="right" >
181          <a href="../py-modindex.html" title="Python Module Index"
182             >modules</a> |</li>
183        <li class="right" >
184          <a href="MulComponent.html" title="MulComponent"
185             >next</a> |</li>
186        <li class="right" >
187          <a href="ModelFactory.html" title="ModelFactory"
188             >previous</a> |</li>
189        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
190          <li><a href="index.html" >Reference</a> &raquo;</li> 
191      </ul>
192    </div>
193    <div class="footer">
194        &copy; Copyright 2010, sans group.
195      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
196    </div>
197  </body>
198</html>
Note: See TracBrowser for help on using the repository browser.