source: sasview/sansmodels/docs/sphinx/_build/html/api/BaseModel.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: 10.7 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>BaseModel &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="BEPolyelectrolyte" href="BEPolyelectrolyte.html" />
28    <link rel="prev" title="BaseComponent" href="BaseComponent.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="BEPolyelectrolyte.html" title="BEPolyelectrolyte"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="BaseComponent.html" title="BaseComponent"
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="basemodel">
57<h1>BaseModel<a class="headerlink" href="#basemodel" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.BaseModel">
59<span id="sans-models-basemodel"></span><h2><a class="reference internal" href="#module-sans.models.BaseModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.BaseModel</span></tt></a><a class="headerlink" href="#module-sans.models.BaseModel" title="Permalink to this headline">¶</a></h2>
60<p>Provide base functionality for all model components</p>
61<p>The following has changed since going from BaseComponent to BaseModel:</p>
62<blockquote>
63<ul class="simple">
64<li>Arithmetic operation between models is no longer supported.
65It was found to be of little use and not very flexible.</li>
66<li>Parameters are now stored as Parameter object to provide
67the necessary extra information like limits, units, etc...</li>
68</ul>
69</blockquote>
70<dl class="class">
71<dt id="sans.models.BaseModel.BaseModel">
72<em class="property">class </em><tt class="descclassname">sans.models.BaseModel.</tt><tt class="descname">BaseModel</tt><a class="headerlink" href="#sans.models.BaseModel.BaseModel" title="Permalink to this definition">¶</a></dt>
73<dd><p>Bases: <a class="reference internal" href="ModelAdaptor.html#sans.models.ModelAdaptor.ModelAdaptor" title="sans.models.ModelAdaptor.ModelAdaptor"><tt class="xref py py-class docutils literal"><span class="pre">sans.models.ModelAdaptor.ModelAdaptor</span></tt></a></p>
74<p>Basic model component</p>
75<dl class="method">
76<dt id="sans.models.BaseModel.BaseModel.calculate_ER">
77<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.calculate_ER" title="Permalink to this definition">¶</a></dt>
78<dd></dd></dl>
79
80<dl class="method">
81<dt id="sans.models.BaseModel.BaseModel.clone">
82<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.clone" title="Permalink to this definition">¶</a></dt>
83<dd>Returns a new object identical to the current object</dd></dl>
84
85<dl class="method">
86<dt id="sans.models.BaseModel.BaseModel.getParam">
87<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.getParam" title="Permalink to this definition">¶</a></dt>
88<dd><p>Set the value of a model parameter</p>
89<table class="docutils field-list" frame="void" rules="none">
90<col class="field-name" />
91<col class="field-body" />
92<tbody valign="top">
93<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
94<li><strong>name</strong> &#8211; name of the parameter</li>
95<li><strong>value</strong> &#8211; value of the parameter</li>
96</ul>
97</td>
98</tr>
99</tbody>
100</table>
101</dd></dl>
102
103<dl class="method">
104<dt id="sans.models.BaseModel.BaseModel.getParamList">
105<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.getParamList" title="Permalink to this definition">¶</a></dt>
106<dd>Return a list of all available parameters for the model</dd></dl>
107
108<dl class="method">
109<dt id="sans.models.BaseModel.BaseModel.getParamListWithToken">
110<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
111<dd></dd></dl>
112
113<dl class="method">
114<dt id="sans.models.BaseModel.BaseModel.getParamWithToken">
115<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
116<dd></dd></dl>
117
118<dl class="method">
119<dt id="sans.models.BaseModel.BaseModel.run">
120<tt class="descname">run</tt><big>(</big><em>x=0</em><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.run" title="Permalink to this definition">¶</a></dt>
121<dd></dd></dl>
122
123<dl class="method">
124<dt id="sans.models.BaseModel.BaseModel.runXY">
125<tt class="descname">runXY</tt><big>(</big><em>x=0</em><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.runXY" title="Permalink to this definition">¶</a></dt>
126<dd></dd></dl>
127
128<dl class="method">
129<dt id="sans.models.BaseModel.BaseModel.setParam">
130<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.setParam" title="Permalink to this definition">¶</a></dt>
131<dd><p>Set the value of a model parameter</p>
132<table class="docutils field-list" frame="void" rules="none">
133<col class="field-name" />
134<col class="field-body" />
135<tbody valign="top">
136<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
137<li><strong>name</strong> &#8211; name of the parameter</li>
138<li><strong>value</strong> &#8211; value of the parameter</li>
139</ul>
140</td>
141</tr>
142</tbody>
143</table>
144</dd></dl>
145
146<dl class="method">
147<dt id="sans.models.BaseModel.BaseModel.setParamWithToken">
148<tt class="descname">setParamWithToken</tt><big>(</big><em>name</em>, <em>value</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.BaseModel.BaseModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
149<dd></dd></dl>
150
151</dd></dl>
152
153<dl class="class">
154<dt id="sans.models.BaseModel.Parameter">
155<em class="property">class </em><tt class="descclassname">sans.models.BaseModel.</tt><tt class="descname">Parameter</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.BaseModel.Parameter" title="Permalink to this definition">¶</a></dt>
156<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
157<p>Parameter class</p>
158</dd></dl>
159
160<dl class="attribute">
161<dt id="sans.models.BaseModel.ParameterProperty">
162<tt class="descclassname">sans.models.BaseModel.</tt><tt class="descname">ParameterProperty</tt><a class="headerlink" href="#sans.models.BaseModel.ParameterProperty" title="Permalink to this definition">¶</a></dt>
163<dd>Parameter property allow direct access to
164the parameter values</dd></dl>
165
166</div>
167</div>
168
169
170          </div>
171        </div>
172      </div>
173      <div class="sphinxsidebar">
174        <div class="sphinxsidebarwrapper">
175  <h3><a href="../index.html">Table Of Contents</a></h3>
176  <ul>
177<li><a class="reference internal" href="#">BaseModel</a><ul>
178<li><a class="reference internal" href="#module-sans.models.BaseModel"><tt class="docutils literal"><span class="pre">sans.models.BaseModel</span></tt></a></li>
179</ul>
180</li>
181</ul>
182
183  <h4>Previous topic</h4>
184  <p class="topless"><a href="BaseComponent.html"
185                        title="previous chapter">BaseComponent</a></p>
186  <h4>Next topic</h4>
187  <p class="topless"><a href="BEPolyelectrolyte.html"
188                        title="next chapter">BEPolyelectrolyte</a></p>
189  <h3>This Page</h3>
190  <ul class="this-page-menu">
191    <li><a href="../_sources/api/BaseModel.txt"
192           rel="nofollow">Show Source</a></li>
193  </ul>
194<div id="searchbox" style="display: none">
195  <h3>Quick search</h3>
196    <form class="search" action="../search.html" method="get">
197      <input type="text" name="q" size="18" />
198      <input type="submit" value="Go" />
199      <input type="hidden" name="check_keywords" value="yes" />
200      <input type="hidden" name="area" value="default" />
201    </form>
202    <p class="searchtip" style="font-size: 90%">
203    Enter search terms or a module, class or function name.
204    </p>
205</div>
206<script type="text/javascript">$('#searchbox').show(0);</script>
207        </div>
208      </div>
209      <div class="clearer"></div>
210    </div>
211    <div class="related">
212      <h3>Navigation</h3>
213      <ul>
214        <li class="right" style="margin-right: 10px">
215          <a href="../genindex.html" title="General Index"
216             >index</a></li>
217        <li class="right" >
218          <a href="../py-modindex.html" title="Python Module Index"
219             >modules</a> |</li>
220        <li class="right" >
221          <a href="BEPolyelectrolyte.html" title="BEPolyelectrolyte"
222             >next</a> |</li>
223        <li class="right" >
224          <a href="BaseComponent.html" title="BaseComponent"
225             >previous</a> |</li>
226        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
227          <li><a href="index.html" >Reference</a> &raquo;</li> 
228      </ul>
229    </div>
230    <div class="footer">
231        &copy; Copyright 2010, sans group.
232      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
233    </div>
234  </body>
235</html>
Note: See TracBrowser for help on using the repository browser.