Changeset c0d873f in sasview for sansmodels/docs/sphinx/html/api/BEPolyelectrolyte.html
- Timestamp:
- Oct 24, 2011 2:52:52 PM (13 years ago)
- Branches:
- master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
- Children:
- 8d70c0a
- Parents:
- 67cd7c0
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
sansmodels/docs/sphinx/html/api/BEPolyelectrolyte.html
r512573a rc0d873f 3 3 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 4 4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 5 5 6 6 7 <html xmlns="http://www.w3.org/1999/xhtml"> … … 8 9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 9 10 10 <title>BEPolyelectrolyte — sansmodels v0.1.0 documentation</title> 11 <title>BEPolyelectrolyte — sansmodels 0.1.0 documentation</title> 12 11 13 <link rel="stylesheet" href="../_static/default.css" type="text/css" /> 12 14 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> 15 13 16 <script type="text/javascript"> 14 17 var DOCUMENTATION_OPTIONS = { … … 23 26 <script type="text/javascript" src="../_static/underscore.js"></script> 24 27 <script type="text/javascript" src="../_static/doctools.js"></script> 25 <link rel="top" title="sansmodels v0.1.0 documentation" href="../index.html" />28 <link rel="top" title="sansmodels 0.1.0 documentation" href="../index.html" /> 26 29 <link rel="up" title="Reference" href="index.html" /> 27 30 <link rel="next" title="BinaryHSModel" href="BinaryHSModel.html" /> … … 44 47 <a href="BCCrystalModel.html" title="BCCrystalModel" 45 48 accesskey="P">previous</a> |</li> 46 <li><a href="../index.html">sansmodels v0.1.0 documentation</a> »</li>49 <li><a href="../index.html">sansmodels 0.1.0 documentation</a> »</li> 47 50 <li><a href="index.html" accesskey="U">Reference</a> »</li> 48 51 </ul> … … 56 59 <div class="section" id="bepolyelectrolyte"> 57 60 <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)))61 <div class="section" id="sans-models-bepolyelectrolyte"> 62 <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="#sans-models-bepolyelectrolyte" title="Permalink to this headline">¶</a></h2> 63 <span class="target" id="module-sans.models.BEPolyelectrolyte"></span><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))) 61 64 BEPolyelectrolyte as a BaseComponent model</p> 62 65 <dl class="class"> … … 78 81 </dl> 79 82 <dl class="method"> 83 <dt id="sans.models.BEPolyelectrolyte.BEPolyelectrolyte._BEPoly"> 84 <tt class="descname">_BEPoly</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BEPolyelectrolyte.BEPolyelectrolyte._BEPoly" title="Permalink to this definition">¶</a></dt> 85 <dd><p>Evaluate 86 F(x) = K*1/(4*pi*Lb*(alpha)^(2))*(q^(2)+k2)/(1+(r02)^(2))</p> 87 <blockquote> 88 <div><a href="#id5"><span class="problematic" id="id6">*</span></a>(q^(2)+k2)*(q^(2)-(12*h*C/b^(2)))</div></blockquote> 89 <dl class="docutils"> 90 <dt>has 3 internal parameters :</dt> 91 <dd>The inverse Debye Length: K2 = 4*pi*Lb*(2*Cs+alpha*C) 92 r02 =1/alpha/Ca^(0.5)*(B/(48*pi*Lb)^(0.5)) 93 Ca = C*6.022136e-4</dd> 94 </dl> 95 </dd></dl> 96 97 <dl class="method"> 98 <dt id="sans.models.BEPolyelectrolyte.BEPolyelectrolyte.__add__"> 99 <tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BEPolyelectrolyte.BEPolyelectrolyte.__add__" title="Permalink to this definition">¶</a></dt> 100 <dd></dd></dl> 101 102 <dl class="method"> 103 <dt id="sans.models.BEPolyelectrolyte.BEPolyelectrolyte.__div__"> 104 <tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BEPolyelectrolyte.BEPolyelectrolyte.__div__" title="Permalink to this definition">¶</a></dt> 105 <dd></dd></dl> 106 107 <dl class="method"> 108 <dt id="sans.models.BEPolyelectrolyte.BEPolyelectrolyte.__init__"> 109 <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BEPolyelectrolyte.BEPolyelectrolyte.__init__" title="Permalink to this definition">¶</a></dt> 110 <dd><p>Initialization</p> 111 </dd></dl> 112 113 <dl class="attribute"> 114 <dt id="sans.models.BEPolyelectrolyte.BEPolyelectrolyte.__module__"> 115 <tt class="descname">__module__</tt><em class="property"> = 'sans.models.BEPolyelectrolyte'</em><a class="headerlink" href="#sans.models.BEPolyelectrolyte.BEPolyelectrolyte.__module__" title="Permalink to this definition">¶</a></dt> 116 <dd></dd></dl> 117 118 <dl class="method"> 119 <dt id="sans.models.BEPolyelectrolyte.BEPolyelectrolyte.__mul__"> 120 <tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BEPolyelectrolyte.BEPolyelectrolyte.__mul__" title="Permalink to this definition">¶</a></dt> 121 <dd></dd></dl> 122 123 <dl class="method"> 124 <dt id="sans.models.BEPolyelectrolyte.BEPolyelectrolyte.__str__"> 125 <tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BEPolyelectrolyte.BEPolyelectrolyte.__str__" title="Permalink to this definition">¶</a></dt> 126 <dd><table class="docutils field-list" frame="void" rules="none"> 127 <col class="field-name" /> 128 <col class="field-body" /> 129 <tbody valign="top"> 130 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string representatio</td> 131 </tr> 132 </tbody> 133 </table> 134 </dd></dl> 135 136 <dl class="method"> 137 <dt id="sans.models.BEPolyelectrolyte.BEPolyelectrolyte.__sub__"> 138 <tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BEPolyelectrolyte.BEPolyelectrolyte.__sub__" title="Permalink to this definition">¶</a></dt> 139 <dd></dd></dl> 140 141 <dl class="method"> 142 <dt id="sans.models.BEPolyelectrolyte.BEPolyelectrolyte._clone"> 143 <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> 144 <dd><p>Internal utility function to copy the internal 145 data members to a fresh copy.</p> 146 </dd></dl> 147 148 <dl class="method"> 80 149 <dt id="sans.models.BEPolyelectrolyte.BEPolyelectrolyte.calculate_ER"> 81 150 <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> … … 90 159 <dl class="method"> 91 160 <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>161 <tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BEPolyelectrolyte.BEPolyelectrolyte.evalDistribution" title="Permalink to this definition">¶</a></dt> 93 162 <dd><p>Evaluate a distribution of q-values.</p> 94 163 <ul> … … 115 184 <col class="field-body" /> 116 185 <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 scattering186 <tr class="field-odd field"><th class="field-name">Note :</th><td class="field-body"><p class="first">Due to 2D speed issue, no anisotropic scattering 118 187 is supported for python models, thus C-models should have</p> 119 188 <blockquote class="last"> … … 131 200 <col class="field-body" /> 132 201 <tbody valign="top"> 133 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>qdist</strong> – ndarray of scalar q-values or list [qx,qy]202 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>qdist</strong> – ndarray of scalar q-values or list [qx,qy] 134 203 where qx,qy are 1D ndarrays</td> 135 204 </tr> … … 146 215 <dl class="method"> 147 216 <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>217 <tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BEPolyelectrolyte.BEPolyelectrolyte.getParam" title="Permalink to this definition">¶</a></dt> 149 218 <dd><p>Set the value of a model parameter</p> 150 219 <table class="docutils field-list" frame="void" rules="none"> … … 152 221 <col class="field-body" /> 153 222 <tbody valign="top"> 154 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – name of the parameter</td>223 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – name of the parameter</td> 155 224 </tr> 156 225 </tbody> … … 166 235 <dl class="method"> 167 236 <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>237 <tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BEPolyelectrolyte.BEPolyelectrolyte.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 169 238 <dd></dd></dl> 170 239 171 240 <dl class="method"> 172 241 <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>242 <tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BEPolyelectrolyte.BEPolyelectrolyte.getParamWithToken" title="Permalink to this definition">¶</a></dt> 174 243 <dd></dd></dl> 175 244 176 245 <dl class="method"> 177 246 <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>247 <tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BEPolyelectrolyte.BEPolyelectrolyte.is_fittable" title="Permalink to this definition">¶</a></dt> 179 248 <dd><p>Check if a given parameter is fittable or not</p> 180 249 <table class="docutils field-list" frame="void" rules="none"> … … 182 251 <col class="field-body" /> 183 252 <tbody valign="top"> 184 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> – the parameter name to check</td>253 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> – the parameter name to check</td> 185 254 </tr> 186 255 </tbody> … … 190 259 <dl class="method"> 191 260 <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>261 <tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BEPolyelectrolyte.BEPolyelectrolyte.run" title="Permalink to this definition">¶</a></dt> 193 262 <dd><p>Evaluate the model 194 263 @param x: input q-value (float or [float, float] as [r, theta]) … … 198 267 <dl class="method"> 199 268 <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>269 <tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BEPolyelectrolyte.BEPolyelectrolyte.runXY" title="Permalink to this definition">¶</a></dt> 201 270 <dd><p>Evaluate the model 202 271 @param x: input q-value (float or [float, float] as [qx, qy]) … … 206 275 <dl class="method"> 207 276 <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>277 <tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BEPolyelectrolyte.BEPolyelectrolyte.setParam" title="Permalink to this definition">¶</a></dt> 209 278 <dd><p>Set the value of a model parameter</p> 210 279 <table class="docutils field-list" frame="void" rules="none"> … … 212 281 <col class="field-body" /> 213 282 <tbody valign="top"> 214 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">283 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 215 284 <li><strong>name</strong> – name of the parameter</li> 216 285 <li><strong>value</strong> – value of the parameter</li> … … 224 293 <dl class="method"> 225 294 <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>295 <tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BEPolyelectrolyte.BEPolyelectrolyte.setParamWithToken" title="Permalink to this definition">¶</a></dt> 227 296 <dd></dd></dl> 228 297 … … 241 310 <ul> 242 311 <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>312 <li><a class="reference internal" href="#sans-models-bepolyelectrolyte"><tt class="docutils literal"><span class="pre">sans.models.BEPolyelectrolyte</span></tt></a></li> 244 313 </ul> 245 314 </li> … … 260 329 <h3>Quick search</h3> 261 330 <form class="search" action="../search.html" method="get"> 262 <input type="text" name="q" size="18"/>331 <input type="text" name="q" /> 263 332 <input type="submit" value="Go" /> 264 333 <input type="hidden" name="check_keywords" value="yes" /> … … 289 358 <a href="BCCrystalModel.html" title="BCCrystalModel" 290 359 >previous</a> |</li> 291 <li><a href="../index.html">sansmodels v0.1.0 documentation</a> »</li>360 <li><a href="../index.html">sansmodels 0.1.0 documentation</a> »</li> 292 361 <li><a href="index.html" >Reference</a> »</li> 293 362 </ul> … … 295 364 <div class="footer"> 296 365 © Copyright 2010, sans group. 297 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1. 0.7.366 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 298 367 </div> 299 368 </body>
Note: See TracChangeset
for help on using the changeset viewer.
