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/SquareWellStructure.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>SquareWellStructure &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>SquareWellStructure &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="StackedDisksModel" href="StackedDisksModel.html" /> 
    … …  
    4447          <a href="SphericalSLDModel.html" title="SphericalSLDModel" 
    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="squarewellstructure"> 
    5760<h1>SquareWellStructure<a class="headerlink" href="#squarewellstructure" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.SquareWellStructure"> 
    59 <span id="sans-models-squarewellstructure"></span><h2><a class="reference internal" href="#module-sans.models.SquareWellStructure" title="sans.models.SquareWellStructure"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.SquareWellStructure</span></tt></a><a class="headerlink" href="#module-sans.models.SquareWellStructure" 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-squarewellstructure"> 
     62<h2><a class="reference internal" href="#module-sans.models.SquareWellStructure" title="sans.models.SquareWellStructure"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.SquareWellStructure</span></tt></a><a class="headerlink" href="#sans-models-squarewellstructure" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.SquareWellStructure"></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_extensionsSquareWell.h 
    6770AND RE-RUN THE GENERATOR SCRIPT</td> 
    … …  
    8487wellwidth       = 1.2</div></blockquote> 
    8588<dl class="method"> 
     89<dt id="sans.models.SquareWellStructure.SquareWellStructure.__add__"> 
     90<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.__add__" title="Permalink to this definition">¶</a></dt> 
     91<dd></dd></dl> 
     92 
     93<dl class="attribute"> 
     94<dt id="sans.models.SquareWellStructure.SquareWellStructure.__class__"> 
     95<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.__class__" title="Permalink to this definition">¶</a></dt> 
     96<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     97</dd></dl> 
     98 
     99<dl class="attribute"> 
     100<dt id="sans.models.SquareWellStructure.SquareWellStructure.__delattr__"> 
     101<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.__delattr__" title="Permalink to this definition">¶</a></dt> 
     102<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     103</dd></dl> 
     104 
     105<dl class="attribute"> 
     106<dt id="sans.models.SquareWellStructure.SquareWellStructure.__dict__"> 
     107<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x02F0ECB0&gt;</em><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.__dict__" title="Permalink to this definition">¶</a></dt> 
     108<dd></dd></dl> 
     109 
     110<dl class="method"> 
     111<dt id="sans.models.SquareWellStructure.SquareWellStructure.__div__"> 
     112<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.__div__" title="Permalink to this definition">¶</a></dt> 
     113<dd></dd></dl> 
     114 
     115<dl class="attribute"> 
     116<dt id="sans.models.SquareWellStructure.SquareWellStructure.__getattribute__"> 
     117<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     118<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     119</dd></dl> 
     120 
     121<dl class="attribute"> 
     122<dt id="sans.models.SquareWellStructure.SquareWellStructure.__hash__"> 
     123<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.__hash__" title="Permalink to this definition">¶</a></dt> 
     124<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     125</dd></dl> 
     126 
     127<dl class="method"> 
     128<dt id="sans.models.SquareWellStructure.SquareWellStructure.__init__"> 
     129<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.__init__" title="Permalink to this definition">¶</a></dt> 
     130<dd><p>Initialization</p> 
     131</dd></dl> 
     132 
     133<dl class="attribute"> 
     134<dt id="sans.models.SquareWellStructure.SquareWellStructure.__module__"> 
     135<tt class="descname">__module__</tt><em class="property"> = 'sans.models.SquareWellStructure'</em><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.__module__" title="Permalink to this definition">¶</a></dt> 
     136<dd></dd></dl> 
     137 
     138<dl class="method"> 
     139<dt id="sans.models.SquareWellStructure.SquareWellStructure.__mul__"> 
     140<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.__mul__" title="Permalink to this definition">¶</a></dt> 
     141<dd></dd></dl> 
     142 
     143<dl class="staticmethod"> 
     144<dt id="sans.models.SquareWellStructure.SquareWellStructure.__new__"> 
     145<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.SquareWellStructure.SquareWellStructure.__new__" title="Permalink to this definition">¶</a></dt> 
     146<dd></dd></dl> 
     147 
     148<dl class="method"> 
     149<dt id="sans.models.SquareWellStructure.SquareWellStructure.__reduce__"> 
     150<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.__reduce__" title="Permalink to this definition">¶</a></dt> 
     151<dd><p>helper for pickle</p> 
     152</dd></dl> 
     153 
     154<dl class="method"> 
     155<dt id="sans.models.SquareWellStructure.SquareWellStructure.__reduce_ex__"> 
     156<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     157<dd><p>Overwrite the __reduce_ex__ of PyTypeObject <a href="#id1"><span class="problematic" id="id2">*</span></a>type call in the init of  
     158c model.</p> 
     159</dd></dl> 
     160 
     161<dl class="attribute"> 
     162<dt id="sans.models.SquareWellStructure.SquareWellStructure.__repr__"> 
     163<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.__repr__" title="Permalink to this definition">¶</a></dt> 
     164<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     165</dd></dl> 
     166 
     167<dl class="attribute"> 
     168<dt id="sans.models.SquareWellStructure.SquareWellStructure.__setattr__"> 
     169<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.__setattr__" title="Permalink to this definition">¶</a></dt> 
     170<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     171</dd></dl> 
     172 
     173<dl class="method"> 
     174<dt id="sans.models.SquareWellStructure.SquareWellStructure.__setstate__"> 
     175<tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.__setstate__" title="Permalink to this definition">¶</a></dt> 
     176<dd><p>restore the state of a model from pickle</p> 
     177</dd></dl> 
     178 
     179<dl class="attribute"> 
     180<dt id="sans.models.SquareWellStructure.SquareWellStructure.__str__"> 
     181<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.__str__" title="Permalink to this definition">¶</a></dt> 
     182<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     183</dd></dl> 
     184 
     185<dl class="method"> 
     186<dt id="sans.models.SquareWellStructure.SquareWellStructure.__sub__"> 
     187<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.__sub__" title="Permalink to this definition">¶</a></dt> 
     188<dd></dd></dl> 
     189 
     190<dl class="attribute"> 
     191<dt id="sans.models.SquareWellStructure.SquareWellStructure.__weakref__"> 
     192<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.__weakref__" title="Permalink to this definition">¶</a></dt> 
     193<dd><p>list of weak references to the object (if defined)</p> 
     194</dd></dl> 
     195 
     196<dl class="method"> 
     197<dt id="sans.models.SquareWellStructure.SquareWellStructure._clone"> 
     198<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure._clone" title="Permalink to this definition">¶</a></dt> 
     199<dd><p>Internal utility function to copy the internal 
     200data members to a fresh copy.</p> 
     201</dd></dl> 
     202 
     203<dl class="method"> 
    86204<dt id="sans.models.SquareWellStructure.SquareWellStructure.calculate_ER"> 
    87205<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.calculate_ER" title="Permalink to this definition">¶</a></dt> 
    … …  
    91209<col class="field-body" /> 
    92210<tbody valign="top"> 
    93 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
     211<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
    94212</tr> 
    95213</tbody> 
    … …  
    111229<dl class="method"> 
    112230<dt id="sans.models.SquareWellStructure.SquareWellStructure.evalDistribution"> 
    113 <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.SquareWellStructure.SquareWellStructure.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     231<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    114232<dd><p>Evaluate the model in cartesian coordinates</p> 
    115233<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    117235<col class="field-body" /> 
    118236<tbody valign="top"> 
    119 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td> 
    120 </tr> 
    121 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
     237<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> 
     238</tr> 
     239<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
    122240</tr> 
    123241</tbody> 
    … …  
    133251<dl class="method"> 
    134252<dt id="sans.models.SquareWellStructure.SquareWellStructure.getParam"> 
    135 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.getParam" title="Permalink to this definition">¶</a></dt> 
     253<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.getParam" title="Permalink to this definition">¶</a></dt> 
    136254<dd><p>Set the value of a model parameter</p> 
    137255<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    139257<col class="field-body" /> 
    140258<tbody valign="top"> 
    141 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     259<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    142260</tr> 
    143261</tbody> 
    … …  
    153271<dl class="method"> 
    154272<dt id="sans.models.SquareWellStructure.SquareWellStructure.getParamListWithToken"> 
    155 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     273<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    156274<dd></dd></dl> 
    157275 
    158276<dl class="method"> 
    159277<dt id="sans.models.SquareWellStructure.SquareWellStructure.getParamWithToken"> 
    160 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     278<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    161279<dd></dd></dl> 
    162280 
    163281<dl class="method"> 
    164282<dt id="sans.models.SquareWellStructure.SquareWellStructure.is_fittable"> 
    165 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.is_fittable" title="Permalink to this definition">¶</a></dt> 
     283<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.is_fittable" title="Permalink to this definition">¶</a></dt> 
    166284<dd><p>Check if a given parameter is fittable or not</p> 
    167285<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    169287<col class="field-body" /> 
    170288<tbody valign="top"> 
    171 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     289<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> 
    172290</tr> 
    173291</tbody> 
    … …  
    187305</dd></dl> 
    188306 
    189 <dl class="attribute"> 
     307<dl class="method"> 
    190308<dt id="sans.models.SquareWellStructure.SquareWellStructure.reset"> 
    191 <tt class="descname">reset</tt><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.reset" title="Permalink to this definition">¶</a></dt> 
     309<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.reset" title="Permalink to this definition">¶</a></dt> 
    192310<dd><p>Reset pair correlation</p> 
    193311</dd></dl> 
    … …  
    195313<dl class="method"> 
    196314<dt id="sans.models.SquareWellStructure.SquareWellStructure.run"> 
    197 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.run" title="Permalink to this definition">¶</a></dt> 
     315<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.run" title="Permalink to this definition">¶</a></dt> 
    198316<dd><p>Evaluate the model</p> 
    199317<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    201319<col class="field-body" /> 
    202320<tbody valign="top"> 
    203 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td> 
    204 </tr> 
    205 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     321<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> 
     322</tr> 
     323<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    206324</tr> 
    207325</tbody> 
    … …  
    211329<dl class="method"> 
    212330<dt id="sans.models.SquareWellStructure.SquareWellStructure.runXY"> 
    213 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.runXY" title="Permalink to this definition">¶</a></dt> 
     331<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.runXY" title="Permalink to this definition">¶</a></dt> 
    214332<dd><p>Evaluate the model in cartesian coordinates</p> 
    215333<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    217335<col class="field-body" /> 
    218336<tbody valign="top"> 
    219 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td> 
    220 </tr> 
    221 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     337<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> 
     338</tr> 
     339<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    222340</tr> 
    223341</tbody> 
    … …  
    227345<dl class="method"> 
    228346<dt id="sans.models.SquareWellStructure.SquareWellStructure.setParam"> 
    229 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.setParam" title="Permalink to this definition">¶</a></dt> 
     347<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.setParam" title="Permalink to this definition">¶</a></dt> 
    230348<dd><p>Set the value of a model parameter</p> 
    231349<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    233351<col class="field-body" /> 
    234352<tbody valign="top"> 
    235 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     353<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    236354<li><strong>name</strong> &#8211; name of the parameter</li> 
    237355<li><strong>value</strong> &#8211; value of the parameter</li> 
    … …  
    245363<dl class="method"> 
    246364<dt id="sans.models.SquareWellStructure.SquareWellStructure.setParamWithToken"> 
    247 <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.SquareWellStructure.SquareWellStructure.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     365<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    248366<dd></dd></dl> 
    249367 
    250368<dl class="method"> 
    251369<dt id="sans.models.SquareWellStructure.SquareWellStructure.set_dispersion"> 
    252 <tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.set_dispersion" title="Permalink to this definition">¶</a></dt> 
     370<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SquareWellStructure.SquareWellStructure.set_dispersion" title="Permalink to this definition">¶</a></dt> 
    253371<dd><p>Set the dispersion object for a model parameter</p> 
    254372<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    256374<col class="field-body" /> 
    257375<tbody valign="top"> 
    258 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     376<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    259377<li><strong>parameter</strong> &#8211; name of the parameter [string]</li> 
    260378<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li> 
    … …  
    285403  <ul> 
    286404<li><a class="reference internal" href="#">SquareWellStructure</a><ul> 
    287 <li><a class="reference internal" href="#module-sans.models.SquareWellStructure"><tt class="docutils literal"><span class="pre">sans.models.SquareWellStructure</span></tt></a></li> 
     405<li><a class="reference internal" href="#sans-models-squarewellstructure"><tt class="docutils literal"><span class="pre">sans.models.SquareWellStructure</span></tt></a></li> 
    288406</ul> 
    289407</li> 
    … …  
    304422  <h3>Quick search</h3> 
    305423    <form class="search" action="../search.html" method="get"> 
    306       <input type="text" name="q" size="18" /> 
     424      <input type="text" name="q" /> 
    307425      <input type="submit" value="Go" /> 
    308426      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    333451          <a href="SphericalSLDModel.html" title="SphericalSLDModel" 
    334452             >previous</a> |</li> 
    335         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     453        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    336454          <li><a href="index.html" >Reference</a> &raquo;</li>  
    337455      </ul> 
    … …  
    339457    <div class="footer"> 
    340458        &copy; Copyright 2010, sans group. 
    341       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     459      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    342460    </div> 
    343461  </body> 
Note: See TracChangeset for help on using the changeset viewer.