Ignore:
Timestamp:
Oct 24, 2011 11:42:54 AM (13 years ago)
Author:
Gervaise Alina <gervyh@…>
Branches:
master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
8884996
Parents:
40299ce
Message:

edit doc

Location:
park_integration/docs/sphinx/html/api
Files:
1 added
5 edited

Legend:

Unmodified
Added
Removed

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

    r6b1588b rf696e2a  
    33<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
    44  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
     5 
    56 
    67<html xmlns="http://www.w3.org/1999/xhtml"> 
    … …  
    89    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 
    910     
    10     <title>AbstractFitEngine &mdash; park_integration v0.1.0 documentation</title> 
     11    <title>AbstractFitEngine &mdash; park_integration 0.1.0 documentation</title> 
     12     
    1113    <link rel="stylesheet" href="../_static/default.css" type="text/css" /> 
    1214    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> 
     15     
    1316    <script type="text/javascript"> 
    1417      var DOCUMENTATION_OPTIONS = { 
    … …  
    2326    <script type="text/javascript" src="../_static/underscore.js"></script> 
    2427    <script type="text/javascript" src="../_static/doctools.js"></script> 
    25     <link rel="top" title="park_integration v0.1.0 documentation" href="../index.html" /> 
     28    <link rel="top" title="park_integration 0.1.0 documentation" href="../index.html" /> 
    2629    <link rel="up" title="Reference" href="index.html" /> 
    2730    <link rel="next" title="Fitting" href="Fitting.html" /> 
    … …  
    4447          <a href="index.html" title="Reference" 
    4548             accesskey="P">previous</a> |</li> 
    46         <li><a href="../index.html">park_integration v0.1.0 documentation</a> &raquo;</li> 
     49        <li><a href="../index.html">park_integration 0.1.0 documentation</a> &raquo;</li> 
    4750          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li>  
    4851      </ul> 
    … …  
    5659  <div class="section" id="abstractfitengine"> 
    5760<h1>AbstractFitEngine<a class="headerlink" href="#abstractfitengine" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.fit.AbstractFitEngine"> 
    59 <span id="mod-sans-fit-abstractfitengine"></span><h2>:mod:` sans.fit.AbstractFitEngine`<a class="headerlink" href="#module-sans.fit.AbstractFitEngine" title="Permalink to this headline">¶</a></h2> 
     61<div class="section" id="mod-sans-fit-abstractfitengine"> 
     62<h2>:mod:` sans.fit.AbstractFitEngine`<a class="headerlink" href="#mod-sans-fit-abstractfitengine" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.fit.AbstractFitEngine"></span><dl class="class"> 
     64<dt id="sans.fit.AbstractFitEngine.FResult"> 
     65<em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FResult</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult" title="Permalink to this definition">¶</a></dt> 
     66<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> 
     67<p>Storing fit result</p> 
     68<dl class="attribute"> 
     69<dt id="sans.fit.AbstractFitEngine.FResult.__class__"> 
     70<tt class="descname">__class__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__class__" title="Permalink to this definition">¶</a></dt> 
     71<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     72</dd></dl> 
     73 
     74<dl class="attribute"> 
     75<dt id="sans.fit.AbstractFitEngine.FResult.__delattr__"> 
     76<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__delattr__" title="Permalink to this definition">¶</a></dt> 
     77<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     78</dd></dl> 
     79 
     80<dl class="attribute"> 
     81<dt id="sans.fit.AbstractFitEngine.FResult.__dict__"> 
     82<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01FA56D0&gt;</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__dict__" title="Permalink to this definition">¶</a></dt> 
     83<dd></dd></dl> 
     84 
     85<dl class="attribute"> 
     86<dt id="sans.fit.AbstractFitEngine.FResult.__getattribute__"> 
     87<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     88<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     89</dd></dl> 
     90 
     91<dl class="attribute"> 
     92<dt id="sans.fit.AbstractFitEngine.FResult.__hash__"> 
     93<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__hash__" title="Permalink to this definition">¶</a></dt> 
     94<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     95</dd></dl> 
     96 
     97<dl class="method"> 
     98<dt id="sans.fit.AbstractFitEngine.FResult.__init__"> 
     99<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__init__" title="Permalink to this definition">¶</a></dt> 
     100<dd></dd></dl> 
     101 
     102<dl class="attribute"> 
     103<dt id="sans.fit.AbstractFitEngine.FResult.__module__"> 
     104<tt class="descname">__module__</tt><em class="property"> = 'sans.fit.AbstractFitEngine'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__module__" title="Permalink to this definition">¶</a></dt> 
     105<dd></dd></dl> 
     106 
     107<dl class="staticmethod"> 
     108<dt id="sans.fit.AbstractFitEngine.FResult.__new__"> 
     109<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__new__" title="Permalink to this definition">¶</a></dt> 
     110<dd></dd></dl> 
     111 
     112<dl class="method"> 
     113<dt id="sans.fit.AbstractFitEngine.FResult.__reduce__"> 
     114<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__reduce__" title="Permalink to this definition">¶</a></dt> 
     115<dd><p>helper for pickle</p> 
     116</dd></dl> 
     117 
     118<dl class="method"> 
     119<dt id="sans.fit.AbstractFitEngine.FResult.__reduce_ex__"> 
     120<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     121<dd><p>helper for pickle</p> 
     122</dd></dl> 
     123 
     124<dl class="attribute"> 
     125<dt id="sans.fit.AbstractFitEngine.FResult.__repr__"> 
     126<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__repr__" title="Permalink to this definition">¶</a></dt> 
     127<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     128</dd></dl> 
     129 
     130<dl class="attribute"> 
     131<dt id="sans.fit.AbstractFitEngine.FResult.__setattr__"> 
     132<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__setattr__" title="Permalink to this definition">¶</a></dt> 
     133<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     134</dd></dl> 
     135 
     136<dl class="method"> 
     137<dt id="sans.fit.AbstractFitEngine.FResult.__str__"> 
     138<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__str__" title="Permalink to this definition">¶</a></dt> 
     139<dd></dd></dl> 
     140 
     141<dl class="attribute"> 
     142<dt id="sans.fit.AbstractFitEngine.FResult.__weakref__"> 
     143<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.__weakref__" title="Permalink to this definition">¶</a></dt> 
     144<dd><p>list of weak references to the object (if defined)</p> 
     145</dd></dl> 
     146 
     147<dl class="method"> 
     148<dt id="sans.fit.AbstractFitEngine.FResult.print_summary"> 
     149<tt class="descname">print_summary</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.print_summary" title="Permalink to this definition">¶</a></dt> 
     150<dd></dd></dl> 
     151 
     152<dl class="method"> 
     153<dt id="sans.fit.AbstractFitEngine.FResult.set_fitness"> 
     154<tt class="descname">set_fitness</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.set_fitness" title="Permalink to this definition">¶</a></dt> 
     155<dd></dd></dl> 
     156 
     157<dl class="method"> 
     158<dt id="sans.fit.AbstractFitEngine.FResult.set_model"> 
     159<tt class="descname">set_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FResult.set_model" title="Permalink to this definition">¶</a></dt> 
     160<dd></dd></dl> 
     161 
     162</dd></dl> 
     163 
    60164<dl class="exception"> 
    61165<dt id="sans.fit.AbstractFitEngine.FitAbort"> 
    … …  
    64168<p>Exception raise to stop the fit</p> 
    65169<dl class="attribute"> 
     170<dt id="sans.fit.AbstractFitEngine.FitAbort.__class__"> 
     171<tt class="descname">__class__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__class__" title="Permalink to this definition">¶</a></dt> 
     172<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     173</dd></dl> 
     174 
     175<dl class="attribute"> 
     176<dt id="sans.fit.AbstractFitEngine.FitAbort.__delattr__"> 
     177<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__delattr__" title="Permalink to this definition">¶</a></dt> 
     178<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     179</dd></dl> 
     180 
     181<dl class="attribute"> 
     182<dt id="sans.fit.AbstractFitEngine.FitAbort.__dict__"> 
     183<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01FA5810&gt;</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__dict__" title="Permalink to this definition">¶</a></dt> 
     184<dd></dd></dl> 
     185 
     186<dl class="attribute"> 
     187<dt id="sans.fit.AbstractFitEngine.FitAbort.__getattribute__"> 
     188<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     189<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     190</dd></dl> 
     191 
     192<dl class="attribute"> 
     193<dt id="sans.fit.AbstractFitEngine.FitAbort.__getitem__"> 
     194<tt class="descname">__getitem__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__getitem__" title="Permalink to this definition">¶</a></dt> 
     195<dd><p>x.__getitem__(y) &lt;==&gt; x[y]</p> 
     196</dd></dl> 
     197 
     198<dl class="attribute"> 
     199<dt id="sans.fit.AbstractFitEngine.FitAbort.__getslice__"> 
     200<tt class="descname">__getslice__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__getslice__" title="Permalink to this definition">¶</a></dt> 
     201<dd><p>x.__getslice__(i, j) &lt;==&gt; x[i:j]</p> 
     202<p>Use of negative indices is not supported.</p> 
     203</dd></dl> 
     204 
     205<dl class="attribute"> 
     206<dt id="sans.fit.AbstractFitEngine.FitAbort.__hash__"> 
     207<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__hash__" title="Permalink to this definition">¶</a></dt> 
     208<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     209</dd></dl> 
     210 
     211<dl class="attribute"> 
     212<dt id="sans.fit.AbstractFitEngine.FitAbort.__init__"> 
     213<tt class="descname">__init__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__init__" title="Permalink to this definition">¶</a></dt> 
     214<dd><p>x.__init__(...) initializes x; see x.__class__.__doc__ for signature</p> 
     215</dd></dl> 
     216 
     217<dl class="attribute"> 
     218<dt id="sans.fit.AbstractFitEngine.FitAbort.__module__"> 
     219<tt class="descname">__module__</tt><em class="property"> = 'sans.fit.AbstractFitEngine'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__module__" title="Permalink to this definition">¶</a></dt> 
     220<dd></dd></dl> 
     221 
     222<dl class="staticmethod"> 
     223<dt id="sans.fit.AbstractFitEngine.FitAbort.__new__"> 
     224<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__new__" title="Permalink to this definition">¶</a></dt> 
     225<dd></dd></dl> 
     226 
     227<dl class="method"> 
     228<dt id="sans.fit.AbstractFitEngine.FitAbort.__reduce__"> 
     229<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__reduce__" title="Permalink to this definition">¶</a></dt> 
     230<dd></dd></dl> 
     231 
     232<dl class="method"> 
     233<dt id="sans.fit.AbstractFitEngine.FitAbort.__reduce_ex__"> 
     234<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     235<dd><p>helper for pickle</p> 
     236</dd></dl> 
     237 
     238<dl class="attribute"> 
     239<dt id="sans.fit.AbstractFitEngine.FitAbort.__repr__"> 
     240<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__repr__" title="Permalink to this definition">¶</a></dt> 
     241<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     242</dd></dl> 
     243 
     244<dl class="attribute"> 
     245<dt id="sans.fit.AbstractFitEngine.FitAbort.__setattr__"> 
     246<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__setattr__" title="Permalink to this definition">¶</a></dt> 
     247<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     248</dd></dl> 
     249 
     250<dl class="method"> 
     251<dt id="sans.fit.AbstractFitEngine.FitAbort.__setstate__"> 
     252<tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__setstate__" title="Permalink to this definition">¶</a></dt> 
     253<dd></dd></dl> 
     254 
     255<dl class="attribute"> 
     256<dt id="sans.fit.AbstractFitEngine.FitAbort.__str__"> 
     257<tt class="descname">__str__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__str__" title="Permalink to this definition">¶</a></dt> 
     258<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     259</dd></dl> 
     260 
     261<dl class="attribute"> 
     262<dt id="sans.fit.AbstractFitEngine.FitAbort.__weakref__"> 
     263<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.__weakref__" title="Permalink to this definition">¶</a></dt> 
     264<dd><p>list of weak references to the object (if defined)</p> 
     265</dd></dl> 
     266 
     267<dl class="attribute"> 
    66268<dt id="sans.fit.AbstractFitEngine.FitAbort.args"> 
    67269<tt class="descname">args</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitAbort.args" title="Permalink to this definition">¶</a></dt> 
    … …  
    80282<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> 
    81283<dd><dl class="method"> 
     284<dt id="sans.fit.AbstractFitEngine.FitArrange.__init__"> 
     285<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.__init__" title="Permalink to this definition">¶</a></dt> 
     286<dd><p>Class FitArrange contains a set of data for a given model 
     287to perform the Fit.FitArrange must contain exactly one model 
     288and at least one data for the fit to be performed.</p> 
     289<p>model: the model selected by the user 
     290Ldata: a list of data what the user wants to fit</p> 
     291</dd></dl> 
     292 
     293<dl class="attribute"> 
     294<dt id="sans.fit.AbstractFitEngine.FitArrange.__module__"> 
     295<tt class="descname">__module__</tt><em class="property"> = 'sans.fit.AbstractFitEngine'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.__module__" title="Permalink to this definition">¶</a></dt> 
     296<dd></dd></dl> 
     297 
     298<dl class="method"> 
    82299<dt id="sans.fit.AbstractFitEngine.FitArrange.add_data"> 
    83 <tt class="descname">add_data</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.add_data" title="Permalink to this definition">¶</a></dt> 
     300<tt class="descname">add_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.add_data" title="Permalink to this definition">¶</a></dt> 
    84301<dd><p>add_data fill a self.data_list with data to fit</p> 
    85302<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    87304<col class="field-body" /> 
    88305<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> 
     306<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> &#8211; Data to add in the list</td> 
    90307</tr> 
    91308</tbody> 
    … …  
    100317<col class="field-body" /> 
    101318<tbody valign="top"> 
    102 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">list of data data_list</td> 
     319<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">list of data data_list</td> 
    103320</tr> 
    104321</tbody> 
    … …  
    113330<col class="field-body" /> 
    114331<tbody valign="top"> 
    115 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">saved model</td> 
     332<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">saved model</td> 
    116333</tr> 
    117334</tbody> 
    … …  
    127344<dl class="method"> 
    128345<dt id="sans.fit.AbstractFitEngine.FitArrange.remove_data"> 
    129 <tt class="descname">remove_data</tt><big>(</big><em>data</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.remove_data" title="Permalink to this definition">¶</a></dt> 
     346<tt class="descname">remove_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.remove_data" title="Permalink to this definition">¶</a></dt> 
    130347<dd><p>Remove one element from the list</p> 
    131348<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    133350<col class="field-body" /> 
    134351<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> 
     352<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> &#8211; Data to remove from data_list</td> 
    136353</tr> 
    137354</tbody> 
    … …  
    141358<dl class="method"> 
    142359<dt id="sans.fit.AbstractFitEngine.FitArrange.set_model"> 
    143 <tt class="descname">set_model</tt><big>(</big><em>model</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.set_model" title="Permalink to this definition">¶</a></dt> 
     360<tt class="descname">set_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.set_model" title="Permalink to this definition">¶</a></dt> 
    144361<dd><p>set_model save a copy of the model</p> 
    145362<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    147364<col class="field-body" /> 
    148365<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> 
     366<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> &#8211; the model being set</td> 
    150367</tr> 
    151368</tbody> 
    … …  
    155372<dl class="method"> 
    156373<dt id="sans.fit.AbstractFitEngine.FitArrange.set_to_fit"> 
    157 <tt class="descname">set_to_fit</tt><big>(</big><em>value=0</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.set_to_fit" title="Permalink to this definition">¶</a></dt> 
     374<tt class="descname">set_to_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitArrange.set_to_fit" title="Permalink to this definition">¶</a></dt> 
    158375<dd><p>set self.selected to 0 or 1  for other values raise an exception</p> 
    159376<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    161378<col class="field-body" /> 
    162379<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> 
     380<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> &#8211; integer between 0 or 1</td> 
    164381</tr> 
    165382</tbody> 
    … …  
    171388<dl class="class"> 
    172389<dt id="sans.fit.AbstractFitEngine.FitData1D"> 
    173 <em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitData1D</tt><big>(</big><em>x</em>, <em>y</em>, <em>dx=None</em>, <em>dy=None</em>, <em>smearer=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D" title="Permalink to this definition">¶</a></dt> 
     390<em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitData1D</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D" title="Permalink to this definition">¶</a></dt> 
    174391<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.data_info.Data1D</span></tt></p> 
    175392<p>Wrapper class  for SANS data  
    … …  
    177394a way to get residuals from data.</p> 
    178395<dl class="method"> 
     396<dt id="sans.fit.AbstractFitEngine.FitData1D.__add__"> 
     397<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__add__" title="Permalink to this definition">¶</a></dt> 
     398<dd><p>Add two data sets</p> 
     399<table class="docutils field-list" frame="void" rules="none"> 
     400<col class="field-name" /> 
     401<col class="field-body" /> 
     402<tbody valign="top"> 
     403<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> &#8211; data set to add to the current one</td> 
     404</tr> 
     405<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> 
     406</tr> 
     407<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     408<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">raised when two data sets are incompatible</td> 
     409</tr> 
     410</tbody> 
     411</table> 
     412</dd></dl> 
     413 
     414<dl class="method"> 
     415<dt id="sans.fit.AbstractFitEngine.FitData1D.__div__"> 
     416<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__div__" title="Permalink to this definition">¶</a></dt> 
     417<dd><p>Divided a data set by another</p> 
     418<table class="docutils field-list" frame="void" rules="none"> 
     419<col class="field-name" /> 
     420<col class="field-body" /> 
     421<tbody valign="top"> 
     422<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> &#8211; data set that the current one is divided by</td> 
     423</tr> 
     424<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> 
     425</tr> 
     426<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     427<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">raised when two data sets are incompatible</td> 
     428</tr> 
     429</tbody> 
     430</table> 
     431</dd></dl> 
     432 
     433<dl class="method"> 
     434<dt id="sans.fit.AbstractFitEngine.FitData1D.__init__"> 
     435<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__init__" title="Permalink to this definition">¶</a></dt> 
     436<dd><table class="docutils field-list" frame="void" rules="none"> 
     437<col class="field-name" /> 
     438<col class="field-body" /> 
     439<tbody valign="top"> 
     440<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>smearer</strong> &#8211; is an object of class QSmearer or SlitSmearer 
     441that will smear the theory data (slit smearing or resolution  
     442smearing) when set.</td> 
     443</tr> 
     444</tbody> 
     445</table> 
     446<p>The proper way to set the smearing object would be to 
     447do the following:</p> 
     448<div class="highlight-python"><pre>from DataLoader.qsmearing import smear_selection 
     449smearer = smear_selection(some_data) 
     450fitdata1d = FitData1D( x= [1,3,..,],  
     451                        y= [3,4,..,8],  
     452                        dx=None, 
     453                        dy=[1,2...], smearer= smearer)</pre> 
     454</div> 
     455<table class="docutils field-list" frame="void" rules="none"> 
     456<col class="field-name" /> 
     457<col class="field-body" /> 
     458<tbody valign="top"> 
     459<tr class="field-odd field"><th class="field-name">Note :</th><td class="field-body">that some_data _HAS_ to be of class DataLoader.data_info.Data1D 
     460Setting it back to None will turn smearing off.</td> 
     461</tr> 
     462</tbody> 
     463</table> 
     464</dd></dl> 
     465 
     466<dl class="attribute"> 
     467<dt id="sans.fit.AbstractFitEngine.FitData1D.__module__"> 
     468<tt class="descname">__module__</tt><em class="property"> = 'sans.fit.AbstractFitEngine'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__module__" title="Permalink to this definition">¶</a></dt> 
     469<dd></dd></dl> 
     470 
     471<dl class="method"> 
     472<dt id="sans.fit.AbstractFitEngine.FitData1D.__mul__"> 
     473<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__mul__" title="Permalink to this definition">¶</a></dt> 
     474<dd><p>Multiply two data sets</p> 
     475<table class="docutils field-list" frame="void" rules="none"> 
     476<col class="field-name" /> 
     477<col class="field-body" /> 
     478<tbody valign="top"> 
     479<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> &#8211; data set to subtract from the current one</td> 
     480</tr> 
     481<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> 
     482</tr> 
     483<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     484<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">raised when two data sets are incompatible</td> 
     485</tr> 
     486</tbody> 
     487</table> 
     488</dd></dl> 
     489 
     490<dl class="method"> 
     491<dt id="sans.fit.AbstractFitEngine.FitData1D.__radd__"> 
     492<tt class="descname">__radd__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__radd__" title="Permalink to this definition">¶</a></dt> 
     493<dd><p>Add two data sets</p> 
     494<table class="docutils field-list" frame="void" rules="none"> 
     495<col class="field-name" /> 
     496<col class="field-body" /> 
     497<tbody valign="top"> 
     498<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> &#8211; data set to add to the current one</td> 
     499</tr> 
     500<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> 
     501</tr> 
     502<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     503<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">raised when two data sets are incompatible</td> 
     504</tr> 
     505</tbody> 
     506</table> 
     507</dd></dl> 
     508 
     509<dl class="method"> 
     510<dt id="sans.fit.AbstractFitEngine.FitData1D.__rdiv__"> 
     511<tt class="descname">__rdiv__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__rdiv__" title="Permalink to this definition">¶</a></dt> 
     512<dd><p>Divided a data set by another</p> 
     513<table class="docutils field-list" frame="void" rules="none"> 
     514<col class="field-name" /> 
     515<col class="field-body" /> 
     516<tbody valign="top"> 
     517<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> &#8211; data set that the current one is divided by</td> 
     518</tr> 
     519<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> 
     520</tr> 
     521<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     522<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">raised when two data sets are incompatible</td> 
     523</tr> 
     524</tbody> 
     525</table> 
     526</dd></dl> 
     527 
     528<dl class="method"> 
     529<dt id="sans.fit.AbstractFitEngine.FitData1D.__rmul__"> 
     530<tt class="descname">__rmul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__rmul__" title="Permalink to this definition">¶</a></dt> 
     531<dd><p>Multiply two data sets</p> 
     532<table class="docutils field-list" frame="void" rules="none"> 
     533<col class="field-name" /> 
     534<col class="field-body" /> 
     535<tbody valign="top"> 
     536<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> &#8211; data set to subtract from the current one</td> 
     537</tr> 
     538<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> 
     539</tr> 
     540<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     541<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">raised when two data sets are incompatible</td> 
     542</tr> 
     543</tbody> 
     544</table> 
     545</dd></dl> 
     546 
     547<dl class="method"> 
     548<dt id="sans.fit.AbstractFitEngine.FitData1D.__rsub__"> 
     549<tt class="descname">__rsub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__rsub__" title="Permalink to this definition">¶</a></dt> 
     550<dd><p>Subtract two data sets</p> 
     551<table class="docutils field-list" frame="void" rules="none"> 
     552<col class="field-name" /> 
     553<col class="field-body" /> 
     554<tbody valign="top"> 
     555<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> &#8211; data set to subtract from the current one</td> 
     556</tr> 
     557<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> 
     558</tr> 
     559<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     560<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">raised when two data sets are incompatible</td> 
     561</tr> 
     562</tbody> 
     563</table> 
     564</dd></dl> 
     565 
     566<dl class="method"> 
     567<dt id="sans.fit.AbstractFitEngine.FitData1D.__str__"> 
     568<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__str__" title="Permalink to this definition">¶</a></dt> 
     569<dd><p>Nice printout</p> 
     570</dd></dl> 
     571 
     572<dl class="method"> 
     573<dt id="sans.fit.AbstractFitEngine.FitData1D.__sub__"> 
     574<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.__sub__" title="Permalink to this definition">¶</a></dt> 
     575<dd><p>Subtract two data sets</p> 
     576<table class="docutils field-list" frame="void" rules="none"> 
     577<col class="field-name" /> 
     578<col class="field-body" /> 
     579<tbody valign="top"> 
     580<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> &#8211; data set to subtract from the current one</td> 
     581</tr> 
     582<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> 
     583</tr> 
     584<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     585<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">raised when two data sets are incompatible</td> 
     586</tr> 
     587</tbody> 
     588</table> 
     589</dd></dl> 
     590 
     591<dl class="method"> 
     592<dt id="sans.fit.AbstractFitEngine.FitData1D._perform_operation"> 
     593<tt class="descname">_perform_operation</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D._perform_operation" title="Permalink to this definition">¶</a></dt> 
     594<dd></dd></dl> 
     595 
     596<dl class="method"> 
     597<dt id="sans.fit.AbstractFitEngine.FitData1D._validity_check"> 
     598<tt class="descname">_validity_check</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D._validity_check" title="Permalink to this definition">¶</a></dt> 
     599<dd><p>Checks that the data lengths are compatible. 
     600Checks that the x vectors are compatible. 
     601Returns errors vectors equal to original 
     602errors vectors if they were present or vectors 
     603of zeros when none was found.</p> 
     604<table class="docutils field-list" frame="void" rules="none"> 
     605<col class="field-name" /> 
     606<col class="field-body" /> 
     607<tbody valign="top"> 
     608<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> &#8211; other data set for operation</td> 
     609</tr> 
     610<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">dy for self, dy for other [numpy arrays]</td> 
     611</tr> 
     612<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     613<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">when lengths are not compatible</td> 
     614</tr> 
     615</tbody> 
     616</table> 
     617</dd></dl> 
     618 
     619<dl class="attribute"> 
     620<dt id="sans.fit.AbstractFitEngine.FitData1D._xaxis"> 
     621<tt class="descname">_xaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D._xaxis" title="Permalink to this definition">¶</a></dt> 
     622<dd></dd></dl> 
     623 
     624<dl class="attribute"> 
     625<dt id="sans.fit.AbstractFitEngine.FitData1D._xunit"> 
     626<tt class="descname">_xunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D._xunit" title="Permalink to this definition">¶</a></dt> 
     627<dd></dd></dl> 
     628 
     629<dl class="attribute"> 
     630<dt id="sans.fit.AbstractFitEngine.FitData1D._yaxis"> 
     631<tt class="descname">_yaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D._yaxis" title="Permalink to this definition">¶</a></dt> 
     632<dd></dd></dl> 
     633 
     634<dl class="attribute"> 
     635<dt id="sans.fit.AbstractFitEngine.FitData1D._yunit"> 
     636<tt class="descname">_yunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D._yunit" title="Permalink to this definition">¶</a></dt> 
     637<dd></dd></dl> 
     638 
     639<dl class="method"> 
    179640<dt id="sans.fit.AbstractFitEngine.FitData1D.add_notes"> 
    180 <tt class="descname">add_notes</tt><big>(</big><em>message=''</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.add_notes" title="Permalink to this definition">¶</a></dt> 
     641<tt class="descname">add_notes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.add_notes" title="Permalink to this definition">¶</a></dt> 
    181642<dd><p>Add notes to datainfo</p> 
    182643</dd></dl> 
    … …  
    189650<dl class="method"> 
    190651<dt id="sans.fit.AbstractFitEngine.FitData1D.clone_without_data"> 
    191 <tt class="descname">clone_without_data</tt><big>(</big><em>length=0</em>, <em>clone=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.clone_without_data" title="Permalink to this definition">¶</a></dt> 
     652<tt class="descname">clone_without_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.clone_without_data" title="Permalink to this definition">¶</a></dt> 
    192653<dd><p>Clone the current object, without copying the data (which 
    193654will be filled out by a subsequent operation). 
    … …  
    197658<col class="field-body" /> 
    198659<tbody valign="top"> 
    199 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     660<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    200661<li><strong>length</strong> &#8211; length of the data array to be initialized</li> 
    201662<li><strong>clone</strong> &#8211; if provided, the data will be copied to clone</li> 
    … …  
    207668</dd></dl> 
    208669 
     670<dl class="attribute"> 
     671<dt id="sans.fit.AbstractFitEngine.FitData1D.collimation"> 
     672<tt class="descname">collimation</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.collimation" title="Permalink to this definition">¶</a></dt> 
     673<dd></dd></dl> 
     674 
     675<dl class="attribute"> 
     676<dt id="sans.fit.AbstractFitEngine.FitData1D.detector"> 
     677<tt class="descname">detector</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.detector" title="Permalink to this definition">¶</a></dt> 
     678<dd></dd></dl> 
     679 
     680<dl class="attribute"> 
     681<dt id="sans.fit.AbstractFitEngine.FitData1D.dx"> 
     682<tt class="descname">dx</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.dx" title="Permalink to this definition">¶</a></dt> 
     683<dd></dd></dl> 
     684 
     685<dl class="attribute"> 
     686<dt id="sans.fit.AbstractFitEngine.FitData1D.dxl"> 
     687<tt class="descname">dxl</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.dxl" title="Permalink to this definition">¶</a></dt> 
     688<dd></dd></dl> 
     689 
     690<dl class="attribute"> 
     691<dt id="sans.fit.AbstractFitEngine.FitData1D.dxw"> 
     692<tt class="descname">dxw</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.dxw" title="Permalink to this definition">¶</a></dt> 
     693<dd></dd></dl> 
     694 
     695<dl class="attribute"> 
     696<dt id="sans.fit.AbstractFitEngine.FitData1D.dy"> 
     697<tt class="descname">dy</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.dy" title="Permalink to this definition">¶</a></dt> 
     698<dd></dd></dl> 
     699 
     700<dl class="attribute"> 
     701<dt id="sans.fit.AbstractFitEngine.FitData1D.errors"> 
     702<tt class="descname">errors</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.errors" title="Permalink to this definition">¶</a></dt> 
     703<dd></dd></dl> 
     704 
     705<dl class="attribute"> 
     706<dt id="sans.fit.AbstractFitEngine.FitData1D.filename"> 
     707<tt class="descname">filename</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.filename" title="Permalink to this definition">¶</a></dt> 
     708<dd></dd></dl> 
     709 
    209710<dl class="method"> 
    210711<dt id="sans.fit.AbstractFitEngine.FitData1D.get_fit_range"> 
    … …  
    213714</dd></dl> 
    214715 
     716<dl class="attribute"> 
     717<dt id="sans.fit.AbstractFitEngine.FitData1D.instrument"> 
     718<tt class="descname">instrument</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.instrument" title="Permalink to this definition">¶</a></dt> 
     719<dd></dd></dl> 
     720 
    215721<dl class="method"> 
    216722<dt id="sans.fit.AbstractFitEngine.FitData1D.is_slit_smeared"> 
    … …  
    221727<col class="field-body" /> 
    222728<tbody valign="top"> 
    223 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">True is slit smearing info is present, False otherwise</td> 
    224 </tr> 
    225 </tbody> 
    226 </table> 
    227 </dd></dl> 
     729<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True is slit smearing info is present, False otherwise</td> 
     730</tr> 
     731</tbody> 
     732</table> 
     733</dd></dl> 
     734 
     735<dl class="attribute"> 
     736<dt id="sans.fit.AbstractFitEngine.FitData1D.meta_data"> 
     737<tt class="descname">meta_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.meta_data" title="Permalink to this definition">¶</a></dt> 
     738<dd></dd></dl> 
     739 
     740<dl class="attribute"> 
     741<dt id="sans.fit.AbstractFitEngine.FitData1D.notes"> 
     742<tt class="descname">notes</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.notes" title="Permalink to this definition">¶</a></dt> 
     743<dd></dd></dl> 
     744 
     745<dl class="attribute"> 
     746<dt id="sans.fit.AbstractFitEngine.FitData1D.process"> 
     747<tt class="descname">process</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.process" title="Permalink to this definition">¶</a></dt> 
     748<dd></dd></dl> 
    228749 
    229750<dl class="method"> 
    230751<dt id="sans.fit.AbstractFitEngine.FitData1D.residuals"> 
    231 <tt class="descname">residuals</tt><big>(</big><em>fn</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.residuals" title="Permalink to this definition">¶</a></dt> 
     752<tt class="descname">residuals</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.residuals" title="Permalink to this definition">¶</a></dt> 
    232753<dd><p>Compute residuals.</p> 
    233754<p>If self.smearer has been set, use if to smear 
    … …  
    237758<col class="field-body" /> 
    238759<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> 
     760<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>fn</strong> &#8211; function that return model value</td> 
     761</tr> 
     762<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">residuals</td> 
    242763</tr> 
    243764</tbody> 
    … …  
    247768<dl class="method"> 
    248769<dt id="sans.fit.AbstractFitEngine.FitData1D.residuals_deriv"> 
    249 <tt class="descname">residuals_deriv</tt><big>(</big><em>model</em>, <em>pars=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.residuals_deriv" title="Permalink to this definition">¶</a></dt> 
     770<tt class="descname">residuals_deriv</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.residuals_deriv" title="Permalink to this definition">¶</a></dt> 
    250771<dd><table class="docutils field-list" frame="void" rules="none"> 
    251772<col class="field-name" /> 
    252773<col class="field-body" /> 
    253774<tbody valign="top"> 
    254 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">residuals derivatives .</td> 
    255 </tr> 
    256 <tr class="field"><th class="field-name">Note :</th><td class="field-body">in this case just return empty array</td> 
    257 </tr> 
    258 </tbody> 
    259 </table> 
    260 </dd></dl> 
     775<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">residuals derivatives .</td> 
     776</tr> 
     777<tr class="field-even field"><th class="field-name">Note :</th><td class="field-body">in this case just return empty array</td> 
     778</tr> 
     779</tbody> 
     780</table> 
     781</dd></dl> 
     782 
     783<dl class="attribute"> 
     784<dt id="sans.fit.AbstractFitEngine.FitData1D.run"> 
     785<tt class="descname">run</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.run" title="Permalink to this definition">¶</a></dt> 
     786<dd></dd></dl> 
     787 
     788<dl class="attribute"> 
     789<dt id="sans.fit.AbstractFitEngine.FitData1D.run_name"> 
     790<tt class="descname">run_name</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.run_name" title="Permalink to this definition">¶</a></dt> 
     791<dd></dd></dl> 
     792 
     793<dl class="attribute"> 
     794<dt id="sans.fit.AbstractFitEngine.FitData1D.sample"> 
     795<tt class="descname">sample</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.sample" title="Permalink to this definition">¶</a></dt> 
     796<dd></dd></dl> 
    261797 
    262798<dl class="method"> 
    263799<dt id="sans.fit.AbstractFitEngine.FitData1D.set_fit_range"> 
    264 <tt class="descname">set_fit_range</tt><big>(</big><em>qmin=None</em>, <em>qmax=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.set_fit_range" title="Permalink to this definition">¶</a></dt> 
     800<tt class="descname">set_fit_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.set_fit_range" title="Permalink to this definition">¶</a></dt> 
    265801<dd><p>to set the fit range</p> 
    266802</dd></dl> 
    267803 
     804<dl class="attribute"> 
     805<dt id="sans.fit.AbstractFitEngine.FitData1D.source"> 
     806<tt class="descname">source</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.source" title="Permalink to this definition">¶</a></dt> 
     807<dd></dd></dl> 
     808 
     809<dl class="attribute"> 
     810<dt id="sans.fit.AbstractFitEngine.FitData1D.title"> 
     811<tt class="descname">title</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.title" title="Permalink to this definition">¶</a></dt> 
     812<dd></dd></dl> 
     813 
     814<dl class="attribute"> 
     815<dt id="sans.fit.AbstractFitEngine.FitData1D.x"> 
     816<tt class="descname">x</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.x" title="Permalink to this definition">¶</a></dt> 
     817<dd></dd></dl> 
     818 
     819<dl class="attribute"> 
     820<dt id="sans.fit.AbstractFitEngine.FitData1D.x_unit"> 
     821<tt class="descname">x_unit</tt><em class="property"> = '1/A'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.x_unit" title="Permalink to this definition">¶</a></dt> 
     822<dd></dd></dl> 
     823 
    268824<dl class="method"> 
    269825<dt id="sans.fit.AbstractFitEngine.FitData1D.xaxis"> 
    270 <tt class="descname">xaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.xaxis" title="Permalink to this definition">¶</a></dt> 
     826<tt class="descname">xaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.xaxis" title="Permalink to this definition">¶</a></dt> 
    271827<dd><p>set the x axis label and unit</p> 
    272828</dd></dl> 
    273829 
     830<dl class="attribute"> 
     831<dt id="sans.fit.AbstractFitEngine.FitData1D.y"> 
     832<tt class="descname">y</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.y" title="Permalink to this definition">¶</a></dt> 
     833<dd></dd></dl> 
     834 
     835<dl class="attribute"> 
     836<dt id="sans.fit.AbstractFitEngine.FitData1D.y_unit"> 
     837<tt class="descname">y_unit</tt><em class="property"> = '1/cm'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.y_unit" title="Permalink to this definition">¶</a></dt> 
     838<dd></dd></dl> 
     839 
    274840<dl class="method"> 
    275841<dt id="sans.fit.AbstractFitEngine.FitData1D.yaxis"> 
    276 <tt class="descname">yaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.yaxis" title="Permalink to this definition">¶</a></dt> 
     842<tt class="descname">yaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData1D.yaxis" title="Permalink to this definition">¶</a></dt> 
    277843<dd><p>set the y axis label and unit</p> 
    278844</dd></dl> 
    … …  
    282848<dl class="class"> 
    283849<dt id="sans.fit.AbstractFitEngine.FitData2D"> 
    284 <em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitData2D</tt><big>(</big><em>sans_data2d</em>, <em>data=None</em>, <em>err_data=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D" title="Permalink to this definition">¶</a></dt> 
     850<em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">FitData2D</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D" title="Permalink to this definition">¶</a></dt> 
    285851<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.dataloader.data_info.Data2D</span></tt></p> 
    286852<p>Wrapper class  for SANS data</p> 
     853<dl class="attribute"> 
     854<dt id="sans.fit.AbstractFitEngine.FitData2D.I_unit"> 
     855<tt class="descname">I_unit</tt><em class="property"> = '1/cm'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.I_unit" title="Permalink to this definition">¶</a></dt> 
     856<dd></dd></dl> 
     857 
     858<dl class="attribute"> 
     859<dt id="sans.fit.AbstractFitEngine.FitData2D.Q_unit"> 
     860<tt class="descname">Q_unit</tt><em class="property"> = '1/A'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.Q_unit" title="Permalink to this definition">¶</a></dt> 
     861<dd></dd></dl> 
     862 
     863<dl class="method"> 
     864<dt id="sans.fit.AbstractFitEngine.FitData2D.__add__"> 
     865<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__add__" title="Permalink to this definition">¶</a></dt> 
     866<dd><p>Add two data sets</p> 
     867<table class="docutils field-list" frame="void" rules="none"> 
     868<col class="field-name" /> 
     869<col class="field-body" /> 
     870<tbody valign="top"> 
     871<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> &#8211; data set to add to the current one</td> 
     872</tr> 
     873<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> 
     874</tr> 
     875<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     876<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">raised when two data sets are incompatible</td> 
     877</tr> 
     878</tbody> 
     879</table> 
     880</dd></dl> 
     881 
     882<dl class="method"> 
     883<dt id="sans.fit.AbstractFitEngine.FitData2D.__div__"> 
     884<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__div__" title="Permalink to this definition">¶</a></dt> 
     885<dd><p>Divided a data set by another</p> 
     886<table class="docutils field-list" frame="void" rules="none"> 
     887<col class="field-name" /> 
     888<col class="field-body" /> 
     889<tbody valign="top"> 
     890<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> &#8211; data set that the current one is divided by</td> 
     891</tr> 
     892<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> 
     893</tr> 
     894<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     895<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">raised when two data sets are incompatible</td> 
     896</tr> 
     897</tbody> 
     898</table> 
     899</dd></dl> 
     900 
     901<dl class="method"> 
     902<dt id="sans.fit.AbstractFitEngine.FitData2D.__init__"> 
     903<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__init__" title="Permalink to this definition">¶</a></dt> 
     904<dd></dd></dl> 
     905 
     906<dl class="attribute"> 
     907<dt id="sans.fit.AbstractFitEngine.FitData2D.__module__"> 
     908<tt class="descname">__module__</tt><em class="property"> = 'sans.fit.AbstractFitEngine'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__module__" title="Permalink to this definition">¶</a></dt> 
     909<dd></dd></dl> 
     910 
     911<dl class="method"> 
     912<dt id="sans.fit.AbstractFitEngine.FitData2D.__mul__"> 
     913<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__mul__" title="Permalink to this definition">¶</a></dt> 
     914<dd><p>Multiply two data sets</p> 
     915<table class="docutils field-list" frame="void" rules="none"> 
     916<col class="field-name" /> 
     917<col class="field-body" /> 
     918<tbody valign="top"> 
     919<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> &#8211; data set to subtract from the current one</td> 
     920</tr> 
     921<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> 
     922</tr> 
     923<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     924<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">raised when two data sets are incompatible</td> 
     925</tr> 
     926</tbody> 
     927</table> 
     928</dd></dl> 
     929 
     930<dl class="method"> 
     931<dt id="sans.fit.AbstractFitEngine.FitData2D.__radd__"> 
     932<tt class="descname">__radd__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__radd__" title="Permalink to this definition">¶</a></dt> 
     933<dd><p>Add two data sets</p> 
     934<table class="docutils field-list" frame="void" rules="none"> 
     935<col class="field-name" /> 
     936<col class="field-body" /> 
     937<tbody valign="top"> 
     938<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> &#8211; data set to add to the current one</td> 
     939</tr> 
     940<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> 
     941</tr> 
     942<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     943<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">raised when two data sets are incompatible</td> 
     944</tr> 
     945</tbody> 
     946</table> 
     947</dd></dl> 
     948 
     949<dl class="method"> 
     950<dt id="sans.fit.AbstractFitEngine.FitData2D.__rdiv__"> 
     951<tt class="descname">__rdiv__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__rdiv__" title="Permalink to this definition">¶</a></dt> 
     952<dd><p>Divided a data set by another</p> 
     953<table class="docutils field-list" frame="void" rules="none"> 
     954<col class="field-name" /> 
     955<col class="field-body" /> 
     956<tbody valign="top"> 
     957<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> &#8211; data set that the current one is divided by</td> 
     958</tr> 
     959<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> 
     960</tr> 
     961<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     962<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">raised when two data sets are incompatible</td> 
     963</tr> 
     964</tbody> 
     965</table> 
     966</dd></dl> 
     967 
     968<dl class="method"> 
     969<dt id="sans.fit.AbstractFitEngine.FitData2D.__rmul__"> 
     970<tt class="descname">__rmul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__rmul__" title="Permalink to this definition">¶</a></dt> 
     971<dd><p>Multiply two data sets</p> 
     972<table class="docutils field-list" frame="void" rules="none"> 
     973<col class="field-name" /> 
     974<col class="field-body" /> 
     975<tbody valign="top"> 
     976<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> &#8211; data set to subtract from the current one</td> 
     977</tr> 
     978<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> 
     979</tr> 
     980<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     981<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">raised when two data sets are incompatible</td> 
     982</tr> 
     983</tbody> 
     984</table> 
     985</dd></dl> 
     986 
     987<dl class="method"> 
     988<dt id="sans.fit.AbstractFitEngine.FitData2D.__rsub__"> 
     989<tt class="descname">__rsub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__rsub__" title="Permalink to this definition">¶</a></dt> 
     990<dd><p>Subtract two data sets</p> 
     991<table class="docutils field-list" frame="void" rules="none"> 
     992<col class="field-name" /> 
     993<col class="field-body" /> 
     994<tbody valign="top"> 
     995<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> &#8211; data set to subtract from the current one</td> 
     996</tr> 
     997<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> 
     998</tr> 
     999<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     1000<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">raised when two data sets are incompatible</td> 
     1001</tr> 
     1002</tbody> 
     1003</table> 
     1004</dd></dl> 
     1005 
     1006<dl class="method"> 
     1007<dt id="sans.fit.AbstractFitEngine.FitData2D.__str__"> 
     1008<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__str__" title="Permalink to this definition">¶</a></dt> 
     1009<dd></dd></dl> 
     1010 
     1011<dl class="method"> 
     1012<dt id="sans.fit.AbstractFitEngine.FitData2D.__sub__"> 
     1013<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.__sub__" title="Permalink to this definition">¶</a></dt> 
     1014<dd><p>Subtract two data sets</p> 
     1015<table class="docutils field-list" frame="void" rules="none"> 
     1016<col class="field-name" /> 
     1017<col class="field-body" /> 
     1018<tbody valign="top"> 
     1019<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> &#8211; data set to subtract from the current one</td> 
     1020</tr> 
     1021<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">new data set</td> 
     1022</tr> 
     1023<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     1024<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">raised when two data sets are incompatible</td> 
     1025</tr> 
     1026</tbody> 
     1027</table> 
     1028</dd></dl> 
     1029 
     1030<dl class="method"> 
     1031<dt id="sans.fit.AbstractFitEngine.FitData2D._perform_operation"> 
     1032<tt class="descname">_perform_operation</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D._perform_operation" title="Permalink to this definition">¶</a></dt> 
     1033<dd><p>Perform 2D operations between data sets</p> 
     1034<table class="docutils field-list" frame="void" rules="none"> 
     1035<col class="field-name" /> 
     1036<col class="field-body" /> 
     1037<tbody valign="top"> 
     1038<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     1039<li><strong>other</strong> &#8211; other data set</li> 
     1040<li><strong>operation</strong> &#8211; function defining the operation</li> 
     1041</ul> 
     1042</td> 
     1043</tr> 
     1044</tbody> 
     1045</table> 
     1046</dd></dl> 
     1047 
     1048<dl class="method"> 
     1049<dt id="sans.fit.AbstractFitEngine.FitData2D._validity_check"> 
     1050<tt class="descname">_validity_check</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D._validity_check" title="Permalink to this definition">¶</a></dt> 
     1051<dd><p>Checks that the data lengths are compatible. 
     1052Checks that the x vectors are compatible. 
     1053Returns errors vectors equal to original 
     1054errors vectors if they were present or vectors 
     1055of zeros when none was found.</p> 
     1056<table class="docutils field-list" frame="void" rules="none"> 
     1057<col class="field-name" /> 
     1058<col class="field-body" /> 
     1059<tbody valign="top"> 
     1060<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>other</strong> &#8211; other data set for operation</td> 
     1061</tr> 
     1062<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">dy for self, dy for other [numpy arrays]</td> 
     1063</tr> 
     1064<tr class="field-odd field"><th class="field-name" colspan="2">Raises ValueError:</th></tr> 
     1065<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">when lengths are not compatible</td> 
     1066</tr> 
     1067</tbody> 
     1068</table> 
     1069</dd></dl> 
     1070 
     1071<dl class="attribute"> 
     1072<dt id="sans.fit.AbstractFitEngine.FitData2D._xaxis"> 
     1073<tt class="descname">_xaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D._xaxis" title="Permalink to this definition">¶</a></dt> 
     1074<dd></dd></dl> 
     1075 
     1076<dl class="attribute"> 
     1077<dt id="sans.fit.AbstractFitEngine.FitData2D._xunit"> 
     1078<tt class="descname">_xunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D._xunit" title="Permalink to this definition">¶</a></dt> 
     1079<dd></dd></dl> 
     1080 
     1081<dl class="attribute"> 
     1082<dt id="sans.fit.AbstractFitEngine.FitData2D._yaxis"> 
     1083<tt class="descname">_yaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D._yaxis" title="Permalink to this definition">¶</a></dt> 
     1084<dd></dd></dl> 
     1085 
     1086<dl class="attribute"> 
     1087<dt id="sans.fit.AbstractFitEngine.FitData2D._yunit"> 
     1088<tt class="descname">_yunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D._yunit" title="Permalink to this definition">¶</a></dt> 
     1089<dd></dd></dl> 
     1090 
     1091<dl class="attribute"> 
     1092<dt id="sans.fit.AbstractFitEngine.FitData2D._zaxis"> 
     1093<tt class="descname">_zaxis</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D._zaxis" title="Permalink to this definition">¶</a></dt> 
     1094<dd></dd></dl> 
     1095 
     1096<dl class="attribute"> 
     1097<dt id="sans.fit.AbstractFitEngine.FitData2D._zunit"> 
     1098<tt class="descname">_zunit</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D._zunit" title="Permalink to this definition">¶</a></dt> 
     1099<dd></dd></dl> 
     1100 
    2871101<dl class="method"> 
    2881102<dt id="sans.fit.AbstractFitEngine.FitData2D.add_notes"> 
    289 <tt class="descname">add_notes</tt><big>(</big><em>message=''</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.add_notes" title="Permalink to this definition">¶</a></dt> 
     1103<tt class="descname">add_notes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.add_notes" title="Permalink to this definition">¶</a></dt> 
    2901104<dd><p>Add notes to datainfo</p> 
    2911105</dd></dl> 
    … …  
    2981112<dl class="method"> 
    2991113<dt id="sans.fit.AbstractFitEngine.FitData2D.clone_without_data"> 
    300 <tt class="descname">clone_without_data</tt><big>(</big><em>length=0</em>, <em>clone=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.clone_without_data" title="Permalink to this definition">¶</a></dt> 
     1114<tt class="descname">clone_without_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.clone_without_data" title="Permalink to this definition">¶</a></dt> 
    3011115<dd><p>Clone the current object, without copying the data (which 
    3021116will be filled out by a subsequent operation). 
    … …  
    3061120<col class="field-body" /> 
    3071121<tbody valign="top"> 
    308 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     1122<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    3091123<li><strong>length</strong> &#8211; length of the data array to be initialized</li> 
    3101124<li><strong>clone</strong> &#8211; if provided, the data will be copied to clone</li> 
    … …  
    3161130</dd></dl> 
    3171131 
     1132<dl class="attribute"> 
     1133<dt id="sans.fit.AbstractFitEngine.FitData2D.collimation"> 
     1134<tt class="descname">collimation</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.collimation" title="Permalink to this definition">¶</a></dt> 
     1135<dd></dd></dl> 
     1136 
     1137<dl class="attribute"> 
     1138<dt id="sans.fit.AbstractFitEngine.FitData2D.data"> 
     1139<tt class="descname">data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.data" title="Permalink to this definition">¶</a></dt> 
     1140<dd></dd></dl> 
     1141 
     1142<dl class="attribute"> 
     1143<dt id="sans.fit.AbstractFitEngine.FitData2D.detector"> 
     1144<tt class="descname">detector</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.detector" title="Permalink to this definition">¶</a></dt> 
     1145<dd></dd></dl> 
     1146 
     1147<dl class="attribute"> 
     1148<dt id="sans.fit.AbstractFitEngine.FitData2D.dqx_data"> 
     1149<tt class="descname">dqx_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.dqx_data" title="Permalink to this definition">¶</a></dt> 
     1150<dd></dd></dl> 
     1151 
     1152<dl class="attribute"> 
     1153<dt id="sans.fit.AbstractFitEngine.FitData2D.dqy_data"> 
     1154<tt class="descname">dqy_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.dqy_data" title="Permalink to this definition">¶</a></dt> 
     1155<dd></dd></dl> 
     1156 
     1157<dl class="attribute"> 
     1158<dt id="sans.fit.AbstractFitEngine.FitData2D.err_data"> 
     1159<tt class="descname">err_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.err_data" title="Permalink to this definition">¶</a></dt> 
     1160<dd></dd></dl> 
     1161 
     1162<dl class="attribute"> 
     1163<dt id="sans.fit.AbstractFitEngine.FitData2D.errors"> 
     1164<tt class="descname">errors</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.errors" title="Permalink to this definition">¶</a></dt> 
     1165<dd></dd></dl> 
     1166 
     1167<dl class="attribute"> 
     1168<dt id="sans.fit.AbstractFitEngine.FitData2D.filename"> 
     1169<tt class="descname">filename</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.filename" title="Permalink to this definition">¶</a></dt> 
     1170<dd></dd></dl> 
     1171 
    3181172<dl class="method"> 
    3191173<dt id="sans.fit.AbstractFitEngine.FitData2D.get_fit_range"> 
    … …  
    3221176</dd></dl> 
    3231177 
     1178<dl class="attribute"> 
     1179<dt id="sans.fit.AbstractFitEngine.FitData2D.instrument"> 
     1180<tt class="descname">instrument</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.instrument" title="Permalink to this definition">¶</a></dt> 
     1181<dd></dd></dl> 
     1182 
     1183<dl class="attribute"> 
     1184<dt id="sans.fit.AbstractFitEngine.FitData2D.mask"> 
     1185<tt class="descname">mask</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.mask" title="Permalink to this definition">¶</a></dt> 
     1186<dd></dd></dl> 
     1187 
     1188<dl class="attribute"> 
     1189<dt id="sans.fit.AbstractFitEngine.FitData2D.meta_data"> 
     1190<tt class="descname">meta_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.meta_data" title="Permalink to this definition">¶</a></dt> 
     1191<dd></dd></dl> 
     1192 
     1193<dl class="attribute"> 
     1194<dt id="sans.fit.AbstractFitEngine.FitData2D.notes"> 
     1195<tt class="descname">notes</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.notes" title="Permalink to this definition">¶</a></dt> 
     1196<dd></dd></dl> 
     1197 
     1198<dl class="attribute"> 
     1199<dt id="sans.fit.AbstractFitEngine.FitData2D.process"> 
     1200<tt class="descname">process</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.process" title="Permalink to this definition">¶</a></dt> 
     1201<dd></dd></dl> 
     1202 
     1203<dl class="attribute"> 
     1204<dt id="sans.fit.AbstractFitEngine.FitData2D.q_data"> 
     1205<tt class="descname">q_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.q_data" title="Permalink to this definition">¶</a></dt> 
     1206<dd></dd></dl> 
     1207 
     1208<dl class="attribute"> 
     1209<dt id="sans.fit.AbstractFitEngine.FitData2D.qx_data"> 
     1210<tt class="descname">qx_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.qx_data" title="Permalink to this definition">¶</a></dt> 
     1211<dd></dd></dl> 
     1212 
     1213<dl class="attribute"> 
     1214<dt id="sans.fit.AbstractFitEngine.FitData2D.qy_data"> 
     1215<tt class="descname">qy_data</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.qy_data" title="Permalink to this definition">¶</a></dt> 
     1216<dd></dd></dl> 
     1217 
    3241218<dl class="method"> 
    3251219<dt id="sans.fit.AbstractFitEngine.FitData2D.residuals"> 
    326 <tt class="descname">residuals</tt><big>(</big><em>fn</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.residuals" title="Permalink to this definition">¶</a></dt> 
     1220<tt class="descname">residuals</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.residuals" title="Permalink to this definition">¶</a></dt> 
    3271221<dd><p>return the residuals</p> 
    3281222</dd></dl> 
    … …  
    3301224<dl class="method"> 
    3311225<dt id="sans.fit.AbstractFitEngine.FitData2D.residuals_deriv"> 
    332 <tt class="descname">residuals_deriv</tt><big>(</big><em>model</em>, <em>pars=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.residuals_deriv" title="Permalink to this definition">¶</a></dt> 
     1226<tt class="descname">residuals_deriv</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.residuals_deriv" title="Permalink to this definition">¶</a></dt> 
    3331227<dd><table class="docutils field-list" frame="void" rules="none"> 
    3341228<col class="field-name" /> 
    3351229<col class="field-body" /> 
    3361230<tbody valign="top"> 
    337 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">residuals derivatives .</td> 
    338 </tr> 
    339 <tr class="field"><th class="field-name">Note :</th><td class="field-body">in this case just return empty array</td> 
    340 </tr> 
    341 </tbody> 
    342 </table> 
    343 </dd></dl> 
     1231<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">residuals derivatives .</td> 
     1232</tr> 
     1233<tr class="field-even field"><th class="field-name">Note :</th><td class="field-body">in this case just return empty array</td> 
     1234</tr> 
     1235</tbody> 
     1236</table> 
     1237</dd></dl> 
     1238 
     1239<dl class="attribute"> 
     1240<dt id="sans.fit.AbstractFitEngine.FitData2D.run"> 
     1241<tt class="descname">run</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.run" title="Permalink to this definition">¶</a></dt> 
     1242<dd></dd></dl> 
     1243 
     1244<dl class="attribute"> 
     1245<dt id="sans.fit.AbstractFitEngine.FitData2D.run_name"> 
     1246<tt class="descname">run_name</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.run_name" title="Permalink to this definition">¶</a></dt> 
     1247<dd></dd></dl> 
     1248 
     1249<dl class="attribute"> 
     1250<dt id="sans.fit.AbstractFitEngine.FitData2D.sample"> 
     1251<tt class="descname">sample</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.sample" title="Permalink to this definition">¶</a></dt> 
     1252<dd></dd></dl> 
    3441253 
    3451254<dl class="method"> 
    3461255<dt id="sans.fit.AbstractFitEngine.FitData2D.set_data"> 
    347 <tt class="descname">set_data</tt><big>(</big><em>sans_data2d</em>, <em>qmin=None</em>, <em>qmax=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.set_data" title="Permalink to this definition">¶</a></dt> 
     1256<tt class="descname">set_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.set_data" title="Permalink to this definition">¶</a></dt> 
    3481257<dd><p>Determine the correct qx_data and qy_data within range to fit</p> 
    3491258</dd></dl> 
    … …  
    3511260<dl class="method"> 
    3521261<dt id="sans.fit.AbstractFitEngine.FitData2D.set_fit_range"> 
    353 <tt class="descname">set_fit_range</tt><big>(</big><em>qmin=None</em>, <em>qmax=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.set_fit_range" title="Permalink to this definition">¶</a></dt> 
     1262<tt class="descname">set_fit_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.set_fit_range" title="Permalink to this definition">¶</a></dt> 
    3541263<dd><p>to set the fit range</p> 
    3551264</dd></dl> 
    … …  
    3571266<dl class="method"> 
    3581267<dt id="sans.fit.AbstractFitEngine.FitData2D.set_smearer"> 
    359 <tt class="descname">set_smearer</tt><big>(</big><em>smearer</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.set_smearer" title="Permalink to this definition">¶</a></dt> 
     1268<tt class="descname">set_smearer</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.set_smearer" title="Permalink to this definition">¶</a></dt> 
    3601269<dd><p>Set smearer</p> 
    3611270</dd></dl> 
    3621271 
     1272<dl class="attribute"> 
     1273<dt id="sans.fit.AbstractFitEngine.FitData2D.source"> 
     1274<tt class="descname">source</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.source" title="Permalink to this definition">¶</a></dt> 
     1275<dd></dd></dl> 
     1276 
     1277<dl class="attribute"> 
     1278<dt id="sans.fit.AbstractFitEngine.FitData2D.title"> 
     1279<tt class="descname">title</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.title" title="Permalink to this definition">¶</a></dt> 
     1280<dd></dd></dl> 
     1281 
     1282<dl class="attribute"> 
     1283<dt id="sans.fit.AbstractFitEngine.FitData2D.x_bins"> 
     1284<tt class="descname">x_bins</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.x_bins" title="Permalink to this definition">¶</a></dt> 
     1285<dd></dd></dl> 
     1286 
    3631287<dl class="method"> 
    3641288<dt id="sans.fit.AbstractFitEngine.FitData2D.xaxis"> 
    365 <tt class="descname">xaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.xaxis" title="Permalink to this definition">¶</a></dt> 
     1289<tt class="descname">xaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.xaxis" title="Permalink to this definition">¶</a></dt> 
    3661290<dd><p>set the x axis label and unit</p> 
    3671291</dd></dl> 
    3681292 
     1293<dl class="attribute"> 
     1294<dt id="sans.fit.AbstractFitEngine.FitData2D.xmax"> 
     1295<tt class="descname">xmax</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.xmax" title="Permalink to this definition">¶</a></dt> 
     1296<dd></dd></dl> 
     1297 
     1298<dl class="attribute"> 
     1299<dt id="sans.fit.AbstractFitEngine.FitData2D.xmin"> 
     1300<tt class="descname">xmin</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.xmin" title="Permalink to this definition">¶</a></dt> 
     1301<dd></dd></dl> 
     1302 
     1303<dl class="attribute"> 
     1304<dt id="sans.fit.AbstractFitEngine.FitData2D.y_bins"> 
     1305<tt class="descname">y_bins</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.y_bins" title="Permalink to this definition">¶</a></dt> 
     1306<dd></dd></dl> 
     1307 
    3691308<dl class="method"> 
    3701309<dt id="sans.fit.AbstractFitEngine.FitData2D.yaxis"> 
    371 <tt class="descname">yaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.yaxis" title="Permalink to this definition">¶</a></dt> 
     1310<tt class="descname">yaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.yaxis" title="Permalink to this definition">¶</a></dt> 
    3721311<dd><p>set the y axis label and unit</p> 
    3731312</dd></dl> 
    3741313 
     1314<dl class="attribute"> 
     1315<dt id="sans.fit.AbstractFitEngine.FitData2D.ymax"> 
     1316<tt class="descname">ymax</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.ymax" title="Permalink to this definition">¶</a></dt> 
     1317<dd></dd></dl> 
     1318 
     1319<dl class="attribute"> 
     1320<dt id="sans.fit.AbstractFitEngine.FitData2D.ymin"> 
     1321<tt class="descname">ymin</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.ymin" title="Permalink to this definition">¶</a></dt> 
     1322<dd></dd></dl> 
     1323 
    3751324<dl class="method"> 
    3761325<dt id="sans.fit.AbstractFitEngine.FitData2D.zaxis"> 
    377 <tt class="descname">zaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.zaxis" title="Permalink to this definition">¶</a></dt> 
     1326<tt class="descname">zaxis</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitData2D.zaxis" title="Permalink to this definition">¶</a></dt> 
    3781327<dd><p>set the z axis label and unit</p> 
    3791328</dd></dl> 
    … …  
    3851334<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> 
    3861335<dd><dl class="method"> 
     1336<dt id="sans.fit.AbstractFitEngine.FitEngine.__init__"> 
     1337<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.__init__" title="Permalink to this definition">¶</a></dt> 
     1338<dd><p>Base class for scipy and park fit engine</p> 
     1339</dd></dl> 
     1340 
     1341<dl class="attribute"> 
     1342<dt id="sans.fit.AbstractFitEngine.FitEngine.__module__"> 
     1343<tt class="descname">__module__</tt><em class="property"> = 'sans.fit.AbstractFitEngine'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.__module__" title="Permalink to this definition">¶</a></dt> 
     1344<dd></dd></dl> 
     1345 
     1346<dl class="method"> 
    3871347<dt id="sans.fit.AbstractFitEngine.FitEngine.get_model"> 
    388 <tt class="descname">get_model</tt><big>(</big><em>id</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.get_model" title="Permalink to this definition">¶</a></dt> 
     1348<tt class="descname">get_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.get_model" title="Permalink to this definition">¶</a></dt> 
    3891349<dd><table class="docutils field-list" frame="void" rules="none"> 
    3901350<col class="field-name" /> 
    3911351<col class="field-body" /> 
    3921352<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  
     1353<tr class="field-odd 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> 
     1354</tr> 
     1355<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a model at this id or None if no FitArrange element was  
    3961356created with this id</td> 
    3971357</tr> 
    … …  
    4021362<dl class="method"> 
    4031363<dt id="sans.fit.AbstractFitEngine.FitEngine.get_problem_to_fit"> 
    404 <tt class="descname">get_problem_to_fit</tt><big>(</big><em>id</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.get_problem_to_fit" title="Permalink to this definition">¶</a></dt> 
     1364<tt class="descname">get_problem_to_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.get_problem_to_fit" title="Permalink to this definition">¶</a></dt> 
    4051365<dd><p>return the self.selected value of the fit problem of id</p> 
    4061366<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    4081368<col class="field-body" /> 
    4091369<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> 
     1370<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> &#8211; the id of the problem</td> 
    4111371</tr> 
    4121372</tbody> 
    … …  
    4161376<dl class="method"> 
    4171377<dt id="sans.fit.AbstractFitEngine.FitEngine.remove_fit_problem"> 
    418 <tt class="descname">remove_fit_problem</tt><big>(</big><em>id</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.remove_fit_problem" title="Permalink to this definition">¶</a></dt> 
     1378<tt class="descname">remove_fit_problem</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.remove_fit_problem" title="Permalink to this definition">¶</a></dt> 
    4191379<dd><p>remove   fitarrange in id</p> 
    4201380</dd></dl> 
    … …  
    4221382<dl class="method"> 
    4231383<dt id="sans.fit.AbstractFitEngine.FitEngine.select_problem_for_fit"> 
    424 <tt class="descname">select_problem_for_fit</tt><big>(</big><em>id</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.select_problem_for_fit" title="Permalink to this definition">¶</a></dt> 
     1384<tt class="descname">select_problem_for_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.select_problem_for_fit" title="Permalink to this definition">¶</a></dt> 
    4251385<dd><p>select a couple of model and data at the id position in dictionary 
    4261386and set in self.selected value to value</p> 
    … …  
    4291389<col class="field-body" /> 
    4301390<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.  
     1391<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> &#8211; the value to allow fitting.  
    4321392can only have the value one or zero</td> 
    4331393</tr> 
    … …  
    4381398<dl class="method"> 
    4391399<dt id="sans.fit.AbstractFitEngine.FitEngine.set_data"> 
    440 <tt class="descname">set_data</tt><big>(</big><em>data</em>, <em>id</em>, <em>smearer=None</em>, <em>qmin=None</em>, <em>qmax=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.set_data" title="Permalink to this definition">¶</a></dt> 
     1400<tt class="descname">set_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.set_data" title="Permalink to this definition">¶</a></dt> 
    4411401<dd><p>Receives plottable, creates a list of data to fit,set data 
    4421402in a FitArrange object and adds that object in a dictionary  
    … …  
    4461406<col class="field-body" /> 
    4471407<tbody valign="top"> 
    448 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     1408<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    4491409<li><strong>data</strong> &#8211; data added</li> 
    4501410<li><strong>id</strong> &#8211; unique key corresponding to a fitArrange object with data</li> 
    … …  
    4581418<dl class="method"> 
    4591419<dt id="sans.fit.AbstractFitEngine.FitEngine.set_model"> 
    460 <tt class="descname">set_model</tt><big>(</big><em>model</em>, <em>id</em>, <em>pars=</em><span class="optional">[</span><span class="optional">]</span>, <em>constraints=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.set_model" title="Permalink to this definition">¶</a></dt> 
     1420<tt class="descname">set_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.FitEngine.set_model" title="Permalink to this definition">¶</a></dt> 
    4611421<dd><p>set a model on a given  in the fit engine.</p> 
    4621422<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    4641424<col class="field-body" /> 
    4651425<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> 
     1426<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> &#8211; sans.models type</td> 
    4671427</tr> 
    4681428</tbody> 
    … …  
    4761436<col class="field-body" /> 
    4771437<tbody valign="top"> 
    478 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
     1438<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
    4791439<li><strong>pars</strong> &#8211; the list of parameters to fit</li> 
    4801440<li><strong>constraints</strong> &#8211; <p>list of  
    … …  
    4911451</td> 
    4921452</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> 
     1453<tr class="field-even field"><th class="field-name">Note :</th><td class="field-body"><p class="first last">pars must contains only name of existing model&#8217;s parameters</p> 
    4941454</td> 
    4951455</tr> 
    … …  
    5021462<dl class="class"> 
    5031463<dt id="sans.fit.AbstractFitEngine.Model"> 
    504 <em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">Model</tt><big>(</big><em>sans_model</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model" title="Permalink to this definition">¶</a></dt> 
     1464<em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">Model</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model" title="Permalink to this definition">¶</a></dt> 
    5051465<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">park.model.Model</span></tt></p> 
    5061466<p>PARK wrapper for SANS models.</p> 
    5071467<dl class="method"> 
     1468<dt id="sans.fit.AbstractFitEngine.Model.__call__"> 
     1469<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__call__" title="Permalink to this definition">¶</a></dt> 
     1470<dd></dd></dl> 
     1471 
     1472<dl class="attribute"> 
     1473<dt id="sans.fit.AbstractFitEngine.Model.__class__"> 
     1474<tt class="descname">__class__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__class__" title="Permalink to this definition">¶</a></dt> 
     1475<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">MetaModel</span></tt></p> 
     1476</dd></dl> 
     1477 
     1478<dl class="attribute"> 
     1479<dt id="sans.fit.AbstractFitEngine.Model.__delattr__"> 
     1480<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__delattr__" title="Permalink to this definition">¶</a></dt> 
     1481<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     1482</dd></dl> 
     1483 
     1484<dl class="attribute"> 
     1485<dt id="sans.fit.AbstractFitEngine.Model.__dict__"> 
     1486<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x020725F0&gt;</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__dict__" title="Permalink to this definition">¶</a></dt> 
     1487<dd></dd></dl> 
     1488 
     1489<dl class="attribute"> 
     1490<dt id="sans.fit.AbstractFitEngine.Model.__getattribute__"> 
     1491<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     1492<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     1493</dd></dl> 
     1494 
     1495<dl class="attribute"> 
     1496<dt id="sans.fit.AbstractFitEngine.Model.__hash__"> 
     1497<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__hash__" title="Permalink to this definition">¶</a></dt> 
     1498<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     1499</dd></dl> 
     1500 
     1501<dl class="method"> 
     1502<dt id="sans.fit.AbstractFitEngine.Model.__init__"> 
     1503<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__init__" title="Permalink to this definition">¶</a></dt> 
     1504<dd><table class="docutils field-list" frame="void" rules="none"> 
     1505<col class="field-name" /> 
     1506<col class="field-body" /> 
     1507<tbody valign="top"> 
     1508<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>sans_model</strong> &#8211; the sans model to wrap using park interface</td> 
     1509</tr> 
     1510</tbody> 
     1511</table> 
     1512</dd></dl> 
     1513 
     1514<dl class="attribute"> 
     1515<dt id="sans.fit.AbstractFitEngine.Model.__metaclass__"> 
     1516<tt class="descname">__metaclass__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__metaclass__" title="Permalink to this definition">¶</a></dt> 
     1517<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">MetaModel</span></tt></p> 
     1518</dd></dl> 
     1519 
     1520<dl class="attribute"> 
     1521<dt id="sans.fit.AbstractFitEngine.Model.__module__"> 
     1522<tt class="descname">__module__</tt><em class="property"> = 'sans.fit.AbstractFitEngine'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__module__" title="Permalink to this definition">¶</a></dt> 
     1523<dd></dd></dl> 
     1524 
     1525<dl class="staticmethod"> 
     1526<dt id="sans.fit.AbstractFitEngine.Model.__new__"> 
     1527<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__new__" title="Permalink to this definition">¶</a></dt> 
     1528<dd></dd></dl> 
     1529 
     1530<dl class="method"> 
     1531<dt id="sans.fit.AbstractFitEngine.Model.__reduce__"> 
     1532<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__reduce__" title="Permalink to this definition">¶</a></dt> 
     1533<dd><p>helper for pickle</p> 
     1534</dd></dl> 
     1535 
     1536<dl class="method"> 
     1537<dt id="sans.fit.AbstractFitEngine.Model.__reduce_ex__"> 
     1538<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     1539<dd><p>helper for pickle</p> 
     1540</dd></dl> 
     1541 
     1542<dl class="attribute"> 
     1543<dt id="sans.fit.AbstractFitEngine.Model.__repr__"> 
     1544<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__repr__" title="Permalink to this definition">¶</a></dt> 
     1545<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     1546</dd></dl> 
     1547 
     1548<dl class="attribute"> 
     1549<dt id="sans.fit.AbstractFitEngine.Model.__setattr__"> 
     1550<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__setattr__" title="Permalink to this definition">¶</a></dt> 
     1551<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     1552</dd></dl> 
     1553 
     1554<dl class="attribute"> 
     1555<dt id="sans.fit.AbstractFitEngine.Model.__str__"> 
     1556<tt class="descname">__str__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__str__" title="Permalink to this definition">¶</a></dt> 
     1557<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     1558</dd></dl> 
     1559 
     1560<dl class="attribute"> 
     1561<dt id="sans.fit.AbstractFitEngine.Model.__weakref__"> 
     1562<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.__weakref__" title="Permalink to this definition">¶</a></dt> 
     1563<dd><p>list of weak references to the object (if defined)</p> 
     1564</dd></dl> 
     1565 
     1566<dl class="attribute"> 
     1567<dt id="sans.fit.AbstractFitEngine.Model.derivatives"> 
     1568<tt class="descname">derivatives</tt><em class="property"> = []</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.derivatives" title="Permalink to this definition">¶</a></dt> 
     1569<dd></dd></dl> 
     1570 
     1571<dl class="method"> 
    5081572<dt id="sans.fit.AbstractFitEngine.Model.eval"> 
    509 <tt class="descname">eval</tt><big>(</big><em>x</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.eval" title="Permalink to this definition">¶</a></dt> 
     1573<tt class="descname">eval</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.eval" title="Permalink to this definition">¶</a></dt> 
    5101574<dd><p>override eval method of park model.</p> 
    5111575<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    5131577<col class="field-body" /> 
    5141578<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> 
     1579<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; the x value used to compute a function</td> 
    5161580</tr> 
    5171581</tbody> 
    … …  
    5211585<dl class="method"> 
    5221586<dt id="sans.fit.AbstractFitEngine.Model.eval_derivs"> 
    523 <tt class="descname">eval_derivs</tt><big>(</big><em>x</em>, <em>pars=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.eval_derivs" title="Permalink to this definition">¶</a></dt> 
     1587<tt class="descname">eval_derivs</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.eval_derivs" title="Permalink to this definition">¶</a></dt> 
    5241588<dd><p>Evaluate the model and derivatives wrt pars at x.</p> 
    5251589<p>pars is a list of the names of the parameters for which derivatives 
    … …  
    5331597<dl class="method"> 
    5341598<dt id="sans.fit.AbstractFitEngine.Model.get_params"> 
    535 <tt class="descname">get_params</tt><big>(</big><em>fitparams</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.get_params" title="Permalink to this definition">¶</a></dt> 
     1599<tt class="descname">get_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.get_params" title="Permalink to this definition">¶</a></dt> 
    5361600<dd><p>return a list of value of paramter to fit</p> 
    5371601<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    5391603<col class="field-body" /> 
    5401604<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> 
     1605<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>fitparams</strong> &#8211; list of paramaters name to fit</td> 
     1606</tr> 
     1607</tbody> 
     1608</table> 
     1609</dd></dl> 
     1610 
     1611<dl class="attribute"> 
     1612<dt id="sans.fit.AbstractFitEngine.Model.parameters"> 
     1613<tt class="descname">parameters</tt><em class="property"> = []</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.parameters" title="Permalink to this definition">¶</a></dt> 
     1614<dd></dd></dl> 
     1615 
     1616<dl class="attribute"> 
     1617<dt id="sans.fit.AbstractFitEngine.Model.parameterset"> 
     1618<tt class="descname">parameterset</tt><em class="property"> = []</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.parameterset" title="Permalink to this definition">¶</a></dt> 
     1619<dd></dd></dl> 
    5461620 
    5471621<dl class="method"> 
    5481622<dt id="sans.fit.AbstractFitEngine.Model.set"> 
    549 <tt class="descname">set</tt><big>(</big><em>**kw</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.set" title="Permalink to this definition">¶</a></dt> 
     1623<tt class="descname">set</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.set" title="Permalink to this definition">¶</a></dt> 
    5501624<dd><p>Set the initial value for a set of parameters.</p> 
    5511625<p>E.g., model.set(width=3,center=5)</p> 
    … …  
    5541628<dl class="method"> 
    5551629<dt id="sans.fit.AbstractFitEngine.Model.set_params"> 
    556 <tt class="descname">set_params</tt><big>(</big><em>paramlist</em>, <em>params</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.set_params" title="Permalink to this definition">¶</a></dt> 
     1630<tt class="descname">set_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.Model.set_params" title="Permalink to this definition">¶</a></dt> 
    5571631<dd><p>Set value for parameters to fit</p> 
    5581632<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    5601634<col class="field-body" /> 
    5611635<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> 
     1636<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>params</strong> &#8211; list of value for parameters to fit</td> 
    5631637</tr> 
    5641638</tbody> 
    … …  
    5701644<dl class="class"> 
    5711645<dt id="sans.fit.AbstractFitEngine.SansAssembly"> 
    572 <em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">SansAssembly</tt><big>(</big><em>paramlist</em>, <em>model=None</em>, <em>data=None</em>, <em>fitresult=None</em>, <em>handler=None</em>, <em>curr_thread=None</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansAssembly" title="Permalink to this definition">¶</a></dt> 
     1646<em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">SansAssembly</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansAssembly" title="Permalink to this definition">¶</a></dt> 
    5731647<dd><p>Sans Assembly class a class wrapper to be call in optimizer.leastsq method</p> 
     1648<dl class="method"> 
     1649<dt id="sans.fit.AbstractFitEngine.SansAssembly.__call__"> 
     1650<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansAssembly.__call__" title="Permalink to this definition">¶</a></dt> 
     1651<dd><p>Compute residuals</p> 
     1652<table class="docutils field-list" frame="void" rules="none"> 
     1653<col class="field-name" /> 
     1654<col class="field-body" /> 
     1655<tbody valign="top"> 
     1656<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>params</strong> &#8211; value of parameters to fit</td> 
     1657</tr> 
     1658</tbody> 
     1659</table> 
     1660</dd></dl> 
     1661 
     1662<dl class="method"> 
     1663<dt id="sans.fit.AbstractFitEngine.SansAssembly.__init__"> 
     1664<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansAssembly.__init__" title="Permalink to this definition">¶</a></dt> 
     1665<dd><table class="docutils field-list" frame="void" rules="none"> 
     1666<col class="field-name" /> 
     1667<col class="field-body" /> 
     1668<tbody valign="top"> 
     1669<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     1670<li><strong>Model</strong> &#8211; the model wrapper fro sans -model</li> 
     1671<li><strong>Data</strong> &#8211; the data wrapper for sans data</li> 
     1672</ul> 
     1673</td> 
     1674</tr> 
     1675</tbody> 
     1676</table> 
     1677</dd></dl> 
     1678 
     1679<dl class="attribute"> 
     1680<dt id="sans.fit.AbstractFitEngine.SansAssembly.__module__"> 
     1681<tt class="descname">__module__</tt><em class="property"> = 'sans.fit.AbstractFitEngine'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansAssembly.__module__" title="Permalink to this definition">¶</a></dt> 
     1682<dd></dd></dl> 
     1683 
    5741684<dl class="method"> 
    5751685<dt id="sans.fit.AbstractFitEngine.SansAssembly.check_param_range"> 
    … …  
    5891699<col class="field-body" /> 
    5901700<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> 
     1701<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>params</strong> &#8211; list of parameter values</td> 
     1702</tr> 
     1703<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">chi^2</td> 
    5941704</tr> 
    5951705</tbody> 
    … …  
    6011711<dl class="class"> 
    6021712<dt id="sans.fit.AbstractFitEngine.SansParameter"> 
    603 <em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">SansParameter</tt><big>(</big><em>name</em>, <em>model</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter" title="Permalink to this definition">¶</a></dt> 
     1713<em class="property">class </em><tt class="descclassname">sans.fit.AbstractFitEngine.</tt><tt class="descname">SansParameter</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter" title="Permalink to this definition">¶</a></dt> 
    6041714<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">park.parameter.Parameter</span></tt></p> 
    6051715<p>SANS model parameters for use in the PARK fitting service. 
    6061716The parameter attribute value is redirected to the underlying 
    6071717parameter value in the SANS model.</p> 
     1718<dl class="attribute"> 
     1719<dt id="sans.fit.AbstractFitEngine.SansParameter.__class__"> 
     1720<tt class="descname">__class__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__class__" title="Permalink to this definition">¶</a></dt> 
     1721<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     1722</dd></dl> 
     1723 
     1724<dl class="attribute"> 
     1725<dt id="sans.fit.AbstractFitEngine.SansParameter.__delattr__"> 
     1726<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__delattr__" title="Permalink to this definition">¶</a></dt> 
     1727<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     1728</dd></dl> 
     1729 
     1730<dl class="attribute"> 
     1731<dt id="sans.fit.AbstractFitEngine.SansParameter.__dict__"> 
     1732<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x02083790&gt;</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__dict__" title="Permalink to this definition">¶</a></dt> 
     1733<dd></dd></dl> 
     1734 
     1735<dl class="attribute"> 
     1736<dt id="sans.fit.AbstractFitEngine.SansParameter.__getattribute__"> 
     1737<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     1738<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     1739</dd></dl> 
     1740 
     1741<dl class="attribute"> 
     1742<dt id="sans.fit.AbstractFitEngine.SansParameter.__hash__"> 
     1743<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__hash__" title="Permalink to this definition">¶</a></dt> 
     1744<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     1745</dd></dl> 
     1746 
     1747<dl class="method"> 
     1748<dt id="sans.fit.AbstractFitEngine.SansParameter.__init__"> 
     1749<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__init__" title="Permalink to this definition">¶</a></dt> 
     1750<dd><table class="docutils field-list" frame="void" rules="none"> 
     1751<col class="field-name" /> 
     1752<col class="field-body" /> 
     1753<tbody valign="top"> 
     1754<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     1755<li><strong>name</strong> &#8211; the name of the model parameter</li> 
     1756<li><strong>model</strong> &#8211; the sans model to wrap as a park model</li> 
     1757</ul> 
     1758</td> 
     1759</tr> 
     1760</tbody> 
     1761</table> 
     1762</dd></dl> 
     1763 
     1764<dl class="attribute"> 
     1765<dt id="sans.fit.AbstractFitEngine.SansParameter.__module__"> 
     1766<tt class="descname">__module__</tt><em class="property"> = 'sans.fit.AbstractFitEngine'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__module__" title="Permalink to this definition">¶</a></dt> 
     1767<dd></dd></dl> 
     1768 
     1769<dl class="staticmethod"> 
     1770<dt id="sans.fit.AbstractFitEngine.SansParameter.__new__"> 
     1771<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__new__" title="Permalink to this definition">¶</a></dt> 
     1772<dd></dd></dl> 
     1773 
     1774<dl class="method"> 
     1775<dt id="sans.fit.AbstractFitEngine.SansParameter.__reduce__"> 
     1776<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__reduce__" title="Permalink to this definition">¶</a></dt> 
     1777<dd><p>helper for pickle</p> 
     1778</dd></dl> 
     1779 
     1780<dl class="method"> 
     1781<dt id="sans.fit.AbstractFitEngine.SansParameter.__reduce_ex__"> 
     1782<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     1783<dd><p>helper for pickle</p> 
     1784</dd></dl> 
     1785 
     1786<dl class="method"> 
     1787<dt id="sans.fit.AbstractFitEngine.SansParameter.__repr__"> 
     1788<tt class="descname">__repr__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__repr__" title="Permalink to this definition">¶</a></dt> 
     1789<dd></dd></dl> 
     1790 
     1791<dl class="attribute"> 
     1792<dt id="sans.fit.AbstractFitEngine.SansParameter.__setattr__"> 
     1793<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__setattr__" title="Permalink to this definition">¶</a></dt> 
     1794<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     1795</dd></dl> 
     1796 
     1797<dl class="method"> 
     1798<dt id="sans.fit.AbstractFitEngine.SansParameter.__str__"> 
     1799<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__str__" title="Permalink to this definition">¶</a></dt> 
     1800<dd></dd></dl> 
     1801 
     1802<dl class="attribute"> 
     1803<dt id="sans.fit.AbstractFitEngine.SansParameter.__weakref__"> 
     1804<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.__weakref__" title="Permalink to this definition">¶</a></dt> 
     1805<dd><p>list of weak references to the object (if defined)</p> 
     1806</dd></dl> 
     1807 
     1808<dl class="method"> 
     1809<dt id="sans.fit.AbstractFitEngine.SansParameter._getname"> 
     1810<tt class="descname">_getname</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter._getname" title="Permalink to this definition">¶</a></dt> 
     1811<dd></dd></dl> 
     1812 
     1813<dl class="method"> 
     1814<dt id="sans.fit.AbstractFitEngine.SansParameter._getrange"> 
     1815<tt class="descname">_getrange</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter._getrange" title="Permalink to this definition">¶</a></dt> 
     1816<dd><p>Override _getrange of park parameter 
     1817return the range of parameter</p> 
     1818</dd></dl> 
     1819 
     1820<dl class="method"> 
     1821<dt id="sans.fit.AbstractFitEngine.SansParameter._getvalue"> 
     1822<tt class="descname">_getvalue</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter._getvalue" title="Permalink to this definition">¶</a></dt> 
     1823<dd><p>override the _getvalue of park parameter</p> 
     1824<p>:return value the parameter associates with self.name</p> 
     1825</dd></dl> 
     1826 
     1827<dl class="attribute"> 
     1828<dt id="sans.fit.AbstractFitEngine.SansParameter._name"> 
     1829<tt class="descname">_name</tt><em class="property"> = 'unknown'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter._name" title="Permalink to this definition">¶</a></dt> 
     1830<dd></dd></dl> 
     1831 
     1832<dl class="attribute"> 
     1833<dt id="sans.fit.AbstractFitEngine.SansParameter._range"> 
     1834<tt class="descname">_range</tt><em class="property"> = (-1.#INF, 1.#INF)</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter._range" title="Permalink to this definition">¶</a></dt> 
     1835<dd></dd></dl> 
     1836 
     1837<dl class="method"> 
     1838<dt id="sans.fit.AbstractFitEngine.SansParameter._setrange"> 
     1839<tt class="descname">_setrange</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter._setrange" title="Permalink to this definition">¶</a></dt> 
     1840<dd><p>override _setrange of park parameter</p> 
     1841<table class="docutils field-list" frame="void" rules="none"> 
     1842<col class="field-name" /> 
     1843<col class="field-body" /> 
     1844<tbody valign="top"> 
     1845<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>r</strong> &#8211; the value of the range to set</td> 
     1846</tr> 
     1847</tbody> 
     1848</table> 
     1849</dd></dl> 
     1850 
     1851<dl class="method"> 
     1852<dt id="sans.fit.AbstractFitEngine.SansParameter._setvalue"> 
     1853<tt class="descname">_setvalue</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter._setvalue" title="Permalink to this definition">¶</a></dt> 
     1854<dd><p>override the _setvalue pf park parameter</p> 
     1855<table class="docutils field-list" frame="void" rules="none"> 
     1856<col class="field-name" /> 
     1857<col class="field-body" /> 
     1858<tbody valign="top"> 
     1859<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> &#8211; the value to set on a given parameter</td> 
     1860</tr> 
     1861</tbody> 
     1862</table> 
     1863</dd></dl> 
     1864 
     1865<dl class="attribute"> 
     1866<dt id="sans.fit.AbstractFitEngine.SansParameter.deriv"> 
     1867<tt class="descname">deriv</tt><em class="property"> = False</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.deriv" title="Permalink to this definition">¶</a></dt> 
     1868<dd></dd></dl> 
     1869 
     1870<dl class="attribute"> 
     1871<dt id="sans.fit.AbstractFitEngine.SansParameter.expression"> 
     1872<tt class="descname">expression</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.expression" title="Permalink to this definition">¶</a></dt> 
     1873<dd></dd></dl> 
     1874 
    6081875<dl class="method"> 
    6091876<dt id="sans.fit.AbstractFitEngine.SansParameter.get"> 
    … …  
    6241891<dl class="method"> 
    6251892<dt id="sans.fit.AbstractFitEngine.SansParameter.isfeasible"> 
    626 <tt class="descname">isfeasible</tt><big>(</big><em>value</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.isfeasible" title="Permalink to this definition">¶</a></dt> 
     1893<tt class="descname">isfeasible</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.isfeasible" title="Permalink to this definition">¶</a></dt> 
    6271894<dd><p>Return true if the value is in the range</p> 
    6281895</dd></dl> 
    … …  
    6411908<dt id="sans.fit.AbstractFitEngine.SansParameter.isrestrained"> 
    6421909<tt class="descname">isrestrained</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.isrestrained" title="Permalink to this definition">¶</a></dt> 
     1910<dd></dd></dl> 
     1911 
     1912<dl class="attribute"> 
     1913<dt id="sans.fit.AbstractFitEngine.SansParameter.likelihood"> 
     1914<tt class="descname">likelihood</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.likelihood" title="Permalink to this definition">¶</a></dt> 
     1915<dd></dd></dl> 
     1916 
     1917<dl class="attribute"> 
     1918<dt id="sans.fit.AbstractFitEngine.SansParameter.limits"> 
     1919<tt class="descname">limits</tt><em class="property"> = (-1.#INF, 1.#INF)</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.limits" title="Permalink to this definition">¶</a></dt> 
    6431920<dd></dd></dl> 
    6441921 
    … …  
    6481925<dd><p>parameter name</p> 
    6491926</dd></dl> 
     1927 
     1928<dl class="attribute"> 
     1929<dt id="sans.fit.AbstractFitEngine.SansParameter.path"> 
     1930<tt class="descname">path</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.path" title="Permalink to this definition">¶</a></dt> 
     1931<dd></dd></dl> 
    6501932 
    6511933<dl class="attribute"> 
    … …  
    6581940<dl class="method"> 
    6591941<dt id="sans.fit.AbstractFitEngine.SansParameter.set"> 
    660 <tt class="descname">set</tt><big>(</big><em>value</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.set" title="Permalink to this definition">¶</a></dt> 
     1942<tt class="descname">set</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.set" title="Permalink to this definition">¶</a></dt> 
    6611943<dd><p>Set a parameter to a value, a range or an expression.  If it is a value, 
    6621944the parameter will be fixed for the fit.  If it is a range, the value 
    … …  
    6681950<dl class="method"> 
    6691951<dt id="sans.fit.AbstractFitEngine.SansParameter.setprefix"> 
    670 <tt class="descname">setprefix</tt><big>(</big><em>prefix</em><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.setprefix" title="Permalink to this definition">¶</a></dt> 
     1952<tt class="descname">setprefix</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.setprefix" title="Permalink to this definition">¶</a></dt> 
    6711953<dd><p>Set the full path to the parameter as used in expressions involving 
    6721954the parameter name.</p> 
    6731955</dd></dl> 
     1956 
     1957<dl class="attribute"> 
     1958<dt id="sans.fit.AbstractFitEngine.SansParameter.status"> 
     1959<tt class="descname">status</tt><em class="property"> = 'fixed'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.status" title="Permalink to this definition">¶</a></dt> 
     1960<dd></dd></dl> 
    6741961 
    6751962<dl class="method"> 
    … …  
    6791966<p>E.g.,  &#8221;       Gold .....|.... 5.2043 in [2,7]&#8221;</p> 
    6801967</dd></dl> 
     1968 
     1969<dl class="attribute"> 
     1970<dt id="sans.fit.AbstractFitEngine.SansParameter.tip"> 
     1971<tt class="descname">tip</tt><em class="property"> = 'Fitting parameter'</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.tip" title="Permalink to this definition">¶</a></dt> 
     1972<dd></dd></dl> 
     1973 
     1974<dl class="attribute"> 
     1975<dt id="sans.fit.AbstractFitEngine.SansParameter.units"> 
     1976<tt class="descname">units</tt><em class="property"> = ''</em><a class="headerlink" href="#sans.fit.AbstractFitEngine.SansParameter.units" title="Permalink to this definition">¶</a></dt> 
     1977<dd></dd></dl> 
    6811978 
    6821979<dl class="attribute"> 
    … …  
    7011998  <ul> 
    7021999<li><a class="reference internal" href="#">AbstractFitEngine</a><ul> 
    703 <li><a class="reference internal" href="#module-sans.fit.AbstractFitEngine">:mod:` sans.fit.AbstractFitEngine`</a></li> 
     2000<li><a class="reference internal" href="#mod-sans-fit-abstractfitengine">:mod:` sans.fit.AbstractFitEngine`</a></li> 
    7042001</ul> 
    7052002</li> 
    … …  
    7202017  <h3>Quick search</h3> 
    7212018    <form class="search" action="../search.html" method="get"> 
    722       <input type="text" name="q" size="18" /> 
     2019      <input type="text" name="q" /> 
    7232020      <input type="submit" value="Go" /> 
    7242021      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    7492046          <a href="index.html" title="Reference" 
    7502047             >previous</a> |</li> 
    751         <li><a href="../index.html">park_integration v0.1.0 documentation</a> &raquo;</li> 
     2048        <li><a href="../index.html">park_integration 0.1.0 documentation</a> &raquo;</li> 
    7522049          <li><a href="index.html" >Reference</a> &raquo;</li>  
    7532050      </ul> 
    … …  
    7552052    <div class="footer"> 
    7562053        &copy; Copyright 2010, sans group. 
    757       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     2054      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    7582055    </div> 
    7592056  </body> 

  • park_integration/docs/sphinx/html/api/Fitting.html

    r6b1588b rf696e2a  
    33<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
    44  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
     5 
    56 
    67<html xmlns="http://www.w3.org/1999/xhtml"> 
    … …  
    89    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 
    910     
    10     <title>Fitting &mdash; park_integration v0.1.0 documentation</title> 
     11    <title>Fitting &mdash; park_integration 0.1.0 documentation</title> 
     12     
    1113    <link rel="stylesheet" href="../_static/default.css" type="text/css" /> 
    1214    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> 
     15     
    1316    <script type="text/javascript"> 
    1417      var DOCUMENTATION_OPTIONS = { 
    … …  
    2326    <script type="text/javascript" src="../_static/underscore.js"></script> 
    2427    <script type="text/javascript" src="../_static/doctools.js"></script> 
    25     <link rel="top" title="park_integration v0.1.0 documentation" href="../index.html" /> 
     28    <link rel="top" title="park_integration 0.1.0 documentation" href="../index.html" /> 
    2629    <link rel="up" title="Reference" href="index.html" /> 
    27     <link rel="next" title="ParkFitting" href="ParkFitting.html" /> 
     30    <link rel="next" title="Loader" href="Loader.html" /> 
    2831    <link rel="prev" title="AbstractFitEngine" href="AbstractFitEngine.html" />  
    2932  </head> 
    … …  
    3942             >modules</a> |</li> 
    4043        <li class="right" > 
    41           <a href="ParkFitting.html" title="ParkFitting" 
     44          <a href="Loader.html" title="Loader" 
    4245             accesskey="N">next</a> |</li> 
    4346        <li class="right" > 
    4447          <a href="AbstractFitEngine.html" title="AbstractFitEngine" 
    4548             accesskey="P">previous</a> |</li> 
    46         <li><a href="../index.html">park_integration v0.1.0 documentation</a> &raquo;</li> 
     49        <li><a href="../index.html">park_integration 0.1.0 documentation</a> &raquo;</li> 
    4750          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li>  
    4851      </ul> 
    … …  
    5861<div class="section" id="mod-sans-fit-fitting"> 
    5962<h2>:mod:` sans.fit.Fitting`<a class="headerlink" href="#mod-sans-fit-fitting" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.fit.Fitting"></span><p>Class Fit contains ScipyFit and ParkFit methods declaration 
     64allows to create instance of type ScipyFit or ParkFit to perform either 
     65a park fit or a scipy fit.</p> 
     66<dl class="class"> 
     67<dt id="sans.fit.Fitting.Fit"> 
     68<em class="property">class </em><tt class="descclassname">sans.fit.Fitting.</tt><tt class="descname">Fit</tt><a class="headerlink" href="#sans.fit.Fitting.Fit" title="Permalink to this definition">¶</a></dt> 
     69<dd><p>Wrap class that allows to select the fitting type.this class  
     70can be used as follow :</p> 
     71<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> 
     72<span class="n">fitter</span><span class="o">=</span> <span class="n">Fit</span><span class="p">()</span> 
     73<span class="n">fitter</span><span class="o">.</span><span class="n">fit_engine</span><span class="p">(</span><span class="s">&#39;scipy&#39;</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">&#39;park&#39;</span><span class="p">)</span> 
     74<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> 
     75<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> 
     76<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> 
     77<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> 
     78 
     79<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> 
     80</pre></div> 
     81</div> 
     82<dl class="method"> 
     83<dt id="sans.fit.Fitting.Fit.__init__"> 
     84<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.__init__" title="Permalink to this definition">¶</a></dt> 
     85<dd></dd></dl> 
     86 
     87<dl class="attribute"> 
     88<dt id="sans.fit.Fitting.Fit.__module__"> 
     89<tt class="descname">__module__</tt><em class="property"> = 'sans.fit.Fitting'</em><a class="headerlink" href="#sans.fit.Fitting.Fit.__module__" title="Permalink to this definition">¶</a></dt> 
     90<dd></dd></dl> 
     91 
     92<dl class="method"> 
     93<dt id="sans.fit.Fitting.Fit.fit"> 
     94<tt class="descname">fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.fit" title="Permalink to this definition">¶</a></dt> 
     95<dd><p>Perform the fit</p> 
     96</dd></dl> 
     97 
     98<dl class="method"> 
     99<dt id="sans.fit.Fitting.Fit.get_model"> 
     100<tt class="descname">get_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.get_model" title="Permalink to this definition">¶</a></dt> 
     101<dd><p>return list of data</p> 
     102</dd></dl> 
     103 
     104<dl class="method"> 
     105<dt id="sans.fit.Fitting.Fit.get_problem_to_fit"> 
     106<tt class="descname">get_problem_to_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.get_problem_to_fit" title="Permalink to this definition">¶</a></dt> 
     107<dd><p>return the self.selected value of the fit problem of id</p> 
     108<table class="docutils field-list" frame="void" rules="none"> 
     109<col class="field-name" /> 
     110<col class="field-body" /> 
     111<tbody valign="top"> 
     112<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> &#8211; the id of the problem</td> 
     113</tr> 
     114</tbody> 
     115</table> 
     116</dd></dl> 
     117 
     118<dl class="method"> 
     119<dt id="sans.fit.Fitting.Fit.remove_fit_problem"> 
     120<tt class="descname">remove_fit_problem</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.remove_fit_problem" title="Permalink to this definition">¶</a></dt> 
     121<dd><p>remove fitarrange in id</p> 
     122</dd></dl> 
     123 
     124<dl class="method"> 
     125<dt id="sans.fit.Fitting.Fit.select_problem_for_fit"> 
     126<tt class="descname">select_problem_for_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.select_problem_for_fit" title="Permalink to this definition">¶</a></dt> 
     127<dd><p>select a couple of model and data at the id position in dictionary 
     128and set in self.selected value to value</p> 
     129<table class="docutils field-list" frame="void" rules="none"> 
     130<col class="field-name" /> 
     131<col class="field-body" /> 
     132<tbody valign="top"> 
     133<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> &#8211; the value to allow fitting. 
     134can only have the value one or zero</td> 
     135</tr> 
     136</tbody> 
     137</table> 
     138</dd></dl> 
     139 
     140<dl class="method"> 
     141<dt id="sans.fit.Fitting.Fit.set_data"> 
     142<tt class="descname">set_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.set_data" title="Permalink to this definition">¶</a></dt> 
     143<dd><p>Store data to fit at the psotion id of the fit engine</p> 
     144<table class="docutils field-list" frame="void" rules="none"> 
     145<col class="field-name" /> 
     146<col class="field-body" /> 
     147<tbody valign="top"> 
     148<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     149<li><strong>data</strong> &#8211; data to fit</li> 
     150<li><strong>smearer</strong> &#8211; smearerobject to smear data</li> 
     151<li><strong>qmin</strong> &#8211; the minimum q range to fit</li> 
     152<li><strong>qmax</strong> &#8211; the minimum q range to fit</li> 
     153</ul> 
     154</td> 
     155</tr> 
     156</tbody> 
     157</table> 
     158</dd></dl> 
     159 
     160<dl class="method"> 
     161<dt id="sans.fit.Fitting.Fit.set_engine"> 
     162<tt class="descname">set_engine</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.set_engine" title="Permalink to this definition">¶</a></dt> 
     163<dd><p>Select the type of Fit</p> 
     164<table class="docutils field-list" frame="void" rules="none"> 
     165<col class="field-name" /> 
     166<col class="field-body" /> 
     167<tbody valign="top"> 
     168<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>word</strong> &#8211; the keyword to select the fit type</td> 
     169</tr> 
     170<tr class="field-even field"><th class="field-name">Raise :</th><td class="field-body">if the user does not enter &#8216;scipy&#8217; or &#8216;park&#8217;, 
     171a valueError is raised</td> 
     172</tr> 
     173</tbody> 
     174</table> 
     175</dd></dl> 
     176 
     177<dl class="method"> 
     178<dt id="sans.fit.Fitting.Fit.set_model"> 
     179<tt class="descname">set_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.Fitting.Fit.set_model" title="Permalink to this definition">¶</a></dt> 
     180<dd><p>store a model model to fit at the position id of the fit engine</p> 
     181</dd></dl> 
     182 
     183</dd></dl> 
     184 
    60185</div> 
    61186</div> 
    … …  
    79204                        title="previous chapter">AbstractFitEngine</a></p> 
    80205  <h4>Next topic</h4> 
    81   <p class="topless"><a href="ParkFitting.html" 
    82                         title="next chapter">ParkFitting</a></p> 
     206  <p class="topless"><a href="Loader.html" 
     207                        title="next chapter">Loader</a></p> 
    83208  <h3>This Page</h3> 
    84209  <ul class="this-page-menu"> 
    … …  
    89214  <h3>Quick search</h3> 
    90215    <form class="search" action="../search.html" method="get"> 
    91       <input type="text" name="q" size="18" /> 
     216      <input type="text" name="q" /> 
    92217      <input type="submit" value="Go" /> 
    93218      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    113238             >modules</a> |</li> 
    114239        <li class="right" > 
    115           <a href="ParkFitting.html" title="ParkFitting" 
     240          <a href="Loader.html" title="Loader" 
    116241             >next</a> |</li> 
    117242        <li class="right" > 
    118243          <a href="AbstractFitEngine.html" title="AbstractFitEngine" 
    119244             >previous</a> |</li> 
    120         <li><a href="../index.html">park_integration v0.1.0 documentation</a> &raquo;</li> 
     245        <li><a href="../index.html">park_integration 0.1.0 documentation</a> &raquo;</li> 
    121246          <li><a href="index.html" >Reference</a> &raquo;</li>  
    122247      </ul> 
    … …  
    124249    <div class="footer"> 
    125250        &copy; Copyright 2010, sans group. 
    126       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     251      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    127252    </div> 
    128253  </body> 

  • park_integration/docs/sphinx/html/api/ParkFitting.html

    r6b1588b rf696e2a  
    33<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
    44  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
     5 
    56 
    67<html xmlns="http://www.w3.org/1999/xhtml"> 
    … …  
    89    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 
    910     
    10     <title>ParkFitting &mdash; park_integration v0.1.0 documentation</title> 
     11    <title>ParkFitting &mdash; park_integration 0.1.0 documentation</title> 
     12     
    1113    <link rel="stylesheet" href="../_static/default.css" type="text/css" /> 
    1214    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> 
     15     
    1316    <script type="text/javascript"> 
    1417      var DOCUMENTATION_OPTIONS = { 
    … …  
    2326    <script type="text/javascript" src="../_static/underscore.js"></script> 
    2427    <script type="text/javascript" src="../_static/doctools.js"></script> 
    25     <link rel="top" title="park_integration v0.1.0 documentation" href="../index.html" /> 
     28    <link rel="top" title="park_integration 0.1.0 documentation" href="../index.html" /> 
    2629    <link rel="up" title="Reference" href="index.html" /> 
    2730    <link rel="next" title="ScipyFitting" href="ScipyFitting.html" /> 
    28     <link rel="prev" title="Fitting" href="Fitting.html" />  
     31    <link rel="prev" title="Loader" href="Loader.html" />  
    2932  </head> 
    3033  <body> 
    … …  
    4245             accesskey="N">next</a> |</li> 
    4346        <li class="right" > 
    44           <a href="Fitting.html" title="Fitting" 
     47          <a href="Loader.html" title="Loader" 
    4548             accesskey="P">previous</a> |</li> 
    46         <li><a href="../index.html">park_integration v0.1.0 documentation</a> &raquo;</li> 
     49        <li><a href="../index.html">park_integration 0.1.0 documentation</a> &raquo;</li> 
    4750          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li>  
    4851      </ul> 
    … …  
    5861<div class="section" id="mod-sans-fit-parkfitting"> 
    5962<h2>:mod:` sans.fit.ParkFitting`<a class="headerlink" href="#mod-sans-fit-parkfitting" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.fit.ParkFitting"></span><p>ParkFitting module contains SansParameter,Model,Data 
     64FitArrange, ParkFit,Parameter classes.All listed classes work together 
     65to perform a simple fit with park optimizer.</p> 
     66<dl class="class"> 
     67<dt id="sans.fit.ParkFitting.MyAssembly"> 
     68<em class="property">class </em><tt class="descclassname">sans.fit.ParkFitting.</tt><tt class="descname">MyAssembly</tt><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly" title="Permalink to this definition">¶</a></dt> 
     69<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">park.assembly.Assembly</span></tt></p> 
     70<dl class="method"> 
     71<dt id="sans.fit.ParkFitting.MyAssembly.__call__"> 
     72<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.__call__" title="Permalink to this definition">¶</a></dt> 
     73<dd><p>Cost function.</p> 
     74<p>Evaluate the system for the parameter vector pvec, returning chisq 
     75as the cost function to be minimized.</p> 
     76<p>Raises a runtime error if the number of fit parameters is 
     77different than the length of the vector.</p> 
     78</dd></dl> 
     79 
     80<dl class="attribute"> 
     81<dt id="sans.fit.ParkFitting.MyAssembly.__class__"> 
     82<tt class="descname">__class__</tt><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.__class__" title="Permalink to this definition">¶</a></dt> 
     83<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     84</dd></dl> 
     85 
     86<dl class="attribute"> 
     87<dt id="sans.fit.ParkFitting.MyAssembly.__delattr__"> 
     88<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.__delattr__" title="Permalink to this definition">¶</a></dt> 
     89<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     90</dd></dl> 
     91 
     92<dl class="method"> 
     93<dt id="sans.fit.ParkFitting.MyAssembly.__delitem__"> 
     94<tt class="descname">__delitem__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.__delitem__" title="Permalink to this definition">¶</a></dt> 
     95<dd><p>Delete the nth model</p> 
     96</dd></dl> 
     97 
     98<dl class="attribute"> 
     99<dt id="sans.fit.ParkFitting.MyAssembly.__dict__"> 
     100<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01E46BB0&gt;</em><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.__dict__" title="Permalink to this definition">¶</a></dt> 
     101<dd></dd></dl> 
     102 
     103<dl class="attribute"> 
     104<dt id="sans.fit.ParkFitting.MyAssembly.__getattribute__"> 
     105<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     106<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     107</dd></dl> 
     108 
     109<dl class="method"> 
     110<dt id="sans.fit.ParkFitting.MyAssembly.__getitem__"> 
     111<tt class="descname">__getitem__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.__getitem__" title="Permalink to this definition">¶</a></dt> 
     112<dd><p>Return the nth model</p> 
     113</dd></dl> 
     114 
     115<dl class="attribute"> 
     116<dt id="sans.fit.ParkFitting.MyAssembly.__hash__"> 
     117<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.__hash__" title="Permalink to this definition">¶</a></dt> 
     118<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     119</dd></dl> 
     120 
     121<dl class="method"> 
     122<dt id="sans.fit.ParkFitting.MyAssembly.__init__"> 
     123<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.__init__" title="Permalink to this definition">¶</a></dt> 
     124<dd><p>Build an assembly from a list of models.</p> 
     125</dd></dl> 
     126 
     127<dl class="method"> 
     128<dt id="sans.fit.ParkFitting.MyAssembly.__iter__"> 
     129<tt class="descname">__iter__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.__iter__" title="Permalink to this definition">¶</a></dt> 
     130<dd><p>Iterate through the models in order</p> 
     131</dd></dl> 
     132 
     133<dl class="attribute"> 
     134<dt id="sans.fit.ParkFitting.MyAssembly.__module__"> 
     135<tt class="descname">__module__</tt><em class="property"> = 'sans.fit.ParkFitting'</em><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.__module__" title="Permalink to this definition">¶</a></dt> 
     136<dd></dd></dl> 
     137 
     138<dl class="staticmethod"> 
     139<dt id="sans.fit.ParkFitting.MyAssembly.__new__"> 
     140<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.__new__" title="Permalink to this definition">¶</a></dt> 
     141<dd></dd></dl> 
     142 
     143<dl class="method"> 
     144<dt id="sans.fit.ParkFitting.MyAssembly.__reduce__"> 
     145<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.__reduce__" title="Permalink to this definition">¶</a></dt> 
     146<dd><p>helper for pickle</p> 
     147</dd></dl> 
     148 
     149<dl class="method"> 
     150<dt id="sans.fit.ParkFitting.MyAssembly.__reduce_ex__"> 
     151<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     152<dd><p>helper for pickle</p> 
     153</dd></dl> 
     154 
     155<dl class="attribute"> 
     156<dt id="sans.fit.ParkFitting.MyAssembly.__repr__"> 
     157<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.__repr__" title="Permalink to this definition">¶</a></dt> 
     158<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     159</dd></dl> 
     160 
     161<dl class="attribute"> 
     162<dt id="sans.fit.ParkFitting.MyAssembly.__setattr__"> 
     163<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.__setattr__" title="Permalink to this definition">¶</a></dt> 
     164<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     165</dd></dl> 
     166 
     167<dl class="method"> 
     168<dt id="sans.fit.ParkFitting.MyAssembly.__setitem__"> 
     169<tt class="descname">__setitem__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.__setitem__" title="Permalink to this definition">¶</a></dt> 
     170<dd><p>Replace the nth model</p> 
     171</dd></dl> 
     172 
     173<dl class="attribute"> 
     174<dt id="sans.fit.ParkFitting.MyAssembly.__str__"> 
     175<tt class="descname">__str__</tt><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.__str__" title="Permalink to this definition">¶</a></dt> 
     176<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     177</dd></dl> 
     178 
     179<dl class="attribute"> 
     180<dt id="sans.fit.ParkFitting.MyAssembly.__weakref__"> 
     181<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.__weakref__" title="Permalink to this definition">¶</a></dt> 
     182<dd><p>list of weak references to the object (if defined)</p> 
     183</dd></dl> 
     184 
     185<dl class="method"> 
     186<dt id="sans.fit.ParkFitting.MyAssembly._reset"> 
     187<tt class="descname">_reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly._reset" title="Permalink to this definition">¶</a></dt> 
     188<dd><p>Adjust the parameter set after the addition of a new model.</p> 
     189</dd></dl> 
     190 
     191<dl class="method"> 
     192<dt id="sans.fit.ParkFitting.MyAssembly.abort"> 
     193<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> 
     194<dd><p>Interrupt the current function evaluation.</p> 
     195<p>Forward this to the currently executing model if possible.</p> 
     196</dd></dl> 
     197 
     198<dl class="method"> 
     199<dt id="sans.fit.ParkFitting.MyAssembly.all_results"> 
     200<tt class="descname">all_results</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.all_results" title="Permalink to this definition">¶</a></dt> 
     201<dd><p>Extend result from the fit with the calculated parameters.</p> 
     202</dd></dl> 
     203 
     204<dl class="method"> 
     205<dt id="sans.fit.ParkFitting.MyAssembly.append"> 
     206<tt class="descname">append</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.append" title="Permalink to this definition">¶</a></dt> 
     207<dd><p>Add a model to the end of set.</p> 
     208<table class="docutils field-list" frame="void" rules="none"> 
     209<col class="field-name" /> 
     210<col class="field-body" /> 
     211<tbody valign="top"> 
     212<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>fitness</strong> &#8211; the fitting model</td> 
     213</tr> 
     214</tbody> 
     215</table> 
     216<p>The fitting model can be an instance of <cite>park.assembly.Fitness</cite>, 
     217or a tuple of (<cite>park.model.Model</cite>,`park.data.Data1D`) 
     218:param weight: model weighting (usually 1.0) 
     219:param isfitted: whether model should be fit (equivalent to weight 0.)</p> 
     220</dd></dl> 
     221 
     222<dl class="method"> 
     223<dt id="sans.fit.ParkFitting.MyAssembly.cov"> 
     224<tt class="descname">cov</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.cov" title="Permalink to this definition">¶</a></dt> 
     225<dd><p>Return the covariance matrix inv(J&#8217;J) at point p.</p> 
     226</dd></dl> 
     227 
     228<dl class="method"> 
     229<dt id="sans.fit.ParkFitting.MyAssembly.eval"> 
     230<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> 
     231<dd><p>Recalculate the theory functions, and from them, the 
     232residuals and chisq.</p> 
     233<table class="docutils field-list" frame="void" rules="none"> 
     234<col class="field-name" /> 
     235<col class="field-body" /> 
     236<tbody valign="top"> 
     237<tr class="field-odd field"><th class="field-name">Note :</th><td class="field-body">Call this after the parameters have been updated.</td> 
     238</tr> 
     239</tbody> 
     240</table> 
     241</dd></dl> 
     242 
     243<dl class="method"> 
     244<dt id="sans.fit.ParkFitting.MyAssembly.fit_parameters"> 
     245<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> 
     246<dd><p>Return an alphabetical list of the fitting parameters.</p> 
     247<p>This function is called once at the beginning of a fit, 
     248and serves as a convenient place to precalculate what 
     249can be precalculated such as the set of fitting parameters 
     250and the parameter expressions evaluator.</p> 
     251</dd></dl> 
     252 
     253<dl class="method"> 
     254<dt id="sans.fit.ParkFitting.MyAssembly.fresiduals"> 
     255<tt class="descname">fresiduals</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.fresiduals" title="Permalink to this definition">¶</a></dt> 
     256<dd></dd></dl> 
     257 
     258<dl class="method"> 
     259<dt id="sans.fit.ParkFitting.MyAssembly.insert"> 
     260<tt class="descname">insert</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.insert" title="Permalink to this definition">¶</a></dt> 
     261<dd><p>Add a model to a particular position in the set.</p> 
     262</dd></dl> 
     263 
     264<dl class="method"> 
     265<dt id="sans.fit.ParkFitting.MyAssembly.isfeasible"> 
     266<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> 
     267<dd><p>Returns true if the parameter set is in a feasible region of the 
     268modeling space.</p> 
     269</dd></dl> 
     270 
     271<dl class="method"> 
     272<dt id="sans.fit.ParkFitting.MyAssembly.isfitted"> 
     273<tt class="descname">isfitted</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.isfitted" title="Permalink to this definition">¶</a></dt> 
     274<dd><p>Query if a particular model is fitted.</p> 
     275<p>Set isfitted to value if value is supplied.</p> 
     276<table class="docutils field-list" frame="void" rules="none"> 
     277<col class="field-name" /> 
     278<col class="field-body" /> 
     279<tbody valign="top"> 
     280<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     281<li><strong>idx</strong> (<em>integer</em>) &#8211; model number</li> 
     282<li><strong>value</strong> &#8211; </li> 
     283</ul> 
     284</td> 
     285</tr> 
     286</tbody> 
     287</table> 
     288</dd></dl> 
     289 
     290<dl class="method"> 
     291<dt id="sans.fit.ParkFitting.MyAssembly.jacobian"> 
     292<tt class="descname">jacobian</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.jacobian" title="Permalink to this definition">¶</a></dt> 
     293<dd><p>Returns the derivative wrt the fit parameters at point p.</p> 
     294<p>Numeric derivatives are calculated based on step, where step is 
     295the portion of the total range for parameter j, or the portion of 
     296point value p_j if the range on parameter j is infinite.</p> 
     297</dd></dl> 
     298 
     299<dl class="method"> 
     300<dt id="sans.fit.ParkFitting.MyAssembly.result"> 
     301<tt class="descname">result</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.result" title="Permalink to this definition">¶</a></dt> 
     302<dd><p>Details to send back to the fitting client on an improved fit.</p> 
     303<p>status is &#8216;start&#8217;, &#8216;step&#8217; or &#8216;end&#8217; depending if this is the 
     304first result to return, an improved result, or the final result.</p> 
     305<p>[Not implemented]</p> 
     306</dd></dl> 
     307 
     308<dl class="method"> 
     309<dt id="sans.fit.ParkFitting.MyAssembly.set_result"> 
     310<tt class="descname">set_result</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.set_result" title="Permalink to this definition">¶</a></dt> 
     311<dd><p>Set the parameters resulting from the fit into the parameter set, 
     312and update the calculated expression.</p> 
     313<p>The parameter values may be retrieved by walking the assembly.parameterset 
     314tree, checking each parameter for isfitted, iscomputed, or isfixed. 
     315For example:</p> 
     316<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> 
     317<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> 
     318    <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">isfitted</span><span class="p">():</span> 
     319        <span class="k">print</span> <span class="s">&quot;</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">]&quot;</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> 
     320    <span class="k">elif</span> <span class="n">p</span><span class="o">.</span><span class="n">iscomputed</span><span class="p">():</span> 
     321        <span class="k">print</span> <span class="s">&quot;</span><span class="si">%s</span><span class="s"> computed as </span><span class="si">%g</span><span class="s">&quot;</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> 
     322</pre></div> 
     323</div> 
     324<p>This does not calculate the function or the residuals for these parameters. 
     325You can call assembly.eval() to do this.  The residuals will be set in 
     326assembly[i].residuals.  The theory and data are model specific, and can 
     327be found in assembly[i].fitness.data.</p> 
     328</dd></dl> 
     329 
     330<dl class="method"> 
     331<dt id="sans.fit.ParkFitting.MyAssembly.stderr"> 
     332<tt class="descname">stderr</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.stderr" title="Permalink to this definition">¶</a></dt> 
     333<dd><p>Return parameter uncertainty.</p> 
     334<p>This is just the sqrt diagonal of covariance matrix inv(J&#8217;J) at point p.</p> 
     335</dd></dl> 
     336 
     337<dl class="method"> 
     338<dt id="sans.fit.ParkFitting.MyAssembly.weight"> 
     339<tt class="descname">weight</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.MyAssembly.weight" title="Permalink to this definition">¶</a></dt> 
     340<dd><p>Query the weight on a particular model.</p> 
     341<p>Set weight to value if value is supplied.</p> 
     342<table class="docutils field-list" frame="void" rules="none"> 
     343<col class="field-name" /> 
     344<col class="field-body" /> 
     345<tbody valign="top"> 
     346<tr class="field-odd field"><th class="field-name">Parameters :</th><td class="field-body"><dl class="first docutils"> 
     347<dt>idx <span class="classifier-delimiter">:</span> <span class="classifier">integer</span></dt> 
     348<dd><p class="first last">model number</p> 
     349</dd> 
     350<dt>value <span class="classifier-delimiter">:</span> <span class="classifier">float</span></dt> 
     351<dd><p class="first last">model weight</p> 
     352</dd> 
     353</dl> 
     354</td> 
     355</tr> 
     356<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">model weight</p> 
     357</td> 
     358</tr> 
     359</tbody> 
     360</table> 
     361</dd></dl> 
     362 
     363</dd></dl> 
     364 
     365<dl class="class"> 
     366<dt id="sans.fit.ParkFitting.ParkFit"> 
     367<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> 
     368<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> 
     369<p>ParkFit performs the Fit.This class can be used as follow: 
     370#Do the fit Park 
     371create an engine: engine = ParkFit() 
     372Use data must be of type plottable 
     373Use a sans model</p> 
     374<p>Add data with a dictionnary of FitArrangeList where Uid is a key and data 
     375is saved in FitArrange object. 
     376engine.set_data(data,Uid)</p> 
     377<p>Set model parameter &#8220;M1&#8221;= model.name add {model.parameter.name:value}.</p> 
     378<table class="docutils field-list" frame="void" rules="none"> 
     379<col class="field-name" /> 
     380<col class="field-body" /> 
     381<tbody valign="top"> 
     382<tr class="field-odd field"><th class="field-name">Note :</th><td class="field-body">Set_param() if used must always preceded set_model() 
     383for the fit to be performed.</td> 
     384</tr> 
     385</tbody> 
     386</table> 
     387<p>engine.set_param( model,&#8221;M1&#8221;, {&#8216;A&#8217;:2,&#8217;B&#8217;:4})</p> 
     388<p>Add model with a dictionnary of FitArrangeList{} where Uid is a key 
     389and model 
     390is save in FitArrange object. 
     391engine.set_model(model,Uid)</p> 
     392<p>engine.fit return chisqr,[model.parameter 1,2,..],[[err1....][..err2...]] 
     393chisqr1, out1, cov1=engine.fit({model.parameter.name:value},qmin,qmax)</p> 
     394<table class="docutils field-list" frame="void" rules="none"> 
     395<col class="field-name" /> 
     396<col class="field-body" /> 
     397<tbody valign="top"> 
     398<tr class="field-odd field"><th class="field-name">Note :</th><td class="field-body">{model.parameter.name:value} is ignored in fit function since  
     399the user should make sure to call set_param himself.</td> 
     400</tr> 
     401</tbody> 
     402</table> 
     403<dl class="method"> 
     404<dt id="sans.fit.ParkFitting.ParkFit.__init__"> 
     405<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.ParkFit.__init__" title="Permalink to this definition">¶</a></dt> 
     406<dd><p>Creates a dictionary (self.fitArrangeList={})of FitArrange elements 
     407with Uid as keys</p> 
     408</dd></dl> 
     409 
     410<dl class="attribute"> 
     411<dt id="sans.fit.ParkFitting.ParkFit.__module__"> 
     412<tt class="descname">__module__</tt><em class="property"> = 'sans.fit.ParkFitting'</em><a class="headerlink" href="#sans.fit.ParkFitting.ParkFit.__module__" title="Permalink to this definition">¶</a></dt> 
     413<dd></dd></dl> 
     414 
     415<dl class="method"> 
     416<dt id="sans.fit.ParkFitting.ParkFit.create_assembly"> 
     417<tt class="descname">create_assembly</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.ParkFit.create_assembly" title="Permalink to this definition">¶</a></dt> 
     418<dd><p>Extract sansmodel and sansdata from  
     419self.FitArrangelist ={Uid:FitArrange} 
     420Create parkmodel and park data ,form a list couple of parkmodel  
     421and parkdata 
     422create an assembly self.problem=  park.Assembly([(parkmodel,parkdata)])</p> 
     423</dd></dl> 
     424 
     425<dl class="method"> 
     426<dt id="sans.fit.ParkFitting.ParkFit.fit"> 
     427<tt class="descname">fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.ParkFit.fit" title="Permalink to this definition">¶</a></dt> 
     428<dd><p>Performs fit with park.fit module.It can  perform fit with one model 
     429and a set of data, more than two fit of  one model and sets of data or  
     430fit with more than two model associated with their set of data and  
     431constraints</p> 
     432<table class="docutils field-list" frame="void" rules="none"> 
     433<col class="field-name" /> 
     434<col class="field-body" /> 
     435<tbody valign="top"> 
     436<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
     437<li><strong>pars</strong> &#8211; Dictionary of parameter names for the model and their  
     438values.</li> 
     439<li><strong>qmin</strong> &#8211; The minimum value of data&#8217;s range to be fit</li> 
     440<li><strong>qmax</strong> &#8211; The maximum value of data&#8217;s range to be fit</li> 
     441</ul> 
     442</td> 
     443</tr> 
     444<tr class="field-even 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  
     445to keep ScipyFit and ParkFit interface the same.</p> 
     446</td> 
     447</tr> 
     448<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">result.fitness Value of the goodness of fit metric</p> 
     449</td> 
     450</tr> 
     451<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">result.pvec list of parameter with the best value  
     452found during fitting</p> 
     453</td> 
     454</tr> 
     455<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">result.cov Covariance matrix</p> 
     456</td> 
     457</tr> 
     458</tbody> 
     459</table> 
     460</dd></dl> 
     461 
     462<dl class="method"> 
     463<dt id="sans.fit.ParkFitting.ParkFit.get_model"> 
     464<tt class="descname">get_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.ParkFit.get_model" title="Permalink to this definition">¶</a></dt> 
     465<dd><table class="docutils field-list" frame="void" rules="none"> 
     466<col class="field-name" /> 
     467<col class="field-body" /> 
     468<tbody valign="top"> 
     469<tr class="field-odd 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> 
     470</tr> 
     471<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a model at this id or None if no FitArrange element was  
     472created with this id</td> 
     473</tr> 
     474</tbody> 
     475</table> 
     476</dd></dl> 
     477 
     478<dl class="method"> 
     479<dt id="sans.fit.ParkFitting.ParkFit.get_problem_to_fit"> 
     480<tt class="descname">get_problem_to_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.ParkFit.get_problem_to_fit" title="Permalink to this definition">¶</a></dt> 
     481<dd><p>return the self.selected value of the fit problem of id</p> 
     482<table class="docutils field-list" frame="void" rules="none"> 
     483<col class="field-name" /> 
     484<col class="field-body" /> 
     485<tbody valign="top"> 
     486<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> &#8211; the id of the problem</td> 
     487</tr> 
     488</tbody> 
     489</table> 
     490</dd></dl> 
     491 
     492<dl class="method"> 
     493<dt id="sans.fit.ParkFitting.ParkFit.remove_fit_problem"> 
     494<tt class="descname">remove_fit_problem</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.ParkFit.remove_fit_problem" title="Permalink to this definition">¶</a></dt> 
     495<dd><p>remove   fitarrange in id</p> 
     496</dd></dl> 
     497 
     498<dl class="method"> 
     499<dt id="sans.fit.ParkFitting.ParkFit.select_problem_for_fit"> 
     500<tt class="descname">select_problem_for_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.ParkFit.select_problem_for_fit" title="Permalink to this definition">¶</a></dt> 
     501<dd><p>select a couple of model and data at the id position in dictionary 
     502and set in self.selected value to value</p> 
     503<table class="docutils field-list" frame="void" rules="none"> 
     504<col class="field-name" /> 
     505<col class="field-body" /> 
     506<tbody valign="top"> 
     507<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> &#8211; the value to allow fitting.  
     508can only have the value one or zero</td> 
     509</tr> 
     510</tbody> 
     511</table> 
     512</dd></dl> 
     513 
     514<dl class="method"> 
     515<dt id="sans.fit.ParkFitting.ParkFit.set_data"> 
     516<tt class="descname">set_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.ParkFit.set_data" title="Permalink to this definition">¶</a></dt> 
     517<dd><p>Receives plottable, creates a list of data to fit,set data 
     518in a FitArrange object and adds that object in a dictionary  
     519with key id.</p> 
     520<table class="docutils field-list" frame="void" rules="none"> 
     521<col class="field-name" /> 
     522<col class="field-body" /> 
     523<tbody valign="top"> 
     524<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     525<li><strong>data</strong> &#8211; data added</li> 
     526<li><strong>id</strong> &#8211; unique key corresponding to a fitArrange object with data</li> 
     527</ul> 
     528</td> 
     529</tr> 
     530</tbody> 
     531</table> 
     532</dd></dl> 
     533 
     534<dl class="method"> 
     535<dt id="sans.fit.ParkFitting.ParkFit.set_model"> 
     536<tt class="descname">set_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.ParkFit.set_model" title="Permalink to this definition">¶</a></dt> 
     537<dd><p>set a model on a given  in the fit engine.</p> 
     538<table class="docutils field-list" frame="void" rules="none"> 
     539<col class="field-name" /> 
     540<col class="field-body" /> 
     541<tbody valign="top"> 
     542<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> &#8211; sans.models type</td> 
     543</tr> 
     544</tbody> 
     545</table> 
     546<dl class="docutils"> 
     547<dt>:param <span class="classifier-delimiter">:</span> <span class="classifier">is the key of the fitArrange dictionary where model is </span></dt> 
     548<dd>saved as a value</dd> 
     549</dl> 
     550<table class="docutils field-list" frame="void" rules="none"> 
     551<col class="field-name" /> 
     552<col class="field-body" /> 
     553<tbody valign="top"> 
     554<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
     555<li><strong>pars</strong> &#8211; the list of parameters to fit</li> 
     556<li><strong>constraints</strong> &#8211; <p>list of  
     557tuple (name of parameter, value of parameters) 
     558the value of parameter must be a string to constraint 2 different 
     559parameters. 
     560Example:   
     561we want to fit 2 model M1 and M2 both have parameters A and B. 
     562constraints can be:</p> 
     563<blockquote> 
     564<div>constraints = [(M1.A, M2.B+2), (M1.B= M2.A <a href="#id1"><span class="problematic" id="id2">*</span></a>5),...,]</div></blockquote> 
     565</li> 
     566</ul> 
     567</td> 
     568</tr> 
     569<tr class="field-even field"><th class="field-name">Note :</th><td class="field-body"><p class="first last">pars must contains only name of existing model&#8217;s parameters</p> 
     570</td> 
     571</tr> 
     572</tbody> 
     573</table> 
     574</dd></dl> 
     575 
     576</dd></dl> 
     577 
     578<dl class="class"> 
     579<dt id="sans.fit.ParkFitting.SansFitMC"> 
     580<em class="property">class </em><tt class="descclassname">sans.fit.ParkFitting.</tt><tt class="descname">SansFitMC</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC" title="Permalink to this definition">¶</a></dt> 
     581<dd><p>Bases: <a class="reference internal" href="#sans.fit.ParkFitting.SansFitter" title="sans.fit.ParkFitting.SansFitter"><tt class="xref py py-class docutils literal"><span class="pre">sans.fit.ParkFitting.SansFitter</span></tt></a></p> 
     582<p>Monte Carlo optimizer.</p> 
     583<p>This implements <cite>park.fit.Fitter</cite>.</p> 
     584<dl class="attribute"> 
     585<dt id="sans.fit.ParkFitting.SansFitMC.__class__"> 
     586<tt class="descname">__class__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC.__class__" title="Permalink to this definition">¶</a></dt> 
     587<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     588</dd></dl> 
     589 
     590<dl class="attribute"> 
     591<dt id="sans.fit.ParkFitting.SansFitMC.__delattr__"> 
     592<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC.__delattr__" title="Permalink to this definition">¶</a></dt> 
     593<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     594</dd></dl> 
     595 
     596<dl class="attribute"> 
     597<dt id="sans.fit.ParkFitting.SansFitMC.__dict__"> 
     598<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01D351B0&gt;</em><a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC.__dict__" title="Permalink to this definition">¶</a></dt> 
     599<dd></dd></dl> 
     600 
     601<dl class="attribute"> 
     602<dt id="sans.fit.ParkFitting.SansFitMC.__getattribute__"> 
     603<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     604<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     605</dd></dl> 
     606 
     607<dl class="attribute"> 
     608<dt id="sans.fit.ParkFitting.SansFitMC.__hash__"> 
     609<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC.__hash__" title="Permalink to this definition">¶</a></dt> 
     610<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     611</dd></dl> 
     612 
     613<dl class="method"> 
     614<dt id="sans.fit.ParkFitting.SansFitMC.__init__"> 
     615<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC.__init__" title="Permalink to this definition">¶</a></dt> 
     616<dd></dd></dl> 
     617 
     618<dl class="attribute"> 
     619<dt id="sans.fit.ParkFitting.SansFitMC.__module__"> 
     620<tt class="descname">__module__</tt><em class="property"> = 'sans.fit.ParkFitting'</em><a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC.__module__" title="Permalink to this definition">¶</a></dt> 
     621<dd></dd></dl> 
     622 
     623<dl class="staticmethod"> 
     624<dt id="sans.fit.ParkFitting.SansFitMC.__new__"> 
     625<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC.__new__" title="Permalink to this definition">¶</a></dt> 
     626<dd></dd></dl> 
     627 
     628<dl class="method"> 
     629<dt id="sans.fit.ParkFitting.SansFitMC.__reduce__"> 
     630<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC.__reduce__" title="Permalink to this definition">¶</a></dt> 
     631<dd><p>helper for pickle</p> 
     632</dd></dl> 
     633 
     634<dl class="method"> 
     635<dt id="sans.fit.ParkFitting.SansFitMC.__reduce_ex__"> 
     636<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     637<dd><p>helper for pickle</p> 
     638</dd></dl> 
     639 
     640<dl class="attribute"> 
     641<dt id="sans.fit.ParkFitting.SansFitMC.__repr__"> 
     642<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC.__repr__" title="Permalink to this definition">¶</a></dt> 
     643<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     644</dd></dl> 
     645 
     646<dl class="attribute"> 
     647<dt id="sans.fit.ParkFitting.SansFitMC.__setattr__"> 
     648<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC.__setattr__" title="Permalink to this definition">¶</a></dt> 
     649<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     650</dd></dl> 
     651 
     652<dl class="attribute"> 
     653<dt id="sans.fit.ParkFitting.SansFitMC.__str__"> 
     654<tt class="descname">__str__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC.__str__" title="Permalink to this definition">¶</a></dt> 
     655<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     656</dd></dl> 
     657 
     658<dl class="attribute"> 
     659<dt id="sans.fit.ParkFitting.SansFitMC.__weakref__"> 
     660<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC.__weakref__" title="Permalink to this definition">¶</a></dt> 
     661<dd><p>list of weak references to the object (if defined)</p> 
     662</dd></dl> 
     663 
     664<dl class="method"> 
     665<dt id="sans.fit.ParkFitting.SansFitMC._fit"> 
     666<tt class="descname">_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC._fit" title="Permalink to this definition">¶</a></dt> 
     667<dd><p>Run a monte carlo fit.</p> 
     668<p>This procedure maps a local optimizer across a set of initial points.</p> 
     669</dd></dl> 
     670 
     671<dl class="method"> 
     672<dt id="sans.fit.ParkFitting.SansFitMC._threaded"> 
     673<tt class="descname">_threaded</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC._threaded" title="Permalink to this definition">¶</a></dt> 
     674<dd></dd></dl> 
     675 
     676<dl class="method"> 
     677<dt id="sans.fit.ParkFitting.SansFitMC.fit"> 
     678<tt class="descname">fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC.fit" title="Permalink to this definition">¶</a></dt> 
     679<dd><p>Global optimizer.</p> 
     680<p>This function should return immediately</p> 
     681</dd></dl> 
     682 
     683<dl class="attribute"> 
     684<dt id="sans.fit.ParkFitting.SansFitMC.localfit"> 
     685<tt class="descname">localfit</tt><em class="property"> = &lt;sans.fit.ParkFitting.SansFitSimplex object at 0x01D084F0&gt;</em><a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC.localfit" title="Permalink to this definition">¶</a></dt> 
     686<dd></dd></dl> 
     687 
     688<dl class="attribute"> 
     689<dt id="sans.fit.ParkFitting.SansFitMC.start_points"> 
     690<tt class="descname">start_points</tt><em class="property"> = 10</em><a class="headerlink" href="#sans.fit.ParkFitting.SansFitMC.start_points" title="Permalink to this definition">¶</a></dt> 
     691<dd></dd></dl> 
     692 
     693</dd></dl> 
     694 
     695<dl class="class"> 
     696<dt id="sans.fit.ParkFitting.SansFitParameter"> 
     697<em class="property">class </em><tt class="descclassname">sans.fit.ParkFitting.</tt><tt class="descname">SansFitParameter</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitParameter" title="Permalink to this definition">¶</a></dt> 
     698<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">park.fitresult.FitParameter</span></tt></p> 
     699<p>Fit result for an individual parameter.</p> 
     700<dl class="attribute"> 
     701<dt id="sans.fit.ParkFitting.SansFitParameter.__class__"> 
     702<tt class="descname">__class__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitParameter.__class__" title="Permalink to this definition">¶</a></dt> 
     703<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     704</dd></dl> 
     705 
     706<dl class="attribute"> 
     707<dt id="sans.fit.ParkFitting.SansFitParameter.__delattr__"> 
     708<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitParameter.__delattr__" title="Permalink to this definition">¶</a></dt> 
     709<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     710</dd></dl> 
     711 
     712<dl class="attribute"> 
     713<dt id="sans.fit.ParkFitting.SansFitParameter.__dict__"> 
     714<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01D352D0&gt;</em><a class="headerlink" href="#sans.fit.ParkFitting.SansFitParameter.__dict__" title="Permalink to this definition">¶</a></dt> 
     715<dd></dd></dl> 
     716 
     717<dl class="attribute"> 
     718<dt id="sans.fit.ParkFitting.SansFitParameter.__getattribute__"> 
     719<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitParameter.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     720<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     721</dd></dl> 
     722 
     723<dl class="attribute"> 
     724<dt id="sans.fit.ParkFitting.SansFitParameter.__hash__"> 
     725<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitParameter.__hash__" title="Permalink to this definition">¶</a></dt> 
     726<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     727</dd></dl> 
     728 
     729<dl class="method"> 
     730<dt id="sans.fit.ParkFitting.SansFitParameter.__init__"> 
     731<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitParameter.__init__" title="Permalink to this definition">¶</a></dt> 
     732<dd></dd></dl> 
     733 
     734<dl class="attribute"> 
     735<dt id="sans.fit.ParkFitting.SansFitParameter.__module__"> 
     736<tt class="descname">__module__</tt><em class="property"> = 'sans.fit.ParkFitting'</em><a class="headerlink" href="#sans.fit.ParkFitting.SansFitParameter.__module__" title="Permalink to this definition">¶</a></dt> 
     737<dd></dd></dl> 
     738 
     739<dl class="staticmethod"> 
     740<dt id="sans.fit.ParkFitting.SansFitParameter.__new__"> 
     741<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.fit.ParkFitting.SansFitParameter.__new__" title="Permalink to this definition">¶</a></dt> 
     742<dd></dd></dl> 
     743 
     744<dl class="method"> 
     745<dt id="sans.fit.ParkFitting.SansFitParameter.__reduce__"> 
     746<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitParameter.__reduce__" title="Permalink to this definition">¶</a></dt> 
     747<dd><p>helper for pickle</p> 
     748</dd></dl> 
     749 
     750<dl class="method"> 
     751<dt id="sans.fit.ParkFitting.SansFitParameter.__reduce_ex__"> 
     752<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitParameter.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     753<dd><p>helper for pickle</p> 
     754</dd></dl> 
     755 
     756<dl class="method"> 
     757<dt id="sans.fit.ParkFitting.SansFitParameter.__repr__"> 
     758<tt class="descname">__repr__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitParameter.__repr__" title="Permalink to this definition">¶</a></dt> 
     759<dd></dd></dl> 
     760 
     761<dl class="attribute"> 
     762<dt id="sans.fit.ParkFitting.SansFitParameter.__setattr__"> 
     763<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitParameter.__setattr__" title="Permalink to this definition">¶</a></dt> 
     764<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     765</dd></dl> 
     766 
     767<dl class="attribute"> 
     768<dt id="sans.fit.ParkFitting.SansFitParameter.__str__"> 
     769<tt class="descname">__str__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitParameter.__str__" title="Permalink to this definition">¶</a></dt> 
     770<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     771</dd></dl> 
     772 
     773<dl class="attribute"> 
     774<dt id="sans.fit.ParkFitting.SansFitParameter.__weakref__"> 
     775<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitParameter.__weakref__" title="Permalink to this definition">¶</a></dt> 
     776<dd><p>list of weak references to the object (if defined)</p> 
     777</dd></dl> 
     778 
     779<dl class="method"> 
     780<dt id="sans.fit.ParkFitting.SansFitParameter.summarize"> 
     781<tt class="descname">summarize</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitParameter.summarize" title="Permalink to this definition">¶</a></dt> 
     782<dd><p>Return parameter range string.</p> 
     783<p>E.g.,  &#8221;       Gold .....|.... 5.2043 in [2,7]&#8221;</p> 
     784</dd></dl> 
     785 
     786</dd></dl> 
     787 
     788<dl class="class"> 
     789<dt id="sans.fit.ParkFitting.SansFitResult"> 
     790<em class="property">class </em><tt class="descclassname">sans.fit.ParkFitting.</tt><tt class="descname">SansFitResult</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitResult" title="Permalink to this definition">¶</a></dt> 
     791<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">park.fitresult.FitResult</span></tt></p> 
     792<dl class="attribute"> 
     793<dt id="sans.fit.ParkFitting.SansFitResult.__class__"> 
     794<tt class="descname">__class__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitResult.__class__" title="Permalink to this definition">¶</a></dt> 
     795<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     796</dd></dl> 
     797 
     798<dl class="attribute"> 
     799<dt id="sans.fit.ParkFitting.SansFitResult.__delattr__"> 
     800<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitResult.__delattr__" title="Permalink to this definition">¶</a></dt> 
     801<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     802</dd></dl> 
     803 
     804<dl class="attribute"> 
     805<dt id="sans.fit.ParkFitting.SansFitResult.__dict__"> 
     806<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01D358D0&gt;</em><a class="headerlink" href="#sans.fit.ParkFitting.SansFitResult.__dict__" title="Permalink to this definition">¶</a></dt> 
     807<dd></dd></dl> 
     808 
     809<dl class="attribute"> 
     810<dt id="sans.fit.ParkFitting.SansFitResult.__getattribute__"> 
     811<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitResult.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     812<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     813</dd></dl> 
     814 
     815<dl class="attribute"> 
     816<dt id="sans.fit.ParkFitting.SansFitResult.__hash__"> 
     817<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitResult.__hash__" title="Permalink to this definition">¶</a></dt> 
     818<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     819</dd></dl> 
     820 
     821<dl class="method"> 
     822<dt id="sans.fit.ParkFitting.SansFitResult.__init__"> 
     823<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitResult.__init__" title="Permalink to this definition">¶</a></dt> 
     824<dd></dd></dl> 
     825 
     826<dl class="attribute"> 
     827<dt id="sans.fit.ParkFitting.SansFitResult.__module__"> 
     828<tt class="descname">__module__</tt><em class="property"> = 'sans.fit.ParkFitting'</em><a class="headerlink" href="#sans.fit.ParkFitting.SansFitResult.__module__" title="Permalink to this definition">¶</a></dt> 
     829<dd></dd></dl> 
     830 
     831<dl class="staticmethod"> 
     832<dt id="sans.fit.ParkFitting.SansFitResult.__new__"> 
     833<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.fit.ParkFitting.SansFitResult.__new__" title="Permalink to this definition">¶</a></dt> 
     834<dd></dd></dl> 
     835 
     836<dl class="method"> 
     837<dt id="sans.fit.ParkFitting.SansFitResult.__reduce__"> 
     838<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitResult.__reduce__" title="Permalink to this definition">¶</a></dt> 
     839<dd><p>helper for pickle</p> 
     840</dd></dl> 
     841 
     842<dl class="method"> 
     843<dt id="sans.fit.ParkFitting.SansFitResult.__reduce_ex__"> 
     844<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitResult.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     845<dd><p>helper for pickle</p> 
     846</dd></dl> 
     847 
     848<dl class="attribute"> 
     849<dt id="sans.fit.ParkFitting.SansFitResult.__repr__"> 
     850<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitResult.__repr__" title="Permalink to this definition">¶</a></dt> 
     851<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     852</dd></dl> 
     853 
     854<dl class="attribute"> 
     855<dt id="sans.fit.ParkFitting.SansFitResult.__setattr__"> 
     856<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitResult.__setattr__" title="Permalink to this definition">¶</a></dt> 
     857<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     858</dd></dl> 
     859 
     860<dl class="method"> 
     861<dt id="sans.fit.ParkFitting.SansFitResult.__str__"> 
     862<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitResult.__str__" title="Permalink to this definition">¶</a></dt> 
     863<dd></dd></dl> 
     864 
     865<dl class="attribute"> 
     866<dt id="sans.fit.ParkFitting.SansFitResult.__weakref__"> 
     867<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitResult.__weakref__" title="Permalink to this definition">¶</a></dt> 
     868<dd><p>list of weak references to the object (if defined)</p> 
     869</dd></dl> 
     870 
     871<dl class="method"> 
     872<dt id="sans.fit.ParkFitting.SansFitResult.calc_cov"> 
     873<tt class="descname">calc_cov</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitResult.calc_cov" title="Permalink to this definition">¶</a></dt> 
     874<dd><p>Return the covariance matrix inv(J&#8217;J) at point p.</p> 
     875</dd></dl> 
     876 
     877<dl class="method"> 
     878<dt id="sans.fit.ParkFitting.SansFitResult.print_summary"> 
     879<tt class="descname">print_summary</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitResult.print_summary" title="Permalink to this definition">¶</a></dt> 
     880<dd></dd></dl> 
     881 
     882<dl class="method"> 
     883<dt id="sans.fit.ParkFitting.SansFitResult.set_cov"> 
     884<tt class="descname">set_cov</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitResult.set_cov" title="Permalink to this definition">¶</a></dt> 
     885<dd><p>Return the covariance matrix inv(J&#8217;J) at point p.</p> 
     886</dd></dl> 
     887 
     888<dl class="method"> 
     889<dt id="sans.fit.ParkFitting.SansFitResult.update"> 
     890<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitResult.update" title="Permalink to this definition">¶</a></dt> 
     891<dd></dd></dl> 
     892 
     893</dd></dl> 
     894 
     895<dl class="class"> 
     896<dt id="sans.fit.ParkFitting.SansFitSimplex"> 
     897<em class="property">class </em><tt class="descclassname">sans.fit.ParkFitting.</tt><tt class="descname">SansFitSimplex</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex" title="Permalink to this definition">¶</a></dt> 
     898<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">park.fitmc.FitSimplex</span></tt></p> 
     899<p>Local minimizer using Nelder-Mead simplex algorithm.</p> 
     900<p>Simplex is robust and derivative free, though not very efficient.</p> 
     901<p>This class wraps the bounds contrained Nelder-Mead simplex 
     902implementation for <cite>park.simplex.simplex</cite>.</p> 
     903<dl class="attribute"> 
     904<dt id="sans.fit.ParkFitting.SansFitSimplex.__class__"> 
     905<tt class="descname">__class__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.__class__" title="Permalink to this definition">¶</a></dt> 
     906<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     907</dd></dl> 
     908 
     909<dl class="attribute"> 
     910<dt id="sans.fit.ParkFitting.SansFitSimplex.__delattr__"> 
     911<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.__delattr__" title="Permalink to this definition">¶</a></dt> 
     912<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     913</dd></dl> 
     914 
     915<dl class="attribute"> 
     916<dt id="sans.fit.ParkFitting.SansFitSimplex.__dict__"> 
     917<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01D35CB0&gt;</em><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.__dict__" title="Permalink to this definition">¶</a></dt> 
     918<dd></dd></dl> 
     919 
     920<dl class="attribute"> 
     921<dt id="sans.fit.ParkFitting.SansFitSimplex.__getattribute__"> 
     922<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     923<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     924</dd></dl> 
     925 
     926<dl class="attribute"> 
     927<dt id="sans.fit.ParkFitting.SansFitSimplex.__hash__"> 
     928<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.__hash__" title="Permalink to this definition">¶</a></dt> 
     929<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     930</dd></dl> 
     931 
     932<dl class="method"> 
     933<dt id="sans.fit.ParkFitting.SansFitSimplex.__init__"> 
     934<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.__init__" title="Permalink to this definition">¶</a></dt> 
     935<dd></dd></dl> 
     936 
     937<dl class="attribute"> 
     938<dt id="sans.fit.ParkFitting.SansFitSimplex.__module__"> 
     939<tt class="descname">__module__</tt><em class="property"> = 'sans.fit.ParkFitting'</em><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.__module__" title="Permalink to this definition">¶</a></dt> 
     940<dd></dd></dl> 
     941 
     942<dl class="staticmethod"> 
     943<dt id="sans.fit.ParkFitting.SansFitSimplex.__new__"> 
     944<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.__new__" title="Permalink to this definition">¶</a></dt> 
     945<dd></dd></dl> 
     946 
     947<dl class="method"> 
     948<dt id="sans.fit.ParkFitting.SansFitSimplex.__reduce__"> 
     949<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.__reduce__" title="Permalink to this definition">¶</a></dt> 
     950<dd><p>helper for pickle</p> 
     951</dd></dl> 
     952 
     953<dl class="method"> 
     954<dt id="sans.fit.ParkFitting.SansFitSimplex.__reduce_ex__"> 
     955<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     956<dd><p>helper for pickle</p> 
     957</dd></dl> 
     958 
     959<dl class="attribute"> 
     960<dt id="sans.fit.ParkFitting.SansFitSimplex.__repr__"> 
     961<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.__repr__" title="Permalink to this definition">¶</a></dt> 
     962<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     963</dd></dl> 
     964 
     965<dl class="attribute"> 
     966<dt id="sans.fit.ParkFitting.SansFitSimplex.__setattr__"> 
     967<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.__setattr__" title="Permalink to this definition">¶</a></dt> 
     968<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     969</dd></dl> 
     970 
     971<dl class="attribute"> 
     972<dt id="sans.fit.ParkFitting.SansFitSimplex.__str__"> 
     973<tt class="descname">__str__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.__str__" title="Permalink to this definition">¶</a></dt> 
     974<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     975</dd></dl> 
     976 
     977<dl class="attribute"> 
     978<dt id="sans.fit.ParkFitting.SansFitSimplex.__weakref__"> 
     979<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.__weakref__" title="Permalink to this definition">¶</a></dt> 
     980<dd><p>list of weak references to the object (if defined)</p> 
     981</dd></dl> 
     982 
     983<dl class="method"> 
     984<dt id="sans.fit.ParkFitting.SansFitSimplex._iscancelled"> 
     985<tt class="descname">_iscancelled</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex._iscancelled" title="Permalink to this definition">¶</a></dt> 
     986<dd></dd></dl> 
     987 
     988<dl class="method"> 
     989<dt id="sans.fit.ParkFitting.SansFitSimplex.abort"> 
     990<tt class="descname">abort</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.abort" title="Permalink to this definition">¶</a></dt> 
     991<dd><p>Cancel the fit in progress from another thread of execution</p> 
     992</dd></dl> 
     993 
     994<dl class="method"> 
     995<dt id="sans.fit.ParkFitting.SansFitSimplex.fit"> 
     996<tt class="descname">fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.fit" title="Permalink to this definition">¶</a></dt> 
     997<dd><p>Run the fit</p> 
     998</dd></dl> 
     999 
     1000<dl class="attribute"> 
     1001<dt id="sans.fit.ParkFitting.SansFitSimplex.ftol"> 
     1002<tt class="descname">ftol</tt><em class="property"> = 5.0000000000000002e-005</em><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.ftol" title="Permalink to this definition">¶</a></dt> 
     1003<dd><p>Stop when vertex values are within ftol of each other</p> 
     1004</dd></dl> 
     1005 
     1006<dl class="attribute"> 
     1007<dt id="sans.fit.ParkFitting.SansFitSimplex.maxiter"> 
     1008<tt class="descname">maxiter</tt><em class="property"> = None</em><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.maxiter" title="Permalink to this definition">¶</a></dt> 
     1009<dd><p>Maximum number of iterations before fit terminates</p> 
     1010</dd></dl> 
     1011 
     1012<dl class="attribute"> 
     1013<dt id="sans.fit.ParkFitting.SansFitSimplex.radius"> 
     1014<tt class="descname">radius</tt><em class="property"> = 0.050000000000000003</em><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.radius" title="Permalink to this definition">¶</a></dt> 
     1015<dd><p>Size of the initial simplex; this is a portion between 0 and 1</p> 
     1016</dd></dl> 
     1017 
     1018<dl class="attribute"> 
     1019<dt id="sans.fit.ParkFitting.SansFitSimplex.xtol"> 
     1020<tt class="descname">xtol</tt><em class="property"> = 1</em><a class="headerlink" href="#sans.fit.ParkFitting.SansFitSimplex.xtol" title="Permalink to this definition">¶</a></dt> 
     1021<dd><p>Stop when simplex vertices are within xtol of each other</p> 
     1022</dd></dl> 
     1023 
     1024</dd></dl> 
     1025 
     1026<dl class="class"> 
     1027<dt id="sans.fit.ParkFitting.SansFitter"> 
     1028<em class="property">class </em><tt class="descclassname">sans.fit.ParkFitting.</tt><tt class="descname">SansFitter</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitter" title="Permalink to this definition">¶</a></dt> 
     1029<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">park.fit.Fitter</span></tt></p> 
     1030<dl class="attribute"> 
     1031<dt id="sans.fit.ParkFitting.SansFitter.__class__"> 
     1032<tt class="descname">__class__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitter.__class__" title="Permalink to this definition">¶</a></dt> 
     1033<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     1034</dd></dl> 
     1035 
     1036<dl class="attribute"> 
     1037<dt id="sans.fit.ParkFitting.SansFitter.__delattr__"> 
     1038<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitter.__delattr__" title="Permalink to this definition">¶</a></dt> 
     1039<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     1040</dd></dl> 
     1041 
     1042<dl class="attribute"> 
     1043<dt id="sans.fit.ParkFitting.SansFitter.__dict__"> 
     1044<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01D35B10&gt;</em><a class="headerlink" href="#sans.fit.ParkFitting.SansFitter.__dict__" title="Permalink to this definition">¶</a></dt> 
     1045<dd></dd></dl> 
     1046 
     1047<dl class="attribute"> 
     1048<dt id="sans.fit.ParkFitting.SansFitter.__getattribute__"> 
     1049<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitter.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     1050<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     1051</dd></dl> 
     1052 
     1053<dl class="attribute"> 
     1054<dt id="sans.fit.ParkFitting.SansFitter.__hash__"> 
     1055<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitter.__hash__" title="Permalink to this definition">¶</a></dt> 
     1056<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     1057</dd></dl> 
     1058 
     1059<dl class="method"> 
     1060<dt id="sans.fit.ParkFitting.SansFitter.__init__"> 
     1061<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitter.__init__" title="Permalink to this definition">¶</a></dt> 
     1062<dd></dd></dl> 
     1063 
     1064<dl class="attribute"> 
     1065<dt id="sans.fit.ParkFitting.SansFitter.__module__"> 
     1066<tt class="descname">__module__</tt><em class="property"> = 'sans.fit.ParkFitting'</em><a class="headerlink" href="#sans.fit.ParkFitting.SansFitter.__module__" title="Permalink to this definition">¶</a></dt> 
     1067<dd></dd></dl> 
     1068 
     1069<dl class="staticmethod"> 
     1070<dt id="sans.fit.ParkFitting.SansFitter.__new__"> 
     1071<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.fit.ParkFitting.SansFitter.__new__" title="Permalink to this definition">¶</a></dt> 
     1072<dd></dd></dl> 
     1073 
     1074<dl class="method"> 
     1075<dt id="sans.fit.ParkFitting.SansFitter.__reduce__"> 
     1076<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitter.__reduce__" title="Permalink to this definition">¶</a></dt> 
     1077<dd><p>helper for pickle</p> 
     1078</dd></dl> 
     1079 
     1080<dl class="method"> 
     1081<dt id="sans.fit.ParkFitting.SansFitter.__reduce_ex__"> 
     1082<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitter.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     1083<dd><p>helper for pickle</p> 
     1084</dd></dl> 
     1085 
     1086<dl class="attribute"> 
     1087<dt id="sans.fit.ParkFitting.SansFitter.__repr__"> 
     1088<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitter.__repr__" title="Permalink to this definition">¶</a></dt> 
     1089<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     1090</dd></dl> 
     1091 
     1092<dl class="attribute"> 
     1093<dt id="sans.fit.ParkFitting.SansFitter.__setattr__"> 
     1094<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitter.__setattr__" title="Permalink to this definition">¶</a></dt> 
     1095<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     1096</dd></dl> 
     1097 
     1098<dl class="attribute"> 
     1099<dt id="sans.fit.ParkFitting.SansFitter.__str__"> 
     1100<tt class="descname">__str__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitter.__str__" title="Permalink to this definition">¶</a></dt> 
     1101<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     1102</dd></dl> 
     1103 
     1104<dl class="attribute"> 
     1105<dt id="sans.fit.ParkFitting.SansFitter.__weakref__"> 
     1106<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansFitter.__weakref__" title="Permalink to this definition">¶</a></dt> 
     1107<dd><p>list of weak references to the object (if defined)</p> 
     1108</dd></dl> 
     1109 
     1110<dl class="method"> 
     1111<dt id="sans.fit.ParkFitting.SansFitter._fit"> 
     1112<tt class="descname">_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitter._fit" title="Permalink to this definition">¶</a></dt> 
     1113<dd><p>Run the actual fit in a separate thread</p> 
     1114<dl class="docutils"> 
     1115<dt>Each cycle k of n:</dt> 
     1116<dd>self.handler.progress(k,n)</dd> 
     1117<dt>Each improvement:</dt> 
     1118<dd>self.handler.result.update(x,fx,ncalls) 
     1119self.handler.improvement()</dd> 
     1120<dt>On completion (if not already performed):</dt> 
     1121<dd>self.hander.result.update(x,fx,ncalls) 
     1122self.handler.done 
     1123self.handler.finalize()</dd> 
     1124</dl> 
     1125</dd></dl> 
     1126 
     1127<dl class="method"> 
     1128<dt id="sans.fit.ParkFitting.SansFitter._threaded"> 
     1129<tt class="descname">_threaded</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitter._threaded" title="Permalink to this definition">¶</a></dt> 
     1130<dd></dd></dl> 
     1131 
     1132<dl class="method"> 
     1133<dt id="sans.fit.ParkFitting.SansFitter.fit"> 
     1134<tt class="descname">fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansFitter.fit" title="Permalink to this definition">¶</a></dt> 
     1135<dd><p>Global optimizer.</p> 
     1136<p>This function should return immediately</p> 
     1137</dd></dl> 
     1138 
     1139</dd></dl> 
     1140 
     1141<dl class="class"> 
     1142<dt id="sans.fit.ParkFitting.SansPart"> 
     1143<em class="property">class </em><tt class="descclassname">sans.fit.ParkFitting.</tt><tt class="descname">SansPart</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansPart" title="Permalink to this definition">¶</a></dt> 
     1144<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">park.assembly.Part</span></tt></p> 
     1145<p>Part of a fitting assembly.  Part holds the model itself and 
     1146associated data.  The part can be initialized with a fitness 
     1147object or with a pair (model,data) for the default fitness function.</p> 
     1148<dl class="docutils"> 
     1149<dt>fitness (Fitness)</dt> 
     1150<dd>object implementing the <cite>park.assembly.Fitness</cite> interface.  In 
     1151particular, fitness should provide a parameterset attribute 
     1152containing a ParameterSet and a residuals method returning a vector 
     1153of residuals.</dd> 
     1154<dt>weight (dimensionless)</dt> 
     1155<dd>weight for the model.  See comments in assembly.py for details.</dd> 
     1156<dt>isfitted (boolean)</dt> 
     1157<dd>True if the model residuals should be included in the fit. 
     1158The model parameters may still be used in parameter 
     1159expressions, but there will be no comparison to the data.</dd> 
     1160<dt>residuals (vector)</dt> 
     1161<dd>Residuals for the model if they have been calculated, or None</dd> 
     1162<dt>degrees_of_freedom</dt> 
     1163<dd>Number of residuals minus number of fitted parameters. 
     1164Degrees of freedom for individual models does not make 
     1165sense in the presence of expressions combining models, 
     1166particularly in the case where a model has many parameters 
     1167but no data or many computed parameters.  The degrees of 
     1168freedom for the model is set to be at least one.</dd> 
     1169<dt>chisq</dt> 
     1170<dd><p class="first">sum(residuals**2); use chisq/degrees_of_freedom to 
     1171get the reduced chisq value.</p> 
     1172<p>Get/set the weight on the given model.</p> 
     1173<p class="last">assembly.weight(3) returns the weight on model 3 (0-origin) 
     1174assembly.weight(3,0.5) sets the weight on model 3 (0-origin)</p> 
     1175</dd> 
     1176</dl> 
     1177<dl class="attribute"> 
     1178<dt id="sans.fit.ParkFitting.SansPart.__class__"> 
     1179<tt class="descname">__class__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansPart.__class__" title="Permalink to this definition">¶</a></dt> 
     1180<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     1181</dd></dl> 
     1182 
     1183<dl class="attribute"> 
     1184<dt id="sans.fit.ParkFitting.SansPart.__delattr__"> 
     1185<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansPart.__delattr__" title="Permalink to this definition">¶</a></dt> 
     1186<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     1187</dd></dl> 
     1188 
     1189<dl class="attribute"> 
     1190<dt id="sans.fit.ParkFitting.SansPart.__dict__"> 
     1191<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01D29050&gt;</em><a class="headerlink" href="#sans.fit.ParkFitting.SansPart.__dict__" title="Permalink to this definition">¶</a></dt> 
     1192<dd></dd></dl> 
     1193 
     1194<dl class="attribute"> 
     1195<dt id="sans.fit.ParkFitting.SansPart.__getattribute__"> 
     1196<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansPart.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     1197<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     1198</dd></dl> 
     1199 
     1200<dl class="attribute"> 
     1201<dt id="sans.fit.ParkFitting.SansPart.__hash__"> 
     1202<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansPart.__hash__" title="Permalink to this definition">¶</a></dt> 
     1203<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     1204</dd></dl> 
     1205 
     1206<dl class="method"> 
     1207<dt id="sans.fit.ParkFitting.SansPart.__init__"> 
     1208<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansPart.__init__" title="Permalink to this definition">¶</a></dt> 
     1209<dd></dd></dl> 
     1210 
     1211<dl class="attribute"> 
     1212<dt id="sans.fit.ParkFitting.SansPart.__module__"> 
     1213<tt class="descname">__module__</tt><em class="property"> = 'sans.fit.ParkFitting'</em><a class="headerlink" href="#sans.fit.ParkFitting.SansPart.__module__" title="Permalink to this definition">¶</a></dt> 
     1214<dd></dd></dl> 
     1215 
     1216<dl class="staticmethod"> 
     1217<dt id="sans.fit.ParkFitting.SansPart.__new__"> 
     1218<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.fit.ParkFitting.SansPart.__new__" title="Permalink to this definition">¶</a></dt> 
     1219<dd></dd></dl> 
     1220 
     1221<dl class="method"> 
     1222<dt id="sans.fit.ParkFitting.SansPart.__reduce__"> 
     1223<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansPart.__reduce__" title="Permalink to this definition">¶</a></dt> 
     1224<dd><p>helper for pickle</p> 
     1225</dd></dl> 
     1226 
     1227<dl class="method"> 
     1228<dt id="sans.fit.ParkFitting.SansPart.__reduce_ex__"> 
     1229<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ParkFitting.SansPart.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     1230<dd><p>helper for pickle</p> 
     1231</dd></dl> 
     1232 
     1233<dl class="attribute"> 
     1234<dt id="sans.fit.ParkFitting.SansPart.__repr__"> 
     1235<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansPart.__repr__" title="Permalink to this definition">¶</a></dt> 
     1236<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     1237</dd></dl> 
     1238 
     1239<dl class="attribute"> 
     1240<dt id="sans.fit.ParkFitting.SansPart.__setattr__"> 
     1241<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansPart.__setattr__" title="Permalink to this definition">¶</a></dt> 
     1242<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     1243</dd></dl> 
     1244 
     1245<dl class="attribute"> 
     1246<dt id="sans.fit.ParkFitting.SansPart.__str__"> 
     1247<tt class="descname">__str__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansPart.__str__" title="Permalink to this definition">¶</a></dt> 
     1248<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     1249</dd></dl> 
     1250 
     1251<dl class="attribute"> 
     1252<dt id="sans.fit.ParkFitting.SansPart.__weakref__"> 
     1253<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.fit.ParkFitting.SansPart.__weakref__" title="Permalink to this definition">¶</a></dt> 
     1254<dd><p>list of weak references to the object (if defined)</p> 
     1255</dd></dl> 
     1256 
     1257</dd></dl> 
     1258 
    601259</div> 
    611260</div> 
    … …  
    761275 
    771276  <h4>Previous topic</h4> 
    78   <p class="topless"><a href="Fitting.html" 
    79                         title="previous chapter">Fitting</a></p> 
     1277  <p class="topless"><a href="Loader.html" 
     1278                        title="previous chapter">Loader</a></p> 
    801279  <h4>Next topic</h4> 
    811280  <p class="topless"><a href="ScipyFitting.html" 
    … …  
    891288  <h3>Quick search</h3> 
    901289    <form class="search" action="../search.html" method="get"> 
    91       <input type="text" name="q" size="18" /> 
     1290      <input type="text" name="q" /> 
    921291      <input type="submit" value="Go" /> 
    931292      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    1161315             >next</a> |</li> 
    1171316        <li class="right" > 
    118           <a href="Fitting.html" title="Fitting" 
     1317          <a href="Loader.html" title="Loader" 
    1191318             >previous</a> |</li> 
    120         <li><a href="../index.html">park_integration v0.1.0 documentation</a> &raquo;</li> 
     1319        <li><a href="../index.html">park_integration 0.1.0 documentation</a> &raquo;</li> 
    1211320          <li><a href="index.html" >Reference</a> &raquo;</li>  
    1221321      </ul> 
    … …  
    1241323    <div class="footer"> 
    1251324        &copy; Copyright 2010, sans group. 
    126       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     1325      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    1271326    </div> 
    1281327  </body> 

  • park_integration/docs/sphinx/html/api/ScipyFitting.html

    r6b1588b rf696e2a  
    33<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
    44  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
     5 
    56 
    67<html xmlns="http://www.w3.org/1999/xhtml"> 
    … …  
    89    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 
    910     
    10     <title>ScipyFitting &mdash; park_integration v0.1.0 documentation</title> 
     11    <title>ScipyFitting &mdash; park_integration 0.1.0 documentation</title> 
     12     
    1113    <link rel="stylesheet" href="../_static/default.css" type="text/css" /> 
    1214    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> 
     15     
    1316    <script type="text/javascript"> 
    1417      var DOCUMENTATION_OPTIONS = { 
    … …  
    2326    <script type="text/javascript" src="../_static/underscore.js"></script> 
    2427    <script type="text/javascript" src="../_static/doctools.js"></script> 
    25     <link rel="top" title="park_integration v0.1.0 documentation" href="../index.html" /> 
     28    <link rel="top" title="park_integration 0.1.0 documentation" href="../index.html" /> 
    2629    <link rel="up" title="Reference" href="index.html" /> 
    2730    <link rel="prev" title="ParkFitting" href="ParkFitting.html" />  
    … …  
    4043          <a href="ParkFitting.html" title="ParkFitting" 
    4144             accesskey="P">previous</a> |</li> 
    42         <li><a href="../index.html">park_integration v0.1.0 documentation</a> &raquo;</li> 
     45        <li><a href="../index.html">park_integration 0.1.0 documentation</a> &raquo;</li> 
    4346          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li>  
    4447      </ul> 
    … …  
    5255  <div class="section" id="scipyfitting"> 
    5356<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<div class="section" id="mod-sans-fit-scipyfitting"> 
     58<h2>:mod:` sans.fit.ScipyFitting`<a class="headerlink" href="#mod-sans-fit-scipyfitting" title="Permalink to this headline">¶</a></h2> 
     59<span class="target" id="module-sans.fit.ScipyFitting"></span><p>ScipyFitting module contains FitArrange , ScipyFit, 
    5760Parameter classes.All listed classes work together to perform a  
    5861simple fit with scipy optimizer.</p> 
    … …  
    7477<col class="field-body" /> 
    7578<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() 
     79<tr class="field-odd field"><th class="field-name">Note :</th><td class="field-body">Set_param() if used must always preceded set_model() 
    7780for the fit to be performed.In case of Scipyfit set_param is called in 
    7881fit () automatically.</td> 
    … …  
    8790chisqr1, out1, cov1=engine.fit({model.parameter.name:value},qmin,qmax)</p> 
    8891<dl class="method"> 
     92<dt id="sans.fit.ScipyFitting.ScipyFit.__init__"> 
     93<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ScipyFitting.ScipyFit.__init__" title="Permalink to this definition">¶</a></dt> 
     94<dd><p>Creates a dictionary (self.fit_arrange_dict={})of FitArrange elements 
     95with Uid as keys</p> 
     96</dd></dl> 
     97 
     98<dl class="attribute"> 
     99<dt id="sans.fit.ScipyFitting.ScipyFit.__module__"> 
     100<tt class="descname">__module__</tt><em class="property"> = 'sans.fit.ScipyFitting'</em><a class="headerlink" href="#sans.fit.ScipyFitting.ScipyFit.__module__" title="Permalink to this definition">¶</a></dt> 
     101<dd></dd></dl> 
     102 
     103<dl class="method"> 
     104<dt id="sans.fit.ScipyFitting.ScipyFit._check_param_range"> 
     105<tt class="descname">_check_param_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ScipyFitting.ScipyFit._check_param_range" title="Permalink to this definition">¶</a></dt> 
     106<dd><p>Check parameter range and set the initial value inside  
     107if it is out of range.</p> 
     108<p>: model: park model object</p> 
     109</dd></dl> 
     110 
     111<dl class="method"> 
     112<dt id="sans.fit.ScipyFitting.ScipyFit._get_zero_shift"> 
     113<tt class="descname">_get_zero_shift</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ScipyFitting.ScipyFit._get_zero_shift" title="Permalink to this definition">¶</a></dt> 
     114<dd><p>Get 10% shift of the param value = 0 based on the range value</p> 
     115<p>: param range: min or max value of the bounds</p> 
     116</dd></dl> 
     117 
     118<dl class="method"> 
    89119<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> 
     120<tt class="descname">fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ScipyFitting.ScipyFit.fit" title="Permalink to this definition">¶</a></dt> 
    91121<dd></dd></dl> 
    92122 
    93123<dl class="method"> 
    94124<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> 
     125<tt class="descname">get_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ScipyFitting.ScipyFit.get_model" title="Permalink to this definition">¶</a></dt> 
    96126<dd><table class="docutils field-list" frame="void" rules="none"> 
    97127<col class="field-name" /> 
    98128<col class="field-body" /> 
    99129<tbody valign="top"> 
    100 <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> 
    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  
     130<tr class="field-odd 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> 
     131</tr> 
     132<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">a model at this id or None if no FitArrange element was  
    103133created with this id</td> 
    104134</tr> 
    … …  
    109139<dl class="method"> 
    110140<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> 
     141<tt class="descname">get_problem_to_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ScipyFitting.ScipyFit.get_problem_to_fit" title="Permalink to this definition">¶</a></dt> 
    112142<dd><p>return the self.selected value of the fit problem of id</p> 
    113143<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    115145<col class="field-body" /> 
    116146<tbody valign="top"> 
    117 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> &#8211; the id of the problem</td> 
     147<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>id</strong> &#8211; the id of the problem</td> 
    118148</tr> 
    119149</tbody> 
    … …  
    123153<dl class="method"> 
    124154<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> 
     155<tt class="descname">remove_fit_problem</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ScipyFitting.ScipyFit.remove_fit_problem" title="Permalink to this definition">¶</a></dt> 
    126156<dd><p>remove   fitarrange in id</p> 
    127157</dd></dl> 
    … …  
    129159<dl class="method"> 
    130160<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> 
     161<tt class="descname">select_problem_for_fit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ScipyFitting.ScipyFit.select_problem_for_fit" title="Permalink to this definition">¶</a></dt> 
    132162<dd><p>select a couple of model and data at the id position in dictionary 
    133163and set in self.selected value to value</p> 
    … …  
    136166<col class="field-body" /> 
    137167<tbody valign="top"> 
    138 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> &#8211; the value to allow fitting.  
     168<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> &#8211; the value to allow fitting.  
    139169can only have the value one or zero</td> 
    140170</tr> 
    … …  
    145175<dl class="method"> 
    146176<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> 
     177<tt class="descname">set_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ScipyFitting.ScipyFit.set_data" title="Permalink to this definition">¶</a></dt> 
    148178<dd><p>Receives plottable, creates a list of data to fit,set data 
    149179in a FitArrange object and adds that object in a dictionary  
    … …  
    153183<col class="field-body" /> 
    154184<tbody valign="top"> 
    155 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     185<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    156186<li><strong>data</strong> &#8211; data added</li> 
    157187<li><strong>id</strong> &#8211; unique key corresponding to a fitArrange object with data</li> 
    … …  
    165195<dl class="method"> 
    166196<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> 
     197<tt class="descname">set_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.fit.ScipyFitting.ScipyFit.set_model" title="Permalink to this definition">¶</a></dt> 
    168198<dd><p>set a model on a given  in the fit engine.</p> 
    169199<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    171201<col class="field-body" /> 
    172202<tbody valign="top"> 
    173 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> &#8211; sans.models type</td> 
     203<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> &#8211; sans.models type</td> 
    174204</tr> 
    175205</tbody> 
    … …  
    183213<col class="field-body" /> 
    184214<tbody valign="top"> 
    185 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
     215<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> 
    186216<li><strong>pars</strong> &#8211; the list of parameters to fit</li> 
    187217<li><strong>constraints</strong> &#8211; <p>list of  
    … …  
    198228</td> 
    199229</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&#8217;s parameters</p> 
     230<tr class="field-even field"><th class="field-name">Note :</th><td class="field-body"><p class="first last">pars must contains only name of existing model&#8217;s parameters</p> 
    201231</td> 
    202232</tr> 
    … …  
    204234</table> 
    205235</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> 
    228236 
    229237</dd></dl> 
    … …  
    241249  <ul> 
    242250<li><a class="reference internal" href="#">ScipyFitting</a><ul> 
    243 <li><a class="reference internal" href="#module-sans.fit.ScipyFitting">:mod:` sans.fit.ScipyFitting`</a></li> 
     251<li><a class="reference internal" href="#mod-sans-fit-scipyfitting">:mod:` sans.fit.ScipyFitting`</a></li> 
    244252</ul> 
    245253</li> 
    … …  
    257265  <h3>Quick search</h3> 
    258266    <form class="search" action="../search.html" method="get"> 
    259       <input type="text" name="q" size="18" /> 
     267      <input type="text" name="q" /> 
    260268      <input type="submit" value="Go" /> 
    261269      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    283291          <a href="ParkFitting.html" title="ParkFitting" 
    284292             >previous</a> |</li> 
    285         <li><a href="../index.html">park_integration v0.1.0 documentation</a> &raquo;</li> 
     293        <li><a href="../index.html">park_integration 0.1.0 documentation</a> &raquo;</li> 
    286294          <li><a href="index.html" >Reference</a> &raquo;</li>  
    287295      </ul> 
    … …  
    289297    <div class="footer"> 
    290298        &copy; Copyright 2010, sans group. 
    291       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     299      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    292300    </div> 
    293301  </body> 

  • park_integration/docs/sphinx/html/api/index.html

    r6b1588b rf696e2a  
    44  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
    55 
     6 
    67<html xmlns="http://www.w3.org/1999/xhtml"> 
    78  <head> 
    89    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 
    910     
    10     <title>Reference &mdash; park_integration v0.1.0 documentation</title> 
     11    <title>Reference &mdash; park_integration 0.1.0 documentation</title> 
     12     
    1113    <link rel="stylesheet" href="../_static/default.css" type="text/css" /> 
    1214    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> 
     15     
    1316    <script type="text/javascript"> 
    1417      var DOCUMENTATION_OPTIONS = { 
    … …  
    2326    <script type="text/javascript" src="../_static/underscore.js"></script> 
    2427    <script type="text/javascript" src="../_static/doctools.js"></script> 
    25     <link rel="top" title="park_integration v0.1.0 documentation" href="../index.html" /> 
     28    <link rel="top" title="park_integration 0.1.0 documentation" href="../index.html" /> 
    2629    <link rel="next" title="AbstractFitEngine" href="AbstractFitEngine.html" /> 
    2730    <link rel="prev" title="Welcome to park_integration’s documentation!" href="../index.html" />  
    … …  
    4346          <a href="../index.html" title="Welcome to park_integration’s documentation!" 
    4447             accesskey="P">previous</a> |</li> 
    45         <li><a href="../index.html">park_integration v0.1.0 documentation</a> &raquo;</li>  
     48        <li><a href="../index.html">park_integration 0.1.0 documentation</a> &raquo;</li>  
    4649      </ul> 
    4750    </div>   
    … …  
    5861<col class="field-body" /> 
    5962<tbody valign="top"> 
    60 <tr class="field"><th class="field-name">Release:</th><td class="field-body">0.1</td> 
     63<tr class="field-odd field"><th class="field-name">Release:</th><td class="field-body">0.1</td> 
    6164</tr> 
    62 <tr class="field"><th class="field-name">Date:</th><td class="field-body">August 09, 2011</td> 
     65<tr class="field-even field"><th class="field-name">Date:</th><td class="field-body">October 24, 2011</td> 
    6366</tr> 
    6467</tbody> 
    … …  
    6770<ul> 
    6871<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#module-sans.fit.AbstractFitEngine">:mod:` sans.fit.AbstractFitEngine`</a></li> 
     72<li class="toctree-l2"><a class="reference internal" href="AbstractFitEngine.html#mod-sans-fit-abstractfitengine">:mod:` sans.fit.AbstractFitEngine`</a></li> 
    7073</ul> 
    7174</li> 
    7275<li class="toctree-l1"><a class="reference internal" href="Fitting.html">Fitting</a><ul> 
    7376<li class="toctree-l2"><a class="reference internal" href="Fitting.html#mod-sans-fit-fitting">:mod:` sans.fit.Fitting`</a></li> 
     77</ul> 
     78</li> 
     79<li class="toctree-l1"><a class="reference internal" href="Loader.html">Loader</a><ul> 
     80<li class="toctree-l2"><a class="reference internal" href="Loader.html#mod-sans-fit-loader">:mod:` sans.fit.Loader`</a></li> 
    7481</ul> 
    7582</li> 
    … …  
    7986</li> 
    8087<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#module-sans.fit.ScipyFitting">:mod:` sans.fit.ScipyFitting`</a></li> 
     88<li class="toctree-l2"><a class="reference internal" href="ScipyFitting.html#mod-sans-fit-scipyfitting">:mod:` sans.fit.ScipyFitting`</a></li> 
    8289</ul> 
    8390</li> 
    … …  
    106113  <h3>Quick search</h3> 
    107114    <form class="search" action="../search.html" method="get"> 
    108       <input type="text" name="q" size="18" /> 
     115      <input type="text" name="q" /> 
    109116      <input type="submit" value="Go" /> 
    110117      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    135142          <a href="../index.html" title="Welcome to park_integration’s documentation!" 
    136143             >previous</a> |</li> 
    137         <li><a href="../index.html">park_integration v0.1.0 documentation</a> &raquo;</li>  
     144        <li><a href="../index.html">park_integration 0.1.0 documentation</a> &raquo;</li>  
    138145      </ul> 
    139146    </div> 
    140147    <div class="footer"> 
    141148        &copy; Copyright 2010, sans group. 
    142       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     149      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    143150    </div> 
    144151  </body> 
Note: See TracChangeset for help on using the changeset viewer.