Changeset c0d873f in sasview for sansmodels/docs/sphinx/html/api/UnifiedPowerRgModel.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/UnifiedPowerRgModel.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>UnifiedPowerRgModel — sansmodels v0.1.0 documentation</title> 11 <title>UnifiedPowerRgModel — 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="VesicleModel" href="VesicleModel.html" /> … … 44 47 <a href="TwoPowerLawModel.html" title="TwoPowerLawModel" 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="unifiedpowerrgmodel"> 57 60 <h1>UnifiedPowerRgModel<a class="headerlink" href="#unifiedpowerrgmodel" title="Permalink to this headline">¶</a></h1> 58 <div class="section" id=" module-sans.models.UnifiedPowerRgModel">59 < span id="sans-models-unifiedpowerrgmodel"></span><h2><a class="reference internal" href="#module-sans.models.UnifiedPowerRgModel" title="sans.models.UnifiedPowerRgModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.UnifiedPowerRgModel</span></tt></a><a class="headerlink" href="#module-sans.models.UnifiedPowerRgModel" title="Permalink to this headline">¶</a></h2>60 < dl class="class">61 <div class="section" id="sans-models-unifiedpowerrgmodel"> 62 <h2><a class="reference internal" href="#module-sans.models.UnifiedPowerRgModel" title="sans.models.UnifiedPowerRgModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.UnifiedPowerRgModel</span></tt></a><a class="headerlink" href="#sans-models-unifiedpowerrgmodel" title="Permalink to this headline">¶</a></h2> 63 <span class="target" id="module-sans.models.UnifiedPowerRgModel"></span><dl class="class"> 61 64 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel"> 62 <em class="property">class </em><tt class="descclassname">sans.models.UnifiedPowerRgModel.</tt><tt class="descname">UnifiedPowerRgModel</tt>< big>(</big><em>multfactor=1</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel" title="Permalink to this definition">¶</a></dt>65 <em class="property">class </em><tt class="descclassname">sans.models.UnifiedPowerRgModel.</tt><tt class="descname">UnifiedPowerRgModel</tt><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel" title="Permalink to this definition">¶</a></dt> 63 66 <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> 64 67 <p>This model is based on Exponential/Power-law fit method developed 65 68 by G. Beaucage</p> 66 69 <dl class="method"> 70 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__add__"> 71 <tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__add__" title="Permalink to this definition">¶</a></dt> 72 <dd></dd></dl> 73 74 <dl class="method"> 75 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__div__"> 76 <tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__div__" title="Permalink to this definition">¶</a></dt> 77 <dd></dd></dl> 78 79 <dl class="method"> 80 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__init__"> 81 <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__init__" title="Permalink to this definition">¶</a></dt> 82 <dd></dd></dl> 83 84 <dl class="attribute"> 85 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__module__"> 86 <tt class="descname">__module__</tt><em class="property"> = 'sans.models.UnifiedPowerRgModel'</em><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__module__" title="Permalink to this definition">¶</a></dt> 87 <dd></dd></dl> 88 89 <dl class="method"> 90 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__mul__"> 91 <tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__mul__" title="Permalink to this definition">¶</a></dt> 92 <dd></dd></dl> 93 94 <dl class="method"> 95 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__str__"> 96 <tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__str__" title="Permalink to this definition">¶</a></dt> 97 <dd><table class="docutils field-list" frame="void" rules="none"> 98 <col class="field-name" /> 99 <col class="field-body" /> 100 <tbody valign="top"> 101 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string representatio</td> 102 </tr> 103 </tbody> 104 </table> 105 </dd></dl> 106 107 <dl class="method"> 108 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__sub__"> 109 <tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__sub__" title="Permalink to this definition">¶</a></dt> 110 <dd></dd></dl> 111 112 <dl class="method"> 113 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._clone"> 114 <tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._clone" title="Permalink to this definition">¶</a></dt> 115 <dd><p>Internal utility function to copy the internal 116 data members to a fresh copy.</p> 117 </dd></dl> 118 119 <dl class="method"> 120 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._get_func_list"> 121 <tt class="descname">_get_func_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._get_func_list" title="Permalink to this definition">¶</a></dt> 122 <dd><p>Get the list of functions in each cases</p> 123 </dd></dl> 124 125 <dl class="method"> 126 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._setParamHelper"> 127 <tt class="descname">_setParamHelper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._setParamHelper" title="Permalink to this definition">¶</a></dt> 128 <dd><p>Helper function to setParam</p> 129 </dd></dl> 130 131 <dl class="method"> 132 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._set_details"> 133 <tt class="descname">_set_details</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._set_details" title="Permalink to this definition">¶</a></dt> 134 <dd><p>Concatenate details of the original model to create 135 this model details</p> 136 </dd></dl> 137 138 <dl class="method"> 139 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._set_dispersion"> 140 <tt class="descname">_set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._set_dispersion" title="Permalink to this definition">¶</a></dt> 141 <dd><p>model dispersions</p> 142 </dd></dl> 143 144 <dl class="method"> 145 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._set_fixed_params"> 146 <tt class="descname">_set_fixed_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._set_fixed_params" title="Permalink to this definition">¶</a></dt> 147 <dd><p>Fill the self.fixed list with the model fixed list</p> 148 </dd></dl> 149 150 <dl class="method"> 151 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._set_params"> 152 <tt class="descname">_set_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._set_params" title="Permalink to this definition">¶</a></dt> 153 <dd><p>Concatenate the parameters of the model to create 154 this model parameters</p> 155 </dd></dl> 156 157 <dl class="method"> 158 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._unifiedpowerrg"> 159 <tt class="descname">_unifiedpowerrg</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._unifiedpowerrg" title="Permalink to this definition">¶</a></dt> 160 <dd><p>Scattering function</p> 161 <table class="docutils field-list" frame="void" rules="none"> 162 <col class="field-name" /> 163 <col class="field-body" /> 164 <tbody valign="top"> 165 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> – q value(s)</td> 166 </tr> 167 <tr class="field-even field"><th class="field-name">Return answer:</th><td class="field-body">output of the function</td> 168 </tr> 169 </tbody> 170 </table> 171 </dd></dl> 172 173 <dl class="method"> 67 174 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.calculate_ER"> 68 175 <tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.calculate_ER" title="Permalink to this definition">¶</a></dt> … … 77 184 <dl class="method"> 78 185 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.evalDistribution"> 79 <tt class="descname">evalDistribution</tt><big>(</big>< em>qdist</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.evalDistribution" title="Permalink to this definition">¶</a></dt>186 <tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 80 187 <dd><p>Evaluate a distribution of q-values.</p> 81 188 <ul> … … 102 209 <col class="field-body" /> 103 210 <tbody valign="top"> 104 <tr class="field "><th class="field-name">Note :</th><td class="field-body"><p class="first">Due to 2D speed issue, no anisotropic scattering211 <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 105 212 is supported for python models, thus C-models should have</p> 106 213 <blockquote class="last"> … … 118 225 <col class="field-body" /> 119 226 <tbody valign="top"> 120 <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]227 <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] 121 228 where qx,qy are 1D ndarrays</td> 122 229 </tr> … … 133 240 <dl class="method"> 134 241 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.getParam"> 135 <tt class="descname">getParam</tt><big>(</big>< em>name</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.getParam" title="Permalink to this definition">¶</a></dt>242 <tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.getParam" title="Permalink to this definition">¶</a></dt> 136 243 <dd><p>Set the value of a model parameter</p> 137 244 <table class="docutils field-list" frame="void" rules="none"> … … 139 246 <col class="field-body" /> 140 247 <tbody valign="top"> 141 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – name of the parameter</td>248 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – name of the parameter</td> 142 249 </tr> 143 250 </tbody> … … 153 260 <dl class="method"> 154 261 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.getParamListWithToken"> 155 <tt class="descname">getParamListWithToken</tt><big>(</big>< em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>262 <tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 156 263 <dd></dd></dl> 157 264 158 265 <dl class="method"> 159 266 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.getParamWithToken"> 160 <tt class="descname">getParamWithToken</tt><big>(</big>< em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>267 <tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 161 268 <dd></dd></dl> 162 269 … … 170 277 <dl class="method"> 171 278 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.is_fittable"> 172 <tt class="descname">is_fittable</tt><big>(</big>< em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.is_fittable" title="Permalink to this definition">¶</a></dt>279 <tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.is_fittable" title="Permalink to this definition">¶</a></dt> 173 280 <dd><p>Check if a given parameter is fittable or not</p> 174 281 <table class="docutils field-list" frame="void" rules="none"> … … 176 283 <col class="field-body" /> 177 284 <tbody valign="top"> 178 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> – the parameter name to check</td>285 <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> 179 286 </tr> 180 287 </tbody> … … 184 291 <dl class="method"> 185 292 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.run"> 186 <tt class="descname">run</tt><big>(</big>< em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.run" title="Permalink to this definition">¶</a></dt>293 <tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.run" title="Permalink to this definition">¶</a></dt> 187 294 <dd><p>Evaluate the model</p> 188 295 <p>: param x: input q-value (float or [float, float] as [r, theta]) … … 192 299 <dl class="method"> 193 300 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.runXY"> 194 <tt class="descname">runXY</tt><big>(</big>< em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.runXY" title="Permalink to this definition">¶</a></dt>301 <tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.runXY" title="Permalink to this definition">¶</a></dt> 195 302 <dd><p>Evaluate the model</p> 196 303 <p>: param x: input q-value (float or [float, float] as [qx, qy]) … … 200 307 <dl class="method"> 201 308 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.setParam"> 202 <tt class="descname">setParam</tt><big>(</big>< em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.setParam" title="Permalink to this definition">¶</a></dt>309 <tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.setParam" title="Permalink to this definition">¶</a></dt> 203 310 <dd><p>Set the value of a model parameter</p> 204 311 <p>: param name: name of the parameter … … 208 315 <dl class="method"> 209 316 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.setParamWithToken"> 210 <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.UnifiedPowerRgModel.UnifiedPowerRgModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>317 <tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 211 318 <dd></dd></dl> 212 319 213 320 <dl class="method"> 214 321 <dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.set_dispersion"> 215 <tt class="descname">set_dispersion</tt><big>(</big>< em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.set_dispersion" title="Permalink to this definition">¶</a></dt>322 <tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 216 323 <dd><p>Set the dispersion object for a model parameter</p> 217 324 <p>: param parameter: name of the parameter [string] … … 233 340 <ul> 234 341 <li><a class="reference internal" href="#">UnifiedPowerRgModel</a><ul> 235 <li><a class="reference internal" href="# module-sans.models.UnifiedPowerRgModel"><tt class="docutils literal"><span class="pre">sans.models.UnifiedPowerRgModel</span></tt></a></li>342 <li><a class="reference internal" href="#sans-models-unifiedpowerrgmodel"><tt class="docutils literal"><span class="pre">sans.models.UnifiedPowerRgModel</span></tt></a></li> 236 343 </ul> 237 344 </li> … … 252 359 <h3>Quick search</h3> 253 360 <form class="search" action="../search.html" method="get"> 254 <input type="text" name="q" size="18"/>361 <input type="text" name="q" /> 255 362 <input type="submit" value="Go" /> 256 363 <input type="hidden" name="check_keywords" value="yes" /> … … 281 388 <a href="TwoPowerLawModel.html" title="TwoPowerLawModel" 282 389 >previous</a> |</li> 283 <li><a href="../index.html">sansmodels v0.1.0 documentation</a> »</li>390 <li><a href="../index.html">sansmodels 0.1.0 documentation</a> »</li> 284 391 <li><a href="index.html" >Reference</a> »</li> 285 392 </ul> … … 287 394 <div class="footer"> 288 395 © Copyright 2010, sans group. 289 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1. 0.7.396 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 290 397 </div> 291 398 </body>
Note: See TracChangeset
for help on using the changeset viewer.