source: sasview/sansmodels/docs/sphinx/html/api/Gaussian.html @ 7e7e806

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

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 15.0 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>Gaussian &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="GaussLorentzGelModel" href="GaussLorentzGelModel.html" />
28    <link rel="prev" title="FuzzySphereModel" href="FuzzySphereModel.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="GaussLorentzGelModel.html" title="GaussLorentzGelModel"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="FuzzySphereModel.html" title="FuzzySphereModel"
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="gaussian">
57<h1>Gaussian<a class="headerlink" href="#gaussian" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.Gaussian">
59<span id="sans-models-gaussian"></span><h2><a class="reference internal" href="#module-sans.models.Gaussian" title="sans.models.Gaussian"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.Gaussian</span></tt></a><a class="headerlink" href="#module-sans.models.Gaussian" title="Permalink to this headline">¶</a></h2>
60<p>Provide functionality for a C extension model</p>
61<table class="docutils field-list" frame="void" rules="none">
62<col class="field-name" />
63<col class="field-body" />
64<tbody valign="top">
65<tr class="field"><th class="field-name">WARNING:</th><td class="field-body">THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
66DO NOT MODIFY THIS FILE, MODIFY ..c_extensionsgaussian.h
67AND RE-RUN THE GENERATOR SCRIPT</td>
68</tr>
69</tbody>
70</table>
71<dl class="class">
72<dt id="sans.models.Gaussian.Gaussian">
73<em class="property">class </em><tt class="descclassname">sans.models.Gaussian.</tt><tt class="descname">Gaussian</tt><a class="headerlink" href="#sans.models.Gaussian.Gaussian" title="Permalink to this definition">¶</a></dt>
74<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">CGaussian</span></tt>, <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>
75<p>Class that evaluates a Gaussian model.
76This file was auto-generated from ..c_extensionsgaussian.h.
77Refer to that file and the structure it contains
78for details of the model.
79List of default parameters:</p>
80<blockquote>
81<div>scale           = 1.0
82sigma           = 1.0
83center          = 0.0</div></blockquote>
84<dl class="method">
85<dt id="sans.models.Gaussian.Gaussian.calculate_ER">
86<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Gaussian.Gaussian.calculate_ER" title="Permalink to this definition">¶</a></dt>
87<dd><p>Calculate the effective radius for P(q)*S(q)</p>
88<table class="docutils field-list" frame="void" rules="none">
89<col class="field-name" />
90<col class="field-body" />
91<tbody valign="top">
92<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td>
93</tr>
94</tbody>
95</table>
96</dd></dl>
97
98<dl class="method">
99<dt id="sans.models.Gaussian.Gaussian.clone">
100<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Gaussian.Gaussian.clone" title="Permalink to this definition">¶</a></dt>
101<dd><p>Return a identical copy of self</p>
102</dd></dl>
103
104<dl class="method">
105<dt id="sans.models.Gaussian.Gaussian.evalDistribution">
106<tt class="descname">evalDistribution</tt><big>(</big><em>x=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.models.Gaussian.Gaussian.evalDistribution" title="Permalink to this definition">¶</a></dt>
107<dd><p>Evaluate the model in cartesian coordinates</p>
108<table class="docutils field-list" frame="void" rules="none">
109<col class="field-name" />
110<col class="field-body" />
111<tbody valign="top">
112<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td>
113</tr>
114<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td>
115</tr>
116</tbody>
117</table>
118</dd></dl>
119
120<dl class="method">
121<dt id="sans.models.Gaussian.Gaussian.getDispParamList">
122<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Gaussian.Gaussian.getDispParamList" title="Permalink to this definition">¶</a></dt>
123<dd><p>Return a list of all available parameters for the model</p>
124</dd></dl>
125
126<dl class="method">
127<dt id="sans.models.Gaussian.Gaussian.getParam">
128<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.Gaussian.Gaussian.getParam" title="Permalink to this definition">¶</a></dt>
129<dd><p>Set the value of a model parameter</p>
130<table class="docutils field-list" frame="void" rules="none">
131<col class="field-name" />
132<col class="field-body" />
133<tbody valign="top">
134<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
135</tr>
136</tbody>
137</table>
138</dd></dl>
139
140<dl class="method">
141<dt id="sans.models.Gaussian.Gaussian.getParamList">
142<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Gaussian.Gaussian.getParamList" title="Permalink to this definition">¶</a></dt>
143<dd><p>Return a list of all available parameters for the model</p>
144</dd></dl>
145
146<dl class="method">
147<dt id="sans.models.Gaussian.Gaussian.getParamListWithToken">
148<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.Gaussian.Gaussian.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
149<dd></dd></dl>
150
151<dl class="method">
152<dt id="sans.models.Gaussian.Gaussian.getParamWithToken">
153<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.Gaussian.Gaussian.getParamWithToken" title="Permalink to this definition">¶</a></dt>
154<dd></dd></dl>
155
156<dl class="method">
157<dt id="sans.models.Gaussian.Gaussian.is_fittable">
158<tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.Gaussian.Gaussian.is_fittable" title="Permalink to this definition">¶</a></dt>
159<dd><p>Check if a given parameter is fittable or not</p>
160<table class="docutils field-list" frame="void" rules="none">
161<col class="field-name" />
162<col class="field-body" />
163<tbody valign="top">
164<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td>
165</tr>
166</tbody>
167</table>
168</dd></dl>
169
170<dl class="attribute">
171<dt id="sans.models.Gaussian.Gaussian.log">
172<tt class="descname">log</tt><a class="headerlink" href="#sans.models.Gaussian.Gaussian.log" title="Permalink to this definition">¶</a></dt>
173<dd><p>Log</p>
174</dd></dl>
175
176<dl class="attribute">
177<dt id="sans.models.Gaussian.Gaussian.params">
178<tt class="descname">params</tt><a class="headerlink" href="#sans.models.Gaussian.Gaussian.params" title="Permalink to this definition">¶</a></dt>
179<dd><p>Parameters</p>
180</dd></dl>
181
182<dl class="attribute">
183<dt id="sans.models.Gaussian.Gaussian.reset">
184<tt class="descname">reset</tt><a class="headerlink" href="#sans.models.Gaussian.Gaussian.reset" title="Permalink to this definition">¶</a></dt>
185<dd><p>Reset pair correlation</p>
186</dd></dl>
187
188<dl class="method">
189<dt id="sans.models.Gaussian.Gaussian.run">
190<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.Gaussian.Gaussian.run" title="Permalink to this definition">¶</a></dt>
191<dd><p>Evaluate the model</p>
192<table class="docutils field-list" frame="void" rules="none">
193<col class="field-name" />
194<col class="field-body" />
195<tbody valign="top">
196<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td>
197</tr>
198<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
199</tr>
200</tbody>
201</table>
202</dd></dl>
203
204<dl class="method">
205<dt id="sans.models.Gaussian.Gaussian.runXY">
206<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.Gaussian.Gaussian.runXY" title="Permalink to this definition">¶</a></dt>
207<dd><p>Evaluate the model in cartesian coordinates</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"><strong>x</strong> &#8211; input q, or [qx, qy]</td>
213</tr>
214<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
215</tr>
216</tbody>
217</table>
218</dd></dl>
219
220<dl class="method">
221<dt id="sans.models.Gaussian.Gaussian.setParam">
222<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.Gaussian.Gaussian.setParam" title="Permalink to this definition">¶</a></dt>
223<dd><p>Set the value of a model parameter</p>
224<table class="docutils field-list" frame="void" rules="none">
225<col class="field-name" />
226<col class="field-body" />
227<tbody valign="top">
228<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
229<li><strong>name</strong> &#8211; name of the parameter</li>
230<li><strong>value</strong> &#8211; value of the parameter</li>
231</ul>
232</td>
233</tr>
234</tbody>
235</table>
236</dd></dl>
237
238<dl class="method">
239<dt id="sans.models.Gaussian.Gaussian.setParamWithToken">
240<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.Gaussian.Gaussian.setParamWithToken" title="Permalink to this definition">¶</a></dt>
241<dd></dd></dl>
242
243<dl class="method">
244<dt id="sans.models.Gaussian.Gaussian.set_dispersion">
245<tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.Gaussian.Gaussian.set_dispersion" title="Permalink to this definition">¶</a></dt>
246<dd><p>Set the dispersion object for a model parameter</p>
247<table class="docutils field-list" frame="void" rules="none">
248<col class="field-name" />
249<col class="field-body" />
250<tbody valign="top">
251<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
252<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
253<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
254</ul>
255</td>
256</tr>
257</tbody>
258</table>
259</dd></dl>
260
261</dd></dl>
262
263<dl class="function">
264<dt id="sans.models.Gaussian.create_Gaussian">
265<tt class="descclassname">sans.models.Gaussian.</tt><tt class="descname">create_Gaussian</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Gaussian.create_Gaussian" title="Permalink to this definition">¶</a></dt>
266<dd></dd></dl>
267
268</div>
269</div>
270
271
272          </div>
273        </div>
274      </div>
275      <div class="sphinxsidebar">
276        <div class="sphinxsidebarwrapper">
277  <h3><a href="../index.html">Table Of Contents</a></h3>
278  <ul>
279<li><a class="reference internal" href="#">Gaussian</a><ul>
280<li><a class="reference internal" href="#module-sans.models.Gaussian"><tt class="docutils literal"><span class="pre">sans.models.Gaussian</span></tt></a></li>
281</ul>
282</li>
283</ul>
284
285  <h4>Previous topic</h4>
286  <p class="topless"><a href="FuzzySphereModel.html"
287                        title="previous chapter">FuzzySphereModel</a></p>
288  <h4>Next topic</h4>
289  <p class="topless"><a href="GaussLorentzGelModel.html"
290                        title="next chapter">GaussLorentzGelModel</a></p>
291  <h3>This Page</h3>
292  <ul class="this-page-menu">
293    <li><a href="../_sources/api/Gaussian.txt"
294           rel="nofollow">Show Source</a></li>
295  </ul>
296<div id="searchbox" style="display: none">
297  <h3>Quick search</h3>
298    <form class="search" action="../search.html" method="get">
299      <input type="text" name="q" size="18" />
300      <input type="submit" value="Go" />
301      <input type="hidden" name="check_keywords" value="yes" />
302      <input type="hidden" name="area" value="default" />
303    </form>
304    <p class="searchtip" style="font-size: 90%">
305    Enter search terms or a module, class or function name.
306    </p>
307</div>
308<script type="text/javascript">$('#searchbox').show(0);</script>
309        </div>
310      </div>
311      <div class="clearer"></div>
312    </div>
313    <div class="related">
314      <h3>Navigation</h3>
315      <ul>
316        <li class="right" style="margin-right: 10px">
317          <a href="../genindex.html" title="General Index"
318             >index</a></li>
319        <li class="right" >
320          <a href="../py-modindex.html" title="Python Module Index"
321             >modules</a> |</li>
322        <li class="right" >
323          <a href="GaussLorentzGelModel.html" title="GaussLorentzGelModel"
324             >next</a> |</li>
325        <li class="right" >
326          <a href="FuzzySphereModel.html" title="FuzzySphereModel"
327             >previous</a> |</li>
328        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
329          <li><a href="index.html" >Reference</a> &raquo;</li> 
330      </ul>
331    </div>
332    <div class="footer">
333        &copy; Copyright 2010, sans group.
334      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
335    </div>
336  </body>
337</html>
Note: See TracBrowser for help on using the repository browser.