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