source: sasview/sansmodels/docs/sphinx/html/api/FractalCoreShellModel.html @ 650fd318

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

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 13.7 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>FractalCoreShellModel &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="FractalAbsModel" href="FractalAbsModel.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="FractalAbsModel.html" title="FractalAbsModel"
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="fractalcoreshellmodel">
57<h1>FractalCoreShellModel<a class="headerlink" href="#fractalcoreshellmodel" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.FractalCoreShellModel">
59<span id="sans-models-fractalcoreshellmodel"></span><h2><a class="reference internal" href="#module-sans.models.FractalCoreShellModel" title="sans.models.FractalCoreShellModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.FractalCoreShellModel</span></tt></a><a class="headerlink" href="#module-sans.models.FractalCoreShellModel" title="Permalink to this headline">¶</a></h2>
60<dl class="class">
61<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel">
62<em class="property">class </em><tt class="descclassname">sans.models.FractalCoreShellModel.</tt><tt class="descname">FractalCoreShellModel</tt><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel" title="Permalink to this definition">¶</a></dt>
63<dd><p>Bases: <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>
64<p>Class that evaluates a FractalCoreShellModel
65List of default parameters:
66volfraction     = 0.05
67radius          = 20.0 [A]
68thickness       = 5.0 [A]
69frac_dim        = 2.0
70cor_length      = 100 [A]
71core_sld        = 3.5e-006 [1/A^(2)]
72shell_sld       = 1.0e-006 [1/A^(2)]
73solvent_sld     = 6.35e-006 [1/A^(2)]
74background      = 0.0 [1/cm]</p>
75<dl class="method">
76<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.calculate_ER">
77<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.calculate_ER" title="Permalink to this definition">¶</a></dt>
78<dd></dd></dl>
79
80<dl class="method">
81<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.clone">
82<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.clone" title="Permalink to this definition">¶</a></dt>
83<dd><p>Returns a new object identical to the current object</p>
84</dd></dl>
85
86<dl class="method">
87<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.evalDistribution">
88<tt class="descname">evalDistribution</tt><big>(</big><em>qdist</em><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
89<dd><p>Evaluate a distribution of q-values.</p>
90<ul>
91<li><p class="first">For 1D, a numpy array is expected as input:</p>
92<blockquote>
93<div><p>evalDistribution(q)</p>
94</div></blockquote>
95</li>
96</ul>
97<p>where q is a numpy array.</p>
98<ul class="simple">
99<li>For 2D, a list of numpy arrays are expected: [qx_prime,qy_prime],
100where 1D arrays,</li>
101</ul>
102<p>qx_prime = [ qx[0], qx[1], qx[2], ....]
103and
104qy_prime = [ qy[0], qy[1], qy[2], ....]</p>
105<p>Then get
106q = numpy.sqrt(qx_prime^2+qy_prime^2)</p>
107<p>that is a qr in 1D array;
108q = [q[0], q[1], q[2], ....]</p>
109<table class="docutils field-list" frame="void" rules="none">
110<col class="field-name" />
111<col class="field-body" />
112<tbody valign="top">
113<tr class="field"><th class="field-name">Note :</th><td class="field-body"><p class="first">Due to 2D speed issue, no anisotropic scattering
114is supported for python models, thus C-models should have</p>
115<blockquote class="last">
116<div><p>their own evalDistribution methods.</p>
117</div></blockquote>
118</td>
119</tr>
120</tbody>
121</table>
122<p>The method is then called the following way:</p>
123<p>evalDistribution(q)
124where q is a numpy array.</p>
125<table class="docutils field-list" frame="void" rules="none">
126<col class="field-name" />
127<col class="field-body" />
128<tbody valign="top">
129<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>qdist</strong> &#8211; ndarray of scalar q-values or list [qx,qy]
130where qx,qy are 1D ndarrays</td>
131</tr>
132</tbody>
133</table>
134</dd></dl>
135
136<dl class="method">
137<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.getDispParamList">
138<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.getDispParamList" title="Permalink to this definition">¶</a></dt>
139<dd><p>Return a list of all available parameters for the model</p>
140</dd></dl>
141
142<dl class="method">
143<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.getParam">
144<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.getParam" title="Permalink to this definition">¶</a></dt>
145<dd><p>Set the value of a model parameter</p>
146<table class="docutils field-list" frame="void" rules="none">
147<col class="field-name" />
148<col class="field-body" />
149<tbody valign="top">
150<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
151</tr>
152</tbody>
153</table>
154</dd></dl>
155
156<dl class="method">
157<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.getParamList">
158<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.getParamList" title="Permalink to this definition">¶</a></dt>
159<dd><p>Return a list of all available parameters for the model</p>
160</dd></dl>
161
162<dl class="method">
163<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.getParamListWithToken">
164<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
165<dd></dd></dl>
166
167<dl class="method">
168<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.getParamWithToken">
169<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
170<dd></dd></dl>
171
172<dl class="method">
173<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.is_fittable">
174<tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.is_fittable" title="Permalink to this definition">¶</a></dt>
175<dd><p>Check if a given parameter is fittable or not</p>
176<table class="docutils field-list" frame="void" rules="none">
177<col class="field-name" />
178<col class="field-body" />
179<tbody valign="top">
180<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td>
181</tr>
182</tbody>
183</table>
184</dd></dl>
185
186<dl class="method">
187<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.run">
188<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.run" title="Permalink to this definition">¶</a></dt>
189<dd><p>Evaluate the model</p>
190<p>: param x: input q-value (float or [float, float] as [r, theta])
191: return: (DAB value)</p>
192</dd></dl>
193
194<dl class="method">
195<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.runXY">
196<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.runXY" title="Permalink to this definition">¶</a></dt>
197<dd><p>Evaluate the model</p>
198<p>: param x: input q-value (float or [float, float] as [qx, qy])
199: return: DAB value</p>
200</dd></dl>
201
202<dl class="method">
203<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.setParam">
204<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.setParam" title="Permalink to this definition">¶</a></dt>
205<dd><p>Set the value of a model parameter</p>
206<p>: param name: name of the parameter
207: param value: value of the parameter</p>
208</dd></dl>
209
210<dl class="method">
211<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.setParamWithToken">
212<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.FractalCoreShellModel.FractalCoreShellModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
213<dd></dd></dl>
214
215<dl class="method">
216<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.set_dispersion">
217<tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
218<dd><p>Set the dispersion object for a model parameter</p>
219<p>: param parameter: name of the parameter [string]
220:dispersion: dispersion object of type DispersionModel</p>
221</dd></dl>
222
223</dd></dl>
224
225</div>
226</div>
227
228
229          </div>
230        </div>
231      </div>
232      <div class="sphinxsidebar">
233        <div class="sphinxsidebarwrapper">
234  <h3><a href="../index.html">Table Of Contents</a></h3>
235  <ul>
236<li><a class="reference internal" href="#">FractalCoreShellModel</a><ul>
237<li><a class="reference internal" href="#module-sans.models.FractalCoreShellModel"><tt class="docutils literal"><span class="pre">sans.models.FractalCoreShellModel</span></tt></a></li>
238</ul>
239</li>
240</ul>
241
242  <h4>Previous topic</h4>
243  <p class="topless"><a href="FractalAbsModel.html"
244                        title="previous chapter">FractalAbsModel</a></p>
245  <h4>Next topic</h4>
246  <p class="topless"><a href="FractalModel.html"
247                        title="next chapter">FractalModel</a></p>
248  <h3>This Page</h3>
249  <ul class="this-page-menu">
250    <li><a href="../_sources/api/FractalCoreShellModel.txt"
251           rel="nofollow">Show Source</a></li>
252  </ul>
253<div id="searchbox" style="display: none">
254  <h3>Quick search</h3>
255    <form class="search" action="../search.html" method="get">
256      <input type="text" name="q" size="18" />
257      <input type="submit" value="Go" />
258      <input type="hidden" name="check_keywords" value="yes" />
259      <input type="hidden" name="area" value="default" />
260    </form>
261    <p class="searchtip" style="font-size: 90%">
262    Enter search terms or a module, class or function name.
263    </p>
264</div>
265<script type="text/javascript">$('#searchbox').show(0);</script>
266        </div>
267      </div>
268      <div class="clearer"></div>
269    </div>
270    <div class="related">
271      <h3>Navigation</h3>
272      <ul>
273        <li class="right" style="margin-right: 10px">
274          <a href="../genindex.html" title="General Index"
275             >index</a></li>
276        <li class="right" >
277          <a href="../py-modindex.html" title="Python Module Index"
278             >modules</a> |</li>
279        <li class="right" >
280          <a href="FractalModel.html" title="FractalModel"
281             >next</a> |</li>
282        <li class="right" >
283          <a href="FractalAbsModel.html" title="FractalAbsModel"
284             >previous</a> |</li>
285        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
286          <li><a href="index.html" >Reference</a> &raquo;</li> 
287      </ul>
288    </div>
289    <div class="footer">
290        &copy; Copyright 2010, sans group.
291      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
292    </div>
293  </body>
294</html>
Note: See TracBrowser for help on using the repository browser.