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/ReflectivityModel.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>ReflectivityModel &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>ReflectivityModel &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="ReflModel" href="ReflModel.html" /> 
    … …  
    4447          <a href="ReflectivityIIModel.html" title="ReflectivityIIModel" 
    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="reflectivitymodel"> 
    5760<h1>ReflectivityModel<a class="headerlink" href="#reflectivitymodel" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.ReflectivityModel"> 
    59 <span id="sans-models-reflectivitymodel"></span><h2><a class="reference internal" href="#module-sans.models.ReflectivityModel" title="sans.models.ReflectivityModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.ReflectivityModel</span></tt></a><a class="headerlink" href="#module-sans.models.ReflectivityModel" title="Permalink to this headline">¶</a></h2> 
    60 <dl class="class"> 
     61<div class="section" id="sans-models-reflectivitymodel"> 
     62<h2><a class="reference internal" href="#module-sans.models.ReflectivityModel" title="sans.models.ReflectivityModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.ReflectivityModel</span></tt></a><a class="headerlink" href="#sans-models-reflectivitymodel" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.ReflectivityModel"></span><dl class="class"> 
    6164<dt id="sans.models.ReflectivityModel.ReflectivityModel"> 
    62 <em class="property">class </em><tt class="descclassname">sans.models.ReflectivityModel.</tt><tt class="descname">ReflectivityModel</tt><big>(</big><em>multfactor=1</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel" title="Permalink to this definition">¶</a></dt> 
     65<em class="property">class </em><tt class="descclassname">sans.models.ReflectivityModel.</tt><tt class="descname">ReflectivityModel</tt><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel" 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 Parratt formalism and provides the capability 
    6568of changing the number of layers between 0 and 10.</p> 
    6669<dl class="method"> 
     70<dt id="sans.models.ReflectivityModel.ReflectivityModel.__add__"> 
     71<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.__add__" title="Permalink to this definition">¶</a></dt> 
     72<dd></dd></dl> 
     73 
     74<dl class="method"> 
     75<dt id="sans.models.ReflectivityModel.ReflectivityModel.__div__"> 
     76<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.__div__" title="Permalink to this definition">¶</a></dt> 
     77<dd></dd></dl> 
     78 
     79<dl class="method"> 
     80<dt id="sans.models.ReflectivityModel.ReflectivityModel.__init__"> 
     81<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.__init__" title="Permalink to this definition">¶</a></dt> 
     82<dd></dd></dl> 
     83 
     84<dl class="attribute"> 
     85<dt id="sans.models.ReflectivityModel.ReflectivityModel.__module__"> 
     86<tt class="descname">__module__</tt><em class="property"> = 'sans.models.ReflectivityModel'</em><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.__module__" title="Permalink to this definition">¶</a></dt> 
     87<dd></dd></dl> 
     88 
     89<dl class="method"> 
     90<dt id="sans.models.ReflectivityModel.ReflectivityModel.__mul__"> 
     91<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.__mul__" title="Permalink to this definition">¶</a></dt> 
     92<dd></dd></dl> 
     93 
     94<dl class="method"> 
     95<dt id="sans.models.ReflectivityModel.ReflectivityModel.__str__"> 
     96<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.__str__" title="Permalink to this definition">¶</a></dt> 
     97<dd><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">Returns:</th><td class="field-body">string representatio</td> 
     102</tr> 
     103</tbody> 
     104</table> 
     105</dd></dl> 
     106 
     107<dl class="method"> 
     108<dt id="sans.models.ReflectivityModel.ReflectivityModel.__sub__"> 
     109<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.__sub__" title="Permalink to this definition">¶</a></dt> 
     110<dd></dd></dl> 
     111 
     112<dl class="method"> 
     113<dt id="sans.models.ReflectivityModel.ReflectivityModel._clone"> 
     114<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel._clone" title="Permalink to this definition">¶</a></dt> 
     115<dd><p>Internal utility function to copy the internal 
     116data members to a fresh copy.</p> 
     117</dd></dl> 
     118 
     119<dl class="method"> 
     120<dt id="sans.models.ReflectivityModel.ReflectivityModel._get_func"> 
     121<tt class="descname">_get_func</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel._get_func" title="Permalink to this definition">¶</a></dt> 
     122<dd><p>Get the function asked to buil sld profile 
     123: param index: index of sub_layer 
     124: param n_sub: total number of sub_layer 
     125: param func_idx: an integer to identify a function</p> 
     126<p>: return out: the output from the function, float</p> 
     127</dd></dl> 
     128 
     129<dl class="method"> 
     130<dt id="sans.models.ReflectivityModel.ReflectivityModel._get_func_list"> 
     131<tt class="descname">_get_func_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel._get_func_list" title="Permalink to this definition">¶</a></dt> 
     132<dd><p>Get the list of functions in each layer (shell)</p> 
     133</dd></dl> 
     134 
     135<dl class="method"> 
     136<dt id="sans.models.ReflectivityModel.ReflectivityModel._setParamHelper"> 
     137<tt class="descname">_setParamHelper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel._setParamHelper" title="Permalink to this definition">¶</a></dt> 
     138<dd><p>Helper function to setParam</p> 
     139</dd></dl> 
     140 
     141<dl class="method"> 
     142<dt id="sans.models.ReflectivityModel.ReflectivityModel._set_details"> 
     143<tt class="descname">_set_details</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel._set_details" title="Permalink to this definition">¶</a></dt> 
     144<dd><p>Concatenate details of the original model to create 
     145this model details</p> 
     146</dd></dl> 
     147 
     148<dl class="method"> 
     149<dt id="sans.models.ReflectivityModel.ReflectivityModel._set_dispersion"> 
     150<tt class="descname">_set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel._set_dispersion" title="Permalink to this definition">¶</a></dt> 
     151<dd><p>model dispersions</p> 
     152</dd></dl> 
     153 
     154<dl class="method"> 
     155<dt id="sans.models.ReflectivityModel.ReflectivityModel._set_fixed_params"> 
     156<tt class="descname">_set_fixed_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel._set_fixed_params" title="Permalink to this definition">¶</a></dt> 
     157<dd><p>Fill the self.fixed list with the model fixed list</p> 
     158</dd></dl> 
     159 
     160<dl class="method"> 
     161<dt id="sans.models.ReflectivityModel.ReflectivityModel._set_params"> 
     162<tt class="descname">_set_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel._set_params" title="Permalink to this definition">¶</a></dt> 
     163<dd><p>Concatenate the parameters of the model to create 
     164this model parameters</p> 
     165</dd></dl> 
     166 
     167<dl class="method"> 
     168<dt id="sans.models.ReflectivityModel.ReflectivityModel._set_xtra_model_param"> 
     169<tt class="descname">_set_xtra_model_param</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel._set_xtra_model_param" title="Permalink to this definition">¶</a></dt> 
     170<dd><p>Set params of original model that are hidden from this model</p> 
     171</dd></dl> 
     172 
     173<dl class="method"> 
    67174<dt id="sans.models.ReflectivityModel.ReflectivityModel.calculate_ER"> 
    68175<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.calculate_ER" title="Permalink to this definition">¶</a></dt> 
    … …  
    77184<dl class="method"> 
    78185<dt id="sans.models.ReflectivityModel.ReflectivityModel.evalDistribution"> 
    79 <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.ReflectivityModel.ReflectivityModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     186<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    80187<dd><p>Evaluate the model in cartesian coordinates</p> 
    81188<p>: param x: input q[], or [qx[], qy[]] 
    … …  
    91198<dl class="method"> 
    92199<dt id="sans.models.ReflectivityModel.ReflectivityModel.getParam"> 
    93 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.getParam" title="Permalink to this definition">¶</a></dt> 
     200<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.getParam" title="Permalink to this definition">¶</a></dt> 
    94201<dd><p>Set the value of a model parameter</p> 
    95202<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    97204<col class="field-body" /> 
    98205<tbody valign="top"> 
    99 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     206<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    100207</tr> 
    101208</tbody> 
    … …  
    111218<dl class="method"> 
    112219<dt id="sans.models.ReflectivityModel.ReflectivityModel.getParamListWithToken"> 
    113 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     220<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    114221<dd></dd></dl> 
    115222 
    116223<dl class="method"> 
    117224<dt id="sans.models.ReflectivityModel.ReflectivityModel.getParamWithToken"> 
    118 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     225<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    119226<dd></dd></dl> 
    120227 
    … …  
    131238<dl class="method"> 
    132239<dt id="sans.models.ReflectivityModel.ReflectivityModel.is_fittable"> 
    133 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
     240<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
    134241<dd><p>Check if a given parameter is fittable or not</p> 
    135242<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    137244<col class="field-body" /> 
    138245<tbody valign="top"> 
    139 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     246<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> 
    140247</tr> 
    141248</tbody> 
    … …  
    145252<dl class="method"> 
    146253<dt id="sans.models.ReflectivityModel.ReflectivityModel.run"> 
    147 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.run" title="Permalink to this definition">¶</a></dt> 
     254<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.run" title="Permalink to this definition">¶</a></dt> 
    148255<dd><p>Evaluate the model</p> 
    149256<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    151258<col class="field-body" /> 
    152259<tbody valign="top"> 
    153 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td> 
    154 </tr> 
    155 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     260<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td> 
     261</tr> 
     262<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    156263</tr> 
    157264</tbody> 
    … …  
    161268<dl class="method"> 
    162269<dt id="sans.models.ReflectivityModel.ReflectivityModel.runXY"> 
    163 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.runXY" title="Permalink to this definition">¶</a></dt> 
     270<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.runXY" title="Permalink to this definition">¶</a></dt> 
    164271<dd><p>Evaluate the model</p> 
    165272<p>: param x: input q-value (float or [float, float] as [qx, qy]) 
    … …  
    169276<dl class="method"> 
    170277<dt id="sans.models.ReflectivityModel.ReflectivityModel.setParam"> 
    171 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.setParam" title="Permalink to this definition">¶</a></dt> 
     278<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.setParam" title="Permalink to this definition">¶</a></dt> 
    172279<dd><p>Set the value of a model parameter</p> 
    173280<p>: param name: name of the parameter 
    … …  
    177284<dl class="method"> 
    178285<dt id="sans.models.ReflectivityModel.ReflectivityModel.setParamWithToken"> 
    179 <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.ReflectivityModel.ReflectivityModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     286<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    180287<dd></dd></dl> 
    181288 
    182289<dl class="method"> 
    183290<dt id="sans.models.ReflectivityModel.ReflectivityModel.set_dispersion"> 
    184 <tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
     291<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
    185292<dd><p>Set the dispersion object for a model parameter</p> 
    186293<p>: param parameter: name of the parameter [string] 
    … …  
    202309  <ul> 
    203310<li><a class="reference internal" href="#">ReflectivityModel</a><ul> 
    204 <li><a class="reference internal" href="#module-sans.models.ReflectivityModel"><tt class="docutils literal"><span class="pre">sans.models.ReflectivityModel</span></tt></a></li> 
     311<li><a class="reference internal" href="#sans-models-reflectivitymodel"><tt class="docutils literal"><span class="pre">sans.models.ReflectivityModel</span></tt></a></li> 
    205312</ul> 
    206313</li> 
    … …  
    221328  <h3>Quick search</h3> 
    222329    <form class="search" action="../search.html" method="get"> 
    223       <input type="text" name="q" size="18" /> 
     330      <input type="text" name="q" /> 
    224331      <input type="submit" value="Go" /> 
    225332      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    250357          <a href="ReflectivityIIModel.html" title="ReflectivityIIModel" 
    251358             >previous</a> |</li> 
    252         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     359        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    253360          <li><a href="index.html" >Reference</a> &raquo;</li>  
    254361      </ul> 
    … …  
    256363    <div class="footer"> 
    257364        &copy; Copyright 2010, sans group. 
    258       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     365      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    259366    </div> 
    260367  </body> 
Note: See TracChangeset for help on using the changeset viewer.