source: sasview/sansmodels/docs/sphinx/html/api/BroadPeakModel.html @ cef2da8

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

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