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