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/Lorentzian.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>Lorentzian &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>Lorentzian &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="LorentzModel" href="LorentzModel.html" /> 
    … …  
    4447          <a href="LogNormal.html" title="LogNormal" 
    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="lorentzian"> 
    5760<h1>Lorentzian<a class="headerlink" href="#lorentzian" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.Lorentzian"> 
    59 <span id="sans-models-lorentzian"></span><h2><a class="reference internal" href="#module-sans.models.Lorentzian" title="sans.models.Lorentzian"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.Lorentzian</span></tt></a><a class="headerlink" href="#module-sans.models.Lorentzian" 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-lorentzian"> 
     62<h2><a class="reference internal" href="#module-sans.models.Lorentzian" title="sans.models.Lorentzian"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.Lorentzian</span></tt></a><a class="headerlink" href="#sans-models-lorentzian" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.Lorentzian"></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_extensionslorentzian.h 
    6770AND RE-RUN THE GENERATOR SCRIPT</td> 
    … …  
    8386center          = 0.0</div></blockquote> 
    8487<dl class="method"> 
     88<dt id="sans.models.Lorentzian.Lorentzian.__add__"> 
     89<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.__add__" title="Permalink to this definition">¶</a></dt> 
     90<dd></dd></dl> 
     91 
     92<dl class="attribute"> 
     93<dt id="sans.models.Lorentzian.Lorentzian.__class__"> 
     94<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.__class__" title="Permalink to this definition">¶</a></dt> 
     95<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     96</dd></dl> 
     97 
     98<dl class="attribute"> 
     99<dt id="sans.models.Lorentzian.Lorentzian.__delattr__"> 
     100<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.__delattr__" title="Permalink to this definition">¶</a></dt> 
     101<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     102</dd></dl> 
     103 
     104<dl class="attribute"> 
     105<dt id="sans.models.Lorentzian.Lorentzian.__dict__"> 
     106<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01E031F0&gt;</em><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.__dict__" title="Permalink to this definition">¶</a></dt> 
     107<dd></dd></dl> 
     108 
     109<dl class="method"> 
     110<dt id="sans.models.Lorentzian.Lorentzian.__div__"> 
     111<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.__div__" title="Permalink to this definition">¶</a></dt> 
     112<dd></dd></dl> 
     113 
     114<dl class="attribute"> 
     115<dt id="sans.models.Lorentzian.Lorentzian.__getattribute__"> 
     116<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     117<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     118</dd></dl> 
     119 
     120<dl class="attribute"> 
     121<dt id="sans.models.Lorentzian.Lorentzian.__hash__"> 
     122<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.__hash__" title="Permalink to this definition">¶</a></dt> 
     123<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     124</dd></dl> 
     125 
     126<dl class="method"> 
     127<dt id="sans.models.Lorentzian.Lorentzian.__init__"> 
     128<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.__init__" title="Permalink to this definition">¶</a></dt> 
     129<dd><p>Initialization</p> 
     130</dd></dl> 
     131 
     132<dl class="attribute"> 
     133<dt id="sans.models.Lorentzian.Lorentzian.__module__"> 
     134<tt class="descname">__module__</tt><em class="property"> = 'sans.models.Lorentzian'</em><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.__module__" title="Permalink to this definition">¶</a></dt> 
     135<dd></dd></dl> 
     136 
     137<dl class="method"> 
     138<dt id="sans.models.Lorentzian.Lorentzian.__mul__"> 
     139<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.__mul__" title="Permalink to this definition">¶</a></dt> 
     140<dd></dd></dl> 
     141 
     142<dl class="staticmethod"> 
     143<dt id="sans.models.Lorentzian.Lorentzian.__new__"> 
     144<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.Lorentzian.Lorentzian.__new__" title="Permalink to this definition">¶</a></dt> 
     145<dd></dd></dl> 
     146 
     147<dl class="method"> 
     148<dt id="sans.models.Lorentzian.Lorentzian.__reduce__"> 
     149<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.__reduce__" title="Permalink to this definition">¶</a></dt> 
     150<dd><p>helper for pickle</p> 
     151</dd></dl> 
     152 
     153<dl class="method"> 
     154<dt id="sans.models.Lorentzian.Lorentzian.__reduce_ex__"> 
     155<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     156<dd><p>Overwrite the __reduce_ex__ of PyTypeObject <a href="#id1"><span class="problematic" id="id2">*</span></a>type call in the init of  
     157c model.</p> 
     158</dd></dl> 
     159 
     160<dl class="attribute"> 
     161<dt id="sans.models.Lorentzian.Lorentzian.__repr__"> 
     162<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.__repr__" title="Permalink to this definition">¶</a></dt> 
     163<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     164</dd></dl> 
     165 
     166<dl class="attribute"> 
     167<dt id="sans.models.Lorentzian.Lorentzian.__setattr__"> 
     168<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.__setattr__" title="Permalink to this definition">¶</a></dt> 
     169<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     170</dd></dl> 
     171 
     172<dl class="method"> 
     173<dt id="sans.models.Lorentzian.Lorentzian.__setstate__"> 
     174<tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.__setstate__" title="Permalink to this definition">¶</a></dt> 
     175<dd><p>restore the state of a model from pickle</p> 
     176</dd></dl> 
     177 
     178<dl class="attribute"> 
     179<dt id="sans.models.Lorentzian.Lorentzian.__str__"> 
     180<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.__str__" title="Permalink to this definition">¶</a></dt> 
     181<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     182</dd></dl> 
     183 
     184<dl class="method"> 
     185<dt id="sans.models.Lorentzian.Lorentzian.__sub__"> 
     186<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.__sub__" title="Permalink to this definition">¶</a></dt> 
     187<dd></dd></dl> 
     188 
     189<dl class="attribute"> 
     190<dt id="sans.models.Lorentzian.Lorentzian.__weakref__"> 
     191<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.__weakref__" title="Permalink to this definition">¶</a></dt> 
     192<dd><p>list of weak references to the object (if defined)</p> 
     193</dd></dl> 
     194 
     195<dl class="method"> 
     196<dt id="sans.models.Lorentzian.Lorentzian._clone"> 
     197<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian._clone" title="Permalink to this definition">¶</a></dt> 
     198<dd><p>Internal utility function to copy the internal 
     199data members to a fresh copy.</p> 
     200</dd></dl> 
     201 
     202<dl class="method"> 
    85203<dt id="sans.models.Lorentzian.Lorentzian.calculate_ER"> 
    86204<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.calculate_ER" title="Permalink to this definition">¶</a></dt> 
    … …  
    90208<col class="field-body" /> 
    91209<tbody valign="top"> 
    92 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
     210<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
    93211</tr> 
    94212</tbody> 
    … …  
    104222<dl class="method"> 
    105223<dt id="sans.models.Lorentzian.Lorentzian.evalDistribution"> 
    106 <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.Lorentzian.Lorentzian.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     224<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    107225<dd><p>Evaluate the model in cartesian coordinates</p> 
    108226<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    110228<col class="field-body" /> 
    111229<tbody valign="top"> 
    112 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td> 
    113 </tr> 
    114 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
     230<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> 
     231</tr> 
     232<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
    115233</tr> 
    116234</tbody> 
    … …  
    126244<dl class="method"> 
    127245<dt id="sans.models.Lorentzian.Lorentzian.getParam"> 
    128 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.getParam" title="Permalink to this definition">¶</a></dt> 
     246<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.getParam" title="Permalink to this definition">¶</a></dt> 
    129247<dd><p>Set the value of a model parameter</p> 
    130248<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    132250<col class="field-body" /> 
    133251<tbody valign="top"> 
    134 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     252<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    135253</tr> 
    136254</tbody> 
    … …  
    146264<dl class="method"> 
    147265<dt id="sans.models.Lorentzian.Lorentzian.getParamListWithToken"> 
    148 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     266<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    149267<dd></dd></dl> 
    150268 
    151269<dl class="method"> 
    152270<dt id="sans.models.Lorentzian.Lorentzian.getParamWithToken"> 
    153 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     271<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    154272<dd></dd></dl> 
    155273 
    156274<dl class="method"> 
    157275<dt id="sans.models.Lorentzian.Lorentzian.is_fittable"> 
    158 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.is_fittable" title="Permalink to this definition">¶</a></dt> 
     276<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.is_fittable" title="Permalink to this definition">¶</a></dt> 
    159277<dd><p>Check if a given parameter is fittable or not</p> 
    160278<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    162280<col class="field-body" /> 
    163281<tbody valign="top"> 
    164 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     282<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> 
    165283</tr> 
    166284</tbody> 
    … …  
    180298</dd></dl> 
    181299 
    182 <dl class="attribute"> 
     300<dl class="method"> 
    183301<dt id="sans.models.Lorentzian.Lorentzian.reset"> 
    184 <tt class="descname">reset</tt><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.reset" title="Permalink to this definition">¶</a></dt> 
     302<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.reset" title="Permalink to this definition">¶</a></dt> 
    185303<dd><p>Reset pair correlation</p> 
    186304</dd></dl> 
    … …  
    188306<dl class="method"> 
    189307<dt id="sans.models.Lorentzian.Lorentzian.run"> 
    190 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.run" title="Permalink to this definition">¶</a></dt> 
     308<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.run" title="Permalink to this definition">¶</a></dt> 
    191309<dd><p>Evaluate the model</p> 
    192310<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    194312<col class="field-body" /> 
    195313<tbody valign="top"> 
    196 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td> 
    197 </tr> 
    198 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     314<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> 
     315</tr> 
     316<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    199317</tr> 
    200318</tbody> 
    … …  
    204322<dl class="method"> 
    205323<dt id="sans.models.Lorentzian.Lorentzian.runXY"> 
    206 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.runXY" title="Permalink to this definition">¶</a></dt> 
     324<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.runXY" title="Permalink to this definition">¶</a></dt> 
    207325<dd><p>Evaluate the model in cartesian coordinates</p> 
    208326<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    210328<col class="field-body" /> 
    211329<tbody valign="top"> 
    212 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td> 
    213 </tr> 
    214 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     330<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> 
     331</tr> 
     332<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    215333</tr> 
    216334</tbody> 
    … …  
    220338<dl class="method"> 
    221339<dt id="sans.models.Lorentzian.Lorentzian.setParam"> 
    222 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.setParam" title="Permalink to this definition">¶</a></dt> 
     340<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.setParam" title="Permalink to this definition">¶</a></dt> 
    223341<dd><p>Set the value of a model parameter</p> 
    224342<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    226344<col class="field-body" /> 
    227345<tbody valign="top"> 
    228 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     346<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    229347<li><strong>name</strong> &#8211; name of the parameter</li> 
    230348<li><strong>value</strong> &#8211; value of the parameter</li> 
    … …  
    238356<dl class="method"> 
    239357<dt id="sans.models.Lorentzian.Lorentzian.setParamWithToken"> 
    240 <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.Lorentzian.Lorentzian.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     358<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    241359<dd></dd></dl> 
    242360 
    243361<dl class="method"> 
    244362<dt id="sans.models.Lorentzian.Lorentzian.set_dispersion"> 
    245 <tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.set_dispersion" title="Permalink to this definition">¶</a></dt> 
     363<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.Lorentzian.Lorentzian.set_dispersion" title="Permalink to this definition">¶</a></dt> 
    246364<dd><p>Set the dispersion object for a model parameter</p> 
    247365<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    249367<col class="field-body" /> 
    250368<tbody valign="top"> 
    251 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     369<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    252370<li><strong>parameter</strong> &#8211; name of the parameter [string]</li> 
    253371<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li> 
    … …  
    278396  <ul> 
    279397<li><a class="reference internal" href="#">Lorentzian</a><ul> 
    280 <li><a class="reference internal" href="#module-sans.models.Lorentzian"><tt class="docutils literal"><span class="pre">sans.models.Lorentzian</span></tt></a></li> 
     398<li><a class="reference internal" href="#sans-models-lorentzian"><tt class="docutils literal"><span class="pre">sans.models.Lorentzian</span></tt></a></li> 
    281399</ul> 
    282400</li> 
    … …  
    297415  <h3>Quick search</h3> 
    298416    <form class="search" action="../search.html" method="get"> 
    299       <input type="text" name="q" size="18" /> 
     417      <input type="text" name="q" /> 
    300418      <input type="submit" value="Go" /> 
    301419      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    326444          <a href="LogNormal.html" title="LogNormal" 
    327445             >previous</a> |</li> 
    328         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     446        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    329447          <li><a href="index.html" >Reference</a> &raquo;</li>  
    330448      </ul> 
    … …  
    332450    <div class="footer"> 
    333451        &copy; Copyright 2010, sans group. 
    334       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     452      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    335453    </div> 
    336454  </body> 
Note: See TracChangeset for help on using the changeset viewer.