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/MultiplicationModel.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>MultiplicationModel &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>MultiplicationModel &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="MultiShellModel" href="MultiShellModel.html" /> 
    … …  
    4447          <a href="MulComponent.html" title="MulComponent" 
    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="multiplicationmodel"> 
    5760<h1>MultiplicationModel<a class="headerlink" href="#multiplicationmodel" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.MultiplicationModel"> 
    59 <span id="sans-models-multiplicationmodel"></span><h2><a class="reference internal" href="#module-sans.models.MultiplicationModel" title="sans.models.MultiplicationModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.MultiplicationModel</span></tt></a><a class="headerlink" href="#module-sans.models.MultiplicationModel" title="Permalink to this headline">¶</a></h2> 
    60 <dl class="class"> 
     61<div class="section" id="sans-models-multiplicationmodel"> 
     62<h2><a class="reference internal" href="#module-sans.models.MultiplicationModel" title="sans.models.MultiplicationModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.MultiplicationModel</span></tt></a><a class="headerlink" href="#sans-models-multiplicationmodel" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.MultiplicationModel"></span><dl class="class"> 
    6164<dt id="sans.models.MultiplicationModel.MultiplicationModel"> 
    62 <em class="property">class </em><tt class="descclassname">sans.models.MultiplicationModel.</tt><tt class="descname">MultiplicationModel</tt><big>(</big><em>p_model</em>, <em>s_model</em><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel" title="Permalink to this definition">¶</a></dt> 
     65<em class="property">class </em><tt class="descclassname">sans.models.MultiplicationModel.</tt><tt class="descname">MultiplicationModel</tt><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel" 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>Use for P(Q)*S(Q); function call must be in the order of P(Q) and then S(Q): 
    … …  
    7073Note: P(Q) refers to &#8216;form factor&#8217; model while S(Q) does to &#8216;structure factor&#8217;.</p> 
    7174<dl class="method"> 
     75<dt id="sans.models.MultiplicationModel.MultiplicationModel.__add__"> 
     76<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.__add__" title="Permalink to this definition">¶</a></dt> 
     77<dd></dd></dl> 
     78 
     79<dl class="method"> 
     80<dt id="sans.models.MultiplicationModel.MultiplicationModel.__div__"> 
     81<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.__div__" title="Permalink to this definition">¶</a></dt> 
     82<dd></dd></dl> 
     83 
     84<dl class="method"> 
     85<dt id="sans.models.MultiplicationModel.MultiplicationModel.__init__"> 
     86<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.__init__" title="Permalink to this definition">¶</a></dt> 
     87<dd></dd></dl> 
     88 
     89<dl class="attribute"> 
     90<dt id="sans.models.MultiplicationModel.MultiplicationModel.__module__"> 
     91<tt class="descname">__module__</tt><em class="property"> = 'sans.models.MultiplicationModel'</em><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.__module__" title="Permalink to this definition">¶</a></dt> 
     92<dd></dd></dl> 
     93 
     94<dl class="method"> 
     95<dt id="sans.models.MultiplicationModel.MultiplicationModel.__mul__"> 
     96<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.__mul__" title="Permalink to this definition">¶</a></dt> 
     97<dd></dd></dl> 
     98 
     99<dl class="method"> 
     100<dt id="sans.models.MultiplicationModel.MultiplicationModel.__str__"> 
     101<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.__str__" title="Permalink to this definition">¶</a></dt> 
     102<dd><table class="docutils field-list" frame="void" rules="none"> 
     103<col class="field-name" /> 
     104<col class="field-body" /> 
     105<tbody valign="top"> 
     106<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string representatio</td> 
     107</tr> 
     108</tbody> 
     109</table> 
     110</dd></dl> 
     111 
     112<dl class="method"> 
     113<dt id="sans.models.MultiplicationModel.MultiplicationModel.__sub__"> 
     114<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.__sub__" title="Permalink to this definition">¶</a></dt> 
     115<dd></dd></dl> 
     116 
     117<dl class="method"> 
     118<dt id="sans.models.MultiplicationModel.MultiplicationModel._clone"> 
     119<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel._clone" title="Permalink to this definition">¶</a></dt> 
     120<dd><p>Internal utility function to copy the internal 
     121data members to a fresh copy.</p> 
     122</dd></dl> 
     123 
     124<dl class="method"> 
     125<dt id="sans.models.MultiplicationModel.MultiplicationModel._setParamHelper"> 
     126<tt class="descname">_setParamHelper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel._setParamHelper" title="Permalink to this definition">¶</a></dt> 
     127<dd><p>Helper function to setparam</p> 
     128</dd></dl> 
     129 
     130<dl class="method"> 
     131<dt id="sans.models.MultiplicationModel.MultiplicationModel._set_details"> 
     132<tt class="descname">_set_details</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel._set_details" title="Permalink to this definition">¶</a></dt> 
     133<dd><p>Concatenate details of the two models to create 
     134this model details</p> 
     135</dd></dl> 
     136 
     137<dl class="method"> 
     138<dt id="sans.models.MultiplicationModel.MultiplicationModel._set_dispersion"> 
     139<tt class="descname">_set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel._set_dispersion" title="Permalink to this definition">¶</a></dt> 
     140<dd><p>combined the two models dispersions 
     141Polydispersion should not be applied to s_model</p> 
     142</dd></dl> 
     143 
     144<dl class="method"> 
     145<dt id="sans.models.MultiplicationModel.MultiplicationModel._set_effect_radius"> 
     146<tt class="descname">_set_effect_radius</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel._set_effect_radius" title="Permalink to this definition">¶</a></dt> 
     147<dd><p>Set effective radius to S(Q) model</p> 
     148</dd></dl> 
     149 
     150<dl class="method"> 
     151<dt id="sans.models.MultiplicationModel.MultiplicationModel._set_fixed_params"> 
     152<tt class="descname">_set_fixed_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel._set_fixed_params" title="Permalink to this definition">¶</a></dt> 
     153<dd><p>fill the self.fixed list with the p_model fixed list</p> 
     154</dd></dl> 
     155 
     156<dl class="method"> 
     157<dt id="sans.models.MultiplicationModel.MultiplicationModel._set_params"> 
     158<tt class="descname">_set_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel._set_params" title="Permalink to this definition">¶</a></dt> 
     159<dd><p>Concatenate the parameters of the two models to create 
     160this model parameters</p> 
     161</dd></dl> 
     162 
     163<dl class="method"> 
     164<dt id="sans.models.MultiplicationModel.MultiplicationModel._set_scale_factor"> 
     165<tt class="descname">_set_scale_factor</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel._set_scale_factor" title="Permalink to this definition">¶</a></dt> 
     166<dd><p>Set scale=volfraction to P model</p> 
     167</dd></dl> 
     168 
     169<dl class="method"> 
    72170<dt id="sans.models.MultiplicationModel.MultiplicationModel.calculate_ER"> 
    73171<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.calculate_ER" title="Permalink to this definition">¶</a></dt> 
    … …  
    82180<dl class="method"> 
    83181<dt id="sans.models.MultiplicationModel.MultiplicationModel.evalDistribution"> 
    84 <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.MultiplicationModel.MultiplicationModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     182<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    85183<dd><p>Evaluate the model in cartesian coordinates 
    86184&#64;param x: input q[], or [qx[], qy[]] 
    … …  
    90188<dl class="method"> 
    91189<dt id="sans.models.MultiplicationModel.MultiplicationModel.fill_description"> 
    92 <tt class="descname">fill_description</tt><big>(</big><em>p_model</em>, <em>s_model</em><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.fill_description" title="Permalink to this definition">¶</a></dt> 
     190<tt class="descname">fill_description</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.fill_description" title="Permalink to this definition">¶</a></dt> 
    93191<dd><p>Fill the description for P(Q)*S(Q)</p> 
    94192</dd></dl> 
    … …  
    102200<dl class="method"> 
    103201<dt id="sans.models.MultiplicationModel.MultiplicationModel.getParam"> 
    104 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.getParam" title="Permalink to this definition">¶</a></dt> 
     202<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.getParam" title="Permalink to this definition">¶</a></dt> 
    105203<dd><p>Set the value of a model parameter</p> 
    106204<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    108206<col class="field-body" /> 
    109207<tbody valign="top"> 
    110 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     208<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    111209</tr> 
    112210</tbody> 
    … …  
    122220<dl class="method"> 
    123221<dt id="sans.models.MultiplicationModel.MultiplicationModel.getParamListWithToken"> 
    124 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     222<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    125223<dd></dd></dl> 
    126224 
    127225<dl class="method"> 
    128226<dt id="sans.models.MultiplicationModel.MultiplicationModel.getParamWithToken"> 
    129 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     227<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    130228<dd></dd></dl> 
    131229 
    … …  
    143241<dl class="method"> 
    144242<dt id="sans.models.MultiplicationModel.MultiplicationModel.is_fittable"> 
    145 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.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.MultiplicationModel.MultiplicationModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
    146244<dd><p>Check if a given parameter is fittable or not</p> 
    147245<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    149247<col class="field-body" /> 
    150248<tbody valign="top"> 
    151 <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> 
    152250</tr> 
    153251</tbody> 
    … …  
    157255<dl class="method"> 
    158256<dt id="sans.models.MultiplicationModel.MultiplicationModel.run"> 
    159 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.run" title="Permalink to this definition">¶</a></dt> 
     257<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.run" title="Permalink to this definition">¶</a></dt> 
    160258<dd><p>Evaluate the model 
    161259&#64;param x: input q-value (float or [float, float] as [r, theta]) 
    … …  
    165263<dl class="method"> 
    166264<dt id="sans.models.MultiplicationModel.MultiplicationModel.runXY"> 
    167 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.runXY" title="Permalink to this definition">¶</a></dt> 
     265<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.runXY" title="Permalink to this definition">¶</a></dt> 
    168266<dd><p>Evaluate the model 
    169267&#64;param x: input q-value (float or [float, float] as [qx, qy]) 
    … …  
    173271<dl class="method"> 
    174272<dt id="sans.models.MultiplicationModel.MultiplicationModel.setParam"> 
    175 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.setParam" title="Permalink to this definition">¶</a></dt> 
     273<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.setParam" title="Permalink to this definition">¶</a></dt> 
    176274<dd><p>Set the value of a model parameter</p> 
    177275<p>&#64;param name: name of the parameter 
    … …  
    181279<dl class="method"> 
    182280<dt id="sans.models.MultiplicationModel.MultiplicationModel.setParamWithToken"> 
    183 <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.MultiplicationModel.MultiplicationModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     281<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    184282<dd></dd></dl> 
    185283 
    186284<dl class="method"> 
    187285<dt id="sans.models.MultiplicationModel.MultiplicationModel.set_dispersion"> 
    188 <tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
     286<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
    189287<dd><p>Set the dispersion object for a model parameter 
    190288&#64;param parameter: name of the parameter [string] 
    … …  
    206304  <ul> 
    207305<li><a class="reference internal" href="#">MultiplicationModel</a><ul> 
    208 <li><a class="reference internal" href="#module-sans.models.MultiplicationModel"><tt class="docutils literal"><span class="pre">sans.models.MultiplicationModel</span></tt></a></li> 
     306<li><a class="reference internal" href="#sans-models-multiplicationmodel"><tt class="docutils literal"><span class="pre">sans.models.MultiplicationModel</span></tt></a></li> 
    209307</ul> 
    210308</li> 
    … …  
    225323  <h3>Quick search</h3> 
    226324    <form class="search" action="../search.html" method="get"> 
    227       <input type="text" name="q" size="18" /> 
     325      <input type="text" name="q" /> 
    228326      <input type="submit" value="Go" /> 
    229327      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    254352          <a href="MulComponent.html" title="MulComponent" 
    255353             >previous</a> |</li> 
    256         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     354        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    257355          <li><a href="index.html" >Reference</a> &raquo;</li>  
    258356      </ul> 
    … …  
    260358    <div class="footer"> 
    261359        &copy; Copyright 2010, sans group. 
    262       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     360      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    263361    </div> 
    264362  </body> 
Note: See TracChangeset for help on using the changeset viewer.