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/PearlNecklaceModel.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>PearlNecklaceModel &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>PearlNecklaceModel &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="pluginmodel" href="pluginmodel.html" /> 
    … …  
    4447          <a href="PeakLorentzModel.html" title="PeakLorentzModel" 
    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="pearlnecklacemodel"> 
    5760<h1>PearlNecklaceModel<a class="headerlink" href="#pearlnecklacemodel" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.PearlNecklaceModel"> 
    59 <span id="sans-models-pearlnecklacemodel"></span><h2><a class="reference internal" href="#module-sans.models.PearlNecklaceModel" title="sans.models.PearlNecklaceModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.PearlNecklaceModel</span></tt></a><a class="headerlink" href="#module-sans.models.PearlNecklaceModel" 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-pearlnecklacemodel"> 
     62<h2><a class="reference internal" href="#module-sans.models.PearlNecklaceModel" title="sans.models.PearlNecklaceModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.PearlNecklaceModel</span></tt></a><a class="headerlink" href="#sans-models-pearlnecklacemodel" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.PearlNecklaceModel"></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_extensionspearlnecklace.h 
    6770AND RE-RUN THE GENERATOR SCRIPT</td> 
    … …  
    8992background      = 0.0</div></blockquote> 
    9093<dl class="method"> 
     94<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.__add__"> 
     95<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.__add__" title="Permalink to this definition">¶</a></dt> 
     96<dd></dd></dl> 
     97 
     98<dl class="attribute"> 
     99<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.__class__"> 
     100<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.__class__" title="Permalink to this definition">¶</a></dt> 
     101<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     102</dd></dl> 
     103 
     104<dl class="attribute"> 
     105<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.__delattr__"> 
     106<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.__delattr__" title="Permalink to this definition">¶</a></dt> 
     107<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     108</dd></dl> 
     109 
     110<dl class="attribute"> 
     111<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.__dict__"> 
     112<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x023084B0&gt;</em><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.__dict__" title="Permalink to this definition">¶</a></dt> 
     113<dd></dd></dl> 
     114 
     115<dl class="method"> 
     116<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.__div__"> 
     117<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.__div__" title="Permalink to this definition">¶</a></dt> 
     118<dd></dd></dl> 
     119 
     120<dl class="attribute"> 
     121<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.__getattribute__"> 
     122<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     123<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     124</dd></dl> 
     125 
     126<dl class="attribute"> 
     127<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.__hash__"> 
     128<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.__hash__" title="Permalink to this definition">¶</a></dt> 
     129<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     130</dd></dl> 
     131 
     132<dl class="method"> 
     133<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.__init__"> 
     134<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.__init__" title="Permalink to this definition">¶</a></dt> 
     135<dd><p>Initialization</p> 
     136</dd></dl> 
     137 
     138<dl class="attribute"> 
     139<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.__module__"> 
     140<tt class="descname">__module__</tt><em class="property"> = 'sans.models.PearlNecklaceModel'</em><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.__module__" title="Permalink to this definition">¶</a></dt> 
     141<dd></dd></dl> 
     142 
     143<dl class="method"> 
     144<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.__mul__"> 
     145<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.__mul__" title="Permalink to this definition">¶</a></dt> 
     146<dd></dd></dl> 
     147 
     148<dl class="staticmethod"> 
     149<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.__new__"> 
     150<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.PearlNecklaceModel.PearlNecklaceModel.__new__" title="Permalink to this definition">¶</a></dt> 
     151<dd></dd></dl> 
     152 
     153<dl class="method"> 
     154<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.__reduce__"> 
     155<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.__reduce__" title="Permalink to this definition">¶</a></dt> 
     156<dd><p>helper for pickle</p> 
     157</dd></dl> 
     158 
     159<dl class="method"> 
     160<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.__reduce_ex__"> 
     161<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     162<dd><p>Overwrite the __reduce_ex__ of PyTypeObject <a href="#id1"><span class="problematic" id="id2">*</span></a>type call in the init of  
     163c model.</p> 
     164</dd></dl> 
     165 
     166<dl class="attribute"> 
     167<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.__repr__"> 
     168<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.__repr__" title="Permalink to this definition">¶</a></dt> 
     169<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     170</dd></dl> 
     171 
     172<dl class="attribute"> 
     173<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.__setattr__"> 
     174<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.__setattr__" title="Permalink to this definition">¶</a></dt> 
     175<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     176</dd></dl> 
     177 
     178<dl class="method"> 
     179<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.__setstate__"> 
     180<tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.__setstate__" title="Permalink to this definition">¶</a></dt> 
     181<dd><p>restore the state of a model from pickle</p> 
     182</dd></dl> 
     183 
     184<dl class="attribute"> 
     185<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.__str__"> 
     186<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.__str__" title="Permalink to this definition">¶</a></dt> 
     187<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     188</dd></dl> 
     189 
     190<dl class="method"> 
     191<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.__sub__"> 
     192<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.__sub__" title="Permalink to this definition">¶</a></dt> 
     193<dd></dd></dl> 
     194 
     195<dl class="attribute"> 
     196<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.__weakref__"> 
     197<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.__weakref__" title="Permalink to this definition">¶</a></dt> 
     198<dd><p>list of weak references to the object (if defined)</p> 
     199</dd></dl> 
     200 
     201<dl class="method"> 
     202<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel._clone"> 
     203<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel._clone" title="Permalink to this definition">¶</a></dt> 
     204<dd><p>Internal utility function to copy the internal 
     205data members to a fresh copy.</p> 
     206</dd></dl> 
     207 
     208<dl class="method"> 
    91209<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.calculate_ER"> 
    92210<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.calculate_ER" title="Permalink to this definition">¶</a></dt> 
    … …  
    96214<col class="field-body" /> 
    97215<tbody valign="top"> 
    98 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
     216<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
    99217</tr> 
    100218</tbody> 
    … …  
    116234<dl class="method"> 
    117235<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.evalDistribution"> 
    118 <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.PearlNecklaceModel.PearlNecklaceModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     236<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    119237<dd><p>Evaluate the model in cartesian coordinates</p> 
    120238<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    122240<col class="field-body" /> 
    123241<tbody valign="top"> 
    124 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td> 
    125 </tr> 
    126 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
     242<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> 
     243</tr> 
     244<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
    127245</tr> 
    128246</tbody> 
    … …  
    138256<dl class="method"> 
    139257<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.getParam"> 
    140 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.getParam" title="Permalink to this definition">¶</a></dt> 
     258<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.getParam" title="Permalink to this definition">¶</a></dt> 
    141259<dd><p>Set the value of a model parameter</p> 
    142260<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    144262<col class="field-body" /> 
    145263<tbody valign="top"> 
    146 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     264<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    147265</tr> 
    148266</tbody> 
    … …  
    158276<dl class="method"> 
    159277<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.getParamListWithToken"> 
    160 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     278<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    161279<dd></dd></dl> 
    162280 
    163281<dl class="method"> 
    164282<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.getParamWithToken"> 
    165 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     283<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    166284<dd></dd></dl> 
    167285 
    168286<dl class="method"> 
    169287<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.is_fittable"> 
    170 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
     288<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
    171289<dd><p>Check if a given parameter is fittable or not</p> 
    172290<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    174292<col class="field-body" /> 
    175293<tbody valign="top"> 
    176 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     294<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> 
    177295</tr> 
    178296</tbody> 
    … …  
    192310</dd></dl> 
    193311 
    194 <dl class="attribute"> 
     312<dl class="method"> 
    195313<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.reset"> 
    196 <tt class="descname">reset</tt><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.reset" title="Permalink to this definition">¶</a></dt> 
     314<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.reset" title="Permalink to this definition">¶</a></dt> 
    197315<dd><p>Reset pair correlation</p> 
    198316</dd></dl> 
    … …  
    200318<dl class="method"> 
    201319<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.run"> 
    202 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.run" title="Permalink to this definition">¶</a></dt> 
     320<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.run" title="Permalink to this definition">¶</a></dt> 
    203321<dd><p>Evaluate the model</p> 
    204322<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    206324<col class="field-body" /> 
    207325<tbody valign="top"> 
    208 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td> 
    209 </tr> 
    210 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     326<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> 
     327</tr> 
     328<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    211329</tr> 
    212330</tbody> 
    … …  
    216334<dl class="method"> 
    217335<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.runXY"> 
    218 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.runXY" title="Permalink to this definition">¶</a></dt> 
     336<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.runXY" title="Permalink to this definition">¶</a></dt> 
    219337<dd><p>Evaluate the model in cartesian coordinates</p> 
    220338<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    222340<col class="field-body" /> 
    223341<tbody valign="top"> 
    224 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td> 
    225 </tr> 
    226 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     342<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> 
     343</tr> 
     344<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    227345</tr> 
    228346</tbody> 
    … …  
    232350<dl class="method"> 
    233351<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.setParam"> 
    234 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.setParam" title="Permalink to this definition">¶</a></dt> 
     352<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.setParam" title="Permalink to this definition">¶</a></dt> 
    235353<dd><p>Set the value of a model parameter</p> 
    236354<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    238356<col class="field-body" /> 
    239357<tbody valign="top"> 
    240 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     358<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    241359<li><strong>name</strong> &#8211; name of the parameter</li> 
    242360<li><strong>value</strong> &#8211; value of the parameter</li> 
    … …  
    250368<dl class="method"> 
    251369<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.setParamWithToken"> 
    252 <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.PearlNecklaceModel.PearlNecklaceModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     370<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    253371<dd></dd></dl> 
    254372 
    255373<dl class="method"> 
    256374<dt id="sans.models.PearlNecklaceModel.PearlNecklaceModel.set_dispersion"> 
    257 <tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
     375<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.PearlNecklaceModel.PearlNecklaceModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
    258376<dd><p>Set the dispersion object for a model parameter</p> 
    259377<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    261379<col class="field-body" /> 
    262380<tbody valign="top"> 
    263 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     381<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    264382<li><strong>parameter</strong> &#8211; name of the parameter [string]</li> 
    265383<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li> 
    … …  
    290408  <ul> 
    291409<li><a class="reference internal" href="#">PearlNecklaceModel</a><ul> 
    292 <li><a class="reference internal" href="#module-sans.models.PearlNecklaceModel"><tt class="docutils literal"><span class="pre">sans.models.PearlNecklaceModel</span></tt></a></li> 
     410<li><a class="reference internal" href="#sans-models-pearlnecklacemodel"><tt class="docutils literal"><span class="pre">sans.models.PearlNecklaceModel</span></tt></a></li> 
    293411</ul> 
    294412</li> 
    … …  
    309427  <h3>Quick search</h3> 
    310428    <form class="search" action="../search.html" method="get"> 
    311       <input type="text" name="q" size="18" /> 
     429      <input type="text" name="q" /> 
    312430      <input type="submit" value="Go" /> 
    313431      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    338456          <a href="PeakLorentzModel.html" title="PeakLorentzModel" 
    339457             >previous</a> |</li> 
    340         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     458        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    341459          <li><a href="index.html" >Reference</a> &raquo;</li>  
    342460      </ul> 
    … …  
    344462    <div class="footer"> 
    345463        &copy; Copyright 2010, sans group. 
    346       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     464      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    347465    </div> 
    348466  </body> 
Note: See TracChangeset for help on using the changeset viewer.