Changeset f696e2a in sasview for park_integration/docs/sphinx/html/api/AbstractFitEngine.html
- Timestamp:
- Oct 24, 2011 1:42:54 PM (14 years ago)
- Branches:
- master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
- Children:
- 8884996
- Parents:
- 40299ce
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
park_integration/docs/sphinx/html/api/AbstractFitEngine.html
r6b1588b rf696e2a 3 3 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 4 4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 5 5 6 6 7 <html xmlns="http://www.w3.org/1999/xhtml"> … … 8 9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 9 10 10 <title>AbstractFitEngine — park_integration v0.1.0 documentation</title> 11 <title>AbstractFitEngine — park_integration 0.1.0 documentation</title> 12 11 13 <link rel="stylesheet" href="../_static/default.css" type="text/css" /> 12 14 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> 15 13 16 <script type="text/javascript"> 14 17 var DOCUMENTATION_OPTIONS = { … … 23 26 <script type="text/javascript" src="../_static/underscore.js"></script> 24 27 <script type="text/javascript" src="../_static/doctools.js"></script> 25 <link rel="top" title="park_integration v0.1.0 documentation" href="../index.html" />28 <link rel="top" title="park_integration 0.1.0 documentation" href="../index.html" /> 26 29 <link rel="up" title="Reference" href="index.html" /> 27 30 <link rel="next" title="Fitting" href="Fitting.html" /> … … 44 47 <a href="index.html" title="Reference" 45 48 accesskey="P">previous</a> |</li> 46 <li><a href="../index.html">park_integration v0.1.0 documentation</a> »</li>49 <li><a href="../index.html">park_integration 0.1.0 documentation</a> »</li> 47 50 <li><a href="index.html" accesskey="U">Reference</a> »</li> 48 51 </ul> … … 56 59 <div class="section" id="abstractfitengine"> 57 60 <h1>AbstractFitEngine<a class="headerlink" href="#abstractfitengine" title="Permalink to this headline">¶</a></h1> 58 <div class="section" id="module-sans.fit.AbstractFitEngine"> 59 <span id="mod-sans-fit-abstractfitengine"></span><h2>:mod:` sans.fit.AbstractFitEngine`<a class="headerlink" href="#module-sans.fit.AbstractFitEngine" title="Permalink to this headline">¶</a></h2> 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 60 164 <dl class="exception"> 61 165 <dt id="sans.fit.AbstractFitEngine.FitAbort"> … … 64 168 <p>Exception raise to stop the fit</p> 65 169 <dl class="attribute"> 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"> 66 268 <dt id="sans.fit.AbstractFitEngine.FitAbort.args"> 67 269 <tt class="descname">args</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.args" title="Permalink to this definition">¶</a></dt> … … 80 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> 81 283 <dd><dl class="method"> 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"> 82 299 <dt id="sans.fit.AbstractFitEngine.FitArrange.add_data"> 83 <tt class="descname">add_data</tt><big>(</big>< em>data</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.add_data" title="Permalink to this definition">¶</a></dt>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> 84 301 <dd><p>add_data fill a self.data_list with data to fit</p> 85 302 <table class="docutils field-list" frame="void" rules="none"> … … 87 304 <col class="field-body" /> 88 305 <tbody valign="top"> 89 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> – Data to add in the list</td>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> 90 307 </tr> 91 308 </tbody> … … 100 317 <col class="field-body" /> 101 318 <tbody valign="top"> 102 <tr class="field "><th class="field-name">Returns:</th><td class="field-body">list of data data_list</td>319 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">list of data data_list</td> 103 320 </tr> 104 321 </tbody> … … 113 330 <col class="field-body" /> 114 331 <tbody valign="top"> 115 <tr class="field "><th class="field-name">Returns:</th><td class="field-body">saved model</td>332 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">saved model</td> 116 333 </tr> 117 334 </tbody> … … 127 344 <dl class="method"> 128 345 <dt id="sans.fit.AbstractFitEngine.FitArrange.remove_data"> 129 <tt class="descname">remove_data</tt><big>(</big>< em>data</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.remove_data" title="Permalink to this definition">¶</a></dt>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> 130 347 <dd><p>Remove one element from the list</p> 131 348 <table class="docutils field-list" frame="void" rules="none"> … … 133 350 <col class="field-body" /> 134 351 <tbody valign="top"> 135 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> – Data to remove from data_list</td>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> 136 353 </tr> 137 354 </tbody> … … 141 358 <dl class="method"> 142 359 <dt id="sans.fit.AbstractFitEngine.FitArrange.set_model"> 143 <tt class="descname">set_model</tt><big>(</big>< em>model</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.set_model" title="Permalink to this definition">¶</a></dt>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> 144 361 <dd><p>set_model save a copy of the model</p> 145 362 <table class="docutils field-list" frame="void" rules="none"> … … 147 364 <col class="field-body" /> 148 365 <tbody valign="top"> 149 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – the model being set</td>366 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – the model being set</td> 150 367 </tr> 151 368 </tbody> … … 155 372 <dl class="method"> 156 373 <dt id="sans.fit.AbstractFitEngine.FitArrange.set_to_fit"> 157 <tt class="descname">set_to_fit</tt><big>(</big>< em>value=0</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.set_to_fit" title="Permalink to this definition">¶</a></dt>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> 158 375 <dd><p>set self.selected to 0 or 1 for other values raise an exception</p> 159 376 <table class="docutils field-list" frame="void" rules="none"> … … 161 378 <col class="field-body" /> 162 379 <tbody valign="top"> 163 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> – integer between 0 or 1</td>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> 164 381 </tr> 165 382 </tbody> … … 171 388 <dl class="class"> 172 389 <dt id="sans.fit.AbstractFitEngine.FitData1D"> 173 <em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitData1D</tt>< big>(</big><em>x</em>, <em>y</em>, <em>dx=None</em>, <em>dy=None</em>, <em>smearer=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D" title="Permalink to this definition">¶</a></dt>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> 174 391 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.data_info.Data1D</span></tt></p> 175 392 <p>Wrapper class for SANS data … … 177 394 a way to get residuals from data.</p> 178 395 <dl class="method"> 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> 412 </dd></dl> 413 414 <dl class="method"> 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> 432 433 <dl class="method"> 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> 455 <table class="docutils field-list" frame="void" rules="none"> 456 <col class="field-name" /> 457 <col class="field-body" /> 458 <tbody valign="top"> 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> 461 </tr> 462 </tbody> 463 </table> 464 </dd></dl> 465 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 471 <dl class="method"> 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> 488 </dd></dl> 489 490 <dl class="method"> 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> 494 <table class="docutils field-list" frame="void" rules="none"> 495 <col class="field-name" /> 496 <col class="field-body" /> 497 <tbody valign="top"> 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> 504 </tr> 505 </tbody> 506 </table> 507 </dd></dl> 508 509 <dl class="method"> 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> 513 <table class="docutils field-list" frame="void" rules="none"> 514 <col class="field-name" /> 515 <col class="field-body" /> 516 <tbody valign="top"> 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> 520 </tr> 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> 523 </tr> 524 </tbody> 525 </table> 526 </dd></dl> 527 528 <dl class="method"> 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"> 533 <col class="field-name" /> 534 <col class="field-body" /> 535 <tbody valign="top"> 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> 539 </tr> 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> 542 </tr> 543 </tbody> 544 </table> 545 </dd></dl> 546 547 <dl class="method"> 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> 564 </dd></dl> 565 566 <dl class="method"> 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> 570 </dd></dl> 571 572 <dl class="method"> 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> 589 </dd></dl> 590 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> 617 </dd></dl> 618 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 639 <dl class="method"> 179 640 <dt id="sans.fit.AbstractFitEngine.FitData1D.add_notes"> 180 <tt class="descname">add_notes</tt><big>(</big>< em>message=''</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.add_notes" title="Permalink to this definition">¶</a></dt>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> 181 642 <dd><p>Add notes to datainfo</p> 182 643 </dd></dl> … … 189 650 <dl class="method"> 190 651 <dt id="sans.fit.AbstractFitEngine.FitData1D.clone_without_data"> 191 <tt class="descname">clone_without_data</tt><big>(</big>< em>length=0</em>, <em>clone=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.clone_without_data" title="Permalink to this definition">¶</a></dt>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> 192 653 <dd><p>Clone the current object, without copying the data (which 193 654 will be filled out by a subsequent operation). … … 197 658 <col class="field-body" /> 198 659 <tbody valign="top"> 199 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">660 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 200 661 <li><strong>length</strong> – length of the data array to be initialized</li> 201 662 <li><strong>clone</strong> – if provided, the data will be copied to clone</li> … … 207 668 </dd></dl> 208 669 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 209 710 <dl class="method"> 210 711 <dt id="sans.fit.AbstractFitEngine.FitData1D.get_fit_range"> … … 213 714 </dd></dl> 214 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 215 721 <dl class="method"> 216 722 <dt id="sans.fit.AbstractFitEngine.FitData1D.is_slit_smeared"> … … 221 727 <col class="field-body" /> 222 728 <tbody valign="top"> 223 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">True is slit smearing info is present, False otherwise</td> 224 </tr> 225 </tbody> 226 </table> 227 </dd></dl> 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> 228 749 229 750 <dl class="method"> 230 751 <dt id="sans.fit.AbstractFitEngine.FitData1D.residuals"> 231 <tt class="descname">residuals</tt><big>(</big>< em>fn</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.residuals" title="Permalink to this definition">¶</a></dt>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> 232 753 <dd><p>Compute residuals.</p> 233 754 <p>If self.smearer has been set, use if to smear … … 237 758 <col class="field-body" /> 238 759 <tbody valign="top"> 239 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>fn</strong> – function that return model value</td>240 </tr> 241 <tr class="field "><th class="field-name">Returns:</th><td class="field-body">residuals</td>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> 242 763 </tr> 243 764 </tbody> … … 247 768 <dl class="method"> 248 769 <dt id="sans.fit.AbstractFitEngine.FitData1D.residuals_deriv"> 249 <tt class="descname">residuals_deriv</tt><big>(</big>< em>model</em>, <em>pars=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.residuals_deriv" title="Permalink to this definition">¶</a></dt>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> 250 771 <dd><table class="docutils field-list" frame="void" rules="none"> 251 772 <col class="field-name" /> 252 773 <col class="field-body" /> 253 774 <tbody valign="top"> 254 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">residuals derivatives .</td> 255 </tr> 256 <tr class="field"><th class="field-name">Note :</th><td class="field-body">in this case just return empty array</td> 257 </tr> 258 </tbody> 259 </table> 260 </dd></dl> 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> 261 797 262 798 <dl class="method"> 263 799 <dt id="sans.fit.AbstractFitEngine.FitData1D.set_fit_range"> 264 <tt class="descname">set_fit_range</tt><big>(</big>< em>qmin=None</em>, <em>qmax=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.set_fit_range" title="Permalink to this definition">¶</a></dt>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> 265 801 <dd><p>to set the fit range</p> 266 802 </dd></dl> 267 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 268 824 <dl class="method"> 269 825 <dt id="sans.fit.AbstractFitEngine.FitData1D.xaxis"> 270 <tt class="descname">xaxis</tt><big>(</big>< em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.xaxis" title="Permalink to this definition">¶</a></dt>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> 271 827 <dd><p>set the x axis label and unit</p> 272 828 </dd></dl> 273 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 274 840 <dl class="method"> 275 841 <dt id="sans.fit.AbstractFitEngine.FitData1D.yaxis"> 276 <tt class="descname">yaxis</tt><big>(</big>< em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.yaxis" title="Permalink to this definition">¶</a></dt>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> 277 843 <dd><p>set the y axis label and unit</p> 278 844 </dd></dl> … … 282 848 <dl class="class"> 283 849 <dt id="sans.fit.AbstractFitEngine.FitData2D"> 284 <em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitData2D</tt>< big>(</big><em>sans_data2d</em>, <em>data=None</em>, <em>err_data=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D" title="Permalink to this definition">¶</a></dt>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> 285 851 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.data_info.Data2D</span></tt></p> 286 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 287 1101 <dl class="method"> 288 1102 <dt id="sans.fit.AbstractFitEngine.FitData2D.add_notes"> 289 <tt class="descname">add_notes</tt><big>(</big>< em>message=''</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.add_notes" title="Permalink to this definition">¶</a></dt>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> 290 1104 <dd><p>Add notes to datainfo</p> 291 1105 </dd></dl> … … 298 1112 <dl class="method"> 299 1113 <dt id="sans.fit.AbstractFitEngine.FitData2D.clone_without_data"> 300 <tt class="descname">clone_without_data</tt><big>(</big>< em>length=0</em>, <em>clone=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.clone_without_data" title="Permalink to this definition">¶</a></dt>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> 301 1115 <dd><p>Clone the current object, without copying the data (which 302 1116 will be filled out by a subsequent operation). … … 306 1120 <col class="field-body" /> 307 1121 <tbody valign="top"> 308 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">1122 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 309 1123 <li><strong>length</strong> – length of the data array to be initialized</li> 310 1124 <li><strong>clone</strong> – if provided, the data will be copied to clone</li> … … 316 1130 </dd></dl> 317 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 318 1172 <dl class="method"> 319 1173 <dt id="sans.fit.AbstractFitEngine.FitData2D.get_fit_range"> … … 322 1176 </dd></dl> 323 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> 1217 324 1218 <dl class="method"> 325 1219 <dt id="sans.fit.AbstractFitEngine.FitData2D.residuals"> 326 <tt class="descname">residuals</tt><big>(</big>< em>fn</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.residuals" title="Permalink to this definition">¶</a></dt>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> 327 1221 <dd><p>return the residuals</p> 328 1222 </dd></dl> … … 330 1224 <dl class="method"> 331 1225 <dt id="sans.fit.AbstractFitEngine.FitData2D.residuals_deriv"> 332 <tt class="descname">residuals_deriv</tt><big>(</big>< em>model</em>, <em>pars=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.residuals_deriv" title="Permalink to this definition">¶</a></dt>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> 333 1227 <dd><table class="docutils field-list" frame="void" rules="none"> 334 1228 <col class="field-name" /> 335 1229 <col class="field-body" /> 336 1230 <tbody valign="top"> 337 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">residuals derivatives .</td> 338 </tr> 339 <tr class="field"><th class="field-name">Note :</th><td class="field-body">in this case just return empty array</td> 340 </tr> 341 </tbody> 342 </table> 343 </dd></dl> 1231 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">residuals derivatives .</td> 1232 </tr> 1233 <tr class="field-even field"><th class="field-name">Note :</th><td class="field-body">in this case just return empty array</td> 1234 </tr> 1235 </tbody> 1236 </table> 1237 </dd></dl> 1238 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> 344 1253 345 1254 <dl class="method"> 346 1255 <dt id="sans.fit.AbstractFitEngine.FitData2D.set_data"> 347 <tt class="descname">set_data</tt><big>(</big>< em>sans_data2d</em>, <em>qmin=None</em>, <em>qmax=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.set_data" title="Permalink to this definition">¶</a></dt>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> 348 1257 <dd><p>Determine the correct qx_data and qy_data within range to fit</p> 349 1258 </dd></dl> … … 351 1260 <dl class="method"> 352 1261 <dt id="sans.fit.AbstractFitEngine.FitData2D.set_fit_range"> 353 <tt class="descname">set_fit_range</tt><big>(</big>< em>qmin=None</em>, <em>qmax=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.set_fit_range" title="Permalink to this definition">¶</a></dt>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> 354 1263 <dd><p>to set the fit range</p> 355 1264 </dd></dl> … … 357 1266 <dl class="method"> 358 1267 <dt id="sans.fit.AbstractFitEngine.FitData2D.set_smearer"> 359 <tt class="descname">set_smearer</tt><big>(</big>< em>smearer</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.set_smearer" title="Permalink to this definition">¶</a></dt>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> 360 1269 <dd><p>Set smearer</p> 361 1270 </dd></dl> 362 1271 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 363 1287 <dl class="method"> 364 1288 <dt id="sans.fit.AbstractFitEngine.FitData2D.xaxis"> 365 <tt class="descname">xaxis</tt><big>(</big>< em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.xaxis" title="Permalink to this definition">¶</a></dt>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> 366 1290 <dd><p>set the x axis label and unit</p> 367 1291 </dd></dl> 368 1292 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 369 1308 <dl class="method"> 370 1309 <dt id="sans.fit.AbstractFitEngine.FitData2D.yaxis"> 371 <tt class="descname">yaxis</tt><big>(</big>< em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.yaxis" title="Permalink to this definition">¶</a></dt>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> 372 1311 <dd><p>set the y axis label and unit</p> 373 1312 </dd></dl> 374 1313 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 375 1324 <dl class="method"> 376 1325 <dt id="sans.fit.AbstractFitEngine.FitData2D.zaxis"> 377 <tt class="descname">zaxis</tt><big>(</big>< em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.zaxis" title="Permalink to this definition">¶</a></dt>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> 378 1327 <dd><p>set the z axis label and unit</p> 379 1328 </dd></dl> … … 385 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> 386 1335 <dd><dl class="method"> 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"> 387 1347 <dt id="sans.fit.AbstractFitEngine.FitEngine.get_model"> 388 <tt class="descname">get_model</tt><big>(</big>< em>id</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.get_model" title="Permalink to this definition">¶</a></dt>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> 389 1349 <dd><table class="docutils field-list" frame="void" rules="none"> 390 1350 <col class="field-name" /> 391 1351 <col class="field-body" /> 392 1352 <tbody valign="top"> 393 <tr class="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>394 </tr> 395 <tr class="field "><th class="field-name">Returns:</th><td class="field-body">a model at this id or None if no FitArrange element was1353 <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> 1354 </tr> 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 396 1356 created with this id</td> 397 1357 </tr> … … 402 1362 <dl class="method"> 403 1363 <dt id="sans.fit.AbstractFitEngine.FitEngine.get_problem_to_fit"> 404 <tt class="descname">get_problem_to_fit</tt><big>(</big>< em>id</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.get_problem_to_fit" title="Permalink to this definition">¶</a></dt>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> 405 1365 <dd><p>return the self.selected value of the fit problem of id</p> 406 1366 <table class="docutils field-list" frame="void" rules="none"> … … 408 1368 <col class="field-body" /> 409 1369 <tbody valign="top"> 410 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – the id of the problem</td>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> 411 1371 </tr> 412 1372 </tbody> … … 416 1376 <dl class="method"> 417 1377 <dt id="sans.fit.AbstractFitEngine.FitEngine.remove_fit_problem"> 418 <tt class="descname">remove_fit_problem</tt><big>(</big>< em>id</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.remove_fit_problem" title="Permalink to this definition">¶</a></dt>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> 419 1379 <dd><p>remove fitarrange in id</p> 420 1380 </dd></dl> … … 422 1382 <dl class="method"> 423 1383 <dt id="sans.fit.AbstractFitEngine.FitEngine.select_problem_for_fit"> 424 <tt class="descname">select_problem_for_fit</tt><big>(</big>< em>id</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.select_problem_for_fit" title="Permalink to this definition">¶</a></dt>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> 425 1385 <dd><p>select a couple of model and data at the id position in dictionary 426 1386 and set in self.selected value to value</p> … … 429 1389 <col class="field-body" /> 430 1390 <tbody valign="top"> 431 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> – the value to allow fitting.1391 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> – the value to allow fitting. 432 1392 can only have the value one or zero</td> 433 1393 </tr> … … 438 1398 <dl class="method"> 439 1399 <dt id="sans.fit.AbstractFitEngine.FitEngine.set_data"> 440 <tt class="descname">set_data</tt><big>(</big>< em>data</em>, <em>id</em>, <em>smearer=None</em>, <em>qmin=None</em>, <em>qmax=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.set_data" title="Permalink to this definition">¶</a></dt>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> 441 1401 <dd><p>Receives plottable, creates a list of data to fit,set data 442 1402 in a FitArrange object and adds that object in a dictionary … … 446 1406 <col class="field-body" /> 447 1407 <tbody valign="top"> 448 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">1408 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 449 1409 <li><strong>data</strong> – data added</li> 450 1410 <li><strong>id</strong> – unique key corresponding to a fitArrange object with data</li> … … 458 1418 <dl class="method"> 459 1419 <dt id="sans.fit.AbstractFitEngine.FitEngine.set_model"> 460 <tt class="descname">set_model</tt><big>(</big>< em>model</em>, <em>id</em>, <em>pars=</em><span class="optional">[</span><span class="optional">]</span>, <em>constraints=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.set_model" title="Permalink to this definition">¶</a></dt>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> 461 1421 <dd><p>set a model on a given in the fit engine.</p> 462 1422 <table class="docutils field-list" frame="void" rules="none"> … … 464 1424 <col class="field-body" /> 465 1425 <tbody valign="top"> 466 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – sans.models type</td>1426 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – sans.models type</td> 467 1427 </tr> 468 1428 </tbody> … … 476 1436 <col class="field-body" /> 477 1437 <tbody valign="top"> 478 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">1438 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 479 1439 <li><strong>pars</strong> – the list of parameters to fit</li> 480 1440 <li><strong>constraints</strong> – <p>list of … … 491 1451 </td> 492 1452 </tr> 493 <tr class="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>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> 494 1454 </td> 495 1455 </tr> … … 502 1462 <dl class="class"> 503 1463 <dt id="sans.fit.AbstractFitEngine.Model"> 504 <em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">Model</tt>< big>(</big><em>sans_model</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model" title="Permalink to this definition">¶</a></dt>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> 505 1465 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">park.model.Model</span></tt></p> 506 1466 <p>PARK wrapper for SANS models.</p> 507 1467 <dl class="method"> 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"> 508 1572 <dt id="sans.fit.AbstractFitEngine.Model.eval"> 509 <tt class="descname">eval</tt><big>(</big>< em>x</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.eval" title="Permalink to this definition">¶</a></dt>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> 510 1574 <dd><p>override eval method of park model.</p> 511 1575 <table class="docutils field-list" frame="void" rules="none"> … … 513 1577 <col class="field-body" /> 514 1578 <tbody valign="top"> 515 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> – the x value used to compute a function</td>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> 516 1580 </tr> 517 1581 </tbody> … … 521 1585 <dl class="method"> 522 1586 <dt id="sans.fit.AbstractFitEngine.Model.eval_derivs"> 523 <tt class="descname">eval_derivs</tt><big>(</big>< em>x</em>, <em>pars=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.eval_derivs" title="Permalink to this definition">¶</a></dt>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> 524 1588 <dd><p>Evaluate the model and derivatives wrt pars at x.</p> 525 1589 <p>pars is a list of the names of the parameters for which derivatives … … 533 1597 <dl class="method"> 534 1598 <dt id="sans.fit.AbstractFitEngine.Model.get_params"> 535 <tt class="descname">get_params</tt><big>(</big>< em>fitparams</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.get_params" title="Permalink to this definition">¶</a></dt>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> 536 1600 <dd><p>return a list of value of paramter to fit</p> 537 1601 <table class="docutils field-list" frame="void" rules="none"> … … 539 1603 <col class="field-body" /> 540 1604 <tbody valign="top"> 541 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>fitparams</strong> – list of paramaters name to fit</td> 542 </tr> 543 </tbody> 544 </table> 545 </dd></dl> 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> 1606 </tr> 1607 </tbody> 1608 </table> 1609 </dd></dl> 1610 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> 546 1620 547 1621 <dl class="method"> 548 1622 <dt id="sans.fit.AbstractFitEngine.Model.set"> 549 <tt class="descname">set</tt><big>(</big>< em>**kw</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.set" title="Permalink to this definition">¶</a></dt>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> 550 1624 <dd><p>Set the initial value for a set of parameters.</p> 551 1625 <p>E.g., model.set(width=3,center=5)</p> … … 554 1628 <dl class="method"> 555 1629 <dt id="sans.fit.AbstractFitEngine.Model.set_params"> 556 <tt class="descname">set_params</tt><big>(</big>< em>paramlist</em>, <em>params</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.set_params" title="Permalink to this definition">¶</a></dt>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> 557 1631 <dd><p>Set value for parameters to fit</p> 558 1632 <table class="docutils field-list" frame="void" rules="none"> … … 560 1634 <col class="field-body" /> 561 1635 <tbody valign="top"> 562 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>params</strong> – list of value for parameters to fit</td>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> 563 1637 </tr> 564 1638 </tbody> … … 570 1644 <dl class="class"> 571 1645 <dt id="sans.fit.AbstractFitEngine.SansAssembly"> 572 <em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">SansAssembly</tt>< big>(</big><em>paramlist</em>, <em>model=None</em>, <em>data=None</em>, <em>fitresult=None</em>, <em>handler=None</em>, <em>curr_thread=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansAssembly" title="Permalink to this definition">¶</a></dt>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> 573 1647 <dd><p>Sans Assembly class a class wrapper to be call in optimizer.leastsq method</p> 1648 <dl class="method"> 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 574 1684 <dl class="method"> 575 1685 <dt id="sans.fit.AbstractFitEngine.SansAssembly.check_param_range"> … … 589 1699 <col class="field-body" /> 590 1700 <tbody valign="top"> 591 <tr class="field "><th class="field-name">Parameters:</th><td class="field-body"><strong>params</strong> – list of parameter values</td>592 </tr> 593 <tr class="field "><th class="field-name">Returns:</th><td class="field-body">chi^2</td>1701 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>params</strong> – list of parameter values</td> 1702 </tr> 1703 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">chi^2</td> 594 1704 </tr> 595 1705 </tbody> … … 601 1711 <dl class="class"> 602 1712 <dt id="sans.fit.AbstractFitEngine.SansParameter"> 603 <em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">SansParameter</tt>< big>(</big><em>name</em>, <em>model</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter" title="Permalink to this definition">¶</a></dt>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> 604 1714 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">park.parameter.Parameter</span></tt></p> 605 1715 <p>SANS model parameters for use in the PARK fitting service. 606 1716 The parameter attribute value is redirected to the underlying 607 1717 parameter value in the SANS model.</p> 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 608 1875 <dl class="method"> 609 1876 <dt id="sans.fit.AbstractFitEngine.SansParameter.get"> … … 624 1891 <dl class="method"> 625 1892 <dt id="sans.fit.AbstractFitEngine.SansParameter.isfeasible"> 626 <tt class="descname">isfeasible</tt><big>(</big>< em>value</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.isfeasible" title="Permalink to this definition">¶</a></dt>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> 627 1894 <dd><p>Return true if the value is in the range</p> 628 1895 </dd></dl> … … 641 1908 <dt id="sans.fit.AbstractFitEngine.SansParameter.isrestrained"> 642 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"> 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> 643 1920 <dd></dd></dl> 644 1921 … … 648 1925 <dd><p>parameter name</p> 649 1926 </dd></dl> 1927 1928 <dl class="attribute"> 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> 650 1932 651 1933 <dl class="attribute"> … … 658 1940 <dl class="method"> 659 1941 <dt id="sans.fit.AbstractFitEngine.SansParameter.set"> 660 <tt class="descname">set</tt><big>(</big>< em>value</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.set" title="Permalink to this definition">¶</a></dt>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> 661 1943 <dd><p>Set a parameter to a value, a range or an expression. If it is a value, 662 1944 the parameter will be fixed for the fit. If it is a range, the value … … 668 1950 <dl class="method"> 669 1951 <dt id="sans.fit.AbstractFitEngine.SansParameter.setprefix"> 670 <tt class="descname">setprefix</tt><big>(</big>< em>prefix</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.setprefix" title="Permalink to this definition">¶</a></dt>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> 671 1953 <dd><p>Set the full path to the parameter as used in expressions involving 672 1954 the parameter name.</p> 673 1955 </dd></dl> 1956 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> 674 1961 675 1962 <dl class="method"> … … 679 1966 <p>E.g., ” Gold .....|.... 5.2043 in [2,7]”</p> 680 1967 </dd></dl> 1968 1969 <dl class="attribute"> 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> 681 1978 682 1979 <dl class="attribute"> … … 701 1998 <ul> 702 1999 <li><a class="reference internal" href="#">AbstractFitEngine</a><ul> 703 <li><a class="reference internal" href="#mod ule-sans.fit.AbstractFitEngine">:mod:` sans.fit.AbstractFitEngine`</a></li>2000 <li><a class="reference internal" href="#mod-sans-fit-abstractfitengine">:mod:` sans.fit.AbstractFitEngine`</a></li> 704 2001 </ul> 705 2002 </li> … … 720 2017 <h3>Quick search</h3> 721 2018 <form class="search" action="../search.html" method="get"> 722 <input type="text" name="q" size="18"/>2019 <input type="text" name="q" /> 723 2020 <input type="submit" value="Go" /> 724 2021 <input type="hidden" name="check_keywords" value="yes" /> … … 749 2046 <a href="index.html" title="Reference" 750 2047 >previous</a> |</li> 751 <li><a href="../index.html">park_integration v0.1.0 documentation</a> »</li>2048 <li><a href="../index.html">park_integration 0.1.0 documentation</a> »</li> 752 2049 <li><a href="index.html" >Reference</a> »</li> 753 2050 </ul> … … 755 2052 <div class="footer"> 756 2053 © Copyright 2010, sans group. 757 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1. 0.7.2054 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 758 2055 </div> 759 2056 </body>
Note: See TracChangeset
for help on using the changeset viewer.