[6b1588b] | 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 | |
---|
[f696e2a] | 6 | |
---|
[6b1588b] | 7 | <html xmlns="http://www.w3.org/1999/xhtml"> |
---|
| 8 | <head> |
---|
| 9 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
---|
| 10 | |
---|
[f696e2a] | 11 | <title>AbstractFitEngine — park_integration 0.1.0 documentation</title> |
---|
| 12 | |
---|
[6b1588b] | 13 | <link rel="stylesheet" href="../_static/default.css" type="text/css" /> |
---|
| 14 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> |
---|
[f696e2a] | 15 | |
---|
[6b1588b] | 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> |
---|
[f696e2a] | 28 | <link rel="top" title="park_integration 0.1.0 documentation" href="../index.html" /> |
---|
[6b1588b] | 29 | <link rel="up" title="Reference" href="index.html" /> |
---|
| 30 | <link rel="next" title="Fitting" href="Fitting.html" /> |
---|
| 31 | <link rel="prev" title="Reference" href="index.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="Fitting.html" title="Fitting" |
---|
| 45 | accesskey="N">next</a> |</li> |
---|
| 46 | <li class="right" > |
---|
| 47 | <a href="index.html" title="Reference" |
---|
| 48 | accesskey="P">previous</a> |</li> |
---|
[f696e2a] | 49 | <li><a href="../index.html">park_integration 0.1.0 documentation</a> »</li> |
---|
[6b1588b] | 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="abstractfitengine"> |
---|
| 60 | <h1>AbstractFitEngine<a class="headerlink" href="#abstractfitengine" title="Permalink to this headline">¶</a></h1> |
---|
[f696e2a] | 61 | <div class="section" id="mod-sans-fit-abstractfitengine"> |
---|
| 62 | <h2>:mod:` sans.fit.AbstractFitEngine`<a class="headerlink" href="#mod-sans-fit-abstractfitengine" title="Permalink to this headline">¶</a></h2> |
---|
| 63 | <span class="target" id="module-sans.fit.AbstractFitEngine"></span><dl class="class"> |
---|
| 64 | <dt id="sans.fit.AbstractFitEngine.FResult"> |
---|
| 65 | <em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FResult</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult" title="Permalink to this definition">¶</a></dt> |
---|
| 66 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> |
---|
| 67 | <p>Storing fit result</p> |
---|
| 68 | <dl class="attribute"> |
---|
| 69 | <dt id="sans.fit.AbstractFitEngine.FResult.__class__"> |
---|
| 70 | <tt class="descname">__class__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__class__" title="Permalink to this definition">¶</a></dt> |
---|
| 71 | <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> |
---|
| 72 | </dd></dl> |
---|
| 73 | |
---|
| 74 | <dl class="attribute"> |
---|
| 75 | <dt id="sans.fit.AbstractFitEngine.FResult.__delattr__"> |
---|
| 76 | <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__delattr__" title="Permalink to this definition">¶</a></dt> |
---|
| 77 | <dd><p>x.__delattr__(‘name’) <==> del x.name</p> |
---|
| 78 | </dd></dl> |
---|
| 79 | |
---|
| 80 | <dl class="attribute"> |
---|
| 81 | <dt id="sans.fit.AbstractFitEngine.FResult.__dict__"> |
---|
| 82 | <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x01FA56D0></em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__dict__" title="Permalink to this definition">¶</a></dt> |
---|
| 83 | <dd></dd></dl> |
---|
| 84 | |
---|
| 85 | <dl class="attribute"> |
---|
| 86 | <dt id="sans.fit.AbstractFitEngine.FResult.__getattribute__"> |
---|
| 87 | <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__getattribute__" title="Permalink to this definition">¶</a></dt> |
---|
| 88 | <dd><p>x.__getattribute__(‘name’) <==> x.name</p> |
---|
| 89 | </dd></dl> |
---|
| 90 | |
---|
| 91 | <dl class="attribute"> |
---|
| 92 | <dt id="sans.fit.AbstractFitEngine.FResult.__hash__"> |
---|
| 93 | <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__hash__" title="Permalink to this definition">¶</a></dt> |
---|
| 94 | <dd><p>x.__hash__() <==> hash(x)</p> |
---|
| 95 | </dd></dl> |
---|
| 96 | |
---|
| 97 | <dl class="method"> |
---|
| 98 | <dt id="sans.fit.AbstractFitEngine.FResult.__init__"> |
---|
| 99 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__init__" title="Permalink to this definition">¶</a></dt> |
---|
| 100 | <dd></dd></dl> |
---|
| 101 | |
---|
| 102 | <dl class="attribute"> |
---|
| 103 | <dt id="sans.fit.AbstractFitEngine.FResult.__module__"> |
---|
| 104 | <tt class="descname">__module__</tt><em class="property"> = 'sans.fit.AbstractFitEngine'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__module__" title="Permalink to this definition">¶</a></dt> |
---|
| 105 | <dd></dd></dl> |
---|
| 106 | |
---|
| 107 | <dl class="staticmethod"> |
---|
| 108 | <dt id="sans.fit.AbstractFitEngine.FResult.__new__"> |
---|
| 109 | <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.fit.AbstractFitEngine.FResult.__new__" title="Permalink to this definition">¶</a></dt> |
---|
| 110 | <dd></dd></dl> |
---|
| 111 | |
---|
| 112 | <dl class="method"> |
---|
| 113 | <dt id="sans.fit.AbstractFitEngine.FResult.__reduce__"> |
---|
| 114 | <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__reduce__" title="Permalink to this definition">¶</a></dt> |
---|
| 115 | <dd><p>helper for pickle</p> |
---|
| 116 | </dd></dl> |
---|
| 117 | |
---|
| 118 | <dl class="method"> |
---|
| 119 | <dt id="sans.fit.AbstractFitEngine.FResult.__reduce_ex__"> |
---|
| 120 | <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__reduce_ex__" title="Permalink to this definition">¶</a></dt> |
---|
| 121 | <dd><p>helper for pickle</p> |
---|
| 122 | </dd></dl> |
---|
| 123 | |
---|
| 124 | <dl class="attribute"> |
---|
| 125 | <dt id="sans.fit.AbstractFitEngine.FResult.__repr__"> |
---|
| 126 | <tt class="descname">__repr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__repr__" title="Permalink to this definition">¶</a></dt> |
---|
| 127 | <dd><p>x.__repr__() <==> repr(x)</p> |
---|
| 128 | </dd></dl> |
---|
| 129 | |
---|
| 130 | <dl class="attribute"> |
---|
| 131 | <dt id="sans.fit.AbstractFitEngine.FResult.__setattr__"> |
---|
| 132 | <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__setattr__" title="Permalink to this definition">¶</a></dt> |
---|
| 133 | <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> |
---|
| 134 | </dd></dl> |
---|
| 135 | |
---|
| 136 | <dl class="method"> |
---|
| 137 | <dt id="sans.fit.AbstractFitEngine.FResult.__str__"> |
---|
| 138 | <tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__str__" title="Permalink to this definition">¶</a></dt> |
---|
| 139 | <dd></dd></dl> |
---|
| 140 | |
---|
| 141 | <dl class="attribute"> |
---|
| 142 | <dt id="sans.fit.AbstractFitEngine.FResult.__weakref__"> |
---|
| 143 | <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__weakref__" title="Permalink to this definition">¶</a></dt> |
---|
| 144 | <dd><p>list of weak references to the object (if defined)</p> |
---|
| 145 | </dd></dl> |
---|
| 146 | |
---|
| 147 | <dl class="method"> |
---|
| 148 | <dt id="sans.fit.AbstractFitEngine.FResult.print_summary"> |
---|
| 149 | <tt class="descname">print_summary</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.print_summary" title="Permalink to this definition">¶</a></dt> |
---|
| 150 | <dd></dd></dl> |
---|
| 151 | |
---|
| 152 | <dl class="method"> |
---|
| 153 | <dt id="sans.fit.AbstractFitEngine.FResult.set_fitness"> |
---|
| 154 | <tt class="descname">set_fitness</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.set_fitness" title="Permalink to this definition">¶</a></dt> |
---|
| 155 | <dd></dd></dl> |
---|
| 156 | |
---|
| 157 | <dl class="method"> |
---|
| 158 | <dt id="sans.fit.AbstractFitEngine.FResult.set_model"> |
---|
| 159 | <tt class="descname">set_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.set_model" title="Permalink to this definition">¶</a></dt> |
---|
| 160 | <dd></dd></dl> |
---|
| 161 | |
---|
| 162 | </dd></dl> |
---|
| 163 | |
---|
[6b1588b] | 164 | <dl class="exception"> |
---|
| 165 | <dt id="sans.fit.AbstractFitEngine.FitAbort"> |
---|
| 166 | <em class="property">exception </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitAbort</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort" title="Permalink to this definition">¶</a></dt> |
---|
| 167 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p> |
---|
| 168 | <p>Exception raise to stop the fit</p> |
---|
| 169 | <dl class="attribute"> |
---|
[f696e2a] | 170 | <dt id="sans.fit.AbstractFitEngine.FitAbort.__class__"> |
---|
| 171 | <tt class="descname">__class__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__class__" title="Permalink to this definition">¶</a></dt> |
---|
| 172 | <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> |
---|
| 173 | </dd></dl> |
---|
| 174 | |
---|
| 175 | <dl class="attribute"> |
---|
| 176 | <dt id="sans.fit.AbstractFitEngine.FitAbort.__delattr__"> |
---|
| 177 | <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__delattr__" title="Permalink to this definition">¶</a></dt> |
---|
| 178 | <dd><p>x.__delattr__(‘name’) <==> del x.name</p> |
---|
| 179 | </dd></dl> |
---|
| 180 | |
---|
| 181 | <dl class="attribute"> |
---|
| 182 | <dt id="sans.fit.AbstractFitEngine.FitAbort.__dict__"> |
---|
| 183 | <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x01FA5810></em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__dict__" title="Permalink to this definition">¶</a></dt> |
---|
| 184 | <dd></dd></dl> |
---|
| 185 | |
---|
| 186 | <dl class="attribute"> |
---|
| 187 | <dt id="sans.fit.AbstractFitEngine.FitAbort.__getattribute__"> |
---|
| 188 | <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__getattribute__" title="Permalink to this definition">¶</a></dt> |
---|
| 189 | <dd><p>x.__getattribute__(‘name’) <==> x.name</p> |
---|
| 190 | </dd></dl> |
---|
| 191 | |
---|
| 192 | <dl class="attribute"> |
---|
| 193 | <dt id="sans.fit.AbstractFitEngine.FitAbort.__getitem__"> |
---|
| 194 | <tt class="descname">__getitem__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__getitem__" title="Permalink to this definition">¶</a></dt> |
---|
| 195 | <dd><p>x.__getitem__(y) <==> x[y]</p> |
---|
| 196 | </dd></dl> |
---|
| 197 | |
---|
| 198 | <dl class="attribute"> |
---|
| 199 | <dt id="sans.fit.AbstractFitEngine.FitAbort.__getslice__"> |
---|
| 200 | <tt class="descname">__getslice__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__getslice__" title="Permalink to this definition">¶</a></dt> |
---|
| 201 | <dd><p>x.__getslice__(i, j) <==> x[i:j]</p> |
---|
| 202 | <p>Use of negative indices is not supported.</p> |
---|
| 203 | </dd></dl> |
---|
| 204 | |
---|
| 205 | <dl class="attribute"> |
---|
| 206 | <dt id="sans.fit.AbstractFitEngine.FitAbort.__hash__"> |
---|
| 207 | <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__hash__" title="Permalink to this definition">¶</a></dt> |
---|
| 208 | <dd><p>x.__hash__() <==> hash(x)</p> |
---|
| 209 | </dd></dl> |
---|
| 210 | |
---|
| 211 | <dl class="attribute"> |
---|
| 212 | <dt id="sans.fit.AbstractFitEngine.FitAbort.__init__"> |
---|
| 213 | <tt class="descname">__init__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__init__" title="Permalink to this definition">¶</a></dt> |
---|
| 214 | <dd><p>x.__init__(...) initializes x; see x.__class__.__doc__ for signature</p> |
---|
| 215 | </dd></dl> |
---|
| 216 | |
---|
| 217 | <dl class="attribute"> |
---|
| 218 | <dt id="sans.fit.AbstractFitEngine.FitAbort.__module__"> |
---|
| 219 | <tt class="descname">__module__</tt><em class="property"> = 'sans.fit.AbstractFitEngine'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__module__" title="Permalink to this definition">¶</a></dt> |
---|
| 220 | <dd></dd></dl> |
---|
| 221 | |
---|
| 222 | <dl class="staticmethod"> |
---|
| 223 | <dt id="sans.fit.AbstractFitEngine.FitAbort.__new__"> |
---|
| 224 | <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.fit.AbstractFitEngine.FitAbort.__new__" title="Permalink to this definition">¶</a></dt> |
---|
| 225 | <dd></dd></dl> |
---|
| 226 | |
---|
| 227 | <dl class="method"> |
---|
| 228 | <dt id="sans.fit.AbstractFitEngine.FitAbort.__reduce__"> |
---|
| 229 | <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__reduce__" title="Permalink to this definition">¶</a></dt> |
---|
| 230 | <dd></dd></dl> |
---|
| 231 | |
---|
| 232 | <dl class="method"> |
---|
| 233 | <dt id="sans.fit.AbstractFitEngine.FitAbort.__reduce_ex__"> |
---|
| 234 | <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__reduce_ex__" title="Permalink to this definition">¶</a></dt> |
---|
| 235 | <dd><p>helper for pickle</p> |
---|
| 236 | </dd></dl> |
---|
| 237 | |
---|
| 238 | <dl class="attribute"> |
---|
| 239 | <dt id="sans.fit.AbstractFitEngine.FitAbort.__repr__"> |
---|
| 240 | <tt class="descname">__repr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__repr__" title="Permalink to this definition">¶</a></dt> |
---|
| 241 | <dd><p>x.__repr__() <==> repr(x)</p> |
---|
| 242 | </dd></dl> |
---|
| 243 | |
---|
| 244 | <dl class="attribute"> |
---|
| 245 | <dt id="sans.fit.AbstractFitEngine.FitAbort.__setattr__"> |
---|
| 246 | <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__setattr__" title="Permalink to this definition">¶</a></dt> |
---|
| 247 | <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> |
---|
| 248 | </dd></dl> |
---|
| 249 | |
---|
| 250 | <dl class="method"> |
---|
| 251 | <dt id="sans.fit.AbstractFitEngine.FitAbort.__setstate__"> |
---|
| 252 | <tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__setstate__" title="Permalink to this definition">¶</a></dt> |
---|
| 253 | <dd></dd></dl> |
---|
| 254 | |
---|
| 255 | <dl class="attribute"> |
---|
| 256 | <dt id="sans.fit.AbstractFitEngine.FitAbort.__str__"> |
---|
| 257 | <tt class="descname">__str__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__str__" title="Permalink to this definition">¶</a></dt> |
---|
| 258 | <dd><p>x.__str__() <==> str(x)</p> |
---|
| 259 | </dd></dl> |
---|
| 260 | |
---|
| 261 | <dl class="attribute"> |
---|
| 262 | <dt id="sans.fit.AbstractFitEngine.FitAbort.__weakref__"> |
---|
| 263 | <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__weakref__" title="Permalink to this definition">¶</a></dt> |
---|
| 264 | <dd><p>list of weak references to the object (if defined)</p> |
---|
| 265 | </dd></dl> |
---|
| 266 | |
---|
| 267 | <dl class="attribute"> |
---|
[6b1588b] | 268 | <dt id="sans.fit.AbstractFitEngine.FitAbort.args"> |
---|
| 269 | <tt class="descname">args</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.args" title="Permalink to this definition">¶</a></dt> |
---|
| 270 | <dd></dd></dl> |
---|
| 271 | |
---|
| 272 | <dl class="attribute"> |
---|
| 273 | <dt id="sans.fit.AbstractFitEngine.FitAbort.message"> |
---|
| 274 | <tt class="descname">message</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.message" title="Permalink to this definition">¶</a></dt> |
---|
| 275 | <dd><p>exception message</p> |
---|
| 276 | </dd></dl> |
---|
| 277 | |
---|
| 278 | </dd></dl> |
---|
| 279 | |
---|
| 280 | <dl class="class"> |
---|
| 281 | <dt id="sans.fit.AbstractFitEngine.FitArrange"> |
---|
| 282 | <em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitArrange</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange" title="Permalink to this definition">¶</a></dt> |
---|
| 283 | <dd><dl class="method"> |
---|
[f696e2a] | 284 | <dt id="sans.fit.AbstractFitEngine.FitArrange.__init__"> |
---|
| 285 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.__init__" title="Permalink to this definition">¶</a></dt> |
---|
| 286 | <dd><p>Class FitArrange contains a set of data for a given model |
---|
| 287 | to perform the Fit.FitArrange must contain exactly one model |
---|
| 288 | and at least one data for the fit to be performed.</p> |
---|
| 289 | <p>model: the model selected by the user |
---|
| 290 | Ldata: a list of data what the user wants to fit</p> |
---|
| 291 | </dd></dl> |
---|
| 292 | |
---|
| 293 | <dl class="attribute"> |
---|
| 294 | <dt id="sans.fit.AbstractFitEngine.FitArrange.__module__"> |
---|
| 295 | <tt class="descname">__module__</tt><em class="property"> = 'sans.fit.AbstractFitEngine'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.__module__" title="Permalink to this definition">¶</a></dt> |
---|
| 296 | <dd></dd></dl> |
---|
| 297 | |
---|
| 298 | <dl class="method"> |
---|
[6b1588b] | 299 | <dt id="sans.fit.AbstractFitEngine.FitArrange.add_data"> |
---|
[f696e2a] | 300 | <tt class="descname">add_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.add_data" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 301 | <dd><p>add_data fill a self.data_list with data to fit</p> |
---|
| 302 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 303 | <col class="field-name" /> |
---|
| 304 | <col class="field-body" /> |
---|
| 305 | <tbody valign="top"> |
---|
[f696e2a] | 306 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> – Data to add in the list</td> |
---|
[6b1588b] | 307 | </tr> |
---|
| 308 | </tbody> |
---|
| 309 | </table> |
---|
| 310 | </dd></dl> |
---|
| 311 | |
---|
| 312 | <dl class="method"> |
---|
| 313 | <dt id="sans.fit.AbstractFitEngine.FitArrange.get_data"> |
---|
| 314 | <tt class="descname">get_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.get_data" title="Permalink to this definition">¶</a></dt> |
---|
| 315 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
| 316 | <col class="field-name" /> |
---|
| 317 | <col class="field-body" /> |
---|
| 318 | <tbody valign="top"> |
---|
[f696e2a] | 319 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">list of data data_list</td> |
---|
[6b1588b] | 320 | </tr> |
---|
| 321 | </tbody> |
---|
| 322 | </table> |
---|
| 323 | </dd></dl> |
---|
| 324 | |
---|
| 325 | <dl class="method"> |
---|
| 326 | <dt id="sans.fit.AbstractFitEngine.FitArrange.get_model"> |
---|
| 327 | <tt class="descname">get_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.get_model" title="Permalink to this definition">¶</a></dt> |
---|
| 328 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
| 329 | <col class="field-name" /> |
---|
| 330 | <col class="field-body" /> |
---|
| 331 | <tbody valign="top"> |
---|
[f696e2a] | 332 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">saved model</td> |
---|
[6b1588b] | 333 | </tr> |
---|
| 334 | </tbody> |
---|
| 335 | </table> |
---|
| 336 | </dd></dl> |
---|
| 337 | |
---|
| 338 | <dl class="method"> |
---|
| 339 | <dt id="sans.fit.AbstractFitEngine.FitArrange.get_to_fit"> |
---|
| 340 | <tt class="descname">get_to_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.get_to_fit" title="Permalink to this definition">¶</a></dt> |
---|
| 341 | <dd><p>return self.selected value</p> |
---|
| 342 | </dd></dl> |
---|
| 343 | |
---|
| 344 | <dl class="method"> |
---|
| 345 | <dt id="sans.fit.AbstractFitEngine.FitArrange.remove_data"> |
---|
[f696e2a] | 346 | <tt class="descname">remove_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.remove_data" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 347 | <dd><p>Remove one element from the list</p> |
---|
| 348 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 349 | <col class="field-name" /> |
---|
| 350 | <col class="field-body" /> |
---|
| 351 | <tbody valign="top"> |
---|
[f696e2a] | 352 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> – Data to remove from data_list</td> |
---|
[6b1588b] | 353 | </tr> |
---|
| 354 | </tbody> |
---|
| 355 | </table> |
---|
| 356 | </dd></dl> |
---|
| 357 | |
---|
| 358 | <dl class="method"> |
---|
| 359 | <dt id="sans.fit.AbstractFitEngine.FitArrange.set_model"> |
---|
[f696e2a] | 360 | <tt class="descname">set_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.set_model" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 361 | <dd><p>set_model save a copy of the model</p> |
---|
| 362 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 363 | <col class="field-name" /> |
---|
| 364 | <col class="field-body" /> |
---|
| 365 | <tbody valign="top"> |
---|
[f696e2a] | 366 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – the model being set</td> |
---|
[6b1588b] | 367 | </tr> |
---|
| 368 | </tbody> |
---|
| 369 | </table> |
---|
| 370 | </dd></dl> |
---|
| 371 | |
---|
| 372 | <dl class="method"> |
---|
| 373 | <dt id="sans.fit.AbstractFitEngine.FitArrange.set_to_fit"> |
---|
[f696e2a] | 374 | <tt class="descname">set_to_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.set_to_fit" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 375 | <dd><p>set self.selected to 0 or 1 for other values raise an exception</p> |
---|
| 376 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 377 | <col class="field-name" /> |
---|
| 378 | <col class="field-body" /> |
---|
| 379 | <tbody valign="top"> |
---|
[f696e2a] | 380 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> – integer between 0 or 1</td> |
---|
[6b1588b] | 381 | </tr> |
---|
| 382 | </tbody> |
---|
| 383 | </table> |
---|
| 384 | </dd></dl> |
---|
| 385 | |
---|
| 386 | </dd></dl> |
---|
| 387 | |
---|
| 388 | <dl class="class"> |
---|
| 389 | <dt id="sans.fit.AbstractFitEngine.FitData1D"> |
---|
[f696e2a] | 390 | <em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitData1D</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 391 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.data_info.Data1D</span></tt></p> |
---|
| 392 | <p>Wrapper class for SANS data |
---|
| 393 | FitData1D inherits from DataLoader.data_info.Data1D. Implements |
---|
| 394 | a way to get residuals from data.</p> |
---|
| 395 | <dl class="method"> |
---|
[f696e2a] | 396 | <dt id="sans.fit.AbstractFitEngine.FitData1D.__add__"> |
---|
| 397 | <tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__add__" title="Permalink to this definition">¶</a></dt> |
---|
| 398 | <dd><p>Add two data sets</p> |
---|
| 399 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 400 | <col class="field-name" /> |
---|
| 401 | <col class="field-body" /> |
---|
| 402 | <tbody valign="top"> |
---|
| 403 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to add to the current one</td> |
---|
| 404 | </tr> |
---|
| 405 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
| 406 | </tr> |
---|
| 407 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
| 408 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
| 409 | </tr> |
---|
| 410 | </tbody> |
---|
| 411 | </table> |
---|
[6b1588b] | 412 | </dd></dl> |
---|
| 413 | |
---|
| 414 | <dl class="method"> |
---|
[f696e2a] | 415 | <dt id="sans.fit.AbstractFitEngine.FitData1D.__div__"> |
---|
| 416 | <tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__div__" title="Permalink to this definition">¶</a></dt> |
---|
| 417 | <dd><p>Divided a data set by another</p> |
---|
| 418 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 419 | <col class="field-name" /> |
---|
| 420 | <col class="field-body" /> |
---|
| 421 | <tbody valign="top"> |
---|
| 422 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set that the current one is divided by</td> |
---|
| 423 | </tr> |
---|
| 424 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
| 425 | </tr> |
---|
| 426 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
| 427 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
| 428 | </tr> |
---|
| 429 | </tbody> |
---|
| 430 | </table> |
---|
| 431 | </dd></dl> |
---|
[6b1588b] | 432 | |
---|
| 433 | <dl class="method"> |
---|
[f696e2a] | 434 | <dt id="sans.fit.AbstractFitEngine.FitData1D.__init__"> |
---|
| 435 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__init__" title="Permalink to this definition">¶</a></dt> |
---|
| 436 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
| 437 | <col class="field-name" /> |
---|
| 438 | <col class="field-body" /> |
---|
| 439 | <tbody valign="top"> |
---|
| 440 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>smearer</strong> – is an object of class QSmearer or SlitSmearer |
---|
| 441 | that will smear the theory data (slit smearing or resolution |
---|
| 442 | smearing) when set.</td> |
---|
| 443 | </tr> |
---|
| 444 | </tbody> |
---|
| 445 | </table> |
---|
| 446 | <p>The proper way to set the smearing object would be to |
---|
| 447 | do the following:</p> |
---|
| 448 | <div class="highlight-python"><pre>from DataLoader.qsmearing import smear_selection |
---|
| 449 | smearer = smear_selection(some_data) |
---|
| 450 | fitdata1d = FitData1D( x= [1,3,..,], |
---|
| 451 | y= [3,4,..,8], |
---|
| 452 | dx=None, |
---|
| 453 | dy=[1,2...], smearer= smearer)</pre> |
---|
| 454 | </div> |
---|
[6b1588b] | 455 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 456 | <col class="field-name" /> |
---|
| 457 | <col class="field-body" /> |
---|
| 458 | <tbody valign="top"> |
---|
[f696e2a] | 459 | <tr class="field-odd field"><th class="field-name">Note :</th><td class="field-body">that some_data _HAS_ to be of class DataLoader.data_info.Data1D |
---|
| 460 | Setting it back to None will turn smearing off.</td> |
---|
[6b1588b] | 461 | </tr> |
---|
| 462 | </tbody> |
---|
| 463 | </table> |
---|
| 464 | </dd></dl> |
---|
| 465 | |
---|
[f696e2a] | 466 | <dl class="attribute"> |
---|
| 467 | <dt id="sans.fit.AbstractFitEngine.FitData1D.__module__"> |
---|
| 468 | <tt class="descname">__module__</tt><em class="property"> = 'sans.fit.AbstractFitEngine'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__module__" title="Permalink to this definition">¶</a></dt> |
---|
| 469 | <dd></dd></dl> |
---|
| 470 | |
---|
[6b1588b] | 471 | <dl class="method"> |
---|
[f696e2a] | 472 | <dt id="sans.fit.AbstractFitEngine.FitData1D.__mul__"> |
---|
| 473 | <tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__mul__" title="Permalink to this definition">¶</a></dt> |
---|
| 474 | <dd><p>Multiply two data sets</p> |
---|
| 475 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 476 | <col class="field-name" /> |
---|
| 477 | <col class="field-body" /> |
---|
| 478 | <tbody valign="top"> |
---|
| 479 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to subtract from the current one</td> |
---|
| 480 | </tr> |
---|
| 481 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
| 482 | </tr> |
---|
| 483 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
| 484 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
| 485 | </tr> |
---|
| 486 | </tbody> |
---|
| 487 | </table> |
---|
[6b1588b] | 488 | </dd></dl> |
---|
| 489 | |
---|
| 490 | <dl class="method"> |
---|
[f696e2a] | 491 | <dt id="sans.fit.AbstractFitEngine.FitData1D.__radd__"> |
---|
| 492 | <tt class="descname">__radd__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__radd__" title="Permalink to this definition">¶</a></dt> |
---|
| 493 | <dd><p>Add two data sets</p> |
---|
[6b1588b] | 494 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 495 | <col class="field-name" /> |
---|
| 496 | <col class="field-body" /> |
---|
| 497 | <tbody valign="top"> |
---|
[f696e2a] | 498 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to add to the current one</td> |
---|
| 499 | </tr> |
---|
| 500 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
| 501 | </tr> |
---|
| 502 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
| 503 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
[6b1588b] | 504 | </tr> |
---|
| 505 | </tbody> |
---|
| 506 | </table> |
---|
| 507 | </dd></dl> |
---|
| 508 | |
---|
| 509 | <dl class="method"> |
---|
[f696e2a] | 510 | <dt id="sans.fit.AbstractFitEngine.FitData1D.__rdiv__"> |
---|
| 511 | <tt class="descname">__rdiv__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__rdiv__" title="Permalink to this definition">¶</a></dt> |
---|
| 512 | <dd><p>Divided a data set by another</p> |
---|
[6b1588b] | 513 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 514 | <col class="field-name" /> |
---|
| 515 | <col class="field-body" /> |
---|
| 516 | <tbody valign="top"> |
---|
[f696e2a] | 517 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set that the current one is divided by</td> |
---|
| 518 | </tr> |
---|
| 519 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
[6b1588b] | 520 | </tr> |
---|
[f696e2a] | 521 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
| 522 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
[6b1588b] | 523 | </tr> |
---|
| 524 | </tbody> |
---|
| 525 | </table> |
---|
| 526 | </dd></dl> |
---|
| 527 | |
---|
| 528 | <dl class="method"> |
---|
[f696e2a] | 529 | <dt id="sans.fit.AbstractFitEngine.FitData1D.__rmul__"> |
---|
| 530 | <tt class="descname">__rmul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__rmul__" title="Permalink to this definition">¶</a></dt> |
---|
| 531 | <dd><p>Multiply two data sets</p> |
---|
| 532 | <table class="docutils field-list" frame="void" rules="none"> |
---|
[6b1588b] | 533 | <col class="field-name" /> |
---|
| 534 | <col class="field-body" /> |
---|
| 535 | <tbody valign="top"> |
---|
[f696e2a] | 536 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to subtract from the current one</td> |
---|
| 537 | </tr> |
---|
| 538 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
[6b1588b] | 539 | </tr> |
---|
[f696e2a] | 540 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
| 541 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
[6b1588b] | 542 | </tr> |
---|
| 543 | </tbody> |
---|
| 544 | </table> |
---|
| 545 | </dd></dl> |
---|
| 546 | |
---|
| 547 | <dl class="method"> |
---|
[f696e2a] | 548 | <dt id="sans.fit.AbstractFitEngine.FitData1D.__rsub__"> |
---|
| 549 | <tt class="descname">__rsub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__rsub__" title="Permalink to this definition">¶</a></dt> |
---|
| 550 | <dd><p>Subtract two data sets</p> |
---|
| 551 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 552 | <col class="field-name" /> |
---|
| 553 | <col class="field-body" /> |
---|
| 554 | <tbody valign="top"> |
---|
| 555 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to subtract from the current one</td> |
---|
| 556 | </tr> |
---|
| 557 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
| 558 | </tr> |
---|
| 559 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
| 560 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
| 561 | </tr> |
---|
| 562 | </tbody> |
---|
| 563 | </table> |
---|
[6b1588b] | 564 | </dd></dl> |
---|
| 565 | |
---|
| 566 | <dl class="method"> |
---|
[f696e2a] | 567 | <dt id="sans.fit.AbstractFitEngine.FitData1D.__str__"> |
---|
| 568 | <tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__str__" title="Permalink to this definition">¶</a></dt> |
---|
| 569 | <dd><p>Nice printout</p> |
---|
[6b1588b] | 570 | </dd></dl> |
---|
| 571 | |
---|
| 572 | <dl class="method"> |
---|
[f696e2a] | 573 | <dt id="sans.fit.AbstractFitEngine.FitData1D.__sub__"> |
---|
| 574 | <tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__sub__" title="Permalink to this definition">¶</a></dt> |
---|
| 575 | <dd><p>Subtract two data sets</p> |
---|
| 576 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 577 | <col class="field-name" /> |
---|
| 578 | <col class="field-body" /> |
---|
| 579 | <tbody valign="top"> |
---|
| 580 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to subtract from the current one</td> |
---|
| 581 | </tr> |
---|
| 582 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
| 583 | </tr> |
---|
| 584 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
| 585 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
| 586 | </tr> |
---|
| 587 | </tbody> |
---|
| 588 | </table> |
---|
[6b1588b] | 589 | </dd></dl> |
---|
| 590 | |
---|
[f696e2a] | 591 | <dl class="method"> |
---|
| 592 | <dt id="sans.fit.AbstractFitEngine.FitData1D._perform_operation"> |
---|
| 593 | <tt class="descname">_perform_operation</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D._perform_operation" title="Permalink to this definition">¶</a></dt> |
---|
| 594 | <dd></dd></dl> |
---|
| 595 | |
---|
| 596 | <dl class="method"> |
---|
| 597 | <dt id="sans.fit.AbstractFitEngine.FitData1D._validity_check"> |
---|
| 598 | <tt class="descname">_validity_check</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D._validity_check" title="Permalink to this definition">¶</a></dt> |
---|
| 599 | <dd><p>Checks that the data lengths are compatible. |
---|
| 600 | Checks that the x vectors are compatible. |
---|
| 601 | Returns errors vectors equal to original |
---|
| 602 | errors vectors if they were present or vectors |
---|
| 603 | of zeros when none was found.</p> |
---|
| 604 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 605 | <col class="field-name" /> |
---|
| 606 | <col class="field-body" /> |
---|
| 607 | <tbody valign="top"> |
---|
| 608 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – other data set for operation</td> |
---|
| 609 | </tr> |
---|
| 610 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">dy for self, dy for other [numpy arrays]</td> |
---|
| 611 | </tr> |
---|
| 612 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
| 613 | <tr class="field-odd field"><td> </td><td class="field-body">when lengths are not compatible</td> |
---|
| 614 | </tr> |
---|
| 615 | </tbody> |
---|
| 616 | </table> |
---|
[6b1588b] | 617 | </dd></dl> |
---|
| 618 | |
---|
[f696e2a] | 619 | <dl class="attribute"> |
---|
| 620 | <dt id="sans.fit.AbstractFitEngine.FitData1D._xaxis"> |
---|
| 621 | <tt class="descname">_xaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D._xaxis" title="Permalink to this definition">¶</a></dt> |
---|
| 622 | <dd></dd></dl> |
---|
| 623 | |
---|
| 624 | <dl class="attribute"> |
---|
| 625 | <dt id="sans.fit.AbstractFitEngine.FitData1D._xunit"> |
---|
| 626 | <tt class="descname">_xunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D._xunit" title="Permalink to this definition">¶</a></dt> |
---|
| 627 | <dd></dd></dl> |
---|
| 628 | |
---|
| 629 | <dl class="attribute"> |
---|
| 630 | <dt id="sans.fit.AbstractFitEngine.FitData1D._yaxis"> |
---|
| 631 | <tt class="descname">_yaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D._yaxis" title="Permalink to this definition">¶</a></dt> |
---|
| 632 | <dd></dd></dl> |
---|
| 633 | |
---|
| 634 | <dl class="attribute"> |
---|
| 635 | <dt id="sans.fit.AbstractFitEngine.FitData1D._yunit"> |
---|
| 636 | <tt class="descname">_yunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D._yunit" title="Permalink to this definition">¶</a></dt> |
---|
| 637 | <dd></dd></dl> |
---|
| 638 | |
---|
[6b1588b] | 639 | <dl class="method"> |
---|
[f696e2a] | 640 | <dt id="sans.fit.AbstractFitEngine.FitData1D.add_notes"> |
---|
| 641 | <tt class="descname">add_notes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.add_notes" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 642 | <dd><p>Add notes to datainfo</p> |
---|
| 643 | </dd></dl> |
---|
| 644 | |
---|
| 645 | <dl class="method"> |
---|
[f696e2a] | 646 | <dt id="sans.fit.AbstractFitEngine.FitData1D.append_empty_process"> |
---|
| 647 | <tt class="descname">append_empty_process</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.append_empty_process" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 648 | <dd></dd></dl> |
---|
| 649 | |
---|
| 650 | <dl class="method"> |
---|
[f696e2a] | 651 | <dt id="sans.fit.AbstractFitEngine.FitData1D.clone_without_data"> |
---|
| 652 | <tt class="descname">clone_without_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.clone_without_data" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 653 | <dd><p>Clone the current object, without copying the data (which |
---|
| 654 | will be filled out by a subsequent operation). |
---|
| 655 | The data arrays will be initialized to zero.</p> |
---|
| 656 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 657 | <col class="field-name" /> |
---|
| 658 | <col class="field-body" /> |
---|
| 659 | <tbody valign="top"> |
---|
[f696e2a] | 660 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
[6b1588b] | 661 | <li><strong>length</strong> – length of the data array to be initialized</li> |
---|
| 662 | <li><strong>clone</strong> – if provided, the data will be copied to clone</li> |
---|
| 663 | </ul> |
---|
| 664 | </td> |
---|
| 665 | </tr> |
---|
| 666 | </tbody> |
---|
| 667 | </table> |
---|
| 668 | </dd></dl> |
---|
| 669 | |
---|
[f696e2a] | 670 | <dl class="attribute"> |
---|
| 671 | <dt id="sans.fit.AbstractFitEngine.FitData1D.collimation"> |
---|
| 672 | <tt class="descname">collimation</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.collimation" title="Permalink to this definition">¶</a></dt> |
---|
| 673 | <dd></dd></dl> |
---|
| 674 | |
---|
| 675 | <dl class="attribute"> |
---|
| 676 | <dt id="sans.fit.AbstractFitEngine.FitData1D.detector"> |
---|
| 677 | <tt class="descname">detector</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.detector" title="Permalink to this definition">¶</a></dt> |
---|
| 678 | <dd></dd></dl> |
---|
| 679 | |
---|
| 680 | <dl class="attribute"> |
---|
| 681 | <dt id="sans.fit.AbstractFitEngine.FitData1D.dx"> |
---|
| 682 | <tt class="descname">dx</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.dx" title="Permalink to this definition">¶</a></dt> |
---|
| 683 | <dd></dd></dl> |
---|
| 684 | |
---|
| 685 | <dl class="attribute"> |
---|
| 686 | <dt id="sans.fit.AbstractFitEngine.FitData1D.dxl"> |
---|
| 687 | <tt class="descname">dxl</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.dxl" title="Permalink to this definition">¶</a></dt> |
---|
| 688 | <dd></dd></dl> |
---|
| 689 | |
---|
| 690 | <dl class="attribute"> |
---|
| 691 | <dt id="sans.fit.AbstractFitEngine.FitData1D.dxw"> |
---|
| 692 | <tt class="descname">dxw</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.dxw" title="Permalink to this definition">¶</a></dt> |
---|
| 693 | <dd></dd></dl> |
---|
| 694 | |
---|
| 695 | <dl class="attribute"> |
---|
| 696 | <dt id="sans.fit.AbstractFitEngine.FitData1D.dy"> |
---|
| 697 | <tt class="descname">dy</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.dy" title="Permalink to this definition">¶</a></dt> |
---|
| 698 | <dd></dd></dl> |
---|
| 699 | |
---|
| 700 | <dl class="attribute"> |
---|
| 701 | <dt id="sans.fit.AbstractFitEngine.FitData1D.errors"> |
---|
| 702 | <tt class="descname">errors</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.errors" title="Permalink to this definition">¶</a></dt> |
---|
| 703 | <dd></dd></dl> |
---|
| 704 | |
---|
| 705 | <dl class="attribute"> |
---|
| 706 | <dt id="sans.fit.AbstractFitEngine.FitData1D.filename"> |
---|
| 707 | <tt class="descname">filename</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.filename" title="Permalink to this definition">¶</a></dt> |
---|
| 708 | <dd></dd></dl> |
---|
| 709 | |
---|
| 710 | <dl class="method"> |
---|
| 711 | <dt id="sans.fit.AbstractFitEngine.FitData1D.get_fit_range"> |
---|
| 712 | <tt class="descname">get_fit_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.get_fit_range" title="Permalink to this definition">¶</a></dt> |
---|
| 713 | <dd><p>return the range of data.x to fit</p> |
---|
| 714 | </dd></dl> |
---|
| 715 | |
---|
| 716 | <dl class="attribute"> |
---|
| 717 | <dt id="sans.fit.AbstractFitEngine.FitData1D.instrument"> |
---|
| 718 | <tt class="descname">instrument</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.instrument" title="Permalink to this definition">¶</a></dt> |
---|
| 719 | <dd></dd></dl> |
---|
| 720 | |
---|
| 721 | <dl class="method"> |
---|
| 722 | <dt id="sans.fit.AbstractFitEngine.FitData1D.is_slit_smeared"> |
---|
| 723 | <tt class="descname">is_slit_smeared</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.is_slit_smeared" title="Permalink to this definition">¶</a></dt> |
---|
| 724 | <dd><p>Check whether the data has slit smearing information</p> |
---|
| 725 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 726 | <col class="field-name" /> |
---|
| 727 | <col class="field-body" /> |
---|
| 728 | <tbody valign="top"> |
---|
| 729 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True is slit smearing info is present, False otherwise</td> |
---|
| 730 | </tr> |
---|
| 731 | </tbody> |
---|
| 732 | </table> |
---|
| 733 | </dd></dl> |
---|
| 734 | |
---|
| 735 | <dl class="attribute"> |
---|
| 736 | <dt id="sans.fit.AbstractFitEngine.FitData1D.meta_data"> |
---|
| 737 | <tt class="descname">meta_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.meta_data" title="Permalink to this definition">¶</a></dt> |
---|
| 738 | <dd></dd></dl> |
---|
| 739 | |
---|
| 740 | <dl class="attribute"> |
---|
| 741 | <dt id="sans.fit.AbstractFitEngine.FitData1D.notes"> |
---|
| 742 | <tt class="descname">notes</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.notes" title="Permalink to this definition">¶</a></dt> |
---|
| 743 | <dd></dd></dl> |
---|
| 744 | |
---|
| 745 | <dl class="attribute"> |
---|
| 746 | <dt id="sans.fit.AbstractFitEngine.FitData1D.process"> |
---|
| 747 | <tt class="descname">process</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.process" title="Permalink to this definition">¶</a></dt> |
---|
| 748 | <dd></dd></dl> |
---|
| 749 | |
---|
| 750 | <dl class="method"> |
---|
| 751 | <dt id="sans.fit.AbstractFitEngine.FitData1D.residuals"> |
---|
| 752 | <tt class="descname">residuals</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.residuals" title="Permalink to this definition">¶</a></dt> |
---|
| 753 | <dd><p>Compute residuals.</p> |
---|
| 754 | <p>If self.smearer has been set, use if to smear |
---|
| 755 | the data before computing chi squared.</p> |
---|
| 756 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 757 | <col class="field-name" /> |
---|
| 758 | <col class="field-body" /> |
---|
| 759 | <tbody valign="top"> |
---|
| 760 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>fn</strong> – function that return model value</td> |
---|
| 761 | </tr> |
---|
| 762 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">residuals</td> |
---|
| 763 | </tr> |
---|
| 764 | </tbody> |
---|
| 765 | </table> |
---|
| 766 | </dd></dl> |
---|
| 767 | |
---|
| 768 | <dl class="method"> |
---|
| 769 | <dt id="sans.fit.AbstractFitEngine.FitData1D.residuals_deriv"> |
---|
| 770 | <tt class="descname">residuals_deriv</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.residuals_deriv" title="Permalink to this definition">¶</a></dt> |
---|
| 771 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
| 772 | <col class="field-name" /> |
---|
| 773 | <col class="field-body" /> |
---|
| 774 | <tbody valign="top"> |
---|
| 775 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">residuals derivatives .</td> |
---|
| 776 | </tr> |
---|
| 777 | <tr class="field-even field"><th class="field-name">Note :</th><td class="field-body">in this case just return empty array</td> |
---|
| 778 | </tr> |
---|
| 779 | </tbody> |
---|
| 780 | </table> |
---|
| 781 | </dd></dl> |
---|
| 782 | |
---|
| 783 | <dl class="attribute"> |
---|
| 784 | <dt id="sans.fit.AbstractFitEngine.FitData1D.run"> |
---|
| 785 | <tt class="descname">run</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.run" title="Permalink to this definition">¶</a></dt> |
---|
| 786 | <dd></dd></dl> |
---|
| 787 | |
---|
| 788 | <dl class="attribute"> |
---|
| 789 | <dt id="sans.fit.AbstractFitEngine.FitData1D.run_name"> |
---|
| 790 | <tt class="descname">run_name</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.run_name" title="Permalink to this definition">¶</a></dt> |
---|
| 791 | <dd></dd></dl> |
---|
| 792 | |
---|
| 793 | <dl class="attribute"> |
---|
| 794 | <dt id="sans.fit.AbstractFitEngine.FitData1D.sample"> |
---|
| 795 | <tt class="descname">sample</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.sample" title="Permalink to this definition">¶</a></dt> |
---|
| 796 | <dd></dd></dl> |
---|
| 797 | |
---|
| 798 | <dl class="method"> |
---|
| 799 | <dt id="sans.fit.AbstractFitEngine.FitData1D.set_fit_range"> |
---|
| 800 | <tt class="descname">set_fit_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.set_fit_range" title="Permalink to this definition">¶</a></dt> |
---|
| 801 | <dd><p>to set the fit range</p> |
---|
| 802 | </dd></dl> |
---|
| 803 | |
---|
| 804 | <dl class="attribute"> |
---|
| 805 | <dt id="sans.fit.AbstractFitEngine.FitData1D.source"> |
---|
| 806 | <tt class="descname">source</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.source" title="Permalink to this definition">¶</a></dt> |
---|
| 807 | <dd></dd></dl> |
---|
| 808 | |
---|
| 809 | <dl class="attribute"> |
---|
| 810 | <dt id="sans.fit.AbstractFitEngine.FitData1D.title"> |
---|
| 811 | <tt class="descname">title</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.title" title="Permalink to this definition">¶</a></dt> |
---|
| 812 | <dd></dd></dl> |
---|
| 813 | |
---|
| 814 | <dl class="attribute"> |
---|
| 815 | <dt id="sans.fit.AbstractFitEngine.FitData1D.x"> |
---|
| 816 | <tt class="descname">x</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.x" title="Permalink to this definition">¶</a></dt> |
---|
| 817 | <dd></dd></dl> |
---|
| 818 | |
---|
| 819 | <dl class="attribute"> |
---|
| 820 | <dt id="sans.fit.AbstractFitEngine.FitData1D.x_unit"> |
---|
| 821 | <tt class="descname">x_unit</tt><em class="property"> = '1/A'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.x_unit" title="Permalink to this definition">¶</a></dt> |
---|
| 822 | <dd></dd></dl> |
---|
| 823 | |
---|
| 824 | <dl class="method"> |
---|
| 825 | <dt id="sans.fit.AbstractFitEngine.FitData1D.xaxis"> |
---|
| 826 | <tt class="descname">xaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.xaxis" title="Permalink to this definition">¶</a></dt> |
---|
| 827 | <dd><p>set the x axis label and unit</p> |
---|
| 828 | </dd></dl> |
---|
| 829 | |
---|
| 830 | <dl class="attribute"> |
---|
| 831 | <dt id="sans.fit.AbstractFitEngine.FitData1D.y"> |
---|
| 832 | <tt class="descname">y</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.y" title="Permalink to this definition">¶</a></dt> |
---|
| 833 | <dd></dd></dl> |
---|
| 834 | |
---|
| 835 | <dl class="attribute"> |
---|
| 836 | <dt id="sans.fit.AbstractFitEngine.FitData1D.y_unit"> |
---|
| 837 | <tt class="descname">y_unit</tt><em class="property"> = '1/cm'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.y_unit" title="Permalink to this definition">¶</a></dt> |
---|
| 838 | <dd></dd></dl> |
---|
| 839 | |
---|
| 840 | <dl class="method"> |
---|
| 841 | <dt id="sans.fit.AbstractFitEngine.FitData1D.yaxis"> |
---|
| 842 | <tt class="descname">yaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.yaxis" title="Permalink to this definition">¶</a></dt> |
---|
| 843 | <dd><p>set the y axis label and unit</p> |
---|
| 844 | </dd></dl> |
---|
| 845 | |
---|
| 846 | </dd></dl> |
---|
| 847 | |
---|
| 848 | <dl class="class"> |
---|
| 849 | <dt id="sans.fit.AbstractFitEngine.FitData2D"> |
---|
| 850 | <em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitData2D</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D" title="Permalink to this definition">¶</a></dt> |
---|
| 851 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.data_info.Data2D</span></tt></p> |
---|
| 852 | <p>Wrapper class for SANS data</p> |
---|
| 853 | <dl class="attribute"> |
---|
| 854 | <dt id="sans.fit.AbstractFitEngine.FitData2D.I_unit"> |
---|
| 855 | <tt class="descname">I_unit</tt><em class="property"> = '1/cm'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.I_unit" title="Permalink to this definition">¶</a></dt> |
---|
| 856 | <dd></dd></dl> |
---|
| 857 | |
---|
| 858 | <dl class="attribute"> |
---|
| 859 | <dt id="sans.fit.AbstractFitEngine.FitData2D.Q_unit"> |
---|
| 860 | <tt class="descname">Q_unit</tt><em class="property"> = '1/A'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.Q_unit" title="Permalink to this definition">¶</a></dt> |
---|
| 861 | <dd></dd></dl> |
---|
| 862 | |
---|
| 863 | <dl class="method"> |
---|
| 864 | <dt id="sans.fit.AbstractFitEngine.FitData2D.__add__"> |
---|
| 865 | <tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__add__" title="Permalink to this definition">¶</a></dt> |
---|
| 866 | <dd><p>Add two data sets</p> |
---|
| 867 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 868 | <col class="field-name" /> |
---|
| 869 | <col class="field-body" /> |
---|
| 870 | <tbody valign="top"> |
---|
| 871 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to add to the current one</td> |
---|
| 872 | </tr> |
---|
| 873 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
| 874 | </tr> |
---|
| 875 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
| 876 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
| 877 | </tr> |
---|
| 878 | </tbody> |
---|
| 879 | </table> |
---|
| 880 | </dd></dl> |
---|
| 881 | |
---|
| 882 | <dl class="method"> |
---|
| 883 | <dt id="sans.fit.AbstractFitEngine.FitData2D.__div__"> |
---|
| 884 | <tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__div__" title="Permalink to this definition">¶</a></dt> |
---|
| 885 | <dd><p>Divided a data set by another</p> |
---|
| 886 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 887 | <col class="field-name" /> |
---|
| 888 | <col class="field-body" /> |
---|
| 889 | <tbody valign="top"> |
---|
| 890 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set that the current one is divided by</td> |
---|
| 891 | </tr> |
---|
| 892 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
| 893 | </tr> |
---|
| 894 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
| 895 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
| 896 | </tr> |
---|
| 897 | </tbody> |
---|
| 898 | </table> |
---|
| 899 | </dd></dl> |
---|
| 900 | |
---|
| 901 | <dl class="method"> |
---|
| 902 | <dt id="sans.fit.AbstractFitEngine.FitData2D.__init__"> |
---|
| 903 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__init__" title="Permalink to this definition">¶</a></dt> |
---|
| 904 | <dd></dd></dl> |
---|
| 905 | |
---|
| 906 | <dl class="attribute"> |
---|
| 907 | <dt id="sans.fit.AbstractFitEngine.FitData2D.__module__"> |
---|
| 908 | <tt class="descname">__module__</tt><em class="property"> = 'sans.fit.AbstractFitEngine'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__module__" title="Permalink to this definition">¶</a></dt> |
---|
| 909 | <dd></dd></dl> |
---|
| 910 | |
---|
| 911 | <dl class="method"> |
---|
| 912 | <dt id="sans.fit.AbstractFitEngine.FitData2D.__mul__"> |
---|
| 913 | <tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__mul__" title="Permalink to this definition">¶</a></dt> |
---|
| 914 | <dd><p>Multiply two data sets</p> |
---|
| 915 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 916 | <col class="field-name" /> |
---|
| 917 | <col class="field-body" /> |
---|
| 918 | <tbody valign="top"> |
---|
| 919 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to subtract from the current one</td> |
---|
| 920 | </tr> |
---|
| 921 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
| 922 | </tr> |
---|
| 923 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
| 924 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
| 925 | </tr> |
---|
| 926 | </tbody> |
---|
| 927 | </table> |
---|
| 928 | </dd></dl> |
---|
| 929 | |
---|
| 930 | <dl class="method"> |
---|
| 931 | <dt id="sans.fit.AbstractFitEngine.FitData2D.__radd__"> |
---|
| 932 | <tt class="descname">__radd__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__radd__" title="Permalink to this definition">¶</a></dt> |
---|
| 933 | <dd><p>Add two data sets</p> |
---|
| 934 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 935 | <col class="field-name" /> |
---|
| 936 | <col class="field-body" /> |
---|
| 937 | <tbody valign="top"> |
---|
| 938 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to add to the current one</td> |
---|
| 939 | </tr> |
---|
| 940 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
| 941 | </tr> |
---|
| 942 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
| 943 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
| 944 | </tr> |
---|
| 945 | </tbody> |
---|
| 946 | </table> |
---|
| 947 | </dd></dl> |
---|
| 948 | |
---|
| 949 | <dl class="method"> |
---|
| 950 | <dt id="sans.fit.AbstractFitEngine.FitData2D.__rdiv__"> |
---|
| 951 | <tt class="descname">__rdiv__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__rdiv__" title="Permalink to this definition">¶</a></dt> |
---|
| 952 | <dd><p>Divided a data set by another</p> |
---|
| 953 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 954 | <col class="field-name" /> |
---|
| 955 | <col class="field-body" /> |
---|
| 956 | <tbody valign="top"> |
---|
| 957 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set that the current one is divided by</td> |
---|
| 958 | </tr> |
---|
| 959 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
| 960 | </tr> |
---|
| 961 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
| 962 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
| 963 | </tr> |
---|
| 964 | </tbody> |
---|
| 965 | </table> |
---|
| 966 | </dd></dl> |
---|
| 967 | |
---|
| 968 | <dl class="method"> |
---|
| 969 | <dt id="sans.fit.AbstractFitEngine.FitData2D.__rmul__"> |
---|
| 970 | <tt class="descname">__rmul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__rmul__" title="Permalink to this definition">¶</a></dt> |
---|
| 971 | <dd><p>Multiply two data sets</p> |
---|
| 972 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 973 | <col class="field-name" /> |
---|
| 974 | <col class="field-body" /> |
---|
| 975 | <tbody valign="top"> |
---|
| 976 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to subtract from the current one</td> |
---|
| 977 | </tr> |
---|
| 978 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
| 979 | </tr> |
---|
| 980 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
| 981 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
| 982 | </tr> |
---|
| 983 | </tbody> |
---|
| 984 | </table> |
---|
| 985 | </dd></dl> |
---|
| 986 | |
---|
| 987 | <dl class="method"> |
---|
| 988 | <dt id="sans.fit.AbstractFitEngine.FitData2D.__rsub__"> |
---|
| 989 | <tt class="descname">__rsub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__rsub__" title="Permalink to this definition">¶</a></dt> |
---|
| 990 | <dd><p>Subtract two data sets</p> |
---|
| 991 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 992 | <col class="field-name" /> |
---|
| 993 | <col class="field-body" /> |
---|
| 994 | <tbody valign="top"> |
---|
| 995 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to subtract from the current one</td> |
---|
| 996 | </tr> |
---|
| 997 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
| 998 | </tr> |
---|
| 999 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
| 1000 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
| 1001 | </tr> |
---|
| 1002 | </tbody> |
---|
| 1003 | </table> |
---|
| 1004 | </dd></dl> |
---|
| 1005 | |
---|
| 1006 | <dl class="method"> |
---|
| 1007 | <dt id="sans.fit.AbstractFitEngine.FitData2D.__str__"> |
---|
| 1008 | <tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__str__" title="Permalink to this definition">¶</a></dt> |
---|
| 1009 | <dd></dd></dl> |
---|
| 1010 | |
---|
| 1011 | <dl class="method"> |
---|
| 1012 | <dt id="sans.fit.AbstractFitEngine.FitData2D.__sub__"> |
---|
| 1013 | <tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__sub__" title="Permalink to this definition">¶</a></dt> |
---|
| 1014 | <dd><p>Subtract two data sets</p> |
---|
| 1015 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1016 | <col class="field-name" /> |
---|
| 1017 | <col class="field-body" /> |
---|
| 1018 | <tbody valign="top"> |
---|
| 1019 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – data set to subtract from the current one</td> |
---|
| 1020 | </tr> |
---|
| 1021 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> |
---|
| 1022 | </tr> |
---|
| 1023 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
| 1024 | <tr class="field-odd field"><td> </td><td class="field-body">raised when two data sets are incompatible</td> |
---|
| 1025 | </tr> |
---|
| 1026 | </tbody> |
---|
| 1027 | </table> |
---|
| 1028 | </dd></dl> |
---|
| 1029 | |
---|
| 1030 | <dl class="method"> |
---|
| 1031 | <dt id="sans.fit.AbstractFitEngine.FitData2D._perform_operation"> |
---|
| 1032 | <tt class="descname">_perform_operation</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D._perform_operation" title="Permalink to this definition">¶</a></dt> |
---|
| 1033 | <dd><p>Perform 2D operations between data sets</p> |
---|
| 1034 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1035 | <col class="field-name" /> |
---|
| 1036 | <col class="field-body" /> |
---|
| 1037 | <tbody valign="top"> |
---|
| 1038 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 1039 | <li><strong>other</strong> – other data set</li> |
---|
| 1040 | <li><strong>operation</strong> – function defining the operation</li> |
---|
| 1041 | </ul> |
---|
| 1042 | </td> |
---|
| 1043 | </tr> |
---|
| 1044 | </tbody> |
---|
| 1045 | </table> |
---|
| 1046 | </dd></dl> |
---|
| 1047 | |
---|
| 1048 | <dl class="method"> |
---|
| 1049 | <dt id="sans.fit.AbstractFitEngine.FitData2D._validity_check"> |
---|
| 1050 | <tt class="descname">_validity_check</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D._validity_check" title="Permalink to this definition">¶</a></dt> |
---|
| 1051 | <dd><p>Checks that the data lengths are compatible. |
---|
| 1052 | Checks that the x vectors are compatible. |
---|
| 1053 | Returns errors vectors equal to original |
---|
| 1054 | errors vectors if they were present or vectors |
---|
| 1055 | of zeros when none was found.</p> |
---|
| 1056 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1057 | <col class="field-name" /> |
---|
| 1058 | <col class="field-body" /> |
---|
| 1059 | <tbody valign="top"> |
---|
| 1060 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> – other data set for operation</td> |
---|
| 1061 | </tr> |
---|
| 1062 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">dy for self, dy for other [numpy arrays]</td> |
---|
| 1063 | </tr> |
---|
| 1064 | <tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> |
---|
| 1065 | <tr class="field-odd field"><td> </td><td class="field-body">when lengths are not compatible</td> |
---|
| 1066 | </tr> |
---|
| 1067 | </tbody> |
---|
| 1068 | </table> |
---|
| 1069 | </dd></dl> |
---|
| 1070 | |
---|
| 1071 | <dl class="attribute"> |
---|
| 1072 | <dt id="sans.fit.AbstractFitEngine.FitData2D._xaxis"> |
---|
| 1073 | <tt class="descname">_xaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D._xaxis" title="Permalink to this definition">¶</a></dt> |
---|
| 1074 | <dd></dd></dl> |
---|
| 1075 | |
---|
| 1076 | <dl class="attribute"> |
---|
| 1077 | <dt id="sans.fit.AbstractFitEngine.FitData2D._xunit"> |
---|
| 1078 | <tt class="descname">_xunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D._xunit" title="Permalink to this definition">¶</a></dt> |
---|
| 1079 | <dd></dd></dl> |
---|
| 1080 | |
---|
| 1081 | <dl class="attribute"> |
---|
| 1082 | <dt id="sans.fit.AbstractFitEngine.FitData2D._yaxis"> |
---|
| 1083 | <tt class="descname">_yaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D._yaxis" title="Permalink to this definition">¶</a></dt> |
---|
| 1084 | <dd></dd></dl> |
---|
| 1085 | |
---|
| 1086 | <dl class="attribute"> |
---|
| 1087 | <dt id="sans.fit.AbstractFitEngine.FitData2D._yunit"> |
---|
| 1088 | <tt class="descname">_yunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D._yunit" title="Permalink to this definition">¶</a></dt> |
---|
| 1089 | <dd></dd></dl> |
---|
| 1090 | |
---|
| 1091 | <dl class="attribute"> |
---|
| 1092 | <dt id="sans.fit.AbstractFitEngine.FitData2D._zaxis"> |
---|
| 1093 | <tt class="descname">_zaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D._zaxis" title="Permalink to this definition">¶</a></dt> |
---|
| 1094 | <dd></dd></dl> |
---|
| 1095 | |
---|
| 1096 | <dl class="attribute"> |
---|
| 1097 | <dt id="sans.fit.AbstractFitEngine.FitData2D._zunit"> |
---|
| 1098 | <tt class="descname">_zunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D._zunit" title="Permalink to this definition">¶</a></dt> |
---|
| 1099 | <dd></dd></dl> |
---|
| 1100 | |
---|
| 1101 | <dl class="method"> |
---|
| 1102 | <dt id="sans.fit.AbstractFitEngine.FitData2D.add_notes"> |
---|
| 1103 | <tt class="descname">add_notes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.add_notes" title="Permalink to this definition">¶</a></dt> |
---|
| 1104 | <dd><p>Add notes to datainfo</p> |
---|
| 1105 | </dd></dl> |
---|
| 1106 | |
---|
| 1107 | <dl class="method"> |
---|
| 1108 | <dt id="sans.fit.AbstractFitEngine.FitData2D.append_empty_process"> |
---|
| 1109 | <tt class="descname">append_empty_process</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.append_empty_process" title="Permalink to this definition">¶</a></dt> |
---|
| 1110 | <dd></dd></dl> |
---|
| 1111 | |
---|
| 1112 | <dl class="method"> |
---|
| 1113 | <dt id="sans.fit.AbstractFitEngine.FitData2D.clone_without_data"> |
---|
| 1114 | <tt class="descname">clone_without_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.clone_without_data" title="Permalink to this definition">¶</a></dt> |
---|
| 1115 | <dd><p>Clone the current object, without copying the data (which |
---|
| 1116 | will be filled out by a subsequent operation). |
---|
| 1117 | The data arrays will be initialized to zero.</p> |
---|
| 1118 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1119 | <col class="field-name" /> |
---|
| 1120 | <col class="field-body" /> |
---|
| 1121 | <tbody valign="top"> |
---|
| 1122 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 1123 | <li><strong>length</strong> – length of the data array to be initialized</li> |
---|
| 1124 | <li><strong>clone</strong> – if provided, the data will be copied to clone</li> |
---|
| 1125 | </ul> |
---|
| 1126 | </td> |
---|
| 1127 | </tr> |
---|
| 1128 | </tbody> |
---|
| 1129 | </table> |
---|
| 1130 | </dd></dl> |
---|
| 1131 | |
---|
| 1132 | <dl class="attribute"> |
---|
| 1133 | <dt id="sans.fit.AbstractFitEngine.FitData2D.collimation"> |
---|
| 1134 | <tt class="descname">collimation</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.collimation" title="Permalink to this definition">¶</a></dt> |
---|
| 1135 | <dd></dd></dl> |
---|
| 1136 | |
---|
| 1137 | <dl class="attribute"> |
---|
| 1138 | <dt id="sans.fit.AbstractFitEngine.FitData2D.data"> |
---|
| 1139 | <tt class="descname">data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.data" title="Permalink to this definition">¶</a></dt> |
---|
| 1140 | <dd></dd></dl> |
---|
| 1141 | |
---|
| 1142 | <dl class="attribute"> |
---|
| 1143 | <dt id="sans.fit.AbstractFitEngine.FitData2D.detector"> |
---|
| 1144 | <tt class="descname">detector</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.detector" title="Permalink to this definition">¶</a></dt> |
---|
| 1145 | <dd></dd></dl> |
---|
| 1146 | |
---|
| 1147 | <dl class="attribute"> |
---|
| 1148 | <dt id="sans.fit.AbstractFitEngine.FitData2D.dqx_data"> |
---|
| 1149 | <tt class="descname">dqx_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.dqx_data" title="Permalink to this definition">¶</a></dt> |
---|
| 1150 | <dd></dd></dl> |
---|
| 1151 | |
---|
| 1152 | <dl class="attribute"> |
---|
| 1153 | <dt id="sans.fit.AbstractFitEngine.FitData2D.dqy_data"> |
---|
| 1154 | <tt class="descname">dqy_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.dqy_data" title="Permalink to this definition">¶</a></dt> |
---|
| 1155 | <dd></dd></dl> |
---|
| 1156 | |
---|
| 1157 | <dl class="attribute"> |
---|
| 1158 | <dt id="sans.fit.AbstractFitEngine.FitData2D.err_data"> |
---|
| 1159 | <tt class="descname">err_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.err_data" title="Permalink to this definition">¶</a></dt> |
---|
| 1160 | <dd></dd></dl> |
---|
| 1161 | |
---|
| 1162 | <dl class="attribute"> |
---|
| 1163 | <dt id="sans.fit.AbstractFitEngine.FitData2D.errors"> |
---|
| 1164 | <tt class="descname">errors</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.errors" title="Permalink to this definition">¶</a></dt> |
---|
| 1165 | <dd></dd></dl> |
---|
| 1166 | |
---|
| 1167 | <dl class="attribute"> |
---|
| 1168 | <dt id="sans.fit.AbstractFitEngine.FitData2D.filename"> |
---|
| 1169 | <tt class="descname">filename</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.filename" title="Permalink to this definition">¶</a></dt> |
---|
| 1170 | <dd></dd></dl> |
---|
| 1171 | |
---|
| 1172 | <dl class="method"> |
---|
| 1173 | <dt id="sans.fit.AbstractFitEngine.FitData2D.get_fit_range"> |
---|
| 1174 | <tt class="descname">get_fit_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.get_fit_range" title="Permalink to this definition">¶</a></dt> |
---|
| 1175 | <dd><p>return the range of data.x to fit</p> |
---|
| 1176 | </dd></dl> |
---|
| 1177 | |
---|
| 1178 | <dl class="attribute"> |
---|
| 1179 | <dt id="sans.fit.AbstractFitEngine.FitData2D.instrument"> |
---|
| 1180 | <tt class="descname">instrument</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.instrument" title="Permalink to this definition">¶</a></dt> |
---|
| 1181 | <dd></dd></dl> |
---|
| 1182 | |
---|
| 1183 | <dl class="attribute"> |
---|
| 1184 | <dt id="sans.fit.AbstractFitEngine.FitData2D.mask"> |
---|
| 1185 | <tt class="descname">mask</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.mask" title="Permalink to this definition">¶</a></dt> |
---|
| 1186 | <dd></dd></dl> |
---|
| 1187 | |
---|
| 1188 | <dl class="attribute"> |
---|
| 1189 | <dt id="sans.fit.AbstractFitEngine.FitData2D.meta_data"> |
---|
| 1190 | <tt class="descname">meta_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.meta_data" title="Permalink to this definition">¶</a></dt> |
---|
| 1191 | <dd></dd></dl> |
---|
| 1192 | |
---|
| 1193 | <dl class="attribute"> |
---|
| 1194 | <dt id="sans.fit.AbstractFitEngine.FitData2D.notes"> |
---|
| 1195 | <tt class="descname">notes</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.notes" title="Permalink to this definition">¶</a></dt> |
---|
| 1196 | <dd></dd></dl> |
---|
| 1197 | |
---|
| 1198 | <dl class="attribute"> |
---|
| 1199 | <dt id="sans.fit.AbstractFitEngine.FitData2D.process"> |
---|
| 1200 | <tt class="descname">process</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.process" title="Permalink to this definition">¶</a></dt> |
---|
| 1201 | <dd></dd></dl> |
---|
| 1202 | |
---|
| 1203 | <dl class="attribute"> |
---|
| 1204 | <dt id="sans.fit.AbstractFitEngine.FitData2D.q_data"> |
---|
| 1205 | <tt class="descname">q_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.q_data" title="Permalink to this definition">¶</a></dt> |
---|
| 1206 | <dd></dd></dl> |
---|
| 1207 | |
---|
| 1208 | <dl class="attribute"> |
---|
| 1209 | <dt id="sans.fit.AbstractFitEngine.FitData2D.qx_data"> |
---|
| 1210 | <tt class="descname">qx_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.qx_data" title="Permalink to this definition">¶</a></dt> |
---|
| 1211 | <dd></dd></dl> |
---|
| 1212 | |
---|
| 1213 | <dl class="attribute"> |
---|
| 1214 | <dt id="sans.fit.AbstractFitEngine.FitData2D.qy_data"> |
---|
| 1215 | <tt class="descname">qy_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.qy_data" title="Permalink to this definition">¶</a></dt> |
---|
| 1216 | <dd></dd></dl> |
---|
[6b1588b] | 1217 | |
---|
| 1218 | <dl class="method"> |
---|
| 1219 | <dt id="sans.fit.AbstractFitEngine.FitData2D.residuals"> |
---|
[f696e2a] | 1220 | <tt class="descname">residuals</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.residuals" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1221 | <dd><p>return the residuals</p> |
---|
| 1222 | </dd></dl> |
---|
| 1223 | |
---|
| 1224 | <dl class="method"> |
---|
| 1225 | <dt id="sans.fit.AbstractFitEngine.FitData2D.residuals_deriv"> |
---|
[f696e2a] | 1226 | <tt class="descname">residuals_deriv</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.residuals_deriv" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1227 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
| 1228 | <col class="field-name" /> |
---|
| 1229 | <col class="field-body" /> |
---|
| 1230 | <tbody valign="top"> |
---|
[f696e2a] | 1231 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">residuals derivatives .</td> |
---|
[6b1588b] | 1232 | </tr> |
---|
[f696e2a] | 1233 | <tr class="field-even field"><th class="field-name">Note :</th><td class="field-body">in this case just return empty array</td> |
---|
[6b1588b] | 1234 | </tr> |
---|
| 1235 | </tbody> |
---|
| 1236 | </table> |
---|
| 1237 | </dd></dl> |
---|
| 1238 | |
---|
[f696e2a] | 1239 | <dl class="attribute"> |
---|
| 1240 | <dt id="sans.fit.AbstractFitEngine.FitData2D.run"> |
---|
| 1241 | <tt class="descname">run</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.run" title="Permalink to this definition">¶</a></dt> |
---|
| 1242 | <dd></dd></dl> |
---|
| 1243 | |
---|
| 1244 | <dl class="attribute"> |
---|
| 1245 | <dt id="sans.fit.AbstractFitEngine.FitData2D.run_name"> |
---|
| 1246 | <tt class="descname">run_name</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.run_name" title="Permalink to this definition">¶</a></dt> |
---|
| 1247 | <dd></dd></dl> |
---|
| 1248 | |
---|
| 1249 | <dl class="attribute"> |
---|
| 1250 | <dt id="sans.fit.AbstractFitEngine.FitData2D.sample"> |
---|
| 1251 | <tt class="descname">sample</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.sample" title="Permalink to this definition">¶</a></dt> |
---|
| 1252 | <dd></dd></dl> |
---|
| 1253 | |
---|
[6b1588b] | 1254 | <dl class="method"> |
---|
| 1255 | <dt id="sans.fit.AbstractFitEngine.FitData2D.set_data"> |
---|
[f696e2a] | 1256 | <tt class="descname">set_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.set_data" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1257 | <dd><p>Determine the correct qx_data and qy_data within range to fit</p> |
---|
| 1258 | </dd></dl> |
---|
| 1259 | |
---|
| 1260 | <dl class="method"> |
---|
| 1261 | <dt id="sans.fit.AbstractFitEngine.FitData2D.set_fit_range"> |
---|
[f696e2a] | 1262 | <tt class="descname">set_fit_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.set_fit_range" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1263 | <dd><p>to set the fit range</p> |
---|
| 1264 | </dd></dl> |
---|
| 1265 | |
---|
| 1266 | <dl class="method"> |
---|
| 1267 | <dt id="sans.fit.AbstractFitEngine.FitData2D.set_smearer"> |
---|
[f696e2a] | 1268 | <tt class="descname">set_smearer</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.set_smearer" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1269 | <dd><p>Set smearer</p> |
---|
| 1270 | </dd></dl> |
---|
| 1271 | |
---|
[f696e2a] | 1272 | <dl class="attribute"> |
---|
| 1273 | <dt id="sans.fit.AbstractFitEngine.FitData2D.source"> |
---|
| 1274 | <tt class="descname">source</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.source" title="Permalink to this definition">¶</a></dt> |
---|
| 1275 | <dd></dd></dl> |
---|
| 1276 | |
---|
| 1277 | <dl class="attribute"> |
---|
| 1278 | <dt id="sans.fit.AbstractFitEngine.FitData2D.title"> |
---|
| 1279 | <tt class="descname">title</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.title" title="Permalink to this definition">¶</a></dt> |
---|
| 1280 | <dd></dd></dl> |
---|
| 1281 | |
---|
| 1282 | <dl class="attribute"> |
---|
| 1283 | <dt id="sans.fit.AbstractFitEngine.FitData2D.x_bins"> |
---|
| 1284 | <tt class="descname">x_bins</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.x_bins" title="Permalink to this definition">¶</a></dt> |
---|
| 1285 | <dd></dd></dl> |
---|
| 1286 | |
---|
[6b1588b] | 1287 | <dl class="method"> |
---|
| 1288 | <dt id="sans.fit.AbstractFitEngine.FitData2D.xaxis"> |
---|
[f696e2a] | 1289 | <tt class="descname">xaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.xaxis" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1290 | <dd><p>set the x axis label and unit</p> |
---|
| 1291 | </dd></dl> |
---|
| 1292 | |
---|
[f696e2a] | 1293 | <dl class="attribute"> |
---|
| 1294 | <dt id="sans.fit.AbstractFitEngine.FitData2D.xmax"> |
---|
| 1295 | <tt class="descname">xmax</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.xmax" title="Permalink to this definition">¶</a></dt> |
---|
| 1296 | <dd></dd></dl> |
---|
| 1297 | |
---|
| 1298 | <dl class="attribute"> |
---|
| 1299 | <dt id="sans.fit.AbstractFitEngine.FitData2D.xmin"> |
---|
| 1300 | <tt class="descname">xmin</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.xmin" title="Permalink to this definition">¶</a></dt> |
---|
| 1301 | <dd></dd></dl> |
---|
| 1302 | |
---|
| 1303 | <dl class="attribute"> |
---|
| 1304 | <dt id="sans.fit.AbstractFitEngine.FitData2D.y_bins"> |
---|
| 1305 | <tt class="descname">y_bins</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.y_bins" title="Permalink to this definition">¶</a></dt> |
---|
| 1306 | <dd></dd></dl> |
---|
| 1307 | |
---|
[6b1588b] | 1308 | <dl class="method"> |
---|
| 1309 | <dt id="sans.fit.AbstractFitEngine.FitData2D.yaxis"> |
---|
[f696e2a] | 1310 | <tt class="descname">yaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.yaxis" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1311 | <dd><p>set the y axis label and unit</p> |
---|
| 1312 | </dd></dl> |
---|
| 1313 | |
---|
[f696e2a] | 1314 | <dl class="attribute"> |
---|
| 1315 | <dt id="sans.fit.AbstractFitEngine.FitData2D.ymax"> |
---|
| 1316 | <tt class="descname">ymax</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.ymax" title="Permalink to this definition">¶</a></dt> |
---|
| 1317 | <dd></dd></dl> |
---|
| 1318 | |
---|
| 1319 | <dl class="attribute"> |
---|
| 1320 | <dt id="sans.fit.AbstractFitEngine.FitData2D.ymin"> |
---|
| 1321 | <tt class="descname">ymin</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.ymin" title="Permalink to this definition">¶</a></dt> |
---|
| 1322 | <dd></dd></dl> |
---|
| 1323 | |
---|
[6b1588b] | 1324 | <dl class="method"> |
---|
| 1325 | <dt id="sans.fit.AbstractFitEngine.FitData2D.zaxis"> |
---|
[f696e2a] | 1326 | <tt class="descname">zaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.zaxis" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1327 | <dd><p>set the z axis label and unit</p> |
---|
| 1328 | </dd></dl> |
---|
| 1329 | |
---|
| 1330 | </dd></dl> |
---|
| 1331 | |
---|
| 1332 | <dl class="class"> |
---|
| 1333 | <dt id="sans.fit.AbstractFitEngine.FitEngine"> |
---|
| 1334 | <em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitEngine</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine" title="Permalink to this definition">¶</a></dt> |
---|
| 1335 | <dd><dl class="method"> |
---|
[f696e2a] | 1336 | <dt id="sans.fit.AbstractFitEngine.FitEngine.__init__"> |
---|
| 1337 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.__init__" title="Permalink to this definition">¶</a></dt> |
---|
| 1338 | <dd><p>Base class for scipy and park fit engine</p> |
---|
| 1339 | </dd></dl> |
---|
| 1340 | |
---|
| 1341 | <dl class="attribute"> |
---|
| 1342 | <dt id="sans.fit.AbstractFitEngine.FitEngine.__module__"> |
---|
| 1343 | <tt class="descname">__module__</tt><em class="property"> = 'sans.fit.AbstractFitEngine'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.__module__" title="Permalink to this definition">¶</a></dt> |
---|
| 1344 | <dd></dd></dl> |
---|
| 1345 | |
---|
| 1346 | <dl class="method"> |
---|
[6b1588b] | 1347 | <dt id="sans.fit.AbstractFitEngine.FitEngine.get_model"> |
---|
[f696e2a] | 1348 | <tt class="descname">get_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.get_model" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1349 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
| 1350 | <col class="field-name" /> |
---|
| 1351 | <col class="field-body" /> |
---|
| 1352 | <tbody valign="top"> |
---|
[f696e2a] | 1353 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – id is key in the dictionary containing the model to return</td> |
---|
[6b1588b] | 1354 | </tr> |
---|
[f696e2a] | 1355 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a model at this id or None if no FitArrange element was |
---|
[6b1588b] | 1356 | created with this id</td> |
---|
| 1357 | </tr> |
---|
| 1358 | </tbody> |
---|
| 1359 | </table> |
---|
| 1360 | </dd></dl> |
---|
| 1361 | |
---|
| 1362 | <dl class="method"> |
---|
| 1363 | <dt id="sans.fit.AbstractFitEngine.FitEngine.get_problem_to_fit"> |
---|
[f696e2a] | 1364 | <tt class="descname">get_problem_to_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.get_problem_to_fit" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1365 | <dd><p>return the self.selected value of the fit problem of id</p> |
---|
| 1366 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1367 | <col class="field-name" /> |
---|
| 1368 | <col class="field-body" /> |
---|
| 1369 | <tbody valign="top"> |
---|
[f696e2a] | 1370 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – the id of the problem</td> |
---|
[6b1588b] | 1371 | </tr> |
---|
| 1372 | </tbody> |
---|
| 1373 | </table> |
---|
| 1374 | </dd></dl> |
---|
| 1375 | |
---|
| 1376 | <dl class="method"> |
---|
| 1377 | <dt id="sans.fit.AbstractFitEngine.FitEngine.remove_fit_problem"> |
---|
[f696e2a] | 1378 | <tt class="descname">remove_fit_problem</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.remove_fit_problem" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1379 | <dd><p>remove fitarrange in id</p> |
---|
| 1380 | </dd></dl> |
---|
| 1381 | |
---|
| 1382 | <dl class="method"> |
---|
| 1383 | <dt id="sans.fit.AbstractFitEngine.FitEngine.select_problem_for_fit"> |
---|
[f696e2a] | 1384 | <tt class="descname">select_problem_for_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.select_problem_for_fit" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1385 | <dd><p>select a couple of model and data at the id position in dictionary |
---|
| 1386 | and set in self.selected value to value</p> |
---|
| 1387 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1388 | <col class="field-name" /> |
---|
| 1389 | <col class="field-body" /> |
---|
| 1390 | <tbody valign="top"> |
---|
[f696e2a] | 1391 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> – the value to allow fitting. |
---|
[6b1588b] | 1392 | can only have the value one or zero</td> |
---|
| 1393 | </tr> |
---|
| 1394 | </tbody> |
---|
| 1395 | </table> |
---|
| 1396 | </dd></dl> |
---|
| 1397 | |
---|
| 1398 | <dl class="method"> |
---|
| 1399 | <dt id="sans.fit.AbstractFitEngine.FitEngine.set_data"> |
---|
[f696e2a] | 1400 | <tt class="descname">set_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.set_data" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1401 | <dd><p>Receives plottable, creates a list of data to fit,set data |
---|
| 1402 | in a FitArrange object and adds that object in a dictionary |
---|
| 1403 | with key id.</p> |
---|
| 1404 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1405 | <col class="field-name" /> |
---|
| 1406 | <col class="field-body" /> |
---|
| 1407 | <tbody valign="top"> |
---|
[f696e2a] | 1408 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
[6b1588b] | 1409 | <li><strong>data</strong> – data added</li> |
---|
| 1410 | <li><strong>id</strong> – unique key corresponding to a fitArrange object with data</li> |
---|
| 1411 | </ul> |
---|
| 1412 | </td> |
---|
| 1413 | </tr> |
---|
| 1414 | </tbody> |
---|
| 1415 | </table> |
---|
| 1416 | </dd></dl> |
---|
| 1417 | |
---|
| 1418 | <dl class="method"> |
---|
| 1419 | <dt id="sans.fit.AbstractFitEngine.FitEngine.set_model"> |
---|
[f696e2a] | 1420 | <tt class="descname">set_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.set_model" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1421 | <dd><p>set a model on a given in the fit engine.</p> |
---|
| 1422 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1423 | <col class="field-name" /> |
---|
| 1424 | <col class="field-body" /> |
---|
| 1425 | <tbody valign="top"> |
---|
[f696e2a] | 1426 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – sans.models type</td> |
---|
[6b1588b] | 1427 | </tr> |
---|
| 1428 | </tbody> |
---|
| 1429 | </table> |
---|
| 1430 | <dl class="docutils"> |
---|
| 1431 | <dt>:param <span class="classifier-delimiter">:</span> <span class="classifier">is the key of the fitArrange dictionary where model is </span></dt> |
---|
| 1432 | <dd>saved as a value</dd> |
---|
| 1433 | </dl> |
---|
| 1434 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1435 | <col class="field-name" /> |
---|
| 1436 | <col class="field-body" /> |
---|
| 1437 | <tbody valign="top"> |
---|
[f696e2a] | 1438 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
[6b1588b] | 1439 | <li><strong>pars</strong> – the list of parameters to fit</li> |
---|
| 1440 | <li><strong>constraints</strong> – <p>list of |
---|
| 1441 | tuple (name of parameter, value of parameters) |
---|
| 1442 | the value of parameter must be a string to constraint 2 different |
---|
| 1443 | parameters. |
---|
| 1444 | Example: |
---|
| 1445 | we want to fit 2 model M1 and M2 both have parameters A and B. |
---|
| 1446 | constraints can be:</p> |
---|
| 1447 | <blockquote> |
---|
| 1448 | <div>constraints = [(M1.A, M2.B+2), (M1.B= M2.A <a href="#id1"><span class="problematic" id="id2">*</span></a>5),...,]</div></blockquote> |
---|
| 1449 | </li> |
---|
| 1450 | </ul> |
---|
| 1451 | </td> |
---|
| 1452 | </tr> |
---|
[f696e2a] | 1453 | <tr class="field-even field"><th class="field-name">Note :</th><td class="field-body"><p class="first last">pars must contains only name of existing model’s parameters</p> |
---|
[6b1588b] | 1454 | </td> |
---|
| 1455 | </tr> |
---|
| 1456 | </tbody> |
---|
| 1457 | </table> |
---|
| 1458 | </dd></dl> |
---|
| 1459 | |
---|
| 1460 | </dd></dl> |
---|
| 1461 | |
---|
| 1462 | <dl class="class"> |
---|
| 1463 | <dt id="sans.fit.AbstractFitEngine.Model"> |
---|
[f696e2a] | 1464 | <em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">Model</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1465 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">park.model.Model</span></tt></p> |
---|
| 1466 | <p>PARK wrapper for SANS models.</p> |
---|
| 1467 | <dl class="method"> |
---|
[f696e2a] | 1468 | <dt id="sans.fit.AbstractFitEngine.Model.__call__"> |
---|
| 1469 | <tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__call__" title="Permalink to this definition">¶</a></dt> |
---|
| 1470 | <dd></dd></dl> |
---|
| 1471 | |
---|
| 1472 | <dl class="attribute"> |
---|
| 1473 | <dt id="sans.fit.AbstractFitEngine.Model.__class__"> |
---|
| 1474 | <tt class="descname">__class__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__class__" title="Permalink to this definition">¶</a></dt> |
---|
| 1475 | <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">MetaModel</span></tt></p> |
---|
| 1476 | </dd></dl> |
---|
| 1477 | |
---|
| 1478 | <dl class="attribute"> |
---|
| 1479 | <dt id="sans.fit.AbstractFitEngine.Model.__delattr__"> |
---|
| 1480 | <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__delattr__" title="Permalink to this definition">¶</a></dt> |
---|
| 1481 | <dd><p>x.__delattr__(‘name’) <==> del x.name</p> |
---|
| 1482 | </dd></dl> |
---|
| 1483 | |
---|
| 1484 | <dl class="attribute"> |
---|
| 1485 | <dt id="sans.fit.AbstractFitEngine.Model.__dict__"> |
---|
| 1486 | <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x020725F0></em><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__dict__" title="Permalink to this definition">¶</a></dt> |
---|
| 1487 | <dd></dd></dl> |
---|
| 1488 | |
---|
| 1489 | <dl class="attribute"> |
---|
| 1490 | <dt id="sans.fit.AbstractFitEngine.Model.__getattribute__"> |
---|
| 1491 | <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__getattribute__" title="Permalink to this definition">¶</a></dt> |
---|
| 1492 | <dd><p>x.__getattribute__(‘name’) <==> x.name</p> |
---|
| 1493 | </dd></dl> |
---|
| 1494 | |
---|
| 1495 | <dl class="attribute"> |
---|
| 1496 | <dt id="sans.fit.AbstractFitEngine.Model.__hash__"> |
---|
| 1497 | <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__hash__" title="Permalink to this definition">¶</a></dt> |
---|
| 1498 | <dd><p>x.__hash__() <==> hash(x)</p> |
---|
| 1499 | </dd></dl> |
---|
| 1500 | |
---|
| 1501 | <dl class="method"> |
---|
| 1502 | <dt id="sans.fit.AbstractFitEngine.Model.__init__"> |
---|
| 1503 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__init__" title="Permalink to this definition">¶</a></dt> |
---|
| 1504 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
| 1505 | <col class="field-name" /> |
---|
| 1506 | <col class="field-body" /> |
---|
| 1507 | <tbody valign="top"> |
---|
| 1508 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sans_model</strong> – the sans model to wrap using park interface</td> |
---|
| 1509 | </tr> |
---|
| 1510 | </tbody> |
---|
| 1511 | </table> |
---|
| 1512 | </dd></dl> |
---|
| 1513 | |
---|
| 1514 | <dl class="attribute"> |
---|
| 1515 | <dt id="sans.fit.AbstractFitEngine.Model.__metaclass__"> |
---|
| 1516 | <tt class="descname">__metaclass__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__metaclass__" title="Permalink to this definition">¶</a></dt> |
---|
| 1517 | <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">MetaModel</span></tt></p> |
---|
| 1518 | </dd></dl> |
---|
| 1519 | |
---|
| 1520 | <dl class="attribute"> |
---|
| 1521 | <dt id="sans.fit.AbstractFitEngine.Model.__module__"> |
---|
| 1522 | <tt class="descname">__module__</tt><em class="property"> = 'sans.fit.AbstractFitEngine'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__module__" title="Permalink to this definition">¶</a></dt> |
---|
| 1523 | <dd></dd></dl> |
---|
| 1524 | |
---|
| 1525 | <dl class="staticmethod"> |
---|
| 1526 | <dt id="sans.fit.AbstractFitEngine.Model.__new__"> |
---|
| 1527 | <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.fit.AbstractFitEngine.Model.__new__" title="Permalink to this definition">¶</a></dt> |
---|
| 1528 | <dd></dd></dl> |
---|
| 1529 | |
---|
| 1530 | <dl class="method"> |
---|
| 1531 | <dt id="sans.fit.AbstractFitEngine.Model.__reduce__"> |
---|
| 1532 | <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__reduce__" title="Permalink to this definition">¶</a></dt> |
---|
| 1533 | <dd><p>helper for pickle</p> |
---|
| 1534 | </dd></dl> |
---|
| 1535 | |
---|
| 1536 | <dl class="method"> |
---|
| 1537 | <dt id="sans.fit.AbstractFitEngine.Model.__reduce_ex__"> |
---|
| 1538 | <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__reduce_ex__" title="Permalink to this definition">¶</a></dt> |
---|
| 1539 | <dd><p>helper for pickle</p> |
---|
| 1540 | </dd></dl> |
---|
| 1541 | |
---|
| 1542 | <dl class="attribute"> |
---|
| 1543 | <dt id="sans.fit.AbstractFitEngine.Model.__repr__"> |
---|
| 1544 | <tt class="descname">__repr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__repr__" title="Permalink to this definition">¶</a></dt> |
---|
| 1545 | <dd><p>x.__repr__() <==> repr(x)</p> |
---|
| 1546 | </dd></dl> |
---|
| 1547 | |
---|
| 1548 | <dl class="attribute"> |
---|
| 1549 | <dt id="sans.fit.AbstractFitEngine.Model.__setattr__"> |
---|
| 1550 | <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__setattr__" title="Permalink to this definition">¶</a></dt> |
---|
| 1551 | <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> |
---|
| 1552 | </dd></dl> |
---|
| 1553 | |
---|
| 1554 | <dl class="attribute"> |
---|
| 1555 | <dt id="sans.fit.AbstractFitEngine.Model.__str__"> |
---|
| 1556 | <tt class="descname">__str__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__str__" title="Permalink to this definition">¶</a></dt> |
---|
| 1557 | <dd><p>x.__str__() <==> str(x)</p> |
---|
| 1558 | </dd></dl> |
---|
| 1559 | |
---|
| 1560 | <dl class="attribute"> |
---|
| 1561 | <dt id="sans.fit.AbstractFitEngine.Model.__weakref__"> |
---|
| 1562 | <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__weakref__" title="Permalink to this definition">¶</a></dt> |
---|
| 1563 | <dd><p>list of weak references to the object (if defined)</p> |
---|
| 1564 | </dd></dl> |
---|
| 1565 | |
---|
| 1566 | <dl class="attribute"> |
---|
| 1567 | <dt id="sans.fit.AbstractFitEngine.Model.derivatives"> |
---|
| 1568 | <tt class="descname">derivatives</tt><em class="property"> = []</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.derivatives" title="Permalink to this definition">¶</a></dt> |
---|
| 1569 | <dd></dd></dl> |
---|
| 1570 | |
---|
| 1571 | <dl class="method"> |
---|
[6b1588b] | 1572 | <dt id="sans.fit.AbstractFitEngine.Model.eval"> |
---|
[f696e2a] | 1573 | <tt class="descname">eval</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.eval" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1574 | <dd><p>override eval method of park model.</p> |
---|
| 1575 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1576 | <col class="field-name" /> |
---|
| 1577 | <col class="field-body" /> |
---|
| 1578 | <tbody valign="top"> |
---|
[f696e2a] | 1579 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> – the x value used to compute a function</td> |
---|
[6b1588b] | 1580 | </tr> |
---|
| 1581 | </tbody> |
---|
| 1582 | </table> |
---|
| 1583 | </dd></dl> |
---|
| 1584 | |
---|
| 1585 | <dl class="method"> |
---|
| 1586 | <dt id="sans.fit.AbstractFitEngine.Model.eval_derivs"> |
---|
[f696e2a] | 1587 | <tt class="descname">eval_derivs</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.eval_derivs" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1588 | <dd><p>Evaluate the model and derivatives wrt pars at x.</p> |
---|
| 1589 | <p>pars is a list of the names of the parameters for which derivatives |
---|
| 1590 | are desired.</p> |
---|
| 1591 | <p>This method needs to be specialized in the model to evaluate the |
---|
| 1592 | model function. Alternatively, the model can implement is own |
---|
| 1593 | version of residuals which calculates the residuals directly |
---|
| 1594 | instead of calling eval.</p> |
---|
| 1595 | </dd></dl> |
---|
| 1596 | |
---|
| 1597 | <dl class="method"> |
---|
| 1598 | <dt id="sans.fit.AbstractFitEngine.Model.get_params"> |
---|
[f696e2a] | 1599 | <tt class="descname">get_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.get_params" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1600 | <dd><p>return a list of value of paramter to fit</p> |
---|
| 1601 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1602 | <col class="field-name" /> |
---|
| 1603 | <col class="field-body" /> |
---|
| 1604 | <tbody valign="top"> |
---|
[f696e2a] | 1605 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>fitparams</strong> – list of paramaters name to fit</td> |
---|
[6b1588b] | 1606 | </tr> |
---|
| 1607 | </tbody> |
---|
| 1608 | </table> |
---|
| 1609 | </dd></dl> |
---|
| 1610 | |
---|
[f696e2a] | 1611 | <dl class="attribute"> |
---|
| 1612 | <dt id="sans.fit.AbstractFitEngine.Model.parameters"> |
---|
| 1613 | <tt class="descname">parameters</tt><em class="property"> = []</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.parameters" title="Permalink to this definition">¶</a></dt> |
---|
| 1614 | <dd></dd></dl> |
---|
| 1615 | |
---|
| 1616 | <dl class="attribute"> |
---|
| 1617 | <dt id="sans.fit.AbstractFitEngine.Model.parameterset"> |
---|
| 1618 | <tt class="descname">parameterset</tt><em class="property"> = []</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.parameterset" title="Permalink to this definition">¶</a></dt> |
---|
| 1619 | <dd></dd></dl> |
---|
| 1620 | |
---|
[6b1588b] | 1621 | <dl class="method"> |
---|
| 1622 | <dt id="sans.fit.AbstractFitEngine.Model.set"> |
---|
[f696e2a] | 1623 | <tt class="descname">set</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.set" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1624 | <dd><p>Set the initial value for a set of parameters.</p> |
---|
| 1625 | <p>E.g., model.set(width=3,center=5)</p> |
---|
| 1626 | </dd></dl> |
---|
| 1627 | |
---|
| 1628 | <dl class="method"> |
---|
| 1629 | <dt id="sans.fit.AbstractFitEngine.Model.set_params"> |
---|
[f696e2a] | 1630 | <tt class="descname">set_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.set_params" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1631 | <dd><p>Set value for parameters to fit</p> |
---|
| 1632 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1633 | <col class="field-name" /> |
---|
| 1634 | <col class="field-body" /> |
---|
| 1635 | <tbody valign="top"> |
---|
[f696e2a] | 1636 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>params</strong> – list of value for parameters to fit</td> |
---|
[6b1588b] | 1637 | </tr> |
---|
| 1638 | </tbody> |
---|
| 1639 | </table> |
---|
| 1640 | </dd></dl> |
---|
| 1641 | |
---|
| 1642 | </dd></dl> |
---|
| 1643 | |
---|
| 1644 | <dl class="class"> |
---|
| 1645 | <dt id="sans.fit.AbstractFitEngine.SansAssembly"> |
---|
[f696e2a] | 1646 | <em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">SansAssembly</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansAssembly" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1647 | <dd><p>Sans Assembly class a class wrapper to be call in optimizer.leastsq method</p> |
---|
| 1648 | <dl class="method"> |
---|
[f696e2a] | 1649 | <dt id="sans.fit.AbstractFitEngine.SansAssembly.__call__"> |
---|
| 1650 | <tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansAssembly.__call__" title="Permalink to this definition">¶</a></dt> |
---|
| 1651 | <dd><p>Compute residuals</p> |
---|
| 1652 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1653 | <col class="field-name" /> |
---|
| 1654 | <col class="field-body" /> |
---|
| 1655 | <tbody valign="top"> |
---|
| 1656 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>params</strong> – value of parameters to fit</td> |
---|
| 1657 | </tr> |
---|
| 1658 | </tbody> |
---|
| 1659 | </table> |
---|
| 1660 | </dd></dl> |
---|
| 1661 | |
---|
| 1662 | <dl class="method"> |
---|
| 1663 | <dt id="sans.fit.AbstractFitEngine.SansAssembly.__init__"> |
---|
| 1664 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansAssembly.__init__" title="Permalink to this definition">¶</a></dt> |
---|
| 1665 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
| 1666 | <col class="field-name" /> |
---|
| 1667 | <col class="field-body" /> |
---|
| 1668 | <tbody valign="top"> |
---|
| 1669 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 1670 | <li><strong>Model</strong> – the model wrapper fro sans -model</li> |
---|
| 1671 | <li><strong>Data</strong> – the data wrapper for sans data</li> |
---|
| 1672 | </ul> |
---|
| 1673 | </td> |
---|
| 1674 | </tr> |
---|
| 1675 | </tbody> |
---|
| 1676 | </table> |
---|
| 1677 | </dd></dl> |
---|
| 1678 | |
---|
| 1679 | <dl class="attribute"> |
---|
| 1680 | <dt id="sans.fit.AbstractFitEngine.SansAssembly.__module__"> |
---|
| 1681 | <tt class="descname">__module__</tt><em class="property"> = 'sans.fit.AbstractFitEngine'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansAssembly.__module__" title="Permalink to this definition">¶</a></dt> |
---|
| 1682 | <dd></dd></dl> |
---|
| 1683 | |
---|
| 1684 | <dl class="method"> |
---|
[6b1588b] | 1685 | <dt id="sans.fit.AbstractFitEngine.SansAssembly.check_param_range"> |
---|
| 1686 | <tt class="descname">check_param_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansAssembly.check_param_range" title="Permalink to this definition">¶</a></dt> |
---|
| 1687 | <dd><p>Check the lower and upper bound of the parameter value |
---|
| 1688 | and set res to the inf if the value is outside of the |
---|
| 1689 | range |
---|
| 1690 | :limitation: the initial values must be within range.</p> |
---|
| 1691 | </dd></dl> |
---|
| 1692 | |
---|
| 1693 | <dl class="method"> |
---|
| 1694 | <dt id="sans.fit.AbstractFitEngine.SansAssembly.chisq"> |
---|
| 1695 | <tt class="descname">chisq</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansAssembly.chisq" title="Permalink to this definition">¶</a></dt> |
---|
| 1696 | <dd><p>Calculates chi^2</p> |
---|
| 1697 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1698 | <col class="field-name" /> |
---|
| 1699 | <col class="field-body" /> |
---|
| 1700 | <tbody valign="top"> |
---|
[f696e2a] | 1701 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>params</strong> – list of parameter values</td> |
---|
[6b1588b] | 1702 | </tr> |
---|
[f696e2a] | 1703 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">chi^2</td> |
---|
[6b1588b] | 1704 | </tr> |
---|
| 1705 | </tbody> |
---|
| 1706 | </table> |
---|
| 1707 | </dd></dl> |
---|
| 1708 | |
---|
| 1709 | </dd></dl> |
---|
| 1710 | |
---|
| 1711 | <dl class="class"> |
---|
| 1712 | <dt id="sans.fit.AbstractFitEngine.SansParameter"> |
---|
[f696e2a] | 1713 | <em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">SansParameter</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1714 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">park.parameter.Parameter</span></tt></p> |
---|
| 1715 | <p>SANS model parameters for use in the PARK fitting service. |
---|
| 1716 | The parameter attribute value is redirected to the underlying |
---|
| 1717 | parameter value in the SANS model.</p> |
---|
[f696e2a] | 1718 | <dl class="attribute"> |
---|
| 1719 | <dt id="sans.fit.AbstractFitEngine.SansParameter.__class__"> |
---|
| 1720 | <tt class="descname">__class__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__class__" title="Permalink to this definition">¶</a></dt> |
---|
| 1721 | <dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> |
---|
| 1722 | </dd></dl> |
---|
| 1723 | |
---|
| 1724 | <dl class="attribute"> |
---|
| 1725 | <dt id="sans.fit.AbstractFitEngine.SansParameter.__delattr__"> |
---|
| 1726 | <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__delattr__" title="Permalink to this definition">¶</a></dt> |
---|
| 1727 | <dd><p>x.__delattr__(‘name’) <==> del x.name</p> |
---|
| 1728 | </dd></dl> |
---|
| 1729 | |
---|
| 1730 | <dl class="attribute"> |
---|
| 1731 | <dt id="sans.fit.AbstractFitEngine.SansParameter.__dict__"> |
---|
| 1732 | <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x02083790></em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__dict__" title="Permalink to this definition">¶</a></dt> |
---|
| 1733 | <dd></dd></dl> |
---|
| 1734 | |
---|
| 1735 | <dl class="attribute"> |
---|
| 1736 | <dt id="sans.fit.AbstractFitEngine.SansParameter.__getattribute__"> |
---|
| 1737 | <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__getattribute__" title="Permalink to this definition">¶</a></dt> |
---|
| 1738 | <dd><p>x.__getattribute__(‘name’) <==> x.name</p> |
---|
| 1739 | </dd></dl> |
---|
| 1740 | |
---|
| 1741 | <dl class="attribute"> |
---|
| 1742 | <dt id="sans.fit.AbstractFitEngine.SansParameter.__hash__"> |
---|
| 1743 | <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__hash__" title="Permalink to this definition">¶</a></dt> |
---|
| 1744 | <dd><p>x.__hash__() <==> hash(x)</p> |
---|
| 1745 | </dd></dl> |
---|
| 1746 | |
---|
| 1747 | <dl class="method"> |
---|
| 1748 | <dt id="sans.fit.AbstractFitEngine.SansParameter.__init__"> |
---|
| 1749 | <tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__init__" title="Permalink to this definition">¶</a></dt> |
---|
| 1750 | <dd><table class="docutils field-list" frame="void" rules="none"> |
---|
| 1751 | <col class="field-name" /> |
---|
| 1752 | <col class="field-body" /> |
---|
| 1753 | <tbody valign="top"> |
---|
| 1754 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 1755 | <li><strong>name</strong> – the name of the model parameter</li> |
---|
| 1756 | <li><strong>model</strong> – the sans model to wrap as a park model</li> |
---|
| 1757 | </ul> |
---|
| 1758 | </td> |
---|
| 1759 | </tr> |
---|
| 1760 | </tbody> |
---|
| 1761 | </table> |
---|
| 1762 | </dd></dl> |
---|
| 1763 | |
---|
| 1764 | <dl class="attribute"> |
---|
| 1765 | <dt id="sans.fit.AbstractFitEngine.SansParameter.__module__"> |
---|
| 1766 | <tt class="descname">__module__</tt><em class="property"> = 'sans.fit.AbstractFitEngine'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__module__" title="Permalink to this definition">¶</a></dt> |
---|
| 1767 | <dd></dd></dl> |
---|
| 1768 | |
---|
| 1769 | <dl class="staticmethod"> |
---|
| 1770 | <dt id="sans.fit.AbstractFitEngine.SansParameter.__new__"> |
---|
| 1771 | <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.fit.AbstractFitEngine.SansParameter.__new__" title="Permalink to this definition">¶</a></dt> |
---|
| 1772 | <dd></dd></dl> |
---|
| 1773 | |
---|
| 1774 | <dl class="method"> |
---|
| 1775 | <dt id="sans.fit.AbstractFitEngine.SansParameter.__reduce__"> |
---|
| 1776 | <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__reduce__" title="Permalink to this definition">¶</a></dt> |
---|
| 1777 | <dd><p>helper for pickle</p> |
---|
| 1778 | </dd></dl> |
---|
| 1779 | |
---|
| 1780 | <dl class="method"> |
---|
| 1781 | <dt id="sans.fit.AbstractFitEngine.SansParameter.__reduce_ex__"> |
---|
| 1782 | <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__reduce_ex__" title="Permalink to this definition">¶</a></dt> |
---|
| 1783 | <dd><p>helper for pickle</p> |
---|
| 1784 | </dd></dl> |
---|
| 1785 | |
---|
| 1786 | <dl class="method"> |
---|
| 1787 | <dt id="sans.fit.AbstractFitEngine.SansParameter.__repr__"> |
---|
| 1788 | <tt class="descname">__repr__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__repr__" title="Permalink to this definition">¶</a></dt> |
---|
| 1789 | <dd></dd></dl> |
---|
| 1790 | |
---|
| 1791 | <dl class="attribute"> |
---|
| 1792 | <dt id="sans.fit.AbstractFitEngine.SansParameter.__setattr__"> |
---|
| 1793 | <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__setattr__" title="Permalink to this definition">¶</a></dt> |
---|
| 1794 | <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> |
---|
| 1795 | </dd></dl> |
---|
| 1796 | |
---|
| 1797 | <dl class="method"> |
---|
| 1798 | <dt id="sans.fit.AbstractFitEngine.SansParameter.__str__"> |
---|
| 1799 | <tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__str__" title="Permalink to this definition">¶</a></dt> |
---|
| 1800 | <dd></dd></dl> |
---|
| 1801 | |
---|
| 1802 | <dl class="attribute"> |
---|
| 1803 | <dt id="sans.fit.AbstractFitEngine.SansParameter.__weakref__"> |
---|
| 1804 | <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__weakref__" title="Permalink to this definition">¶</a></dt> |
---|
| 1805 | <dd><p>list of weak references to the object (if defined)</p> |
---|
| 1806 | </dd></dl> |
---|
| 1807 | |
---|
| 1808 | <dl class="method"> |
---|
| 1809 | <dt id="sans.fit.AbstractFitEngine.SansParameter._getname"> |
---|
| 1810 | <tt class="descname">_getname</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter._getname" title="Permalink to this definition">¶</a></dt> |
---|
| 1811 | <dd></dd></dl> |
---|
| 1812 | |
---|
| 1813 | <dl class="method"> |
---|
| 1814 | <dt id="sans.fit.AbstractFitEngine.SansParameter._getrange"> |
---|
| 1815 | <tt class="descname">_getrange</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter._getrange" title="Permalink to this definition">¶</a></dt> |
---|
| 1816 | <dd><p>Override _getrange of park parameter |
---|
| 1817 | return the range of parameter</p> |
---|
| 1818 | </dd></dl> |
---|
| 1819 | |
---|
| 1820 | <dl class="method"> |
---|
| 1821 | <dt id="sans.fit.AbstractFitEngine.SansParameter._getvalue"> |
---|
| 1822 | <tt class="descname">_getvalue</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter._getvalue" title="Permalink to this definition">¶</a></dt> |
---|
| 1823 | <dd><p>override the _getvalue of park parameter</p> |
---|
| 1824 | <p>:return value the parameter associates with self.name</p> |
---|
| 1825 | </dd></dl> |
---|
| 1826 | |
---|
| 1827 | <dl class="attribute"> |
---|
| 1828 | <dt id="sans.fit.AbstractFitEngine.SansParameter._name"> |
---|
| 1829 | <tt class="descname">_name</tt><em class="property"> = 'unknown'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter._name" title="Permalink to this definition">¶</a></dt> |
---|
| 1830 | <dd></dd></dl> |
---|
| 1831 | |
---|
| 1832 | <dl class="attribute"> |
---|
| 1833 | <dt id="sans.fit.AbstractFitEngine.SansParameter._range"> |
---|
| 1834 | <tt class="descname">_range</tt><em class="property"> = (-1.#INF, 1.#INF)</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter._range" title="Permalink to this definition">¶</a></dt> |
---|
| 1835 | <dd></dd></dl> |
---|
| 1836 | |
---|
| 1837 | <dl class="method"> |
---|
| 1838 | <dt id="sans.fit.AbstractFitEngine.SansParameter._setrange"> |
---|
| 1839 | <tt class="descname">_setrange</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter._setrange" title="Permalink to this definition">¶</a></dt> |
---|
| 1840 | <dd><p>override _setrange of park parameter</p> |
---|
| 1841 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1842 | <col class="field-name" /> |
---|
| 1843 | <col class="field-body" /> |
---|
| 1844 | <tbody valign="top"> |
---|
| 1845 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>r</strong> – the value of the range to set</td> |
---|
| 1846 | </tr> |
---|
| 1847 | </tbody> |
---|
| 1848 | </table> |
---|
| 1849 | </dd></dl> |
---|
| 1850 | |
---|
| 1851 | <dl class="method"> |
---|
| 1852 | <dt id="sans.fit.AbstractFitEngine.SansParameter._setvalue"> |
---|
| 1853 | <tt class="descname">_setvalue</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter._setvalue" title="Permalink to this definition">¶</a></dt> |
---|
| 1854 | <dd><p>override the _setvalue pf park parameter</p> |
---|
| 1855 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1856 | <col class="field-name" /> |
---|
| 1857 | <col class="field-body" /> |
---|
| 1858 | <tbody valign="top"> |
---|
| 1859 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> – the value to set on a given parameter</td> |
---|
| 1860 | </tr> |
---|
| 1861 | </tbody> |
---|
| 1862 | </table> |
---|
| 1863 | </dd></dl> |
---|
| 1864 | |
---|
| 1865 | <dl class="attribute"> |
---|
| 1866 | <dt id="sans.fit.AbstractFitEngine.SansParameter.deriv"> |
---|
| 1867 | <tt class="descname">deriv</tt><em class="property"> = False</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.deriv" title="Permalink to this definition">¶</a></dt> |
---|
| 1868 | <dd></dd></dl> |
---|
| 1869 | |
---|
| 1870 | <dl class="attribute"> |
---|
| 1871 | <dt id="sans.fit.AbstractFitEngine.SansParameter.expression"> |
---|
| 1872 | <tt class="descname">expression</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.expression" title="Permalink to this definition">¶</a></dt> |
---|
| 1873 | <dd></dd></dl> |
---|
| 1874 | |
---|
[6b1588b] | 1875 | <dl class="method"> |
---|
| 1876 | <dt id="sans.fit.AbstractFitEngine.SansParameter.get"> |
---|
| 1877 | <tt class="descname">get</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.get" title="Permalink to this definition">¶</a></dt> |
---|
| 1878 | <dd><p>Return the current value for a parameter.</p> |
---|
| 1879 | </dd></dl> |
---|
| 1880 | |
---|
| 1881 | <dl class="method"> |
---|
| 1882 | <dt id="sans.fit.AbstractFitEngine.SansParameter.get_name"> |
---|
| 1883 | <tt class="descname">get_name</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.get_name" title="Permalink to this definition">¶</a></dt> |
---|
| 1884 | <dd></dd></dl> |
---|
| 1885 | |
---|
| 1886 | <dl class="method"> |
---|
| 1887 | <dt id="sans.fit.AbstractFitEngine.SansParameter.iscomputed"> |
---|
| 1888 | <tt class="descname">iscomputed</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.iscomputed" title="Permalink to this definition">¶</a></dt> |
---|
| 1889 | <dd></dd></dl> |
---|
| 1890 | |
---|
| 1891 | <dl class="method"> |
---|
| 1892 | <dt id="sans.fit.AbstractFitEngine.SansParameter.isfeasible"> |
---|
[f696e2a] | 1893 | <tt class="descname">isfeasible</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.isfeasible" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1894 | <dd><p>Return true if the value is in the range</p> |
---|
| 1895 | </dd></dl> |
---|
| 1896 | |
---|
| 1897 | <dl class="method"> |
---|
| 1898 | <dt id="sans.fit.AbstractFitEngine.SansParameter.isfitted"> |
---|
| 1899 | <tt class="descname">isfitted</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.isfitted" title="Permalink to this definition">¶</a></dt> |
---|
| 1900 | <dd></dd></dl> |
---|
| 1901 | |
---|
| 1902 | <dl class="method"> |
---|
| 1903 | <dt id="sans.fit.AbstractFitEngine.SansParameter.isfixed"> |
---|
| 1904 | <tt class="descname">isfixed</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.isfixed" title="Permalink to this definition">¶</a></dt> |
---|
| 1905 | <dd></dd></dl> |
---|
| 1906 | |
---|
| 1907 | <dl class="method"> |
---|
| 1908 | <dt id="sans.fit.AbstractFitEngine.SansParameter.isrestrained"> |
---|
| 1909 | <tt class="descname">isrestrained</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.isrestrained" title="Permalink to this definition">¶</a></dt> |
---|
| 1910 | <dd></dd></dl> |
---|
| 1911 | |
---|
| 1912 | <dl class="attribute"> |
---|
[f696e2a] | 1913 | <dt id="sans.fit.AbstractFitEngine.SansParameter.likelihood"> |
---|
| 1914 | <tt class="descname">likelihood</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.likelihood" title="Permalink to this definition">¶</a></dt> |
---|
| 1915 | <dd></dd></dl> |
---|
| 1916 | |
---|
| 1917 | <dl class="attribute"> |
---|
| 1918 | <dt id="sans.fit.AbstractFitEngine.SansParameter.limits"> |
---|
| 1919 | <tt class="descname">limits</tt><em class="property"> = (-1.#INF, 1.#INF)</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.limits" title="Permalink to this definition">¶</a></dt> |
---|
| 1920 | <dd></dd></dl> |
---|
| 1921 | |
---|
| 1922 | <dl class="attribute"> |
---|
[6b1588b] | 1923 | <dt id="sans.fit.AbstractFitEngine.SansParameter.name"> |
---|
| 1924 | <tt class="descname">name</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.name" title="Permalink to this definition">¶</a></dt> |
---|
| 1925 | <dd><p>parameter name</p> |
---|
| 1926 | </dd></dl> |
---|
| 1927 | |
---|
| 1928 | <dl class="attribute"> |
---|
[f696e2a] | 1929 | <dt id="sans.fit.AbstractFitEngine.SansParameter.path"> |
---|
| 1930 | <tt class="descname">path</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.path" title="Permalink to this definition">¶</a></dt> |
---|
| 1931 | <dd></dd></dl> |
---|
| 1932 | |
---|
| 1933 | <dl class="attribute"> |
---|
[6b1588b] | 1934 | <dt id="sans.fit.AbstractFitEngine.SansParameter.range"> |
---|
| 1935 | <tt class="descname">range</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.range" title="Permalink to this definition">¶</a></dt> |
---|
| 1936 | <dd><p>Override _getrange of park parameter |
---|
| 1937 | return the range of parameter</p> |
---|
| 1938 | </dd></dl> |
---|
| 1939 | |
---|
| 1940 | <dl class="method"> |
---|
| 1941 | <dt id="sans.fit.AbstractFitEngine.SansParameter.set"> |
---|
[f696e2a] | 1942 | <tt class="descname">set</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.set" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1943 | <dd><p>Set a parameter to a value, a range or an expression. If it is a value, |
---|
| 1944 | the parameter will be fixed for the fit. If it is a range, the value |
---|
| 1945 | will be varying for the fit. If it is an expression, the parameter will |
---|
| 1946 | be calculated from the values of other parameters in the fit.</p> |
---|
| 1947 | <p>Raises ValueError if the value could not be interpreted.</p> |
---|
| 1948 | </dd></dl> |
---|
| 1949 | |
---|
| 1950 | <dl class="method"> |
---|
| 1951 | <dt id="sans.fit.AbstractFitEngine.SansParameter.setprefix"> |
---|
[f696e2a] | 1952 | <tt class="descname">setprefix</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.setprefix" title="Permalink to this definition">¶</a></dt> |
---|
[6b1588b] | 1953 | <dd><p>Set the full path to the parameter as used in expressions involving |
---|
| 1954 | the parameter name.</p> |
---|
| 1955 | </dd></dl> |
---|
| 1956 | |
---|
[f696e2a] | 1957 | <dl class="attribute"> |
---|
| 1958 | <dt id="sans.fit.AbstractFitEngine.SansParameter.status"> |
---|
| 1959 | <tt class="descname">status</tt><em class="property"> = 'fixed'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.status" title="Permalink to this definition">¶</a></dt> |
---|
| 1960 | <dd></dd></dl> |
---|
| 1961 | |
---|
[6b1588b] | 1962 | <dl class="method"> |
---|
| 1963 | <dt id="sans.fit.AbstractFitEngine.SansParameter.summarize"> |
---|
| 1964 | <tt class="descname">summarize</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.summarize" title="Permalink to this definition">¶</a></dt> |
---|
| 1965 | <dd><p>Return parameter range string.</p> |
---|
| 1966 | <p>E.g., ” Gold .....|.... 5.2043 in [2,7]”</p> |
---|
| 1967 | </dd></dl> |
---|
| 1968 | |
---|
| 1969 | <dl class="attribute"> |
---|
[f696e2a] | 1970 | <dt id="sans.fit.AbstractFitEngine.SansParameter.tip"> |
---|
| 1971 | <tt class="descname">tip</tt><em class="property"> = 'Fitting parameter'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.tip" title="Permalink to this definition">¶</a></dt> |
---|
| 1972 | <dd></dd></dl> |
---|
| 1973 | |
---|
| 1974 | <dl class="attribute"> |
---|
| 1975 | <dt id="sans.fit.AbstractFitEngine.SansParameter.units"> |
---|
| 1976 | <tt class="descname">units</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.units" title="Permalink to this definition">¶</a></dt> |
---|
| 1977 | <dd></dd></dl> |
---|
| 1978 | |
---|
| 1979 | <dl class="attribute"> |
---|
[6b1588b] | 1980 | <dt id="sans.fit.AbstractFitEngine.SansParameter.value"> |
---|
| 1981 | <tt class="descname">value</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.value" title="Permalink to this definition">¶</a></dt> |
---|
| 1982 | <dd><p>override the _getvalue of park parameter</p> |
---|
| 1983 | <p>:return value the parameter associates with self.name</p> |
---|
| 1984 | </dd></dl> |
---|
| 1985 | |
---|
| 1986 | </dd></dl> |
---|
| 1987 | |
---|
| 1988 | </div> |
---|
| 1989 | </div> |
---|
| 1990 | |
---|
| 1991 | |
---|
| 1992 | </div> |
---|
| 1993 | </div> |
---|
| 1994 | </div> |
---|
| 1995 | <div class="sphinxsidebar"> |
---|
| 1996 | <div class="sphinxsidebarwrapper"> |
---|
| 1997 | <h3><a href="../index.html">Table Of Contents</a></h3> |
---|
| 1998 | <ul> |
---|
| 1999 | <li><a class="reference internal" href="#">AbstractFitEngine</a><ul> |
---|
[f696e2a] | 2000 | <li><a class="reference internal" href="#mod-sans-fit-abstractfitengine">:mod:` sans.fit.AbstractFitEngine`</a></li> |
---|
[6b1588b] | 2001 | </ul> |
---|
| 2002 | </li> |
---|
| 2003 | </ul> |
---|
| 2004 | |
---|
| 2005 | <h4>Previous topic</h4> |
---|
| 2006 | <p class="topless"><a href="index.html" |
---|
| 2007 | title="previous chapter">Reference</a></p> |
---|
| 2008 | <h4>Next topic</h4> |
---|
| 2009 | <p class="topless"><a href="Fitting.html" |
---|
| 2010 | title="next chapter">Fitting</a></p> |
---|
| 2011 | <h3>This Page</h3> |
---|
| 2012 | <ul class="this-page-menu"> |
---|
| 2013 | <li><a href="../_sources/api/AbstractFitEngine.txt" |
---|
| 2014 | rel="nofollow">Show Source</a></li> |
---|
| 2015 | </ul> |
---|
| 2016 | <div id="searchbox" style="display: none"> |
---|
| 2017 | <h3>Quick search</h3> |
---|
| 2018 | <form class="search" action="../search.html" method="get"> |
---|
[f696e2a] | 2019 | <input type="text" name="q" /> |
---|
[6b1588b] | 2020 | <input type="submit" value="Go" /> |
---|
| 2021 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 2022 | <input type="hidden" name="area" value="default" /> |
---|
| 2023 | </form> |
---|
| 2024 | <p class="searchtip" style="font-size: 90%"> |
---|
| 2025 | Enter search terms or a module, class or function name. |
---|
| 2026 | </p> |
---|
| 2027 | </div> |
---|
| 2028 | <script type="text/javascript">$('#searchbox').show(0);</script> |
---|
| 2029 | </div> |
---|
| 2030 | </div> |
---|
| 2031 | <div class="clearer"></div> |
---|
| 2032 | </div> |
---|
| 2033 | <div class="related"> |
---|
| 2034 | <h3>Navigation</h3> |
---|
| 2035 | <ul> |
---|
| 2036 | <li class="right" style="margin-right: 10px"> |
---|
| 2037 | <a href="../genindex.html" title="General Index" |
---|
| 2038 | >index</a></li> |
---|
| 2039 | <li class="right" > |
---|
| 2040 | <a href="../py-modindex.html" title="Python Module Index" |
---|
| 2041 | >modules</a> |</li> |
---|
| 2042 | <li class="right" > |
---|
| 2043 | <a href="Fitting.html" title="Fitting" |
---|
| 2044 | >next</a> |</li> |
---|
| 2045 | <li class="right" > |
---|
| 2046 | <a href="index.html" title="Reference" |
---|
| 2047 | >previous</a> |</li> |
---|
[f696e2a] | 2048 | <li><a href="../index.html">park_integration 0.1.0 documentation</a> »</li> |
---|
[6b1588b] | 2049 | <li><a href="index.html" >Reference</a> »</li> |
---|
| 2050 | </ul> |
---|
| 2051 | </div> |
---|
| 2052 | <div class="footer"> |
---|
| 2053 | © Copyright 2010, sans group. |
---|
[f696e2a] | 2054 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. |
---|
[6b1588b] | 2055 | </div> |
---|
| 2056 | </body> |
---|
| 2057 | </html> |
---|