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/LamellarPSModel.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>LamellarPSModel &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>LamellarPSModel &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="LineModel" href="LineModel.html" /> 
     
    4447          <a href="LamellarPSHGModel.html" title="LamellarPSHGModel" 
    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="lamellarpsmodel"> 
    5760<h1>LamellarPSModel<a class="headerlink" href="#lamellarpsmodel" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.LamellarPSModel"> 
    59 <span id="sans-models-lamellarpsmodel"></span><h2><a class="reference internal" href="#module-sans.models.LamellarPSModel" title="sans.models.LamellarPSModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.LamellarPSModel</span></tt></a><a class="headerlink" href="#module-sans.models.LamellarPSModel" 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-lamellarpsmodel"> 
     62<h2><a class="reference internal" href="#module-sans.models.LamellarPSModel" title="sans.models.LamellarPSModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.LamellarPSModel</span></tt></a><a class="headerlink" href="#sans-models-lamellarpsmodel" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.LamellarPSModel"></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_extensionslamellarPS.h 
    6770AND RE-RUN THE GENERATOR SCRIPT</td> 
     
    8891background      = 0.0 [1/cm]</div></blockquote> 
    8992<dl class="method"> 
     93<dt id="sans.models.LamellarPSModel.LamellarPSModel.__add__"> 
     94<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.__add__" title="Permalink to this definition">¶</a></dt> 
     95<dd></dd></dl> 
     96 
     97<dl class="attribute"> 
     98<dt id="sans.models.LamellarPSModel.LamellarPSModel.__class__"> 
     99<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.__class__" title="Permalink to this definition">¶</a></dt> 
     100<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     101</dd></dl> 
     102 
     103<dl class="attribute"> 
     104<dt id="sans.models.LamellarPSModel.LamellarPSModel.__delattr__"> 
     105<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.__delattr__" title="Permalink to this definition">¶</a></dt> 
     106<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     107</dd></dl> 
     108 
     109<dl class="attribute"> 
     110<dt id="sans.models.LamellarPSModel.LamellarPSModel.__dict__"> 
     111<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x021408D0&gt;</em><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.__dict__" title="Permalink to this definition">¶</a></dt> 
     112<dd></dd></dl> 
     113 
     114<dl class="method"> 
     115<dt id="sans.models.LamellarPSModel.LamellarPSModel.__div__"> 
     116<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.__div__" title="Permalink to this definition">¶</a></dt> 
     117<dd></dd></dl> 
     118 
     119<dl class="attribute"> 
     120<dt id="sans.models.LamellarPSModel.LamellarPSModel.__getattribute__"> 
     121<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     122<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     123</dd></dl> 
     124 
     125<dl class="attribute"> 
     126<dt id="sans.models.LamellarPSModel.LamellarPSModel.__hash__"> 
     127<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.__hash__" title="Permalink to this definition">¶</a></dt> 
     128<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     129</dd></dl> 
     130 
     131<dl class="method"> 
     132<dt id="sans.models.LamellarPSModel.LamellarPSModel.__init__"> 
     133<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.__init__" title="Permalink to this definition">¶</a></dt> 
     134<dd><p>Initialization</p> 
     135</dd></dl> 
     136 
     137<dl class="attribute"> 
     138<dt id="sans.models.LamellarPSModel.LamellarPSModel.__module__"> 
     139<tt class="descname">__module__</tt><em class="property"> = 'sans.models.LamellarPSModel'</em><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.__module__" title="Permalink to this definition">¶</a></dt> 
     140<dd></dd></dl> 
     141 
     142<dl class="method"> 
     143<dt id="sans.models.LamellarPSModel.LamellarPSModel.__mul__"> 
     144<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.__mul__" title="Permalink to this definition">¶</a></dt> 
     145<dd></dd></dl> 
     146 
     147<dl class="staticmethod"> 
     148<dt id="sans.models.LamellarPSModel.LamellarPSModel.__new__"> 
     149<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.LamellarPSModel.LamellarPSModel.__new__" title="Permalink to this definition">¶</a></dt> 
     150<dd></dd></dl> 
     151 
     152<dl class="method"> 
     153<dt id="sans.models.LamellarPSModel.LamellarPSModel.__reduce__"> 
     154<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.__reduce__" title="Permalink to this definition">¶</a></dt> 
     155<dd><p>helper for pickle</p> 
     156</dd></dl> 
     157 
     158<dl class="method"> 
     159<dt id="sans.models.LamellarPSModel.LamellarPSModel.__reduce_ex__"> 
     160<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     161<dd><p>Overwrite the __reduce_ex__ of PyTypeObject <a href="#id1"><span class="problematic" id="id2">*</span></a>type call in the init of  
     162c model.</p> 
     163</dd></dl> 
     164 
     165<dl class="attribute"> 
     166<dt id="sans.models.LamellarPSModel.LamellarPSModel.__repr__"> 
     167<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.__repr__" title="Permalink to this definition">¶</a></dt> 
     168<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     169</dd></dl> 
     170 
     171<dl class="attribute"> 
     172<dt id="sans.models.LamellarPSModel.LamellarPSModel.__setattr__"> 
     173<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.__setattr__" title="Permalink to this definition">¶</a></dt> 
     174<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     175</dd></dl> 
     176 
     177<dl class="method"> 
     178<dt id="sans.models.LamellarPSModel.LamellarPSModel.__setstate__"> 
     179<tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.__setstate__" title="Permalink to this definition">¶</a></dt> 
     180<dd><p>restore the state of a model from pickle</p> 
     181</dd></dl> 
     182 
     183<dl class="attribute"> 
     184<dt id="sans.models.LamellarPSModel.LamellarPSModel.__str__"> 
     185<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.__str__" title="Permalink to this definition">¶</a></dt> 
     186<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     187</dd></dl> 
     188 
     189<dl class="method"> 
     190<dt id="sans.models.LamellarPSModel.LamellarPSModel.__sub__"> 
     191<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.__sub__" title="Permalink to this definition">¶</a></dt> 
     192<dd></dd></dl> 
     193 
     194<dl class="attribute"> 
     195<dt id="sans.models.LamellarPSModel.LamellarPSModel.__weakref__"> 
     196<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.__weakref__" title="Permalink to this definition">¶</a></dt> 
     197<dd><p>list of weak references to the object (if defined)</p> 
     198</dd></dl> 
     199 
     200<dl class="method"> 
     201<dt id="sans.models.LamellarPSModel.LamellarPSModel._clone"> 
     202<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel._clone" title="Permalink to this definition">¶</a></dt> 
     203<dd><p>Internal utility function to copy the internal 
     204data members to a fresh copy.</p> 
     205</dd></dl> 
     206 
     207<dl class="method"> 
    90208<dt id="sans.models.LamellarPSModel.LamellarPSModel.calculate_ER"> 
    91209<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.calculate_ER" title="Permalink to this definition">¶</a></dt> 
     
    95213<col class="field-body" /> 
    96214<tbody valign="top"> 
    97 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
     215<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
    98216</tr> 
    99217</tbody> 
     
    115233<dl class="method"> 
    116234<dt id="sans.models.LamellarPSModel.LamellarPSModel.evalDistribution"> 
    117 <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.LamellarPSModel.LamellarPSModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     235<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    118236<dd><p>Evaluate the model in cartesian coordinates</p> 
    119237<table class="docutils field-list" frame="void" rules="none"> 
     
    121239<col class="field-body" /> 
    122240<tbody valign="top"> 
    123 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td> 
    124 </tr> 
    125 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
     241<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> 
     242</tr> 
     243<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
    126244</tr> 
    127245</tbody> 
     
    137255<dl class="method"> 
    138256<dt id="sans.models.LamellarPSModel.LamellarPSModel.getParam"> 
    139 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.getParam" title="Permalink to this definition">¶</a></dt> 
     257<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.getParam" title="Permalink to this definition">¶</a></dt> 
    140258<dd><p>Set the value of a model parameter</p> 
    141259<table class="docutils field-list" frame="void" rules="none"> 
     
    143261<col class="field-body" /> 
    144262<tbody valign="top"> 
    145 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     263<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    146264</tr> 
    147265</tbody> 
     
    157275<dl class="method"> 
    158276<dt id="sans.models.LamellarPSModel.LamellarPSModel.getParamListWithToken"> 
    159 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     277<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    160278<dd></dd></dl> 
    161279 
    162280<dl class="method"> 
    163281<dt id="sans.models.LamellarPSModel.LamellarPSModel.getParamWithToken"> 
    164 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     282<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    165283<dd></dd></dl> 
    166284 
    167285<dl class="method"> 
    168286<dt id="sans.models.LamellarPSModel.LamellarPSModel.is_fittable"> 
    169 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
     287<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
    170288<dd><p>Check if a given parameter is fittable or not</p> 
    171289<table class="docutils field-list" frame="void" rules="none"> 
     
    173291<col class="field-body" /> 
    174292<tbody valign="top"> 
    175 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     293<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> 
    176294</tr> 
    177295</tbody> 
     
    191309</dd></dl> 
    192310 
    193 <dl class="attribute"> 
     311<dl class="method"> 
    194312<dt id="sans.models.LamellarPSModel.LamellarPSModel.reset"> 
    195 <tt class="descname">reset</tt><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.reset" title="Permalink to this definition">¶</a></dt> 
     313<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.reset" title="Permalink to this definition">¶</a></dt> 
    196314<dd><p>Reset pair correlation</p> 
    197315</dd></dl> 
     
    199317<dl class="method"> 
    200318<dt id="sans.models.LamellarPSModel.LamellarPSModel.run"> 
    201 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.run" title="Permalink to this definition">¶</a></dt> 
     319<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.run" title="Permalink to this definition">¶</a></dt> 
    202320<dd><p>Evaluate the model</p> 
    203321<table class="docutils field-list" frame="void" rules="none"> 
     
    205323<col class="field-body" /> 
    206324<tbody valign="top"> 
    207 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td> 
    208 </tr> 
    209 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     325<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> 
     326</tr> 
     327<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    210328</tr> 
    211329</tbody> 
     
    215333<dl class="method"> 
    216334<dt id="sans.models.LamellarPSModel.LamellarPSModel.runXY"> 
    217 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.runXY" title="Permalink to this definition">¶</a></dt> 
     335<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.runXY" title="Permalink to this definition">¶</a></dt> 
    218336<dd><p>Evaluate the model in cartesian coordinates</p> 
    219337<table class="docutils field-list" frame="void" rules="none"> 
     
    221339<col class="field-body" /> 
    222340<tbody valign="top"> 
    223 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td> 
    224 </tr> 
    225 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     341<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> 
     342</tr> 
     343<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    226344</tr> 
    227345</tbody> 
     
    231349<dl class="method"> 
    232350<dt id="sans.models.LamellarPSModel.LamellarPSModel.setParam"> 
    233 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.setParam" title="Permalink to this definition">¶</a></dt> 
     351<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.setParam" title="Permalink to this definition">¶</a></dt> 
    234352<dd><p>Set the value of a model parameter</p> 
    235353<table class="docutils field-list" frame="void" rules="none"> 
     
    237355<col class="field-body" /> 
    238356<tbody valign="top"> 
    239 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     357<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    240358<li><strong>name</strong> &#8211; name of the parameter</li> 
    241359<li><strong>value</strong> &#8211; value of the parameter</li> 
     
    249367<dl class="method"> 
    250368<dt id="sans.models.LamellarPSModel.LamellarPSModel.setParamWithToken"> 
    251 <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.LamellarPSModel.LamellarPSModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     369<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    252370<dd></dd></dl> 
    253371 
    254372<dl class="method"> 
    255373<dt id="sans.models.LamellarPSModel.LamellarPSModel.set_dispersion"> 
    256 <tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
     374<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarPSModel.LamellarPSModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
    257375<dd><p>Set the dispersion object for a model parameter</p> 
    258376<table class="docutils field-list" frame="void" rules="none"> 
     
    260378<col class="field-body" /> 
    261379<tbody valign="top"> 
    262 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     380<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    263381<li><strong>parameter</strong> &#8211; name of the parameter [string]</li> 
    264382<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li> 
     
    289407  <ul> 
    290408<li><a class="reference internal" href="#">LamellarPSModel</a><ul> 
    291 <li><a class="reference internal" href="#module-sans.models.LamellarPSModel"><tt class="docutils literal"><span class="pre">sans.models.LamellarPSModel</span></tt></a></li> 
     409<li><a class="reference internal" href="#sans-models-lamellarpsmodel"><tt class="docutils literal"><span class="pre">sans.models.LamellarPSModel</span></tt></a></li> 
    292410</ul> 
    293411</li> 
     
    308426  <h3>Quick search</h3> 
    309427    <form class="search" action="../search.html" method="get"> 
    310       <input type="text" name="q" size="18" /> 
     428      <input type="text" name="q" /> 
    311429      <input type="submit" value="Go" /> 
    312430      <input type="hidden" name="check_keywords" value="yes" /> 
     
    337455          <a href="LamellarPSHGModel.html" title="LamellarPSHGModel" 
    338456             >previous</a> |</li> 
    339         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     457        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    340458          <li><a href="index.html" >Reference</a> &raquo;</li>  
    341459      </ul> 
     
    343461    <div class="footer"> 
    344462        &copy; Copyright 2010, sans group. 
    345       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     463      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    346464    </div> 
    347465  </body> 
Note: See TracChangeset for help on using the changeset viewer.