source: sasview/sansmodels/docs/sphinx/_build/html/api/GuinierModel.html @ 5062bbf

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 5062bbf was 79ac6f8, checked in by Gervaise Alina <gervyh@…>, 15 years ago

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