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/CSParallelepipedModel.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>CSParallelepipedModel &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>CSParallelepipedModel &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="CylinderModel" href="CylinderModel.html" /> 
     
    4447          <a href="Cos.html" title="Cos" 
    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="csparallelepipedmodel"> 
    5760<h1>CSParallelepipedModel<a class="headerlink" href="#csparallelepipedmodel" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.CSParallelepipedModel"> 
    59 <span id="sans-models-csparallelepipedmodel"></span><h2><a class="reference internal" href="#module-sans.models.CSParallelepipedModel" title="sans.models.CSParallelepipedModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.CSParallelepipedModel</span></tt></a><a class="headerlink" href="#module-sans.models.CSParallelepipedModel" 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-csparallelepipedmodel"> 
     62<h2><a class="reference internal" href="#module-sans.models.CSParallelepipedModel" title="sans.models.CSParallelepipedModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.CSParallelepipedModel</span></tt></a><a class="headerlink" href="#sans-models-csparallelepipedmodel" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.CSParallelepipedModel"></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_extensionscsparallelepiped.h 
    6770AND RE-RUN THE GENERATOR SCRIPT</td> 
     
    9699parallel_psi    = 0.0 [deg]</div></blockquote> 
    97100<dl class="method"> 
     101<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__add__"> 
     102<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__add__" title="Permalink to this definition">¶</a></dt> 
     103<dd></dd></dl> 
     104 
     105<dl class="attribute"> 
     106<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__class__"> 
     107<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__class__" title="Permalink to this definition">¶</a></dt> 
     108<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     109</dd></dl> 
     110 
     111<dl class="attribute"> 
     112<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__delattr__"> 
     113<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__delattr__" title="Permalink to this definition">¶</a></dt> 
     114<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     115</dd></dl> 
     116 
     117<dl class="attribute"> 
     118<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__dict__"> 
     119<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01C4CE30&gt;</em><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__dict__" title="Permalink to this definition">¶</a></dt> 
     120<dd></dd></dl> 
     121 
     122<dl class="method"> 
     123<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__div__"> 
     124<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__div__" title="Permalink to this definition">¶</a></dt> 
     125<dd></dd></dl> 
     126 
     127<dl class="attribute"> 
     128<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__getattribute__"> 
     129<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     130<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     131</dd></dl> 
     132 
     133<dl class="attribute"> 
     134<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__hash__"> 
     135<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__hash__" title="Permalink to this definition">¶</a></dt> 
     136<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     137</dd></dl> 
     138 
     139<dl class="method"> 
     140<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__init__"> 
     141<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__init__" title="Permalink to this definition">¶</a></dt> 
     142<dd><p>Initialization</p> 
     143</dd></dl> 
     144 
     145<dl class="attribute"> 
     146<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__module__"> 
     147<tt class="descname">__module__</tt><em class="property"> = 'sans.models.CSParallelepipedModel'</em><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__module__" title="Permalink to this definition">¶</a></dt> 
     148<dd></dd></dl> 
     149 
     150<dl class="method"> 
     151<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__mul__"> 
     152<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__mul__" title="Permalink to this definition">¶</a></dt> 
     153<dd></dd></dl> 
     154 
     155<dl class="staticmethod"> 
     156<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__new__"> 
     157<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.CSParallelepipedModel.CSParallelepipedModel.__new__" title="Permalink to this definition">¶</a></dt> 
     158<dd></dd></dl> 
     159 
     160<dl class="method"> 
     161<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__reduce__"> 
     162<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__reduce__" title="Permalink to this definition">¶</a></dt> 
     163<dd><p>helper for pickle</p> 
     164</dd></dl> 
     165 
     166<dl class="method"> 
     167<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__reduce_ex__"> 
     168<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     169<dd><p>Overwrite the __reduce_ex__ of PyTypeObject <a href="#id1"><span class="problematic" id="id2">*</span></a>type call in the init of  
     170c model.</p> 
     171</dd></dl> 
     172 
     173<dl class="attribute"> 
     174<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__repr__"> 
     175<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__repr__" title="Permalink to this definition">¶</a></dt> 
     176<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     177</dd></dl> 
     178 
     179<dl class="attribute"> 
     180<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__setattr__"> 
     181<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__setattr__" title="Permalink to this definition">¶</a></dt> 
     182<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     183</dd></dl> 
     184 
     185<dl class="method"> 
     186<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__setstate__"> 
     187<tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__setstate__" title="Permalink to this definition">¶</a></dt> 
     188<dd><p>restore the state of a model from pickle</p> 
     189</dd></dl> 
     190 
     191<dl class="attribute"> 
     192<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__str__"> 
     193<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__str__" title="Permalink to this definition">¶</a></dt> 
     194<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     195</dd></dl> 
     196 
     197<dl class="method"> 
     198<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__sub__"> 
     199<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__sub__" title="Permalink to this definition">¶</a></dt> 
     200<dd></dd></dl> 
     201 
     202<dl class="attribute"> 
     203<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.__weakref__"> 
     204<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.__weakref__" title="Permalink to this definition">¶</a></dt> 
     205<dd><p>list of weak references to the object (if defined)</p> 
     206</dd></dl> 
     207 
     208<dl class="method"> 
     209<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel._clone"> 
     210<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel._clone" title="Permalink to this definition">¶</a></dt> 
     211<dd><p>Internal utility function to copy the internal 
     212data members to a fresh copy.</p> 
     213</dd></dl> 
     214 
     215<dl class="method"> 
    98216<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.calculate_ER"> 
    99217<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.calculate_ER" title="Permalink to this definition">¶</a></dt> 
     
    103221<col class="field-body" /> 
    104222<tbody valign="top"> 
    105 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
     223<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
    106224</tr> 
    107225</tbody> 
     
    123241<dl class="method"> 
    124242<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.evalDistribution"> 
    125 <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.CSParallelepipedModel.CSParallelepipedModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     243<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    126244<dd><p>Evaluate the model in cartesian coordinates</p> 
    127245<table class="docutils field-list" frame="void" rules="none"> 
     
    129247<col class="field-body" /> 
    130248<tbody valign="top"> 
    131 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td> 
    132 </tr> 
    133 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
     249<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> 
     250</tr> 
     251<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
    134252</tr> 
    135253</tbody> 
     
    145263<dl class="method"> 
    146264<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.getParam"> 
    147 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.getParam" title="Permalink to this definition">¶</a></dt> 
     265<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.getParam" title="Permalink to this definition">¶</a></dt> 
    148266<dd><p>Set the value of a model parameter</p> 
    149267<table class="docutils field-list" frame="void" rules="none"> 
     
    151269<col class="field-body" /> 
    152270<tbody valign="top"> 
    153 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     271<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    154272</tr> 
    155273</tbody> 
     
    165283<dl class="method"> 
    166284<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.getParamListWithToken"> 
    167 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     285<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    168286<dd></dd></dl> 
    169287 
    170288<dl class="method"> 
    171289<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.getParamWithToken"> 
    172 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     290<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    173291<dd></dd></dl> 
    174292 
    175293<dl class="method"> 
    176294<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.is_fittable"> 
    177 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
     295<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
    178296<dd><p>Check if a given parameter is fittable or not</p> 
    179297<table class="docutils field-list" frame="void" rules="none"> 
     
    181299<col class="field-body" /> 
    182300<tbody valign="top"> 
    183 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     301<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> 
    184302</tr> 
    185303</tbody> 
     
    199317</dd></dl> 
    200318 
    201 <dl class="attribute"> 
     319<dl class="method"> 
    202320<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.reset"> 
    203 <tt class="descname">reset</tt><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.reset" title="Permalink to this definition">¶</a></dt> 
     321<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.reset" title="Permalink to this definition">¶</a></dt> 
    204322<dd><p>Reset pair correlation</p> 
    205323</dd></dl> 
     
    207325<dl class="method"> 
    208326<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.run"> 
    209 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.run" title="Permalink to this definition">¶</a></dt> 
     327<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.run" title="Permalink to this definition">¶</a></dt> 
    210328<dd><p>Evaluate the model</p> 
    211329<table class="docutils field-list" frame="void" rules="none"> 
     
    213331<col class="field-body" /> 
    214332<tbody valign="top"> 
    215 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td> 
    216 </tr> 
    217 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     333<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> 
     334</tr> 
     335<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    218336</tr> 
    219337</tbody> 
     
    223341<dl class="method"> 
    224342<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.runXY"> 
    225 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.runXY" title="Permalink to this definition">¶</a></dt> 
     343<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.runXY" title="Permalink to this definition">¶</a></dt> 
    226344<dd><p>Evaluate the model in cartesian coordinates</p> 
    227345<table class="docutils field-list" frame="void" rules="none"> 
     
    229347<col class="field-body" /> 
    230348<tbody valign="top"> 
    231 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td> 
    232 </tr> 
    233 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     349<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> 
     350</tr> 
     351<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    234352</tr> 
    235353</tbody> 
     
    239357<dl class="method"> 
    240358<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.setParam"> 
    241 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.setParam" title="Permalink to this definition">¶</a></dt> 
     359<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.setParam" title="Permalink to this definition">¶</a></dt> 
    242360<dd><p>Set the value of a model parameter</p> 
    243361<table class="docutils field-list" frame="void" rules="none"> 
     
    245363<col class="field-body" /> 
    246364<tbody valign="top"> 
    247 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     365<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    248366<li><strong>name</strong> &#8211; name of the parameter</li> 
    249367<li><strong>value</strong> &#8211; value of the parameter</li> 
     
    257375<dl class="method"> 
    258376<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.setParamWithToken"> 
    259 <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.CSParallelepipedModel.CSParallelepipedModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     377<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    260378<dd></dd></dl> 
    261379 
    262380<dl class="method"> 
    263381<dt id="sans.models.CSParallelepipedModel.CSParallelepipedModel.set_dispersion"> 
    264 <tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
     382<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CSParallelepipedModel.CSParallelepipedModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
    265383<dd><p>Set the dispersion object for a model parameter</p> 
    266384<table class="docutils field-list" frame="void" rules="none"> 
     
    268386<col class="field-body" /> 
    269387<tbody valign="top"> 
    270 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     388<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    271389<li><strong>parameter</strong> &#8211; name of the parameter [string]</li> 
    272390<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li> 
     
    297415  <ul> 
    298416<li><a class="reference internal" href="#">CSParallelepipedModel</a><ul> 
    299 <li><a class="reference internal" href="#module-sans.models.CSParallelepipedModel"><tt class="docutils literal"><span class="pre">sans.models.CSParallelepipedModel</span></tt></a></li> 
     417<li><a class="reference internal" href="#sans-models-csparallelepipedmodel"><tt class="docutils literal"><span class="pre">sans.models.CSParallelepipedModel</span></tt></a></li> 
    300418</ul> 
    301419</li> 
     
    316434  <h3>Quick search</h3> 
    317435    <form class="search" action="../search.html" method="get"> 
    318       <input type="text" name="q" size="18" /> 
     436      <input type="text" name="q" /> 
    319437      <input type="submit" value="Go" /> 
    320438      <input type="hidden" name="check_keywords" value="yes" /> 
     
    345463          <a href="Cos.html" title="Cos" 
    346464             >previous</a> |</li> 
    347         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     465        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    348466          <li><a href="index.html" >Reference</a> &raquo;</li>  
    349467      </ul> 
     
    351469    <div class="footer"> 
    352470        &copy; Copyright 2010, sans group. 
    353       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     471      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    354472    </div> 
    355473  </body> 
Note: See TracChangeset for help on using the changeset viewer.