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/CoreShellEllipsoidModel.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>CoreShellEllipsoidModel &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>CoreShellEllipsoidModel &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="CoreShellModel" href="CoreShellModel.html" /> 
     
    4447          <a href="CoreShellCylinderModel.html" title="CoreShellCylinderModel" 
    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="coreshellellipsoidmodel"> 
    5760<h1>CoreShellEllipsoidModel<a class="headerlink" href="#coreshellellipsoidmodel" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.CoreShellEllipsoidModel"> 
    59 <span id="sans-models-coreshellellipsoidmodel"></span><h2><a class="reference internal" href="#module-sans.models.CoreShellEllipsoidModel" title="sans.models.CoreShellEllipsoidModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.CoreShellEllipsoidModel</span></tt></a><a class="headerlink" href="#module-sans.models.CoreShellEllipsoidModel" 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-coreshellellipsoidmodel"> 
     62<h2><a class="reference internal" href="#module-sans.models.CoreShellEllipsoidModel" title="sans.models.CoreShellEllipsoidModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.CoreShellEllipsoidModel</span></tt></a><a class="headerlink" href="#sans-models-coreshellellipsoidmodel" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.CoreShellEllipsoidModel"></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_extensionsspheroid.h 
    6770AND RE-RUN THE GENERATOR SCRIPT</td> 
     
    9194axis_phi        = 0.0 [deg]</div></blockquote> 
    9295<dl class="method"> 
     96<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__add__"> 
     97<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__add__" title="Permalink to this definition">¶</a></dt> 
     98<dd></dd></dl> 
     99 
     100<dl class="attribute"> 
     101<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__class__"> 
     102<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__class__" title="Permalink to this definition">¶</a></dt> 
     103<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     104</dd></dl> 
     105 
     106<dl class="attribute"> 
     107<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__delattr__"> 
     108<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__delattr__" title="Permalink to this definition">¶</a></dt> 
     109<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     110</dd></dl> 
     111 
     112<dl class="attribute"> 
     113<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__dict__"> 
     114<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01B54330&gt;</em><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__dict__" title="Permalink to this definition">¶</a></dt> 
     115<dd></dd></dl> 
     116 
     117<dl class="method"> 
     118<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__div__"> 
     119<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__div__" title="Permalink to this definition">¶</a></dt> 
     120<dd></dd></dl> 
     121 
     122<dl class="attribute"> 
     123<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__getattribute__"> 
     124<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     125<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     126</dd></dl> 
     127 
     128<dl class="attribute"> 
     129<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__hash__"> 
     130<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__hash__" title="Permalink to this definition">¶</a></dt> 
     131<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     132</dd></dl> 
     133 
     134<dl class="method"> 
     135<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__init__"> 
     136<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__init__" title="Permalink to this definition">¶</a></dt> 
     137<dd><p>Initialization</p> 
     138</dd></dl> 
     139 
     140<dl class="attribute"> 
     141<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__module__"> 
     142<tt class="descname">__module__</tt><em class="property"> = 'sans.models.CoreShellEllipsoidModel'</em><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__module__" title="Permalink to this definition">¶</a></dt> 
     143<dd></dd></dl> 
     144 
     145<dl class="method"> 
     146<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__mul__"> 
     147<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__mul__" title="Permalink to this definition">¶</a></dt> 
     148<dd></dd></dl> 
     149 
     150<dl class="staticmethod"> 
     151<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__new__"> 
     152<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.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__new__" title="Permalink to this definition">¶</a></dt> 
     153<dd></dd></dl> 
     154 
     155<dl class="method"> 
     156<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__reduce__"> 
     157<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__reduce__" title="Permalink to this definition">¶</a></dt> 
     158<dd><p>helper for pickle</p> 
     159</dd></dl> 
     160 
     161<dl class="method"> 
     162<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__reduce_ex__"> 
     163<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     164<dd><p>Overwrite the __reduce_ex__ of PyTypeObject <a href="#id1"><span class="problematic" id="id2">*</span></a>type call in the init of  
     165c model.</p> 
     166</dd></dl> 
     167 
     168<dl class="attribute"> 
     169<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__repr__"> 
     170<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__repr__" title="Permalink to this definition">¶</a></dt> 
     171<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     172</dd></dl> 
     173 
     174<dl class="attribute"> 
     175<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__setattr__"> 
     176<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__setattr__" title="Permalink to this definition">¶</a></dt> 
     177<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     178</dd></dl> 
     179 
     180<dl class="method"> 
     181<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__setstate__"> 
     182<tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__setstate__" title="Permalink to this definition">¶</a></dt> 
     183<dd><p>restore the state of a model from pickle</p> 
     184</dd></dl> 
     185 
     186<dl class="attribute"> 
     187<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__str__"> 
     188<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__str__" title="Permalink to this definition">¶</a></dt> 
     189<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     190</dd></dl> 
     191 
     192<dl class="method"> 
     193<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__sub__"> 
     194<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__sub__" title="Permalink to this definition">¶</a></dt> 
     195<dd></dd></dl> 
     196 
     197<dl class="attribute"> 
     198<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__weakref__"> 
     199<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.__weakref__" title="Permalink to this definition">¶</a></dt> 
     200<dd><p>list of weak references to the object (if defined)</p> 
     201</dd></dl> 
     202 
     203<dl class="method"> 
     204<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel._clone"> 
     205<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel._clone" title="Permalink to this definition">¶</a></dt> 
     206<dd><p>Internal utility function to copy the internal 
     207data members to a fresh copy.</p> 
     208</dd></dl> 
     209 
     210<dl class="method"> 
    93211<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.calculate_ER"> 
    94212<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.calculate_ER" title="Permalink to this definition">¶</a></dt> 
     
    98216<col class="field-body" /> 
    99217<tbody valign="top"> 
    100 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
     218<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
    101219</tr> 
    102220</tbody> 
     
    118236<dl class="method"> 
    119237<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.evalDistribution"> 
    120 <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.CoreShellEllipsoidModel.CoreShellEllipsoidModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     238<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    121239<dd><p>Evaluate the model in cartesian coordinates</p> 
    122240<table class="docutils field-list" frame="void" rules="none"> 
     
    124242<col class="field-body" /> 
    125243<tbody valign="top"> 
    126 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td> 
    127 </tr> 
    128 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
     244<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> 
     245</tr> 
     246<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
    129247</tr> 
    130248</tbody> 
     
    140258<dl class="method"> 
    141259<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.getParam"> 
    142 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.getParam" title="Permalink to this definition">¶</a></dt> 
     260<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.getParam" title="Permalink to this definition">¶</a></dt> 
    143261<dd><p>Set the value of a model parameter</p> 
    144262<table class="docutils field-list" frame="void" rules="none"> 
     
    146264<col class="field-body" /> 
    147265<tbody valign="top"> 
    148 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     266<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    149267</tr> 
    150268</tbody> 
     
    160278<dl class="method"> 
    161279<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.getParamListWithToken"> 
    162 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     280<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    163281<dd></dd></dl> 
    164282 
    165283<dl class="method"> 
    166284<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.getParamWithToken"> 
    167 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     285<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    168286<dd></dd></dl> 
    169287 
    170288<dl class="method"> 
    171289<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.is_fittable"> 
    172 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
     290<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
    173291<dd><p>Check if a given parameter is fittable or not</p> 
    174292<table class="docutils field-list" frame="void" rules="none"> 
     
    176294<col class="field-body" /> 
    177295<tbody valign="top"> 
    178 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     296<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> 
    179297</tr> 
    180298</tbody> 
     
    194312</dd></dl> 
    195313 
    196 <dl class="attribute"> 
     314<dl class="method"> 
    197315<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.reset"> 
    198 <tt class="descname">reset</tt><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.reset" title="Permalink to this definition">¶</a></dt> 
     316<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.reset" title="Permalink to this definition">¶</a></dt> 
    199317<dd><p>Reset pair correlation</p> 
    200318</dd></dl> 
     
    202320<dl class="method"> 
    203321<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.run"> 
    204 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.run" title="Permalink to this definition">¶</a></dt> 
     322<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.run" title="Permalink to this definition">¶</a></dt> 
    205323<dd><p>Evaluate the model</p> 
    206324<table class="docutils field-list" frame="void" rules="none"> 
     
    208326<col class="field-body" /> 
    209327<tbody valign="top"> 
    210 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td> 
    211 </tr> 
    212 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     328<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> 
     329</tr> 
     330<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    213331</tr> 
    214332</tbody> 
     
    218336<dl class="method"> 
    219337<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.runXY"> 
    220 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.runXY" title="Permalink to this definition">¶</a></dt> 
     338<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.runXY" title="Permalink to this definition">¶</a></dt> 
    221339<dd><p>Evaluate the model in cartesian coordinates</p> 
    222340<table class="docutils field-list" frame="void" rules="none"> 
     
    224342<col class="field-body" /> 
    225343<tbody valign="top"> 
    226 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td> 
    227 </tr> 
    228 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     344<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> 
     345</tr> 
     346<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    229347</tr> 
    230348</tbody> 
     
    234352<dl class="method"> 
    235353<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.setParam"> 
    236 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.setParam" title="Permalink to this definition">¶</a></dt> 
     354<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.setParam" title="Permalink to this definition">¶</a></dt> 
    237355<dd><p>Set the value of a model parameter</p> 
    238356<table class="docutils field-list" frame="void" rules="none"> 
     
    240358<col class="field-body" /> 
    241359<tbody valign="top"> 
    242 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     360<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    243361<li><strong>name</strong> &#8211; name of the parameter</li> 
    244362<li><strong>value</strong> &#8211; value of the parameter</li> 
     
    252370<dl class="method"> 
    253371<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.setParamWithToken"> 
    254 <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.CoreShellEllipsoidModel.CoreShellEllipsoidModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     372<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    255373<dd></dd></dl> 
    256374 
    257375<dl class="method"> 
    258376<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.set_dispersion"> 
    259 <tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
     377<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
    260378<dd><p>Set the dispersion object for a model parameter</p> 
    261379<table class="docutils field-list" frame="void" rules="none"> 
     
    263381<col class="field-body" /> 
    264382<tbody valign="top"> 
    265 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     383<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    266384<li><strong>parameter</strong> &#8211; name of the parameter [string]</li> 
    267385<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li> 
     
    292410  <ul> 
    293411<li><a class="reference internal" href="#">CoreShellEllipsoidModel</a><ul> 
    294 <li><a class="reference internal" href="#module-sans.models.CoreShellEllipsoidModel"><tt class="docutils literal"><span class="pre">sans.models.CoreShellEllipsoidModel</span></tt></a></li> 
     412<li><a class="reference internal" href="#sans-models-coreshellellipsoidmodel"><tt class="docutils literal"><span class="pre">sans.models.CoreShellEllipsoidModel</span></tt></a></li> 
    295413</ul> 
    296414</li> 
     
    311429  <h3>Quick search</h3> 
    312430    <form class="search" action="../search.html" method="get"> 
    313       <input type="text" name="q" size="18" /> 
     431      <input type="text" name="q" /> 
    314432      <input type="submit" value="Go" /> 
    315433      <input type="hidden" name="check_keywords" value="yes" /> 
     
    340458          <a href="CoreShellCylinderModel.html" title="CoreShellCylinderModel" 
    341459             >previous</a> |</li> 
    342         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     460        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    343461          <li><a href="index.html" >Reference</a> &raquo;</li>  
    344462      </ul> 
     
    346464    <div class="footer"> 
    347465        &copy; Copyright 2010, sans group. 
    348       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     466      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    349467    </div> 
    350468  </body> 
Note: See TracChangeset for help on using the changeset viewer.