source: sasview/sansmodels/docs/sphinx/_build/html/api/Schulz.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@…>, 14 years ago

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