[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>FractalAbsModel — 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="FractalCoreShellModel" href="FractalCoreShellModel.html" /> |
---|
| 31 | <link rel="prev" title="FlexibleCylinderModel" href="FlexibleCylinderModel.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="FractalCoreShellModel.html" title="FractalCoreShellModel" |
---|
| 45 | accesskey="N">next</a> |</li> |
---|
| 46 | <li class="right" > |
---|
| 47 | <a href="FlexibleCylinderModel.html" title="FlexibleCylinderModel" |
---|
| 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="fractalabsmodel"> |
---|
| 60 | <h1>FractalAbsModel<a class="headerlink" href="#fractalabsmodel" title="Permalink to this headline">¶</a></h1> |
---|
[c0d873f] | 61 | <div class="section" id="sans-models-fractalabsmodel"> |
---|
| 62 | <h2><a class="reference internal" href="#module-sans.models.FractalAbsModel" title="sans.models.FractalAbsModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.FractalAbsModel</span></tt></a><a class="headerlink" href="#sans-models-fractalabsmodel" title="Permalink to this headline">¶</a></h2> |
---|
| 63 | <span class="target" id="module-sans.models.FractalAbsModel"></span><p>Provide F(x)= P(<a href="#id3"><span class="problematic" id="id4">|x|</span></a>)*S(<a href="#id5"><span class="problematic" id="id6">|x|</span></a>) + bkd |
---|
[512573a] | 64 | Fractal as a BaseComponent model</p> |
---|
| 65 | <dl class="class"> |
---|
| 66 | <dt id="sans.models.FractalAbsModel.FractalAbsModel"> |
---|
| 67 | <em class="property">class </em><tt class="descclassname">sans.models.FractalAbsModel.</tt><tt class="descname">FractalAbsModel</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel" title="Permalink to this definition">¶</a></dt> |
---|
| 68 | <dd><p>Bases: <a class="reference internal" href="FractalModel.html#sans.models.FractalModel.FractalModel" title="sans.models.FractalModel.FractalModel"><tt class="xref py py-class docutils literal"><span class="pre">sans.models.FractalModel.FractalModel</span></tt></a></p> |
---|
| 69 | <p>Class that evaluates a Fractal function.</p> |
---|
[c0d873f] | 70 | <p>F(<a href="#id7"><span class="problematic" id="id8">|x|</span></a>)= P(<a href="#id9"><span class="problematic" id="id10">|x|</span></a>)*S(<a href="#id11"><span class="problematic" id="id12">|x|</span></a>) + bkd |
---|
[512573a] | 71 | The model has Seven parameters:</p> |
---|
| 72 | <blockquote> |
---|
| 73 | <div>scale = Volume fraction |
---|
| 74 | radius = Block radius |
---|
| 75 | fractal_dim = Fractal dimension |
---|
| 76 | corr_length = correlation Length |
---|
| 77 | block_sld = SDL block |
---|
| 78 | solvent_sld = SDL solvent |
---|
| 79 | background = background</div></blockquote> |
---|
| 80 | <dl class="method"> |
---|
[c0d873f] | 81 | <dt id="sans.models.FractalAbsModel.FractalAbsModel._Fractal"> |
---|
| 82 | <tt class="descname">_Fractal</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel._Fractal" title="Permalink to this definition">¶</a></dt> |
---|
| 83 | <dd></dd></dl> |
---|
| 84 | |
---|
| 85 | <dl class="method"> |
---|
| 86 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.__add__"> |
---|
| 87 | <tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.__add__" title="Permalink to this definition">¶</a></dt> |
---|
| 88 | <dd></dd></dl> |
---|
| 89 | |
---|
| 90 | <dl class="attribute"> |
---|
| 91 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.__class__"> |
---|
| 92 | <tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.__class__" title="Permalink to this definition">¶</a></dt> |
---|
| 93 | <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> |
---|
| 94 | </dd></dl> |
---|
| 95 | |
---|
| 96 | <dl class="attribute"> |
---|
| 97 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.__delattr__"> |
---|
| 98 | <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.__delattr__" title="Permalink to this definition">¶</a></dt> |
---|
| 99 | <dd><p>x.__delattr__(‘name’) <==> del x.name</p> |
---|
| 100 | </dd></dl> |
---|
| 101 | |
---|
| 102 | <dl class="attribute"> |
---|
| 103 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.__dict__"> |
---|
| 104 | <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x02270330></em><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.__dict__" title="Permalink to this definition">¶</a></dt> |
---|
| 105 | <dd></dd></dl> |
---|
| 106 | |
---|
| 107 | <dl class="method"> |
---|
| 108 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.__div__"> |
---|
| 109 | <tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.__div__" title="Permalink to this definition">¶</a></dt> |
---|
| 110 | <dd></dd></dl> |
---|
| 111 | |
---|
| 112 | <dl class="attribute"> |
---|
| 113 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.__getattribute__"> |
---|
| 114 | <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.__getattribute__" title="Permalink to this definition">¶</a></dt> |
---|
| 115 | <dd><p>x.__getattribute__(‘name’) <==> x.name</p> |
---|
| 116 | </dd></dl> |
---|
| 117 | |
---|
| 118 | <dl class="attribute"> |
---|
| 119 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.__hash__"> |
---|
| 120 | <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.__hash__" title="Permalink to this definition">¶</a></dt> |
---|
| 121 | <dd><p>x.__hash__() <==> hash(x)</p> |
---|
| 122 | </dd></dl> |
---|
| 123 | |
---|
| 124 | <dl class="method"> |
---|
| 125 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.__init__"> |
---|
| 126 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.__init__" title="Permalink to this definition">¶</a></dt> |
---|
| 127 | <dd><p>Initialization</p> |
---|
| 128 | </dd></dl> |
---|
| 129 | |
---|
| 130 | <dl class="attribute"> |
---|
| 131 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.__module__"> |
---|
| 132 | <tt class="descname">__module__</tt><em class="property"> = 'sans.models.FractalAbsModel'</em><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.__module__" title="Permalink to this definition">¶</a></dt> |
---|
| 133 | <dd></dd></dl> |
---|
| 134 | |
---|
| 135 | <dl class="method"> |
---|
| 136 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.__mul__"> |
---|
| 137 | <tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.__mul__" title="Permalink to this definition">¶</a></dt> |
---|
| 138 | <dd></dd></dl> |
---|
| 139 | |
---|
| 140 | <dl class="staticmethod"> |
---|
| 141 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.__new__"> |
---|
| 142 | <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.FractalAbsModel.FractalAbsModel.__new__" title="Permalink to this definition">¶</a></dt> |
---|
| 143 | <dd></dd></dl> |
---|
| 144 | |
---|
| 145 | <dl class="method"> |
---|
| 146 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.__reduce__"> |
---|
| 147 | <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.__reduce__" title="Permalink to this definition">¶</a></dt> |
---|
| 148 | <dd><p>helper for pickle</p> |
---|
| 149 | </dd></dl> |
---|
| 150 | |
---|
| 151 | <dl class="method"> |
---|
| 152 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.__reduce_ex__"> |
---|
| 153 | <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.__reduce_ex__" title="Permalink to this definition">¶</a></dt> |
---|
| 154 | <dd><p>Overwrite the __reduce_ex__ of PyTypeObject <a href="#id1"><span class="problematic" id="id2">*</span></a>type call in the init of |
---|
| 155 | c model.</p> |
---|
| 156 | </dd></dl> |
---|
| 157 | |
---|
| 158 | <dl class="attribute"> |
---|
| 159 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.__repr__"> |
---|
| 160 | <tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.__repr__" title="Permalink to this definition">¶</a></dt> |
---|
| 161 | <dd><p>x.__repr__() <==> repr(x)</p> |
---|
| 162 | </dd></dl> |
---|
| 163 | |
---|
| 164 | <dl class="attribute"> |
---|
| 165 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.__setattr__"> |
---|
| 166 | <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.__setattr__" title="Permalink to this definition">¶</a></dt> |
---|
| 167 | <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> |
---|
| 168 | </dd></dl> |
---|
| 169 | |
---|
| 170 | <dl class="method"> |
---|
| 171 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.__setstate__"> |
---|
| 172 | <tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.__setstate__" title="Permalink to this definition">¶</a></dt> |
---|
| 173 | <dd><p>restore the state of a model from pickle</p> |
---|
| 174 | </dd></dl> |
---|
| 175 | |
---|
| 176 | <dl class="attribute"> |
---|
| 177 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.__str__"> |
---|
| 178 | <tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.__str__" title="Permalink to this definition">¶</a></dt> |
---|
| 179 | <dd><p>x.__str__() <==> str(x)</p> |
---|
| 180 | </dd></dl> |
---|
| 181 | |
---|
| 182 | <dl class="method"> |
---|
| 183 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.__sub__"> |
---|
| 184 | <tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.__sub__" title="Permalink to this definition">¶</a></dt> |
---|
| 185 | <dd></dd></dl> |
---|
| 186 | |
---|
| 187 | <dl class="attribute"> |
---|
| 188 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.__weakref__"> |
---|
| 189 | <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.__weakref__" title="Permalink to this definition">¶</a></dt> |
---|
| 190 | <dd><p>list of weak references to the object (if defined)</p> |
---|
| 191 | </dd></dl> |
---|
| 192 | |
---|
| 193 | <dl class="method"> |
---|
| 194 | <dt id="sans.models.FractalAbsModel.FractalAbsModel._clone"> |
---|
| 195 | <tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel._clone" title="Permalink to this definition">¶</a></dt> |
---|
| 196 | <dd><p>Internal utility function to copy the internal |
---|
| 197 | data members to a fresh copy.</p> |
---|
| 198 | </dd></dl> |
---|
| 199 | |
---|
| 200 | <dl class="method"> |
---|
[512573a] | 201 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.calculate_ER"> |
---|
| 202 | <tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.calculate_ER" title="Permalink to this definition">¶</a></dt> |
---|
| 203 | <dd><p>Calculate the effective radius for P(q)*S(q)</p> |
---|
| 204 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 205 | <col class="field-name" /> |
---|
| 206 | <col class="field-body" /> |
---|
| 207 | <tbody valign="top"> |
---|
[c0d873f] | 208 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> |
---|
[512573a] | 209 | </tr> |
---|
| 210 | </tbody> |
---|
| 211 | </table> |
---|
| 212 | </dd></dl> |
---|
| 213 | |
---|
| 214 | <dl class="method"> |
---|
| 215 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.clone"> |
---|
| 216 | <tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.clone" title="Permalink to this definition">¶</a></dt> |
---|
| 217 | <dd><p>Return a identical copy of self</p> |
---|
| 218 | </dd></dl> |
---|
| 219 | |
---|
| 220 | <dl class="attribute"> |
---|
| 221 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.dispersion"> |
---|
| 222 | <tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.dispersion" title="Permalink to this definition">¶</a></dt> |
---|
| 223 | <dd><p>Dispersion parameters</p> |
---|
| 224 | </dd></dl> |
---|
| 225 | |
---|
| 226 | <dl class="method"> |
---|
| 227 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.evalDistribution"> |
---|
[c0d873f] | 228 | <tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.evalDistribution" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 229 | <dd><p>Evaluate the model in cartesian coordinates</p> |
---|
| 230 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 231 | <col class="field-name" /> |
---|
| 232 | <col class="field-body" /> |
---|
| 233 | <tbody valign="top"> |
---|
[c0d873f] | 234 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> – input q[], or [qx[], qy[]]</td> |
---|
[512573a] | 235 | </tr> |
---|
[c0d873f] | 236 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> |
---|
[512573a] | 237 | </tr> |
---|
| 238 | </tbody> |
---|
| 239 | </table> |
---|
| 240 | </dd></dl> |
---|
| 241 | |
---|
| 242 | <dl class="method"> |
---|
| 243 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.getDispParamList"> |
---|
| 244 | <tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.getDispParamList" title="Permalink to this definition">¶</a></dt> |
---|
| 245 | <dd><p>Return a list of all available parameters for the model</p> |
---|
| 246 | </dd></dl> |
---|
| 247 | |
---|
| 248 | <dl class="method"> |
---|
| 249 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.getParam"> |
---|
[c0d873f] | 250 | <tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.getParam" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 251 | <dd><p>Set the value of a model parameter</p> |
---|
| 252 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 253 | <col class="field-name" /> |
---|
| 254 | <col class="field-body" /> |
---|
| 255 | <tbody valign="top"> |
---|
[c0d873f] | 256 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> – name of the parameter</td> |
---|
[512573a] | 257 | </tr> |
---|
| 258 | </tbody> |
---|
| 259 | </table> |
---|
| 260 | </dd></dl> |
---|
| 261 | |
---|
| 262 | <dl class="method"> |
---|
| 263 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.getParamList"> |
---|
| 264 | <tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.getParamList" title="Permalink to this definition">¶</a></dt> |
---|
| 265 | <dd><p>Return a list of all available parameters for the model</p> |
---|
| 266 | </dd></dl> |
---|
| 267 | |
---|
| 268 | <dl class="method"> |
---|
| 269 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.getParamListWithToken"> |
---|
[c0d873f] | 270 | <tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 271 | <dd></dd></dl> |
---|
| 272 | |
---|
| 273 | <dl class="method"> |
---|
| 274 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.getParamWithToken"> |
---|
[c0d873f] | 275 | <tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 276 | <dd></dd></dl> |
---|
| 277 | |
---|
| 278 | <dl class="method"> |
---|
| 279 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.is_fittable"> |
---|
[c0d873f] | 280 | <tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.is_fittable" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 281 | <dd><p>Check if a given parameter is fittable or not</p> |
---|
| 282 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 283 | <col class="field-name" /> |
---|
| 284 | <col class="field-body" /> |
---|
| 285 | <tbody valign="top"> |
---|
[c0d873f] | 286 | <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] | 287 | </tr> |
---|
| 288 | </tbody> |
---|
| 289 | </table> |
---|
| 290 | </dd></dl> |
---|
| 291 | |
---|
| 292 | <dl class="attribute"> |
---|
| 293 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.log"> |
---|
| 294 | <tt class="descname">log</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.log" title="Permalink to this definition">¶</a></dt> |
---|
| 295 | <dd><p>Log</p> |
---|
| 296 | </dd></dl> |
---|
| 297 | |
---|
| 298 | <dl class="attribute"> |
---|
| 299 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.params"> |
---|
| 300 | <tt class="descname">params</tt><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.params" title="Permalink to this definition">¶</a></dt> |
---|
| 301 | <dd><p>Parameters</p> |
---|
| 302 | </dd></dl> |
---|
| 303 | |
---|
[c0d873f] | 304 | <dl class="method"> |
---|
[512573a] | 305 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.reset"> |
---|
[c0d873f] | 306 | <tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.reset" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 307 | <dd><p>Reset pair correlation</p> |
---|
| 308 | </dd></dl> |
---|
| 309 | |
---|
| 310 | <dl class="method"> |
---|
| 311 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.run"> |
---|
[c0d873f] | 312 | <tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.run" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 313 | <dd><p>Evaluate the model</p> |
---|
| 314 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 315 | <col class="field-name" /> |
---|
| 316 | <col class="field-body" /> |
---|
| 317 | <tbody valign="top"> |
---|
[c0d873f] | 318 | <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] | 319 | </tr> |
---|
[c0d873f] | 320 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> |
---|
[512573a] | 321 | </tr> |
---|
| 322 | </tbody> |
---|
| 323 | </table> |
---|
| 324 | </dd></dl> |
---|
| 325 | |
---|
| 326 | <dl class="method"> |
---|
| 327 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.runXY"> |
---|
[c0d873f] | 328 | <tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.runXY" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 329 | <dd><p>Evaluate the model in cartesian coordinates</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 [qx, qy]</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.FractalAbsModel.FractalAbsModel.setParam"> |
---|
[c0d873f] | 344 | <tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.setParam" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 345 | <dd><p>Set the value of a model parameter</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"><ul class="first last simple"> |
---|
[512573a] | 351 | <li><strong>name</strong> – name of the parameter</li> |
---|
| 352 | <li><strong>value</strong> – value of the parameter</li> |
---|
| 353 | </ul> |
---|
| 354 | </td> |
---|
| 355 | </tr> |
---|
| 356 | </tbody> |
---|
| 357 | </table> |
---|
| 358 | </dd></dl> |
---|
| 359 | |
---|
| 360 | <dl class="method"> |
---|
| 361 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.setParamWithToken"> |
---|
[c0d873f] | 362 | <tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 363 | <dd></dd></dl> |
---|
| 364 | |
---|
| 365 | <dl class="method"> |
---|
| 366 | <dt id="sans.models.FractalAbsModel.FractalAbsModel.set_dispersion"> |
---|
[c0d873f] | 367 | <tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalAbsModel.FractalAbsModel.set_dispersion" title="Permalink to this definition">¶</a></dt> |
---|
[512573a] | 368 | <dd><p>Set the dispersion object for a model parameter</p> |
---|
| 369 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 370 | <col class="field-name" /> |
---|
| 371 | <col class="field-body" /> |
---|
| 372 | <tbody valign="top"> |
---|
[c0d873f] | 373 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
[512573a] | 374 | <li><strong>parameter</strong> – name of the parameter [string]</li> |
---|
| 375 | <li><strong>dispersion</strong> – dispersion object of type DispersionModel</li> |
---|
| 376 | </ul> |
---|
| 377 | </td> |
---|
| 378 | </tr> |
---|
| 379 | </tbody> |
---|
| 380 | </table> |
---|
| 381 | </dd></dl> |
---|
| 382 | |
---|
| 383 | </dd></dl> |
---|
| 384 | |
---|
| 385 | </div> |
---|
| 386 | </div> |
---|
| 387 | |
---|
| 388 | |
---|
| 389 | </div> |
---|
| 390 | </div> |
---|
| 391 | </div> |
---|
| 392 | <div class="sphinxsidebar"> |
---|
| 393 | <div class="sphinxsidebarwrapper"> |
---|
| 394 | <h3><a href="../index.html">Table Of Contents</a></h3> |
---|
| 395 | <ul> |
---|
| 396 | <li><a class="reference internal" href="#">FractalAbsModel</a><ul> |
---|
[c0d873f] | 397 | <li><a class="reference internal" href="#sans-models-fractalabsmodel"><tt class="docutils literal"><span class="pre">sans.models.FractalAbsModel</span></tt></a></li> |
---|
[512573a] | 398 | </ul> |
---|
| 399 | </li> |
---|
| 400 | </ul> |
---|
| 401 | |
---|
| 402 | <h4>Previous topic</h4> |
---|
| 403 | <p class="topless"><a href="FlexibleCylinderModel.html" |
---|
| 404 | title="previous chapter">FlexibleCylinderModel</a></p> |
---|
| 405 | <h4>Next topic</h4> |
---|
| 406 | <p class="topless"><a href="FractalCoreShellModel.html" |
---|
| 407 | title="next chapter">FractalCoreShellModel</a></p> |
---|
| 408 | <h3>This Page</h3> |
---|
| 409 | <ul class="this-page-menu"> |
---|
| 410 | <li><a href="../_sources/api/FractalAbsModel.txt" |
---|
| 411 | rel="nofollow">Show Source</a></li> |
---|
| 412 | </ul> |
---|
| 413 | <div id="searchbox" style="display: none"> |
---|
| 414 | <h3>Quick search</h3> |
---|
| 415 | <form class="search" action="../search.html" method="get"> |
---|
[c0d873f] | 416 | <input type="text" name="q" /> |
---|
[512573a] | 417 | <input type="submit" value="Go" /> |
---|
| 418 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 419 | <input type="hidden" name="area" value="default" /> |
---|
| 420 | </form> |
---|
| 421 | <p class="searchtip" style="font-size: 90%"> |
---|
| 422 | Enter search terms or a module, class or function name. |
---|
| 423 | </p> |
---|
| 424 | </div> |
---|
| 425 | <script type="text/javascript">$('#searchbox').show(0);</script> |
---|
| 426 | </div> |
---|
| 427 | </div> |
---|
| 428 | <div class="clearer"></div> |
---|
| 429 | </div> |
---|
| 430 | <div class="related"> |
---|
| 431 | <h3>Navigation</h3> |
---|
| 432 | <ul> |
---|
| 433 | <li class="right" style="margin-right: 10px"> |
---|
| 434 | <a href="../genindex.html" title="General Index" |
---|
| 435 | >index</a></li> |
---|
| 436 | <li class="right" > |
---|
| 437 | <a href="../py-modindex.html" title="Python Module Index" |
---|
| 438 | >modules</a> |</li> |
---|
| 439 | <li class="right" > |
---|
| 440 | <a href="FractalCoreShellModel.html" title="FractalCoreShellModel" |
---|
| 441 | >next</a> |</li> |
---|
| 442 | <li class="right" > |
---|
| 443 | <a href="FlexibleCylinderModel.html" title="FlexibleCylinderModel" |
---|
| 444 | >previous</a> |</li> |
---|
[c0d873f] | 445 | <li><a href="../index.html">sansmodels 0.1.0 documentation</a> »</li> |
---|
[512573a] | 446 | <li><a href="index.html" >Reference</a> »</li> |
---|
| 447 | </ul> |
---|
| 448 | </div> |
---|
| 449 | <div class="footer"> |
---|
| 450 | © Copyright 2010, sans group. |
---|
[c0d873f] | 451 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. |
---|
[512573a] | 452 | </div> |
---|
| 453 | </body> |
---|
| 454 | </html> |
---|