Ignore:
Timestamp:
Oct 24, 2011 1:42:54 PM (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

File:
1 edited

Legend:

Unmodified
Added
Removed

  • 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> 
Note: See TracChangeset for help on using the changeset viewer.