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