source: sasview/sansmodels/docs/sphinx/html/api/ModelIO.html @ 017e0390

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 017e0390 was 512573a, checked in by Jessica Tumarkin <jtumarki@…>, 13 years ago

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 8.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>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" 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="#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><p>Load a model from a file
75&#64;param file: file to load
76&#64;return: a new BaseComponent</p>
77</dd></dl>
78
79<dl class="method">
80<dt id="sans.models.ModelIO.ModelIO.lookupComponentNodes">
81<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>
82<dd><p>Look up a component node among the children of a node
83&#64;param node: the minidom node to investigate
84&#64;return: the model object described by the component node, None otherwise</p>
85</dd></dl>
86
87<dl class="method">
88<dt id="sans.models.ModelIO.ModelIO.modelToXML">
89<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>
90<dd><p>Saves XML representation of the component
91&#64;param model: model to save
92&#64;param file: name of file to write to (if None, a string is returned)</p>
93</dd></dl>
94
95<dl class="method">
96<dt id="sans.models.ModelIO.ModelIO.processComponentNode">
97<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>
98<dd><p>Process an XML &#8216;Component&#8217; node in a model file
99&#64;param node: XML minidom node to process
100&#64;param model: model object to build from</p>
101</dd></dl>
102
103<dl class="method">
104<dt id="sans.models.ModelIO.ModelIO.save">
105<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>
106<dd><p>Save the XML representation of a model to a file
107&#64;param model: XML representation of the model
108&#64;param filename: the path of the file to write to
109&#64;return: True if everything went well</p>
110</dd></dl>
111
112</dd></dl>
113
114</div>
115</div>
116
117
118          </div>
119        </div>
120      </div>
121      <div class="sphinxsidebar">
122        <div class="sphinxsidebarwrapper">
123  <h3><a href="../index.html">Table Of Contents</a></h3>
124  <ul>
125<li><a class="reference internal" href="#">ModelIO</a><ul>
126<li><a class="reference internal" href="#module-sans.models.ModelIO"><tt class="docutils literal"><span class="pre">sans.models.ModelIO</span></tt></a></li>
127</ul>
128</li>
129</ul>
130
131  <h4>Previous topic</h4>
132  <p class="topless"><a href="ModelFactory.html"
133                        title="previous chapter">ModelFactory</a></p>
134  <h4>Next topic</h4>
135  <p class="topless"><a href="MulComponent.html"
136                        title="next chapter">MulComponent</a></p>
137  <h3>This Page</h3>
138  <ul class="this-page-menu">
139    <li><a href="../_sources/api/ModelIO.txt"
140           rel="nofollow">Show Source</a></li>
141  </ul>
142<div id="searchbox" style="display: none">
143  <h3>Quick search</h3>
144    <form class="search" action="../search.html" method="get">
145      <input type="text" name="q" size="18" />
146      <input type="submit" value="Go" />
147      <input type="hidden" name="check_keywords" value="yes" />
148      <input type="hidden" name="area" value="default" />
149    </form>
150    <p class="searchtip" style="font-size: 90%">
151    Enter search terms or a module, class or function name.
152    </p>
153</div>
154<script type="text/javascript">$('#searchbox').show(0);</script>
155        </div>
156      </div>
157      <div class="clearer"></div>
158    </div>
159    <div class="related">
160      <h3>Navigation</h3>
161      <ul>
162        <li class="right" style="margin-right: 10px">
163          <a href="../genindex.html" title="General Index"
164             >index</a></li>
165        <li class="right" >
166          <a href="../py-modindex.html" title="Python Module Index"
167             >modules</a> |</li>
168        <li class="right" >
169          <a href="MulComponent.html" title="MulComponent"
170             >next</a> |</li>
171        <li class="right" >
172          <a href="ModelFactory.html" title="ModelFactory"
173             >previous</a> |</li>
174        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
175          <li><a href="index.html" >Reference</a> &raquo;</li> 
176      </ul>
177    </div>
178    <div class="footer">
179        &copy; Copyright 2010, sans group.
180      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
181    </div>
182  </body>
183</html>
Note: See TracBrowser for help on using the repository browser.