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

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

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