source: sasview/sansmodels/docs/sphinx/html/api/LogNormal.html @ c09ace41

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

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