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/Constant.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>Constant &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>Constant &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="CoreFourShellModel" href="CoreFourShellModel.html" /> 
    … …  
    4447          <a href="CappedCylinderModel.html" title="CappedCylinderModel" 
    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="constant"> 
    5760<h1>Constant<a class="headerlink" href="#constant" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.Constant"> 
    59 <span id="sans-models-constant"></span><h2><a class="reference internal" href="#module-sans.models.Constant" title="sans.models.Constant"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.Constant</span></tt></a><a class="headerlink" href="#module-sans.models.Constant" title="Permalink to this headline">¶</a></h2> 
    60 <p>Provide constant function as a BaseComponent model</p> 
     61<div class="section" id="sans-models-constant"> 
     62<h2><a class="reference internal" href="#module-sans.models.Constant" title="sans.models.Constant"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.Constant</span></tt></a><a class="headerlink" href="#sans-models-constant" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.Constant"></span><p>Provide constant function as a BaseComponent model</p> 
    6164<dl class="class"> 
    6265<dt id="sans.models.Constant.Constant"> 
    … …  
    6871<div>value           = 1.0</div></blockquote> 
    6972<dl class="method"> 
     73<dt id="sans.models.Constant.Constant.__add__"> 
     74<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.__add__" title="Permalink to this definition">¶</a></dt> 
     75<dd></dd></dl> 
     76 
     77<dl class="method"> 
     78<dt id="sans.models.Constant.Constant.__div__"> 
     79<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.__div__" title="Permalink to this definition">¶</a></dt> 
     80<dd></dd></dl> 
     81 
     82<dl class="method"> 
     83<dt id="sans.models.Constant.Constant.__init__"> 
     84<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.__init__" title="Permalink to this definition">¶</a></dt> 
     85<dd><p>Initialization</p> 
     86</dd></dl> 
     87 
     88<dl class="attribute"> 
     89<dt id="sans.models.Constant.Constant.__module__"> 
     90<tt class="descname">__module__</tt><em class="property"> = 'sans.models.Constant'</em><a class="headerlink" href="#sans.models.Constant.Constant.__module__" title="Permalink to this definition">¶</a></dt> 
     91<dd></dd></dl> 
     92 
     93<dl class="method"> 
     94<dt id="sans.models.Constant.Constant.__mul__"> 
     95<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.__mul__" title="Permalink to this definition">¶</a></dt> 
     96<dd></dd></dl> 
     97 
     98<dl class="method"> 
     99<dt id="sans.models.Constant.Constant.__str__"> 
     100<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.__str__" title="Permalink to this definition">¶</a></dt> 
     101<dd><table class="docutils field-list" frame="void" rules="none"> 
     102<col class="field-name" /> 
     103<col class="field-body" /> 
     104<tbody valign="top"> 
     105<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string representatio</td> 
     106</tr> 
     107</tbody> 
     108</table> 
     109</dd></dl> 
     110 
     111<dl class="method"> 
     112<dt id="sans.models.Constant.Constant.__sub__"> 
     113<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.__sub__" title="Permalink to this definition">¶</a></dt> 
     114<dd></dd></dl> 
     115 
     116<dl class="method"> 
     117<dt id="sans.models.Constant.Constant._clone"> 
     118<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant._clone" title="Permalink to this definition">¶</a></dt> 
     119<dd><p>Internal utility function to copy the internal 
     120data members to a fresh copy.</p> 
     121</dd></dl> 
     122 
     123<dl class="method"> 
    70124<dt id="sans.models.Constant.Constant.calculate_ER"> 
    71125<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.calculate_ER" title="Permalink to this definition">¶</a></dt> 
    … …  
    80134<dl class="method"> 
    81135<dt id="sans.models.Constant.Constant.evalDistribution"> 
    82 <tt class="descname">evalDistribution</tt><big>(</big><em>qdist</em><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     136<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    83137<dd><p>Evaluate a distribution of q-values.</p> 
    84138<ul> 
    … …  
    105159<col class="field-body" /> 
    106160<tbody valign="top"> 
    107 <tr class="field"><th class="field-name">Note :</th><td class="field-body"><p class="first">Due to 2D speed issue, no anisotropic scattering  
     161<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  
    108162is supported for python models, thus C-models should have</p> 
    109163<blockquote class="last"> 
    … …  
    121175<col class="field-body" /> 
    122176<tbody valign="top"> 
    123 <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]  
     177<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]  
    124178where qx,qy are 1D ndarrays</td> 
    125179</tr> 
    … …  
    136190<dl class="method"> 
    137191<dt id="sans.models.Constant.Constant.getParam"> 
    138 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.getParam" title="Permalink to this definition">¶</a></dt> 
     192<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.getParam" title="Permalink to this definition">¶</a></dt> 
    139193<dd><p>Set the value of a model parameter</p> 
    140194<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    142196<col class="field-body" /> 
    143197<tbody valign="top"> 
    144 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     198<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    145199</tr> 
    146200</tbody> 
    … …  
    156210<dl class="method"> 
    157211<dt id="sans.models.Constant.Constant.getParamListWithToken"> 
    158 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     212<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    159213<dd></dd></dl> 
    160214 
    161215<dl class="method"> 
    162216<dt id="sans.models.Constant.Constant.getParamWithToken"> 
    163 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     217<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    164218<dd></dd></dl> 
    165219 
    166220<dl class="method"> 
    167221<dt id="sans.models.Constant.Constant.is_fittable"> 
    168 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.is_fittable" title="Permalink to this definition">¶</a></dt> 
     222<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.is_fittable" title="Permalink to this definition">¶</a></dt> 
    169223<dd><p>Check if a given parameter is fittable or not</p> 
    170224<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    172226<col class="field-body" /> 
    173227<tbody valign="top"> 
    174 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     228<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> 
    175229</tr> 
    176230</tbody> 
    … …  
    180234<dl class="method"> 
    181235<dt id="sans.models.Constant.Constant.run"> 
    182 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.run" title="Permalink to this definition">¶</a></dt> 
     236<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.run" title="Permalink to this definition">¶</a></dt> 
    183237<dd><p>Evaluate the model 
    184238&#64;param x: unused 
    … …  
    188242<dl class="method"> 
    189243<dt id="sans.models.Constant.Constant.runXY"> 
    190 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.runXY" title="Permalink to this definition">¶</a></dt> 
     244<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.runXY" title="Permalink to this definition">¶</a></dt> 
    191245<dd><p>Evaluate the model 
    192246&#64;param x: unused 
    … …  
    196250<dl class="method"> 
    197251<dt id="sans.models.Constant.Constant.setParam"> 
    198 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.setParam" title="Permalink to this definition">¶</a></dt> 
     252<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.setParam" title="Permalink to this definition">¶</a></dt> 
    199253<dd><p>Set the value of a model parameter</p> 
    200254<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    202256<col class="field-body" /> 
    203257<tbody valign="top"> 
    204 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     258<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    205259<li><strong>name</strong> &#8211; name of the parameter</li> 
    206260<li><strong>value</strong> &#8211; value of the parameter</li> 
    … …  
    214268<dl class="method"> 
    215269<dt id="sans.models.Constant.Constant.setParamWithToken"> 
    216 <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.Constant.Constant.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     270<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Constant.Constant.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    217271<dd></dd></dl> 
    218272 
    … …  
    231285  <ul> 
    232286<li><a class="reference internal" href="#">Constant</a><ul> 
    233 <li><a class="reference internal" href="#module-sans.models.Constant"><tt class="docutils literal"><span class="pre">sans.models.Constant</span></tt></a></li> 
     287<li><a class="reference internal" href="#sans-models-constant"><tt class="docutils literal"><span class="pre">sans.models.Constant</span></tt></a></li> 
    234288</ul> 
    235289</li> 
    … …  
    250304  <h3>Quick search</h3> 
    251305    <form class="search" action="../search.html" method="get"> 
    252       <input type="text" name="q" size="18" /> 
     306      <input type="text" name="q" /> 
    253307      <input type="submit" value="Go" /> 
    254308      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    279333          <a href="CappedCylinderModel.html" title="CappedCylinderModel" 
    280334             >previous</a> |</li> 
    281         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     335        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    282336          <li><a href="index.html" >Reference</a> &raquo;</li>  
    283337      </ul> 
    … …  
    285339    <div class="footer"> 
    286340        &copy; Copyright 2010, sans group. 
    287       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     341      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    288342    </div> 
    289343  </body> 
Note: See TracChangeset for help on using the changeset viewer.