Changeset 1679f2f in sasview for park_integration/docs
- Timestamp:
- Aug 12, 2011 2:30:37 PM (13 years ago)
- Branches:
- master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
- Children:
- fa597990
- Parents:
- 25cba72
- Location:
- park_integration/docs/sphinx/_build/html
- Files:
-
- 11 edited
Legend:
- Unmodified
- Added
- Removed
-
park_integration/docs/sphinx/_build/html/api/AbstractFitEngine.html
r41517a6 r1679f2f 36 36 accesskey="I">index</a></li> 37 37 <li class="right" > 38 <a href="../py-modindex.html" title="Python Module Index" 39 >modules</a> |</li> 40 <li class="right" > 38 41 <a href="Fitting.html" title="Fitting" 39 42 accesskey="N">next</a> |</li> … … 53 56 <div class="section" id="abstractfitengine"> 54 57 <h1>AbstractFitEngine<a class="headerlink" href="#abstractfitengine" title="Permalink to this headline">¶</a></h1> 55 <div class="section" id="mod-sans-fit-abstractfitengine"> 56 <h2>:mod:` sans.fit.AbstractFitEngine`<a class="headerlink" href="#mod-sans-fit-abstractfitengine" title="Permalink to this headline">¶</a></h2> 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> 60 <dl class="exception"> 61 <dt id="sans.fit.AbstractFitEngine.FitAbort"> 62 <em class="property">exception </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitAbort</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort" title="Permalink to this definition">¶</a></dt> 63 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p> 64 <p>Exception raise to stop the fit</p> 65 <dl class="attribute"> 66 <dt id="sans.fit.AbstractFitEngine.FitAbort.args"> 67 <tt class="descname">args</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.args" title="Permalink to this definition">¶</a></dt> 68 <dd></dd></dl> 69 70 <dl class="attribute"> 71 <dt id="sans.fit.AbstractFitEngine.FitAbort.message"> 72 <tt class="descname">message</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.message" title="Permalink to this definition">¶</a></dt> 73 <dd><p>exception message</p> 74 </dd></dl> 75 76 </dd></dl> 77 78 <dl class="class"> 79 <dt id="sans.fit.AbstractFitEngine.FitArrange"> 80 <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 <dd><dl class="method"> 82 <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> 84 <dd><p>add_data fill a self.data_list with data to fit</p> 85 <table class="docutils field-list" frame="void" rules="none"> 86 <col class="field-name" /> 87 <col class="field-body" /> 88 <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> 90 </tr> 91 </tbody> 92 </table> 93 </dd></dl> 94 95 <dl class="method"> 96 <dt id="sans.fit.AbstractFitEngine.FitArrange.get_data"> 97 <tt class="descname">get_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.get_data" title="Permalink to this definition">¶</a></dt> 98 <dd><table class="docutils field-list" frame="void" rules="none"> 99 <col class="field-name" /> 100 <col class="field-body" /> 101 <tbody valign="top"> 102 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">list of data data_list</td> 103 </tr> 104 </tbody> 105 </table> 106 </dd></dl> 107 108 <dl class="method"> 109 <dt id="sans.fit.AbstractFitEngine.FitArrange.get_model"> 110 <tt class="descname">get_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.get_model" title="Permalink to this definition">¶</a></dt> 111 <dd><table class="docutils field-list" frame="void" rules="none"> 112 <col class="field-name" /> 113 <col class="field-body" /> 114 <tbody valign="top"> 115 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">saved model</td> 116 </tr> 117 </tbody> 118 </table> 119 </dd></dl> 120 121 <dl class="method"> 122 <dt id="sans.fit.AbstractFitEngine.FitArrange.get_to_fit"> 123 <tt class="descname">get_to_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.get_to_fit" title="Permalink to this definition">¶</a></dt> 124 <dd><p>return self.selected value</p> 125 </dd></dl> 126 127 <dl class="method"> 128 <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> 130 <dd><p>Remove one element from the list</p> 131 <table class="docutils field-list" frame="void" rules="none"> 132 <col class="field-name" /> 133 <col class="field-body" /> 134 <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> 136 </tr> 137 </tbody> 138 </table> 139 </dd></dl> 140 141 <dl class="method"> 142 <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> 144 <dd><p>set_model save a copy of the model</p> 145 <table class="docutils field-list" frame="void" rules="none"> 146 <col class="field-name" /> 147 <col class="field-body" /> 148 <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> 150 </tr> 151 </tbody> 152 </table> 153 </dd></dl> 154 155 <dl class="method"> 156 <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> 158 <dd><p>set self.selected to 0 or 1 for other values raise an exception</p> 159 <table class="docutils field-list" frame="void" rules="none"> 160 <col class="field-name" /> 161 <col class="field-body" /> 162 <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> 164 </tr> 165 </tbody> 166 </table> 167 </dd></dl> 168 169 </dd></dl> 170 171 <dl class="class"> 172 <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> 174 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.data_info.Data1D</span></tt></p> 175 <p>Wrapper class for SANS data 176 FitData1D inherits from DataLoader.data_info.Data1D. Implements 177 a way to get residuals from data.</p> 178 <dl class="method"> 179 <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> 181 <dd><p>Add notes to datainfo</p> 182 </dd></dl> 183 184 <dl class="method"> 185 <dt id="sans.fit.AbstractFitEngine.FitData1D.append_empty_process"> 186 <tt class="descname">append_empty_process</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.append_empty_process" title="Permalink to this definition">¶</a></dt> 187 <dd></dd></dl> 188 189 <dl class="method"> 190 <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> 192 <dd><p>Clone the current object, without copying the data (which 193 will be filled out by a subsequent operation). 194 The data arrays will be initialized to zero.</p> 195 <table class="docutils field-list" frame="void" rules="none"> 196 <col class="field-name" /> 197 <col class="field-body" /> 198 <tbody valign="top"> 199 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 200 <li><strong>length</strong> – length of the data array to be initialized</li> 201 <li><strong>clone</strong> – if provided, the data will be copied to clone</li> 202 </ul> 203 </td> 204 </tr> 205 </tbody> 206 </table> 207 </dd></dl> 208 209 <dl class="method"> 210 <dt id="sans.fit.AbstractFitEngine.FitData1D.get_fit_range"> 211 <tt class="descname">get_fit_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.get_fit_range" title="Permalink to this definition">¶</a></dt> 212 <dd><p>return the range of data.x to fit</p> 213 </dd></dl> 214 215 <dl class="method"> 216 <dt id="sans.fit.AbstractFitEngine.FitData1D.is_slit_smeared"> 217 <tt class="descname">is_slit_smeared</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.is_slit_smeared" title="Permalink to this definition">¶</a></dt> 218 <dd><p>Check whether the data has slit smearing information</p> 219 <table class="docutils field-list" frame="void" rules="none"> 220 <col class="field-name" /> 221 <col class="field-body" /> 222 <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> 228 229 <dl class="method"> 230 <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> 232 <dd><p>Compute residuals.</p> 233 <p>If self.smearer has been set, use if to smear 234 the data before computing chi squared.</p> 235 <table class="docutils field-list" frame="void" rules="none"> 236 <col class="field-name" /> 237 <col class="field-body" /> 238 <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> 242 </tr> 243 </tbody> 244 </table> 245 </dd></dl> 246 247 <dl class="method"> 248 <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> 250 <dd><table class="docutils field-list" frame="void" rules="none"> 251 <col class="field-name" /> 252 <col class="field-body" /> 253 <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> 261 262 <dl class="method"> 263 <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> 265 <dd><p>to set the fit range</p> 266 </dd></dl> 267 268 <dl class="method"> 269 <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> 271 <dd><p>set the x axis label and unit</p> 272 </dd></dl> 273 274 <dl class="method"> 275 <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> 277 <dd><p>set the y axis label and unit</p> 278 </dd></dl> 279 280 </dd></dl> 281 282 <dl class="class"> 283 <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> 285 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.data_info.Data2D</span></tt></p> 286 <p>Wrapper class for SANS data</p> 287 <dl class="method"> 288 <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> 290 <dd><p>Add notes to datainfo</p> 291 </dd></dl> 292 293 <dl class="method"> 294 <dt id="sans.fit.AbstractFitEngine.FitData2D.append_empty_process"> 295 <tt class="descname">append_empty_process</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.append_empty_process" title="Permalink to this definition">¶</a></dt> 296 <dd></dd></dl> 297 298 <dl class="method"> 299 <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> 301 <dd><p>Clone the current object, without copying the data (which 302 will be filled out by a subsequent operation). 303 The data arrays will be initialized to zero.</p> 304 <table class="docutils field-list" frame="void" rules="none"> 305 <col class="field-name" /> 306 <col class="field-body" /> 307 <tbody valign="top"> 308 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 309 <li><strong>length</strong> – length of the data array to be initialized</li> 310 <li><strong>clone</strong> – if provided, the data will be copied to clone</li> 311 </ul> 312 </td> 313 </tr> 314 </tbody> 315 </table> 316 </dd></dl> 317 318 <dl class="method"> 319 <dt id="sans.fit.AbstractFitEngine.FitData2D.get_fit_range"> 320 <tt class="descname">get_fit_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.get_fit_range" title="Permalink to this definition">¶</a></dt> 321 <dd><p>return the range of data.x to fit</p> 322 </dd></dl> 323 324 <dl class="method"> 325 <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> 327 <dd><p>return the residuals</p> 328 </dd></dl> 329 330 <dl class="method"> 331 <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> 333 <dd><table class="docutils field-list" frame="void" rules="none"> 334 <col class="field-name" /> 335 <col class="field-body" /> 336 <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> 344 345 <dl class="method"> 346 <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> 348 <dd><p>Determine the correct qx_data and qy_data within range to fit</p> 349 </dd></dl> 350 351 <dl class="method"> 352 <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> 354 <dd><p>to set the fit range</p> 355 </dd></dl> 356 357 <dl class="method"> 358 <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> 360 <dd><p>Set smearer</p> 361 </dd></dl> 362 363 <dl class="method"> 364 <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> 366 <dd><p>set the x axis label and unit</p> 367 </dd></dl> 368 369 <dl class="method"> 370 <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> 372 <dd><p>set the y axis label and unit</p> 373 </dd></dl> 374 375 <dl class="method"> 376 <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> 378 <dd><p>set the z axis label and unit</p> 379 </dd></dl> 380 381 </dd></dl> 382 383 <dl class="class"> 384 <dt id="sans.fit.AbstractFitEngine.FitEngine"> 385 <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 <dd><dl class="method"> 387 <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> 389 <dd><table class="docutils field-list" frame="void" rules="none"> 390 <col class="field-name" /> 391 <col class="field-body" /> 392 <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 was 396 created with this id</td> 397 </tr> 398 </tbody> 399 </table> 400 </dd></dl> 401 402 <dl class="method"> 403 <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> 405 <dd><p>return the self.selected value of the fit problem of id</p> 406 <table class="docutils field-list" frame="void" rules="none"> 407 <col class="field-name" /> 408 <col class="field-body" /> 409 <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> 411 </tr> 412 </tbody> 413 </table> 414 </dd></dl> 415 416 <dl class="method"> 417 <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> 419 <dd><p>remove fitarrange in id</p> 420 </dd></dl> 421 422 <dl class="method"> 423 <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> 425 <dd><p>select a couple of model and data at the id position in dictionary 426 and set in self.selected value to value</p> 427 <table class="docutils field-list" frame="void" rules="none"> 428 <col class="field-name" /> 429 <col class="field-body" /> 430 <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. 432 can only have the value one or zero</td> 433 </tr> 434 </tbody> 435 </table> 436 </dd></dl> 437 438 <dl class="method"> 439 <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> 441 <dd><p>Receives plottable, creates a list of data to fit,set data 442 in a FitArrange object and adds that object in a dictionary 443 with key id.</p> 444 <table class="docutils field-list" frame="void" rules="none"> 445 <col class="field-name" /> 446 <col class="field-body" /> 447 <tbody valign="top"> 448 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 449 <li><strong>data</strong> – data added</li> 450 <li><strong>id</strong> – unique key corresponding to a fitArrange object with data</li> 451 </ul> 452 </td> 453 </tr> 454 </tbody> 455 </table> 456 </dd></dl> 457 458 <dl class="method"> 459 <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> 461 <dd><p>set a model on a given in the fit engine.</p> 462 <table class="docutils field-list" frame="void" rules="none"> 463 <col class="field-name" /> 464 <col class="field-body" /> 465 <tbody valign="top"> 466 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – sans.models type</td> 467 </tr> 468 </tbody> 469 </table> 470 <dl class="docutils"> 471 <dt>:param <span class="classifier-delimiter">:</span> <span class="classifier">is the key of the fitArrange dictionary where model is </span></dt> 472 <dd>saved as a value</dd> 473 </dl> 474 <table class="docutils field-list" frame="void" rules="none"> 475 <col class="field-name" /> 476 <col class="field-body" /> 477 <tbody valign="top"> 478 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 479 <li><strong>pars</strong> – the list of parameters to fit</li> 480 <li><strong>constraints</strong> – <p>list of 481 tuple (name of parameter, value of parameters) 482 the value of parameter must be a string to constraint 2 different 483 parameters. 484 Example: 485 we want to fit 2 model M1 and M2 both have parameters A and B. 486 constraints can be:</p> 487 <blockquote> 488 <div>constraints = [(M1.A, M2.B+2), (M1.B= M2.A <a href="#id1"><span class="problematic" id="id2">*</span></a>5),...,]</div></blockquote> 489 </li> 490 </ul> 491 </td> 492 </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> 494 </td> 495 </tr> 496 </tbody> 497 </table> 498 </dd></dl> 499 500 </dd></dl> 501 502 <dl class="class"> 503 <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> 505 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">park.model.Model</span></tt></p> 506 <p>PARK wrapper for SANS models.</p> 507 <dl class="method"> 508 <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> 510 <dd><p>override eval method of park model.</p> 511 <table class="docutils field-list" frame="void" rules="none"> 512 <col class="field-name" /> 513 <col class="field-body" /> 514 <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> 516 </tr> 517 </tbody> 518 </table> 519 </dd></dl> 520 521 <dl class="method"> 522 <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> 524 <dd><p>Evaluate the model and derivatives wrt pars at x.</p> 525 <p>pars is a list of the names of the parameters for which derivatives 526 are desired.</p> 527 <p>This method needs to be specialized in the model to evaluate the 528 model function. Alternatively, the model can implement is own 529 version of residuals which calculates the residuals directly 530 instead of calling eval.</p> 531 </dd></dl> 532 533 <dl class="method"> 534 <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> 536 <dd><p>return a list of value of paramter to fit</p> 537 <table class="docutils field-list" frame="void" rules="none"> 538 <col class="field-name" /> 539 <col class="field-body" /> 540 <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> 546 547 <dl class="method"> 548 <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> 550 <dd><p>Set the initial value for a set of parameters.</p> 551 <p>E.g., model.set(width=3,center=5)</p> 552 </dd></dl> 553 554 <dl class="method"> 555 <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> 557 <dd><p>Set value for parameters to fit</p> 558 <table class="docutils field-list" frame="void" rules="none"> 559 <col class="field-name" /> 560 <col class="field-body" /> 561 <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> 563 </tr> 564 </tbody> 565 </table> 566 </dd></dl> 567 568 </dd></dl> 569 570 <dl class="class"> 571 <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> 573 <dd><p>Sans Assembly class a class wrapper to be call in optimizer.leastsq method</p> 574 <dl class="method"> 575 <dt id="sans.fit.AbstractFitEngine.SansAssembly.check_param_range"> 576 <tt class="descname">check_param_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansAssembly.check_param_range" title="Permalink to this definition">¶</a></dt> 577 <dd><p>Check the lower and upper bound of the parameter value 578 and set res to the inf if the value is outside of the 579 range 580 :limitation: the initial values must be within range.</p> 581 </dd></dl> 582 583 <dl class="method"> 584 <dt id="sans.fit.AbstractFitEngine.SansAssembly.chisq"> 585 <tt class="descname">chisq</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansAssembly.chisq" title="Permalink to this definition">¶</a></dt> 586 <dd><p>Calculates chi^2</p> 587 <table class="docutils field-list" frame="void" rules="none"> 588 <col class="field-name" /> 589 <col class="field-body" /> 590 <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> 594 </tr> 595 </tbody> 596 </table> 597 </dd></dl> 598 599 </dd></dl> 600 601 <dl class="class"> 602 <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> 604 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">park.parameter.Parameter</span></tt></p> 605 <p>SANS model parameters for use in the PARK fitting service. 606 The parameter attribute value is redirected to the underlying 607 parameter value in the SANS model.</p> 608 <dl class="method"> 609 <dt id="sans.fit.AbstractFitEngine.SansParameter.get"> 610 <tt class="descname">get</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.get" title="Permalink to this definition">¶</a></dt> 611 <dd><p>Return the current value for a parameter.</p> 612 </dd></dl> 613 614 <dl class="method"> 615 <dt id="sans.fit.AbstractFitEngine.SansParameter.get_name"> 616 <tt class="descname">get_name</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.get_name" title="Permalink to this definition">¶</a></dt> 617 <dd></dd></dl> 618 619 <dl class="method"> 620 <dt id="sans.fit.AbstractFitEngine.SansParameter.iscomputed"> 621 <tt class="descname">iscomputed</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.iscomputed" title="Permalink to this definition">¶</a></dt> 622 <dd></dd></dl> 623 624 <dl class="method"> 625 <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> 627 <dd><p>Return true if the value is in the range</p> 628 </dd></dl> 629 630 <dl class="method"> 631 <dt id="sans.fit.AbstractFitEngine.SansParameter.isfitted"> 632 <tt class="descname">isfitted</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.isfitted" title="Permalink to this definition">¶</a></dt> 633 <dd></dd></dl> 634 635 <dl class="method"> 636 <dt id="sans.fit.AbstractFitEngine.SansParameter.isfixed"> 637 <tt class="descname">isfixed</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.isfixed" title="Permalink to this definition">¶</a></dt> 638 <dd></dd></dl> 639 640 <dl class="method"> 641 <dt id="sans.fit.AbstractFitEngine.SansParameter.isrestrained"> 642 <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> 643 <dd></dd></dl> 644 645 <dl class="attribute"> 646 <dt id="sans.fit.AbstractFitEngine.SansParameter.name"> 647 <tt class="descname">name</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.name" title="Permalink to this definition">¶</a></dt> 648 <dd><p>parameter name</p> 649 </dd></dl> 650 651 <dl class="attribute"> 652 <dt id="sans.fit.AbstractFitEngine.SansParameter.range"> 653 <tt class="descname">range</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.range" title="Permalink to this definition">¶</a></dt> 654 <dd><p>Override _getrange of park parameter 655 return the range of parameter</p> 656 </dd></dl> 657 658 <dl class="method"> 659 <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> 661 <dd><p>Set a parameter to a value, a range or an expression. If it is a value, 662 the parameter will be fixed for the fit. If it is a range, the value 663 will be varying for the fit. If it is an expression, the parameter will 664 be calculated from the values of other parameters in the fit.</p> 665 <p>Raises ValueError if the value could not be interpreted.</p> 666 </dd></dl> 667 668 <dl class="method"> 669 <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> 671 <dd><p>Set the full path to the parameter as used in expressions involving 672 the parameter name.</p> 673 </dd></dl> 674 675 <dl class="method"> 676 <dt id="sans.fit.AbstractFitEngine.SansParameter.summarize"> 677 <tt class="descname">summarize</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.summarize" title="Permalink to this definition">¶</a></dt> 678 <dd><p>Return parameter range string.</p> 679 <p>E.g., ” Gold .....|.... 5.2043 in [2,7]”</p> 680 </dd></dl> 681 682 <dl class="attribute"> 683 <dt id="sans.fit.AbstractFitEngine.SansParameter.value"> 684 <tt class="descname">value</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.value" title="Permalink to this definition">¶</a></dt> 685 <dd><p>override the _getvalue of park parameter</p> 686 <p>:return value the parameter associates with self.name</p> 687 </dd></dl> 688 689 </dd></dl> 690 57 691 </div> 58 692 </div> … … 67 701 <ul> 68 702 <li><a class="reference internal" href="#">AbstractFitEngine</a><ul> 69 <li><a class="reference internal" href="#mod -sans-fit-abstractfitengine">:mod:` sans.fit.AbstractFitEngine`</a></li>703 <li><a class="reference internal" href="#module-sans.fit.AbstractFitEngine">:mod:` sans.fit.AbstractFitEngine`</a></li> 70 704 </ul> 71 705 </li> … … 107 741 >index</a></li> 108 742 <li class="right" > 743 <a href="../py-modindex.html" title="Python Module Index" 744 >modules</a> |</li> 745 <li class="right" > 109 746 <a href="Fitting.html" title="Fitting" 110 747 >next</a> |</li> -
park_integration/docs/sphinx/_build/html/api/Fitting.html
r41517a6 r1679f2f 35 35 <a href="../genindex.html" title="General Index" 36 36 accesskey="I">index</a></li> 37 <li class="right" > 38 <a href="../py-modindex.html" title="Python Module Index" 39 >modules</a> |</li> 37 40 <li class="right" > 38 41 <a href="ParkFitting.html" title="ParkFitting" … … 107 110 >index</a></li> 108 111 <li class="right" > 112 <a href="../py-modindex.html" title="Python Module Index" 113 >modules</a> |</li> 114 <li class="right" > 109 115 <a href="ParkFitting.html" title="ParkFitting" 110 116 >next</a> |</li> -
park_integration/docs/sphinx/_build/html/api/ParkFitting.html
r41517a6 r1679f2f 35 35 <a href="../genindex.html" title="General Index" 36 36 accesskey="I">index</a></li> 37 <li class="right" > 38 <a href="../py-modindex.html" title="Python Module Index" 39 >modules</a> |</li> 37 40 <li class="right" > 38 41 <a href="ScipyFitting.html" title="ScipyFitting" … … 107 110 >index</a></li> 108 111 <li class="right" > 112 <a href="../py-modindex.html" title="Python Module Index" 113 >modules</a> |</li> 114 <li class="right" > 109 115 <a href="ScipyFitting.html" title="ScipyFitting" 110 116 >next</a> |</li> -
park_integration/docs/sphinx/_build/html/api/ScipyFitting.html
r41517a6 r1679f2f 35 35 accesskey="I">index</a></li> 36 36 <li class="right" > 37 <a href="../py-modindex.html" title="Python Module Index" 38 >modules</a> |</li> 39 <li class="right" > 37 40 <a href="ParkFitting.html" title="ParkFitting" 38 41 accesskey="P">previous</a> |</li> … … 49 52 <div class="section" id="scipyfitting"> 50 53 <h1>ScipyFitting<a class="headerlink" href="#scipyfitting" title="Permalink to this headline">¶</a></h1> 51 <div class="section" id="mod-sans-fit-scipyfitting"> 52 <h2>:mod:` sans.fit.ScipyFitting`<a class="headerlink" href="#mod-sans-fit-scipyfitting" title="Permalink to this headline">¶</a></h2> 54 <div class="section" id="module-sans.fit.ScipyFitting"> 55 <span id="mod-sans-fit-scipyfitting"></span><h2>:mod:` sans.fit.ScipyFitting`<a class="headerlink" href="#module-sans.fit.ScipyFitting" title="Permalink to this headline">¶</a></h2> 56 <p>ScipyFitting module contains FitArrange , ScipyFit, 57 Parameter classes.All listed classes work together to perform a 58 simple fit with scipy optimizer.</p> 59 <dl class="class"> 60 <dt id="sans.fit.ScipyFitting.ScipyFit"> 61 <em class="property">class </em><tt class="descclassname">sans.fit.ScipyFitting.</tt><tt class="descname">ScipyFit</tt><a class="headerlink" href="#sans.fit.ScipyFitting.ScipyFit" title="Permalink to this definition">¶</a></dt> 62 <dd><p>Bases: <a class="reference internal" href="AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitEngine" title="sans.fit.AbstractFitEngine.FitEngine"><tt class="xref py py-class docutils literal"><span class="pre">sans.fit.AbstractFitEngine.FitEngine</span></tt></a></p> 63 <p>ScipyFit performs the Fit.This class can be used as follow: 64 #Do the fit SCIPY 65 create an engine: engine = ScipyFit() 66 Use data must be of type plottable 67 Use a sans model</p> 68 <p>Add data with a dictionnary of FitArrangeDict where Uid is a key and data 69 is saved in FitArrange object. 70 engine.set_data(data,Uid)</p> 71 <p>Set model parameter “M1”= model.name add {model.parameter.name:value}.</p> 72 <table class="docutils field-list" frame="void" rules="none"> 73 <col class="field-name" /> 74 <col class="field-body" /> 75 <tbody valign="top"> 76 <tr class="field"><th class="field-name">Note :</th><td class="field-body">Set_param() if used must always preceded set_model() 77 for the fit to be performed.In case of Scipyfit set_param is called in 78 fit () automatically.</td> 79 </tr> 80 </tbody> 81 </table> 82 <p>engine.set_param( model,”M1”, {‘A’:2,’B’:4})</p> 83 <p>Add model with a dictionnary of FitArrangeDict{} where Uid is a key and model 84 is save in FitArrange object. 85 engine.set_model(model,Uid)</p> 86 <p>engine.fit return chisqr,[model.parameter 1,2,..],[[err1....][..err2...]] 87 chisqr1, out1, cov1=engine.fit({model.parameter.name:value},qmin,qmax)</p> 88 <dl class="method"> 89 <dt id="sans.fit.ScipyFitting.ScipyFit.fit"> 90 <tt class="descname">fit</tt><big>(</big><em>q=None</em>, <em>handler=None</em>, <em>curr_thread=None</em>, <em>ftol=1.49012e-008</em><big>)</big><a class="headerlink" href="#sans.fit.ScipyFitting.ScipyFit.fit" title="Permalink to this definition">¶</a></dt> 91 <dd></dd></dl> 92 93 <dl class="method"> 94 <dt id="sans.fit.ScipyFitting.ScipyFit.get_model"> 95 <tt class="descname">get_model</tt><big>(</big><em>id</em><big>)</big><a class="headerlink" href="#sans.fit.ScipyFitting.ScipyFit.get_model" title="Permalink to this definition">¶</a></dt> 96 <dd><table class="docutils field-list" frame="void" rules="none"> 97 <col class="field-name" /> 98 <col class="field-body" /> 99 <tbody valign="top"> 100 <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> 101 </tr> 102 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">a model at this id or None if no FitArrange element was 103 created with this id</td> 104 </tr> 105 </tbody> 106 </table> 107 </dd></dl> 108 109 <dl class="method"> 110 <dt id="sans.fit.ScipyFitting.ScipyFit.get_problem_to_fit"> 111 <tt class="descname">get_problem_to_fit</tt><big>(</big><em>id</em><big>)</big><a class="headerlink" href="#sans.fit.ScipyFitting.ScipyFit.get_problem_to_fit" title="Permalink to this definition">¶</a></dt> 112 <dd><p>return the self.selected value of the fit problem of id</p> 113 <table class="docutils field-list" frame="void" rules="none"> 114 <col class="field-name" /> 115 <col class="field-body" /> 116 <tbody valign="top"> 117 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – the id of the problem</td> 118 </tr> 119 </tbody> 120 </table> 121 </dd></dl> 122 123 <dl class="method"> 124 <dt id="sans.fit.ScipyFitting.ScipyFit.remove_fit_problem"> 125 <tt class="descname">remove_fit_problem</tt><big>(</big><em>id</em><big>)</big><a class="headerlink" href="#sans.fit.ScipyFitting.ScipyFit.remove_fit_problem" title="Permalink to this definition">¶</a></dt> 126 <dd><p>remove fitarrange in id</p> 127 </dd></dl> 128 129 <dl class="method"> 130 <dt id="sans.fit.ScipyFitting.ScipyFit.select_problem_for_fit"> 131 <tt class="descname">select_problem_for_fit</tt><big>(</big><em>id</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.fit.ScipyFitting.ScipyFit.select_problem_for_fit" title="Permalink to this definition">¶</a></dt> 132 <dd><p>select a couple of model and data at the id position in dictionary 133 and set in self.selected value to value</p> 134 <table class="docutils field-list" frame="void" rules="none"> 135 <col class="field-name" /> 136 <col class="field-body" /> 137 <tbody valign="top"> 138 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> – the value to allow fitting. 139 can only have the value one or zero</td> 140 </tr> 141 </tbody> 142 </table> 143 </dd></dl> 144 145 <dl class="method"> 146 <dt id="sans.fit.ScipyFitting.ScipyFit.set_data"> 147 <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.ScipyFitting.ScipyFit.set_data" title="Permalink to this definition">¶</a></dt> 148 <dd><p>Receives plottable, creates a list of data to fit,set data 149 in a FitArrange object and adds that object in a dictionary 150 with key id.</p> 151 <table class="docutils field-list" frame="void" rules="none"> 152 <col class="field-name" /> 153 <col class="field-body" /> 154 <tbody valign="top"> 155 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 156 <li><strong>data</strong> – data added</li> 157 <li><strong>id</strong> – unique key corresponding to a fitArrange object with data</li> 158 </ul> 159 </td> 160 </tr> 161 </tbody> 162 </table> 163 </dd></dl> 164 165 <dl class="method"> 166 <dt id="sans.fit.ScipyFitting.ScipyFit.set_model"> 167 <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.ScipyFitting.ScipyFit.set_model" title="Permalink to this definition">¶</a></dt> 168 <dd><p>set a model on a given in the fit engine.</p> 169 <table class="docutils field-list" frame="void" rules="none"> 170 <col class="field-name" /> 171 <col class="field-body" /> 172 <tbody valign="top"> 173 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – sans.models type</td> 174 </tr> 175 </tbody> 176 </table> 177 <dl class="docutils"> 178 <dt>:param <span class="classifier-delimiter">:</span> <span class="classifier">is the key of the fitArrange dictionary where model is </span></dt> 179 <dd>saved as a value</dd> 180 </dl> 181 <table class="docutils field-list" frame="void" rules="none"> 182 <col class="field-name" /> 183 <col class="field-body" /> 184 <tbody valign="top"> 185 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 186 <li><strong>pars</strong> – the list of parameters to fit</li> 187 <li><strong>constraints</strong> – <p>list of 188 tuple (name of parameter, value of parameters) 189 the value of parameter must be a string to constraint 2 different 190 parameters. 191 Example: 192 we want to fit 2 model M1 and M2 both have parameters A and B. 193 constraints can be:</p> 194 <blockquote> 195 <div>constraints = [(M1.A, M2.B+2), (M1.B= M2.A <a href="#id1"><span class="problematic" id="id2">*</span></a>5),...,]</div></blockquote> 196 </li> 197 </ul> 198 </td> 199 </tr> 200 <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> 201 </td> 202 </tr> 203 </tbody> 204 </table> 205 </dd></dl> 206 207 </dd></dl> 208 209 <dl class="class"> 210 <dt id="sans.fit.ScipyFitting.fitresult"> 211 <em class="property">class </em><tt class="descclassname">sans.fit.ScipyFitting.</tt><tt class="descname">fitresult</tt><big>(</big><em>model=None</em>, <em>param_list=None</em><big>)</big><a class="headerlink" href="#sans.fit.ScipyFitting.fitresult" title="Permalink to this definition">¶</a></dt> 212 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> 213 <p>Storing fit result</p> 214 <dl class="method"> 215 <dt id="sans.fit.ScipyFitting.fitresult.print_summary"> 216 <tt class="descname">print_summary</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ScipyFitting.fitresult.print_summary" title="Permalink to this definition">¶</a></dt> 217 <dd></dd></dl> 218 219 <dl class="method"> 220 <dt id="sans.fit.ScipyFitting.fitresult.set_fitness"> 221 <tt class="descname">set_fitness</tt><big>(</big><em>fitness</em><big>)</big><a class="headerlink" href="#sans.fit.ScipyFitting.fitresult.set_fitness" title="Permalink to this definition">¶</a></dt> 222 <dd></dd></dl> 223 224 <dl class="method"> 225 <dt id="sans.fit.ScipyFitting.fitresult.set_model"> 226 <tt class="descname">set_model</tt><big>(</big><em>model</em><big>)</big><a class="headerlink" href="#sans.fit.ScipyFitting.fitresult.set_model" title="Permalink to this definition">¶</a></dt> 227 <dd></dd></dl> 228 229 </dd></dl> 230 53 231 </div> 54 232 </div> … … 63 241 <ul> 64 242 <li><a class="reference internal" href="#">ScipyFitting</a><ul> 65 <li><a class="reference internal" href="#mod -sans-fit-scipyfitting">:mod:` sans.fit.ScipyFitting`</a></li>243 <li><a class="reference internal" href="#module-sans.fit.ScipyFitting">:mod:` sans.fit.ScipyFitting`</a></li> 66 244 </ul> 67 245 </li> … … 100 278 >index</a></li> 101 279 <li class="right" > 280 <a href="../py-modindex.html" title="Python Module Index" 281 >modules</a> |</li> 282 <li class="right" > 102 283 <a href="ParkFitting.html" title="ParkFitting" 103 284 >previous</a> |</li> -
park_integration/docs/sphinx/_build/html/api/index.html
r41517a6 r1679f2f 35 35 accesskey="I">index</a></li> 36 36 <li class="right" > 37 <a href="../py-modindex.html" title="Python Module Index" 38 >modules</a> |</li> 39 <li class="right" > 37 40 <a href="AbstractFitEngine.html" title="AbstractFitEngine" 38 41 accesskey="N">next</a> |</li> … … 64 67 <ul> 65 68 <li class="toctree-l1"><a class="reference internal" href="AbstractFitEngine.html">AbstractFitEngine</a><ul> 66 <li class="toctree-l2"><a class="reference internal" href="AbstractFitEngine.html#mod -sans-fit-abstractfitengine">:mod:` sans.fit.AbstractFitEngine`</a></li>69 <li class="toctree-l2"><a class="reference internal" href="AbstractFitEngine.html#module-sans.fit.AbstractFitEngine">:mod:` sans.fit.AbstractFitEngine`</a></li> 67 70 </ul> 68 71 </li> … … 76 79 </li> 77 80 <li class="toctree-l1"><a class="reference internal" href="ScipyFitting.html">ScipyFitting</a><ul> 78 <li class="toctree-l2"><a class="reference internal" href="ScipyFitting.html#mod -sans-fit-scipyfitting">:mod:` sans.fit.ScipyFitting`</a></li>81 <li class="toctree-l2"><a class="reference internal" href="ScipyFitting.html#module-sans.fit.ScipyFitting">:mod:` sans.fit.ScipyFitting`</a></li> 79 82 </ul> 80 83 </li> … … 124 127 >index</a></li> 125 128 <li class="right" > 129 <a href="../py-modindex.html" title="Python Module Index" 130 >modules</a> |</li> 131 <li class="right" > 126 132 <a href="AbstractFitEngine.html" title="AbstractFitEngine" 127 133 >next</a> |</li> -
park_integration/docs/sphinx/_build/html/genindex.html
r41517a6 r1679f2f 32 32 <a href="#" title="General Index" 33 33 accesskey="I">index</a></li> 34 <li class="right" > 35 <a href="py-modindex.html" title="Python Module Index" 36 >modules</a> |</li> 34 37 <li><a href="index.html">park_integration v0.1.0 documentation</a> »</li> 35 38 </ul> … … 45 48 46 49 <div class="genindex-jumpbox"> 47 50 <a href="#A"><strong>A</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#V"><strong>V</strong></a> | <a href="#X"><strong>X</strong></a> | <a href="#Y"><strong>Y</strong></a> | <a href="#Z"><strong>Z</strong></a> 48 51 </div> 52 <h2 id="A">A</h2> 53 <table style="width: 100%" class="indextable genindextable"><tr> 54 <td style="width: 33%" valign="top"><dl> 55 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitArrange.add_data">add_data() (sans.fit.AbstractFitEngine.FitArrange method)</a></dt> 56 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.add_notes">add_notes() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt> 57 <dd><dl> 58 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.add_notes">(sans.fit.AbstractFitEngine.FitData2D method)</a></dt> 59 </dl></dd> 60 </dl></td> 61 <td style="width: 33%" valign="top"><dl> 62 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.append_empty_process">append_empty_process() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt> 63 <dd><dl> 64 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.append_empty_process">(sans.fit.AbstractFitEngine.FitData2D method)</a></dt> 65 </dl></dd> 66 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitAbort.args">args (sans.fit.AbstractFitEngine.FitAbort attribute)</a></dt> 67 </dl></td> 68 </tr></table> 69 70 <h2 id="C">C</h2> 71 <table style="width: 100%" class="indextable genindextable"><tr> 72 <td style="width: 33%" valign="top"><dl> 73 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansAssembly.check_param_range">check_param_range() (sans.fit.AbstractFitEngine.SansAssembly method)</a></dt> 74 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansAssembly.chisq">chisq() (sans.fit.AbstractFitEngine.SansAssembly method)</a></dt> 75 </dl></td> 76 <td style="width: 33%" valign="top"><dl> 77 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.clone_without_data">clone_without_data() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt> 78 <dd><dl> 79 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.clone_without_data">(sans.fit.AbstractFitEngine.FitData2D method)</a></dt> 80 </dl></dd> 81 </dl></td> 82 </tr></table> 83 84 <h2 id="E">E</h2> 85 <table style="width: 100%" class="indextable genindextable"><tr> 86 <td style="width: 33%" valign="top"><dl> 87 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.Model.eval">eval() (sans.fit.AbstractFitEngine.Model method)</a></dt> 88 </dl></td> 89 <td style="width: 33%" valign="top"><dl> 90 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.Model.eval_derivs">eval_derivs() (sans.fit.AbstractFitEngine.Model method)</a></dt> 91 </dl></td> 92 </tr></table> 93 94 <h2 id="F">F</h2> 95 <table style="width: 100%" class="indextable genindextable"><tr> 96 <td style="width: 33%" valign="top"><dl> 97 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.ScipyFit.fit">fit() (sans.fit.ScipyFitting.ScipyFit method)</a></dt> 98 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitAbort">FitAbort</a></dt> 99 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitArrange">FitArrange (class in sans.fit.AbstractFitEngine)</a></dt> 100 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D">FitData1D (class in sans.fit.AbstractFitEngine)</a></dt> 101 </dl></td> 102 <td style="width: 33%" valign="top"><dl> 103 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D">FitData2D (class in sans.fit.AbstractFitEngine)</a></dt> 104 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitEngine">FitEngine (class in sans.fit.AbstractFitEngine)</a></dt> 105 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.fitresult">fitresult (class in sans.fit.ScipyFitting)</a></dt> 106 </dl></td> 107 </tr></table> 108 109 <h2 id="G">G</h2> 110 <table style="width: 100%" class="indextable genindextable"><tr> 111 <td style="width: 33%" valign="top"><dl> 112 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.get">get() (sans.fit.AbstractFitEngine.SansParameter method)</a></dt> 113 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitArrange.get_data">get_data() (sans.fit.AbstractFitEngine.FitArrange method)</a></dt> 114 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.get_fit_range">get_fit_range() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt> 115 <dd><dl> 116 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.get_fit_range">(sans.fit.AbstractFitEngine.FitData2D method)</a></dt> 117 </dl></dd> 118 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitArrange.get_model">get_model() (sans.fit.AbstractFitEngine.FitArrange method)</a></dt> 119 <dd><dl> 120 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitEngine.get_model">(sans.fit.AbstractFitEngine.FitEngine method)</a></dt> 121 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.ScipyFit.get_model">(sans.fit.ScipyFitting.ScipyFit method)</a></dt> 122 </dl></dd> 123 </dl></td> 124 <td style="width: 33%" valign="top"><dl> 125 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.get_name">get_name() (sans.fit.AbstractFitEngine.SansParameter method)</a></dt> 126 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.Model.get_params">get_params() (sans.fit.AbstractFitEngine.Model method)</a></dt> 127 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitEngine.get_problem_to_fit">get_problem_to_fit() (sans.fit.AbstractFitEngine.FitEngine method)</a></dt> 128 <dd><dl> 129 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.ScipyFit.get_problem_to_fit">(sans.fit.ScipyFitting.ScipyFit method)</a></dt> 130 </dl></dd> 131 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitArrange.get_to_fit">get_to_fit() (sans.fit.AbstractFitEngine.FitArrange method)</a></dt> 132 </dl></td> 133 </tr></table> 134 135 <h2 id="I">I</h2> 136 <table style="width: 100%" class="indextable genindextable"><tr> 137 <td style="width: 33%" valign="top"><dl> 138 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.is_slit_smeared">is_slit_smeared() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt> 139 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.iscomputed">iscomputed() (sans.fit.AbstractFitEngine.SansParameter method)</a></dt> 140 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.isfeasible">isfeasible() (sans.fit.AbstractFitEngine.SansParameter method)</a></dt> 141 </dl></td> 142 <td style="width: 33%" valign="top"><dl> 143 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.isfitted">isfitted() (sans.fit.AbstractFitEngine.SansParameter method)</a></dt> 144 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.isfixed">isfixed() (sans.fit.AbstractFitEngine.SansParameter method)</a></dt> 145 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.isrestrained">isrestrained() (sans.fit.AbstractFitEngine.SansParameter method)</a></dt> 146 </dl></td> 147 </tr></table> 148 149 <h2 id="M">M</h2> 150 <table style="width: 100%" class="indextable genindextable"><tr> 151 <td style="width: 33%" valign="top"><dl> 152 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitAbort.message">message (sans.fit.AbstractFitEngine.FitAbort attribute)</a></dt> 153 </dl></td> 154 <td style="width: 33%" valign="top"><dl> 155 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.Model">Model (class in sans.fit.AbstractFitEngine)</a></dt> 156 </dl></td> 157 </tr></table> 158 159 <h2 id="N">N</h2> 160 <table style="width: 100%" class="indextable genindextable"><tr> 161 <td style="width: 33%" valign="top"><dl> 162 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.name">name (sans.fit.AbstractFitEngine.SansParameter attribute)</a></dt> 163 </dl></td> 164 </tr></table> 165 166 <h2 id="P">P</h2> 167 <table style="width: 100%" class="indextable genindextable"><tr> 168 <td style="width: 33%" valign="top"><dl> 169 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.fitresult.print_summary">print_summary() (sans.fit.ScipyFitting.fitresult method)</a></dt> 170 </dl></td> 171 </tr></table> 172 173 <h2 id="R">R</h2> 174 <table style="width: 100%" class="indextable genindextable"><tr> 175 <td style="width: 33%" valign="top"><dl> 176 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.range">range (sans.fit.AbstractFitEngine.SansParameter attribute)</a></dt> 177 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitArrange.remove_data">remove_data() (sans.fit.AbstractFitEngine.FitArrange method)</a></dt> 178 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitEngine.remove_fit_problem">remove_fit_problem() (sans.fit.AbstractFitEngine.FitEngine method)</a></dt> 179 <dd><dl> 180 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.ScipyFit.remove_fit_problem">(sans.fit.ScipyFitting.ScipyFit method)</a></dt> 181 </dl></dd> 182 </dl></td> 183 <td style="width: 33%" valign="top"><dl> 184 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.residuals">residuals() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt> 185 <dd><dl> 186 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.residuals">(sans.fit.AbstractFitEngine.FitData2D method)</a></dt> 187 </dl></dd> 188 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.residuals_deriv">residuals_deriv() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt> 189 <dd><dl> 190 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.residuals_deriv">(sans.fit.AbstractFitEngine.FitData2D method)</a></dt> 191 </dl></dd> 192 </dl></td> 193 </tr></table> 194 195 <h2 id="S">S</h2> 196 <table style="width: 100%" class="indextable genindextable"><tr> 197 <td style="width: 33%" valign="top"><dl> 198 <dt><a href="api/AbstractFitEngine.html#module-sans.fit.AbstractFitEngine">sans.fit.AbstractFitEngine (module)</a></dt> 199 <dt><a href="api/ScipyFitting.html#module-sans.fit.ScipyFitting">sans.fit.ScipyFitting (module)</a></dt> 200 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansAssembly">SansAssembly (class in sans.fit.AbstractFitEngine)</a></dt> 201 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter">SansParameter (class in sans.fit.AbstractFitEngine)</a></dt> 202 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.ScipyFit">ScipyFit (class in sans.fit.ScipyFitting)</a></dt> 203 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitEngine.select_problem_for_fit">select_problem_for_fit() (sans.fit.AbstractFitEngine.FitEngine method)</a></dt> 204 <dd><dl> 205 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.ScipyFit.select_problem_for_fit">(sans.fit.ScipyFitting.ScipyFit method)</a></dt> 206 </dl></dd> 207 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.Model.set">set() (sans.fit.AbstractFitEngine.Model method)</a></dt> 208 <dd><dl> 209 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.set">(sans.fit.AbstractFitEngine.SansParameter method)</a></dt> 210 </dl></dd> 211 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.set_data">set_data() (sans.fit.AbstractFitEngine.FitData2D method)</a></dt> 212 <dd><dl> 213 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitEngine.set_data">(sans.fit.AbstractFitEngine.FitEngine method)</a></dt> 214 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.ScipyFit.set_data">(sans.fit.ScipyFitting.ScipyFit method)</a></dt> 215 </dl></dd> 216 </dl></td> 217 <td style="width: 33%" valign="top"><dl> 218 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.set_fit_range">set_fit_range() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt> 219 <dd><dl> 220 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.set_fit_range">(sans.fit.AbstractFitEngine.FitData2D method)</a></dt> 221 </dl></dd> 222 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.fitresult.set_fitness">set_fitness() (sans.fit.ScipyFitting.fitresult method)</a></dt> 223 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitArrange.set_model">set_model() (sans.fit.AbstractFitEngine.FitArrange method)</a></dt> 224 <dd><dl> 225 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitEngine.set_model">(sans.fit.AbstractFitEngine.FitEngine method)</a></dt> 226 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.ScipyFit.set_model">(sans.fit.ScipyFitting.ScipyFit method)</a></dt> 227 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.fitresult.set_model">(sans.fit.ScipyFitting.fitresult method)</a></dt> 228 </dl></dd> 229 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.Model.set_params">set_params() (sans.fit.AbstractFitEngine.Model method)</a></dt> 230 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.set_smearer">set_smearer() (sans.fit.AbstractFitEngine.FitData2D method)</a></dt> 231 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitArrange.set_to_fit">set_to_fit() (sans.fit.AbstractFitEngine.FitArrange method)</a></dt> 232 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.setprefix">setprefix() (sans.fit.AbstractFitEngine.SansParameter method)</a></dt> 233 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.summarize">summarize() (sans.fit.AbstractFitEngine.SansParameter method)</a></dt> 234 </dl></td> 235 </tr></table> 236 237 <h2 id="V">V</h2> 238 <table style="width: 100%" class="indextable genindextable"><tr> 239 <td style="width: 33%" valign="top"><dl> 240 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.value">value (sans.fit.AbstractFitEngine.SansParameter attribute)</a></dt> 241 </dl></td> 242 </tr></table> 243 244 <h2 id="X">X</h2> 245 <table style="width: 100%" class="indextable genindextable"><tr> 246 <td style="width: 33%" valign="top"><dl> 247 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.xaxis">xaxis() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt> 248 <dd><dl> 249 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.xaxis">(sans.fit.AbstractFitEngine.FitData2D method)</a></dt> 250 </dl></dd> 251 </dl></td> 252 </tr></table> 253 254 <h2 id="Y">Y</h2> 255 <table style="width: 100%" class="indextable genindextable"><tr> 256 <td style="width: 33%" valign="top"><dl> 257 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.yaxis">yaxis() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt> 258 <dd><dl> 259 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.yaxis">(sans.fit.AbstractFitEngine.FitData2D method)</a></dt> 260 </dl></dd> 261 </dl></td> 262 </tr></table> 263 264 <h2 id="Z">Z</h2> 265 <table style="width: 100%" class="indextable genindextable"><tr> 266 <td style="width: 33%" valign="top"><dl> 267 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.zaxis">zaxis() (sans.fit.AbstractFitEngine.FitData2D method)</a></dt> 268 </dl></td> 269 </tr></table> 270 49 271 50 272 … … 80 302 <a href="#" title="General Index" 81 303 >index</a></li> 304 <li class="right" > 305 <a href="py-modindex.html" title="Python Module Index" 306 >modules</a> |</li> 82 307 <li><a href="index.html">park_integration v0.1.0 documentation</a> »</li> 83 308 </ul> -
park_integration/docs/sphinx/_build/html/index.html
r41517a6 r1679f2f 33 33 <a href="genindex.html" title="General Index" 34 34 accesskey="I">index</a></li> 35 <li class="right" > 36 <a href="py-modindex.html" title="Python Module Index" 37 >modules</a> |</li> 35 38 <li class="right" > 36 39 <a href="api/index.html" title="Reference" … … 115 118 >index</a></li> 116 119 <li class="right" > 120 <a href="py-modindex.html" title="Python Module Index" 121 >modules</a> |</li> 122 <li class="right" > 117 123 <a href="api/index.html" title="Reference" 118 124 >next</a> |</li> -
park_integration/docs/sphinx/_build/html/py-modindex.html
r0c3003d r1679f2f 72 72 <td></td> 73 73 <td> 74 <a href="api/Fitting.html#module-sans.fit.Fitting"><tt class="xref">sans.fit.Fitting</tt></a></td><td>75 <em></em></td></tr>76 <tr class="cg-1">77 <td></td>78 <td> 79 <a href="api/ParkFitting.html#module-sans.fit.ParkFitting"><tt class="xref">sans.fit.ParkFitting</tt></a></td><td>80 <em></em></td></tr>81 <tr class="cg-1">82 <td></td>83 <td> 84 74 <a href="api/ScipyFitting.html#module-sans.fit.ScipyFitting"><tt class="xref">sans.fit.ScipyFitting</tt></a></td><td> 85 75 <em></em></td></tr> -
park_integration/docs/sphinx/_build/html/search.html
r41517a6 r1679f2f 38 38 <a href="genindex.html" title="General Index" 39 39 accesskey="I">index</a></li> 40 <li class="right" > 41 <a href="py-modindex.html" title="Python Module Index" 42 >modules</a> |</li> 40 43 <li><a href="index.html">park_integration v0.1.0 documentation</a> »</li> 41 44 </ul> … … 86 89 <a href="genindex.html" title="General Index" 87 90 >index</a></li> 91 <li class="right" > 92 <a href="py-modindex.html" title="Python Module Index" 93 >modules</a> |</li> 88 94 <li><a href="index.html">park_integration v0.1.0 documentation</a> »</li> 89 95 </ul> -
park_integration/docs/sphinx/_build/html/searchindex.js
r51db68f r1679f2f 1 Search.setIndex({objects:{ },terms:{all:[],all_result:[],set_param:[],eval_deriv:[],prefix:[],follow:[],depend:[],send:[],plottabl:[],queri:[],string:[],fals:[],feasibl:[],retriev:[],list:[],zaxi:[],stderr:[],set_fit_rang:[],upper:[],check_param_rang:[],p_j:[],smearerobject:[],zero:[],setprefix:[],append:[],index:0,what:[],curr_thread:[],is_slit_smear:[],current:[],version:[],method:[],involv:[],full:[],deriv:[],path:[],sinc:[],valu:[],search:0,fitarrang:[],get_model:[],implement:[],"_getvalu":[],param_list:[],modul:0,parkmodel:[],paramat:[],total:[],select:[],ftol:[],from:[],chi:[],remove_data:[],two:[],handler:[],call:[],type:[],fitarrangelist:[],more:[],desir:[],get_nam:[],smearer:[],particular:[],given:[],must:[],none:[],word:[],work:[],uniqu:[],abort:[],can:[],residuals_deriv:[],overrid:[],fitengin:[],indic:0,slit:[],chisq:[],want:[],set_model:[],err_data:[],alwai:[],fitresult:[],end:[],get_to_fit:[],instead:[],fitparam:[],updat:[],clone_without_data:[],sansmodel:[],clone:[],after:[],minimum:[],befor:[],date:3,data:[],pvec:[],sansdata:[],correspond:[],element:[],receiv:[],preced:[],allow:[],enter:[],elif:[],sqrt:[],vari:[],paramet:[],"_getrang":[],fit:[0,1,2,3,4,5],fix:[],add_data:[],wrt:[],onc:[],them:[],scipi:[],"return":[],initi:[],dataload:[],interrupt:[],name:[],simpl:[],data_info:[],each:[],found:[],fitdata1d:[],fitarrangedict:[],weight:[],wrap:[],extract:[],special:[],out:[],datainfo:[],matrix:[],space:[],content:0,print:[],correct:[],iscomput:[],get_problem_to_fit:[],base:[],theori:[],dictionari:[],releas:3,could:[],park_integr:0,print_summari:[],keep:[],length:[],place:[],outsid:[],get_param:[],get_fit_rang:[],first:[],oper:[],rang:[],directli:[],data1d:[],arrai:[],number:[],mai:[],wrapper:[],sansassembl:[],differ:[],width:[],associ:[],messag:[],paramt:[],conveni:[],"final":[],store:[],copi:[],park:[],than:[],serv:[],keyword:[],provid:[],remov:[],tree:[],exampl:[],posit:[],select_problem_for_fit:[],comput:[],san:[3,5,4,1,2],have:[],tabl:0,need:[],engin:[],squar:[],equival:[],inform:[],dictionnari:[],self:[],inv:[],note:[],data_list:[],client:[],which:[],jacobian:[],begin:[],sure:[],parkdata:[],object:[],most:[],"class":[],qy_data:[],fitter:[],doe:[],declar:[],determin:[],axi:[],parameterset:[],gold:[],qmin:[],redirect:[],onli:[],just:[],should:[],set_fit:[],leastsq:[],get:[],express:[],stop:[],paramlist:[],recalcul:[],sans_data2d:[],contain:[],where:[],set:[],"49012e":[],result:[],arg:[],best:[],yaxi:[],infinit:[],statu:[],kei:[],label:[],between:[],"import":[],attribut:[],altern:[],august:3,extend:[],numer:[],set_data:[],both:[],cov:[],region:[],instanc:[],improv:[],uncertainti:[],point:[],within:[],set_result:[],walk:[],residu:[],psotion:[],suppli:[],summar:[],evalu:[],coupl:[],set_to_fit:[],empti:[],interpret:[],valueerror:[],set_engin:[],sansparamet:[],sans_model:[],togeth:[],present:[],"case":[],save:[],servic:[],abstractfitengin:[3,0,2],calcul:[],metric:[],good:[],par:[],welcom:0,perform:[],alphabet:[],make:[],same:[],document:0,optim:[],data2d:[],covari:[],rais:[],user:[],lower:[],center:[],inherit:[],without:[],thi:[],model:[],usual:[],isfeas:[],execut:[],except:[],param:[],add:[],chisqr:[],subsequ:[],xaxi:[],mod:[3,5,4,1,2],insert:[],specif:[],qx_data:[],integ:[],either:[],page:0,underli:[],isfix:[],isfit:[],back:[],flatten:[],chisqr1:[],add_not:[],unit:[],refer:[3,0],set_smear:[],fresidu:[],step:[],out1:[],idx:[],constraint:[],smear:[],qmax:[],scipyfit:[3,0,1],append_empty_process:[],own:[],"float":[],bound:[],automat:[],diagon:[],been:[],returnengin:[],myassembl:[],wai:[],start:[],interfac:[],forward:[],fitabort:[],"function":[],himself:[],form:[],tupl:[],parkfit:[3,0,5],err2:[],err1:[],"true":[],info:[],possibl:[],whether:[],remove_fit_problem:[],maximum:[],limit:[],otherwis:[],problem:[],precalcul:[],fit_paramet:[],uid:[],creat:[],dure:[],exist:[],cov1:[],inf:[],check:[],fill:[],assembl:[],fitdata2d:[],get_data:[],detail:[],other:[],you:[],create_assembl:[],eval:[],isrestrain:[],portion:[],ignor:[],time:[],fit_engin:[]},objtypes:{},titles:["Welcome to park_integration’s documentation!","ScipyFitting","AbstractFitEngine","Reference","Fitting","ParkFitting"],objnames:{},filenames:["index","api/ScipyFitting","api/AbstractFitEngine","api/index","api/Fitting","api/ParkFitting"]})1 Search.setIndex({objects:{"sans.fit":{AbstractFitEngine:[2,0,1],ScipyFitting:[1,0,1]},"sans.fit.AbstractFitEngine":{FitData2D:[2,3,1],SansParameter:[2,3,1],FitArrange:[2,3,1],SansAssembly:[2,3,1],FitEngine:[2,3,1],FitAbort:[2,4,1],Model:[2,3,1],FitData1D:[2,3,1]},"sans.fit.AbstractFitEngine.FitData2D":{clone_without_data:[2,1,1],yaxis:[2,1,1],add_notes:[2,1,1],set_smearer:[2,1,1],zaxis:[2,1,1],residuals:[2,1,1],xaxis:[2,1,1],set_data:[2,1,1],get_fit_range:[2,1,1],append_empty_process:[2,1,1],residuals_deriv:[2,1,1],set_fit_range:[2,1,1]},"sans.fit.AbstractFitEngine.SansParameter":{set:[2,1,1],name:[2,2,1],get:[2,1,1],value:[2,2,1],isfixed:[2,1,1],range:[2,2,1],isrestrained:[2,1,1],get_name:[2,1,1],isfitted:[2,1,1],summarize:[2,1,1],iscomputed:[2,1,1],setprefix:[2,1,1],isfeasible:[2,1,1]},"sans.fit.ScipyFitting.ScipyFit":{fit:[1,1,1],remove_fit_problem:[1,1,1],set_model:[1,1,1],get_problem_to_fit:[1,1,1],get_model:[1,1,1],set_data:[1,1,1],select_problem_for_fit:[1,1,1]},"sans.fit.AbstractFitEngine.Model":{eval_derivs:[2,1,1],set_params:[2,1,1],set:[2,1,1],eval:[2,1,1],get_params:[2,1,1]},"sans.fit.AbstractFitEngine.FitData1D":{clone_without_data:[2,1,1],yaxis:[2,1,1],add_notes:[2,1,1],is_slit_smeared:[2,1,1],residuals:[2,1,1],xaxis:[2,1,1],set_fit_range:[2,1,1],get_fit_range:[2,1,1],append_empty_process:[2,1,1],residuals_deriv:[2,1,1]},"sans.fit.AbstractFitEngine.FitEngine":{remove_fit_problem:[2,1,1],set_model:[2,1,1],get_problem_to_fit:[2,1,1],get_model:[2,1,1],set_data:[2,1,1],select_problem_for_fit:[2,1,1]},"sans.fit.AbstractFitEngine.SansAssembly":{chisq:[2,1,1],check_param_range:[2,1,1]},"sans.fit.ScipyFitting":{ScipyFit:[1,3,1],fitresult:[1,3,1]},"sans.fit.AbstractFitEngine.FitAbort":{message:[2,2,1],args:[2,2,1]},"sans.fit.ScipyFitting.fitresult":{print_summary:[1,1,1],set_fitness:[1,1,1],set_model:[1,1,1]},"sans.fit.AbstractFitEngine.FitArrange":{add_data:[2,1,1],get_data:[2,1,1],remove_data:[2,1,1],get_to_fit:[2,1,1],set_model:[2,1,1],set_to_fit:[2,1,1],get_model:[2,1,1]}},terms:{all:1,all_result:[],set_param:[1,2],eval_deriv:2,zaxi:2,follow:1,depend:[],send:[],plottabl:[1,2],queri:[],string:[1,2],fals:2,feasibl:[],word:[],list:[1,2],prefix:2,stderr:[],set_fit_rang:2,upper:2,work:1,p_j:[],smearerobject:[],zero:[1,2],setprefix:2,append:[],index:0,what:[],curr_thread:[1,2],is_slit_smear:2,current:2,version:2,method:2,"49012e":1,full:2,deriv:2,path:2,sinc:[],valu:[1,2],search:0,fitarrang:[1,2],get_model:[1,2],implement:2,"_getvalu":2,param_list:1,modul:[0,1],parkmodel:[],paramat:2,total:[],unit:2,ftol:1,from:2,chi:2,remove_data:2,two:[],dure:[],handler:[1,2],call:[1,2],type:[1,2],fitarrangelist:[],more:[],desir:2,get_nam:2,smearer:[1,2],particular:[],given:[1,2],must:[1,2],none:[1,2],retriev:[],check_param_rang:2,uniqu:[1,2],abort:[],can:[1,2],residuals_deriv:2,overrid:2,fitengin:[1,2],indic:0,slit:2,chisq:2,want:[1,2],fitresult:[1,2],err_data:2,alwai:1,parameterset:[],end:[],get_to_fit:2,instead:2,simpl:1,updat:[],clone_without_data:2,sansmodel:[],clone:2,after:[],minimum:[],befor:2,mai:[],associ:2,pvec:[],sansdata:[],correspond:[1,2],element:[1,2],receiv:[1,2],preced:1,allow:[1,2],enter:[],elif:[],same:[],vari:2,paramet:[1,2],"_getrang":2,fit:[0,1,2,3,4,5],fix:2,add_data:2,wrt:2,onc:[],them:[],scipi:1,"return":[1,2],initi:2,dataload:2,interrupt:[],name:[1,2],fitparam:2,data_info:2,each:[],found:[],fitdata1d:2,fitarrangedict:1,weight:[],wrap:[],extract:[],special:2,out:2,datainfo:2,matrix:[],space:[],content:0,print:[],correct:2,iscomput:2,get_problem_to_fit:[1,2],base:[1,2],theori:[],dictionari:[1,2],releas:3,could:2,park_integr:0,print_summari:1,set_model:[1,2],length:2,place:[],outsid:2,get_param:2,get_fit_rang:2,first:[],oper:2,rang:2,directli:2,data1d:2,arrai:2,number:[],date:3,wrapper:2,sansassembl:2,differ:[1,2],width:2,data:[1,2],messag:2,paramt:2,conveni:[],"final":[],store:1,copi:2,park:2,than:[],serv:[],keyword:[],provid:2,remov:[1,2],tree:[],posit:[1,2],select_problem_for_fit:[1,2],comput:2,san:[3,5,4,1,2],have:[1,2],tabl:0,need:2,engin:[1,2],squar:2,equival:[],inform:2,dictionnari:1,self:[1,2],note:[1,2],data_list:2,exampl:[1,2],which:2,jacobian:[],begin:[],sure:[],parkdata:[],object:[1,2],most:[],"class":[1,2],qy_data:2,fitter:[],doe:[],declar:[],determin:2,axi:2,gold:2,qmin:[1,2],involv:2,onli:[1,2],execut:[],should:[],set_fit:1,info:2,get:2,express:2,stop:2,paramlist:2,recalcul:[],sans_data2d:2,contain:[1,2],where:[1,2],set:[1,2],result:1,arg:2,best:[],yaxi:2,infinit:[],statu:[],kei:[1,2],redirect:2,label:2,between:2,"import":[],attribut:2,altern:2,august:3,extend:[],numer:[],set_data:[1,2],both:[1,2],cov:[],region:[],instanc:[],improv:[],uncertainti:[],point:[],within:2,set_result:[],walk:[],residu:2,psotion:[],suppli:[],summar:2,creat:[1,2],coupl:[1,2],add:[1,2],empti:2,interpret:2,valueerror:2,set_engin:[],sansparamet:2,sans_model:2,togeth:1,present:2,"case":[1,2],save:[1,2],servic:2,abstractfitengin:[3,0,1,2],calcul:2,metric:[],good:[],par:[1,2],welcom:0,perform:1,alphabet:[],make:[],sqrt:[],document:0,optim:[1,2],data2d:2,covari:[],rais:2,user:[],keep:[],lower:2,center:2,inherit:2,without:2,client:[],thi:[1,2],model:[1,2],usual:[],isfeas:2,just:2,except:2,param:[1,2],set_to_fit:2,chisqr:1,subsequ:2,xaxi:2,mod:[3,5,4,1,2],insert:[],specif:[],qx_data:2,integ:2,either:[],page:0,underli:2,isfix:2,isfit:2,back:[],flatten:[],chisqr1:1,add_not:2,select:[1,2],refer:[3,0],set_smear:2,fresidu:[],step:[],out1:1,idx:[],constraint:[1,2],smear:2,qmax:[1,2],scipyfit:[3,0,1],append_empty_process:2,own:2,"float":[],bound:2,automat:1,diagon:[],been:2,returnengin:[],myassembl:[],wai:2,start:[],interfac:[],forward:[],fitabort:2,"function":2,himself:[],form:[],tupl:[1,2],parkfit:[3,0,5],err2:1,err1:1,"true":2,leastsq:2,possibl:[],whether:2,remove_fit_problem:[1,2],maximum:[],limit:2,otherwis:2,problem:[1,2],precalcul:[],fit_paramet:[],uid:1,evalu:2,inv:[],exist:[1,2],cov1:1,inf:2,check:2,fill:2,assembl:2,fitdata2d:2,get_data:2,detail:[],other:2,you:[],create_assembl:[],eval:2,isrestrain:2,portion:[],ignor:[],time:[],fit_engin:[]},objtypes:{"0":"py:module","1":"py:method","2":"py:attribute","3":"py:class","4":"py:exception"},titles:["Welcome to park_integration’s documentation!","ScipyFitting","AbstractFitEngine","Reference","Fitting","ParkFitting"],objnames:{"0":"Python module","1":"Python method","2":"Python attribute","3":"Python class","4":"Python exception"},filenames:["index","api/ScipyFitting","api/AbstractFitEngine","api/index","api/Fitting","api/ParkFitting"]})
Note: See TracChangeset
for help on using the changeset viewer.