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/FractalCoreShellModel.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>FractalCoreShellModel &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>FractalCoreShellModel &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="FractalModel" href="FractalModel.html" /> 
    … …  
    4447          <a href="FractalAbsModel.html" title="FractalAbsModel" 
    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="fractalcoreshellmodel"> 
    5760<h1>FractalCoreShellModel<a class="headerlink" href="#fractalcoreshellmodel" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.FractalCoreShellModel"> 
    59 <span id="sans-models-fractalcoreshellmodel"></span><h2><a class="reference internal" href="#module-sans.models.FractalCoreShellModel" title="sans.models.FractalCoreShellModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.FractalCoreShellModel</span></tt></a><a class="headerlink" href="#module-sans.models.FractalCoreShellModel" title="Permalink to this headline">¶</a></h2> 
    60 <dl class="class"> 
     61<div class="section" id="sans-models-fractalcoreshellmodel"> 
     62<h2><a class="reference internal" href="#module-sans.models.FractalCoreShellModel" title="sans.models.FractalCoreShellModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.FractalCoreShellModel</span></tt></a><a class="headerlink" href="#sans-models-fractalcoreshellmodel" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.FractalCoreShellModel"></span><dl class="class"> 
    6164<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel"> 
    6265<em class="property">class </em><tt class="descclassname">sans.models.FractalCoreShellModel.</tt><tt class="descname">FractalCoreShellModel</tt><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel" title="Permalink to this definition">¶</a></dt> 
    … …  
    7477background      = 0.0 [1/cm]</p> 
    7578<dl class="method"> 
     79<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.__add__"> 
     80<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.__add__" title="Permalink to this definition">¶</a></dt> 
     81<dd></dd></dl> 
     82 
     83<dl class="method"> 
     84<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.__div__"> 
     85<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.__div__" title="Permalink to this definition">¶</a></dt> 
     86<dd></dd></dl> 
     87 
     88<dl class="method"> 
     89<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.__init__"> 
     90<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.__init__" title="Permalink to this definition">¶</a></dt> 
     91<dd></dd></dl> 
     92 
     93<dl class="attribute"> 
     94<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.__module__"> 
     95<tt class="descname">__module__</tt><em class="property"> = 'sans.models.FractalCoreShellModel'</em><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.__module__" title="Permalink to this definition">¶</a></dt> 
     96<dd></dd></dl> 
     97 
     98<dl class="method"> 
     99<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.__mul__"> 
     100<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.__mul__" title="Permalink to this definition">¶</a></dt> 
     101<dd></dd></dl> 
     102 
     103<dl class="method"> 
     104<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.__str__"> 
     105<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.__str__" title="Permalink to this definition">¶</a></dt> 
     106<dd><table class="docutils field-list" frame="void" rules="none"> 
     107<col class="field-name" /> 
     108<col class="field-body" /> 
     109<tbody valign="top"> 
     110<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string representatio</td> 
     111</tr> 
     112</tbody> 
     113</table> 
     114</dd></dl> 
     115 
     116<dl class="method"> 
     117<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.__sub__"> 
     118<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.__sub__" title="Permalink to this definition">¶</a></dt> 
     119<dd></dd></dl> 
     120 
     121<dl class="method"> 
     122<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel._clone"> 
     123<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel._clone" title="Permalink to this definition">¶</a></dt> 
     124<dd><p>Internal utility function to copy the internal 
     125data members to a fresh copy.</p> 
     126</dd></dl> 
     127 
     128<dl class="method"> 
     129<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel._fractalcore"> 
     130<tt class="descname">_fractalcore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel._fractalcore" title="Permalink to this definition">¶</a></dt> 
     131<dd><p>Define model function</p> 
     132<p>return S(q): Fractal Structure</p> 
     133</dd></dl> 
     134 
     135<dl class="method"> 
     136<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel._setParamHelper"> 
     137<tt class="descname">_setParamHelper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel._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.FractalCoreShellModel.FractalCoreShellModel._set_details"> 
     143<tt class="descname">_set_details</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel._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.FractalCoreShellModel.FractalCoreShellModel._set_dispersion"> 
     150<tt class="descname">_set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel._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.FractalCoreShellModel.FractalCoreShellModel._set_params"> 
     156<tt class="descname">_set_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel._set_params" title="Permalink to this definition">¶</a></dt> 
     157<dd><p>Concatenate the parameters of the model to create 
     158this model parameters</p> 
     159</dd></dl> 
     160 
     161<dl class="method"> 
    76162<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.calculate_ER"> 
    77163<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.calculate_ER" title="Permalink to this definition">¶</a></dt> 
    … …  
    86172<dl class="method"> 
    87173<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.evalDistribution"> 
    88 <tt class="descname">evalDistribution</tt><big>(</big><em>qdist</em><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     174<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    89175<dd><p>Evaluate a distribution of q-values.</p> 
    90176<ul> 
    … …  
    111197<col class="field-body" /> 
    112198<tbody valign="top"> 
    113 <tr class="field"><th class="field-name">Note :</th><td class="field-body"><p class="first">Due to 2D speed issue, no anisotropic scattering  
     199<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  
    114200is supported for python models, thus C-models should have</p> 
    115201<blockquote class="last"> 
    … …  
    127213<col class="field-body" /> 
    128214<tbody valign="top"> 
    129 <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]  
     215<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]  
    130216where qx,qy are 1D ndarrays</td> 
    131217</tr> 
    … …  
    142228<dl class="method"> 
    143229<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.getParam"> 
    144 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.getParam" title="Permalink to this definition">¶</a></dt> 
     230<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.getParam" title="Permalink to this definition">¶</a></dt> 
    145231<dd><p>Set the value of a model parameter</p> 
    146232<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    148234<col class="field-body" /> 
    149235<tbody valign="top"> 
    150 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     236<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    151237</tr> 
    152238</tbody> 
    … …  
    162248<dl class="method"> 
    163249<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.getParamListWithToken"> 
    164 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     250<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    165251<dd></dd></dl> 
    166252 
    167253<dl class="method"> 
    168254<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.getParamWithToken"> 
    169 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     255<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    170256<dd></dd></dl> 
    171257 
    172258<dl class="method"> 
    173259<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.is_fittable"> 
    174 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
     260<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
    175261<dd><p>Check if a given parameter is fittable or not</p> 
    176262<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    178264<col class="field-body" /> 
    179265<tbody valign="top"> 
    180 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     266<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> 
    181267</tr> 
    182268</tbody> 
    … …  
    186272<dl class="method"> 
    187273<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.run"> 
    188 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.run" title="Permalink to this definition">¶</a></dt> 
     274<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.run" title="Permalink to this definition">¶</a></dt> 
    189275<dd><p>Evaluate the model</p> 
    190276<p>: param x: input q-value (float or [float, float] as [r, theta]) 
    … …  
    194280<dl class="method"> 
    195281<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.runXY"> 
    196 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.runXY" title="Permalink to this definition">¶</a></dt> 
     282<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.runXY" title="Permalink to this definition">¶</a></dt> 
    197283<dd><p>Evaluate the model</p> 
    198284<p>: param x: input q-value (float or [float, float] as [qx, qy]) 
    … …  
    202288<dl class="method"> 
    203289<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.setParam"> 
    204 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.setParam" title="Permalink to this definition">¶</a></dt> 
     290<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.setParam" title="Permalink to this definition">¶</a></dt> 
    205291<dd><p>Set the value of a model parameter</p> 
    206292<p>: param name: name of the parameter 
    … …  
    210296<dl class="method"> 
    211297<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.setParamWithToken"> 
    212 <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.FractalCoreShellModel.FractalCoreShellModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     298<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    213299<dd></dd></dl> 
    214300 
    215301<dl class="method"> 
    216302<dt id="sans.models.FractalCoreShellModel.FractalCoreShellModel.set_dispersion"> 
    217 <tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
     303<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.FractalCoreShellModel.FractalCoreShellModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
    218304<dd><p>Set the dispersion object for a model parameter</p> 
    219305<p>: param parameter: name of the parameter [string] 
    … …  
    235321  <ul> 
    236322<li><a class="reference internal" href="#">FractalCoreShellModel</a><ul> 
    237 <li><a class="reference internal" href="#module-sans.models.FractalCoreShellModel"><tt class="docutils literal"><span class="pre">sans.models.FractalCoreShellModel</span></tt></a></li> 
     323<li><a class="reference internal" href="#sans-models-fractalcoreshellmodel"><tt class="docutils literal"><span class="pre">sans.models.FractalCoreShellModel</span></tt></a></li> 
    238324</ul> 
    239325</li> 
    … …  
    254340  <h3>Quick search</h3> 
    255341    <form class="search" action="../search.html" method="get"> 
    256       <input type="text" name="q" size="18" /> 
     342      <input type="text" name="q" /> 
    257343      <input type="submit" value="Go" /> 
    258344      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    283369          <a href="FractalAbsModel.html" title="FractalAbsModel" 
    284370             >previous</a> |</li> 
    285         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     371        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    286372          <li><a href="index.html" >Reference</a> &raquo;</li>  
    287373      </ul> 
    … …  
    289375    <div class="footer"> 
    290376        &copy; Copyright 2010, sans group. 
    291       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     377      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    292378    </div> 
    293379  </body> 
Note: See TracChangeset for help on using the changeset viewer.