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/ReflectivityIIModel.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>ReflectivityIIModel &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>ReflectivityIIModel &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="ReflectivityModel" href="ReflectivityModel.html" /> 
    … …  
    4447          <a href="ReflAdvModel.html" title="ReflAdvModel" 
    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="reflectivityiimodel"> 
    5760<h1>ReflectivityIIModel<a class="headerlink" href="#reflectivityiimodel" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.ReflectivityIIModel"> 
    59 <span id="sans-models-reflectivityiimodel"></span><h2><a class="reference internal" href="#module-sans.models.ReflectivityIIModel" title="sans.models.ReflectivityIIModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.ReflectivityIIModel</span></tt></a><a class="headerlink" href="#module-sans.models.ReflectivityIIModel" title="Permalink to this headline">¶</a></h2> 
    60 <dl class="class"> 
     61<div class="section" id="sans-models-reflectivityiimodel"> 
     62<h2><a class="reference internal" href="#module-sans.models.ReflectivityIIModel" title="sans.models.ReflectivityIIModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.ReflectivityIIModel</span></tt></a><a class="headerlink" href="#sans-models-reflectivityiimodel" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.ReflectivityIIModel"></span><dl class="class"> 
    6164<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel"> 
    62 <em class="property">class </em><tt class="descclassname">sans.models.ReflectivityIIModel.</tt><tt class="descname">ReflectivityIIModel</tt><big>(</big><em>multfactor=1</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel" title="Permalink to this definition">¶</a></dt> 
     65<em class="property">class </em><tt class="descclassname">sans.models.ReflectivityIIModel.</tt><tt class="descname">ReflectivityIIModel</tt><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel" 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.ReflectivityIIModel.ReflectivityIIModel.__add__"> 
     71<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.__add__" title="Permalink to this definition">¶</a></dt> 
     72<dd></dd></dl> 
     73 
     74<dl class="method"> 
     75<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.__div__"> 
     76<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.__div__" title="Permalink to this definition">¶</a></dt> 
     77<dd></dd></dl> 
     78 
     79<dl class="method"> 
     80<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.__init__"> 
     81<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.__init__" title="Permalink to this definition">¶</a></dt> 
     82<dd></dd></dl> 
     83 
     84<dl class="attribute"> 
     85<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.__module__"> 
     86<tt class="descname">__module__</tt><em class="property"> = 'sans.models.ReflectivityIIModel'</em><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.__module__" title="Permalink to this definition">¶</a></dt> 
     87<dd></dd></dl> 
     88 
     89<dl class="method"> 
     90<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.__mul__"> 
     91<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.__mul__" title="Permalink to this definition">¶</a></dt> 
     92<dd></dd></dl> 
     93 
     94<dl class="method"> 
     95<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.__str__"> 
     96<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.__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.ReflectivityIIModel.ReflectivityIIModel.__sub__"> 
     109<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.__sub__" title="Permalink to this definition">¶</a></dt> 
     110<dd></dd></dl> 
     111 
     112<dl class="method"> 
     113<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel._clone"> 
     114<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel._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.ReflectivityIIModel.ReflectivityIIModel._get_func_list"> 
     121<tt class="descname">_get_func_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel._get_func_list" title="Permalink to this definition">¶</a></dt> 
     122<dd><p>Get the list of functions in each layer (shell)</p> 
     123</dd></dl> 
     124 
     125<dl class="method"> 
     126<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel._get_sld"> 
     127<tt class="descname">_get_sld</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel._get_sld" title="Permalink to this definition">¶</a></dt> 
     128<dd><p>Get the function asked to build sld profile 
     129: param func_idx: func type number 
     130: param n_sub: total number of sub_layer 
     131: param n_s: index of sub_layer 
     132: param nu: coefficient of the function 
     133: param sld_l: sld on the left side 
     134: param sld_r: sld on the right side 
     135: return: sld value, float</p> 
     136</dd></dl> 
     137 
     138<dl class="method"> 
     139<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel._setParamHelper"> 
     140<tt class="descname">_setParamHelper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel._setParamHelper" title="Permalink to this definition">¶</a></dt> 
     141<dd><p>Helper function to setParam</p> 
     142</dd></dl> 
     143 
     144<dl class="method"> 
     145<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel._set_details"> 
     146<tt class="descname">_set_details</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel._set_details" title="Permalink to this definition">¶</a></dt> 
     147<dd><p>Concatenate details of the original model to create 
     148this model details</p> 
     149</dd></dl> 
     150 
     151<dl class="method"> 
     152<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel._set_dispersion"> 
     153<tt class="descname">_set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel._set_dispersion" title="Permalink to this definition">¶</a></dt> 
     154<dd><p>model dispersions</p> 
     155</dd></dl> 
     156 
     157<dl class="method"> 
     158<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel._set_fixed_params"> 
     159<tt class="descname">_set_fixed_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel._set_fixed_params" title="Permalink to this definition">¶</a></dt> 
     160<dd><p>Fill the self.fixed list with the model fixed list</p> 
     161</dd></dl> 
     162 
     163<dl class="method"> 
     164<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel._set_params"> 
     165<tt class="descname">_set_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel._set_params" title="Permalink to this definition">¶</a></dt> 
     166<dd><p>Concatenate the parameters of the model to create 
     167this model parameters</p> 
     168</dd></dl> 
     169 
     170<dl class="method"> 
     171<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel._set_xtra_model_param"> 
     172<tt class="descname">_set_xtra_model_param</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel._set_xtra_model_param" title="Permalink to this definition">¶</a></dt> 
     173<dd><p>Set params of original model that are hidden from this model</p> 
     174</dd></dl> 
     175 
     176<dl class="method"> 
    67177<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.calculate_ER"> 
    68178<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.calculate_ER" title="Permalink to this definition">¶</a></dt> 
    … …  
    77187<dl class="method"> 
    78188<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.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.ReflectivityIIModel.ReflectivityIIModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     189<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    80190<dd><p>Evaluate the model in cartesian coordinates</p> 
    81191<p>: param x: input q[], or [qx[], qy[]] 
    … …  
    91201<dl class="method"> 
    92202<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.getParam"> 
    93 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.getParam" title="Permalink to this definition">¶</a></dt> 
     203<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.getParam" title="Permalink to this definition">¶</a></dt> 
    94204<dd><p>Set the value of a model parameter</p> 
    95205<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    97207<col class="field-body" /> 
    98208<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> 
     209<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    100210</tr> 
    101211</tbody> 
    … …  
    111221<dl class="method"> 
    112222<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.getParamListWithToken"> 
    113 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     223<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    114224<dd></dd></dl> 
    115225 
    116226<dl class="method"> 
    117227<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.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.ReflectivityIIModel.ReflectivityIIModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     228<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    119229<dd></dd></dl> 
    120230 
    … …  
    131241<dl class="method"> 
    132242<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.is_fittable"> 
    133 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.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.ReflectivityIIModel.ReflectivityIIModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
    134244<dd><p>Check if a given parameter is fittable or not</p> 
    135245<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    137247<col class="field-body" /> 
    138248<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> 
     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> 
    140250</tr> 
    141251</tbody> 
    … …  
    145255<dl class="method"> 
    146256<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.run"> 
    147 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.run" title="Permalink to this definition">¶</a></dt> 
     257<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.run" title="Permalink to this definition">¶</a></dt> 
    148258<dd><p>Evaluate the model</p> 
    149259<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    151261<col class="field-body" /> 
    152262<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> 
     263<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> 
     264</tr> 
     265<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    156266</tr> 
    157267</tbody> 
    … …  
    161271<dl class="method"> 
    162272<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.runXY"> 
    163 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.runXY" title="Permalink to this definition">¶</a></dt> 
     273<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.runXY" title="Permalink to this definition">¶</a></dt> 
    164274<dd><p>Evaluate the model</p> 
    165275<p>: param x: input q-value (float or [float, float] as [qx, qy]) 
    … …  
    169279<dl class="method"> 
    170280<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.setParam"> 
    171 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.setParam" title="Permalink to this definition">¶</a></dt> 
     281<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.setParam" title="Permalink to this definition">¶</a></dt> 
    172282<dd><p>Set the value of a model parameter</p> 
    173283<p>: param name: name of the parameter 
    … …  
    177287<dl class="method"> 
    178288<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.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.ReflectivityIIModel.ReflectivityIIModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     289<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    180290<dd></dd></dl> 
    181291 
    182292<dl class="method"> 
    183293<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.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.ReflectivityIIModel.ReflectivityIIModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
     294<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
    185295<dd><p>Set the dispersion object for a model parameter</p> 
    186296<p>: param parameter: name of the parameter [string] 
    … …  
    202312  <ul> 
    203313<li><a class="reference internal" href="#">ReflectivityIIModel</a><ul> 
    204 <li><a class="reference internal" href="#module-sans.models.ReflectivityIIModel"><tt class="docutils literal"><span class="pre">sans.models.ReflectivityIIModel</span></tt></a></li> 
     314<li><a class="reference internal" href="#sans-models-reflectivityiimodel"><tt class="docutils literal"><span class="pre">sans.models.ReflectivityIIModel</span></tt></a></li> 
    205315</ul> 
    206316</li> 
    … …  
    221331  <h3>Quick search</h3> 
    222332    <form class="search" action="../search.html" method="get"> 
    223       <input type="text" name="q" size="18" /> 
     333      <input type="text" name="q" /> 
    224334      <input type="submit" value="Go" /> 
    225335      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    250360          <a href="ReflAdvModel.html" title="ReflAdvModel" 
    251361             >previous</a> |</li> 
    252         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     362        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    253363          <li><a href="index.html" >Reference</a> &raquo;</li>  
    254364      </ul> 
    … …  
    256366    <div class="footer"> 
    257367        &copy; Copyright 2010, sans group. 
    258       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     368      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    259369    </div> 
    260370  </body> 
Note: See TracChangeset for help on using the changeset viewer.