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/DebyeModel.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>DebyeModel &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>DebyeModel &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="DiamCylFunc" href="DiamCylFunc.html" /> 
    … …  
    4447          <a href="DABModel.html" title="DABModel" 
    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="debyemodel"> 
    5760<h1>DebyeModel<a class="headerlink" href="#debyemodel" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.DebyeModel"> 
    59 <span id="sans-models-debyemodel"></span><h2><a class="reference internal" href="#module-sans.models.DebyeModel" title="sans.models.DebyeModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.DebyeModel</span></tt></a><a class="headerlink" href="#module-sans.models.DebyeModel" title="Permalink to this headline">¶</a></h2> 
    60 <p>Provide F(x) = 2( exp(-x) + x - 1 )/x**2 
     61<div class="section" id="sans-models-debyemodel"> 
     62<h2><a class="reference internal" href="#module-sans.models.DebyeModel" title="sans.models.DebyeModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.DebyeModel</span></tt></a><a class="headerlink" href="#sans-models-debyemodel" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.DebyeModel"></span><p>Provide F(x) = 2( exp(-x) + x - 1 )/x**2 
    6164with x = (q*R_g)**2</p> 
    6265<p>Debye function as a BaseComponent model</p> 
    … …  
    7578</dl> 
    7679<dl class="method"> 
     80<dt id="sans.models.DebyeModel.DebyeModel.__add__"> 
     81<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.__add__" title="Permalink to this definition">¶</a></dt> 
     82<dd></dd></dl> 
     83 
     84<dl class="method"> 
     85<dt id="sans.models.DebyeModel.DebyeModel.__div__"> 
     86<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.__div__" title="Permalink to this definition">¶</a></dt> 
     87<dd></dd></dl> 
     88 
     89<dl class="method"> 
     90<dt id="sans.models.DebyeModel.DebyeModel.__init__"> 
     91<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.__init__" title="Permalink to this definition">¶</a></dt> 
     92<dd><p>Initialization</p> 
     93</dd></dl> 
     94 
     95<dl class="attribute"> 
     96<dt id="sans.models.DebyeModel.DebyeModel.__module__"> 
     97<tt class="descname">__module__</tt><em class="property"> = 'sans.models.DebyeModel'</em><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.__module__" title="Permalink to this definition">¶</a></dt> 
     98<dd></dd></dl> 
     99 
     100<dl class="method"> 
     101<dt id="sans.models.DebyeModel.DebyeModel.__mul__"> 
     102<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.__mul__" title="Permalink to this definition">¶</a></dt> 
     103<dd></dd></dl> 
     104 
     105<dl class="method"> 
     106<dt id="sans.models.DebyeModel.DebyeModel.__str__"> 
     107<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.__str__" title="Permalink to this definition">¶</a></dt> 
     108<dd><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">Returns:</th><td class="field-body">string representatio</td> 
     113</tr> 
     114</tbody> 
     115</table> 
     116</dd></dl> 
     117 
     118<dl class="method"> 
     119<dt id="sans.models.DebyeModel.DebyeModel.__sub__"> 
     120<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.__sub__" title="Permalink to this definition">¶</a></dt> 
     121<dd></dd></dl> 
     122 
     123<dl class="method"> 
     124<dt id="sans.models.DebyeModel.DebyeModel._clone"> 
     125<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel._clone" title="Permalink to this definition">¶</a></dt> 
     126<dd><p>Internal utility function to copy the internal 
     127data members to a fresh copy.</p> 
     128</dd></dl> 
     129 
     130<dl class="method"> 
     131<dt id="sans.models.DebyeModel.DebyeModel._debye"> 
     132<tt class="descname">_debye</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel._debye" title="Permalink to this definition">¶</a></dt> 
     133<dd><p>Evaluate F(x)= scale * D + bkd 
     134has 2 internal parameters :</p> 
     135<blockquote> 
     136<div>D = 2 * (exp(-y) + y - 1)/y**2  
     137y = (x * Rg)^(2)</div></blockquote> 
     138</dd></dl> 
     139 
     140<dl class="method"> 
    77141<dt id="sans.models.DebyeModel.DebyeModel.calculate_ER"> 
    78142<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.calculate_ER" title="Permalink to this definition">¶</a></dt> 
    … …  
    87151<dl class="method"> 
    88152<dt id="sans.models.DebyeModel.DebyeModel.evalDistribution"> 
    89 <tt class="descname">evalDistribution</tt><big>(</big><em>qdist</em><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     153<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    90154<dd><p>Evaluate a distribution of q-values.</p> 
    91155<ul> 
    … …  
    112176<col class="field-body" /> 
    113177<tbody valign="top"> 
    114 <tr class="field"><th class="field-name">Note :</th><td class="field-body"><p class="first">Due to 2D speed issue, no anisotropic scattering  
     178<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  
    115179is supported for python models, thus C-models should have</p> 
    116180<blockquote class="last"> 
    … …  
    128192<col class="field-body" /> 
    129193<tbody valign="top"> 
    130 <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]  
     194<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]  
    131195where qx,qy are 1D ndarrays</td> 
    132196</tr> 
    … …  
    143207<dl class="method"> 
    144208<dt id="sans.models.DebyeModel.DebyeModel.getParam"> 
    145 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.getParam" title="Permalink to this definition">¶</a></dt> 
     209<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.getParam" title="Permalink to this definition">¶</a></dt> 
    146210<dd><p>Set the value of a model parameter</p> 
    147211<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    149213<col class="field-body" /> 
    150214<tbody valign="top"> 
    151 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     215<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    152216</tr> 
    153217</tbody> 
    … …  
    163227<dl class="method"> 
    164228<dt id="sans.models.DebyeModel.DebyeModel.getParamListWithToken"> 
    165 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     229<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    166230<dd></dd></dl> 
    167231 
    168232<dl class="method"> 
    169233<dt id="sans.models.DebyeModel.DebyeModel.getParamWithToken"> 
    170 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     234<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    171235<dd></dd></dl> 
    172236 
    173237<dl class="method"> 
    174238<dt id="sans.models.DebyeModel.DebyeModel.is_fittable"> 
    175 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
     239<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
    176240<dd><p>Check if a given parameter is fittable or not</p> 
    177241<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    179243<col class="field-body" /> 
    180244<tbody valign="top"> 
    181 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     245<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> 
    182246</tr> 
    183247</tbody> 
    … …  
    187251<dl class="method"> 
    188252<dt id="sans.models.DebyeModel.DebyeModel.run"> 
    189 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.run" title="Permalink to this definition">¶</a></dt> 
     253<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.run" title="Permalink to this definition">¶</a></dt> 
    190254<dd><p>Evaluate the model 
    191255&#64;param x: input q-value (float or [float, float] as [r, theta]) 
    … …  
    195259<dl class="method"> 
    196260<dt id="sans.models.DebyeModel.DebyeModel.runXY"> 
    197 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.runXY" title="Permalink to this definition">¶</a></dt> 
     261<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.runXY" title="Permalink to this definition">¶</a></dt> 
    198262<dd><p>Evaluate the model 
    199263&#64;param x: input q-value (float or [float, float] as [qx, qy]) 
    … …  
    203267<dl class="method"> 
    204268<dt id="sans.models.DebyeModel.DebyeModel.setParam"> 
    205 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.setParam" title="Permalink to this definition">¶</a></dt> 
     269<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.setParam" title="Permalink to this definition">¶</a></dt> 
    206270<dd><p>Set the value of a model parameter</p> 
    207271<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    209273<col class="field-body" /> 
    210274<tbody valign="top"> 
    211 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     275<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    212276<li><strong>name</strong> &#8211; name of the parameter</li> 
    213277<li><strong>value</strong> &#8211; value of the parameter</li> 
    … …  
    221285<dl class="method"> 
    222286<dt id="sans.models.DebyeModel.DebyeModel.setParamWithToken"> 
    223 <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.DebyeModel.DebyeModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     287<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DebyeModel.DebyeModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    224288<dd></dd></dl> 
    225289 
    … …  
    238302  <ul> 
    239303<li><a class="reference internal" href="#">DebyeModel</a><ul> 
    240 <li><a class="reference internal" href="#module-sans.models.DebyeModel"><tt class="docutils literal"><span class="pre">sans.models.DebyeModel</span></tt></a></li> 
     304<li><a class="reference internal" href="#sans-models-debyemodel"><tt class="docutils literal"><span class="pre">sans.models.DebyeModel</span></tt></a></li> 
    241305</ul> 
    242306</li> 
    … …  
    257321  <h3>Quick search</h3> 
    258322    <form class="search" action="../search.html" method="get"> 
    259       <input type="text" name="q" size="18" /> 
     323      <input type="text" name="q" /> 
    260324      <input type="submit" value="Go" /> 
    261325      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    286350          <a href="DABModel.html" title="DABModel" 
    287351             >previous</a> |</li> 
    288         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     352        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    289353          <li><a href="index.html" >Reference</a> &raquo;</li>  
    290354      </ul> 
    … …  
    292356    <div class="footer"> 
    293357        &copy; Copyright 2010, sans group. 
    294       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     358      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    295359    </div> 
    296360  </body> 
Note: See TracChangeset for help on using the changeset viewer.