[512573a] | 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 | |
---|
[c0d873f] | 6 | |
---|
[512573a] | 7 | <html xmlns="http://www.w3.org/1999/xhtml"> |
---|
| 8 | <head> |
---|
| 9 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
---|
| 10 | |
---|
[c0d873f] | 11 | <title>DisperseModel — sansmodels 0.1.0 documentation</title> |
---|
| 12 | |
---|
[512573a] | 13 | <link rel="stylesheet" href="../_static/default.css" type="text/css" /> |
---|
| 14 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> |
---|
[c0d873f] | 15 | |
---|
[512573a] | 16 | <script type="text/javascript"> |
---|
| 17 | var DOCUMENTATION_OPTIONS = { |
---|
| 18 | URL_ROOT: '../', |
---|
| 19 | VERSION: '0.1.0', |
---|
| 20 | COLLAPSE_INDEX: false, |
---|
| 21 | FILE_SUFFIX: '.html', |
---|
| 22 | HAS_SOURCE: true |
---|
| 23 | }; |
---|
| 24 | </script> |
---|
| 25 | <script type="text/javascript" src="../_static/jquery.js"></script> |
---|
| 26 | <script type="text/javascript" src="../_static/underscore.js"></script> |
---|
| 27 | <script type="text/javascript" src="../_static/doctools.js"></script> |
---|
[c0d873f] | 28 | <link rel="top" title="sansmodels 0.1.0 documentation" href="../index.html" /> |
---|
[512573a] | 29 | <link rel="up" title="Reference" href="index.html" /> |
---|
| 30 | <link rel="next" title="dispersion_models" href="dispersion_models.html" /> |
---|
| 31 | <link rel="prev" title="DiamEllipFunc" href="DiamEllipFunc.html" /> |
---|
| 32 | </head> |
---|
| 33 | <body> |
---|
| 34 | <div class="related"> |
---|
| 35 | <h3>Navigation</h3> |
---|
| 36 | <ul> |
---|
| 37 | <li class="right" style="margin-right: 10px"> |
---|
| 38 | <a href="../genindex.html" title="General Index" |
---|
| 39 | accesskey="I">index</a></li> |
---|
| 40 | <li class="right" > |
---|
| 41 | <a href="../py-modindex.html" title="Python Module Index" |
---|
| 42 | >modules</a> |</li> |
---|
| 43 | <li class="right" > |
---|
| 44 | <a href="dispersion_models.html" title="dispersion_models" |
---|
| 45 | accesskey="N">next</a> |</li> |
---|
| 46 | <li class="right" > |
---|
| 47 | <a href="DiamEllipFunc.html" title="DiamEllipFunc" |
---|
| 48 | accesskey="P">previous</a> |</li> |
---|
[c0d873f] | 49 | <li><a href="../index.html">sansmodels 0.1.0 documentation</a> »</li> |
---|
[512573a] | 50 | <li><a href="index.html" accesskey="U">Reference</a> »</li> |
---|
| 51 | </ul> |
---|
| 52 | </div> |
---|
| 53 | |
---|
| 54 | <div class="document"> |
---|
| 55 | <div class="documentwrapper"> |
---|
| 56 | <div class="bodywrapper"> |
---|
| 57 | <div class="body"> |
---|
| 58 | |
---|
| 59 | <div class="section" id="dispersemodel"> |
---|
| 60 | <h1>DisperseModel<a class="headerlink" href="#dispersemodel" title="Permalink to this headline">¶</a></h1> |
---|
[c0d873f] | 61 | <div class="section" id="sans-models-dispersemodel"> |
---|
| 62 | <h2><a class="reference internal" href="#module-sans.models.DisperseModel" title="sans.models.DisperseModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.DisperseModel</span></tt></a><a class="headerlink" href="#sans-models-dispersemodel" title="Permalink to this headline">¶</a></h2> |
---|
| 63 | <span class="target" id="module-sans.models.DisperseModel"></span><p>Wrapper for the Disperser class extension</p> |
---|
[512573a] | 64 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 65 | <col class="field-name" /> |
---|
| 66 | <col class="field-body" /> |
---|
| 67 | <tbody valign="top"> |
---|
[c0d873f] | 68 | <tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Mathieu Doucet / UTK</td> |
---|
[512573a] | 69 | </tr> |
---|
[c0d873f] | 70 | <tr class="field-even field"><th class="field-name">contact:</th><td class="field-body"><a class="reference external" href="mailto:mathieu.doucet%40nist.gov">mathieu<span>.</span>doucet<span>@</span>nist<span>.</span>gov</a></td> |
---|
[512573a] | 71 | </tr> |
---|
| 72 | </tbody> |
---|
| 73 | </table> |
---|
| 74 | <dl class="class"> |
---|
| 75 | <dt id="sans.models.DisperseModel.DisperseModel"> |
---|
[c0d873f] | 76 | <em class="property">class </em><tt class="descclassname">sans.models.DisperseModel.</tt><tt class="descname">DisperseModel</tt><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 77 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">Disperser</span></tt>, <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> |
---|
| 78 | <p>Wrapper class for the Disperser extension |
---|
| 79 | Python class that takes a model and averages its output |
---|
| 80 | for a distribution of its parameters.</p> |
---|
| 81 | <p>The parameters to be varied are specified at instantiation time. |
---|
| 82 | The distributions are Gaussian, with std deviations specified for |
---|
| 83 | each parameter at instantiation time.</p> |
---|
| 84 | <p>Example:</p> |
---|
| 85 | <div class="highlight-python"><div class="highlight"><pre><span class="n">cyl</span> <span class="o">=</span> <span class="n">ModelFactory</span><span class="p">()</span><span class="o">.</span><span class="n">getModel</span><span class="p">(</span><span class="s">"CylinderModel"</span><span class="p">)</span> |
---|
| 86 | <span class="n">disp</span> <span class="o">=</span> <span class="n">DisperseModel</span><span class="p">(</span><span class="n">cyl</span><span class="p">,</span> <span class="p">[</span><span class="s">'cyl_phi'</span><span class="p">],</span> <span class="p">[</span><span class="mf">0.3</span><span class="p">])</span> |
---|
| 87 | <span class="n">disp</span><span class="o">.</span><span class="n">run</span><span class="p">([</span><span class="mf">0.01</span><span class="p">,</span> <span class="mf">1.57</span><span class="p">])</span> |
---|
| 88 | </pre></div> |
---|
| 89 | </div> |
---|
| 90 | <dl class="method"> |
---|
[c0d873f] | 91 | <dt id="sans.models.DisperseModel.DisperseModel.__add__"> |
---|
| 92 | <tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.__add__" title="Permalink to this definition">¶</a></dt> |
---|
| 93 | <dd></dd></dl> |
---|
| 94 | |
---|
| 95 | <dl class="attribute"> |
---|
| 96 | <dt id="sans.models.DisperseModel.DisperseModel.__class__"> |
---|
| 97 | <tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.__class__" title="Permalink to this definition">¶</a></dt> |
---|
| 98 | <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> |
---|
| 99 | </dd></dl> |
---|
| 100 | |
---|
| 101 | <dl class="attribute"> |
---|
| 102 | <dt id="sans.models.DisperseModel.DisperseModel.__delattr__"> |
---|
| 103 | <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.__delattr__" title="Permalink to this definition">¶</a></dt> |
---|
| 104 | <dd><p>x.__delattr__(‘name’) <==> del x.name</p> |
---|
| 105 | </dd></dl> |
---|
| 106 | |
---|
| 107 | <dl class="attribute"> |
---|
| 108 | <dt id="sans.models.DisperseModel.DisperseModel.__dict__"> |
---|
| 109 | <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x0200CEB0></em><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.__dict__" title="Permalink to this definition">¶</a></dt> |
---|
| 110 | <dd></dd></dl> |
---|
| 111 | |
---|
| 112 | <dl class="method"> |
---|
| 113 | <dt id="sans.models.DisperseModel.DisperseModel.__div__"> |
---|
| 114 | <tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.__div__" title="Permalink to this definition">¶</a></dt> |
---|
| 115 | <dd></dd></dl> |
---|
| 116 | |
---|
| 117 | <dl class="attribute"> |
---|
| 118 | <dt id="sans.models.DisperseModel.DisperseModel.__getattribute__"> |
---|
| 119 | <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.__getattribute__" title="Permalink to this definition">¶</a></dt> |
---|
| 120 | <dd><p>x.__getattribute__(‘name’) <==> x.name</p> |
---|
| 121 | </dd></dl> |
---|
| 122 | |
---|
| 123 | <dl class="attribute"> |
---|
| 124 | <dt id="sans.models.DisperseModel.DisperseModel.__hash__"> |
---|
| 125 | <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.__hash__" title="Permalink to this definition">¶</a></dt> |
---|
| 126 | <dd><p>x.__hash__() <==> hash(x)</p> |
---|
| 127 | </dd></dl> |
---|
| 128 | |
---|
| 129 | <dl class="method"> |
---|
| 130 | <dt id="sans.models.DisperseModel.DisperseModel.__init__"> |
---|
| 131 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.__init__" title="Permalink to this definition">¶</a></dt> |
---|
| 132 | <dd><p>Initialization</p> |
---|
| 133 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 134 | <col class="field-name" /> |
---|
| 135 | <col class="field-body" /> |
---|
| 136 | <tbody valign="top"> |
---|
| 137 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 138 | <li><strong>model</strong> – Model to disperse [BaseComponent]</li> |
---|
| 139 | <li><strong>paramList</strong> – list of parameters to disperse [List of strings]</li> |
---|
| 140 | <li><strong>sigmaList</strong> – list of std deviations for Gaussian dispersion |
---|
| 141 | [List of floats]</li> |
---|
| 142 | </ul> |
---|
| 143 | </td> |
---|
| 144 | </tr> |
---|
| 145 | </tbody> |
---|
| 146 | </table> |
---|
| 147 | </dd></dl> |
---|
| 148 | |
---|
| 149 | <dl class="attribute"> |
---|
| 150 | <dt id="sans.models.DisperseModel.DisperseModel.__module__"> |
---|
| 151 | <tt class="descname">__module__</tt><em class="property"> = 'sans.models.DisperseModel'</em><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.__module__" title="Permalink to this definition">¶</a></dt> |
---|
| 152 | <dd></dd></dl> |
---|
| 153 | |
---|
| 154 | <dl class="method"> |
---|
| 155 | <dt id="sans.models.DisperseModel.DisperseModel.__mul__"> |
---|
| 156 | <tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.__mul__" title="Permalink to this definition">¶</a></dt> |
---|
| 157 | <dd></dd></dl> |
---|
| 158 | |
---|
| 159 | <dl class="staticmethod"> |
---|
| 160 | <dt id="sans.models.DisperseModel.DisperseModel.__new__"> |
---|
| 161 | <em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> → a new object with type S, a subtype of T<a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.__new__" title="Permalink to this definition">¶</a></dt> |
---|
| 162 | <dd></dd></dl> |
---|
| 163 | |
---|
| 164 | <dl class="method"> |
---|
| 165 | <dt id="sans.models.DisperseModel.DisperseModel.__reduce__"> |
---|
| 166 | <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.__reduce__" title="Permalink to this definition">¶</a></dt> |
---|
| 167 | <dd><p>helper for pickle</p> |
---|
| 168 | </dd></dl> |
---|
| 169 | |
---|
| 170 | <dl class="method"> |
---|
| 171 | <dt id="sans.models.DisperseModel.DisperseModel.__reduce_ex__"> |
---|
| 172 | <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.__reduce_ex__" title="Permalink to this definition">¶</a></dt> |
---|
| 173 | <dd><p>helper for pickle</p> |
---|
| 174 | </dd></dl> |
---|
| 175 | |
---|
| 176 | <dl class="attribute"> |
---|
| 177 | <dt id="sans.models.DisperseModel.DisperseModel.__repr__"> |
---|
| 178 | <tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.__repr__" title="Permalink to this definition">¶</a></dt> |
---|
| 179 | <dd><p>x.__repr__() <==> repr(x)</p> |
---|
| 180 | </dd></dl> |
---|
| 181 | |
---|
| 182 | <dl class="attribute"> |
---|
| 183 | <dt id="sans.models.DisperseModel.DisperseModel.__setattr__"> |
---|
| 184 | <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.__setattr__" title="Permalink to this definition">¶</a></dt> |
---|
| 185 | <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> |
---|
| 186 | </dd></dl> |
---|
| 187 | |
---|
| 188 | <dl class="attribute"> |
---|
| 189 | <dt id="sans.models.DisperseModel.DisperseModel.__str__"> |
---|
| 190 | <tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.__str__" title="Permalink to this definition">¶</a></dt> |
---|
| 191 | <dd><p>x.__str__() <==> str(x)</p> |
---|
| 192 | </dd></dl> |
---|
| 193 | |
---|
| 194 | <dl class="method"> |
---|
| 195 | <dt id="sans.models.DisperseModel.DisperseModel.__sub__"> |
---|
| 196 | <tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.__sub__" title="Permalink to this definition">¶</a></dt> |
---|
| 197 | <dd></dd></dl> |
---|
| 198 | |
---|
| 199 | <dl class="attribute"> |
---|
| 200 | <dt id="sans.models.DisperseModel.DisperseModel.__weakref__"> |
---|
| 201 | <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.__weakref__" title="Permalink to this definition">¶</a></dt> |
---|
| 202 | <dd><p>list of weak references to the object (if defined)</p> |
---|
| 203 | </dd></dl> |
---|
| 204 | |
---|
| 205 | <dl class="method"> |
---|
| 206 | <dt id="sans.models.DisperseModel.DisperseModel._clone"> |
---|
| 207 | <tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel._clone" title="Permalink to this definition">¶</a></dt> |
---|
| 208 | <dd><p>Internal utility function to copy the internal |
---|
| 209 | data members to a fresh copy.</p> |
---|
| 210 | </dd></dl> |
---|
| 211 | |
---|
| 212 | <dl class="method"> |
---|
[512573a] | 213 | <dt id="sans.models.DisperseModel.DisperseModel.calculate_ER"> |
---|
| 214 | <tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.calculate_ER" title="Permalink to this definition">¶</a></dt> |
---|
| 215 | <dd></dd></dl> |
---|
| 216 | |
---|
| 217 | <dl class="method"> |
---|
| 218 | <dt id="sans.models.DisperseModel.DisperseModel.clone"> |
---|
| 219 | <tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.clone" title="Permalink to this definition">¶</a></dt> |
---|
| 220 | <dd><p>Return a identical copy of self</p> |
---|
| 221 | </dd></dl> |
---|
| 222 | |
---|
| 223 | <dl class="method"> |
---|
| 224 | <dt id="sans.models.DisperseModel.DisperseModel.evalDistribution"> |
---|
[c0d873f] | 225 | <tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.evalDistribution" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 226 | <dd><p>Evaluate a distribution of q-values.</p> |
---|
| 227 | <ul> |
---|
| 228 | <li><p class="first">For 1D, a numpy array is expected as input:</p> |
---|
| 229 | <blockquote> |
---|
| 230 | <div><p>evalDistribution(q)</p> |
---|
| 231 | </div></blockquote> |
---|
| 232 | </li> |
---|
| 233 | </ul> |
---|
| 234 | <p>where q is a numpy array.</p> |
---|
| 235 | <ul class="simple"> |
---|
| 236 | <li>For 2D, a list of numpy arrays are expected: [qx_prime,qy_prime], |
---|
| 237 | where 1D arrays,</li> |
---|
| 238 | </ul> |
---|
| 239 | <p>qx_prime = [ qx[0], qx[1], qx[2], ....] |
---|
| 240 | and |
---|
| 241 | qy_prime = [ qy[0], qy[1], qy[2], ....]</p> |
---|
| 242 | <p>Then get |
---|
| 243 | q = numpy.sqrt(qx_prime^2+qy_prime^2)</p> |
---|
| 244 | <p>that is a qr in 1D array; |
---|
| 245 | q = [q[0], q[1], q[2], ....]</p> |
---|
| 246 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 247 | <col class="field-name" /> |
---|
| 248 | <col class="field-body" /> |
---|
| 249 | <tbody valign="top"> |
---|
[c0d873f] | 250 | <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 |
---|
[512573a] | 251 | is supported for python models, thus C-models should have</p> |
---|
| 252 | <blockquote class="last"> |
---|
| 253 | <div><p>their own evalDistribution methods.</p> |
---|
| 254 | </div></blockquote> |
---|
| 255 | </td> |
---|
| 256 | </tr> |
---|
| 257 | </tbody> |
---|
| 258 | </table> |
---|
| 259 | <p>The method is then called the following way:</p> |
---|
| 260 | <p>evalDistribution(q) |
---|
| 261 | where q is a numpy array.</p> |
---|
| 262 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 263 | <col class="field-name" /> |
---|
| 264 | <col class="field-body" /> |
---|
| 265 | <tbody valign="top"> |
---|
[c0d873f] | 266 | <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] |
---|
[512573a] | 267 | where qx,qy are 1D ndarrays</td> |
---|
| 268 | </tr> |
---|
| 269 | </tbody> |
---|
| 270 | </table> |
---|
| 271 | </dd></dl> |
---|
| 272 | |
---|
| 273 | <dl class="method"> |
---|
| 274 | <dt id="sans.models.DisperseModel.DisperseModel.getDispParamList"> |
---|
| 275 | <tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.getDispParamList" title="Permalink to this definition">¶</a></dt> |
---|
| 276 | <dd><p>Return a list of all available parameters for the model</p> |
---|
| 277 | </dd></dl> |
---|
| 278 | |
---|
| 279 | <dl class="method"> |
---|
| 280 | <dt id="sans.models.DisperseModel.DisperseModel.getParam"> |
---|
[c0d873f] | 281 | <tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.getParam" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 282 | <dd></dd></dl> |
---|
| 283 | |
---|
| 284 | <dl class="method"> |
---|
| 285 | <dt id="sans.models.DisperseModel.DisperseModel.getParamList"> |
---|
| 286 | <tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.getParamList" title="Permalink to this definition">¶</a></dt> |
---|
| 287 | <dd><p>Return a list of all available parameters for the model</p> |
---|
| 288 | </dd></dl> |
---|
| 289 | |
---|
| 290 | <dl class="method"> |
---|
| 291 | <dt id="sans.models.DisperseModel.DisperseModel.getParamListWithToken"> |
---|
[c0d873f] | 292 | <tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 293 | <dd></dd></dl> |
---|
| 294 | |
---|
| 295 | <dl class="method"> |
---|
| 296 | <dt id="sans.models.DisperseModel.DisperseModel.getParamWithToken"> |
---|
[c0d873f] | 297 | <tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 298 | <dd></dd></dl> |
---|
| 299 | |
---|
| 300 | <dl class="method"> |
---|
| 301 | <dt id="sans.models.DisperseModel.DisperseModel.is_fittable"> |
---|
[c0d873f] | 302 | <tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.is_fittable" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 303 | <dd><p>Check if a given parameter is fittable or not</p> |
---|
| 304 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 305 | <col class="field-name" /> |
---|
| 306 | <col class="field-body" /> |
---|
| 307 | <tbody valign="top"> |
---|
[c0d873f] | 308 | <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> |
---|
[512573a] | 309 | </tr> |
---|
| 310 | </tbody> |
---|
| 311 | </table> |
---|
| 312 | </dd></dl> |
---|
| 313 | |
---|
| 314 | <dl class="attribute"> |
---|
| 315 | <dt id="sans.models.DisperseModel.DisperseModel.model"> |
---|
| 316 | <tt class="descname">model</tt><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.model" title="Permalink to this definition">¶</a></dt> |
---|
| 317 | <dd><p>Model to disperse</p> |
---|
| 318 | </dd></dl> |
---|
| 319 | |
---|
| 320 | <dl class="attribute"> |
---|
| 321 | <dt id="sans.models.DisperseModel.DisperseModel.params"> |
---|
| 322 | <tt class="descname">params</tt><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.params" title="Permalink to this definition">¶</a></dt> |
---|
| 323 | <dd><p>Parameters</p> |
---|
| 324 | </dd></dl> |
---|
| 325 | |
---|
| 326 | <dl class="method"> |
---|
| 327 | <dt id="sans.models.DisperseModel.DisperseModel.run"> |
---|
[c0d873f] | 328 | <tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.run" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 329 | <dd><p>Evaluate the model</p> |
---|
| 330 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 331 | <col class="field-name" /> |
---|
| 332 | <col class="field-body" /> |
---|
| 333 | <tbody valign="top"> |
---|
[c0d873f] | 334 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> – input q, or [q,phi]</td> |
---|
[512573a] | 335 | </tr> |
---|
[c0d873f] | 336 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> |
---|
[512573a] | 337 | </tr> |
---|
| 338 | </tbody> |
---|
| 339 | </table> |
---|
| 340 | </dd></dl> |
---|
| 341 | |
---|
| 342 | <dl class="method"> |
---|
| 343 | <dt id="sans.models.DisperseModel.DisperseModel.runXY"> |
---|
[c0d873f] | 344 | <tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.runXY" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 345 | <dd><p>Evaluate the model</p> |
---|
| 346 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 347 | <col class="field-name" /> |
---|
| 348 | <col class="field-body" /> |
---|
| 349 | <tbody valign="top"> |
---|
[c0d873f] | 350 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> – input q, or [q,phi]</td> |
---|
[512573a] | 351 | </tr> |
---|
[c0d873f] | 352 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> |
---|
[512573a] | 353 | </tr> |
---|
| 354 | </tbody> |
---|
| 355 | </table> |
---|
| 356 | </dd></dl> |
---|
| 357 | |
---|
| 358 | <dl class="method"> |
---|
| 359 | <dt id="sans.models.DisperseModel.DisperseModel.setParam"> |
---|
[c0d873f] | 360 | <tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.setParam" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 361 | <dd></dd></dl> |
---|
| 362 | |
---|
| 363 | <dl class="method"> |
---|
| 364 | <dt id="sans.models.DisperseModel.DisperseModel.setParamWithToken"> |
---|
[c0d873f] | 365 | <tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DisperseModel.DisperseModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 366 | <dd></dd></dl> |
---|
| 367 | |
---|
| 368 | </dd></dl> |
---|
| 369 | |
---|
| 370 | </div> |
---|
| 371 | </div> |
---|
| 372 | |
---|
| 373 | |
---|
| 374 | </div> |
---|
| 375 | </div> |
---|
| 376 | </div> |
---|
| 377 | <div class="sphinxsidebar"> |
---|
| 378 | <div class="sphinxsidebarwrapper"> |
---|
| 379 | <h3><a href="../index.html">Table Of Contents</a></h3> |
---|
| 380 | <ul> |
---|
| 381 | <li><a class="reference internal" href="#">DisperseModel</a><ul> |
---|
[c0d873f] | 382 | <li><a class="reference internal" href="#sans-models-dispersemodel"><tt class="docutils literal"><span class="pre">sans.models.DisperseModel</span></tt></a></li> |
---|
[512573a] | 383 | </ul> |
---|
| 384 | </li> |
---|
| 385 | </ul> |
---|
| 386 | |
---|
| 387 | <h4>Previous topic</h4> |
---|
| 388 | <p class="topless"><a href="DiamEllipFunc.html" |
---|
| 389 | title="previous chapter">DiamEllipFunc</a></p> |
---|
| 390 | <h4>Next topic</h4> |
---|
| 391 | <p class="topless"><a href="dispersion_models.html" |
---|
| 392 | title="next chapter">dispersion_models</a></p> |
---|
| 393 | <h3>This Page</h3> |
---|
| 394 | <ul class="this-page-menu"> |
---|
| 395 | <li><a href="../_sources/api/DisperseModel.txt" |
---|
| 396 | rel="nofollow">Show Source</a></li> |
---|
| 397 | </ul> |
---|
| 398 | <div id="searchbox" style="display: none"> |
---|
| 399 | <h3>Quick search</h3> |
---|
| 400 | <form class="search" action="../search.html" method="get"> |
---|
[c0d873f] | 401 | <input type="text" name="q" /> |
---|
[512573a] | 402 | <input type="submit" value="Go" /> |
---|
| 403 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 404 | <input type="hidden" name="area" value="default" /> |
---|
| 405 | </form> |
---|
| 406 | <p class="searchtip" style="font-size: 90%"> |
---|
| 407 | Enter search terms or a module, class or function name. |
---|
| 408 | </p> |
---|
| 409 | </div> |
---|
| 410 | <script type="text/javascript">$('#searchbox').show(0);</script> |
---|
| 411 | </div> |
---|
| 412 | </div> |
---|
| 413 | <div class="clearer"></div> |
---|
| 414 | </div> |
---|
| 415 | <div class="related"> |
---|
| 416 | <h3>Navigation</h3> |
---|
| 417 | <ul> |
---|
| 418 | <li class="right" style="margin-right: 10px"> |
---|
| 419 | <a href="../genindex.html" title="General Index" |
---|
| 420 | >index</a></li> |
---|
| 421 | <li class="right" > |
---|
| 422 | <a href="../py-modindex.html" title="Python Module Index" |
---|
| 423 | >modules</a> |</li> |
---|
| 424 | <li class="right" > |
---|
| 425 | <a href="dispersion_models.html" title="dispersion_models" |
---|
| 426 | >next</a> |</li> |
---|
| 427 | <li class="right" > |
---|
| 428 | <a href="DiamEllipFunc.html" title="DiamEllipFunc" |
---|
| 429 | >previous</a> |</li> |
---|
[c0d873f] | 430 | <li><a href="../index.html">sansmodels 0.1.0 documentation</a> »</li> |
---|
[512573a] | 431 | <li><a href="index.html" >Reference</a> »</li> |
---|
| 432 | </ul> |
---|
| 433 | </div> |
---|
| 434 | <div class="footer"> |
---|
| 435 | © Copyright 2010, sans group. |
---|
[c0d873f] | 436 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. |
---|
[512573a] | 437 | </div> |
---|
| 438 | </body> |
---|
| 439 | </html> |
---|