Changeset 41517a6 in sasview for park_integration/docs
- Timestamp:
- Aug 9, 2011 1:24:54 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:
- 032d585
- Parents:
- 6992dfd
- Location:
- park_integration/docs/sphinx
- Files:
-
- 17 edited
Legend:
- Unmodified
- Added
- Removed
-
park_integration/docs/sphinx/_build/html/api/AbstractFitEngine.html
r0c3003d r41517a6 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" >41 38 <a href="Fitting.html" title="Fitting" 42 39 accesskey="N">next</a> |</li> … … 56 53 <div class="section" id="abstractfitengine"> 57 54 <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> 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">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">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 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> 691 57 </div> 692 58 </div> … … 701 67 <ul> 702 68 <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>69 <li><a class="reference internal" href="#mod-sans-fit-abstractfitengine">:mod:` sans.fit.AbstractFitEngine`</a></li> 704 70 </ul> 705 71 </li> … … 741 107 >index</a></li> 742 108 <li class="right" > 743 <a href="../py-modindex.html" title="Python Module Index"744 >modules</a> |</li>745 <li class="right" >746 109 <a href="Fitting.html" title="Fitting" 747 110 >next</a> |</li> -
park_integration/docs/sphinx/_build/html/api/Fitting.html
r0c3003d r41517a6 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" >41 38 <a href="ParkFitting.html" title="ParkFitting" 42 39 accesskey="N">next</a> |</li> … … 56 53 <div class="section" id="fitting"> 57 54 <h1>Fitting<a class="headerlink" href="#fitting" title="Permalink to this headline">¶</a></h1> 58 <div class="section" id="module-sans.fit.Fitting"> 59 <span id="mod-sans-fit-fitting"></span><h2>:mod:` sans.fit.Fitting`<a class="headerlink" href="#module-sans.fit.Fitting" title="Permalink to this headline">¶</a></h2> 60 <p>Class Fit contains ScipyFit and ParkFit methods declaration 61 allows to create instance of type ScipyFit or ParkFit to perform either 62 a park fit or a scipy fit.</p> 63 <dl class="class"> 64 <dt id="sans.fit.Fitting.Fit"> 65 <em class="property">class </em><tt class="descclassname">sans.fit.Fitting.</tt><tt class="descname">Fit</tt><big>(</big><em>engine='scipy'</em><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit" title="Permalink to this definition">¶</a></dt> 66 <dd><p>Wrap class that allows to select the fitting type.this class 67 can be used as follow :</p> 68 <div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">sans.fit.Fitting</span> <span class="kn">import</span> <span class="n">Fit</span> 69 <span class="n">fitter</span><span class="o">=</span> <span class="n">Fit</span><span class="p">()</span> 70 <span class="n">fitter</span><span class="o">.</span><span class="n">fit_engine</span><span class="p">(</span><span class="s">'scipy'</span><span class="p">)</span> <span class="ow">or</span> <span class="n">fitter</span><span class="o">.</span><span class="n">fit_engine</span><span class="p">(</span><span class="s">'park'</span><span class="p">)</span> 71 <span class="n">engine</span> <span class="o">=</span> <span class="n">fitter</span><span class="o">.</span><span class="n">returnEngine</span><span class="p">()</span> 72 <span class="n">engine</span><span class="o">.</span><span class="n">set_data</span><span class="p">(</span><span class="n">data</span><span class="p">,</span><span class="nb">id</span><span class="p">)</span> 73 <span class="n">engine</span><span class="o">.</span><span class="n">set_param</span><span class="p">(</span> <span class="n">model</span><span class="p">,</span><span class="n">model</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">pars</span><span class="p">)</span> 74 <span class="n">engine</span><span class="o">.</span><span class="n">set_model</span><span class="p">(</span><span class="n">model</span><span class="p">,</span><span class="nb">id</span><span class="p">)</span> 75 76 <span class="n">chisqr1</span><span class="p">,</span> <span class="n">out1</span><span class="p">,</span> <span class="n">cov1</span><span class="o">=</span><span class="n">engine</span><span class="o">.</span><span class="n">fit</span><span class="p">(</span><span class="n">pars</span><span class="p">,</span><span class="n">qmin</span><span class="p">,</span><span class="n">qmax</span><span class="p">)</span> 77 </pre></div> 78 </div> 79 <dl class="method"> 80 <dt id="sans.fit.Fitting.Fit.fit"> 81 <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.Fitting.Fit.fit" title="Permalink to this definition">¶</a></dt> 82 <dd><p>Perform the fit</p> 83 </dd></dl> 84 85 <dl class="method"> 86 <dt id="sans.fit.Fitting.Fit.get_model"> 87 <tt class="descname">get_model</tt><big>(</big><em>id</em><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.get_model" title="Permalink to this definition">¶</a></dt> 88 <dd><p>return list of data</p> 89 </dd></dl> 90 91 <dl class="method"> 92 <dt id="sans.fit.Fitting.Fit.get_problem_to_fit"> 93 <tt class="descname">get_problem_to_fit</tt><big>(</big><em>id</em><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.get_problem_to_fit" title="Permalink to this definition">¶</a></dt> 94 <dd><p>return the self.selected value of the fit problem of id</p> 95 <table class="docutils field-list" frame="void" rules="none"> 96 <col class="field-name" /> 97 <col class="field-body" /> 98 <tbody valign="top"> 99 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – the id of the problem</td> 100 </tr> 101 </tbody> 102 </table> 103 </dd></dl> 104 105 <dl class="method"> 106 <dt id="sans.fit.Fitting.Fit.remove_fit_problem"> 107 <tt class="descname">remove_fit_problem</tt><big>(</big><em>id</em><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.remove_fit_problem" title="Permalink to this definition">¶</a></dt> 108 <dd><p>remove fitarrange in id</p> 109 </dd></dl> 110 111 <dl class="method"> 112 <dt id="sans.fit.Fitting.Fit.select_problem_for_fit"> 113 <tt class="descname">select_problem_for_fit</tt><big>(</big><em>id</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.select_problem_for_fit" title="Permalink to this definition">¶</a></dt> 114 <dd><p>select a couple of model and data at the id position in dictionary 115 and set in self.selected value to value</p> 116 <table class="docutils field-list" frame="void" rules="none"> 117 <col class="field-name" /> 118 <col class="field-body" /> 119 <tbody valign="top"> 120 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> – the value to allow fitting. 121 can only have the value one or zero</td> 122 </tr> 123 </tbody> 124 </table> 125 </dd></dl> 126 127 <dl class="method"> 128 <dt id="sans.fit.Fitting.Fit.set_data"> 129 <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.Fitting.Fit.set_data" title="Permalink to this definition">¶</a></dt> 130 <dd><p>Store data to fit at the psotion id of the fit engine</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"><ul class="first last simple"> 136 <li><strong>data</strong> – data to fit</li> 137 <li><strong>smearer</strong> – smearerobject to smear data</li> 138 <li><strong>qmin</strong> – the minimum q range to fit</li> 139 <li><strong>qmax</strong> – the minimum q range to fit</li> 140 </ul> 141 </td> 142 </tr> 143 </tbody> 144 </table> 145 </dd></dl> 146 147 <dl class="method"> 148 <dt id="sans.fit.Fitting.Fit.set_engine"> 149 <tt class="descname">set_engine</tt><big>(</big><em>word</em><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.set_engine" title="Permalink to this definition">¶</a></dt> 150 <dd><p>Select the type of Fit</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"><strong>word</strong> – the keyword to select the fit type</td> 156 </tr> 157 <tr class="field"><th class="field-name">Raise :</th><td class="field-body">if the user does not enter ‘scipy’ or ‘park’, 158 a valueError is raised</td> 159 </tr> 160 </tbody> 161 </table> 162 </dd></dl> 163 164 <dl class="method"> 165 <dt id="sans.fit.Fitting.Fit.set_model"> 166 <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.Fitting.Fit.set_model" title="Permalink to this definition">¶</a></dt> 167 <dd><p>store a model model to fit at the position id of the fit engine</p> 168 </dd></dl> 169 170 </dd></dl> 171 55 <div class="section" id="mod-sans-fit-fitting"> 56 <h2>:mod:` sans.fit.Fitting`<a class="headerlink" href="#mod-sans-fit-fitting" title="Permalink to this headline">¶</a></h2> 172 57 </div> 173 58 </div> … … 182 67 <ul> 183 68 <li><a class="reference internal" href="#">Fitting</a><ul> 184 <li><a class="reference internal" href="#mod ule-sans.fit.Fitting">:mod:` sans.fit.Fitting`</a></li>69 <li><a class="reference internal" href="#mod-sans-fit-fitting">:mod:` sans.fit.Fitting`</a></li> 185 70 </ul> 186 71 </li> … … 222 107 >index</a></li> 223 108 <li class="right" > 224 <a href="../py-modindex.html" title="Python Module Index"225 >modules</a> |</li>226 <li class="right" >227 109 <a href="ParkFitting.html" title="ParkFitting" 228 110 >next</a> |</li> -
park_integration/docs/sphinx/_build/html/api/ParkFitting.html
r0c3003d r41517a6 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" >41 38 <a href="ScipyFitting.html" title="ScipyFitting" 42 39 accesskey="N">next</a> |</li> … … 56 53 <div class="section" id="parkfitting"> 57 54 <h1>ParkFitting<a class="headerlink" href="#parkfitting" title="Permalink to this headline">¶</a></h1> 58 <div class="section" id="module-sans.fit.ParkFitting"> 59 <span id="mod-sans-fit-parkfitting"></span><h2>:mod:` sans.fit.ParkFitting`<a class="headerlink" href="#module-sans.fit.ParkFitting" title="Permalink to this headline">¶</a></h2> 60 <p>ParkFitting module contains SansParameter,Model,Data 61 FitArrange, ParkFit,Parameter classes.All listed classes work together 62 to perform a simple fit with park optimizer.</p> 63 <dl class="class"> 64 <dt id="sans.fit.ParkFitting.MyAssembly"> 65 <em class="property">class </em><tt class="descclassname">sans.fit.ParkFitting.</tt><tt class="descname">MyAssembly</tt><big>(</big><em>models</em>, <em>curr_thread=None</em><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly" title="Permalink to this definition">¶</a></dt> 66 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">park.assembly.Assembly</span></tt></p> 67 <dl class="method"> 68 <dt id="sans.fit.ParkFitting.MyAssembly.abort"> 69 <tt class="descname">abort</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.abort" title="Permalink to this definition">¶</a></dt> 70 <dd><p>Interrupt the current function evaluation.</p> 71 <p>Forward this to the currently executing model if possible.</p> 72 </dd></dl> 73 74 <dl class="method"> 75 <dt id="sans.fit.ParkFitting.MyAssembly.all_results"> 76 <tt class="descname">all_results</tt><big>(</big><em>result</em><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.all_results" title="Permalink to this definition">¶</a></dt> 77 <dd><p>Extend result from the fit with the calculated parameters.</p> 78 </dd></dl> 79 80 <dl class="method"> 81 <dt id="sans.fit.ParkFitting.MyAssembly.append"> 82 <tt class="descname">append</tt><big>(</big><em>fitness</em>, <em>weight=1.0</em>, <em>isfitted=True</em><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.append" title="Permalink to this definition">¶</a></dt> 83 <dd><p>Add a model to the end of set.</p> 84 <table class="docutils field-list" frame="void" rules="none"> 85 <col class="field-name" /> 86 <col class="field-body" /> 87 <tbody valign="top"> 88 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>fitness</strong> – the fitting model</td> 89 </tr> 90 </tbody> 91 </table> 92 <p>The fitting model can be an instance of <cite>park.assembly.Fitness</cite>, 93 or a tuple of (<cite>park.model.Model</cite>,`park.data.Data1D`) 94 :param weight: model weighting (usually 1.0) 95 :param isfitted: whether model should be fit (equivalent to weight 0.)</p> 96 </dd></dl> 97 98 <dl class="method"> 99 <dt id="sans.fit.ParkFitting.MyAssembly.cov"> 100 <tt class="descname">cov</tt><big>(</big><em>pvec</em><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.cov" title="Permalink to this definition">¶</a></dt> 101 <dd><p>Return the covariance matrix inv(J’J) at point p.</p> 102 </dd></dl> 103 104 <dl class="method"> 105 <dt id="sans.fit.ParkFitting.MyAssembly.eval"> 106 <tt class="descname">eval</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.eval" title="Permalink to this definition">¶</a></dt> 107 <dd><p>Recalculate the theory functions, and from them, the 108 residuals and chisq.</p> 109 <table class="docutils field-list" frame="void" rules="none"> 110 <col class="field-name" /> 111 <col class="field-body" /> 112 <tbody valign="top"> 113 <tr class="field"><th class="field-name">Note :</th><td class="field-body">Call this after the parameters have been updated.</td> 114 </tr> 115 </tbody> 116 </table> 117 </dd></dl> 118 119 <dl class="method"> 120 <dt id="sans.fit.ParkFitting.MyAssembly.fit_parameters"> 121 <tt class="descname">fit_parameters</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.fit_parameters" title="Permalink to this definition">¶</a></dt> 122 <dd><p>Return an alphabetical list of the fitting parameters.</p> 123 <p>This function is called once at the beginning of a fit, 124 and serves as a convenient place to precalculate what 125 can be precalculated such as the set of fitting parameters 126 and the parameter expressions evaluator.</p> 127 </dd></dl> 128 129 <dl class="method"> 130 <dt id="sans.fit.ParkFitting.MyAssembly.fresiduals"> 131 <tt class="descname">fresiduals</tt><big>(</big><em>pvec</em><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.fresiduals" title="Permalink to this definition">¶</a></dt> 132 <dd></dd></dl> 133 134 <dl class="method"> 135 <dt id="sans.fit.ParkFitting.MyAssembly.insert"> 136 <tt class="descname">insert</tt><big>(</big><em>idx</em>, <em>fitness</em>, <em>weight=1.0</em>, <em>isfitted=True</em><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.insert" title="Permalink to this definition">¶</a></dt> 137 <dd><p>Add a model to a particular position in the set.</p> 138 </dd></dl> 139 140 <dl class="method"> 141 <dt id="sans.fit.ParkFitting.MyAssembly.isfeasible"> 142 <tt class="descname">isfeasible</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.isfeasible" title="Permalink to this definition">¶</a></dt> 143 <dd><p>Returns true if the parameter set is in a feasible region of the 144 modeling space.</p> 145 </dd></dl> 146 147 <dl class="method"> 148 <dt id="sans.fit.ParkFitting.MyAssembly.isfitted"> 149 <tt class="descname">isfitted</tt><big>(</big><em>idx</em>, <em>value=None</em><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.isfitted" title="Permalink to this definition">¶</a></dt> 150 <dd><p>Query if a particular model is fitted.</p> 151 <p>Set isfitted to value if value is supplied.</p> 152 <table class="docutils field-list" frame="void" rules="none"> 153 <col class="field-name" /> 154 <col class="field-body" /> 155 <tbody valign="top"> 156 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 157 <li><strong>idx</strong> (<em>integer</em>) – model number</li> 158 <li><strong>value</strong> – </li> 159 </ul> 160 </td> 161 </tr> 162 </tbody> 163 </table> 164 </dd></dl> 165 166 <dl class="method"> 167 <dt id="sans.fit.ParkFitting.MyAssembly.jacobian"> 168 <tt class="descname">jacobian</tt><big>(</big><em>pvec</em>, <em>step=1e-008</em><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.jacobian" title="Permalink to this definition">¶</a></dt> 169 <dd><p>Returns the derivative wrt the fit parameters at point p.</p> 170 <p>Numeric derivatives are calculated based on step, where step is 171 the portion of the total range for parameter j, or the portion of 172 point value p_j if the range on parameter j is infinite.</p> 173 </dd></dl> 174 175 <dl class="method"> 176 <dt id="sans.fit.ParkFitting.MyAssembly.result"> 177 <tt class="descname">result</tt><big>(</big><em>status='step'</em><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.result" title="Permalink to this definition">¶</a></dt> 178 <dd><p>Details to send back to the fitting client on an improved fit.</p> 179 <p>status is ‘start’, ‘step’ or ‘end’ depending if this is the 180 first result to return, an improved result, or the final result.</p> 181 <p>[Not implemented]</p> 182 </dd></dl> 183 184 <dl class="method"> 185 <dt id="sans.fit.ParkFitting.MyAssembly.set_result"> 186 <tt class="descname">set_result</tt><big>(</big><em>result</em><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.set_result" title="Permalink to this definition">¶</a></dt> 187 <dd><p>Set the parameters resulting from the fit into the parameter set, 188 and update the calculated expression.</p> 189 <p>The parameter values may be retrieved by walking the assembly.parameterset 190 tree, checking each parameter for isfitted, iscomputed, or isfixed. 191 For example:</p> 192 <div class="highlight-python"><div class="highlight"><pre><span class="n">assembly</span><span class="o">.</span><span class="n">set_result</span><span class="p">(</span><span class="n">result</span><span class="p">)</span> 193 <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">assembly</span><span class="o">.</span><span class="n">parameterset</span><span class="o">.</span><span class="n">flatten</span><span class="p">():</span> 194 <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">isfitted</span><span class="p">():</span> 195 <span class="k">print</span> <span class="s">"</span><span class="si">%s</span><span class="s"> </span><span class="si">%g</span><span class="s"> in [</span><span class="si">%g</span><span class="s">,</span><span class="si">%g</span><span class="s">]"</span><span class="o">%</span><span class="p">(</span><span class="n">p</span><span class="o">.</span><span class="n">path</span><span class="p">,</span><span class="n">p</span><span class="o">.</span><span class="n">value</span><span class="p">,</span><span class="n">p</span><span class="o">.</span><span class="n">range</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span><span class="n">p</span><span class="o">.</span><span class="n">range</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> 196 <span class="k">elif</span> <span class="n">p</span><span class="o">.</span><span class="n">iscomputed</span><span class="p">():</span> 197 <span class="k">print</span> <span class="s">"</span><span class="si">%s</span><span class="s"> computed as </span><span class="si">%g</span><span class="s">"</span><span class="o">%</span><span class="p">(</span><span class="n">p</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">p</span><span class="o">.</span><span class="n">value</span><span class="p">)</span> 198 </pre></div> 199 </div> 200 <p>This does not calculate the function or the residuals for these parameters. 201 You can call assembly.eval() to do this. The residuals will be set in 202 assembly[i].residuals. The theory and data are model specific, and can 203 be found in assembly[i].fitness.data.</p> 204 </dd></dl> 205 206 <dl class="method"> 207 <dt id="sans.fit.ParkFitting.MyAssembly.stderr"> 208 <tt class="descname">stderr</tt><big>(</big><em>pvec</em><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.stderr" title="Permalink to this definition">¶</a></dt> 209 <dd><p>Return parameter uncertainty.</p> 210 <p>This is just the sqrt diagonal of covariance matrix inv(J’J) at point p.</p> 211 </dd></dl> 212 213 <dl class="method"> 214 <dt id="sans.fit.ParkFitting.MyAssembly.weight"> 215 <tt class="descname">weight</tt><big>(</big><em>idx</em>, <em>value=None</em><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.weight" title="Permalink to this definition">¶</a></dt> 216 <dd><p>Query the weight on a particular model.</p> 217 <p>Set weight to value if value is supplied.</p> 218 <table class="docutils field-list" frame="void" rules="none"> 219 <col class="field-name" /> 220 <col class="field-body" /> 221 <tbody valign="top"> 222 <tr class="field"><th class="field-name">Parameters :</th><td class="field-body"><dl class="first docutils"> 223 <dt>idx <span class="classifier-delimiter">:</span> <span class="classifier">integer</span></dt> 224 <dd><p class="first last">model number</p> 225 </dd> 226 <dt>value <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt> 227 <dd><p class="first last">model weight</p> 228 </dd> 229 </dl> 230 </td> 231 </tr> 232 <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">model weight</p> 233 </td> 234 </tr> 235 </tbody> 236 </table> 237 </dd></dl> 238 239 </dd></dl> 240 241 <dl class="class"> 242 <dt id="sans.fit.ParkFitting.ParkFit"> 243 <em class="property">class </em><tt class="descclassname">sans.fit.ParkFitting.</tt><tt class="descname">ParkFit</tt><a class="headerlink" href="#sans.fit.ParkFitting.ParkFit" title="Permalink to this definition">¶</a></dt> 244 <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> 245 <p>ParkFit performs the Fit.This class can be used as follow: 246 #Do the fit Park 247 create an engine: engine = ParkFit() 248 Use data must be of type plottable 249 Use a sans model</p> 250 <p>Add data with a dictionnary of FitArrangeList where Uid is a key and data 251 is saved in FitArrange object. 252 engine.set_data(data,Uid)</p> 253 <p>Set model parameter “M1”= model.name add {model.parameter.name:value}.</p> 254 <table class="docutils field-list" frame="void" rules="none"> 255 <col class="field-name" /> 256 <col class="field-body" /> 257 <tbody valign="top"> 258 <tr class="field"><th class="field-name">Note :</th><td class="field-body">Set_param() if used must always preceded set_model() 259 for the fit to be performed.</td> 260 </tr> 261 </tbody> 262 </table> 263 <p>engine.set_param( model,”M1”, {‘A’:2,’B’:4})</p> 264 <p>Add model with a dictionnary of FitArrangeList{} where Uid is a key 265 and model 266 is save in FitArrange object. 267 engine.set_model(model,Uid)</p> 268 <p>engine.fit return chisqr,[model.parameter 1,2,..],[[err1....][..err2...]] 269 chisqr1, out1, cov1=engine.fit({model.parameter.name:value},qmin,qmax)</p> 270 <table class="docutils field-list" frame="void" rules="none"> 271 <col class="field-name" /> 272 <col class="field-body" /> 273 <tbody valign="top"> 274 <tr class="field"><th class="field-name">Note :</th><td class="field-body">{model.parameter.name:value} is ignored in fit function since 275 the user should make sure to call set_param himself.</td> 276 </tr> 277 </tbody> 278 </table> 279 <dl class="method"> 280 <dt id="sans.fit.ParkFitting.ParkFit.create_assembly"> 281 <tt class="descname">create_assembly</tt><big>(</big><em>curr_thread</em><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.ParkFit.create_assembly" title="Permalink to this definition">¶</a></dt> 282 <dd><p>Extract sansmodel and sansdata from 283 self.FitArrangelist ={Uid:FitArrange} 284 Create parkmodel and park data ,form a list couple of parkmodel 285 and parkdata 286 create an assembly self.problem= park.Assembly([(parkmodel,parkdata)])</p> 287 </dd></dl> 288 289 <dl class="method"> 290 <dt id="sans.fit.ParkFitting.ParkFit.fit"> 291 <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.ParkFitting.ParkFit.fit" title="Permalink to this definition">¶</a></dt> 292 <dd><p>Performs fit with park.fit module.It can perform fit with one model 293 and a set of data, more than two fit of one model and sets of data or 294 fit with more than two model associated with their set of data and 295 constraints</p> 296 <table class="docutils field-list" frame="void" rules="none"> 297 <col class="field-name" /> 298 <col class="field-body" /> 299 <tbody valign="top"> 300 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 301 <li><strong>pars</strong> – Dictionary of parameter names for the model and their 302 values.</li> 303 <li><strong>qmin</strong> – The minimum value of data’s range to be fit</li> 304 <li><strong>qmax</strong> – The maximum value of data’s range to be fit</li> 305 </ul> 306 </td> 307 </tr> 308 <tr class="field"><th class="field-name">Note :</th><td class="field-body"><p class="first">all parameter are ignored most of the time.Are just there 309 to keep ScipyFit and ParkFit interface the same.</p> 310 </td> 311 </tr> 312 <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">result.fitness Value of the goodness of fit metric</p> 313 </td> 314 </tr> 315 <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">result.pvec list of parameter with the best value 316 found during fitting</p> 317 </td> 318 </tr> 319 <tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">result.cov Covariance matrix</p> 320 </td> 321 </tr> 322 </tbody> 323 </table> 324 </dd></dl> 325 326 <dl class="method"> 327 <dt id="sans.fit.ParkFitting.ParkFit.get_model"> 328 <tt class="descname">get_model</tt><big>(</big><em>id</em><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.ParkFit.get_model" title="Permalink to this definition">¶</a></dt> 329 <dd><table class="docutils field-list" frame="void" rules="none"> 330 <col class="field-name" /> 331 <col class="field-body" /> 332 <tbody valign="top"> 333 <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> 334 </tr> 335 <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 336 created with this id</td> 337 </tr> 338 </tbody> 339 </table> 340 </dd></dl> 341 342 <dl class="method"> 343 <dt id="sans.fit.ParkFitting.ParkFit.get_problem_to_fit"> 344 <tt class="descname">get_problem_to_fit</tt><big>(</big><em>id</em><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.ParkFit.get_problem_to_fit" title="Permalink to this definition">¶</a></dt> 345 <dd><p>return the self.selected value of the fit problem of id</p> 346 <table class="docutils field-list" frame="void" rules="none"> 347 <col class="field-name" /> 348 <col class="field-body" /> 349 <tbody valign="top"> 350 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> – the id of the problem</td> 351 </tr> 352 </tbody> 353 </table> 354 </dd></dl> 355 356 <dl class="method"> 357 <dt id="sans.fit.ParkFitting.ParkFit.remove_fit_problem"> 358 <tt class="descname">remove_fit_problem</tt><big>(</big><em>id</em><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.ParkFit.remove_fit_problem" title="Permalink to this definition">¶</a></dt> 359 <dd><p>remove fitarrange in id</p> 360 </dd></dl> 361 362 <dl class="method"> 363 <dt id="sans.fit.ParkFitting.ParkFit.select_problem_for_fit"> 364 <tt class="descname">select_problem_for_fit</tt><big>(</big><em>id</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.ParkFit.select_problem_for_fit" title="Permalink to this definition">¶</a></dt> 365 <dd><p>select a couple of model and data at the id position in dictionary 366 and set in self.selected value to value</p> 367 <table class="docutils field-list" frame="void" rules="none"> 368 <col class="field-name" /> 369 <col class="field-body" /> 370 <tbody valign="top"> 371 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> – the value to allow fitting. 372 can only have the value one or zero</td> 373 </tr> 374 </tbody> 375 </table> 376 </dd></dl> 377 378 <dl class="method"> 379 <dt id="sans.fit.ParkFitting.ParkFit.set_data"> 380 <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.ParkFitting.ParkFit.set_data" title="Permalink to this definition">¶</a></dt> 381 <dd><p>Receives plottable, creates a list of data to fit,set data 382 in a FitArrange object and adds that object in a dictionary 383 with key id.</p> 384 <table class="docutils field-list" frame="void" rules="none"> 385 <col class="field-name" /> 386 <col class="field-body" /> 387 <tbody valign="top"> 388 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 389 <li><strong>data</strong> – data added</li> 390 <li><strong>id</strong> – unique key corresponding to a fitArrange object with data</li> 391 </ul> 392 </td> 393 </tr> 394 </tbody> 395 </table> 396 </dd></dl> 397 398 <dl class="method"> 399 <dt id="sans.fit.ParkFitting.ParkFit.set_model"> 400 <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.ParkFitting.ParkFit.set_model" title="Permalink to this definition">¶</a></dt> 401 <dd><p>set a model on a given in the fit engine.</p> 402 <table class="docutils field-list" frame="void" rules="none"> 403 <col class="field-name" /> 404 <col class="field-body" /> 405 <tbody valign="top"> 406 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> – sans.models type</td> 407 </tr> 408 </tbody> 409 </table> 410 <dl class="docutils"> 411 <dt>:param <span class="classifier-delimiter">:</span> <span class="classifier">is the key of the fitArrange dictionary where model is </span></dt> 412 <dd>saved as a value</dd> 413 </dl> 414 <table class="docutils field-list" frame="void" rules="none"> 415 <col class="field-name" /> 416 <col class="field-body" /> 417 <tbody valign="top"> 418 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 419 <li><strong>pars</strong> – the list of parameters to fit</li> 420 <li><strong>constraints</strong> – <p>list of 421 tuple (name of parameter, value of parameters) 422 the value of parameter must be a string to constraint 2 different 423 parameters. 424 Example: 425 we want to fit 2 model M1 and M2 both have parameters A and B. 426 constraints can be:</p> 427 <blockquote> 428 <div>constraints = [(M1.A, M2.B+2), (M1.B= M2.A <a href="#id1"><span class="problematic" id="id2">*</span></a>5),...,]</div></blockquote> 429 </li> 430 </ul> 431 </td> 432 </tr> 433 <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> 434 </td> 435 </tr> 436 </tbody> 437 </table> 438 </dd></dl> 439 440 </dd></dl> 441 55 <div class="section" id="mod-sans-fit-parkfitting"> 56 <h2>:mod:` sans.fit.ParkFitting`<a class="headerlink" href="#mod-sans-fit-parkfitting" title="Permalink to this headline">¶</a></h2> 442 57 </div> 443 58 </div> … … 452 67 <ul> 453 68 <li><a class="reference internal" href="#">ParkFitting</a><ul> 454 <li><a class="reference internal" href="#mod ule-sans.fit.ParkFitting">:mod:` sans.fit.ParkFitting`</a></li>69 <li><a class="reference internal" href="#mod-sans-fit-parkfitting">:mod:` sans.fit.ParkFitting`</a></li> 455 70 </ul> 456 71 </li> … … 492 107 >index</a></li> 493 108 <li class="right" > 494 <a href="../py-modindex.html" title="Python Module Index"495 >modules</a> |</li>496 <li class="right" >497 109 <a href="ScipyFitting.html" title="ScipyFitting" 498 110 >next</a> |</li> -
park_integration/docs/sphinx/_build/html/api/ScipyFitting.html
r0c3003d r41517a6 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" >40 37 <a href="ParkFitting.html" title="ParkFitting" 41 38 accesskey="P">previous</a> |</li> … … 52 49 <div class="section" id="scipyfitting"> 53 50 <h1>ScipyFitting<a class="headerlink" href="#scipyfitting" title="Permalink to this headline">¶</a></h1> 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 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> 231 53 </div> 232 54 </div> … … 241 63 <ul> 242 64 <li><a class="reference internal" href="#">ScipyFitting</a><ul> 243 <li><a class="reference internal" href="#mod ule-sans.fit.ScipyFitting">:mod:` sans.fit.ScipyFitting`</a></li>65 <li><a class="reference internal" href="#mod-sans-fit-scipyfitting">:mod:` sans.fit.ScipyFitting`</a></li> 244 66 </ul> 245 67 </li> … … 278 100 >index</a></li> 279 101 <li class="right" > 280 <a href="../py-modindex.html" title="Python Module Index"281 >modules</a> |</li>282 <li class="right" >283 102 <a href="ParkFitting.html" title="ParkFitting" 284 103 >previous</a> |</li> -
park_integration/docs/sphinx/_build/html/api/index.html
r0c3003d r41517a6 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" >40 37 <a href="AbstractFitEngine.html" title="AbstractFitEngine" 41 38 accesskey="N">next</a> |</li> … … 60 57 <tr class="field"><th class="field-name">Release:</th><td class="field-body">0.1</td> 61 58 </tr> 62 <tr class="field"><th class="field-name">Date:</th><td class="field-body">August 0 8, 2011</td>59 <tr class="field"><th class="field-name">Date:</th><td class="field-body">August 09, 2011</td> 63 60 </tr> 64 61 </tbody> … … 67 64 <ul> 68 65 <li class="toctree-l1"><a class="reference internal" href="AbstractFitEngine.html">AbstractFitEngine</a><ul> 69 <li class="toctree-l2"><a class="reference internal" href="AbstractFitEngine.html#mod ule-sans.fit.AbstractFitEngine">:mod:` sans.fit.AbstractFitEngine`</a></li>66 <li class="toctree-l2"><a class="reference internal" href="AbstractFitEngine.html#mod-sans-fit-abstractfitengine">:mod:` sans.fit.AbstractFitEngine`</a></li> 70 67 </ul> 71 68 </li> 72 69 <li class="toctree-l1"><a class="reference internal" href="Fitting.html">Fitting</a><ul> 73 <li class="toctree-l2"><a class="reference internal" href="Fitting.html#mod ule-sans.fit.Fitting">:mod:` sans.fit.Fitting`</a></li>70 <li class="toctree-l2"><a class="reference internal" href="Fitting.html#mod-sans-fit-fitting">:mod:` sans.fit.Fitting`</a></li> 74 71 </ul> 75 72 </li> 76 73 <li class="toctree-l1"><a class="reference internal" href="ParkFitting.html">ParkFitting</a><ul> 77 <li class="toctree-l2"><a class="reference internal" href="ParkFitting.html#mod ule-sans.fit.ParkFitting">:mod:` sans.fit.ParkFitting`</a></li>74 <li class="toctree-l2"><a class="reference internal" href="ParkFitting.html#mod-sans-fit-parkfitting">:mod:` sans.fit.ParkFitting`</a></li> 78 75 </ul> 79 76 </li> 80 77 <li class="toctree-l1"><a class="reference internal" href="ScipyFitting.html">ScipyFitting</a><ul> 81 <li class="toctree-l2"><a class="reference internal" href="ScipyFitting.html#mod ule-sans.fit.ScipyFitting">:mod:` sans.fit.ScipyFitting`</a></li>78 <li class="toctree-l2"><a class="reference internal" href="ScipyFitting.html#mod-sans-fit-scipyfitting">:mod:` sans.fit.ScipyFitting`</a></li> 82 79 </ul> 83 80 </li> … … 127 124 >index</a></li> 128 125 <li class="right" > 129 <a href="../py-modindex.html" title="Python Module Index"130 >modules</a> |</li>131 <li class="right" >132 126 <a href="AbstractFitEngine.html" title="AbstractFitEngine" 133 127 >next</a> |</li> -
park_integration/docs/sphinx/_build/html/genindex.html
r0c3003d r41517a6 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>37 34 <li><a href="index.html">park_integration v0.1.0 documentation</a> »</li> 38 35 </ul> … … 48 45 49 46 <div class="genindex-jumpbox"> 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="#J"><strong>J</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="#W"><strong>W</strong></a> | <a href="#X"><strong>X</strong></a> | <a href="#Y"><strong>Y</strong></a> | <a href="#Z"><strong>Z</strong></a>47 51 48 </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/ParkFitting.html#sans.fit.ParkFitting.MyAssembly.abort">abort() (sans.fit.ParkFitting.MyAssembly method)</a></dt>56 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitArrange.add_data">add_data() (sans.fit.AbstractFitEngine.FitArrange method)</a></dt>57 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.add_notes">add_notes() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt>58 <dd><dl>59 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.add_notes">(sans.fit.AbstractFitEngine.FitData2D method)</a></dt>60 </dl></dd>61 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.MyAssembly.all_results">all_results() (sans.fit.ParkFitting.MyAssembly method)</a></dt>62 </dl></td>63 <td style="width: 33%" valign="top"><dl>64 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.MyAssembly.append">append() (sans.fit.ParkFitting.MyAssembly method)</a></dt>65 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.append_empty_process">append_empty_process() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt>66 <dd><dl>67 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.append_empty_process">(sans.fit.AbstractFitEngine.FitData2D method)</a></dt>68 </dl></dd>69 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitAbort.args">args (sans.fit.AbstractFitEngine.FitAbort attribute)</a></dt>70 </dl></td>71 </tr></table>72 73 <h2 id="C">C</h2>74 <table style="width: 100%" class="indextable genindextable"><tr>75 <td style="width: 33%" valign="top"><dl>76 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansAssembly.check_param_range">check_param_range() (sans.fit.AbstractFitEngine.SansAssembly method)</a></dt>77 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansAssembly.chisq">chisq() (sans.fit.AbstractFitEngine.SansAssembly method)</a></dt>78 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.clone_without_data">clone_without_data() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt>79 <dd><dl>80 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.clone_without_data">(sans.fit.AbstractFitEngine.FitData2D method)</a></dt>81 </dl></dd>82 </dl></td>83 <td style="width: 33%" valign="top"><dl>84 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.MyAssembly.cov">cov() (sans.fit.ParkFitting.MyAssembly method)</a></dt>85 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.ParkFit.create_assembly">create_assembly() (sans.fit.ParkFitting.ParkFit method)</a></dt>86 </dl></td>87 </tr></table>88 89 <h2 id="E">E</h2>90 <table style="width: 100%" class="indextable genindextable"><tr>91 <td style="width: 33%" valign="top"><dl>92 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.Model.eval">eval() (sans.fit.AbstractFitEngine.Model method)</a></dt>93 <dd><dl>94 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.MyAssembly.eval">(sans.fit.ParkFitting.MyAssembly method)</a></dt>95 </dl></dd>96 </dl></td>97 <td style="width: 33%" valign="top"><dl>98 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.Model.eval_derivs">eval_derivs() (sans.fit.AbstractFitEngine.Model method)</a></dt>99 </dl></td>100 </tr></table>101 102 <h2 id="F">F</h2>103 <table style="width: 100%" class="indextable genindextable"><tr>104 <td style="width: 33%" valign="top"><dl>105 <dt><a href="api/Fitting.html#sans.fit.Fitting.Fit">Fit (class in sans.fit.Fitting)</a></dt>106 <dt><a href="api/Fitting.html#sans.fit.Fitting.Fit.fit">fit() (sans.fit.Fitting.Fit method)</a></dt>107 <dd><dl>108 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.ParkFit.fit">(sans.fit.ParkFitting.ParkFit method)</a></dt>109 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.ScipyFit.fit">(sans.fit.ScipyFitting.ScipyFit method)</a></dt>110 </dl></dd>111 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.MyAssembly.fit_parameters">fit_parameters() (sans.fit.ParkFitting.MyAssembly method)</a></dt>112 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitAbort">FitAbort</a></dt>113 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitArrange">FitArrange (class in sans.fit.AbstractFitEngine)</a></dt>114 </dl></td>115 <td style="width: 33%" valign="top"><dl>116 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D">FitData1D (class in sans.fit.AbstractFitEngine)</a></dt>117 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D">FitData2D (class in sans.fit.AbstractFitEngine)</a></dt>118 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitEngine">FitEngine (class in sans.fit.AbstractFitEngine)</a></dt>119 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.fitresult">fitresult (class in sans.fit.ScipyFitting)</a></dt>120 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.MyAssembly.fresiduals">fresiduals() (sans.fit.ParkFitting.MyAssembly method)</a></dt>121 </dl></td>122 </tr></table>123 124 <h2 id="G">G</h2>125 <table style="width: 100%" class="indextable genindextable"><tr>126 <td style="width: 33%" valign="top"><dl>127 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.get">get() (sans.fit.AbstractFitEngine.SansParameter method)</a></dt>128 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitArrange.get_data">get_data() (sans.fit.AbstractFitEngine.FitArrange method)</a></dt>129 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.get_fit_range">get_fit_range() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt>130 <dd><dl>131 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.get_fit_range">(sans.fit.AbstractFitEngine.FitData2D method)</a></dt>132 </dl></dd>133 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitArrange.get_model">get_model() (sans.fit.AbstractFitEngine.FitArrange method)</a></dt>134 <dd><dl>135 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitEngine.get_model">(sans.fit.AbstractFitEngine.FitEngine method)</a></dt>136 <dt><a href="api/Fitting.html#sans.fit.Fitting.Fit.get_model">(sans.fit.Fitting.Fit method)</a></dt>137 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.ParkFit.get_model">(sans.fit.ParkFitting.ParkFit method)</a></dt>138 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.ScipyFit.get_model">(sans.fit.ScipyFitting.ScipyFit method)</a></dt>139 </dl></dd>140 </dl></td>141 <td style="width: 33%" valign="top"><dl>142 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.get_name">get_name() (sans.fit.AbstractFitEngine.SansParameter method)</a></dt>143 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.Model.get_params">get_params() (sans.fit.AbstractFitEngine.Model method)</a></dt>144 <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>145 <dd><dl>146 <dt><a href="api/Fitting.html#sans.fit.Fitting.Fit.get_problem_to_fit">(sans.fit.Fitting.Fit method)</a></dt>147 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.ParkFit.get_problem_to_fit">(sans.fit.ParkFitting.ParkFit method)</a></dt>148 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.ScipyFit.get_problem_to_fit">(sans.fit.ScipyFitting.ScipyFit method)</a></dt>149 </dl></dd>150 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitArrange.get_to_fit">get_to_fit() (sans.fit.AbstractFitEngine.FitArrange method)</a></dt>151 </dl></td>152 </tr></table>153 154 <h2 id="I">I</h2>155 <table style="width: 100%" class="indextable genindextable"><tr>156 <td style="width: 33%" valign="top"><dl>157 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.MyAssembly.insert">insert() (sans.fit.ParkFitting.MyAssembly method)</a></dt>158 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.is_slit_smeared">is_slit_smeared() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt>159 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.iscomputed">iscomputed() (sans.fit.AbstractFitEngine.SansParameter method)</a></dt>160 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.isfeasible">isfeasible() (sans.fit.AbstractFitEngine.SansParameter method)</a></dt>161 <dd><dl>162 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.MyAssembly.isfeasible">(sans.fit.ParkFitting.MyAssembly method)</a></dt>163 </dl></dd>164 </dl></td>165 <td style="width: 33%" valign="top"><dl>166 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.isfitted">isfitted() (sans.fit.AbstractFitEngine.SansParameter method)</a></dt>167 <dd><dl>168 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.MyAssembly.isfitted">(sans.fit.ParkFitting.MyAssembly method)</a></dt>169 </dl></dd>170 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.isfixed">isfixed() (sans.fit.AbstractFitEngine.SansParameter method)</a></dt>171 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.isrestrained">isrestrained() (sans.fit.AbstractFitEngine.SansParameter method)</a></dt>172 </dl></td>173 </tr></table>174 175 <h2 id="J">J</h2>176 <table style="width: 100%" class="indextable genindextable"><tr>177 <td style="width: 33%" valign="top"><dl>178 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.MyAssembly.jacobian">jacobian() (sans.fit.ParkFitting.MyAssembly method)</a></dt>179 </dl></td>180 </tr></table>181 182 <h2 id="M">M</h2>183 <table style="width: 100%" class="indextable genindextable"><tr>184 <td style="width: 33%" valign="top"><dl>185 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitAbort.message">message (sans.fit.AbstractFitEngine.FitAbort attribute)</a></dt>186 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.Model">Model (class in sans.fit.AbstractFitEngine)</a></dt>187 </dl></td>188 <td style="width: 33%" valign="top"><dl>189 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.MyAssembly">MyAssembly (class in sans.fit.ParkFitting)</a></dt>190 </dl></td>191 </tr></table>192 193 <h2 id="N">N</h2>194 <table style="width: 100%" class="indextable genindextable"><tr>195 <td style="width: 33%" valign="top"><dl>196 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.name">name (sans.fit.AbstractFitEngine.SansParameter attribute)</a></dt>197 </dl></td>198 </tr></table>199 200 <h2 id="P">P</h2>201 <table style="width: 100%" class="indextable genindextable"><tr>202 <td style="width: 33%" valign="top"><dl>203 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.ParkFit">ParkFit (class in sans.fit.ParkFitting)</a></dt>204 </dl></td>205 <td style="width: 33%" valign="top"><dl>206 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.fitresult.print_summary">print_summary() (sans.fit.ScipyFitting.fitresult method)</a></dt>207 </dl></td>208 </tr></table>209 210 <h2 id="R">R</h2>211 <table style="width: 100%" class="indextable genindextable"><tr>212 <td style="width: 33%" valign="top"><dl>213 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.range">range (sans.fit.AbstractFitEngine.SansParameter attribute)</a></dt>214 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitArrange.remove_data">remove_data() (sans.fit.AbstractFitEngine.FitArrange method)</a></dt>215 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitEngine.remove_fit_problem">remove_fit_problem() (sans.fit.AbstractFitEngine.FitEngine method)</a></dt>216 <dd><dl>217 <dt><a href="api/Fitting.html#sans.fit.Fitting.Fit.remove_fit_problem">(sans.fit.Fitting.Fit method)</a></dt>218 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.ParkFit.remove_fit_problem">(sans.fit.ParkFitting.ParkFit method)</a></dt>219 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.ScipyFit.remove_fit_problem">(sans.fit.ScipyFitting.ScipyFit method)</a></dt>220 </dl></dd>221 </dl></td>222 <td style="width: 33%" valign="top"><dl>223 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.residuals">residuals() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt>224 <dd><dl>225 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.residuals">(sans.fit.AbstractFitEngine.FitData2D method)</a></dt>226 </dl></dd>227 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.residuals_deriv">residuals_deriv() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt>228 <dd><dl>229 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.residuals_deriv">(sans.fit.AbstractFitEngine.FitData2D method)</a></dt>230 </dl></dd>231 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.MyAssembly.result">result() (sans.fit.ParkFitting.MyAssembly method)</a></dt>232 </dl></td>233 </tr></table>234 235 <h2 id="S">S</h2>236 <table style="width: 100%" class="indextable genindextable"><tr>237 <td style="width: 33%" valign="top"><dl>238 <dt><a href="api/AbstractFitEngine.html#module-sans.fit.AbstractFitEngine">sans.fit.AbstractFitEngine (module)</a></dt>239 <dt><a href="api/Fitting.html#module-sans.fit.Fitting">sans.fit.Fitting (module)</a></dt>240 <dt><a href="api/ParkFitting.html#module-sans.fit.ParkFitting">sans.fit.ParkFitting (module)</a></dt>241 <dt><a href="api/ScipyFitting.html#module-sans.fit.ScipyFitting">sans.fit.ScipyFitting (module)</a></dt>242 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansAssembly">SansAssembly (class in sans.fit.AbstractFitEngine)</a></dt>243 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter">SansParameter (class in sans.fit.AbstractFitEngine)</a></dt>244 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.ScipyFit">ScipyFit (class in sans.fit.ScipyFitting)</a></dt>245 <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>246 <dd><dl>247 <dt><a href="api/Fitting.html#sans.fit.Fitting.Fit.select_problem_for_fit">(sans.fit.Fitting.Fit method)</a></dt>248 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.ParkFit.select_problem_for_fit">(sans.fit.ParkFitting.ParkFit method)</a></dt>249 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.ScipyFit.select_problem_for_fit">(sans.fit.ScipyFitting.ScipyFit method)</a></dt>250 </dl></dd>251 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.Model.set">set() (sans.fit.AbstractFitEngine.Model method)</a></dt>252 <dd><dl>253 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.set">(sans.fit.AbstractFitEngine.SansParameter method)</a></dt>254 </dl></dd>255 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.set_data">set_data() (sans.fit.AbstractFitEngine.FitData2D method)</a></dt>256 <dd><dl>257 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitEngine.set_data">(sans.fit.AbstractFitEngine.FitEngine method)</a></dt>258 <dt><a href="api/Fitting.html#sans.fit.Fitting.Fit.set_data">(sans.fit.Fitting.Fit method)</a></dt>259 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.ParkFit.set_data">(sans.fit.ParkFitting.ParkFit method)</a></dt>260 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.ScipyFit.set_data">(sans.fit.ScipyFitting.ScipyFit method)</a></dt>261 </dl></dd>262 <dt><a href="api/Fitting.html#sans.fit.Fitting.Fit.set_engine">set_engine() (sans.fit.Fitting.Fit method)</a></dt>263 </dl></td>264 <td style="width: 33%" valign="top"><dl>265 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.set_fit_range">set_fit_range() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt>266 <dd><dl>267 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.set_fit_range">(sans.fit.AbstractFitEngine.FitData2D method)</a></dt>268 </dl></dd>269 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.fitresult.set_fitness">set_fitness() (sans.fit.ScipyFitting.fitresult method)</a></dt>270 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitArrange.set_model">set_model() (sans.fit.AbstractFitEngine.FitArrange method)</a></dt>271 <dd><dl>272 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitEngine.set_model">(sans.fit.AbstractFitEngine.FitEngine method)</a></dt>273 <dt><a href="api/Fitting.html#sans.fit.Fitting.Fit.set_model">(sans.fit.Fitting.Fit method)</a></dt>274 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.ParkFit.set_model">(sans.fit.ParkFitting.ParkFit method)</a></dt>275 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.ScipyFit.set_model">(sans.fit.ScipyFitting.ScipyFit method)</a></dt>276 <dt><a href="api/ScipyFitting.html#sans.fit.ScipyFitting.fitresult.set_model">(sans.fit.ScipyFitting.fitresult method)</a></dt>277 </dl></dd>278 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.Model.set_params">set_params() (sans.fit.AbstractFitEngine.Model method)</a></dt>279 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.MyAssembly.set_result">set_result() (sans.fit.ParkFitting.MyAssembly method)</a></dt>280 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.set_smearer">set_smearer() (sans.fit.AbstractFitEngine.FitData2D method)</a></dt>281 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitArrange.set_to_fit">set_to_fit() (sans.fit.AbstractFitEngine.FitArrange method)</a></dt>282 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.setprefix">setprefix() (sans.fit.AbstractFitEngine.SansParameter method)</a></dt>283 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.MyAssembly.stderr">stderr() (sans.fit.ParkFitting.MyAssembly method)</a></dt>284 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.summarize">summarize() (sans.fit.AbstractFitEngine.SansParameter method)</a></dt>285 </dl></td>286 </tr></table>287 288 <h2 id="V">V</h2>289 <table style="width: 100%" class="indextable genindextable"><tr>290 <td style="width: 33%" valign="top"><dl>291 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.SansParameter.value">value (sans.fit.AbstractFitEngine.SansParameter attribute)</a></dt>292 </dl></td>293 </tr></table>294 295 <h2 id="W">W</h2>296 <table style="width: 100%" class="indextable genindextable"><tr>297 <td style="width: 33%" valign="top"><dl>298 <dt><a href="api/ParkFitting.html#sans.fit.ParkFitting.MyAssembly.weight">weight() (sans.fit.ParkFitting.MyAssembly method)</a></dt>299 </dl></td>300 </tr></table>301 302 <h2 id="X">X</h2>303 <table style="width: 100%" class="indextable genindextable"><tr>304 <td style="width: 33%" valign="top"><dl>305 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.xaxis">xaxis() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt>306 <dd><dl>307 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.xaxis">(sans.fit.AbstractFitEngine.FitData2D method)</a></dt>308 </dl></dd>309 </dl></td>310 </tr></table>311 312 <h2 id="Y">Y</h2>313 <table style="width: 100%" class="indextable genindextable"><tr>314 <td style="width: 33%" valign="top"><dl>315 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData1D.yaxis">yaxis() (sans.fit.AbstractFitEngine.FitData1D method)</a></dt>316 <dd><dl>317 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.yaxis">(sans.fit.AbstractFitEngine.FitData2D method)</a></dt>318 </dl></dd>319 </dl></td>320 </tr></table>321 322 <h2 id="Z">Z</h2>323 <table style="width: 100%" class="indextable genindextable"><tr>324 <td style="width: 33%" valign="top"><dl>325 <dt><a href="api/AbstractFitEngine.html#sans.fit.AbstractFitEngine.FitData2D.zaxis">zaxis() (sans.fit.AbstractFitEngine.FitData2D method)</a></dt>326 </dl></td>327 </tr></table>328 329 49 330 50 … … 360 80 <a href="#" title="General Index" 361 81 >index</a></li> 362 <li class="right" >363 <a href="py-modindex.html" title="Python Module Index"364 >modules</a> |</li>365 82 <li><a href="index.html">park_integration v0.1.0 documentation</a> »</li> 366 83 </ul> -
park_integration/docs/sphinx/_build/html/index.html
r0c3003d r41517a6 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>38 35 <li class="right" > 39 36 <a href="api/index.html" title="Reference" … … 118 115 >index</a></li> 119 116 <li class="right" > 120 <a href="py-modindex.html" title="Python Module Index"121 >modules</a> |</li>122 <li class="right" >123 117 <a href="api/index.html" title="Reference" 124 118 >next</a> |</li> -
park_integration/docs/sphinx/_build/html/search.html
r0c3003d r41517a6 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>43 40 <li><a href="index.html">park_integration v0.1.0 documentation</a> »</li> 44 41 </ul> … … 89 86 <a href="genindex.html" title="General Index" 90 87 >index</a></li> 91 <li class="right" >92 <a href="py-modindex.html" title="Python Module Index"93 >modules</a> |</li>94 88 <li><a href="index.html">park_integration v0.1.0 documentation</a> »</li> 95 89 </ul> -
park_integration/docs/sphinx/_build/html/searchindex.js
r0c3003d r41517a6 1 Search.setIndex({objects:{ "sans.fit":{AbstractFitEngine:[2,0,1],Fitting:[4,0,1],ParkFitting:[5,0,1],ScipyFitting:[1,0,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]},"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,3,1],get:[2,1,1],value:[2,3,1],isfixed:[2,1,1],range:[2,3,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.ParkFitting.ParkFit":{fit:[5,1,1],remove_fit_problem:[5,1,1],create_assembly:[5,1,1],set_model:[5,1,1],get_problem_to_fit:[5,1,1],get_model:[5,1,1],set_data:[5,1,1],select_problem_for_fit:[5,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.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.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.Fitting.Fit":{fit:[4,1,1],remove_fit_problem:[4,1,1],set_engine:[4,1,1],set_model:[4,1,1],get_problem_to_fit:[4,1,1],get_model:[4,1,1],set_data:[4,1,1],select_problem_for_fit:[4,1,1]},"sans.fit.AbstractFitEngine.SansAssembly":{chisq:[2,1,1],check_param_range:[2,1,1]},"sans.fit.Fitting":{Fit:[4,2,1]},"sans.fit.ScipyFitting":{fitresult:[1,2,1],ScipyFit:[1,2,1]},"sans.fit.AbstractFitEngine.FitAbort":{message:[2,3,1],args:[2,3,1]},"sans.fit.ScipyFitting.fitresult":{print_summary:[1,1,1],set_fitness:[1,1,1],set_model:[1,1,1]},"sans.fit.ParkFitting":{ParkFit:[5,2,1],MyAssembly:[5,2,1]},"sans.fit.AbstractFitEngine":{FitData2D:[2,2,1],SansParameter:[2,2,1],FitArrange:[2,2,1],SansAssembly:[2,2,1],FitEngine:[2,2,1],FitAbort:[2,4,1],Model:[2,2,1],FitData1D:[2,2,1]},"sans.fit.ParkFitting.MyAssembly":{insert:[5,1,1],isfeasible:[5,1,1],weight:[5,1,1],cov:[5,1,1],set_result:[5,1,1],fresiduals:[5,1,1],fit_parameters:[5,1,1],abort:[5,1,1],eval:[5,1,1],all_results:[5,1,1],stderr:[5,1,1],jacobian:[5,1,1],isfitted:[5,1,1],append:[5,1,1],result:[5,1,1]}},terms:{all:[5,1],all_result:5,set_param:[5,4,1,2],eval_deriv:2,prefix:2,follow:[5,4,1],depend:5,send:5,plottabl:[5,1,2],queri:5,string:[5,1,2],fals:2,feasibl:5,retriev:5,list:[5,4,1,2],zaxi:2,stderr:5,set_fit_rang:2,upper:2,check_param_rang:2,p_j:5,smearerobject:4,zero:[5,4,1,2],setprefix:2,append:5,index:0,what:5,curr_thread:[5,4,1,2],is_slit_smear:2,current:[5,2],version:2,method:[4,2],involv:2,full:2,deriv:[5,2],path:[5,2],sinc:5,valu:[5,4,1,2],search:0,fitarrang:[5,4,1,2],get_model:[5,4,1,2],implement:[5,2],"_getvalu":2,param_list:1,modul:[0,5,1],parkmodel:5,paramat:2,total:5,select:[5,4,1,2],ftol:[5,4,1],from:[5,4,2],chi:2,remove_data:2,two:5,handler:[5,4,1,2],call:[5,1,2],type:[5,4,1,2],fitarrangelist:5,more:5,desir:2,get_nam:2,smearer:[5,4,1,2],particular:5,given:[5,1,2],must:[5,1,2],none:[5,4,1,2],word:4,work:[5,1],uniqu:[5,1,2],abort:5,can:[5,4,1,2],residuals_deriv:2,overrid:2,fitengin:[5,1,2],indic:0,slit:2,chisq:[5,2],want:[5,1,2],set_model:[5,4,1,2],err_data:2,alwai:[5,1],fitresult:[1,2],end:5,get_to_fit:2,instead:2,fitparam:2,updat:5,clone_without_data:2,sansmodel:5,clone:2,after:5,minimum:[5,4],befor:2,date:3,data:[5,4,1,2],pvec:5,sansdata:5,correspond:[5,1,2],element:[5,1,2],receiv:[5,1,2],preced:[5,1],allow:[5,4,1,2],enter:4,elif:5,sqrt:5,vari:2,paramet:[5,4,1,2],"_getrang":2,fit:[0,1,2,3,4,5],fix:2,add_data:2,wrt:[5,2],onc:5,them:5,scipi:[4,1],"return":[5,4,1,2],initi:2,dataload:2,interrupt:5,name:[5,4,1,2],simpl:[5,1],data_info:2,each:5,found:5,fitdata1d:2,fitarrangedict:1,weight:5,wrap:4,extract:5,special:2,out:2,datainfo:2,matrix:5,space:5,content:0,print:5,correct:2,iscomput:[5,2],get_problem_to_fit:[5,4,1,2],base:[5,1,2],theori:5,dictionari:[5,4,1,2],releas:3,could:2,park_integr:0,print_summari:1,keep:5,length:2,place:5,outsid:2,get_param:2,get_fit_rang:2,first:5,oper:2,rang:[5,4,2],directli:2,data1d:[5,2],arrai:2,number:5,mai:5,wrapper:2,sansassembl:2,differ:[5,1,2],width:2,associ:[5,2],messag:2,paramt:2,conveni:5,"final":5,store:[4,1],copi:2,park:[5,4,2],than:5,serv:5,keyword:4,provid:2,remov:[5,4,1,2],tree:5,exampl:[5,1,2],posit:[5,4,1,2],select_problem_for_fit:[5,4,1,2],comput:[5,2],san:[3,5,4,1,2],have:[5,4,1,2],tabl:0,need:2,engin:[5,4,1,2],squar:2,equival:5,inform:2,dictionnari:[5,1],self:[5,4,1,2],inv:5,note:[5,1,2],data_list:2,client:5,which:2,jacobian:5,begin:5,sure:5,parkdata:5,object:[5,1,2],most:5,"class":[5,4,1,2],qy_data:2,fitter:4,doe:[5,4],declar:4,determin:2,axi:2,parameterset:5,gold:2,qmin:[5,4,1,2],redirect:2,onli:[5,4,1,2],just:[5,2],should:5,set_fit:1,leastsq:2,get:2,express:[5,2],stop:2,paramlist:2,recalcul:5,sans_data2d:2,contain:[5,4,1,2],where:[5,1,2],set:[5,4,1,2],"49012e":[5,4,1],result:[5,1],arg:2,best:5,yaxi:2,infinit:5,statu:5,kei:[5,1,2],label:2,between:2,"import":4,attribut:2,altern:2,august:3,extend:5,numer:5,set_data:[5,4,1,2],both:[5,1,2],cov:5,region:5,instanc:[5,4],improv:5,uncertainti:5,point:5,within:2,set_result:5,walk:5,residu:[5,2],psotion:4,suppli:5,summar:2,evalu:[5,2],coupl:[5,4,1,2],set_to_fit:2,empti:2,interpret:2,valueerror:[4,2],set_engin:4,sansparamet:[5,2],sans_model:2,togeth:[5,1],present:2,"case":[1,2],save:[5,1,2],servic:2,abstractfitengin:[3,0,5,1,2],calcul:[5,2],metric:5,good:5,par:[5,4,1,2],welcom:0,perform:[5,4,1],alphabet:5,make:5,same:5,document:0,optim:[5,1,2],data2d:2,covari:5,rais:[4,2],user:[5,4],lower:2,center:2,inherit:2,without:2,thi:[5,4,1,2],model:[5,4,1,2],usual:5,isfeas:[5,2],execut:5,except:2,param:[5,1,2],add:[5,1,2],chisqr:[5,1],subsequ:2,xaxi:2,mod:[3,5,4,1,2],insert:5,specif:5,qx_data:2,integ:[5,2],either:4,page:0,underli:2,isfix:[5,2],isfit:[5,2],back:5,flatten:5,chisqr1:[5,4,1],add_not:2,unit:2,refer:[3,0],set_smear:2,fresidu:5,step:5,out1:[5,4,1],idx:5,constraint:[5,4,1,2],smear:[4,2],qmax:[5,4,1,2],scipyfit:[3,0,5,4,1],append_empty_process:2,own:2,"float":5,bound:2,automat:1,diagon:5,been:[5,2],returnengin:4,myassembl:5,wai:2,start:5,interfac:5,forward:5,fitabort:2,"function":[5,2],himself:5,form:5,tupl:[5,1,2],parkfit:[3,0,5,4],err2:[5,1],err1:[5,1],"true":[5,2],info:2,possibl:5,whether:[5,2],remove_fit_problem:[5,4,1,2],maximum:5,limit:2,otherwis:2,problem:[5,4,1,2],precalcul:5,fit_paramet:5,uid:[5,1],creat:[5,4,1,2],dure:5,exist:[5,1,2],cov1:[5,4,1],inf:2,check:[5,2],fill:2,assembl:[5,2],fitdata2d:2,get_data:2,detail:5,other:2,you:5,create_assembl:5,eval:[5,2],isrestrain:2,portion:5,ignor:5,time:5,fit_engin:4},objtypes:{"0":"py:module","1":"py:method","2":"py:class","3":"py:attribute","4":"py:exception"},titles:["Welcome to park_integration’s documentation!","ScipyFitting","AbstractFitEngine","Reference","Fitting","ParkFitting"],objnames:{"0":"Python module","1":"Python method","2":"Python class","3":"Python attribute","4":"Python exception"},filenames:["index","api/ScipyFitting","api/AbstractFitEngine","api/index","api/Fitting","api/ParkFitting"]})1 Search.setIndex({objects:{},terms:{all:[],all_result:[],set_param:[],eval_deriv:[],zaxi:[],follow:[],depend:[],send:[],plottabl:[],queri:[],string:[],fals:[],feasibl:[],word:[],list:[],prefix:[],stderr:[],set_fit_rang:[],upper:[],work:[],p_j:[],smearerobject:[],zero:[],setprefix:[],append:[],index:0,what:[],curr_thread:[],is_slit_smear:[],current:[],version:[],method:[],"49012e":[],full:[],deriv:[],path:[],sinc:[],valu:[],search:0,fitarrang:[],get_model:[],implement:[],"_getvalu":[],param_list:[],modul:0,parkmodel:[],paramat:[],total:[],unit:[],ftol:[],from:[],chi:[],remove_data:[],two:[],dure:[],handler:[],call:[],type:[],fitarrangelist:[],more:[],desir:[],get_nam:[],smearer:[],particular:[],given:[],must:[],none:[],retriev:[],check_param_rang:[],uniqu:[],abort:[],can:[],residuals_deriv:[],overrid:[],fitengin:[],indic:0,slit:[],chisq:[],want:[],fitresult:[],err_data:[],alwai:[],parameterset:[],end:[],get_to_fit:[],instead:[],simpl:[],updat:[],clone_without_data:[],sansmodel:[],clone:[],after:[],minimum:[],befor:[],mai:[],associ:[],pvec:[],sansdata:[],correspond:[],element:[],receiv:[],preced:[],allow:[],enter:[],elif:[],same:[],vari:[],paramet:[],"_getrang":[],fit:[0,1,2,3,4,5],fix:[],add_data:[],wrt:[],onc:[],them:[],scipi:[],"return":[],initi:[],dataload:[],interrupt:[],name:[],fitparam:[],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:[],set_model:[],length:[],place:[],outsid:[],get_param:[],get_fit_rang:[],first:[],oper:[],rang:[],directli:[],data1d:[],arrai:[],number:[],date:3,wrapper:[],sansassembl:[],differ:[],width:[],data:[],messag:[],paramt:[],conveni:[],"final":[],store:[],copi:[],park:[],than:[],serv:[],keyword:[],provid:[],remov:[],tree:[],posit:[],select_problem_for_fit:[],comput:[],san:[3,5,4,1,2],have:[],tabl:0,need:[],engin:[],squar:[],equival:[],inform:[],dictionnari:[],self:[],note:[],data_list:[],exampl:[],which:[],jacobian:[],begin:[],sure:[],parkdata:[],object:[],most:[],"class":[],qy_data:[],fitter:[],doe:[],declar:[],determin:[],axi:[],gold:[],qmin:[],involv:[],onli:[],execut:[],should:[],set_fit:[],info:[],get:[],express:[],stop:[],paramlist:[],recalcul:[],sans_data2d:[],contain:[],where:[],set:[],result:[],arg:[],best:[],yaxi:[],infinit:[],statu:[],kei:[],redirect:[],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:[],creat:[],coupl:[],add:[],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:[],sqrt:[],document:0,optim:[],data2d:[],covari:[],rais:[],user:[],keep:[],lower:[],center:[],inherit:[],without:[],client:[],thi:[],model:[],usual:[],isfeas:[],just:[],except:[],param:[],set_to_fit:[],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:[],select:[],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":[],leastsq:[],possibl:[],whether:[],remove_fit_problem:[],maximum:[],limit:[],otherwis:[],problem:[],precalcul:[],fit_paramet:[],uid:[],evalu:[],inv:[],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"]}) -
park_integration/docs/sphinx/conf.py
raa36f96 r41517a6 17 17 # add these directories to sys.path here. If the directory is relative to the 18 18 # documentation root, use os.path.abspath to make it absolute, like shown here. 19 sys.path.append(os.path.abspath(os.path.dirname('../../park_integration'))) 19 sys.path.append(os.path.abspath(os.path.join('..', '..', 'src'))) 20 #sys.path.append(os.path.abspath(os.path.dirname('../../park_integration'))) 20 21 sys.path.append(os.path.abspath('_extensions')) 21 22
Note: See TracChangeset
for help on using the changeset viewer.