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/NewCylinderModel.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>NewCylinderModel &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>NewCylinderModel &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="NoStructure" href="NoStructure.html" /> 
    … …  
    4447          <a href="MultiShellModel.html" title="MultiShellModel" 
    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="newcylindermodel"> 
    5760<h1>NewCylinderModel<a class="headerlink" href="#newcylindermodel" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.NewCylinderModel"> 
    59 <span id="sans-models-newcylindermodel"></span><h2><a class="reference internal" href="#module-sans.models.NewCylinderModel" title="sans.models.NewCylinderModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.NewCylinderModel</span></tt></a><a class="headerlink" href="#module-sans.models.NewCylinderModel" title="Permalink to this headline">¶</a></h2> 
    60 <p>This software was developed by the University of Tennessee as part of the 
     61<div class="section" id="sans-models-newcylindermodel"> 
     62<h2><a class="reference internal" href="#module-sans.models.NewCylinderModel" title="sans.models.NewCylinderModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.NewCylinderModel</span></tt></a><a class="headerlink" href="#sans-models-newcylindermodel" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.NewCylinderModel"></span><p>This software was developed by the University of Tennessee as part of the 
    6164Distributed Data Analysis of Neutron Scattering Experiments (DANSE) 
    6265project funded by the US National Science Foundation.</p> 
    … …  
    8386cyl_theta       = 1.0 rad 
    8487cyl_phi         = 1.0 rad</div></blockquote> 
    85 <dl class="attribute"> 
     88<dl class="method"> 
     89<dt id="sans.models.NewCylinderModel.CylinderModel.__add__"> 
     90<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__add__" title="Permalink to this definition">¶</a></dt> 
     91<dd></dd></dl> 
     92 
     93<dl class="method"> 
     94<dt id="sans.models.NewCylinderModel.CylinderModel.__call__"> 
     95<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__call__" title="Permalink to this definition">¶</a></dt> 
     96<dd><p>Evaluate the model. Equivalent to runXY(x)</p> 
     97<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">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input value</td> 
     102</tr> 
     103<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">value of the model</td> 
     104</tr> 
     105</tbody> 
     106</table> 
     107</dd></dl> 
     108 
     109<dl class="attribute"> 
     110<dt id="sans.models.NewCylinderModel.CylinderModel.__class__"> 
     111<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__class__" title="Permalink to this definition">¶</a></dt> 
     112<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     113</dd></dl> 
     114 
     115<dl class="attribute"> 
     116<dt id="sans.models.NewCylinderModel.CylinderModel.__delattr__"> 
     117<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__delattr__" title="Permalink to this definition">¶</a></dt> 
     118<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     119</dd></dl> 
     120 
     121<dl class="attribute"> 
     122<dt id="sans.models.NewCylinderModel.CylinderModel.__dict__"> 
     123<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x0279BE50&gt;</em><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__dict__" title="Permalink to this definition">¶</a></dt> 
     124<dd></dd></dl> 
     125 
     126<dl class="method"> 
     127<dt id="sans.models.NewCylinderModel.CylinderModel.__div__"> 
     128<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__div__" title="Permalink to this definition">¶</a></dt> 
     129<dd></dd></dl> 
     130 
     131<dl class="attribute"> 
     132<dt id="sans.models.NewCylinderModel.CylinderModel.__getattribute__"> 
     133<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     134<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     135</dd></dl> 
     136 
     137<dl class="attribute"> 
     138<dt id="sans.models.NewCylinderModel.CylinderModel.__hash__"> 
     139<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__hash__" title="Permalink to this definition">¶</a></dt> 
     140<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     141</dd></dl> 
     142 
     143<dl class="method"> 
     144<dt id="sans.models.NewCylinderModel.CylinderModel.__init__"> 
     145<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__init__" title="Permalink to this definition">¶</a></dt> 
     146<dd><p>Initialization</p> 
     147</dd></dl> 
     148 
     149<dl class="attribute"> 
     150<dt id="sans.models.NewCylinderModel.CylinderModel.__module__"> 
     151<tt class="descname">__module__</tt><em class="property"> = 'sans.models.NewCylinderModel'</em><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__module__" title="Permalink to this definition">¶</a></dt> 
     152<dd></dd></dl> 
     153 
     154<dl class="method"> 
     155<dt id="sans.models.NewCylinderModel.CylinderModel.__mul__"> 
     156<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__mul__" title="Permalink to this definition">¶</a></dt> 
     157<dd></dd></dl> 
     158 
     159<dl class="staticmethod"> 
     160<dt id="sans.models.NewCylinderModel.CylinderModel.__new__"> 
     161<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__new__" title="Permalink to this definition">¶</a></dt> 
     162<dd></dd></dl> 
     163 
     164<dl class="method"> 
     165<dt id="sans.models.NewCylinderModel.CylinderModel.__reduce__"> 
     166<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__reduce__" title="Permalink to this definition">¶</a></dt> 
     167<dd><p>helper for pickle</p> 
     168</dd></dl> 
     169 
     170<dl class="method"> 
     171<dt id="sans.models.NewCylinderModel.CylinderModel.__reduce_ex__"> 
     172<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     173<dd><p>helper for pickle</p> 
     174</dd></dl> 
     175 
     176<dl class="attribute"> 
     177<dt id="sans.models.NewCylinderModel.CylinderModel.__repr__"> 
     178<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__repr__" title="Permalink to this definition">¶</a></dt> 
     179<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     180</dd></dl> 
     181 
     182<dl class="attribute"> 
     183<dt id="sans.models.NewCylinderModel.CylinderModel.__setattr__"> 
     184<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__setattr__" title="Permalink to this definition">¶</a></dt> 
     185<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     186</dd></dl> 
     187 
     188<dl class="attribute"> 
     189<dt id="sans.models.NewCylinderModel.CylinderModel.__str__"> 
     190<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__str__" title="Permalink to this definition">¶</a></dt> 
     191<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     192</dd></dl> 
     193 
     194<dl class="method"> 
     195<dt id="sans.models.NewCylinderModel.CylinderModel.__sub__"> 
     196<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__sub__" title="Permalink to this definition">¶</a></dt> 
     197<dd></dd></dl> 
     198 
     199<dl class="attribute"> 
     200<dt id="sans.models.NewCylinderModel.CylinderModel.__weakref__"> 
     201<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__weakref__" title="Permalink to this definition">¶</a></dt> 
     202<dd><p>list of weak references to the object (if defined)</p> 
     203</dd></dl> 
     204 
     205<dl class="method"> 
    86206<dt id="sans.models.NewCylinderModel.CylinderModel.calculate_ER"> 
    87 <tt class="descname">calculate_ER</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.calculate_ER" title="Permalink to this definition">¶</a></dt> 
     207<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.calculate_ER" title="Permalink to this definition">¶</a></dt> 
    88208<dd><p>Evaluate the model at a given Q or Q, phi</p> 
    89209</dd></dl> 
    … …  
    101221</dd></dl> 
    102222 
    103 <dl class="attribute"> 
     223<dl class="method"> 
    104224<dt id="sans.models.NewCylinderModel.CylinderModel.evalDistribution"> 
    105 <tt class="descname">evalDistribution</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     225<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    106226<dd><p>Evaluate the model at a given Q or Qx, Qy vector</p> 
    107227</dd></dl> 
    … …  
    109229<dl class="method"> 
    110230<dt id="sans.models.NewCylinderModel.CylinderModel.getParam"> 
    111 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.getParam" title="Permalink to this definition">¶</a></dt> 
     231<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.getParam" title="Permalink to this definition">¶</a></dt> 
    112232<dd><p>Set the value of a model parameter</p> 
    113233<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    115235<col class="field-body" /> 
    116236<tbody valign="top"> 
    117 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     237<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    118238<li><strong>name</strong> &#8211; name of the parameter</li> 
    119239<li><strong>value</strong> &#8211; value of the parameter</li> 
    … …  
    133253<dl class="method"> 
    134254<dt id="sans.models.NewCylinderModel.CylinderModel.getParamListWithToken"> 
    135 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     255<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    136256<dd></dd></dl> 
    137257 
    138258<dl class="method"> 
    139259<dt id="sans.models.NewCylinderModel.CylinderModel.getParamWithToken"> 
    140 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     260<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    141261<dd></dd></dl> 
    142262 
    … …  
    148268 
    149269<dl class="attribute"> 
     270<dt id="sans.models.NewCylinderModel.CylinderModel.name"> 
     271<tt class="descname">name</tt><em class="property"> = 'BaseModel'</em><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.name" title="Permalink to this definition">¶</a></dt> 
     272<dd></dd></dl> 
     273 
     274<dl class="attribute"> 
    150275<dt id="sans.models.NewCylinderModel.CylinderModel.params"> 
    151276<tt class="descname">params</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.params" title="Permalink to this definition">¶</a></dt> 
    … …  
    153278</dd></dl> 
    154279 
    155 <dl class="attribute"> 
     280<dl class="method"> 
    156281<dt id="sans.models.NewCylinderModel.CylinderModel.reset"> 
    157 <tt class="descname">reset</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.reset" title="Permalink to this definition">¶</a></dt> 
     282<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.reset" title="Permalink to this definition">¶</a></dt> 
    158283<dd><p>Reset pair correlation</p> 
    159284</dd></dl> 
    … …  
    161286<dl class="method"> 
    162287<dt id="sans.models.NewCylinderModel.CylinderModel.run"> 
    163 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.run" title="Permalink to this definition">¶</a></dt> 
     288<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.run" title="Permalink to this definition">¶</a></dt> 
    164289<dd><p>Evaluate the model 
    165290&#64;param x: input q, or [q,phi] 
    … …  
    169294<dl class="method"> 
    170295<dt id="sans.models.NewCylinderModel.CylinderModel.runXY"> 
    171 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.runXY" title="Permalink to this definition">¶</a></dt> 
     296<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.runXY" title="Permalink to this definition">¶</a></dt> 
    172297<dd><p>Evaluate the model in cartesian coordinates 
    173298&#64;param x: input q, or [qx, qy] 
    … …  
    177302<dl class="method"> 
    178303<dt id="sans.models.NewCylinderModel.CylinderModel.setParam"> 
    179 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.setParam" title="Permalink to this definition">¶</a></dt> 
     304<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.setParam" title="Permalink to this definition">¶</a></dt> 
    180305<dd><p>Set the value of a model parameter</p> 
    181306<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    183308<col class="field-body" /> 
    184309<tbody valign="top"> 
    185 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     310<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    186311<li><strong>name</strong> &#8211; name of the parameter</li> 
    187312<li><strong>value</strong> &#8211; value of the parameter</li> 
    … …  
    195320<dl class="method"> 
    196321<dt id="sans.models.NewCylinderModel.CylinderModel.setParamWithToken"> 
    197 <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.NewCylinderModel.CylinderModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     322<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    198323<dd></dd></dl> 
    199324 
    200325<dl class="method"> 
    201326<dt id="sans.models.NewCylinderModel.CylinderModel.set_dispersion"> 
    202 <tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
     327<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
    203328<dd><p>Set the dispersion object for a model parameter 
    204329&#64;param parameter: name of the parameter [string] 
    … …  
    220345  <ul> 
    221346<li><a class="reference internal" href="#">NewCylinderModel</a><ul> 
    222 <li><a class="reference internal" href="#module-sans.models.NewCylinderModel"><tt class="docutils literal"><span class="pre">sans.models.NewCylinderModel</span></tt></a></li> 
     347<li><a class="reference internal" href="#sans-models-newcylindermodel"><tt class="docutils literal"><span class="pre">sans.models.NewCylinderModel</span></tt></a></li> 
    223348</ul> 
    224349</li> 
    … …  
    239364  <h3>Quick search</h3> 
    240365    <form class="search" action="../search.html" method="get"> 
    241       <input type="text" name="q" size="18" /> 
     366      <input type="text" name="q" /> 
    242367      <input type="submit" value="Go" /> 
    243368      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    268393          <a href="MultiShellModel.html" title="MultiShellModel" 
    269394             >previous</a> |</li> 
    270         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     395        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    271396          <li><a href="index.html" >Reference</a> &raquo;</li>  
    272397      </ul> 
    … …  
    274399    <div class="footer"> 
    275400        &copy; Copyright 2010, sans group. 
    276       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     401      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    277402    </div> 
    278403  </body> 
Note: See TracChangeset for help on using the changeset viewer.