source: sasview/sansmodels/docs/sphinx/_build/html/api/FractalAbsModel.html @ 79ac6f8

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 79ac6f8 was 79ac6f8, checked in by Gervaise Alina <gervyh@…>, 15 years ago

working on documentation
  • Property mode set to 100644
File size: 15.6 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>FractalAbsModel &mdash; sansmodels v0.1.0 documentation</title>
11    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13    <script type="text/javascript">
14      var DOCUMENTATION_OPTIONS = {
15        URL_ROOT:    '../',
16        VERSION:     '0.1.0',
17        COLLAPSE_INDEX: false,
18        FILE_SUFFIX: '.html',
19        HAS_SOURCE:  true
20      };
21    </script>
22    <script type="text/javascript" src="../_static/jquery.js"></script>
23    <script type="text/javascript" src="../_static/underscore.js"></script>
24    <script type="text/javascript" src="../_static/doctools.js"></script>
25    <link rel="top" title="sansmodels v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="next" title="FractalModel" href="FractalModel.html" />
28    <link rel="prev" title="FlexibleCylinderModel" href="FlexibleCylinderModel.html" /> 
29  </head>
30  <body>
31    <div class="related">
32      <h3>Navigation</h3>
33      <ul>
34        <li class="right" style="margin-right: 10px">
35          <a href="../genindex.html" title="General Index"
36             accesskey="I">index</a></li>
37        <li class="right" >
38          <a href="../py-modindex.html" title="Python Module Index"
39             >modules</a> |</li>
40        <li class="right" >
41          <a href="FractalModel.html" title="FractalModel"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="FlexibleCylinderModel.html" title="FlexibleCylinderModel"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
47          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
48      </ul>
49    </div> 
50
51    <div class="document">
52      <div class="documentwrapper">
53        <div class="bodywrapper">
54          <div class="body">
55           
56  <div class="section" id="fractalabsmodel">
57<h1>FractalAbsModel<a class="headerlink" href="#fractalabsmodel" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.FractalAbsModel">
59<span id="sans-models-fractalabsmodel"></span><h2><a class="reference internal" href="#module-sans.models.FractalAbsModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.FractalAbsModel</span></tt></a><a class="headerlink" href="#module-sans.models.FractalAbsModel" title="Permalink to this headline">¶</a></h2>
60<p>Provide F(x)= P(<a href="#id1"><span class="problematic" id="id2">|x|</span></a>)*S(<a href="#id3"><span class="problematic" id="id4">|x|</span></a>) + bkd
61Fractal as a BaseComponent model</p>
62<dl class="class">
63<dt id="sans.models.FractalAbsModel.FractalAbsModel">
64<em class="property">class </em><tt class="descclassname">sans.models.FractalAbsModel.</tt><tt class="descname">FractalAbsModel</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel" title="Permalink to this definition">¶</a></dt>
65<dd><p>Bases: <a class="reference internal" href="FractalModel.html#sans.models.FractalModel.FractalModel" title="sans.models.FractalModel.FractalModel"><tt class="xref py py-class docutils literal"><span class="pre">sans.models.FractalModel.FractalModel</span></tt></a></p>
66<p>Class that evaluates a Fractal function.</p>
67<p>F(<a href="#id5"><span class="problematic" id="id6">|x|</span></a>)= P(<a href="#id7"><span class="problematic" id="id8">|x|</span></a>)*S(<a href="#id9"><span class="problematic" id="id10">|x|</span></a>) + bkd
68The model has Seven parameters:</p>
69<blockquote>
70scale        =  Volume fraction
71radius       =  Block radius
72fractal_dim  =  Fractal dimension
73corr_length  =  correlation Length
74block_sld    =  SDL block
75solvent_sld  =  SDL solvent
76background   =  background</blockquote>
77<dl class="method">
78<dt id="sans.models.FractalAbsModel.FractalAbsModel.calculate_ER">
79<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.calculate_ER" title="Permalink to this definition">¶</a></dt>
80<dd><p>Calculate the effective radius for P(q)*S(q)</p>
81<table class="docutils field-list" frame="void" rules="none">
82<col class="field-name" />
83<col class="field-body" />
84<tbody valign="top">
85<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td>
86</tr>
87</tbody>
88</table>
89</dd></dl>
90
91<dl class="method">
92<dt id="sans.models.FractalAbsModel.FractalAbsModel.clone">
93<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.clone" title="Permalink to this definition">¶</a></dt>
94<dd>Return a identical copy of self</dd></dl>
95
96<dl class="attribute">
97<dt id="sans.models.FractalAbsModel.FractalAbsModel.dispersion">
98<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.dispersion" title="Permalink to this definition">¶</a></dt>
99<dd>Dispersion parameters</dd></dl>
100
101<dl class="method">
102<dt id="sans.models.FractalAbsModel.FractalAbsModel.evalDistribution">
103<tt class="descname">evalDistribution</tt><big>(</big><em>x=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
104<dd><p>Evaluate the model in cartesian coordinates</p>
105<table class="docutils field-list" frame="void" rules="none">
106<col class="field-name" />
107<col class="field-body" />
108<tbody valign="top">
109<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
110<li><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</li>
111</ul>
112</td>
113</tr>
114<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">scattering function P(q[])</p>
115</td>
116</tr>
117</tbody>
118</table>
119</dd></dl>
120
121<dl class="method">
122<dt id="sans.models.FractalAbsModel.FractalAbsModel.getDispParamList">
123<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.getDispParamList" title="Permalink to this definition">¶</a></dt>
124<dd>Return a list of all available parameters for the model</dd></dl>
125
126<dl class="method">
127<dt id="sans.models.FractalAbsModel.FractalAbsModel.getParam">
128<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.getParam" title="Permalink to this definition">¶</a></dt>
129<dd><p>Set the value of a model parameter</p>
130<table class="docutils field-list" frame="void" rules="none">
131<col class="field-name" />
132<col class="field-body" />
133<tbody valign="top">
134<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
135<li><strong>name</strong> &#8211; name of the parameter</li>
136</ul>
137</td>
138</tr>
139</tbody>
140</table>
141</dd></dl>
142
143<dl class="method">
144<dt id="sans.models.FractalAbsModel.FractalAbsModel.getParamList">
145<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.getParamList" title="Permalink to this definition">¶</a></dt>
146<dd>Return a list of all available parameters for the model</dd></dl>
147
148<dl class="method">
149<dt id="sans.models.FractalAbsModel.FractalAbsModel.getParamListWithToken">
150<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
151<dd></dd></dl>
152
153<dl class="method">
154<dt id="sans.models.FractalAbsModel.FractalAbsModel.getParamWithToken">
155<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
156<dd></dd></dl>
157
158<dl class="method">
159<dt id="sans.models.FractalAbsModel.FractalAbsModel.is_fittable">
160<tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.is_fittable" title="Permalink to this definition">¶</a></dt>
161<dd><p>Check if a given parameter is fittable or not</p>
162<table class="docutils field-list" frame="void" rules="none">
163<col class="field-name" />
164<col class="field-body" />
165<tbody valign="top">
166<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
167<li><strong>par_name</strong> &#8211; the parameter name to check</li>
168</ul>
169</td>
170</tr>
171</tbody>
172</table>
173</dd></dl>
174
175<dl class="attribute">
176<dt id="sans.models.FractalAbsModel.FractalAbsModel.log">
177<tt class="descname">log</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.log" title="Permalink to this definition">¶</a></dt>
178<dd>Log</dd></dl>
179
180<dl class="attribute">
181<dt id="sans.models.FractalAbsModel.FractalAbsModel.params">
182<tt class="descname">params</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.params" title="Permalink to this definition">¶</a></dt>
183<dd>Parameters</dd></dl>
184
185<dl class="attribute">
186<dt id="sans.models.FractalAbsModel.FractalAbsModel.reset">
187<tt class="descname">reset</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.reset" title="Permalink to this definition">¶</a></dt>
188<dd>Reset pair correlation</dd></dl>
189
190<dl class="method">
191<dt id="sans.models.FractalAbsModel.FractalAbsModel.run">
192<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.run" title="Permalink to this definition">¶</a></dt>
193<dd><p>Evaluate the model</p>
194<table class="docutils field-list" frame="void" rules="none">
195<col class="field-name" />
196<col class="field-body" />
197<tbody valign="top">
198<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
199<li><strong>x</strong> &#8211; input q, or [q,phi]</li>
200</ul>
201</td>
202</tr>
203<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">scattering function P(q)</p>
204</td>
205</tr>
206</tbody>
207</table>
208</dd></dl>
209
210<dl class="method">
211<dt id="sans.models.FractalAbsModel.FractalAbsModel.runXY">
212<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.runXY" title="Permalink to this definition">¶</a></dt>
213<dd><p>Evaluate the model in cartesian coordinates</p>
214<table class="docutils field-list" frame="void" rules="none">
215<col class="field-name" />
216<col class="field-body" />
217<tbody valign="top">
218<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
219<li><strong>x</strong> &#8211; input q, or [qx, qy]</li>
220</ul>
221</td>
222</tr>
223<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">scattering function P(q)</p>
224</td>
225</tr>
226</tbody>
227</table>
228</dd></dl>
229
230<dl class="method">
231<dt id="sans.models.FractalAbsModel.FractalAbsModel.setParam">
232<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.setParam" title="Permalink to this definition">¶</a></dt>
233<dd><p>Set the value of a model parameter</p>
234<table class="docutils field-list" frame="void" rules="none">
235<col class="field-name" />
236<col class="field-body" />
237<tbody valign="top">
238<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
239<li><strong>name</strong> &#8211; name of the parameter</li>
240<li><strong>value</strong> &#8211; value of the parameter</li>
241</ul>
242</td>
243</tr>
244</tbody>
245</table>
246</dd></dl>
247
248<dl class="method">
249<dt id="sans.models.FractalAbsModel.FractalAbsModel.setParamWithToken">
250<tt class="descname">setParamWithToken</tt><big>(</big><em>name</em>, <em>value</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
251<dd></dd></dl>
252
253<dl class="method">
254<dt id="sans.models.FractalAbsModel.FractalAbsModel.set_dispersion">
255<tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
256<dd><p>Set the dispersion object for a model parameter</p>
257<table class="docutils field-list" frame="void" rules="none">
258<col class="field-name" />
259<col class="field-body" />
260<tbody valign="top">
261<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
262<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
263<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
264</ul>
265</td>
266</tr>
267</tbody>
268</table>
269</dd></dl>
270
271</dd></dl>
272
273</div>
274</div>
275
276
277          </div>
278        </div>
279      </div>
280      <div class="sphinxsidebar">
281        <div class="sphinxsidebarwrapper">
282  <h3><a href="../index.html">Table Of Contents</a></h3>
283  <ul>
284<li><a class="reference internal" href="#">FractalAbsModel</a><ul>
285<li><a class="reference internal" href="#module-sans.models.FractalAbsModel"><tt class="docutils literal"><span class="pre">sans.models.FractalAbsModel</span></tt></a></li>
286</ul>
287</li>
288</ul>
289
290  <h4>Previous topic</h4>
291  <p class="topless"><a href="FlexibleCylinderModel.html"
292                        title="previous chapter">FlexibleCylinderModel</a></p>
293  <h4>Next topic</h4>
294  <p class="topless"><a href="FractalModel.html"
295                        title="next chapter">FractalModel</a></p>
296  <h3>This Page</h3>
297  <ul class="this-page-menu">
298    <li><a href="../_sources/api/FractalAbsModel.txt"
299           rel="nofollow">Show Source</a></li>
300  </ul>
301<div id="searchbox" style="display: none">
302  <h3>Quick search</h3>
303    <form class="search" action="../search.html" method="get">
304      <input type="text" name="q" size="18" />
305      <input type="submit" value="Go" />
306      <input type="hidden" name="check_keywords" value="yes" />
307      <input type="hidden" name="area" value="default" />
308    </form>
309    <p class="searchtip" style="font-size: 90%">
310    Enter search terms or a module, class or function name.
311    </p>
312</div>
313<script type="text/javascript">$('#searchbox').show(0);</script>
314        </div>
315      </div>
316      <div class="clearer"></div>
317    </div>
318    <div class="related">
319      <h3>Navigation</h3>
320      <ul>
321        <li class="right" style="margin-right: 10px">
322          <a href="../genindex.html" title="General Index"
323             >index</a></li>
324        <li class="right" >
325          <a href="../py-modindex.html" title="Python Module Index"
326             >modules</a> |</li>
327        <li class="right" >
328          <a href="FractalModel.html" title="FractalModel"
329             >next</a> |</li>
330        <li class="right" >
331          <a href="FlexibleCylinderModel.html" title="FlexibleCylinderModel"
332             >previous</a> |</li>
333        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
334          <li><a href="index.html" >Reference</a> &raquo;</li> 
335      </ul>
336    </div>
337    <div class="footer">
338        &copy; Copyright 2010, sans group.
339      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
340    </div>
341  </body>
342</html>
Note: See TracBrowser for help on using the repository browser.