source: sasview/sansmodels/docs/sphinx/html/api/CSParallelepipedModel.html @ fafdfd3

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

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