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/HardsphereStructure.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>HardsphereStructure &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>HardsphereStructure &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="HayterMSAStructure" href="HayterMSAStructure.html" /> 
    … …  
    4447          <a href="GuinierPorodModel.html" title="GuinierPorodModel" 
    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="hardspherestructure"> 
    5760<h1>HardsphereStructure<a class="headerlink" href="#hardspherestructure" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.HardsphereStructure"> 
    59 <span id="sans-models-hardspherestructure"></span><h2><a class="reference internal" href="#module-sans.models.HardsphereStructure" title="sans.models.HardsphereStructure"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.HardsphereStructure</span></tt></a><a class="headerlink" href="#module-sans.models.HardsphereStructure" 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-hardspherestructure"> 
     62<h2><a class="reference internal" href="#module-sans.models.HardsphereStructure" title="sans.models.HardsphereStructure"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.HardsphereStructure</span></tt></a><a class="headerlink" href="#sans-models-hardspherestructure" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.HardsphereStructure"></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_extensionsHardsphere.h 
    6770AND RE-RUN THE GENERATOR SCRIPT</td> 
    … …  
    8285volfraction     = 0.2</div></blockquote> 
    8386<dl class="method"> 
     87<dt id="sans.models.HardsphereStructure.HardsphereStructure.__add__"> 
     88<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.__add__" title="Permalink to this definition">¶</a></dt> 
     89<dd></dd></dl> 
     90 
     91<dl class="attribute"> 
     92<dt id="sans.models.HardsphereStructure.HardsphereStructure.__class__"> 
     93<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.__class__" title="Permalink to this definition">¶</a></dt> 
     94<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     95</dd></dl> 
     96 
     97<dl class="attribute"> 
     98<dt id="sans.models.HardsphereStructure.HardsphereStructure.__delattr__"> 
     99<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.__delattr__" title="Permalink to this definition">¶</a></dt> 
     100<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     101</dd></dl> 
     102 
     103<dl class="attribute"> 
     104<dt id="sans.models.HardsphereStructure.HardsphereStructure.__dict__"> 
     105<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01B5F210&gt;</em><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.__dict__" title="Permalink to this definition">¶</a></dt> 
     106<dd></dd></dl> 
     107 
     108<dl class="method"> 
     109<dt id="sans.models.HardsphereStructure.HardsphereStructure.__div__"> 
     110<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.__div__" title="Permalink to this definition">¶</a></dt> 
     111<dd></dd></dl> 
     112 
     113<dl class="attribute"> 
     114<dt id="sans.models.HardsphereStructure.HardsphereStructure.__getattribute__"> 
     115<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     116<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     117</dd></dl> 
     118 
     119<dl class="attribute"> 
     120<dt id="sans.models.HardsphereStructure.HardsphereStructure.__hash__"> 
     121<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.__hash__" title="Permalink to this definition">¶</a></dt> 
     122<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     123</dd></dl> 
     124 
     125<dl class="method"> 
     126<dt id="sans.models.HardsphereStructure.HardsphereStructure.__init__"> 
     127<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.__init__" title="Permalink to this definition">¶</a></dt> 
     128<dd><p>Initialization</p> 
     129</dd></dl> 
     130 
     131<dl class="attribute"> 
     132<dt id="sans.models.HardsphereStructure.HardsphereStructure.__module__"> 
     133<tt class="descname">__module__</tt><em class="property"> = 'sans.models.HardsphereStructure'</em><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.__module__" title="Permalink to this definition">¶</a></dt> 
     134<dd></dd></dl> 
     135 
     136<dl class="method"> 
     137<dt id="sans.models.HardsphereStructure.HardsphereStructure.__mul__"> 
     138<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.__mul__" title="Permalink to this definition">¶</a></dt> 
     139<dd></dd></dl> 
     140 
     141<dl class="staticmethod"> 
     142<dt id="sans.models.HardsphereStructure.HardsphereStructure.__new__"> 
     143<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.HardsphereStructure.HardsphereStructure.__new__" title="Permalink to this definition">¶</a></dt> 
     144<dd></dd></dl> 
     145 
     146<dl class="method"> 
     147<dt id="sans.models.HardsphereStructure.HardsphereStructure.__reduce__"> 
     148<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.__reduce__" title="Permalink to this definition">¶</a></dt> 
     149<dd><p>helper for pickle</p> 
     150</dd></dl> 
     151 
     152<dl class="method"> 
     153<dt id="sans.models.HardsphereStructure.HardsphereStructure.__reduce_ex__"> 
     154<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     155<dd><p>Overwrite the __reduce_ex__ of PyTypeObject <a href="#id1"><span class="problematic" id="id2">*</span></a>type call in the init of  
     156c model.</p> 
     157</dd></dl> 
     158 
     159<dl class="attribute"> 
     160<dt id="sans.models.HardsphereStructure.HardsphereStructure.__repr__"> 
     161<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.__repr__" title="Permalink to this definition">¶</a></dt> 
     162<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     163</dd></dl> 
     164 
     165<dl class="attribute"> 
     166<dt id="sans.models.HardsphereStructure.HardsphereStructure.__setattr__"> 
     167<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.__setattr__" title="Permalink to this definition">¶</a></dt> 
     168<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     169</dd></dl> 
     170 
     171<dl class="method"> 
     172<dt id="sans.models.HardsphereStructure.HardsphereStructure.__setstate__"> 
     173<tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.__setstate__" title="Permalink to this definition">¶</a></dt> 
     174<dd><p>restore the state of a model from pickle</p> 
     175</dd></dl> 
     176 
     177<dl class="attribute"> 
     178<dt id="sans.models.HardsphereStructure.HardsphereStructure.__str__"> 
     179<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.__str__" title="Permalink to this definition">¶</a></dt> 
     180<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     181</dd></dl> 
     182 
     183<dl class="method"> 
     184<dt id="sans.models.HardsphereStructure.HardsphereStructure.__sub__"> 
     185<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.__sub__" title="Permalink to this definition">¶</a></dt> 
     186<dd></dd></dl> 
     187 
     188<dl class="attribute"> 
     189<dt id="sans.models.HardsphereStructure.HardsphereStructure.__weakref__"> 
     190<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.__weakref__" title="Permalink to this definition">¶</a></dt> 
     191<dd><p>list of weak references to the object (if defined)</p> 
     192</dd></dl> 
     193 
     194<dl class="method"> 
     195<dt id="sans.models.HardsphereStructure.HardsphereStructure._clone"> 
     196<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure._clone" title="Permalink to this definition">¶</a></dt> 
     197<dd><p>Internal utility function to copy the internal 
     198data members to a fresh copy.</p> 
     199</dd></dl> 
     200 
     201<dl class="method"> 
    84202<dt id="sans.models.HardsphereStructure.HardsphereStructure.calculate_ER"> 
    85203<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.calculate_ER" title="Permalink to this definition">¶</a></dt> 
    … …  
    89207<col class="field-body" /> 
    90208<tbody valign="top"> 
    91 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
     209<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
    92210</tr> 
    93211</tbody> 
    … …  
    109227<dl class="method"> 
    110228<dt id="sans.models.HardsphereStructure.HardsphereStructure.evalDistribution"> 
    111 <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.HardsphereStructure.HardsphereStructure.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     229<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    112230<dd><p>Evaluate the model in cartesian coordinates</p> 
    113231<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    115233<col class="field-body" /> 
    116234<tbody valign="top"> 
    117 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td> 
    118 </tr> 
    119 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
     235<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> 
     236</tr> 
     237<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
    120238</tr> 
    121239</tbody> 
    … …  
    131249<dl class="method"> 
    132250<dt id="sans.models.HardsphereStructure.HardsphereStructure.getParam"> 
    133 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.getParam" title="Permalink to this definition">¶</a></dt> 
     251<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.getParam" title="Permalink to this definition">¶</a></dt> 
    134252<dd><p>Set the value of a model parameter</p> 
    135253<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    137255<col class="field-body" /> 
    138256<tbody valign="top"> 
    139 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     257<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    140258</tr> 
    141259</tbody> 
    … …  
    151269<dl class="method"> 
    152270<dt id="sans.models.HardsphereStructure.HardsphereStructure.getParamListWithToken"> 
    153 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     271<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    154272<dd></dd></dl> 
    155273 
    156274<dl class="method"> 
    157275<dt id="sans.models.HardsphereStructure.HardsphereStructure.getParamWithToken"> 
    158 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     276<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    159277<dd></dd></dl> 
    160278 
    161279<dl class="method"> 
    162280<dt id="sans.models.HardsphereStructure.HardsphereStructure.is_fittable"> 
    163 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.is_fittable" title="Permalink to this definition">¶</a></dt> 
     281<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.is_fittable" title="Permalink to this definition">¶</a></dt> 
    164282<dd><p>Check if a given parameter is fittable or not</p> 
    165283<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    167285<col class="field-body" /> 
    168286<tbody valign="top"> 
    169 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     287<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> 
    170288</tr> 
    171289</tbody> 
    … …  
    185303</dd></dl> 
    186304 
    187 <dl class="attribute"> 
     305<dl class="method"> 
    188306<dt id="sans.models.HardsphereStructure.HardsphereStructure.reset"> 
    189 <tt class="descname">reset</tt><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.reset" title="Permalink to this definition">¶</a></dt> 
     307<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.reset" title="Permalink to this definition">¶</a></dt> 
    190308<dd><p>Reset pair correlation</p> 
    191309</dd></dl> 
    … …  
    193311<dl class="method"> 
    194312<dt id="sans.models.HardsphereStructure.HardsphereStructure.run"> 
    195 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.run" title="Permalink to this definition">¶</a></dt> 
     313<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.run" title="Permalink to this definition">¶</a></dt> 
    196314<dd><p>Evaluate the model</p> 
    197315<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    199317<col class="field-body" /> 
    200318<tbody valign="top"> 
    201 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td> 
    202 </tr> 
    203 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     319<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> 
     320</tr> 
     321<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    204322</tr> 
    205323</tbody> 
    … …  
    209327<dl class="method"> 
    210328<dt id="sans.models.HardsphereStructure.HardsphereStructure.runXY"> 
    211 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.runXY" title="Permalink to this definition">¶</a></dt> 
     329<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.runXY" title="Permalink to this definition">¶</a></dt> 
    212330<dd><p>Evaluate the model in cartesian coordinates</p> 
    213331<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    215333<col class="field-body" /> 
    216334<tbody valign="top"> 
    217 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td> 
    218 </tr> 
    219 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     335<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> 
     336</tr> 
     337<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    220338</tr> 
    221339</tbody> 
    … …  
    225343<dl class="method"> 
    226344<dt id="sans.models.HardsphereStructure.HardsphereStructure.setParam"> 
    227 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.setParam" title="Permalink to this definition">¶</a></dt> 
     345<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.setParam" title="Permalink to this definition">¶</a></dt> 
    228346<dd><p>Set the value of a model parameter</p> 
    229347<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    231349<col class="field-body" /> 
    232350<tbody valign="top"> 
    233 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     351<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    234352<li><strong>name</strong> &#8211; name of the parameter</li> 
    235353<li><strong>value</strong> &#8211; value of the parameter</li> 
    … …  
    243361<dl class="method"> 
    244362<dt id="sans.models.HardsphereStructure.HardsphereStructure.setParamWithToken"> 
    245 <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.HardsphereStructure.HardsphereStructure.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     363<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    246364<dd></dd></dl> 
    247365 
    248366<dl class="method"> 
    249367<dt id="sans.models.HardsphereStructure.HardsphereStructure.set_dispersion"> 
    250 <tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.set_dispersion" title="Permalink to this definition">¶</a></dt> 
     368<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HardsphereStructure.HardsphereStructure.set_dispersion" title="Permalink to this definition">¶</a></dt> 
    251369<dd><p>Set the dispersion object for a model parameter</p> 
    252370<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    254372<col class="field-body" /> 
    255373<tbody valign="top"> 
    256 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     374<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    257375<li><strong>parameter</strong> &#8211; name of the parameter [string]</li> 
    258376<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li> 
    … …  
    283401  <ul> 
    284402<li><a class="reference internal" href="#">HardsphereStructure</a><ul> 
    285 <li><a class="reference internal" href="#module-sans.models.HardsphereStructure"><tt class="docutils literal"><span class="pre">sans.models.HardsphereStructure</span></tt></a></li> 
     403<li><a class="reference internal" href="#sans-models-hardspherestructure"><tt class="docutils literal"><span class="pre">sans.models.HardsphereStructure</span></tt></a></li> 
    286404</ul> 
    287405</li> 
    … …  
    302420  <h3>Quick search</h3> 
    303421    <form class="search" action="../search.html" method="get"> 
    304       <input type="text" name="q" size="18" /> 
     422      <input type="text" name="q" /> 
    305423      <input type="submit" value="Go" /> 
    306424      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    331449          <a href="GuinierPorodModel.html" title="GuinierPorodModel" 
    332450             >previous</a> |</li> 
    333         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     451        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    334452          <li><a href="index.html" >Reference</a> &raquo;</li>  
    335453      </ul> 
    … …  
    337455    <div class="footer"> 
    338456        &copy; Copyright 2010, sans group. 
    339       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     457      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    340458    </div> 
    341459  </body> 
Note: See TracChangeset for help on using the changeset viewer.