source: sasview/dev/api/sas.perspectives.fitting.plugin_models.html @ a462c6a

gh-pages
Last change on this file since a462c6a was a462c6a, checked in by ajj, 9 years ago

Rebuild to fix index and modules docs
  • Property mode set to 100644
File size: 33.2 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6  <head>
7    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8   
9    <title>sas.perspectives.fitting.plugin_models package &mdash; SasView 3.0.0 documentation</title>
10   
11    <link rel="stylesheet" href="../../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
13   
14    <script type="text/javascript">
15      var DOCUMENTATION_OPTIONS = {
16        URL_ROOT:    '../../',
17        VERSION:     '3.0.0',
18        COLLAPSE_INDEX: false,
19        FILE_SUFFIX: '.html',
20        HAS_SOURCE:  true
21      };
22    </script>
23    <script type="text/javascript" src="../../_static/jquery.js"></script>
24    <script type="text/javascript" src="../../_static/underscore.js"></script>
25    <script type="text/javascript" src="../../_static/doctools.js"></script>
26    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
27    <link rel="top" title="SasView 3.0.0 documentation" href="../../index.html" />
28    <link rel="up" title="sas.perspectives.fitting package" href="sas.perspectives.fitting.html" />
29    <link rel="next" title="sas.perspectives.invariant package" href="sas.perspectives.invariant.html" />
30    <link rel="prev" title="sas.perspectives.fitting package" href="sas.perspectives.fitting.html" /> 
31  </head>
32  <body>
33    <div class="related">
34      <h3>Navigation</h3>
35      <ul>
36        <li class="right" style="margin-right: 10px">
37          <a href="../../genindex.html" title="General Index"
38             accesskey="I">index</a></li>
39        <li class="right" >
40          <a href="../../py-modindex.html" title="Python Module Index"
41             >modules</a> |</li>
42        <li class="right" >
43          <a href="sas.perspectives.invariant.html" title="sas.perspectives.invariant package"
44             accesskey="N">next</a> |</li>
45        <li class="right" >
46          <a href="sas.perspectives.fitting.html" title="sas.perspectives.fitting package"
47             accesskey="P">previous</a> |</li>
48        <li><a href="../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
49          <li><a href="../dev.html" >Developer Documentation</a> &raquo;</li>
50          <li><a href="modules.html" >lib.macosx-10.5-x86_64-2.7</a> &raquo;</li>
51          <li><a href="sas.html" >sas package</a> &raquo;</li>
52          <li><a href="sas.perspectives.html" >sas.perspectives package</a> &raquo;</li>
53          <li><a href="sas.perspectives.fitting.html" accesskey="U">sas.perspectives.fitting package</a> &raquo;</li> 
54      </ul>
55    </div> 
56
57    <div class="document">
58      <div class="documentwrapper">
59        <div class="bodywrapper">
60          <div class="body">
61           
62  <div class="section" id="sas-perspectives-fitting-plugin-models-package">
63<h1>sas.perspectives.fitting.plugin_models package</h1>
64<div class="section" id="submodules">
65<h2>Submodules</h2>
66</div>
67<div class="section" id="module-sas.perspectives.fitting.plugin_models.polynomial5">
68<span id="sas-perspectives-fitting-plugin-models-polynomial5-module"></span><h2>sas.perspectives.fitting.plugin_models.polynomial5 module</h2>
69<p>Test plug-in model
70These are links of available functions:</p>
71<p><a class="reference external" href="http://docs.python.org/library/math.html">http://docs.python.org/library/math.html</a>
72<a class="reference external" href="http://www.scipy.org/Numpy_Functions_by_Category">http://www.scipy.org/Numpy_Functions_by_Category</a></p>
73<dl class="class">
74<dt id="sas.perspectives.fitting.plugin_models.polynomial5.Model">
75<em class="property">class </em><tt class="descclassname">sas.perspectives.fitting.plugin_models.polynomial5.</tt><tt class="descname">Model</tt><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/polynomial5.html#Model"><span class="viewcode-link">[source]</span></a></dt>
76<dd><p>Bases: <a class="reference internal" href="sas.models.html#sas.models.pluginmodel.Model1DPlugin" title="sas.models.pluginmodel.Model1DPlugin"><tt class="xref py py-class docutils literal"><span class="pre">sas.models.pluginmodel.Model1DPlugin</span></tt></a></p>
77<p>##YOU CAN BE MODIFY ANYTHING BETWEEN
78##DESCRIPTION OF MODEL PLUG-IN GOES HERE</p>
79<p>##EXAMPLE: Class that evaluates a polynomial model.</p>
80<dl class="method">
81<dt id="sas.perspectives.fitting.plugin_models.polynomial5.Model.function">
82<tt class="descname">function</tt><big>(</big><em>x=0.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/polynomial5.html#Model.function"><span class="viewcode-link">[source]</span></a></dt>
83<dd><p>Evaluate the model
84:param x: input x
85:return: function value</p>
86</dd></dl>
87
88<dl class="method">
89<dt id="sas.perspectives.fitting.plugin_models.polynomial5.Model.get_fname">
90<tt class="descname">get_fname</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/polynomial5.html#Model.get_fname"><span class="viewcode-link">[source]</span></a></dt>
91<dd><p>Get the model name same as the file name</p>
92</dd></dl>
93
94<dl class="attribute">
95<dt id="sas.perspectives.fitting.plugin_models.polynomial5.Model.name">
96<tt class="descname">name</tt><em class="property"> = ''</em></dt>
97<dd></dd></dl>
98
99</dd></dl>
100
101</div>
102<div class="section" id="module-sas.perspectives.fitting.plugin_models.sph_bessel_jn">
103<span id="sas-perspectives-fitting-plugin-models-sph-bessel-jn-module"></span><h2>sas.perspectives.fitting.plugin_models.sph_bessel_jn module</h2>
104<p>Test plug-in model
105These are links of available functions:</p>
106<p><a class="reference external" href="http://docs.python.org/library/math.html">http://docs.python.org/library/math.html</a>
107<a class="reference external" href="http://www.scipy.org/Numpy_Functions_by_Category">http://www.scipy.org/Numpy_Functions_by_Category</a></p>
108<dl class="class">
109<dt id="sas.perspectives.fitting.plugin_models.sph_bessel_jn.Model">
110<em class="property">class </em><tt class="descclassname">sas.perspectives.fitting.plugin_models.sph_bessel_jn.</tt><tt class="descname">Model</tt><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sph_bessel_jn.html#Model"><span class="viewcode-link">[source]</span></a></dt>
111<dd><p>Bases: <a class="reference internal" href="sas.models.html#sas.models.pluginmodel.Model1DPlugin" title="sas.models.pluginmodel.Model1DPlugin"><tt class="xref py py-class docutils literal"><span class="pre">sas.models.pluginmodel.Model1DPlugin</span></tt></a></p>
112<p>##YOU CAN BE MODIFY ANYTHING BETWEEN
113##DESCRIPTION OF MODEL PLUG-IN GOES HERE</p>
114<p>##EXAMPLE: Class that evaluates a polynomial model.</p>
115<dl class="method">
116<dt id="sas.perspectives.fitting.plugin_models.sph_bessel_jn.Model.function">
117<tt class="descname">function</tt><big>(</big><em>x=0.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sph_bessel_jn.html#Model.function"><span class="viewcode-link">[source]</span></a></dt>
118<dd><p>Evaluate the model</p>
119<table class="docutils field-list" frame="void" rules="none">
120<col class="field-name" />
121<col class="field-body" />
122<tbody valign="top">
123<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input x</td>
124</tr>
125<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">function value</td>
126</tr>
127</tbody>
128</table>
129</dd></dl>
130
131<dl class="method">
132<dt id="sas.perspectives.fitting.plugin_models.sph_bessel_jn.Model.get_fname">
133<tt class="descname">get_fname</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sph_bessel_jn.html#Model.get_fname"><span class="viewcode-link">[source]</span></a></dt>
134<dd><p>Get the model name same as the file name</p>
135</dd></dl>
136
137<dl class="attribute">
138<dt id="sas.perspectives.fitting.plugin_models.sph_bessel_jn.Model.name">
139<tt class="descname">name</tt><em class="property"> = ''</em></dt>
140<dd></dd></dl>
141
142</dd></dl>
143
144</div>
145<div class="section" id="module-sas.perspectives.fitting.plugin_models.sum_Ap1_1_Ap2">
146<span id="sas-perspectives-fitting-plugin-models-sum-ap1-1-ap2-module"></span><h2>sas.perspectives.fitting.plugin_models.sum_Ap1_1_Ap2 module</h2>
147<dl class="class">
148<dt id="sas.perspectives.fitting.plugin_models.sum_Ap1_1_Ap2.Model">
149<em class="property">class </em><tt class="descclassname">sas.perspectives.fitting.plugin_models.sum_Ap1_1_Ap2.</tt><tt class="descname">Model</tt><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_Ap1_1_Ap2.html#Model"><span class="viewcode-link">[source]</span></a></dt>
150<dd><p>Bases: <a class="reference internal" href="sas.models.html#sas.models.pluginmodel.Model1DPlugin" title="sas.models.pluginmodel.Model1DPlugin"><tt class="xref py py-class docutils literal"><span class="pre">sas.models.pluginmodel.Model1DPlugin</span></tt></a></p>
151<p>Use for A*p1(Q)+(1-A)*p2(Q);
152Note: P(Q) refers to &#8216;form factor&#8217; model.</p>
153<dl class="method">
154<dt id="sas.perspectives.fitting.plugin_models.sum_Ap1_1_Ap2.Model.evalDistribution">
155<tt class="descname">evalDistribution</tt><big>(</big><em>x=[]</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_Ap1_1_Ap2.html#Model.evalDistribution"><span class="viewcode-link">[source]</span></a></dt>
156<dd><p>Evaluate the model in cartesian coordinates</p>
157<table class="docutils field-list" frame="void" rules="none">
158<col class="field-name" />
159<col class="field-body" />
160<tbody valign="top">
161<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>
162</tr>
163<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td>
164</tr>
165</tbody>
166</table>
167</dd></dl>
168
169<dl class="method">
170<dt id="sas.perspectives.fitting.plugin_models.sum_Ap1_1_Ap2.Model.fill_description">
171<tt class="descname">fill_description</tt><big>(</big><em>p_model1</em>, <em>p_model2</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_Ap1_1_Ap2.html#Model.fill_description"><span class="viewcode-link">[source]</span></a></dt>
172<dd><p>Fill the description for P(Q)+P(Q)</p>
173</dd></dl>
174
175<dl class="method">
176<dt id="sas.perspectives.fitting.plugin_models.sum_Ap1_1_Ap2.Model.function">
177<tt class="descname">function</tt><big>(</big><em>x=0.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_Ap1_1_Ap2.html#Model.function"><span class="viewcode-link">[source]</span></a></dt>
178<dd></dd></dl>
179
180<dl class="method">
181<dt id="sas.perspectives.fitting.plugin_models.sum_Ap1_1_Ap2.Model.getParam">
182<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_Ap1_1_Ap2.html#Model.getParam"><span class="viewcode-link">[source]</span></a></dt>
183<dd><p>Set the value of a model parameter</p>
184<table class="docutils field-list" frame="void" rules="none">
185<col class="field-name" />
186<col class="field-body" />
187<tbody valign="top">
188<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
189</tr>
190</tbody>
191</table>
192</dd></dl>
193
194<dl class="method">
195<dt id="sas.perspectives.fitting.plugin_models.sum_Ap1_1_Ap2.Model.getProfile">
196<tt class="descname">getProfile</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_Ap1_1_Ap2.html#Model.getProfile"><span class="viewcode-link">[source]</span></a></dt>
197<dd><p>Get SLD profile of p_model if exists</p>
198<dl class="docutils">
199<dt>: return: (r, beta) where r is a list of radius of the transition points</dt>
200<dd>beta is a list of the corresponding SLD values</dd>
201<dt>: Note: This works only for func_shell# = 2 (exp function)</dt>
202<dd>and is not supporting for p2</dd>
203</dl>
204</dd></dl>
205
206<dl class="method">
207<dt id="sas.perspectives.fitting.plugin_models.sum_Ap1_1_Ap2.Model.get_fname">
208<tt class="descname">get_fname</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_Ap1_1_Ap2.html#Model.get_fname"><span class="viewcode-link">[source]</span></a></dt>
209<dd><p>Get the model name same as the file name</p>
210</dd></dl>
211
212<dl class="attribute">
213<dt id="sas.perspectives.fitting.plugin_models.sum_Ap1_1_Ap2.Model.name">
214<tt class="descname">name</tt><em class="property"> = ''</em></dt>
215<dd></dd></dl>
216
217<dl class="method">
218<dt id="sas.perspectives.fitting.plugin_models.sum_Ap1_1_Ap2.Model.run">
219<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_Ap1_1_Ap2.html#Model.run"><span class="viewcode-link">[source]</span></a></dt>
220<dd><p>Evaluate the model</p>
221<table class="docutils field-list" frame="void" rules="none">
222<col class="field-name" />
223<col class="field-body" />
224<tbody valign="top">
225<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q-value (float or [float, float] as [r, theta])</td>
226</tr>
227<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">(scattering function value)</td>
228</tr>
229</tbody>
230</table>
231</dd></dl>
232
233<dl class="method">
234<dt id="sas.perspectives.fitting.plugin_models.sum_Ap1_1_Ap2.Model.runXY">
235<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_Ap1_1_Ap2.html#Model.runXY"><span class="viewcode-link">[source]</span></a></dt>
236<dd><p>Evaluate the model</p>
237<table class="docutils field-list" frame="void" rules="none">
238<col class="field-name" />
239<col class="field-body" />
240<tbody valign="top">
241<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q-value (float or [float, float] as [qx, qy])</td>
242</tr>
243<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function value</td>
244</tr>
245</tbody>
246</table>
247</dd></dl>
248
249<dl class="method">
250<dt id="sas.perspectives.fitting.plugin_models.sum_Ap1_1_Ap2.Model.setParam">
251<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_Ap1_1_Ap2.html#Model.setParam"><span class="viewcode-link">[source]</span></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"><ul class="first last simple">
258<li><strong>name</strong> &#8211; name of the parameter</li>
259<li><strong>value</strong> &#8211; value of the parameter</li>
260</ul>
261</td>
262</tr>
263</tbody>
264</table>
265</dd></dl>
266
267<dl class="method">
268<dt id="sas.perspectives.fitting.plugin_models.sum_Ap1_1_Ap2.Model.set_dispersion">
269<tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_Ap1_1_Ap2.html#Model.set_dispersion"><span class="viewcode-link">[source]</span></a></dt>
270<dd><p>Set the dispersion object for a model parameter</p>
271<table class="docutils field-list" frame="void" rules="none">
272<col class="field-name" />
273<col class="field-body" />
274<tbody valign="top">
275<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parameter</strong> &#8211; name of the parameter [string]</td>
276</tr>
277<tr class="field-even field"><th class="field-name">Dispersion:</th><td class="field-body">dispersion object of type DispersionModel</td>
278</tr>
279</tbody>
280</table>
281</dd></dl>
282
283</dd></dl>
284
285</div>
286<div class="section" id="module-sas.perspectives.fitting.plugin_models.sum_p1_p2">
287<span id="sas-perspectives-fitting-plugin-models-sum-p1-p2-module"></span><h2>sas.perspectives.fitting.plugin_models.sum_p1_p2 module</h2>
288<dl class="class">
289<dt id="sas.perspectives.fitting.plugin_models.sum_p1_p2.Model">
290<em class="property">class </em><tt class="descclassname">sas.perspectives.fitting.plugin_models.sum_p1_p2.</tt><tt class="descname">Model</tt><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_p1_p2.html#Model"><span class="viewcode-link">[source]</span></a></dt>
291<dd><p>Bases: <a class="reference internal" href="sas.models.html#sas.models.pluginmodel.Model1DPlugin" title="sas.models.pluginmodel.Model1DPlugin"><tt class="xref py py-class docutils literal"><span class="pre">sas.models.pluginmodel.Model1DPlugin</span></tt></a></p>
292<p>Use for p1(Q)+p2(Q);
293Note: P(Q) refers to &#8216;form factor&#8217; model.</p>
294<dl class="method">
295<dt id="sas.perspectives.fitting.plugin_models.sum_p1_p2.Model.evalDistribution">
296<tt class="descname">evalDistribution</tt><big>(</big><em>x=[]</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_p1_p2.html#Model.evalDistribution"><span class="viewcode-link">[source]</span></a></dt>
297<dd><p>Evaluate the model in cartesian coordinates</p>
298<table class="docutils field-list" frame="void" rules="none">
299<col class="field-name" />
300<col class="field-body" />
301<tbody valign="top">
302<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>
303</tr>
304<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td>
305</tr>
306</tbody>
307</table>
308</dd></dl>
309
310<dl class="method">
311<dt id="sas.perspectives.fitting.plugin_models.sum_p1_p2.Model.fill_description">
312<tt class="descname">fill_description</tt><big>(</big><em>p_model1</em>, <em>p_model2</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_p1_p2.html#Model.fill_description"><span class="viewcode-link">[source]</span></a></dt>
313<dd><p>Fill the description for P(Q)+P(Q)</p>
314</dd></dl>
315
316<dl class="method">
317<dt id="sas.perspectives.fitting.plugin_models.sum_p1_p2.Model.function">
318<tt class="descname">function</tt><big>(</big><em>x=0.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_p1_p2.html#Model.function"><span class="viewcode-link">[source]</span></a></dt>
319<dd></dd></dl>
320
321<dl class="method">
322<dt id="sas.perspectives.fitting.plugin_models.sum_p1_p2.Model.getParam">
323<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_p1_p2.html#Model.getParam"><span class="viewcode-link">[source]</span></a></dt>
324<dd><p>Set the value of a model parameter</p>
325<table class="docutils field-list" frame="void" rules="none">
326<col class="field-name" />
327<col class="field-body" />
328<tbody valign="top">
329<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
330</tr>
331</tbody>
332</table>
333</dd></dl>
334
335<dl class="method">
336<dt id="sas.perspectives.fitting.plugin_models.sum_p1_p2.Model.getProfile">
337<tt class="descname">getProfile</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_p1_p2.html#Model.getProfile"><span class="viewcode-link">[source]</span></a></dt>
338<dd><p>Get SLD profile of p_model if exists</p>
339<dl class="docutils">
340<dt>: return: (r, beta) where r is a list of radius of the transition points</dt>
341<dd>beta is a list of the corresponding SLD values</dd>
342<dt>: Note: This works only for func_shell# = 2 (exp function)</dt>
343<dd>and is not supporting for p2</dd>
344</dl>
345</dd></dl>
346
347<dl class="method">
348<dt id="sas.perspectives.fitting.plugin_models.sum_p1_p2.Model.get_fname">
349<tt class="descname">get_fname</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_p1_p2.html#Model.get_fname"><span class="viewcode-link">[source]</span></a></dt>
350<dd><p>Get the model name same as the file name</p>
351</dd></dl>
352
353<dl class="attribute">
354<dt id="sas.perspectives.fitting.plugin_models.sum_p1_p2.Model.name">
355<tt class="descname">name</tt><em class="property"> = ''</em></dt>
356<dd></dd></dl>
357
358<dl class="method">
359<dt id="sas.perspectives.fitting.plugin_models.sum_p1_p2.Model.run">
360<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_p1_p2.html#Model.run"><span class="viewcode-link">[source]</span></a></dt>
361<dd><p>Evaluate the model</p>
362<table class="docutils field-list" frame="void" rules="none">
363<col class="field-name" />
364<col class="field-body" />
365<tbody valign="top">
366<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q-value (float or [float, float] as [r, theta])</td>
367</tr>
368<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">(scattering function value)</td>
369</tr>
370</tbody>
371</table>
372</dd></dl>
373
374<dl class="method">
375<dt id="sas.perspectives.fitting.plugin_models.sum_p1_p2.Model.runXY">
376<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_p1_p2.html#Model.runXY"><span class="viewcode-link">[source]</span></a></dt>
377<dd><p>Evaluate the model</p>
378<table class="docutils field-list" frame="void" rules="none">
379<col class="field-name" />
380<col class="field-body" />
381<tbody valign="top">
382<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q-value (float or [float, float] as [qx, qy])</td>
383</tr>
384<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function value</td>
385</tr>
386</tbody>
387</table>
388</dd></dl>
389
390<dl class="method">
391<dt id="sas.perspectives.fitting.plugin_models.sum_p1_p2.Model.setParam">
392<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_p1_p2.html#Model.setParam"><span class="viewcode-link">[source]</span></a></dt>
393<dd><p>Set the value of a model parameter</p>
394<table class="docutils field-list" frame="void" rules="none">
395<col class="field-name" />
396<col class="field-body" />
397<tbody valign="top">
398<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
399<li><strong>name</strong> &#8211; name of the parameter</li>
400<li><strong>value</strong> &#8211; value of the parameter</li>
401</ul>
402</td>
403</tr>
404</tbody>
405</table>
406</dd></dl>
407
408<dl class="method">
409<dt id="sas.perspectives.fitting.plugin_models.sum_p1_p2.Model.set_dispersion">
410<tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/sum_p1_p2.html#Model.set_dispersion"><span class="viewcode-link">[source]</span></a></dt>
411<dd><p>Set the dispersion object for a model parameter</p>
412<table class="docutils field-list" frame="void" rules="none">
413<col class="field-name" />
414<col class="field-body" />
415<tbody valign="top">
416<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>parameter</strong> &#8211; name of the parameter [string]</td>
417</tr>
418<tr class="field-even field"><th class="field-name">Dispersion:</th><td class="field-body">dispersion object of type DispersionModel</td>
419</tr>
420</tbody>
421</table>
422</dd></dl>
423
424</dd></dl>
425
426</div>
427<div class="section" id="module-sas.perspectives.fitting.plugin_models.testmodel">
428<span id="sas-perspectives-fitting-plugin-models-testmodel-module"></span><h2>sas.perspectives.fitting.plugin_models.testmodel module</h2>
429<p>Test plug-in model
430These are links of available functions:</p>
431<p><a class="reference external" href="http://docs.python.org/library/math.html">http://docs.python.org/library/math.html</a>
432<a class="reference external" href="http://www.scipy.org/Numpy_Functions_by_Category">http://www.scipy.org/Numpy_Functions_by_Category</a></p>
433<dl class="class">
434<dt id="sas.perspectives.fitting.plugin_models.testmodel.Model">
435<em class="property">class </em><tt class="descclassname">sas.perspectives.fitting.plugin_models.testmodel.</tt><tt class="descname">Model</tt><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/testmodel.html#Model"><span class="viewcode-link">[source]</span></a></dt>
436<dd><p>Bases: <a class="reference internal" href="sas.models.html#sas.models.pluginmodel.Model1DPlugin" title="sas.models.pluginmodel.Model1DPlugin"><tt class="xref py py-class docutils literal"><span class="pre">sas.models.pluginmodel.Model1DPlugin</span></tt></a></p>
437<p>##YOU CAN BE MODIFY ANYTHING BETWEEN
438##DESCRIPTION OF MODEL PLUG-IN GOES HERE</p>
439<p>##EXAMPLE:Class that evaluates a cos(x) model.</p>
440<dl class="method">
441<dt id="sas.perspectives.fitting.plugin_models.testmodel.Model.function">
442<tt class="descname">function</tt><big>(</big><em>x=0.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/testmodel.html#Model.function"><span class="viewcode-link">[source]</span></a></dt>
443<dd><p>Evaluate the model</p>
444<table class="docutils field-list" frame="void" rules="none">
445<col class="field-name" />
446<col class="field-body" />
447<tbody valign="top">
448<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input x</td>
449</tr>
450<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">function value</td>
451</tr>
452</tbody>
453</table>
454</dd></dl>
455
456<dl class="method">
457<dt id="sas.perspectives.fitting.plugin_models.testmodel.Model.get_fname">
458<tt class="descname">get_fname</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/testmodel.html#Model.get_fname"><span class="viewcode-link">[source]</span></a></dt>
459<dd><p>Get the model name same as the file name</p>
460</dd></dl>
461
462<dl class="attribute">
463<dt id="sas.perspectives.fitting.plugin_models.testmodel.Model.name">
464<tt class="descname">name</tt><em class="property"> = ''</em></dt>
465<dd></dd></dl>
466
467</dd></dl>
468
469</div>
470<div class="section" id="module-sas.perspectives.fitting.plugin_models.testmodel_2">
471<span id="sas-perspectives-fitting-plugin-models-testmodel-2-module"></span><h2>sas.perspectives.fitting.plugin_models.testmodel_2 module</h2>
472<p>Test plug-in model
473These are links of available functions:</p>
474<p><a class="reference external" href="http://docs.python.org/library/math.html">http://docs.python.org/library/math.html</a>
475<a class="reference external" href="http://www.scipy.org/Numpy_Functions_by_Category">http://www.scipy.org/Numpy_Functions_by_Category</a></p>
476<dl class="class">
477<dt id="sas.perspectives.fitting.plugin_models.testmodel_2.Model">
478<em class="property">class </em><tt class="descclassname">sas.perspectives.fitting.plugin_models.testmodel_2.</tt><tt class="descname">Model</tt><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/testmodel_2.html#Model"><span class="viewcode-link">[source]</span></a></dt>
479<dd><p>Bases: <a class="reference internal" href="sas.models.html#sas.models.pluginmodel.Model1DPlugin" title="sas.models.pluginmodel.Model1DPlugin"><tt class="xref py py-class docutils literal"><span class="pre">sas.models.pluginmodel.Model1DPlugin</span></tt></a></p>
480<p>##YOU CAN BE MODIFY ANYTHING BETWEEN
481##DESCRIPTION OF MODEL PLUG-IN GOES HERE</p>
482<p>##EXAMPLE: Class that evaluates a polynomial model.</p>
483<dl class="method">
484<dt id="sas.perspectives.fitting.plugin_models.testmodel_2.Model.function">
485<tt class="descname">function</tt><big>(</big><em>x=0.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/testmodel_2.html#Model.function"><span class="viewcode-link">[source]</span></a></dt>
486<dd><p>Evaluate the model</p>
487<table class="docutils field-list" frame="void" rules="none">
488<col class="field-name" />
489<col class="field-body" />
490<tbody valign="top">
491<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input x</td>
492</tr>
493<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">function value</td>
494</tr>
495</tbody>
496</table>
497</dd></dl>
498
499<dl class="method">
500<dt id="sas.perspectives.fitting.plugin_models.testmodel_2.Model.get_fname">
501<tt class="descname">get_fname</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/perspectives/fitting/plugin_models/testmodel_2.html#Model.get_fname"><span class="viewcode-link">[source]</span></a></dt>
502<dd><p>Get the model name same as the file name</p>
503</dd></dl>
504
505<dl class="attribute">
506<dt id="sas.perspectives.fitting.plugin_models.testmodel_2.Model.name">
507<tt class="descname">name</tt><em class="property"> = ''</em></dt>
508<dd></dd></dl>
509
510</dd></dl>
511
512</div>
513<div class="section" id="module-sas.perspectives.fitting.plugin_models">
514<span id="module-contents"></span><h2>Module contents</h2>
515</div>
516</div>
517
518
519          </div>
520        </div>
521      </div>
522      <div class="sphinxsidebar">
523        <div class="sphinxsidebarwrapper">
524  <h3><a href="../../index.html">Table Of Contents</a></h3>
525  <ul>
526<li><a class="reference internal" href="#">sas.perspectives.fitting.plugin_models package</a><ul>
527<li><a class="reference internal" href="#submodules">Submodules</a></li>
528<li><a class="reference internal" href="#module-sas.perspectives.fitting.plugin_models.polynomial5">sas.perspectives.fitting.plugin_models.polynomial5 module</a></li>
529<li><a class="reference internal" href="#module-sas.perspectives.fitting.plugin_models.sph_bessel_jn">sas.perspectives.fitting.plugin_models.sph_bessel_jn module</a></li>
530<li><a class="reference internal" href="#module-sas.perspectives.fitting.plugin_models.sum_Ap1_1_Ap2">sas.perspectives.fitting.plugin_models.sum_Ap1_1_Ap2 module</a></li>
531<li><a class="reference internal" href="#module-sas.perspectives.fitting.plugin_models.sum_p1_p2">sas.perspectives.fitting.plugin_models.sum_p1_p2 module</a></li>
532<li><a class="reference internal" href="#module-sas.perspectives.fitting.plugin_models.testmodel">sas.perspectives.fitting.plugin_models.testmodel module</a></li>
533<li><a class="reference internal" href="#module-sas.perspectives.fitting.plugin_models.testmodel_2">sas.perspectives.fitting.plugin_models.testmodel_2 module</a></li>
534<li><a class="reference internal" href="#module-sas.perspectives.fitting.plugin_models">Module contents</a></li>
535</ul>
536</li>
537</ul>
538
539  <h4>Previous topic</h4>
540  <p class="topless"><a href="sas.perspectives.fitting.html"
541                        title="previous chapter">sas.perspectives.fitting package</a></p>
542  <h4>Next topic</h4>
543  <p class="topless"><a href="sas.perspectives.invariant.html"
544                        title="next chapter">sas.perspectives.invariant package</a></p>
545  <h3>This Page</h3>
546  <ul class="this-page-menu">
547    <li><a href="../../_sources/dev/api/sas.perspectives.fitting.plugin_models.txt"
548           rel="nofollow">Show Source</a></li>
549  </ul>
550<div id="searchbox" style="display: none">
551  <h3>Quick search</h3>
552    <form class="search" action="../../search.html" method="get">
553      <input type="text" name="q" />
554      <input type="submit" value="Go" />
555      <input type="hidden" name="check_keywords" value="yes" />
556      <input type="hidden" name="area" value="default" />
557    </form>
558    <p class="searchtip" style="font-size: 90%">
559    Enter search terms or a module, class or function name.
560    </p>
561</div>
562<script type="text/javascript">$('#searchbox').show(0);</script>
563        </div>
564      </div>
565      <div class="clearer"></div>
566    </div>
567    <div class="related">
568      <h3>Navigation</h3>
569      <ul>
570        <li class="right" style="margin-right: 10px">
571          <a href="../../genindex.html" title="General Index"
572             >index</a></li>
573        <li class="right" >
574          <a href="../../py-modindex.html" title="Python Module Index"
575             >modules</a> |</li>
576        <li class="right" >
577          <a href="sas.perspectives.invariant.html" title="sas.perspectives.invariant package"
578             >next</a> |</li>
579        <li class="right" >
580          <a href="sas.perspectives.fitting.html" title="sas.perspectives.fitting package"
581             >previous</a> |</li>
582        <li><a href="../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
583          <li><a href="../dev.html" >Developer Documentation</a> &raquo;</li>
584          <li><a href="modules.html" >lib.macosx-10.5-x86_64-2.7</a> &raquo;</li>
585          <li><a href="sas.html" >sas package</a> &raquo;</li>
586          <li><a href="sas.perspectives.html" >sas.perspectives package</a> &raquo;</li>
587          <li><a href="sas.perspectives.fitting.html" >sas.perspectives.fitting package</a> &raquo;</li> 
588      </ul>
589    </div>
590    <div class="footer">
591        &copy; Copyright 2013, The SasView Project.
592      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
593    </div>
594  </body>
595</html>
Note: See TracBrowser for help on using the repository browser.