source: sasview/sansmodels/docs/sphinx/html/api/BinaryHSModel.html @ 512573a

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

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 15.9 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>BinaryHSModel &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="BinaryHSPSF11Model" href="BinaryHSPSF11Model.html" />
28    <link rel="prev" title="BEPolyelectrolyte" href="BEPolyelectrolyte.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="BinaryHSPSF11Model.html" title="BinaryHSPSF11Model"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="BEPolyelectrolyte.html" title="BEPolyelectrolyte"
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="binaryhsmodel">
57<h1>BinaryHSModel<a class="headerlink" href="#binaryhsmodel" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.BinaryHSModel">
59<span id="sans-models-binaryhsmodel"></span><h2><a class="reference internal" href="#module-sans.models.BinaryHSModel" title="sans.models.BinaryHSModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.BinaryHSModel</span></tt></a><a class="headerlink" href="#module-sans.models.BinaryHSModel" title="Permalink to this headline">¶</a></h2>
60<p>Provide functionality for a C extension model</p>
61<table class="docutils field-list" frame="void" rules="none">
62<col class="field-name" />
63<col class="field-body" />
64<tbody valign="top">
65<tr class="field"><th class="field-name">WARNING:</th><td class="field-body">THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
66DO NOT MODIFY THIS FILE, MODIFY ..c_extensionsinaryHS.h
67AND RE-RUN THE GENERATOR SCRIPT</td>
68</tr>
69</tbody>
70</table>
71<dl class="class">
72<dt id="sans.models.BinaryHSModel.BinaryHSModel">
73<em class="property">class </em><tt class="descclassname">sans.models.BinaryHSModel.</tt><tt class="descname">BinaryHSModel</tt><a class="headerlink" href="#sans.models.BinaryHSModel.BinaryHSModel" title="Permalink to this definition">¶</a></dt>
74<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">CBinaryHSModel</span></tt>, <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>
75<p>Class that evaluates a BinaryHSModel model.
76This file was auto-generated from ..c_extensionsinaryHS.h.
77Refer to that file and the structure it contains
78for details of the model.
79List of default parameters:</p>
80<blockquote>
81<div>l_radius        = 100.0 [A]
82s_radius        = 25.0 [A]
83vol_frac_ls     = 0.1
84vol_frac_ss     = 0.2
85ls_sld          = 3.5e-06 [1/A^(2)]
86ss_sld          = 5e-07 [1/A^(2)]
87solvent_sld     = 6.36e-06 [1/A^(2)]
88background      = 0.001 [1/cm]</div></blockquote>
89<dl class="method">
90<dt id="sans.models.BinaryHSModel.BinaryHSModel.calculate_ER">
91<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BinaryHSModel.BinaryHSModel.calculate_ER" title="Permalink to this definition">¶</a></dt>
92<dd><p>Calculate the effective radius for P(q)*S(q)</p>
93<table class="docutils field-list" frame="void" rules="none">
94<col class="field-name" />
95<col class="field-body" />
96<tbody valign="top">
97<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td>
98</tr>
99</tbody>
100</table>
101</dd></dl>
102
103<dl class="method">
104<dt id="sans.models.BinaryHSModel.BinaryHSModel.clone">
105<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BinaryHSModel.BinaryHSModel.clone" title="Permalink to this definition">¶</a></dt>
106<dd><p>Return a identical copy of self</p>
107</dd></dl>
108
109<dl class="attribute">
110<dt id="sans.models.BinaryHSModel.BinaryHSModel.dispersion">
111<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.BinaryHSModel.BinaryHSModel.dispersion" title="Permalink to this definition">¶</a></dt>
112<dd><p>Dispersion parameters</p>
113</dd></dl>
114
115<dl class="method">
116<dt id="sans.models.BinaryHSModel.BinaryHSModel.evalDistribution">
117<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.BinaryHSModel.BinaryHSModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
118<dd><p>Evaluate the model in cartesian coordinates</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"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td>
124</tr>
125<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td>
126</tr>
127</tbody>
128</table>
129</dd></dl>
130
131<dl class="method">
132<dt id="sans.models.BinaryHSModel.BinaryHSModel.getDispParamList">
133<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BinaryHSModel.BinaryHSModel.getDispParamList" title="Permalink to this definition">¶</a></dt>
134<dd><p>Return a list of all available parameters for the model</p>
135</dd></dl>
136
137<dl class="method">
138<dt id="sans.models.BinaryHSModel.BinaryHSModel.getParam">
139<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.BinaryHSModel.BinaryHSModel.getParam" title="Permalink to this definition">¶</a></dt>
140<dd><p>Set the value of a model parameter</p>
141<table class="docutils field-list" frame="void" rules="none">
142<col class="field-name" />
143<col class="field-body" />
144<tbody valign="top">
145<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
146</tr>
147</tbody>
148</table>
149</dd></dl>
150
151<dl class="method">
152<dt id="sans.models.BinaryHSModel.BinaryHSModel.getParamList">
153<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BinaryHSModel.BinaryHSModel.getParamList" title="Permalink to this definition">¶</a></dt>
154<dd><p>Return a list of all available parameters for the model</p>
155</dd></dl>
156
157<dl class="method">
158<dt id="sans.models.BinaryHSModel.BinaryHSModel.getParamListWithToken">
159<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.BinaryHSModel.BinaryHSModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
160<dd></dd></dl>
161
162<dl class="method">
163<dt id="sans.models.BinaryHSModel.BinaryHSModel.getParamWithToken">
164<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.BinaryHSModel.BinaryHSModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
165<dd></dd></dl>
166
167<dl class="method">
168<dt id="sans.models.BinaryHSModel.BinaryHSModel.is_fittable">
169<tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.BinaryHSModel.BinaryHSModel.is_fittable" title="Permalink to this definition">¶</a></dt>
170<dd><p>Check if a given parameter is fittable or not</p>
171<table class="docutils field-list" frame="void" rules="none">
172<col class="field-name" />
173<col class="field-body" />
174<tbody valign="top">
175<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td>
176</tr>
177</tbody>
178</table>
179</dd></dl>
180
181<dl class="attribute">
182<dt id="sans.models.BinaryHSModel.BinaryHSModel.log">
183<tt class="descname">log</tt><a class="headerlink" href="#sans.models.BinaryHSModel.BinaryHSModel.log" title="Permalink to this definition">¶</a></dt>
184<dd><p>Log</p>
185</dd></dl>
186
187<dl class="attribute">
188<dt id="sans.models.BinaryHSModel.BinaryHSModel.params">
189<tt class="descname">params</tt><a class="headerlink" href="#sans.models.BinaryHSModel.BinaryHSModel.params" title="Permalink to this definition">¶</a></dt>
190<dd><p>Parameters</p>
191</dd></dl>
192
193<dl class="attribute">
194<dt id="sans.models.BinaryHSModel.BinaryHSModel.reset">
195<tt class="descname">reset</tt><a class="headerlink" href="#sans.models.BinaryHSModel.BinaryHSModel.reset" title="Permalink to this definition">¶</a></dt>
196<dd><p>Reset pair correlation</p>
197</dd></dl>
198
199<dl class="method">
200<dt id="sans.models.BinaryHSModel.BinaryHSModel.run">
201<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.BinaryHSModel.BinaryHSModel.run" title="Permalink to this definition">¶</a></dt>
202<dd><p>Evaluate the model</p>
203<table class="docutils field-list" frame="void" rules="none">
204<col class="field-name" />
205<col class="field-body" />
206<tbody valign="top">
207<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td>
208</tr>
209<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
210</tr>
211</tbody>
212</table>
213</dd></dl>
214
215<dl class="method">
216<dt id="sans.models.BinaryHSModel.BinaryHSModel.runXY">
217<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.BinaryHSModel.BinaryHSModel.runXY" title="Permalink to this definition">¶</a></dt>
218<dd><p>Evaluate the model in cartesian coordinates</p>
219<table class="docutils field-list" frame="void" rules="none">
220<col class="field-name" />
221<col class="field-body" />
222<tbody valign="top">
223<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td>
224</tr>
225<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
226</tr>
227</tbody>
228</table>
229</dd></dl>
230
231<dl class="method">
232<dt id="sans.models.BinaryHSModel.BinaryHSModel.setParam">
233<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.BinaryHSModel.BinaryHSModel.setParam" title="Permalink to this definition">¶</a></dt>
234<dd><p>Set the value of a model parameter</p>
235<table class="docutils field-list" frame="void" rules="none">
236<col class="field-name" />
237<col class="field-body" />
238<tbody valign="top">
239<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
240<li><strong>name</strong> &#8211; name of the parameter</li>
241<li><strong>value</strong> &#8211; value of the parameter</li>
242</ul>
243</td>
244</tr>
245</tbody>
246</table>
247</dd></dl>
248
249<dl class="method">
250<dt id="sans.models.BinaryHSModel.BinaryHSModel.setParamWithToken">
251<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.BinaryHSModel.BinaryHSModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
252<dd></dd></dl>
253
254<dl class="method">
255<dt id="sans.models.BinaryHSModel.BinaryHSModel.set_dispersion">
256<tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.BinaryHSModel.BinaryHSModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
257<dd><p>Set the dispersion object for a model parameter</p>
258<table class="docutils field-list" frame="void" rules="none">
259<col class="field-name" />
260<col class="field-body" />
261<tbody valign="top">
262<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
263<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
264<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
265</ul>
266</td>
267</tr>
268</tbody>
269</table>
270</dd></dl>
271
272</dd></dl>
273
274<dl class="function">
275<dt id="sans.models.BinaryHSModel.create_BinaryHSModel">
276<tt class="descclassname">sans.models.BinaryHSModel.</tt><tt class="descname">create_BinaryHSModel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BinaryHSModel.create_BinaryHSModel" title="Permalink to this definition">¶</a></dt>
277<dd></dd></dl>
278
279</div>
280</div>
281
282
283          </div>
284        </div>
285      </div>
286      <div class="sphinxsidebar">
287        <div class="sphinxsidebarwrapper">
288  <h3><a href="../index.html">Table Of Contents</a></h3>
289  <ul>
290<li><a class="reference internal" href="#">BinaryHSModel</a><ul>
291<li><a class="reference internal" href="#module-sans.models.BinaryHSModel"><tt class="docutils literal"><span class="pre">sans.models.BinaryHSModel</span></tt></a></li>
292</ul>
293</li>
294</ul>
295
296  <h4>Previous topic</h4>
297  <p class="topless"><a href="BEPolyelectrolyte.html"
298                        title="previous chapter">BEPolyelectrolyte</a></p>
299  <h4>Next topic</h4>
300  <p class="topless"><a href="BinaryHSPSF11Model.html"
301                        title="next chapter">BinaryHSPSF11Model</a></p>
302  <h3>This Page</h3>
303  <ul class="this-page-menu">
304    <li><a href="../_sources/api/BinaryHSModel.txt"
305           rel="nofollow">Show Source</a></li>
306  </ul>
307<div id="searchbox" style="display: none">
308  <h3>Quick search</h3>
309    <form class="search" action="../search.html" method="get">
310      <input type="text" name="q" size="18" />
311      <input type="submit" value="Go" />
312      <input type="hidden" name="check_keywords" value="yes" />
313      <input type="hidden" name="area" value="default" />
314    </form>
315    <p class="searchtip" style="font-size: 90%">
316    Enter search terms or a module, class or function name.
317    </p>
318</div>
319<script type="text/javascript">$('#searchbox').show(0);</script>
320        </div>
321      </div>
322      <div class="clearer"></div>
323    </div>
324    <div class="related">
325      <h3>Navigation</h3>
326      <ul>
327        <li class="right" style="margin-right: 10px">
328          <a href="../genindex.html" title="General Index"
329             >index</a></li>
330        <li class="right" >
331          <a href="../py-modindex.html" title="Python Module Index"
332             >modules</a> |</li>
333        <li class="right" >
334          <a href="BinaryHSPSF11Model.html" title="BinaryHSPSF11Model"
335             >next</a> |</li>
336        <li class="right" >
337          <a href="BEPolyelectrolyte.html" title="BEPolyelectrolyte"
338             >previous</a> |</li>
339        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
340          <li><a href="index.html" >Reference</a> &raquo;</li> 
341      </ul>
342    </div>
343    <div class="footer">
344        &copy; Copyright 2010, sans group.
345      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
346    </div>
347  </body>
348</html>
Note: See TracBrowser for help on using the repository browser.