Ignore:
Timestamp:
Oct 24, 2011 2:52:52 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:
8d70c0a
Parents:
67cd7c0
Message:

edit docs for models

File:
1 edited

Legend:

Unmodified
Added
Removed
  • sansmodels/docs/sphinx/html/api/UnifiedPowerRgModel.html

    r512573a rc0d873f  
    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>UnifiedPowerRgModel &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>UnifiedPowerRgModel &mdash; sansmodels 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="sansmodels v0.1.0 documentation" href="../index.html" /> 
     28    <link rel="top" title="sansmodels 0.1.0 documentation" href="../index.html" /> 
    2629    <link rel="up" title="Reference" href="index.html" /> 
    2730    <link rel="next" title="VesicleModel" href="VesicleModel.html" /> 
     
    4447          <a href="TwoPowerLawModel.html" title="TwoPowerLawModel" 
    4548             accesskey="P">previous</a> |</li> 
    46         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     49        <li><a href="../index.html">sansmodels 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="unifiedpowerrgmodel"> 
    5760<h1>UnifiedPowerRgModel<a class="headerlink" href="#unifiedpowerrgmodel" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.UnifiedPowerRgModel"> 
    59 <span id="sans-models-unifiedpowerrgmodel"></span><h2><a class="reference internal" href="#module-sans.models.UnifiedPowerRgModel" title="sans.models.UnifiedPowerRgModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.UnifiedPowerRgModel</span></tt></a><a class="headerlink" href="#module-sans.models.UnifiedPowerRgModel" title="Permalink to this headline">¶</a></h2> 
    60 <dl class="class"> 
     61<div class="section" id="sans-models-unifiedpowerrgmodel"> 
     62<h2><a class="reference internal" href="#module-sans.models.UnifiedPowerRgModel" title="sans.models.UnifiedPowerRgModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.UnifiedPowerRgModel</span></tt></a><a class="headerlink" href="#sans-models-unifiedpowerrgmodel" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.UnifiedPowerRgModel"></span><dl class="class"> 
    6164<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel"> 
    62 <em class="property">class </em><tt class="descclassname">sans.models.UnifiedPowerRgModel.</tt><tt class="descname">UnifiedPowerRgModel</tt><big>(</big><em>multfactor=1</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel" title="Permalink to this definition">¶</a></dt> 
     65<em class="property">class </em><tt class="descclassname">sans.models.UnifiedPowerRgModel.</tt><tt class="descname">UnifiedPowerRgModel</tt><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel" title="Permalink to this definition">¶</a></dt> 
    6366<dd><p>Bases: <a class="reference internal" href="BaseComponent.html#sans.models.BaseComponent.BaseComponent" title="sans.models.BaseComponent.BaseComponent"><tt class="xref py py-class docutils literal"><span class="pre">sans.models.BaseComponent.BaseComponent</span></tt></a></p> 
    6467<p>This model is based on Exponential/Power-law fit method developed  
    6568by G. Beaucage</p> 
    6669<dl class="method"> 
     70<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__add__"> 
     71<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__add__" title="Permalink to this definition">¶</a></dt> 
     72<dd></dd></dl> 
     73 
     74<dl class="method"> 
     75<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__div__"> 
     76<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__div__" title="Permalink to this definition">¶</a></dt> 
     77<dd></dd></dl> 
     78 
     79<dl class="method"> 
     80<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__init__"> 
     81<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__init__" title="Permalink to this definition">¶</a></dt> 
     82<dd></dd></dl> 
     83 
     84<dl class="attribute"> 
     85<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__module__"> 
     86<tt class="descname">__module__</tt><em class="property"> = 'sans.models.UnifiedPowerRgModel'</em><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__module__" title="Permalink to this definition">¶</a></dt> 
     87<dd></dd></dl> 
     88 
     89<dl class="method"> 
     90<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__mul__"> 
     91<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__mul__" title="Permalink to this definition">¶</a></dt> 
     92<dd></dd></dl> 
     93 
     94<dl class="method"> 
     95<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__str__"> 
     96<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__str__" title="Permalink to this definition">¶</a></dt> 
     97<dd><table class="docutils field-list" frame="void" rules="none"> 
     98<col class="field-name" /> 
     99<col class="field-body" /> 
     100<tbody valign="top"> 
     101<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string representatio</td> 
     102</tr> 
     103</tbody> 
     104</table> 
     105</dd></dl> 
     106 
     107<dl class="method"> 
     108<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__sub__"> 
     109<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.__sub__" title="Permalink to this definition">¶</a></dt> 
     110<dd></dd></dl> 
     111 
     112<dl class="method"> 
     113<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._clone"> 
     114<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._clone" title="Permalink to this definition">¶</a></dt> 
     115<dd><p>Internal utility function to copy the internal 
     116data members to a fresh copy.</p> 
     117</dd></dl> 
     118 
     119<dl class="method"> 
     120<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._get_func_list"> 
     121<tt class="descname">_get_func_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._get_func_list" title="Permalink to this definition">¶</a></dt> 
     122<dd><p>Get the list of functions in each cases</p> 
     123</dd></dl> 
     124 
     125<dl class="method"> 
     126<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._setParamHelper"> 
     127<tt class="descname">_setParamHelper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._setParamHelper" title="Permalink to this definition">¶</a></dt> 
     128<dd><p>Helper function to setParam</p> 
     129</dd></dl> 
     130 
     131<dl class="method"> 
     132<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._set_details"> 
     133<tt class="descname">_set_details</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._set_details" title="Permalink to this definition">¶</a></dt> 
     134<dd><p>Concatenate details of the original model to create 
     135this model details</p> 
     136</dd></dl> 
     137 
     138<dl class="method"> 
     139<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._set_dispersion"> 
     140<tt class="descname">_set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._set_dispersion" title="Permalink to this definition">¶</a></dt> 
     141<dd><p>model dispersions</p> 
     142</dd></dl> 
     143 
     144<dl class="method"> 
     145<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._set_fixed_params"> 
     146<tt class="descname">_set_fixed_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._set_fixed_params" title="Permalink to this definition">¶</a></dt> 
     147<dd><p>Fill the self.fixed list with the model fixed list</p> 
     148</dd></dl> 
     149 
     150<dl class="method"> 
     151<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._set_params"> 
     152<tt class="descname">_set_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._set_params" title="Permalink to this definition">¶</a></dt> 
     153<dd><p>Concatenate the parameters of the model to create 
     154this model parameters</p> 
     155</dd></dl> 
     156 
     157<dl class="method"> 
     158<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._unifiedpowerrg"> 
     159<tt class="descname">_unifiedpowerrg</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel._unifiedpowerrg" title="Permalink to this definition">¶</a></dt> 
     160<dd><p>Scattering function</p> 
     161<table class="docutils field-list" frame="void" rules="none"> 
     162<col class="field-name" /> 
     163<col class="field-body" /> 
     164<tbody valign="top"> 
     165<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; q value(s)</td> 
     166</tr> 
     167<tr class="field-even field"><th class="field-name">Return answer:</th><td class="field-body">output of the function</td> 
     168</tr> 
     169</tbody> 
     170</table> 
     171</dd></dl> 
     172 
     173<dl class="method"> 
    67174<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.calculate_ER"> 
    68175<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.calculate_ER" title="Permalink to this definition">¶</a></dt> 
     
    77184<dl class="method"> 
    78185<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.evalDistribution"> 
    79 <tt class="descname">evalDistribution</tt><big>(</big><em>qdist</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     186<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    80187<dd><p>Evaluate a distribution of q-values.</p> 
    81188<ul> 
     
    102209<col class="field-body" /> 
    103210<tbody valign="top"> 
    104 <tr class="field"><th class="field-name">Note :</th><td class="field-body"><p class="first">Due to 2D speed issue, no anisotropic scattering  
     211<tr class="field-odd field"><th class="field-name">Note :</th><td class="field-body"><p class="first">Due to 2D speed issue, no anisotropic scattering  
    105212is supported for python models, thus C-models should have</p> 
    106213<blockquote class="last"> 
     
    118225<col class="field-body" /> 
    119226<tbody valign="top"> 
    120 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>qdist</strong> &#8211; ndarray of scalar q-values or list [qx,qy]  
     227<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>qdist</strong> &#8211; ndarray of scalar q-values or list [qx,qy]  
    121228where qx,qy are 1D ndarrays</td> 
    122229</tr> 
     
    133240<dl class="method"> 
    134241<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.getParam"> 
    135 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.getParam" title="Permalink to this definition">¶</a></dt> 
     242<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.getParam" title="Permalink to this definition">¶</a></dt> 
    136243<dd><p>Set the value of a model parameter</p> 
    137244<table class="docutils field-list" frame="void" rules="none"> 
     
    139246<col class="field-body" /> 
    140247<tbody valign="top"> 
    141 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     248<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    142249</tr> 
    143250</tbody> 
     
    153260<dl class="method"> 
    154261<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.getParamListWithToken"> 
    155 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     262<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    156263<dd></dd></dl> 
    157264 
    158265<dl class="method"> 
    159266<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.getParamWithToken"> 
    160 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     267<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    161268<dd></dd></dl> 
    162269 
     
    170277<dl class="method"> 
    171278<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.is_fittable"> 
    172 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
     279<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
    173280<dd><p>Check if a given parameter is fittable or not</p> 
    174281<table class="docutils field-list" frame="void" rules="none"> 
     
    176283<col class="field-body" /> 
    177284<tbody valign="top"> 
    178 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     285<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
    179286</tr> 
    180287</tbody> 
     
    184291<dl class="method"> 
    185292<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.run"> 
    186 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.run" title="Permalink to this definition">¶</a></dt> 
     293<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.run" title="Permalink to this definition">¶</a></dt> 
    187294<dd><p>Evaluate the model</p> 
    188295<p>: param x: input q-value (float or [float, float] as [r, theta]) 
     
    192299<dl class="method"> 
    193300<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.runXY"> 
    194 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.runXY" title="Permalink to this definition">¶</a></dt> 
     301<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.runXY" title="Permalink to this definition">¶</a></dt> 
    195302<dd><p>Evaluate the model</p> 
    196303<p>: param x: input q-value (float or [float, float] as [qx, qy]) 
     
    200307<dl class="method"> 
    201308<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.setParam"> 
    202 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.setParam" title="Permalink to this definition">¶</a></dt> 
     309<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.setParam" title="Permalink to this definition">¶</a></dt> 
    203310<dd><p>Set the value of a model parameter</p> 
    204311<p>: param name: name of the parameter 
     
    208315<dl class="method"> 
    209316<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.setParamWithToken"> 
    210 <tt class="descname">setParamWithToken</tt><big>(</big><em>name</em>, <em>value</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     317<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    211318<dd></dd></dl> 
    212319 
    213320<dl class="method"> 
    214321<dt id="sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.set_dispersion"> 
    215 <tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
     322<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.UnifiedPowerRgModel.UnifiedPowerRgModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
    216323<dd><p>Set the dispersion object for a model parameter</p> 
    217324<p>: param parameter: name of the parameter [string] 
     
    233340  <ul> 
    234341<li><a class="reference internal" href="#">UnifiedPowerRgModel</a><ul> 
    235 <li><a class="reference internal" href="#module-sans.models.UnifiedPowerRgModel"><tt class="docutils literal"><span class="pre">sans.models.UnifiedPowerRgModel</span></tt></a></li> 
     342<li><a class="reference internal" href="#sans-models-unifiedpowerrgmodel"><tt class="docutils literal"><span class="pre">sans.models.UnifiedPowerRgModel</span></tt></a></li> 
    236343</ul> 
    237344</li> 
     
    252359  <h3>Quick search</h3> 
    253360    <form class="search" action="../search.html" method="get"> 
    254       <input type="text" name="q" size="18" /> 
     361      <input type="text" name="q" /> 
    255362      <input type="submit" value="Go" /> 
    256363      <input type="hidden" name="check_keywords" value="yes" /> 
     
    281388          <a href="TwoPowerLawModel.html" title="TwoPowerLawModel" 
    282389             >previous</a> |</li> 
    283         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     390        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    284391          <li><a href="index.html" >Reference</a> &raquo;</li>  
    285392      </ul> 
     
    287394    <div class="footer"> 
    288395        &copy; Copyright 2010, sans group. 
    289       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     396      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    290397    </div> 
    291398  </body> 
Note: See TracChangeset for help on using the changeset viewer.