Changeset c0d873f in sasview for sansmodels/docs/sphinx/html/api/BaseComponent.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/BaseComponent.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>BaseComponent — sansmodels v0.1.0 documentation</title> 11 <title>BaseComponent — 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="BaseModel" href="BaseModel.html" /> … … 44 47 <a href="BarBellModel.html" title="BarBellModel" 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="basecomponent"> 57 60 <h1>BaseComponent<a class="headerlink" href="#basecomponent" title="Permalink to this headline">¶</a></h1> 58 <div class="section" id=" module-sans.models.BaseComponent">59 < span id="sans-models-basecomponent"></span><h2><a class="reference internal" href="#module-sans.models.BaseComponent" title="sans.models.BaseComponent"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.BaseComponent</span></tt></a><a class="headerlink" href="#module-sans.models.BaseComponent" title="Permalink to this headline">¶</a></h2>60 < p>Provide base functionality for all model components</p>61 <div class="section" id="sans-models-basecomponent"> 62 <h2><a class="reference internal" href="#module-sans.models.BaseComponent" title="sans.models.BaseComponent"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.BaseComponent</span></tt></a><a class="headerlink" href="#sans-models-basecomponent" title="Permalink to this headline">¶</a></h2> 63 <span class="target" id="module-sans.models.BaseComponent"></span><p>Provide base functionality for all model components</p> 61 64 <dl class="class"> 62 65 <dt id="sans.models.BaseComponent.BaseComponent"> … … 65 68 <p>Since version 0.5.0, basic operations are no longer supported.</p> 66 69 <dl class="method"> 70 <dt id="sans.models.BaseComponent.BaseComponent.__add__"> 71 <tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.__add__" title="Permalink to this definition">¶</a></dt> 72 <dd></dd></dl> 73 74 <dl class="method"> 75 <dt id="sans.models.BaseComponent.BaseComponent.__div__"> 76 <tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.__div__" title="Permalink to this definition">¶</a></dt> 77 <dd></dd></dl> 78 79 <dl class="method"> 80 <dt id="sans.models.BaseComponent.BaseComponent.__init__"> 81 <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.__init__" title="Permalink to this definition">¶</a></dt> 82 <dd><p>Initialization</p> 83 </dd></dl> 84 85 <dl class="attribute"> 86 <dt id="sans.models.BaseComponent.BaseComponent.__module__"> 87 <tt class="descname">__module__</tt><em class="property"> = 'sans.models.BaseComponent'</em><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.__module__" title="Permalink to this definition">¶</a></dt> 88 <dd></dd></dl> 89 90 <dl class="method"> 91 <dt id="sans.models.BaseComponent.BaseComponent.__mul__"> 92 <tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.__mul__" title="Permalink to this definition">¶</a></dt> 93 <dd></dd></dl> 94 95 <dl class="method"> 96 <dt id="sans.models.BaseComponent.BaseComponent.__str__"> 97 <tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.__str__" title="Permalink to this definition">¶</a></dt> 98 <dd><table class="docutils field-list" frame="void" rules="none"> 99 <col class="field-name" /> 100 <col class="field-body" /> 101 <tbody valign="top"> 102 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string representatio</td> 103 </tr> 104 </tbody> 105 </table> 106 </dd></dl> 107 108 <dl class="method"> 109 <dt id="sans.models.BaseComponent.BaseComponent.__sub__"> 110 <tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.__sub__" title="Permalink to this definition">¶</a></dt> 111 <dd></dd></dl> 112 113 <dl class="method"> 114 <dt id="sans.models.BaseComponent.BaseComponent._clone"> 115 <tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent._clone" title="Permalink to this definition">¶</a></dt> 116 <dd><p>Internal utility function to copy the internal 117 data members to a fresh copy.</p> 118 </dd></dl> 119 120 <dl class="method"> 67 121 <dt id="sans.models.BaseComponent.BaseComponent.calculate_ER"> 68 122 <tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.calculate_ER" title="Permalink to this definition">¶</a></dt> … … 77 131 <dl class="method"> 78 132 <dt id="sans.models.BaseComponent.BaseComponent.evalDistribution"> 79 <tt class="descname">evalDistribution</tt><big>(</big>< em>qdist</em><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.evalDistribution" title="Permalink to this definition">¶</a></dt>133 <tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.evalDistribution" title="Permalink to this definition">¶</a></dt> 80 134 <dd><p>Evaluate a distribution of q-values.</p> 81 135 <ul> … … 102 156 <col class="field-body" /> 103 157 <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 scattering158 <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 159 is supported for python models, thus C-models should have</p> 106 160 <blockquote class="last"> … … 118 172 <col class="field-body" /> 119 173 <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]174 <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 175 where qx,qy are 1D ndarrays</td> 122 176 </tr> … … 133 187 <dl class="method"> 134 188 <dt id="sans.models.BaseComponent.BaseComponent.getParam"> 135 <tt class="descname">getParam</tt><big>(</big>< em>name</em><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.getParam" title="Permalink to this definition">¶</a></dt>189 <tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.getParam" title="Permalink to this definition">¶</a></dt> 136 190 <dd><p>Set the value of a model parameter</p> 137 191 <table class="docutils field-list" frame="void" rules="none"> … … 139 193 <col class="field-body" /> 140 194 <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>195 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – name of the parameter</td> 142 196 </tr> 143 197 </tbody> … … 153 207 <dl class="method"> 154 208 <dt id="sans.models.BaseComponent.BaseComponent.getParamListWithToken"> 155 <tt class="descname">getParamListWithToken</tt><big>(</big>< em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.getParamListWithToken" title="Permalink to this definition">¶</a></dt>209 <tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 156 210 <dd></dd></dl> 157 211 158 212 <dl class="method"> 159 213 <dt id="sans.models.BaseComponent.BaseComponent.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.BaseComponent.BaseComponent.getParamWithToken" title="Permalink to this definition">¶</a></dt>214 <tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.getParamWithToken" title="Permalink to this definition">¶</a></dt> 161 215 <dd></dd></dl> 162 216 163 217 <dl class="method"> 164 218 <dt id="sans.models.BaseComponent.BaseComponent.is_fittable"> 165 <tt class="descname">is_fittable</tt><big>(</big>< em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.is_fittable" title="Permalink to this definition">¶</a></dt>219 <tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.is_fittable" title="Permalink to this definition">¶</a></dt> 166 220 <dd><p>Check if a given parameter is fittable or not</p> 167 221 <table class="docutils field-list" frame="void" rules="none"> … … 169 223 <col class="field-body" /> 170 224 <tbody valign="top"> 171 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> – the parameter name to check</td>225 <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> 172 226 </tr> 173 227 </tbody> … … 177 231 <dl class="method"> 178 232 <dt id="sans.models.BaseComponent.BaseComponent.run"> 179 <tt class="descname">run</tt><big>(</big>< em>x</em><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.run" title="Permalink to this definition">¶</a></dt>233 <tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.run" title="Permalink to this definition">¶</a></dt> 180 234 <dd></dd></dl> 181 235 182 236 <dl class="method"> 183 237 <dt id="sans.models.BaseComponent.BaseComponent.runXY"> 184 <tt class="descname">runXY</tt><big>(</big>< em>x</em><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.runXY" title="Permalink to this definition">¶</a></dt>238 <tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.runXY" title="Permalink to this definition">¶</a></dt> 185 239 <dd></dd></dl> 186 240 187 241 <dl class="method"> 188 242 <dt id="sans.models.BaseComponent.BaseComponent.setParam"> 189 <tt class="descname">setParam</tt><big>(</big>< em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.setParam" title="Permalink to this definition">¶</a></dt>243 <tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.setParam" title="Permalink to this definition">¶</a></dt> 190 244 <dd><p>Set the value of a model parameter</p> 191 245 <table class="docutils field-list" frame="void" rules="none"> … … 193 247 <col class="field-body" /> 194 248 <tbody valign="top"> 195 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">249 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 196 250 <li><strong>name</strong> – name of the parameter</li> 197 251 <li><strong>value</strong> – value of the parameter</li> … … 205 259 <dl class="method"> 206 260 <dt id="sans.models.BaseComponent.BaseComponent.setParamWithToken"> 207 <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.BaseComponent.BaseComponent.setParamWithToken" title="Permalink to this definition">¶</a></dt>261 <tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.BaseComponent.BaseComponent.setParamWithToken" title="Permalink to this definition">¶</a></dt> 208 262 <dd></dd></dl> 209 263 … … 222 276 <ul> 223 277 <li><a class="reference internal" href="#">BaseComponent</a><ul> 224 <li><a class="reference internal" href="# module-sans.models.BaseComponent"><tt class="docutils literal"><span class="pre">sans.models.BaseComponent</span></tt></a></li>278 <li><a class="reference internal" href="#sans-models-basecomponent"><tt class="docutils literal"><span class="pre">sans.models.BaseComponent</span></tt></a></li> 225 279 </ul> 226 280 </li> … … 241 295 <h3>Quick search</h3> 242 296 <form class="search" action="../search.html" method="get"> 243 <input type="text" name="q" size="18"/>297 <input type="text" name="q" /> 244 298 <input type="submit" value="Go" /> 245 299 <input type="hidden" name="check_keywords" value="yes" /> … … 270 324 <a href="BarBellModel.html" title="BarBellModel" 271 325 >previous</a> |</li> 272 <li><a href="../index.html">sansmodels v0.1.0 documentation</a> »</li>326 <li><a href="../index.html">sansmodels 0.1.0 documentation</a> »</li> 273 327 <li><a href="index.html" >Reference</a> »</li> 274 328 </ul> … … 276 330 <div class="footer"> 277 331 © Copyright 2010, sans group. 278 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1. 0.7.332 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 279 333 </div> 280 334 </body>
Note: See TracChangeset
for help on using the changeset viewer.
