source: sasview/sansmodels/docs/sphinx/html/api/SLDCalFunc.html @ 846c724

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

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