source: sasview/sansmodels/docs/sphinx/_build/html/api/BEPolyelectrolyte.html @ b94945d

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 b94945d was 79ac6f8, checked in by Gervaise Alina <gervyh@…>, 15 years ago

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