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/StackedDisksModel.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>StackedDisksModel &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>StackedDisksModel &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="StickyHSStructure" href="StickyHSStructure.html" /> 
     
    4447          <a href="SquareWellStructure.html" title="SquareWellStructure" 
    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="stackeddisksmodel"> 
    5760<h1>StackedDisksModel<a class="headerlink" href="#stackeddisksmodel" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.StackedDisksModel"> 
    59 <span id="sans-models-stackeddisksmodel"></span><h2><a class="reference internal" href="#module-sans.models.StackedDisksModel" title="sans.models.StackedDisksModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.StackedDisksModel</span></tt></a><a class="headerlink" href="#module-sans.models.StackedDisksModel" title="Permalink to this headline">¶</a></h2> 
    60 <p>Provide functionality for a C extension model</p> 
    61 <table class="docutils field-list" frame="void" rules="none"> 
    62 <col class="field-name" /> 
    63 <col class="field-body" /> 
    64 <tbody valign="top"> 
    65 <tr class="field"><th class="field-name">WARNING:</th><td class="field-body">THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY 
     61<div class="section" id="sans-models-stackeddisksmodel"> 
     62<h2><a class="reference internal" href="#module-sans.models.StackedDisksModel" title="sans.models.StackedDisksModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.StackedDisksModel</span></tt></a><a class="headerlink" href="#sans-models-stackeddisksmodel" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.StackedDisksModel"></span><p>Provide functionality for a C extension model</p> 
     64<table class="docutils field-list" frame="void" rules="none"> 
     65<col class="field-name" /> 
     66<col class="field-body" /> 
     67<tbody valign="top"> 
     68<tr class="field-odd field"><th class="field-name">WARNING:</th><td class="field-body">THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY 
    6669DO NOT MODIFY THIS FILE, MODIFY ..c_extensionsstacked_disks.h 
    6770AND RE-RUN THE GENERATOR SCRIPT</td> 
     
    9295axis_phi        = 0.0 [rad]</div></blockquote> 
    9396<dl class="method"> 
     97<dt id="sans.models.StackedDisksModel.StackedDisksModel.__add__"> 
     98<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__add__" title="Permalink to this definition">¶</a></dt> 
     99<dd></dd></dl> 
     100 
     101<dl class="attribute"> 
     102<dt id="sans.models.StackedDisksModel.StackedDisksModel.__class__"> 
     103<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__class__" title="Permalink to this definition">¶</a></dt> 
     104<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     105</dd></dl> 
     106 
     107<dl class="attribute"> 
     108<dt id="sans.models.StackedDisksModel.StackedDisksModel.__delattr__"> 
     109<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__delattr__" title="Permalink to this definition">¶</a></dt> 
     110<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     111</dd></dl> 
     112 
     113<dl class="attribute"> 
     114<dt id="sans.models.StackedDisksModel.StackedDisksModel.__dict__"> 
     115<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x0279B5B0&gt;</em><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__dict__" title="Permalink to this definition">¶</a></dt> 
     116<dd></dd></dl> 
     117 
     118<dl class="method"> 
     119<dt id="sans.models.StackedDisksModel.StackedDisksModel.__div__"> 
     120<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__div__" title="Permalink to this definition">¶</a></dt> 
     121<dd></dd></dl> 
     122 
     123<dl class="attribute"> 
     124<dt id="sans.models.StackedDisksModel.StackedDisksModel.__getattribute__"> 
     125<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     126<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     127</dd></dl> 
     128 
     129<dl class="attribute"> 
     130<dt id="sans.models.StackedDisksModel.StackedDisksModel.__hash__"> 
     131<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__hash__" title="Permalink to this definition">¶</a></dt> 
     132<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     133</dd></dl> 
     134 
     135<dl class="method"> 
     136<dt id="sans.models.StackedDisksModel.StackedDisksModel.__init__"> 
     137<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__init__" title="Permalink to this definition">¶</a></dt> 
     138<dd><p>Initialization</p> 
     139</dd></dl> 
     140 
     141<dl class="attribute"> 
     142<dt id="sans.models.StackedDisksModel.StackedDisksModel.__module__"> 
     143<tt class="descname">__module__</tt><em class="property"> = 'sans.models.StackedDisksModel'</em><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__module__" title="Permalink to this definition">¶</a></dt> 
     144<dd></dd></dl> 
     145 
     146<dl class="method"> 
     147<dt id="sans.models.StackedDisksModel.StackedDisksModel.__mul__"> 
     148<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__mul__" title="Permalink to this definition">¶</a></dt> 
     149<dd></dd></dl> 
     150 
     151<dl class="staticmethod"> 
     152<dt id="sans.models.StackedDisksModel.StackedDisksModel.__new__"> 
     153<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__new__" title="Permalink to this definition">¶</a></dt> 
     154<dd></dd></dl> 
     155 
     156<dl class="method"> 
     157<dt id="sans.models.StackedDisksModel.StackedDisksModel.__reduce__"> 
     158<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__reduce__" title="Permalink to this definition">¶</a></dt> 
     159<dd><p>helper for pickle</p> 
     160</dd></dl> 
     161 
     162<dl class="method"> 
     163<dt id="sans.models.StackedDisksModel.StackedDisksModel.__reduce_ex__"> 
     164<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     165<dd><p>Overwrite the __reduce_ex__ of PyTypeObject <a href="#id1"><span class="problematic" id="id2">*</span></a>type call in the init of  
     166c model.</p> 
     167</dd></dl> 
     168 
     169<dl class="attribute"> 
     170<dt id="sans.models.StackedDisksModel.StackedDisksModel.__repr__"> 
     171<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__repr__" title="Permalink to this definition">¶</a></dt> 
     172<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     173</dd></dl> 
     174 
     175<dl class="attribute"> 
     176<dt id="sans.models.StackedDisksModel.StackedDisksModel.__setattr__"> 
     177<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__setattr__" title="Permalink to this definition">¶</a></dt> 
     178<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     179</dd></dl> 
     180 
     181<dl class="method"> 
     182<dt id="sans.models.StackedDisksModel.StackedDisksModel.__setstate__"> 
     183<tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__setstate__" title="Permalink to this definition">¶</a></dt> 
     184<dd><p>restore the state of a model from pickle</p> 
     185</dd></dl> 
     186 
     187<dl class="attribute"> 
     188<dt id="sans.models.StackedDisksModel.StackedDisksModel.__str__"> 
     189<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__str__" title="Permalink to this definition">¶</a></dt> 
     190<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     191</dd></dl> 
     192 
     193<dl class="method"> 
     194<dt id="sans.models.StackedDisksModel.StackedDisksModel.__sub__"> 
     195<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__sub__" title="Permalink to this definition">¶</a></dt> 
     196<dd></dd></dl> 
     197 
     198<dl class="attribute"> 
     199<dt id="sans.models.StackedDisksModel.StackedDisksModel.__weakref__"> 
     200<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__weakref__" title="Permalink to this definition">¶</a></dt> 
     201<dd><p>list of weak references to the object (if defined)</p> 
     202</dd></dl> 
     203 
     204<dl class="method"> 
     205<dt id="sans.models.StackedDisksModel.StackedDisksModel._clone"> 
     206<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel._clone" title="Permalink to this definition">¶</a></dt> 
     207<dd><p>Internal utility function to copy the internal 
     208data members to a fresh copy.</p> 
     209</dd></dl> 
     210 
     211<dl class="method"> 
    94212<dt id="sans.models.StackedDisksModel.StackedDisksModel.calculate_ER"> 
    95213<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.calculate_ER" title="Permalink to this definition">¶</a></dt> 
     
    99217<col class="field-body" /> 
    100218<tbody valign="top"> 
    101 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
     219<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
    102220</tr> 
    103221</tbody> 
     
    119237<dl class="method"> 
    120238<dt id="sans.models.StackedDisksModel.StackedDisksModel.evalDistribution"> 
    121 <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.StackedDisksModel.StackedDisksModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     239<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    122240<dd><p>Evaluate the model in cartesian coordinates</p> 
    123241<table class="docutils field-list" frame="void" rules="none"> 
     
    125243<col class="field-body" /> 
    126244<tbody valign="top"> 
    127 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td> 
    128 </tr> 
    129 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
     245<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td> 
     246</tr> 
     247<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
    130248</tr> 
    131249</tbody> 
     
    141259<dl class="method"> 
    142260<dt id="sans.models.StackedDisksModel.StackedDisksModel.getParam"> 
    143 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.getParam" title="Permalink to this definition">¶</a></dt> 
     261<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.getParam" title="Permalink to this definition">¶</a></dt> 
    144262<dd><p>Set the value of a model parameter</p> 
    145263<table class="docutils field-list" frame="void" rules="none"> 
     
    147265<col class="field-body" /> 
    148266<tbody valign="top"> 
    149 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     267<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    150268</tr> 
    151269</tbody> 
     
    161279<dl class="method"> 
    162280<dt id="sans.models.StackedDisksModel.StackedDisksModel.getParamListWithToken"> 
    163 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     281<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    164282<dd></dd></dl> 
    165283 
    166284<dl class="method"> 
    167285<dt id="sans.models.StackedDisksModel.StackedDisksModel.getParamWithToken"> 
    168 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     286<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    169287<dd></dd></dl> 
    170288 
    171289<dl class="method"> 
    172290<dt id="sans.models.StackedDisksModel.StackedDisksModel.is_fittable"> 
    173 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
     291<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
    174292<dd><p>Check if a given parameter is fittable or not</p> 
    175293<table class="docutils field-list" frame="void" rules="none"> 
     
    177295<col class="field-body" /> 
    178296<tbody valign="top"> 
    179 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     297<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> 
    180298</tr> 
    181299</tbody> 
     
    195313</dd></dl> 
    196314 
    197 <dl class="attribute"> 
     315<dl class="method"> 
    198316<dt id="sans.models.StackedDisksModel.StackedDisksModel.reset"> 
    199 <tt class="descname">reset</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.reset" title="Permalink to this definition">¶</a></dt> 
     317<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.reset" title="Permalink to this definition">¶</a></dt> 
    200318<dd><p>Reset pair correlation</p> 
    201319</dd></dl> 
     
    203321<dl class="method"> 
    204322<dt id="sans.models.StackedDisksModel.StackedDisksModel.run"> 
    205 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.run" title="Permalink to this definition">¶</a></dt> 
     323<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.run" title="Permalink to this definition">¶</a></dt> 
    206324<dd><p>Evaluate the model</p> 
    207325<table class="docutils field-list" frame="void" rules="none"> 
     
    209327<col class="field-body" /> 
    210328<tbody valign="top"> 
    211 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td> 
    212 </tr> 
    213 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     329<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> 
     330</tr> 
     331<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    214332</tr> 
    215333</tbody> 
     
    219337<dl class="method"> 
    220338<dt id="sans.models.StackedDisksModel.StackedDisksModel.runXY"> 
    221 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.runXY" title="Permalink to this definition">¶</a></dt> 
     339<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.runXY" title="Permalink to this definition">¶</a></dt> 
    222340<dd><p>Evaluate the model in cartesian coordinates</p> 
    223341<table class="docutils field-list" frame="void" rules="none"> 
     
    225343<col class="field-body" /> 
    226344<tbody valign="top"> 
    227 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td> 
    228 </tr> 
    229 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     345<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td> 
     346</tr> 
     347<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    230348</tr> 
    231349</tbody> 
     
    235353<dl class="method"> 
    236354<dt id="sans.models.StackedDisksModel.StackedDisksModel.setParam"> 
    237 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.setParam" title="Permalink to this definition">¶</a></dt> 
     355<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.setParam" title="Permalink to this definition">¶</a></dt> 
    238356<dd><p>Set the value of a model parameter</p> 
    239357<table class="docutils field-list" frame="void" rules="none"> 
     
    241359<col class="field-body" /> 
    242360<tbody valign="top"> 
    243 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     361<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    244362<li><strong>name</strong> &#8211; name of the parameter</li> 
    245363<li><strong>value</strong> &#8211; value of the parameter</li> 
     
    253371<dl class="method"> 
    254372<dt id="sans.models.StackedDisksModel.StackedDisksModel.setParamWithToken"> 
    255 <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.StackedDisksModel.StackedDisksModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     373<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    256374<dd></dd></dl> 
    257375 
    258376<dl class="method"> 
    259377<dt id="sans.models.StackedDisksModel.StackedDisksModel.set_dispersion"> 
    260 <tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
     378<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
    261379<dd><p>Set the dispersion object for a model parameter</p> 
    262380<table class="docutils field-list" frame="void" rules="none"> 
     
    264382<col class="field-body" /> 
    265383<tbody valign="top"> 
    266 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     384<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    267385<li><strong>parameter</strong> &#8211; name of the parameter [string]</li> 
    268386<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li> 
     
    293411  <ul> 
    294412<li><a class="reference internal" href="#">StackedDisksModel</a><ul> 
    295 <li><a class="reference internal" href="#module-sans.models.StackedDisksModel"><tt class="docutils literal"><span class="pre">sans.models.StackedDisksModel</span></tt></a></li> 
     413<li><a class="reference internal" href="#sans-models-stackeddisksmodel"><tt class="docutils literal"><span class="pre">sans.models.StackedDisksModel</span></tt></a></li> 
    296414</ul> 
    297415</li> 
     
    312430  <h3>Quick search</h3> 
    313431    <form class="search" action="../search.html" method="get"> 
    314       <input type="text" name="q" size="18" /> 
     432      <input type="text" name="q" /> 
    315433      <input type="submit" value="Go" /> 
    316434      <input type="hidden" name="check_keywords" value="yes" /> 
     
    341459          <a href="SquareWellStructure.html" title="SquareWellStructure" 
    342460             >previous</a> |</li> 
    343         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     461        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    344462          <li><a href="index.html" >Reference</a> &raquo;</li>  
    345463      </ul> 
     
    347465    <div class="footer"> 
    348466        &copy; Copyright 2010, sans group. 
    349       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     467      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    350468    </div> 
    351469  </body> 
Note: See TracChangeset for help on using the changeset viewer.