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

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

edit docs for models
  • Property mode set to 100644
File size: 23.6 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
[c0d873f]6
[512573a]7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
[c0d873f]11    <title>CSParallelepipedModel &mdash; sansmodels 0.1.0 documentation</title>
12   
[512573a]13    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
[c0d873f]15   
[512573a]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>
[c0d873f]28    <link rel="top" title="sansmodels 0.1.0 documentation" href="../index.html" />
[512573a]29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="CylinderModel" href="CylinderModel.html" />
31    <link rel="prev" title="Cos" href="Cos.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="CylinderModel.html" title="CylinderModel"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="Cos.html" title="Cos"
48             accesskey="P">previous</a> |</li>
[c0d873f]49        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
[512573a]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="csparallelepipedmodel">
60<h1>CSParallelepipedModel<a class="headerlink" href="#csparallelepipedmodel" title="Permalink to this headline">¶</a></h1>
[c0d873f]61<div class="section" id="sans-models-csparallelepipedmodel">
62<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="#sans-models-csparallelepipedmodel" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.models.CSParallelepipedModel"></span><p>Provide functionality for a C extension model</p>
[512573a]64<table class="docutils field-list" frame="void" rules="none">
65<col class="field-name" />
66<col class="field-body" />
67<tbody valign="top">
[c0d873f]68<tr class="field-odd field"><th class="field-name">WARNING:</th><td class="field-body">THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
[512573a]69DO NOT MODIFY THIS FILE, MODIFY ..c_extensionscsparallelepiped.h
70AND RE-RUN THE GENERATOR SCRIPT</td>
71</tr>
72</tbody>
73</table>
74<dl class="class">
75<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel">
76<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>
77<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>
78<p>Class that evaluates a CSParallelepipedModel model.
79This file was auto-generated from ..c_extensionscsparallelepiped.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
85shortA          = 35.0 [A]
86midB            = 75.0 [A]
87longC           = 400.0 [A]
88rimA            = 10.0 [A]
89rimB            = 10.0 [A]
90rimC            = 10.0 [A]
91sld_rimA        = 2e-06 [1/A^(2)]
92sld_rimB        = 4e-06 [1/A^(2)]
93sld_rimC        = 2e-06 [1/A^(2)]
94sld_pcore       = 1e-06 [1/A^(2)]
95sld_solv        = 6e-06 [1/A^(2)]
96background      = 0.06 [1/cm]
97parallel_theta  = 0.0 [deg]
98parallel_phi    = 0.0 [deg]
99parallel_psi    = 0.0 [deg]</div></blockquote>
100<dl class="method">
[c0d873f]101<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__add__">
102<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__add__" title="Permalink to this definition">¶</a></dt>
103<dd></dd></dl>
104
105<dl class="attribute">
106<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__class__">
107<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__class__" title="Permalink to this definition">¶</a></dt>
108<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
109</dd></dl>
110
111<dl class="attribute">
112<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__delattr__">
113<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__delattr__" title="Permalink to this definition">¶</a></dt>
114<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
115</dd></dl>
116
117<dl class="attribute">
118<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__dict__">
119<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01C4CE30&gt;</em><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__dict__" title="Permalink to this definition">¶</a></dt>
120<dd></dd></dl>
121
122<dl class="method">
123<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__div__">
124<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__div__" title="Permalink to this definition">¶</a></dt>
125<dd></dd></dl>
126
127<dl class="attribute">
128<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__getattribute__">
129<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__getattribute__" title="Permalink to this definition">¶</a></dt>
130<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
131</dd></dl>
132
133<dl class="attribute">
134<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__hash__">
135<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__hash__" title="Permalink to this definition">¶</a></dt>
136<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
137</dd></dl>
138
139<dl class="method">
140<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__init__">
141<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__init__" title="Permalink to this definition">¶</a></dt>
142<dd><p>Initialization</p>
143</dd></dl>
144
145<dl class="attribute">
146<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__module__">
147<tt class="descname">__module__</tt><em class="property"> = 'sans.models.CSParallelepipedModel'</em><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__module__" title="Permalink to this definition">¶</a></dt>
148<dd></dd></dl>
149
150<dl class="method">
151<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__mul__">
152<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__mul__" title="Permalink to this definition">¶</a></dt>
153<dd></dd></dl>
154
155<dl class="staticmethod">
156<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__new__">
157<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__new__" title="Permalink to this definition">¶</a></dt>
158<dd></dd></dl>
159
160<dl class="method">
161<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__reduce__">
162<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__reduce__" title="Permalink to this definition">¶</a></dt>
163<dd><p>helper for pickle</p>
164</dd></dl>
165
166<dl class="method">
167<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__reduce_ex__">
168<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
169<dd><p>Overwrite the __reduce_ex__ of PyTypeObject <a href="#id1"><span class="problematic" id="id2">*</span></a>type call in the init of
170c model.</p>
171</dd></dl>
172
173<dl class="attribute">
174<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__repr__">
175<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__repr__" title="Permalink to this definition">¶</a></dt>
176<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
177</dd></dl>
178
179<dl class="attribute">
180<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__setattr__">
181<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__setattr__" title="Permalink to this definition">¶</a></dt>
182<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
183</dd></dl>
184
185<dl class="method">
186<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__setstate__">
187<tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__setstate__" title="Permalink to this definition">¶</a></dt>
188<dd><p>restore the state of a model from pickle</p>
189</dd></dl>
190
191<dl class="attribute">
192<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__str__">
193<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__str__" title="Permalink to this definition">¶</a></dt>
194<dd><p>x.__str__() &lt;==&gt; str(x)</p>
195</dd></dl>
196
197<dl class="method">
198<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__sub__">
199<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__sub__" title="Permalink to this definition">¶</a></dt>
200<dd></dd></dl>
201
202<dl class="attribute">
203<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__weakref__">
204<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__weakref__" title="Permalink to this definition">¶</a></dt>
205<dd><p>list of weak references to the object (if defined)</p>
206</dd></dl>
207
208<dl class="method">
209<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel._clone">
210<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>
211<dd><p>Internal utility function to copy the internal
212data members to a fresh copy.</p>
213</dd></dl>
214
215<dl class="method">
[512573a]216<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.calculate_ER">
217<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>
218<dd><p>Calculate the effective radius for P(q)*S(q)</p>
219<table class="docutils field-list" frame="void" rules="none">
220<col class="field-name" />
221<col class="field-body" />
222<tbody valign="top">
[c0d873f]223<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td>
[512573a]224</tr>
225</tbody>
226</table>
227</dd></dl>
228
229<dl class="method">
230<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.clone">
231<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>
232<dd><p>Return a identical copy of self</p>
233</dd></dl>
234
235<dl class="attribute">
236<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.dispersion">
237<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.dispersion" title="Permalink to this definition">¶</a></dt>
238<dd><p>Dispersion parameters</p>
239</dd></dl>
240
241<dl class="method">
242<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.evalDistribution">
[c0d873f]243<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
[512573a]244<dd><p>Evaluate the model in cartesian coordinates</p>
245<table class="docutils field-list" frame="void" rules="none">
246<col class="field-name" />
247<col class="field-body" />
248<tbody valign="top">
[c0d873f]249<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>
[512573a]250</tr>
[c0d873f]251<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td>
[512573a]252</tr>
253</tbody>
254</table>
255</dd></dl>
256
257<dl class="method">
258<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.getDispParamList">
259<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>
260<dd><p>Return a list of all available parameters for the model</p>
261</dd></dl>
262
263<dl class="method">
264<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.getParam">
[c0d873f]265<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.getParam" title="Permalink to this definition">¶</a></dt>
[512573a]266<dd><p>Set the value of a model parameter</p>
267<table class="docutils field-list" frame="void" rules="none">
268<col class="field-name" />
269<col class="field-body" />
270<tbody valign="top">
[c0d873f]271<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
[512573a]272</tr>
273</tbody>
274</table>
275</dd></dl>
276
277<dl class="method">
278<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.getParamList">
279<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>
280<dd><p>Return a list of all available parameters for the model</p>
281</dd></dl>
282
283<dl class="method">
284<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.getParamListWithToken">
[c0d873f]285<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
[512573a]286<dd></dd></dl>
287
288<dl class="method">
289<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.getParamWithToken">
[c0d873f]290<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
[512573a]291<dd></dd></dl>
292
293<dl class="method">
294<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.is_fittable">
[c0d873f]295<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.is_fittable" title="Permalink to this definition">¶</a></dt>
[512573a]296<dd><p>Check if a given parameter is fittable or not</p>
297<table class="docutils field-list" frame="void" rules="none">
298<col class="field-name" />
299<col class="field-body" />
300<tbody valign="top">
[c0d873f]301<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>
[512573a]302</tr>
303</tbody>
304</table>
305</dd></dl>
306
307<dl class="attribute">
308<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.log">
309<tt class="descname">log</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.log" title="Permalink to this definition">¶</a></dt>
310<dd><p>Log</p>
311</dd></dl>
312
313<dl class="attribute">
314<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.params">
315<tt class="descname">params</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.params" title="Permalink to this definition">¶</a></dt>
316<dd><p>Parameters</p>
317</dd></dl>
318
[c0d873f]319<dl class="method">
[512573a]320<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.reset">
[c0d873f]321<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.reset" title="Permalink to this definition">¶</a></dt>
[512573a]322<dd><p>Reset pair correlation</p>
323</dd></dl>
324
325<dl class="method">
326<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.run">
[c0d873f]327<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.run" title="Permalink to this definition">¶</a></dt>
[512573a]328<dd><p>Evaluate the model</p>
329<table class="docutils field-list" frame="void" rules="none">
330<col class="field-name" />
331<col class="field-body" />
332<tbody valign="top">
[c0d873f]333<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>
[512573a]334</tr>
[c0d873f]335<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
[512573a]336</tr>
337</tbody>
338</table>
339</dd></dl>
340
341<dl class="method">
342<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.runXY">
[c0d873f]343<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.runXY" title="Permalink to this definition">¶</a></dt>
[512573a]344<dd><p>Evaluate the model in cartesian coordinates</p>
345<table class="docutils field-list" frame="void" rules="none">
346<col class="field-name" />
347<col class="field-body" />
348<tbody valign="top">
[c0d873f]349<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>
[512573a]350</tr>
[c0d873f]351<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
[512573a]352</tr>
353</tbody>
354</table>
355</dd></dl>
356
357<dl class="method">
358<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.setParam">
[c0d873f]359<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.setParam" title="Permalink to this definition">¶</a></dt>
[512573a]360<dd><p>Set the value of a model parameter</p>
361<table class="docutils field-list" frame="void" rules="none">
362<col class="field-name" />
363<col class="field-body" />
364<tbody valign="top">
[c0d873f]365<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
[512573a]366<li><strong>name</strong> &#8211; name of the parameter</li>
367<li><strong>value</strong> &#8211; value of the parameter</li>
368</ul>
369</td>
370</tr>
371</tbody>
372</table>
373</dd></dl>
374
375<dl class="method">
376<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.setParamWithToken">
[c0d873f]377<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
[512573a]378<dd></dd></dl>
379
380<dl class="method">
381<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.set_dispersion">
[c0d873f]382<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
[512573a]383<dd><p>Set the dispersion object for a model parameter</p>
384<table class="docutils field-list" frame="void" rules="none">
385<col class="field-name" />
386<col class="field-body" />
387<tbody valign="top">
[c0d873f]388<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
[512573a]389<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
390<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
391</ul>
392</td>
393</tr>
394</tbody>
395</table>
396</dd></dl>
397
398</dd></dl>
399
400<dl class="function">
401<dt id="sans.models.CSParallelepipedModel.create_CSParallelepipedModel">
402<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>
403<dd></dd></dl>
404
405</div>
406</div>
407
408
409          </div>
410        </div>
411      </div>
412      <div class="sphinxsidebar">
413        <div class="sphinxsidebarwrapper">
414  <h3><a href="../index.html">Table Of Contents</a></h3>
415  <ul>
416<li><a class="reference internal" href="#">CSParallelepipedModel</a><ul>
[c0d873f]417<li><a class="reference internal" href="#sans-models-csparallelepipedmodel"><tt class="docutils literal"><span class="pre">sans.models.CSParallelepipedModel</span></tt></a></li>
[512573a]418</ul>
419</li>
420</ul>
421
422  <h4>Previous topic</h4>
423  <p class="topless"><a href="Cos.html"
424                        title="previous chapter">Cos</a></p>
425  <h4>Next topic</h4>
426  <p class="topless"><a href="CylinderModel.html"
427                        title="next chapter">CylinderModel</a></p>
428  <h3>This Page</h3>
429  <ul class="this-page-menu">
430    <li><a href="../_sources/api/CSParallelepipedModel.txt"
431           rel="nofollow">Show Source</a></li>
432  </ul>
433<div id="searchbox" style="display: none">
434  <h3>Quick search</h3>
435    <form class="search" action="../search.html" method="get">
[c0d873f]436      <input type="text" name="q" />
[512573a]437      <input type="submit" value="Go" />
438      <input type="hidden" name="check_keywords" value="yes" />
439      <input type="hidden" name="area" value="default" />
440    </form>
441    <p class="searchtip" style="font-size: 90%">
442    Enter search terms or a module, class or function name.
443    </p>
444</div>
445<script type="text/javascript">$('#searchbox').show(0);</script>
446        </div>
447      </div>
448      <div class="clearer"></div>
449    </div>
450    <div class="related">
451      <h3>Navigation</h3>
452      <ul>
453        <li class="right" style="margin-right: 10px">
454          <a href="../genindex.html" title="General Index"
455             >index</a></li>
456        <li class="right" >
457          <a href="../py-modindex.html" title="Python Module Index"
458             >modules</a> |</li>
459        <li class="right" >
460          <a href="CylinderModel.html" title="CylinderModel"
461             >next</a> |</li>
462        <li class="right" >
463          <a href="Cos.html" title="Cos"
464             >previous</a> |</li>
[c0d873f]465        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
[512573a]466          <li><a href="index.html" >Reference</a> &raquo;</li> 
467      </ul>
468    </div>
469    <div class="footer">
470        &copy; Copyright 2010, sans group.
[c0d873f]471      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
[512573a]472    </div>
473  </body>
474</html>
Note: See TracBrowser for help on using the repository browser.