Ignore:
Timestamp:
Aug 12, 2011 2:30:37 PM (14 years ago)
Author:
Jessica Tumarkin <jtumarki@…>
Branches:
master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
fa597990
Parents:
25cba72
Message:

new html files for sphinx docs

File:
1 edited

Legend:

Unmodified
Added
Removed

  • park_integration/docs/sphinx/_build/html/api/AbstractFitEngine.html

    r41517a6 r1679f2f  
    3636             accesskey="I">index</a></li> 
    3737        <li class="right" > 
     38          <a href="../py-modindex.html" title="Python Module Index" 
     39             >modules</a> |</li> 
     40        <li class="right" > 
    3841          <a href="Fitting.html" title="Fitting" 
    3942             accesskey="N">next</a> |</li> 
    … …  
    5356  <div class="section" id="abstractfitengine"> 
    5457<h1>AbstractFitEngine<a class="headerlink" href="#abstractfitengine" title="Permalink to this headline">¶</a></h1> 
    55 <div class="section" id="mod-sans-fit-abstractfitengine"> 
    56 <h2>:mod:` sans.fit.AbstractFitEngine`<a class="headerlink" href="#mod-sans-fit-abstractfitengine" title="Permalink to this headline">¶</a></h2> 
     58<div class="section" id="module-sans.fit.AbstractFitEngine"> 
     59<span id="mod-sans-fit-abstractfitengine"></span><h2>:mod:` sans.fit.AbstractFitEngine`<a class="headerlink" href="#module-sans.fit.AbstractFitEngine" title="Permalink to this headline">¶</a></h2> 
     60<dl class="exception"> 
     61<dt id="sans.fit.AbstractFitEngine.FitAbort"> 
     62<em class="property">exception </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitAbort</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort" title="Permalink to this definition">¶</a></dt> 
     63<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p> 
     64<p>Exception raise to stop the fit</p> 
     65<dl class="attribute"> 
     66<dt id="sans.fit.AbstractFitEngine.FitAbort.args"> 
     67<tt class="descname">args</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.args" title="Permalink to this definition">¶</a></dt> 
     68<dd></dd></dl> 
     69 
     70<dl class="attribute"> 
     71<dt id="sans.fit.AbstractFitEngine.FitAbort.message"> 
     72<tt class="descname">message</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.message" title="Permalink to this definition">¶</a></dt> 
     73<dd><p>exception message</p> 
     74</dd></dl> 
     75 
     76</dd></dl> 
     77 
     78<dl class="class"> 
     79<dt id="sans.fit.AbstractFitEngine.FitArrange"> 
     80<em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitArrange</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange" title="Permalink to this definition">¶</a></dt> 
     81<dd><dl class="method"> 
     82<dt id="sans.fit.AbstractFitEngine.FitArrange.add_data"> 
     83<tt class="descname">add_data</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.add_data" title="Permalink to this definition">¶</a></dt> 
     84<dd><p>add_data fill a self.data_list with data to fit</p> 
     85<table class="docutils field-list" frame="void" rules="none"> 
     86<col class="field-name" /> 
     87<col class="field-body" /> 
     88<tbody valign="top"> 
     89<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> &#8211; 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> &#8211; 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> &#8211; 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> &#8211; integer between 0 or 1</td> 
     164</tr> 
     165</tbody> 
     166</table> 
     167</dd></dl> 
     168 
     169</dd></dl> 
     170 
     171<dl class="class"> 
     172<dt id="sans.fit.AbstractFitEngine.FitData1D"> 
     173<em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitData1D</tt><big>(</big><em>x</em>, <em>y</em>, <em>dx=None</em>, <em>dy=None</em>, <em>smearer=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D" title="Permalink to this definition">¶</a></dt> 
     174<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.data_info.Data1D</span></tt></p> 
     175<p>Wrapper class  for SANS data  
     176FitData1D inherits from DataLoader.data_info.Data1D. Implements  
     177a 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 
     193will be filled out by a subsequent operation). 
     194The 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> &#8211; length of the data array to be initialized</li> 
     201<li><strong>clone</strong> &#8211; 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 
     234the 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> &#8211; function that return model value</td> 
     240</tr> 
     241<tr class="field"><th class="field-name">Returns:</th><td class="field-body">residuals</td> 
     242</tr> 
     243</tbody> 
     244</table> 
     245</dd></dl> 
     246 
     247<dl class="method"> 
     248<dt id="sans.fit.AbstractFitEngine.FitData1D.residuals_deriv"> 
     249<tt class="descname">residuals_deriv</tt><big>(</big><em>model</em>, <em>pars=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.residuals_deriv" title="Permalink to this definition">¶</a></dt> 
     250<dd><table class="docutils field-list" frame="void" rules="none"> 
     251<col class="field-name" /> 
     252<col class="field-body" /> 
     253<tbody valign="top"> 
     254<tr class="field"><th class="field-name">Returns:</th><td class="field-body">residuals derivatives .</td> 
     255</tr> 
     256<tr class="field"><th class="field-name">Note :</th><td class="field-body">in this case just return empty array</td> 
     257</tr> 
     258</tbody> 
     259</table> 
     260</dd></dl> 
     261 
     262<dl class="method"> 
     263<dt id="sans.fit.AbstractFitEngine.FitData1D.set_fit_range"> 
     264<tt class="descname">set_fit_range</tt><big>(</big><em>qmin=None</em>, <em>qmax=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.set_fit_range" title="Permalink to this definition">¶</a></dt> 
     265<dd><p>to set the fit range</p> 
     266</dd></dl> 
     267 
     268<dl class="method"> 
     269<dt id="sans.fit.AbstractFitEngine.FitData1D.xaxis"> 
     270<tt class="descname">xaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.xaxis" title="Permalink to this definition">¶</a></dt> 
     271<dd><p>set the x axis label and unit</p> 
     272</dd></dl> 
     273 
     274<dl class="method"> 
     275<dt id="sans.fit.AbstractFitEngine.FitData1D.yaxis"> 
     276<tt class="descname">yaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.yaxis" title="Permalink to this definition">¶</a></dt> 
     277<dd><p>set the y axis label and unit</p> 
     278</dd></dl> 
     279 
     280</dd></dl> 
     281 
     282<dl class="class"> 
     283<dt id="sans.fit.AbstractFitEngine.FitData2D"> 
     284<em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitData2D</tt><big>(</big><em>sans_data2d</em>, <em>data=None</em>, <em>err_data=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D" title="Permalink to this definition">¶</a></dt> 
     285<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.data_info.Data2D</span></tt></p> 
     286<p>Wrapper class  for SANS data</p> 
     287<dl class="method"> 
     288<dt id="sans.fit.AbstractFitEngine.FitData2D.add_notes"> 
     289<tt class="descname">add_notes</tt><big>(</big><em>message=''</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.add_notes" title="Permalink to this definition">¶</a></dt> 
     290<dd><p>Add notes to datainfo</p> 
     291</dd></dl> 
     292 
     293<dl class="method"> 
     294<dt id="sans.fit.AbstractFitEngine.FitData2D.append_empty_process"> 
     295<tt class="descname">append_empty_process</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.append_empty_process" title="Permalink to this definition">¶</a></dt> 
     296<dd></dd></dl> 
     297 
     298<dl class="method"> 
     299<dt id="sans.fit.AbstractFitEngine.FitData2D.clone_without_data"> 
     300<tt class="descname">clone_without_data</tt><big>(</big><em>length=0</em>, <em>clone=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.clone_without_data" title="Permalink to this definition">¶</a></dt> 
     301<dd><p>Clone the current object, without copying the data (which 
     302will be filled out by a subsequent operation). 
     303The 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> &#8211; length of the data array to be initialized</li> 
     310<li><strong>clone</strong> &#8211; 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> &#8211; 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  
     396created 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> &#8211; 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 
     426and 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> &#8211; the value to allow fitting.  
     432can 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 
     442in a FitArrange object and adds that object in a dictionary  
     443with 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> &#8211; data added</li> 
     450<li><strong>id</strong> &#8211; 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> &#8211; 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> &#8211; the list of parameters to fit</li> 
     480<li><strong>constraints</strong> &#8211; <p>list of  
     481tuple (name of parameter, value of parameters) 
     482the value of parameter must be a string to constraint 2 different 
     483parameters. 
     484Example:   
     485we want to fit 2 model M1 and M2 both have parameters A and B. 
     486constraints 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&#8217;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> &#8211; 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 
     526are desired.</p> 
     527<p>This method needs to be specialized in the model to evaluate the 
     528model function.  Alternatively, the model can implement is own 
     529version of residuals which calculates the residuals directly 
     530instead 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> &#8211; 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> &#8211; 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 
     578and set res to the inf if the value is outside of the 
     579range 
     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> &#8211; 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. 
     606The parameter attribute value is redirected to the underlying 
     607parameter 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 
     655return 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, 
     662the parameter will be fixed for the fit.  If it is a range, the value 
     663will be varying for the fit.  If it is an expression, the parameter will 
     664be 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 
     672the 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.,  &#8221;       Gold .....|.... 5.2043 in [2,7]&#8221;</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 
    57691</div> 
    58692</div> 
    … …  
    67701  <ul> 
    68702<li><a class="reference internal" href="#">AbstractFitEngine</a><ul> 
    69 <li><a class="reference internal" href="#mod-sans-fit-abstractfitengine">:mod:` sans.fit.AbstractFitEngine`</a></li> 
     703<li><a class="reference internal" href="#module-sans.fit.AbstractFitEngine">:mod:` sans.fit.AbstractFitEngine`</a></li> 
    70704</ul> 
    71705</li> 
    … …  
    107741             >index</a></li> 
    108742        <li class="right" > 
     743          <a href="../py-modindex.html" title="Python Module Index" 
     744             >modules</a> |</li> 
     745        <li class="right" > 
    109746          <a href="Fitting.html" title="Fitting" 
    110747             >next</a> |</li> 
Note: See TracChangeset for help on using the changeset viewer.