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/PolymerExclVolume.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>PolymerExclVolume &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>PolymerExclVolume &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="Poly_GaussCoil" href="Poly_GaussCoil.html" /> 
    … …  
    4447          <a href="pluginmodel.html" title="pluginmodel" 
    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="polymerexclvolume"> 
    5760<h1>PolymerExclVolume<a class="headerlink" href="#polymerexclvolume" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.PolymerExclVolume"> 
    59 <span id="sans-models-polymerexclvolume"></span><h2><a class="reference internal" href="#module-sans.models.PolymerExclVolume" title="sans.models.PolymerExclVolume"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.PolymerExclVolume</span></tt></a><a class="headerlink" href="#module-sans.models.PolymerExclVolume" title="Permalink to this headline">¶</a></h2> 
    60 <dl class="class"> 
     61<div class="section" id="sans-models-polymerexclvolume"> 
     62<h2><a class="reference internal" href="#module-sans.models.PolymerExclVolume" title="sans.models.PolymerExclVolume"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.PolymerExclVolume</span></tt></a><a class="headerlink" href="#sans-models-polymerexclvolume" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.PolymerExclVolume"></span><dl class="class"> 
    6164<dt id="sans.models.PolymerExclVolume.PolymerExclVolume"> 
    6265<em class="property">class </em><tt class="descclassname">sans.models.PolymerExclVolume.</tt><tt class="descname">PolymerExclVolume</tt><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume" title="Permalink to this definition">¶</a></dt> 
    … …  
    7376background      = 0.0 [1/cm]</div></blockquote> 
    7477<dl class="method"> 
     78<dt id="sans.models.PolymerExclVolume.PolymerExclVolume.__add__"> 
     79<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.__add__" title="Permalink to this definition">¶</a></dt> 
     80<dd></dd></dl> 
     81 
     82<dl class="method"> 
     83<dt id="sans.models.PolymerExclVolume.PolymerExclVolume.__div__"> 
     84<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.__div__" title="Permalink to this definition">¶</a></dt> 
     85<dd></dd></dl> 
     86 
     87<dl class="method"> 
     88<dt id="sans.models.PolymerExclVolume.PolymerExclVolume.__init__"> 
     89<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.__init__" title="Permalink to this definition">¶</a></dt> 
     90<dd><p>Initialization</p> 
     91</dd></dl> 
     92 
     93<dl class="attribute"> 
     94<dt id="sans.models.PolymerExclVolume.PolymerExclVolume.__module__"> 
     95<tt class="descname">__module__</tt><em class="property"> = 'sans.models.PolymerExclVolume'</em><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.__module__" title="Permalink to this definition">¶</a></dt> 
     96<dd></dd></dl> 
     97 
     98<dl class="method"> 
     99<dt id="sans.models.PolymerExclVolume.PolymerExclVolume.__mul__"> 
     100<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.__mul__" title="Permalink to this definition">¶</a></dt> 
     101<dd></dd></dl> 
     102 
     103<dl class="method"> 
     104<dt id="sans.models.PolymerExclVolume.PolymerExclVolume.__str__"> 
     105<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.__str__" title="Permalink to this definition">¶</a></dt> 
     106<dd><table class="docutils field-list" frame="void" rules="none"> 
     107<col class="field-name" /> 
     108<col class="field-body" /> 
     109<tbody valign="top"> 
     110<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string representatio</td> 
     111</tr> 
     112</tbody> 
     113</table> 
     114</dd></dl> 
     115 
     116<dl class="method"> 
     117<dt id="sans.models.PolymerExclVolume.PolymerExclVolume.__sub__"> 
     118<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.__sub__" title="Permalink to this definition">¶</a></dt> 
     119<dd></dd></dl> 
     120 
     121<dl class="method"> 
     122<dt id="sans.models.PolymerExclVolume.PolymerExclVolume._clone"> 
     123<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume._clone" title="Permalink to this definition">¶</a></dt> 
     124<dd><p>Internal utility function to copy the internal 
     125data members to a fresh copy.</p> 
     126</dd></dl> 
     127 
     128<dl class="method"> 
     129<dt id="sans.models.PolymerExclVolume.PolymerExclVolume._polymerexclvol"> 
     130<tt class="descname">_polymerexclvol</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume._polymerexclvol" title="Permalink to this definition">¶</a></dt> 
     131<dd></dd></dl> 
     132 
     133<dl class="method"> 
    75134<dt id="sans.models.PolymerExclVolume.PolymerExclVolume.calculate_ER"> 
    76135<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.calculate_ER" title="Permalink to this definition">¶</a></dt> 
    … …  
    85144<dl class="method"> 
    86145<dt id="sans.models.PolymerExclVolume.PolymerExclVolume.evalDistribution"> 
    87 <tt class="descname">evalDistribution</tt><big>(</big><em>qdist</em><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     146<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    88147<dd><p>Evaluate a distribution of q-values.</p> 
    89148<ul> 
    … …  
    110169<col class="field-body" /> 
    111170<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  
     171<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  
    113172is supported for python models, thus C-models should have</p> 
    114173<blockquote class="last"> 
    … …  
    126185<col class="field-body" /> 
    127186<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]  
     187<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]  
    129188where qx,qy are 1D ndarrays</td> 
    130189</tr> 
    … …  
    141200<dl class="method"> 
    142201<dt id="sans.models.PolymerExclVolume.PolymerExclVolume.getParam"> 
    143 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.getParam" title="Permalink to this definition">¶</a></dt> 
     202<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.getParam" title="Permalink to this definition">¶</a></dt> 
    144203<dd><p>Set the value of a model parameter</p> 
    145204<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    147206<col class="field-body" /> 
    148207<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> 
     208<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    150209</tr> 
    151210</tbody> 
    … …  
    161220<dl class="method"> 
    162221<dt id="sans.models.PolymerExclVolume.PolymerExclVolume.getParamListWithToken"> 
    163 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     222<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    164223<dd></dd></dl> 
    165224 
    166225<dl class="method"> 
    167226<dt id="sans.models.PolymerExclVolume.PolymerExclVolume.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.PolymerExclVolume.PolymerExclVolume.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     227<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    169228<dd></dd></dl> 
    170229 
    171230<dl class="method"> 
    172231<dt id="sans.models.PolymerExclVolume.PolymerExclVolume.is_fittable"> 
    173 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.is_fittable" title="Permalink to this definition">¶</a></dt> 
     232<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.is_fittable" title="Permalink to this definition">¶</a></dt> 
    174233<dd><p>Check if a given parameter is fittable or not</p> 
    175234<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    177236<col class="field-body" /> 
    178237<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> 
     238<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> 
    180239</tr> 
    181240</tbody> 
    … …  
    185244<dl class="method"> 
    186245<dt id="sans.models.PolymerExclVolume.PolymerExclVolume.run"> 
    187 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.run" title="Permalink to this definition">¶</a></dt> 
     246<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.run" title="Permalink to this definition">¶</a></dt> 
    188247<dd><p>Evaluate the model 
    189248&#64;param x: input q-value (float or [float, float] as [r, theta]) 
    … …  
    193252<dl class="method"> 
    194253<dt id="sans.models.PolymerExclVolume.PolymerExclVolume.runXY"> 
    195 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.runXY" title="Permalink to this definition">¶</a></dt> 
     254<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.runXY" title="Permalink to this definition">¶</a></dt> 
    196255<dd><p>Evaluate the model 
    197256&#64;param x: input q-value (float or [float, float] as [qx, qy]) 
    … …  
    201260<dl class="method"> 
    202261<dt id="sans.models.PolymerExclVolume.PolymerExclVolume.setParam"> 
    203 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.setParam" title="Permalink to this definition">¶</a></dt> 
     262<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.setParam" title="Permalink to this definition">¶</a></dt> 
    204263<dd><p>Set the value of a model parameter</p> 
    205264<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    207266<col class="field-body" /> 
    208267<tbody valign="top"> 
    209 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     268<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    210269<li><strong>name</strong> &#8211; name of the parameter</li> 
    211270<li><strong>value</strong> &#8211; value of the parameter</li> 
    … …  
    219278<dl class="method"> 
    220279<dt id="sans.models.PolymerExclVolume.PolymerExclVolume.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.PolymerExclVolume.PolymerExclVolume.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     280<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PolymerExclVolume.PolymerExclVolume.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    222281<dd></dd></dl> 
    223282 
    … …  
    236295  <ul> 
    237296<li><a class="reference internal" href="#">PolymerExclVolume</a><ul> 
    238 <li><a class="reference internal" href="#module-sans.models.PolymerExclVolume"><tt class="docutils literal"><span class="pre">sans.models.PolymerExclVolume</span></tt></a></li> 
     297<li><a class="reference internal" href="#sans-models-polymerexclvolume"><tt class="docutils literal"><span class="pre">sans.models.PolymerExclVolume</span></tt></a></li> 
    239298</ul> 
    240299</li> 
    … …  
    255314  <h3>Quick search</h3> 
    256315    <form class="search" action="../search.html" method="get"> 
    257       <input type="text" name="q" size="18" /> 
     316      <input type="text" name="q" /> 
    258317      <input type="submit" value="Go" /> 
    259318      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    284343          <a href="pluginmodel.html" title="pluginmodel" 
    285344             >previous</a> |</li> 
    286         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     345        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    287346          <li><a href="index.html" >Reference</a> &raquo;</li>  
    288347      </ul> 
    … …  
    290349    <div class="footer"> 
    291350        &copy; Copyright 2010, sans group. 
    292       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     351      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    293352    </div> 
    294353  </body> 
Note: See TracChangeset for help on using the changeset viewer.