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/DABModel.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>DABModel &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>DABModel &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="DebyeModel" href="DebyeModel.html" /> 
    … …  
    4447          <a href="CylinderModel.html" title="CylinderModel" 
    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="dabmodel"> 
    5760<h1>DABModel<a class="headerlink" href="#dabmodel" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.DABModel"> 
    59 <span id="sans-models-dabmodel"></span><h2><a class="reference internal" href="#module-sans.models.DABModel" title="sans.models.DABModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.DABModel</span></tt></a><a class="headerlink" href="#module-sans.models.DABModel" title="Permalink to this headline">¶</a></h2> 
    60 <p>Provide F(x) = scale/( 1 + (x*L)^2 )^(2) + background 
     61<div class="section" id="sans-models-dabmodel"> 
     62<h2><a class="reference internal" href="#module-sans.models.DABModel" title="sans.models.DABModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.DABModel</span></tt></a><a class="headerlink" href="#sans-models-dabmodel" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.DABModel"></span><p>Provide F(x) = scale/( 1 + (x*L)^2 )^(2) + background 
    6164DAB (Debye Anderson Brumberger) function as a BaseComponent model</p> 
    6265<dl class="class"> 
    … …  
    7376</dl> 
    7477<dl class="method"> 
     78<dt id="sans.models.DABModel.DABModel._DAB"> 
     79<tt class="descname">_DAB</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel._DAB" title="Permalink to this definition">¶</a></dt> 
     80<dd><p>Evaluate  F(x) = (scale*L^3)/( 1 + (x*L)^2 )^(2) + background</p> 
     81</dd></dl> 
     82 
     83<dl class="method"> 
     84<dt id="sans.models.DABModel.DABModel.__add__"> 
     85<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.__add__" title="Permalink to this definition">¶</a></dt> 
     86<dd></dd></dl> 
     87 
     88<dl class="method"> 
     89<dt id="sans.models.DABModel.DABModel.__div__"> 
     90<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.__div__" title="Permalink to this definition">¶</a></dt> 
     91<dd></dd></dl> 
     92 
     93<dl class="method"> 
     94<dt id="sans.models.DABModel.DABModel.__init__"> 
     95<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.__init__" title="Permalink to this definition">¶</a></dt> 
     96<dd><p>Initialization</p> 
     97</dd></dl> 
     98 
     99<dl class="attribute"> 
     100<dt id="sans.models.DABModel.DABModel.__module__"> 
     101<tt class="descname">__module__</tt><em class="property"> = 'sans.models.DABModel'</em><a class="headerlink" href="#sans.models.DABModel.DABModel.__module__" title="Permalink to this definition">¶</a></dt> 
     102<dd></dd></dl> 
     103 
     104<dl class="method"> 
     105<dt id="sans.models.DABModel.DABModel.__mul__"> 
     106<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.__mul__" title="Permalink to this definition">¶</a></dt> 
     107<dd></dd></dl> 
     108 
     109<dl class="method"> 
     110<dt id="sans.models.DABModel.DABModel.__str__"> 
     111<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.__str__" title="Permalink to this definition">¶</a></dt> 
     112<dd><table class="docutils field-list" frame="void" rules="none"> 
     113<col class="field-name" /> 
     114<col class="field-body" /> 
     115<tbody valign="top"> 
     116<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string representatio</td> 
     117</tr> 
     118</tbody> 
     119</table> 
     120</dd></dl> 
     121 
     122<dl class="method"> 
     123<dt id="sans.models.DABModel.DABModel.__sub__"> 
     124<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.__sub__" title="Permalink to this definition">¶</a></dt> 
     125<dd></dd></dl> 
     126 
     127<dl class="method"> 
     128<dt id="sans.models.DABModel.DABModel._clone"> 
     129<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel._clone" title="Permalink to this definition">¶</a></dt> 
     130<dd><p>Internal utility function to copy the internal 
     131data members to a fresh copy.</p> 
     132</dd></dl> 
     133 
     134<dl class="method"> 
    75135<dt id="sans.models.DABModel.DABModel.calculate_ER"> 
    76136<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.calculate_ER" title="Permalink to this definition">¶</a></dt> 
    … …  
    85145<dl class="method"> 
    86146<dt id="sans.models.DABModel.DABModel.evalDistribution"> 
    87 <tt class="descname">evalDistribution</tt><big>(</big><em>qdist</em><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     147<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    88148<dd><p>Evaluate a distribution of q-values.</p> 
    89149<ul> 
    … …  
    110170<col class="field-body" /> 
    111171<tbody valign="top"> 
    112 <tr class="field"><th class="field-name">Note :</th><td class="field-body"><p class="first">Due to 2D speed issue, no anisotropic scattering  
     172<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  
    113173is supported for python models, thus C-models should have</p> 
    114174<blockquote class="last"> 
    … …  
    126186<col class="field-body" /> 
    127187<tbody valign="top"> 
    128 <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]  
     188<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]  
    129189where qx,qy are 1D ndarrays</td> 
    130190</tr> 
    … …  
    141201<dl class="method"> 
    142202<dt id="sans.models.DABModel.DABModel.getParam"> 
    143 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.getParam" title="Permalink to this definition">¶</a></dt> 
     203<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.getParam" title="Permalink to this definition">¶</a></dt> 
    144204<dd><p>Set the value of a model parameter</p> 
    145205<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    147207<col class="field-body" /> 
    148208<tbody valign="top"> 
    149 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     209<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    150210</tr> 
    151211</tbody> 
    … …  
    161221<dl class="method"> 
    162222<dt id="sans.models.DABModel.DABModel.getParamListWithToken"> 
    163 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     223<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    164224<dd></dd></dl> 
    165225 
    166226<dl class="method"> 
    167227<dt id="sans.models.DABModel.DABModel.getParamWithToken"> 
    168 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     228<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    169229<dd></dd></dl> 
    170230 
    171231<dl class="method"> 
    172232<dt id="sans.models.DABModel.DABModel.is_fittable"> 
    173 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
     233<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
    174234<dd><p>Check if a given parameter is fittable or not</p> 
    175235<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    177237<col class="field-body" /> 
    178238<tbody valign="top"> 
    179 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     239<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> 
    180240</tr> 
    181241</tbody> 
    … …  
    185245<dl class="method"> 
    186246<dt id="sans.models.DABModel.DABModel.run"> 
    187 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.run" title="Permalink to this definition">¶</a></dt> 
     247<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.run" title="Permalink to this definition">¶</a></dt> 
    188248<dd><p>Evaluate the model 
    189249&#64;param x: input q-value (float or [float, float] as [r, theta]) 
    … …  
    193253<dl class="method"> 
    194254<dt id="sans.models.DABModel.DABModel.runXY"> 
    195 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.runXY" title="Permalink to this definition">¶</a></dt> 
     255<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.runXY" title="Permalink to this definition">¶</a></dt> 
    196256<dd><p>Evaluate the model 
    197257&#64;param x: input q-value (float or [float, float] as [qx, qy]) 
    … …  
    201261<dl class="method"> 
    202262<dt id="sans.models.DABModel.DABModel.setParam"> 
    203 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.setParam" title="Permalink to this definition">¶</a></dt> 
     263<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.setParam" title="Permalink to this definition">¶</a></dt> 
    204264<dd><p>Set the value of a model parameter</p> 
    205265<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    207267<col class="field-body" /> 
    208268<tbody valign="top"> 
    209 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     269<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    210270<li><strong>name</strong> &#8211; name of the parameter</li> 
    211271<li><strong>value</strong> &#8211; value of the parameter</li> 
    … …  
    219279<dl class="method"> 
    220280<dt id="sans.models.DABModel.DABModel.setParamWithToken"> 
    221 <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.DABModel.DABModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     281<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DABModel.DABModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    222282<dd></dd></dl> 
    223283 
    … …  
    236296  <ul> 
    237297<li><a class="reference internal" href="#">DABModel</a><ul> 
    238 <li><a class="reference internal" href="#module-sans.models.DABModel"><tt class="docutils literal"><span class="pre">sans.models.DABModel</span></tt></a></li> 
     298<li><a class="reference internal" href="#sans-models-dabmodel"><tt class="docutils literal"><span class="pre">sans.models.DABModel</span></tt></a></li> 
    239299</ul> 
    240300</li> 
    … …  
    255315  <h3>Quick search</h3> 
    256316    <form class="search" action="../search.html" method="get"> 
    257       <input type="text" name="q" size="18" /> 
     317      <input type="text" name="q" /> 
    258318      <input type="submit" value="Go" /> 
    259319      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    284344          <a href="CylinderModel.html" title="CylinderModel" 
    285345             >previous</a> |</li> 
    286         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     346        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    287347          <li><a href="index.html" >Reference</a> &raquo;</li>  
    288348      </ul> 
    … …  
    290350    <div class="footer"> 
    291351        &copy; Copyright 2010, sans group. 
    292       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     352      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    293353    </div> 
    294354  </body> 
Note: See TracChangeset for help on using the changeset viewer.