source: sasview/sansmodels/docs/sphinx/_build/html/api/ModelIO.html @ b94945d

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 b94945d was 79ac6f8, checked in by Gervaise Alina <gervyh@…>, 14 years ago

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