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