source: sasview/sansmodels/docs/sphinx/html/api/LineModel.html @ dcbd084f

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

edit docs for models
  • Property mode set to 100644
File size: 11.5 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>LineModel &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="LogNormal" href="LogNormal.html" />
31    <link rel="prev" title="LamellarPSModel" href="LamellarPSModel.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="LogNormal.html" title="LogNormal"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="LamellarPSModel.html" title="LamellarPSModel"
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="linemodel">
60<h1>LineModel<a class="headerlink" href="#linemodel" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-models-linemodel">
62<h2><a class="reference internal" href="#module-sans.models.LineModel" title="sans.models.LineModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.LineModel</span></tt></a><a class="headerlink" href="#sans-models-linemodel" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.models.LineModel"></span><p>Provide Line function (y= A + Bx) as a BaseComponent model</p>
64<dl class="class">
65<dt id="sans.models.LineModel.LineModel">
66<em class="property">class </em><tt class="descclassname">sans.models.LineModel.</tt><tt class="descname">LineModel</tt><a class="headerlink" href="#sans.models.LineModel.LineModel" title="Permalink to this definition">¶</a></dt>
67<dd><p>Bases: <a class="reference internal" href="BaseComponent.html#sans.models.BaseComponent.BaseComponent" title="sans.models.BaseComponent.BaseComponent"><tt class="xref py py-class docutils literal"><span class="pre">sans.models.BaseComponent.BaseComponent</span></tt></a></p>
68<p>Class that evaluates a linear model.</p>
69<p>f(x) = A + Bx</p>
70<dl class="docutils">
71<dt>List of default parameters:</dt>
72<dd>A = 1.0
73B = 1.0</dd>
74</dl>
75<dl class="method">
76<dt id="sans.models.LineModel.LineModel.calculate_ER">
77<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LineModel.LineModel.calculate_ER" title="Permalink to this definition">¶</a></dt>
78<dd></dd></dl>
79
80<dl class="method">
81<dt id="sans.models.LineModel.LineModel.clone">
82<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LineModel.LineModel.clone" title="Permalink to this definition">¶</a></dt>
83<dd><p>Returns a new object identical to the current object</p>
84</dd></dl>
85
86<dl class="method">
87<dt id="sans.models.LineModel.LineModel.evalDistribution">
88<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LineModel.LineModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
89<dd><p>Evaluate a distribution of q-values.</p>
90<ul>
91<li><p class="first">For 1D, a numpy array is expected as input:</p>
92<blockquote>
93<div><p>evalDistribution(q)</p>
94</div></blockquote>
95</li>
96</ul>
97<p>where q is a numpy array.</p>
98<ul class="simple">
99<li>For 2D, a list of numpy arrays are expected: [qx_prime,qy_prime],
100where 1D arrays,</li>
101</ul>
102<table class="docutils field-list" frame="void" rules="none">
103<col class="field-name" />
104<col class="field-body" />
105<tbody valign="top">
106<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>qdist</strong> &#8211; ndarray of scalar q-values or list [qx,qy]
107where qx,qy are 1D ndarrays</td>
108</tr>
109</tbody>
110</table>
111</dd></dl>
112
113<dl class="method">
114<dt id="sans.models.LineModel.LineModel.getDispParamList">
115<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LineModel.LineModel.getDispParamList" title="Permalink to this definition">¶</a></dt>
116<dd><p>Return a list of all available parameters for the model</p>
117</dd></dl>
118
119<dl class="method">
120<dt id="sans.models.LineModel.LineModel.getParam">
121<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LineModel.LineModel.getParam" title="Permalink to this definition">¶</a></dt>
122<dd><p>Set the value of a model parameter</p>
123<table class="docutils field-list" frame="void" rules="none">
124<col class="field-name" />
125<col class="field-body" />
126<tbody valign="top">
127<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
128</tr>
129</tbody>
130</table>
131</dd></dl>
132
133<dl class="method">
134<dt id="sans.models.LineModel.LineModel.getParamList">
135<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LineModel.LineModel.getParamList" title="Permalink to this definition">¶</a></dt>
136<dd><p>Return a list of all available parameters for the model</p>
137</dd></dl>
138
139<dl class="method">
140<dt id="sans.models.LineModel.LineModel.getParamListWithToken">
141<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LineModel.LineModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
142<dd></dd></dl>
143
144<dl class="method">
145<dt id="sans.models.LineModel.LineModel.getParamWithToken">
146<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LineModel.LineModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
147<dd></dd></dl>
148
149<dl class="method">
150<dt id="sans.models.LineModel.LineModel.is_fittable">
151<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LineModel.LineModel.is_fittable" title="Permalink to this definition">¶</a></dt>
152<dd><p>Check if a given parameter is fittable or not</p>
153<table class="docutils field-list" frame="void" rules="none">
154<col class="field-name" />
155<col class="field-body" />
156<tbody valign="top">
157<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td>
158</tr>
159</tbody>
160</table>
161</dd></dl>
162
163<dl class="method">
164<dt id="sans.models.LineModel.LineModel.run">
165<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LineModel.LineModel.run" title="Permalink to this definition">¶</a></dt>
166<dd><p>Evaluate the model
167&#64;param x: simple value
168&#64;return: (Line value)</p>
169</dd></dl>
170
171<dl class="method">
172<dt id="sans.models.LineModel.LineModel.runXY">
173<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LineModel.LineModel.runXY" title="Permalink to this definition">¶</a></dt>
174<dd><p>Evaluate the model
175&#64;param x: simple value
176&#64;return: Line value</p>
177</dd></dl>
178
179<dl class="method">
180<dt id="sans.models.LineModel.LineModel.setParam">
181<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LineModel.LineModel.setParam" title="Permalink to this definition">¶</a></dt>
182<dd><p>Set the value of a model parameter</p>
183<table class="docutils field-list" frame="void" rules="none">
184<col class="field-name" />
185<col class="field-body" />
186<tbody valign="top">
187<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
188<li><strong>name</strong> &#8211; name of the parameter</li>
189<li><strong>value</strong> &#8211; value of the parameter</li>
190</ul>
191</td>
192</tr>
193</tbody>
194</table>
195</dd></dl>
196
197<dl class="method">
198<dt id="sans.models.LineModel.LineModel.setParamWithToken">
199<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LineModel.LineModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
200<dd></dd></dl>
201
202</dd></dl>
203
204</div>
205</div>
206
207
208          </div>
209        </div>
210      </div>
211      <div class="sphinxsidebar">
212        <div class="sphinxsidebarwrapper">
213  <h3><a href="../index.html">Table Of Contents</a></h3>
214  <ul>
215<li><a class="reference internal" href="#">LineModel</a><ul>
216<li><a class="reference internal" href="#sans-models-linemodel"><tt class="docutils literal"><span class="pre">sans.models.LineModel</span></tt></a></li>
217</ul>
218</li>
219</ul>
220
221  <h4>Previous topic</h4>
222  <p class="topless"><a href="LamellarPSModel.html"
223                        title="previous chapter">LamellarPSModel</a></p>
224  <h4>Next topic</h4>
225  <p class="topless"><a href="LogNormal.html"
226                        title="next chapter">LogNormal</a></p>
227  <h3>This Page</h3>
228  <ul class="this-page-menu">
229    <li><a href="../_sources/api/LineModel.txt"
230           rel="nofollow">Show Source</a></li>
231  </ul>
232<div id="searchbox" style="display: none">
233  <h3>Quick search</h3>
234    <form class="search" action="../search.html" method="get">
235      <input type="text" name="q" />
236      <input type="submit" value="Go" />
237      <input type="hidden" name="check_keywords" value="yes" />
238      <input type="hidden" name="area" value="default" />
239    </form>
240    <p class="searchtip" style="font-size: 90%">
241    Enter search terms or a module, class or function name.
242    </p>
243</div>
244<script type="text/javascript">$('#searchbox').show(0);</script>
245        </div>
246      </div>
247      <div class="clearer"></div>
248    </div>
249    <div class="related">
250      <h3>Navigation</h3>
251      <ul>
252        <li class="right" style="margin-right: 10px">
253          <a href="../genindex.html" title="General Index"
254             >index</a></li>
255        <li class="right" >
256          <a href="../py-modindex.html" title="Python Module Index"
257             >modules</a> |</li>
258        <li class="right" >
259          <a href="LogNormal.html" title="LogNormal"
260             >next</a> |</li>
261        <li class="right" >
262          <a href="LamellarPSModel.html" title="LamellarPSModel"
263             >previous</a> |</li>
264        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
265          <li><a href="index.html" >Reference</a> &raquo;</li> 
266      </ul>
267    </div>
268    <div class="footer">
269        &copy; Copyright 2010, sans group.
270      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
271    </div>
272  </body>
273</html>
Note: See TracBrowser for help on using the repository browser.