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/SCCrystalModel.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>SCCrystalModel &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>SCCrystalModel &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="Schulz" href="Schulz.html" /> 
    … …  
    4447          <a href="RPAModel.html" title="RPAModel" 
    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="sccrystalmodel"> 
    5760<h1>SCCrystalModel<a class="headerlink" href="#sccrystalmodel" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.SCCrystalModel"> 
    59 <span id="sans-models-sccrystalmodel"></span><h2><a class="reference internal" href="#module-sans.models.SCCrystalModel" title="sans.models.SCCrystalModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.SCCrystalModel</span></tt></a><a class="headerlink" href="#module-sans.models.SCCrystalModel" 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-sccrystalmodel"> 
     62<h2><a class="reference internal" href="#module-sans.models.SCCrystalModel" title="sans.models.SCCrystalModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.SCCrystalModel</span></tt></a><a class="headerlink" href="#sans-models-sccrystalmodel" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.SCCrystalModel"></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_extensionssc.h 
    6770AND RE-RUN THE GENERATOR SCRIPT</td> 
    … …  
    9093psi             = 0.0 [deg]</div></blockquote> 
    9194<dl class="method"> 
     95<dt id="sans.models.SCCrystalModel.SCCrystalModel.__add__"> 
     96<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.__add__" title="Permalink to this definition">¶</a></dt> 
     97<dd></dd></dl> 
     98 
     99<dl class="attribute"> 
     100<dt id="sans.models.SCCrystalModel.SCCrystalModel.__class__"> 
     101<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.__class__" title="Permalink to this definition">¶</a></dt> 
     102<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     103</dd></dl> 
     104 
     105<dl class="attribute"> 
     106<dt id="sans.models.SCCrystalModel.SCCrystalModel.__delattr__"> 
     107<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.__delattr__" title="Permalink to this definition">¶</a></dt> 
     108<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     109</dd></dl> 
     110 
     111<dl class="attribute"> 
     112<dt id="sans.models.SCCrystalModel.SCCrystalModel.__dict__"> 
     113<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x03049FF0&gt;</em><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.__dict__" title="Permalink to this definition">¶</a></dt> 
     114<dd></dd></dl> 
     115 
     116<dl class="method"> 
     117<dt id="sans.models.SCCrystalModel.SCCrystalModel.__div__"> 
     118<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.__div__" title="Permalink to this definition">¶</a></dt> 
     119<dd></dd></dl> 
     120 
     121<dl class="attribute"> 
     122<dt id="sans.models.SCCrystalModel.SCCrystalModel.__getattribute__"> 
     123<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     124<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     125</dd></dl> 
     126 
     127<dl class="attribute"> 
     128<dt id="sans.models.SCCrystalModel.SCCrystalModel.__hash__"> 
     129<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.__hash__" title="Permalink to this definition">¶</a></dt> 
     130<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     131</dd></dl> 
     132 
     133<dl class="method"> 
     134<dt id="sans.models.SCCrystalModel.SCCrystalModel.__init__"> 
     135<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.__init__" title="Permalink to this definition">¶</a></dt> 
     136<dd><p>Initialization</p> 
     137</dd></dl> 
     138 
     139<dl class="attribute"> 
     140<dt id="sans.models.SCCrystalModel.SCCrystalModel.__module__"> 
     141<tt class="descname">__module__</tt><em class="property"> = 'sans.models.SCCrystalModel'</em><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.__module__" title="Permalink to this definition">¶</a></dt> 
     142<dd></dd></dl> 
     143 
     144<dl class="method"> 
     145<dt id="sans.models.SCCrystalModel.SCCrystalModel.__mul__"> 
     146<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.__mul__" title="Permalink to this definition">¶</a></dt> 
     147<dd></dd></dl> 
     148 
     149<dl class="staticmethod"> 
     150<dt id="sans.models.SCCrystalModel.SCCrystalModel.__new__"> 
     151<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.SCCrystalModel.SCCrystalModel.__new__" title="Permalink to this definition">¶</a></dt> 
     152<dd></dd></dl> 
     153 
     154<dl class="method"> 
     155<dt id="sans.models.SCCrystalModel.SCCrystalModel.__reduce__"> 
     156<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.__reduce__" title="Permalink to this definition">¶</a></dt> 
     157<dd><p>helper for pickle</p> 
     158</dd></dl> 
     159 
     160<dl class="method"> 
     161<dt id="sans.models.SCCrystalModel.SCCrystalModel.__reduce_ex__"> 
     162<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     163<dd><p>Overwrite the __reduce_ex__ of PyTypeObject <a href="#id1"><span class="problematic" id="id2">*</span></a>type call in the init of  
     164c model.</p> 
     165</dd></dl> 
     166 
     167<dl class="attribute"> 
     168<dt id="sans.models.SCCrystalModel.SCCrystalModel.__repr__"> 
     169<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.__repr__" title="Permalink to this definition">¶</a></dt> 
     170<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     171</dd></dl> 
     172 
     173<dl class="attribute"> 
     174<dt id="sans.models.SCCrystalModel.SCCrystalModel.__setattr__"> 
     175<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.__setattr__" title="Permalink to this definition">¶</a></dt> 
     176<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     177</dd></dl> 
     178 
     179<dl class="method"> 
     180<dt id="sans.models.SCCrystalModel.SCCrystalModel.__setstate__"> 
     181<tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.__setstate__" title="Permalink to this definition">¶</a></dt> 
     182<dd><p>restore the state of a model from pickle</p> 
     183</dd></dl> 
     184 
     185<dl class="attribute"> 
     186<dt id="sans.models.SCCrystalModel.SCCrystalModel.__str__"> 
     187<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.__str__" title="Permalink to this definition">¶</a></dt> 
     188<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     189</dd></dl> 
     190 
     191<dl class="method"> 
     192<dt id="sans.models.SCCrystalModel.SCCrystalModel.__sub__"> 
     193<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.__sub__" title="Permalink to this definition">¶</a></dt> 
     194<dd></dd></dl> 
     195 
     196<dl class="attribute"> 
     197<dt id="sans.models.SCCrystalModel.SCCrystalModel.__weakref__"> 
     198<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.__weakref__" title="Permalink to this definition">¶</a></dt> 
     199<dd><p>list of weak references to the object (if defined)</p> 
     200</dd></dl> 
     201 
     202<dl class="method"> 
     203<dt id="sans.models.SCCrystalModel.SCCrystalModel._clone"> 
     204<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel._clone" title="Permalink to this definition">¶</a></dt> 
     205<dd><p>Internal utility function to copy the internal 
     206data members to a fresh copy.</p> 
     207</dd></dl> 
     208 
     209<dl class="method"> 
    92210<dt id="sans.models.SCCrystalModel.SCCrystalModel.calculate_ER"> 
    93211<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.calculate_ER" title="Permalink to this definition">¶</a></dt> 
    … …  
    97215<col class="field-body" /> 
    98216<tbody valign="top"> 
    99 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
     217<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
    100218</tr> 
    101219</tbody> 
    … …  
    117235<dl class="method"> 
    118236<dt id="sans.models.SCCrystalModel.SCCrystalModel.evalDistribution"> 
    119 <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.SCCrystalModel.SCCrystalModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     237<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    120238<dd><p>Evaluate the model in cartesian coordinates</p> 
    121239<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    123241<col class="field-body" /> 
    124242<tbody valign="top"> 
    125 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td> 
    126 </tr> 
    127 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
     243<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> 
     244</tr> 
     245<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
    128246</tr> 
    129247</tbody> 
    … …  
    139257<dl class="method"> 
    140258<dt id="sans.models.SCCrystalModel.SCCrystalModel.getParam"> 
    141 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.getParam" title="Permalink to this definition">¶</a></dt> 
     259<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.getParam" title="Permalink to this definition">¶</a></dt> 
    142260<dd><p>Set the value of a model parameter</p> 
    143261<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    145263<col class="field-body" /> 
    146264<tbody valign="top"> 
    147 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     265<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    148266</tr> 
    149267</tbody> 
    … …  
    159277<dl class="method"> 
    160278<dt id="sans.models.SCCrystalModel.SCCrystalModel.getParamListWithToken"> 
    161 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     279<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    162280<dd></dd></dl> 
    163281 
    164282<dl class="method"> 
    165283<dt id="sans.models.SCCrystalModel.SCCrystalModel.getParamWithToken"> 
    166 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     284<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    167285<dd></dd></dl> 
    168286 
    169287<dl class="method"> 
    170288<dt id="sans.models.SCCrystalModel.SCCrystalModel.is_fittable"> 
    171 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
     289<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
    172290<dd><p>Check if a given parameter is fittable or not</p> 
    173291<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    175293<col class="field-body" /> 
    176294<tbody valign="top"> 
    177 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     295<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> 
    178296</tr> 
    179297</tbody> 
    … …  
    193311</dd></dl> 
    194312 
    195 <dl class="attribute"> 
     313<dl class="method"> 
    196314<dt id="sans.models.SCCrystalModel.SCCrystalModel.reset"> 
    197 <tt class="descname">reset</tt><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.reset" title="Permalink to this definition">¶</a></dt> 
     315<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.reset" title="Permalink to this definition">¶</a></dt> 
    198316<dd><p>Reset pair correlation</p> 
    199317</dd></dl> 
    … …  
    201319<dl class="method"> 
    202320<dt id="sans.models.SCCrystalModel.SCCrystalModel.run"> 
    203 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.run" title="Permalink to this definition">¶</a></dt> 
     321<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.run" title="Permalink to this definition">¶</a></dt> 
    204322<dd><p>Evaluate the model</p> 
    205323<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    207325<col class="field-body" /> 
    208326<tbody valign="top"> 
    209 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td> 
    210 </tr> 
    211 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     327<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> 
     328</tr> 
     329<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    212330</tr> 
    213331</tbody> 
    … …  
    217335<dl class="method"> 
    218336<dt id="sans.models.SCCrystalModel.SCCrystalModel.runXY"> 
    219 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.runXY" title="Permalink to this definition">¶</a></dt> 
     337<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.runXY" title="Permalink to this definition">¶</a></dt> 
    220338<dd><p>Evaluate the model in cartesian coordinates</p> 
    221339<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    223341<col class="field-body" /> 
    224342<tbody valign="top"> 
    225 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td> 
    226 </tr> 
    227 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     343<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> 
     344</tr> 
     345<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    228346</tr> 
    229347</tbody> 
    … …  
    233351<dl class="method"> 
    234352<dt id="sans.models.SCCrystalModel.SCCrystalModel.setParam"> 
    235 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.setParam" title="Permalink to this definition">¶</a></dt> 
     353<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.setParam" title="Permalink to this definition">¶</a></dt> 
    236354<dd><p>Set the value of a model parameter</p> 
    237355<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    239357<col class="field-body" /> 
    240358<tbody valign="top"> 
    241 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     359<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    242360<li><strong>name</strong> &#8211; name of the parameter</li> 
    243361<li><strong>value</strong> &#8211; value of the parameter</li> 
    … …  
    251369<dl class="method"> 
    252370<dt id="sans.models.SCCrystalModel.SCCrystalModel.setParamWithToken"> 
    253 <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.SCCrystalModel.SCCrystalModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     371<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    254372<dd></dd></dl> 
    255373 
    256374<dl class="method"> 
    257375<dt id="sans.models.SCCrystalModel.SCCrystalModel.set_dispersion"> 
    258 <tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
     376<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SCCrystalModel.SCCrystalModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
    259377<dd><p>Set the dispersion object for a model parameter</p> 
    260378<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    262380<col class="field-body" /> 
    263381<tbody valign="top"> 
    264 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     382<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    265383<li><strong>parameter</strong> &#8211; name of the parameter [string]</li> 
    266384<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li> 
    … …  
    291409  <ul> 
    292410<li><a class="reference internal" href="#">SCCrystalModel</a><ul> 
    293 <li><a class="reference internal" href="#module-sans.models.SCCrystalModel"><tt class="docutils literal"><span class="pre">sans.models.SCCrystalModel</span></tt></a></li> 
     411<li><a class="reference internal" href="#sans-models-sccrystalmodel"><tt class="docutils literal"><span class="pre">sans.models.SCCrystalModel</span></tt></a></li> 
    294412</ul> 
    295413</li> 
    … …  
    310428  <h3>Quick search</h3> 
    311429    <form class="search" action="../search.html" method="get"> 
    312       <input type="text" name="q" size="18" /> 
     430      <input type="text" name="q" /> 
    313431      <input type="submit" value="Go" /> 
    314432      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    339457          <a href="RPAModel.html" title="RPAModel" 
    340458             >previous</a> |</li> 
    341         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     459        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    342460          <li><a href="index.html" >Reference</a> &raquo;</li>  
    343461      </ul> 
    … …  
    345463    <div class="footer"> 
    346464        &copy; Copyright 2010, sans group. 
    347       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     465      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    348466    </div> 
    349467  </body> 
Note: See TracChangeset for help on using the changeset viewer.