source: sasview/sansmodels/docs/sphinx/html/api/FractalAbsModel.html @ 6b3edc1

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 6b3edc1 was 512573a, checked in by Jessica Tumarkin <jtumarki@…>, 13 years ago

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 15.5 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="FractalCoreShellModel" href="FractalCoreShellModel.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="FractalCoreShellModel.html" title="FractalCoreShellModel"
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" title="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>
70<div>scale        =  Volume fraction
71radius       =  Block radius
72fractal_dim  =  Fractal dimension
73corr_length  =  correlation Length
74block_sld    =  SDL block
75solvent_sld  =  SDL solvent
76background   =  background</div></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><p>Return a identical copy of self</p>
95</dd></dl>
96
97<dl class="attribute">
98<dt id="sans.models.FractalAbsModel.FractalAbsModel.dispersion">
99<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.dispersion" title="Permalink to this definition">¶</a></dt>
100<dd><p>Dispersion parameters</p>
101</dd></dl>
102
103<dl class="method">
104<dt id="sans.models.FractalAbsModel.FractalAbsModel.evalDistribution">
105<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>
106<dd><p>Evaluate the model in cartesian coordinates</p>
107<table class="docutils field-list" frame="void" rules="none">
108<col class="field-name" />
109<col class="field-body" />
110<tbody valign="top">
111<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td>
112</tr>
113<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td>
114</tr>
115</tbody>
116</table>
117</dd></dl>
118
119<dl class="method">
120<dt id="sans.models.FractalAbsModel.FractalAbsModel.getDispParamList">
121<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>
122<dd><p>Return a list of all available parameters for the model</p>
123</dd></dl>
124
125<dl class="method">
126<dt id="sans.models.FractalAbsModel.FractalAbsModel.getParam">
127<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>
128<dd><p>Set the value of a model parameter</p>
129<table class="docutils field-list" frame="void" rules="none">
130<col class="field-name" />
131<col class="field-body" />
132<tbody valign="top">
133<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
134</tr>
135</tbody>
136</table>
137</dd></dl>
138
139<dl class="method">
140<dt id="sans.models.FractalAbsModel.FractalAbsModel.getParamList">
141<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>
142<dd><p>Return a list of all available parameters for the model</p>
143</dd></dl>
144
145<dl class="method">
146<dt id="sans.models.FractalAbsModel.FractalAbsModel.getParamListWithToken">
147<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>
148<dd></dd></dl>
149
150<dl class="method">
151<dt id="sans.models.FractalAbsModel.FractalAbsModel.getParamWithToken">
152<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>
153<dd></dd></dl>
154
155<dl class="method">
156<dt id="sans.models.FractalAbsModel.FractalAbsModel.is_fittable">
157<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>
158<dd><p>Check if a given parameter is fittable or not</p>
159<table class="docutils field-list" frame="void" rules="none">
160<col class="field-name" />
161<col class="field-body" />
162<tbody valign="top">
163<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td>
164</tr>
165</tbody>
166</table>
167</dd></dl>
168
169<dl class="attribute">
170<dt id="sans.models.FractalAbsModel.FractalAbsModel.log">
171<tt class="descname">log</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.log" title="Permalink to this definition">¶</a></dt>
172<dd><p>Log</p>
173</dd></dl>
174
175<dl class="attribute">
176<dt id="sans.models.FractalAbsModel.FractalAbsModel.params">
177<tt class="descname">params</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.params" title="Permalink to this definition">¶</a></dt>
178<dd><p>Parameters</p>
179</dd></dl>
180
181<dl class="attribute">
182<dt id="sans.models.FractalAbsModel.FractalAbsModel.reset">
183<tt class="descname">reset</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.reset" title="Permalink to this definition">¶</a></dt>
184<dd><p>Reset pair correlation</p>
185</dd></dl>
186
187<dl class="method">
188<dt id="sans.models.FractalAbsModel.FractalAbsModel.run">
189<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>
190<dd><p>Evaluate the model</p>
191<table class="docutils field-list" frame="void" rules="none">
192<col class="field-name" />
193<col class="field-body" />
194<tbody valign="top">
195<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td>
196</tr>
197<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
198</tr>
199</tbody>
200</table>
201</dd></dl>
202
203<dl class="method">
204<dt id="sans.models.FractalAbsModel.FractalAbsModel.runXY">
205<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>
206<dd><p>Evaluate the model in cartesian coordinates</p>
207<table class="docutils field-list" frame="void" rules="none">
208<col class="field-name" />
209<col class="field-body" />
210<tbody valign="top">
211<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td>
212</tr>
213<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
214</tr>
215</tbody>
216</table>
217</dd></dl>
218
219<dl class="method">
220<dt id="sans.models.FractalAbsModel.FractalAbsModel.setParam">
221<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>
222<dd><p>Set the value of a model parameter</p>
223<table class="docutils field-list" frame="void" rules="none">
224<col class="field-name" />
225<col class="field-body" />
226<tbody valign="top">
227<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
228<li><strong>name</strong> &#8211; name of the parameter</li>
229<li><strong>value</strong> &#8211; value of the parameter</li>
230</ul>
231</td>
232</tr>
233</tbody>
234</table>
235</dd></dl>
236
237<dl class="method">
238<dt id="sans.models.FractalAbsModel.FractalAbsModel.setParamWithToken">
239<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>
240<dd></dd></dl>
241
242<dl class="method">
243<dt id="sans.models.FractalAbsModel.FractalAbsModel.set_dispersion">
244<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>
245<dd><p>Set the dispersion object for a model parameter</p>
246<table class="docutils field-list" frame="void" rules="none">
247<col class="field-name" />
248<col class="field-body" />
249<tbody valign="top">
250<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
251<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
252<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
253</ul>
254</td>
255</tr>
256</tbody>
257</table>
258</dd></dl>
259
260</dd></dl>
261
262</div>
263</div>
264
265
266          </div>
267        </div>
268      </div>
269      <div class="sphinxsidebar">
270        <div class="sphinxsidebarwrapper">
271  <h3><a href="../index.html">Table Of Contents</a></h3>
272  <ul>
273<li><a class="reference internal" href="#">FractalAbsModel</a><ul>
274<li><a class="reference internal" href="#module-sans.models.FractalAbsModel"><tt class="docutils literal"><span class="pre">sans.models.FractalAbsModel</span></tt></a></li>
275</ul>
276</li>
277</ul>
278
279  <h4>Previous topic</h4>
280  <p class="topless"><a href="FlexibleCylinderModel.html"
281                        title="previous chapter">FlexibleCylinderModel</a></p>
282  <h4>Next topic</h4>
283  <p class="topless"><a href="FractalCoreShellModel.html"
284                        title="next chapter">FractalCoreShellModel</a></p>
285  <h3>This Page</h3>
286  <ul class="this-page-menu">
287    <li><a href="../_sources/api/FractalAbsModel.txt"
288           rel="nofollow">Show Source</a></li>
289  </ul>
290<div id="searchbox" style="display: none">
291  <h3>Quick search</h3>
292    <form class="search" action="../search.html" method="get">
293      <input type="text" name="q" size="18" />
294      <input type="submit" value="Go" />
295      <input type="hidden" name="check_keywords" value="yes" />
296      <input type="hidden" name="area" value="default" />
297    </form>
298    <p class="searchtip" style="font-size: 90%">
299    Enter search terms or a module, class or function name.
300    </p>
301</div>
302<script type="text/javascript">$('#searchbox').show(0);</script>
303        </div>
304      </div>
305      <div class="clearer"></div>
306    </div>
307    <div class="related">
308      <h3>Navigation</h3>
309      <ul>
310        <li class="right" style="margin-right: 10px">
311          <a href="../genindex.html" title="General Index"
312             >index</a></li>
313        <li class="right" >
314          <a href="../py-modindex.html" title="Python Module Index"
315             >modules</a> |</li>
316        <li class="right" >
317          <a href="FractalCoreShellModel.html" title="FractalCoreShellModel"
318             >next</a> |</li>
319        <li class="right" >
320          <a href="FlexibleCylinderModel.html" title="FlexibleCylinderModel"
321             >previous</a> |</li>
322        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
323          <li><a href="index.html" >Reference</a> &raquo;</li> 
324      </ul>
325    </div>
326    <div class="footer">
327        &copy; Copyright 2010, sans group.
328      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
329    </div>
330  </body>
331</html>
Note: See TracBrowser for help on using the repository browser.