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/OnionExpShellModel.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>OnionExpShellModel &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>OnionExpShellModel &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="OnionModel" href="OnionModel.html" /> 
    … …  
    4447          <a href="OblateModel.html" title="OblateModel" 
    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="onionexpshellmodel"> 
    5760<h1>OnionExpShellModel<a class="headerlink" href="#onionexpshellmodel" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.OnionExpShellModel"> 
    59 <span id="sans-models-onionexpshellmodel"></span><h2><a class="reference internal" href="#module-sans.models.OnionExpShellModel" title="sans.models.OnionExpShellModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.OnionExpShellModel</span></tt></a><a class="headerlink" href="#module-sans.models.OnionExpShellModel" title="Permalink to this headline">¶</a></h2> 
    60 <dl class="class"> 
     61<div class="section" id="sans-models-onionexpshellmodel"> 
     62<h2><a class="reference internal" href="#module-sans.models.OnionExpShellModel" title="sans.models.OnionExpShellModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.OnionExpShellModel</span></tt></a><a class="headerlink" href="#sans-models-onionexpshellmodel" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.OnionExpShellModel"></span><dl class="class"> 
    6164<dt id="sans.models.OnionExpShellModel.OnionExpShellModel"> 
    62 <em class="property">class </em><tt class="descclassname">sans.models.OnionExpShellModel.</tt><tt class="descname">OnionExpShellModel</tt><big>(</big><em>n_shells=1</em><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel" title="Permalink to this definition">¶</a></dt> 
     65<em class="property">class </em><tt class="descclassname">sans.models.OnionExpShellModel.</tt><tt class="descname">OnionExpShellModel</tt><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel" title="Permalink to this definition">¶</a></dt> 
    6366<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> 
    6467<p>This multi-model is based on CoreMultiShellModel with exponential  
    … …  
    6669of changing the number of shells between 1 and 10.</p> 
    6770<dl class="method"> 
     71<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.__add__"> 
     72<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.__add__" title="Permalink to this definition">¶</a></dt> 
     73<dd></dd></dl> 
     74 
     75<dl class="method"> 
     76<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.__div__"> 
     77<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.__div__" title="Permalink to this definition">¶</a></dt> 
     78<dd></dd></dl> 
     79 
     80<dl class="method"> 
     81<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.__init__"> 
     82<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.__init__" title="Permalink to this definition">¶</a></dt> 
     83<dd></dd></dl> 
     84 
     85<dl class="attribute"> 
     86<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.__module__"> 
     87<tt class="descname">__module__</tt><em class="property"> = 'sans.models.OnionExpShellModel'</em><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.__module__" title="Permalink to this definition">¶</a></dt> 
     88<dd></dd></dl> 
     89 
     90<dl class="method"> 
     91<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.__mul__"> 
     92<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.__mul__" title="Permalink to this definition">¶</a></dt> 
     93<dd></dd></dl> 
     94 
     95<dl class="method"> 
     96<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.__str__"> 
     97<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.__str__" title="Permalink to this definition">¶</a></dt> 
     98<dd><table class="docutils field-list" frame="void" rules="none"> 
     99<col class="field-name" /> 
     100<col class="field-body" /> 
     101<tbody valign="top"> 
     102<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string representatio</td> 
     103</tr> 
     104</tbody> 
     105</table> 
     106</dd></dl> 
     107 
     108<dl class="method"> 
     109<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.__sub__"> 
     110<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.__sub__" title="Permalink to this definition">¶</a></dt> 
     111<dd></dd></dl> 
     112 
     113<dl class="method"> 
     114<dt id="sans.models.OnionExpShellModel.OnionExpShellModel._clone"> 
     115<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel._clone" title="Permalink to this definition">¶</a></dt> 
     116<dd><p>Internal utility function to copy the internal 
     117data members to a fresh copy.</p> 
     118</dd></dl> 
     119 
     120<dl class="method"> 
     121<dt id="sans.models.OnionExpShellModel.OnionExpShellModel._setParamHelper"> 
     122<tt class="descname">_setParamHelper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel._setParamHelper" title="Permalink to this definition">¶</a></dt> 
     123<dd><p>Helper function to setParam</p> 
     124</dd></dl> 
     125 
     126<dl class="method"> 
     127<dt id="sans.models.OnionExpShellModel.OnionExpShellModel._set_details"> 
     128<tt class="descname">_set_details</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel._set_details" title="Permalink to this definition">¶</a></dt> 
     129<dd><p>Concatenate details of the original model to create 
     130this model details</p> 
     131</dd></dl> 
     132 
     133<dl class="method"> 
     134<dt id="sans.models.OnionExpShellModel.OnionExpShellModel._set_dispersion"> 
     135<tt class="descname">_set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel._set_dispersion" title="Permalink to this definition">¶</a></dt> 
     136<dd><p>model dispersions</p> 
     137</dd></dl> 
     138 
     139<dl class="method"> 
     140<dt id="sans.models.OnionExpShellModel.OnionExpShellModel._set_fixed_params"> 
     141<tt class="descname">_set_fixed_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel._set_fixed_params" title="Permalink to this definition">¶</a></dt> 
     142<dd><p>Fill the self.fixed list with the model fixed list</p> 
     143</dd></dl> 
     144 
     145<dl class="method"> 
     146<dt id="sans.models.OnionExpShellModel.OnionExpShellModel._set_params"> 
     147<tt class="descname">_set_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel._set_params" title="Permalink to this definition">¶</a></dt> 
     148<dd><p>Concatenate the parameters of the model to create 
     149this model parameters</p> 
     150</dd></dl> 
     151 
     152<dl class="method"> 
     153<dt id="sans.models.OnionExpShellModel.OnionExpShellModel._set_xtra_model_param"> 
     154<tt class="descname">_set_xtra_model_param</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel._set_xtra_model_param" title="Permalink to this definition">¶</a></dt> 
     155<dd><p>Set params of original model that are hidden from this model</p> 
     156</dd></dl> 
     157 
     158<dl class="method"> 
    68159<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.calculate_ER"> 
    69160<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.calculate_ER" title="Permalink to this definition">¶</a></dt> 
    … …  
    78169<dl class="method"> 
    79170<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.evalDistribution"> 
    80 <tt class="descname">evalDistribution</tt><big>(</big><em>x=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     171<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    81172<dd><p>Evaluate the model in cartesian coordinates</p> 
    82173<p>: param x: input q[], or [qx[], qy[]] 
    … …  
    92183<dl class="method"> 
    93184<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.getParam"> 
    94 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.getParam" title="Permalink to this definition">¶</a></dt> 
     185<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.getParam" title="Permalink to this definition">¶</a></dt> 
    95186<dd><p>Set the value of a model parameter</p> 
    96187<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    98189<col class="field-body" /> 
    99190<tbody valign="top"> 
    100 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     191<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    101192</tr> 
    102193</tbody> 
    … …  
    112203<dl class="method"> 
    113204<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.getParamListWithToken"> 
    114 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     205<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    115206<dd></dd></dl> 
    116207 
    117208<dl class="method"> 
    118209<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.getParamWithToken"> 
    119 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     210<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    120211<dd></dd></dl> 
    121212 
    … …  
    132223<dl class="method"> 
    133224<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.is_fittable"> 
    134 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
     225<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
    135226<dd><p>Check if a given parameter is fittable or not</p> 
    136227<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    138229<col class="field-body" /> 
    139230<tbody valign="top"> 
    140 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     231<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> 
    141232</tr> 
    142233</tbody> 
    … …  
    146237<dl class="method"> 
    147238<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.run"> 
    148 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.run" title="Permalink to this definition">¶</a></dt> 
     239<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.run" title="Permalink to this definition">¶</a></dt> 
    149240<dd><p>Evaluate the model</p> 
    150241<p>: param x: input q-value (float or [float, float] as [r, theta]) 
    … …  
    154245<dl class="method"> 
    155246<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.runXY"> 
    156 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.runXY" title="Permalink to this definition">¶</a></dt> 
     247<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.runXY" title="Permalink to this definition">¶</a></dt> 
    157248<dd><p>Evaluate the model</p> 
    158249<p>: param x: input q-value (float or [float, float] as [qx, qy]) 
    … …  
    162253<dl class="method"> 
    163254<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.setParam"> 
    164 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.setParam" title="Permalink to this definition">¶</a></dt> 
     255<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.setParam" title="Permalink to this definition">¶</a></dt> 
    165256<dd><p>Set the value of a model parameter</p> 
    166257<p>: param name: name of the parameter 
    … …  
    170261<dl class="method"> 
    171262<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.setParamWithToken"> 
    172 <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.OnionExpShellModel.OnionExpShellModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     263<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    173264<dd></dd></dl> 
    174265 
    175266<dl class="method"> 
    176267<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.set_dispersion"> 
    177 <tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
     268<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
    178269<dd><p>Set the dispersion object for a model parameter</p> 
    179270<p>: param parameter: name of the parameter [string] 
    … …  
    195286  <ul> 
    196287<li><a class="reference internal" href="#">OnionExpShellModel</a><ul> 
    197 <li><a class="reference internal" href="#module-sans.models.OnionExpShellModel"><tt class="docutils literal"><span class="pre">sans.models.OnionExpShellModel</span></tt></a></li> 
     288<li><a class="reference internal" href="#sans-models-onionexpshellmodel"><tt class="docutils literal"><span class="pre">sans.models.OnionExpShellModel</span></tt></a></li> 
    198289</ul> 
    199290</li> 
    … …  
    214305  <h3>Quick search</h3> 
    215306    <form class="search" action="../search.html" method="get"> 
    216       <input type="text" name="q" size="18" /> 
     307      <input type="text" name="q" /> 
    217308      <input type="submit" value="Go" /> 
    218309      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    243334          <a href="OblateModel.html" title="OblateModel" 
    244335             >previous</a> |</li> 
    245         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     336        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    246337          <li><a href="index.html" >Reference</a> &raquo;</li>  
    247338      </ul> 
    … …  
    249340    <div class="footer"> 
    250341        &copy; Copyright 2010, sans group. 
    251       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     342      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    252343    </div> 
    253344  </body> 
Note: See TracChangeset for help on using the changeset viewer.