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