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/AddComponent.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>AddComponent &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>AddComponent &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="BarBellModel" href="BarBellModel.html" /> 
    … …  
    4447          <a href="index.html" title="Reference" 
    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="addcomponent"> 
    5760<h1>AddComponent<a class="headerlink" href="#addcomponent" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.AddComponent"> 
    59 <span id="sans-models-addcomponent"></span><h2><a class="reference internal" href="#module-sans.models.AddComponent" title="sans.models.AddComponent"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.AddComponent</span></tt></a><a class="headerlink" href="#module-sans.models.AddComponent" title="Permalink to this headline">¶</a></h2> 
    60 <p>Provide base functionality for all model components</p> 
    61 <table class="docutils field-list" frame="void" rules="none"> 
    62 <col class="field-name" /> 
    63 <col class="field-body" /> 
    64 <tbody valign="top"> 
    65 <tr class="field"><th class="field-name">author:</th><td class="field-body">Mathieu Doucet / UTK</td> 
    66 </tr> 
    67 <tr class="field"><th class="field-name">contact:</th><td class="field-body"><a class="reference external" href="mailto:mathieu&#46;doucet&#37;&#52;&#48;nist&#46;gov">mathieu<span>&#46;</span>doucet<span>&#64;</span>nist<span>&#46;</span>gov</a></td> 
     61<div class="section" id="sans-models-addcomponent"> 
     62<h2><a class="reference internal" href="#module-sans.models.AddComponent" title="sans.models.AddComponent"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.AddComponent</span></tt></a><a class="headerlink" href="#sans-models-addcomponent" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.AddComponent"></span><p>Provide base functionality for all model components</p> 
     64<table class="docutils field-list" frame="void" rules="none"> 
     65<col class="field-name" /> 
     66<col class="field-body" /> 
     67<tbody valign="top"> 
     68<tr class="field-odd field"><th class="field-name">author:</th><td class="field-body">Mathieu Doucet / UTK</td> 
     69</tr> 
     70<tr class="field-even field"><th class="field-name">contact:</th><td class="field-body"><a class="reference external" href="mailto:mathieu&#46;doucet&#37;&#52;&#48;nist&#46;gov">mathieu<span>&#46;</span>doucet<span>&#64;</span>nist<span>&#46;</span>gov</a></td> 
    6871</tr> 
    6972</tbody> 
    … …  
    7174<dl class="class"> 
    7275<dt id="sans.models.AddComponent.AddComponent"> 
    73 <em class="property">class </em><tt class="descclassname">sans.models.AddComponent.</tt><tt class="descname">AddComponent</tt><big>(</big><em>base=None</em>, <em>other=None</em><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent" title="Permalink to this definition">¶</a></dt> 
     76<em class="property">class </em><tt class="descclassname">sans.models.AddComponent.</tt><tt class="descname">AddComponent</tt><a class="headerlink" href="#sans.models.AddComponent.AddComponent" title="Permalink to this definition">¶</a></dt> 
    7477<dd><p>Bases: <a class="reference internal" href="BaseComponent.html#sans.models.BaseComponent.BaseComponent" title="sans.models.BaseComponent.BaseComponent"><tt class="xref py py-class docutils literal"><span class="pre">sans.models.BaseComponent.BaseComponent</span></tt></a></p> 
    7578<p>Basic model component for Addition 
    7679Provides basic arithmetics</p> 
    7780<dl class="method"> 
     81<dt id="sans.models.AddComponent.AddComponent.__add__"> 
     82<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.__add__" title="Permalink to this definition">¶</a></dt> 
     83<dd></dd></dl> 
     84 
     85<dl class="method"> 
     86<dt id="sans.models.AddComponent.AddComponent.__div__"> 
     87<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.__div__" title="Permalink to this definition">¶</a></dt> 
     88<dd></dd></dl> 
     89 
     90<dl class="method"> 
     91<dt id="sans.models.AddComponent.AddComponent.__init__"> 
     92<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.__init__" title="Permalink to this definition">¶</a></dt> 
     93<dd><table class="docutils field-list" frame="void" rules="none"> 
     94<col class="field-name" /> 
     95<col class="field-body" /> 
     96<tbody valign="top"> 
     97<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     98<li><strong>base</strong> &#8211; component to add to</li> 
     99<li><strong>other</strong> &#8211; component to add</li> 
     100</ul> 
     101</td> 
     102</tr> 
     103</tbody> 
     104</table> 
     105</dd></dl> 
     106 
     107<dl class="attribute"> 
     108<dt id="sans.models.AddComponent.AddComponent.__module__"> 
     109<tt class="descname">__module__</tt><em class="property"> = 'sans.models.AddComponent'</em><a class="headerlink" href="#sans.models.AddComponent.AddComponent.__module__" title="Permalink to this definition">¶</a></dt> 
     110<dd></dd></dl> 
     111 
     112<dl class="method"> 
     113<dt id="sans.models.AddComponent.AddComponent.__mul__"> 
     114<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.__mul__" title="Permalink to this definition">¶</a></dt> 
     115<dd></dd></dl> 
     116 
     117<dl class="method"> 
     118<dt id="sans.models.AddComponent.AddComponent.__str__"> 
     119<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.__str__" title="Permalink to this definition">¶</a></dt> 
     120<dd><table class="docutils field-list" frame="void" rules="none"> 
     121<col class="field-name" /> 
     122<col class="field-body" /> 
     123<tbody valign="top"> 
     124<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string representatio</td> 
     125</tr> 
     126</tbody> 
     127</table> 
     128</dd></dl> 
     129 
     130<dl class="method"> 
     131<dt id="sans.models.AddComponent.AddComponent.__sub__"> 
     132<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.__sub__" title="Permalink to this definition">¶</a></dt> 
     133<dd></dd></dl> 
     134 
     135<dl class="method"> 
     136<dt id="sans.models.AddComponent.AddComponent._clone"> 
     137<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent._clone" title="Permalink to this definition">¶</a></dt> 
     138<dd><p>Internal utility function to copy the internal 
     139data members to a fresh copy.</p> 
     140</dd></dl> 
     141 
     142<dl class="method"> 
    78143<dt id="sans.models.AddComponent.AddComponent.calculate_ER"> 
    79144<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.calculate_ER" title="Permalink to this definition">¶</a></dt> 
    … …  
    88153<dl class="method"> 
    89154<dt id="sans.models.AddComponent.AddComponent.evalDistribution"> 
    90 <tt class="descname">evalDistribution</tt><big>(</big><em>qdist</em><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     155<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    91156<dd><p>Evaluate a distribution of q-values.</p> 
    92157<ul> 
    … …  
    113178<col class="field-body" /> 
    114179<tbody valign="top"> 
    115 <tr class="field"><th class="field-name">Note :</th><td class="field-body"><p class="first">Due to 2D speed issue, no anisotropic scattering  
     180<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  
    116181is supported for python models, thus C-models should have</p> 
    117182<blockquote class="last"> 
    … …  
    129194<col class="field-body" /> 
    130195<tbody valign="top"> 
    131 <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]  
     196<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]  
    132197where qx,qy are 1D ndarrays</td> 
    133198</tr> 
    … …  
    144209<dl class="method"> 
    145210<dt id="sans.models.AddComponent.AddComponent.getParam"> 
    146 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.getParam" title="Permalink to this definition">¶</a></dt> 
     211<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.getParam" title="Permalink to this definition">¶</a></dt> 
    147212<dd><p>Set the value of a model parameter</p> 
    148213<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    150215<col class="field-body" /> 
    151216<tbody valign="top"> 
    152 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    153 </tr> 
    154 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">value of the parameter</td> 
     217<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     218</tr> 
     219<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">value of the parameter</td> 
    155220</tr> 
    156221</tbody> 
    … …  
    166231<dl class="method"> 
    167232<dt id="sans.models.AddComponent.AddComponent.getParamListWithToken"> 
    168 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     233<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    169234<dd></dd></dl> 
    170235 
    171236<dl class="method"> 
    172237<dt id="sans.models.AddComponent.AddComponent.getParamWithToken"> 
    173 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     238<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    174239<dd></dd></dl> 
    175240 
    176241<dl class="method"> 
    177242<dt id="sans.models.AddComponent.AddComponent.is_fittable"> 
    178 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.is_fittable" title="Permalink to this definition">¶</a></dt> 
     243<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.is_fittable" title="Permalink to this definition">¶</a></dt> 
    179244<dd><p>Check if a given parameter is fittable or not</p> 
    180245<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    182247<col class="field-body" /> 
    183248<tbody valign="top"> 
    184 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     249<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> 
    185250</tr> 
    186251</tbody> 
    … …  
    190255<dl class="method"> 
    191256<dt id="sans.models.AddComponent.AddComponent.run"> 
    192 <tt class="descname">run</tt><big>(</big><em>x=0</em><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.run" title="Permalink to this definition">¶</a></dt> 
     257<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.run" title="Permalink to this definition">¶</a></dt> 
    193258<dd><p>Evaluate each part of the component and sum the results</p> 
    194259<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    196261<col class="field-body" /> 
    197262<tbody valign="top"> 
    198 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input parameter</td> 
    199 </tr> 
    200 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">value of the model at x</td> 
     263<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input parameter</td> 
     264</tr> 
     265<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">value of the model at x</td> 
    201266</tr> 
    202267</tbody> 
    … …  
    206271<dl class="method"> 
    207272<dt id="sans.models.AddComponent.AddComponent.runXY"> 
    208 <tt class="descname">runXY</tt><big>(</big><em>x=0</em><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.runXY" title="Permalink to this definition">¶</a></dt> 
     273<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.runXY" title="Permalink to this definition">¶</a></dt> 
    209274<dd><p>Evaluate each part of the component and sum the results</p> 
    210275<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    212277<col class="field-body" /> 
    213278<tbody valign="top"> 
    214 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input parameter</td> 
    215 </tr> 
    216 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">value of the model at x</td> 
     279<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input parameter</td> 
     280</tr> 
     281<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">value of the model at x</td> 
    217282</tr> 
    218283</tbody> 
    … …  
    222287<dl class="method"> 
    223288<dt id="sans.models.AddComponent.AddComponent.setParam"> 
    224 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.setParam" title="Permalink to this definition">¶</a></dt> 
     289<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.setParam" title="Permalink to this definition">¶</a></dt> 
    225290<dd><p>Set the value of a model parameter</p> 
    226291<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    228293<col class="field-body" /> 
    229294<tbody valign="top"> 
    230 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     295<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    231296<li><strong>name</strong> &#8211; name of parameter to set</li> 
    232297<li><strong>value</strong> &#8211; value to give the paramter</li> 
    … …  
    240305<dl class="method"> 
    241306<dt id="sans.models.AddComponent.AddComponent.setParamWithToken"> 
    242 <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.AddComponent.AddComponent.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     307<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.AddComponent.AddComponent.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    243308<dd></dd></dl> 
    244309 
    … …  
    257322  <ul> 
    258323<li><a class="reference internal" href="#">AddComponent</a><ul> 
    259 <li><a class="reference internal" href="#module-sans.models.AddComponent"><tt class="docutils literal"><span class="pre">sans.models.AddComponent</span></tt></a></li> 
     324<li><a class="reference internal" href="#sans-models-addcomponent"><tt class="docutils literal"><span class="pre">sans.models.AddComponent</span></tt></a></li> 
    260325</ul> 
    261326</li> 
    … …  
    276341  <h3>Quick search</h3> 
    277342    <form class="search" action="../search.html" method="get"> 
    278       <input type="text" name="q" size="18" /> 
     343      <input type="text" name="q" /> 
    279344      <input type="submit" value="Go" /> 
    280345      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    305370          <a href="index.html" title="Reference" 
    306371             >previous</a> |</li> 
    307         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     372        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    308373          <li><a href="index.html" >Reference</a> &raquo;</li>  
    309374      </ul> 
    … …  
    311376    <div class="footer"> 
    312377        &copy; Copyright 2010, sans group. 
    313       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     378      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    314379    </div> 
    315380  </body> 
Note: See TracChangeset for help on using the changeset viewer.