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/CoreShellModel.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>CoreShellModel &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>CoreShellModel &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="CorrLengthModel" href="CorrLengthModel.html" /> 
     
    4447          <a href="CoreShellEllipsoidModel.html" title="CoreShellEllipsoidModel" 
    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="coreshellmodel"> 
    5760<h1>CoreShellModel<a class="headerlink" href="#coreshellmodel" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.CoreShellModel"> 
    59 <span id="sans-models-coreshellmodel"></span><h2><a class="reference internal" href="#module-sans.models.CoreShellModel" title="sans.models.CoreShellModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.CoreShellModel</span></tt></a><a class="headerlink" href="#module-sans.models.CoreShellModel" 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-coreshellmodel"> 
     62<h2><a class="reference internal" href="#module-sans.models.CoreShellModel" title="sans.models.CoreShellModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.CoreShellModel</span></tt></a><a class="headerlink" href="#sans-models-coreshellmodel" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.CoreShellModel"></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_extensionscore_shell.h 
    6770AND RE-RUN THE GENERATOR SCRIPT</td> 
     
    8790background      = 0.0 [1/cm]</div></blockquote> 
    8891<dl class="method"> 
     92<dt id="sans.models.CoreShellModel.CoreShellModel.__add__"> 
     93<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.__add__" title="Permalink to this definition">¶</a></dt> 
     94<dd></dd></dl> 
     95 
     96<dl class="attribute"> 
     97<dt id="sans.models.CoreShellModel.CoreShellModel.__class__"> 
     98<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.__class__" title="Permalink to this definition">¶</a></dt> 
     99<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     100</dd></dl> 
     101 
     102<dl class="attribute"> 
     103<dt id="sans.models.CoreShellModel.CoreShellModel.__delattr__"> 
     104<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.__delattr__" title="Permalink to this definition">¶</a></dt> 
     105<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     106</dd></dl> 
     107 
     108<dl class="attribute"> 
     109<dt id="sans.models.CoreShellModel.CoreShellModel.__dict__"> 
     110<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01E1DB10&gt;</em><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.__dict__" title="Permalink to this definition">¶</a></dt> 
     111<dd></dd></dl> 
     112 
     113<dl class="method"> 
     114<dt id="sans.models.CoreShellModel.CoreShellModel.__div__"> 
     115<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.__div__" title="Permalink to this definition">¶</a></dt> 
     116<dd></dd></dl> 
     117 
     118<dl class="attribute"> 
     119<dt id="sans.models.CoreShellModel.CoreShellModel.__getattribute__"> 
     120<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     121<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     122</dd></dl> 
     123 
     124<dl class="attribute"> 
     125<dt id="sans.models.CoreShellModel.CoreShellModel.__hash__"> 
     126<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.__hash__" title="Permalink to this definition">¶</a></dt> 
     127<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     128</dd></dl> 
     129 
     130<dl class="method"> 
     131<dt id="sans.models.CoreShellModel.CoreShellModel.__init__"> 
     132<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.__init__" title="Permalink to this definition">¶</a></dt> 
     133<dd><p>Initialization</p> 
     134</dd></dl> 
     135 
     136<dl class="attribute"> 
     137<dt id="sans.models.CoreShellModel.CoreShellModel.__module__"> 
     138<tt class="descname">__module__</tt><em class="property"> = 'sans.models.CoreShellModel'</em><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.__module__" title="Permalink to this definition">¶</a></dt> 
     139<dd></dd></dl> 
     140 
     141<dl class="method"> 
     142<dt id="sans.models.CoreShellModel.CoreShellModel.__mul__"> 
     143<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.__mul__" title="Permalink to this definition">¶</a></dt> 
     144<dd></dd></dl> 
     145 
     146<dl class="staticmethod"> 
     147<dt id="sans.models.CoreShellModel.CoreShellModel.__new__"> 
     148<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.CoreShellModel.CoreShellModel.__new__" title="Permalink to this definition">¶</a></dt> 
     149<dd></dd></dl> 
     150 
     151<dl class="method"> 
     152<dt id="sans.models.CoreShellModel.CoreShellModel.__reduce__"> 
     153<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.__reduce__" title="Permalink to this definition">¶</a></dt> 
     154<dd><p>helper for pickle</p> 
     155</dd></dl> 
     156 
     157<dl class="method"> 
     158<dt id="sans.models.CoreShellModel.CoreShellModel.__reduce_ex__"> 
     159<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     160<dd><p>Overwrite the __reduce_ex__ of PyTypeObject <a href="#id1"><span class="problematic" id="id2">*</span></a>type call in the init of  
     161c model.</p> 
     162</dd></dl> 
     163 
     164<dl class="attribute"> 
     165<dt id="sans.models.CoreShellModel.CoreShellModel.__repr__"> 
     166<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.__repr__" title="Permalink to this definition">¶</a></dt> 
     167<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     168</dd></dl> 
     169 
     170<dl class="attribute"> 
     171<dt id="sans.models.CoreShellModel.CoreShellModel.__setattr__"> 
     172<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.__setattr__" title="Permalink to this definition">¶</a></dt> 
     173<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     174</dd></dl> 
     175 
     176<dl class="method"> 
     177<dt id="sans.models.CoreShellModel.CoreShellModel.__setstate__"> 
     178<tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.__setstate__" title="Permalink to this definition">¶</a></dt> 
     179<dd><p>restore the state of a model from pickle</p> 
     180</dd></dl> 
     181 
     182<dl class="attribute"> 
     183<dt id="sans.models.CoreShellModel.CoreShellModel.__str__"> 
     184<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.__str__" title="Permalink to this definition">¶</a></dt> 
     185<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     186</dd></dl> 
     187 
     188<dl class="method"> 
     189<dt id="sans.models.CoreShellModel.CoreShellModel.__sub__"> 
     190<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.__sub__" title="Permalink to this definition">¶</a></dt> 
     191<dd></dd></dl> 
     192 
     193<dl class="attribute"> 
     194<dt id="sans.models.CoreShellModel.CoreShellModel.__weakref__"> 
     195<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.__weakref__" title="Permalink to this definition">¶</a></dt> 
     196<dd><p>list of weak references to the object (if defined)</p> 
     197</dd></dl> 
     198 
     199<dl class="method"> 
     200<dt id="sans.models.CoreShellModel.CoreShellModel._clone"> 
     201<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel._clone" title="Permalink to this definition">¶</a></dt> 
     202<dd><p>Internal utility function to copy the internal 
     203data members to a fresh copy.</p> 
     204</dd></dl> 
     205 
     206<dl class="method"> 
    89207<dt id="sans.models.CoreShellModel.CoreShellModel.calculate_ER"> 
    90208<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.calculate_ER" title="Permalink to this definition">¶</a></dt> 
     
    94212<col class="field-body" /> 
    95213<tbody valign="top"> 
    96 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
     214<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td> 
    97215</tr> 
    98216</tbody> 
     
    114232<dl class="method"> 
    115233<dt id="sans.models.CoreShellModel.CoreShellModel.evalDistribution"> 
    116 <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.CoreShellModel.CoreShellModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
     234<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.evalDistribution" title="Permalink to this definition">¶</a></dt> 
    117235<dd><p>Evaluate the model in cartesian coordinates</p> 
    118236<table class="docutils field-list" frame="void" rules="none"> 
     
    120238<col class="field-body" /> 
    121239<tbody valign="top"> 
    122 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td> 
    123 </tr> 
    124 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
     240<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> 
     241</tr> 
     242<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td> 
    125243</tr> 
    126244</tbody> 
     
    136254<dl class="method"> 
    137255<dt id="sans.models.CoreShellModel.CoreShellModel.getParam"> 
    138 <tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.getParam" title="Permalink to this definition">¶</a></dt> 
     256<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.getParam" title="Permalink to this definition">¶</a></dt> 
    139257<dd><p>Set the value of a model parameter</p> 
    140258<table class="docutils field-list" frame="void" rules="none"> 
     
    142260<col class="field-body" /> 
    143261<tbody valign="top"> 
    144 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
     262<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td> 
    145263</tr> 
    146264</tbody> 
     
    156274<dl class="method"> 
    157275<dt id="sans.models.CoreShellModel.CoreShellModel.getParamListWithToken"> 
    158 <tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
     276<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt> 
    159277<dd></dd></dl> 
    160278 
    161279<dl class="method"> 
    162280<dt id="sans.models.CoreShellModel.CoreShellModel.getParamWithToken"> 
    163 <tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
     281<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.getParamWithToken" title="Permalink to this definition">¶</a></dt> 
    164282<dd></dd></dl> 
    165283 
    166284<dl class="method"> 
    167285<dt id="sans.models.CoreShellModel.CoreShellModel.is_fittable"> 
    168 <tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
     286<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.is_fittable" title="Permalink to this definition">¶</a></dt> 
    169287<dd><p>Check if a given parameter is fittable or not</p> 
    170288<table class="docutils field-list" frame="void" rules="none"> 
     
    172290<col class="field-body" /> 
    173291<tbody valign="top"> 
    174 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td> 
     292<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> 
    175293</tr> 
    176294</tbody> 
     
    190308</dd></dl> 
    191309 
    192 <dl class="attribute"> 
     310<dl class="method"> 
    193311<dt id="sans.models.CoreShellModel.CoreShellModel.reset"> 
    194 <tt class="descname">reset</tt><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.reset" title="Permalink to this definition">¶</a></dt> 
     312<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.reset" title="Permalink to this definition">¶</a></dt> 
    195313<dd><p>Reset pair correlation</p> 
    196314</dd></dl> 
     
    198316<dl class="method"> 
    199317<dt id="sans.models.CoreShellModel.CoreShellModel.run"> 
    200 <tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.run" title="Permalink to this definition">¶</a></dt> 
     318<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.run" title="Permalink to this definition">¶</a></dt> 
    201319<dd><p>Evaluate the model</p> 
    202320<table class="docutils field-list" frame="void" rules="none"> 
     
    204322<col class="field-body" /> 
    205323<tbody valign="top"> 
    206 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td> 
    207 </tr> 
    208 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     324<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> 
     325</tr> 
     326<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    209327</tr> 
    210328</tbody> 
     
    214332<dl class="method"> 
    215333<dt id="sans.models.CoreShellModel.CoreShellModel.runXY"> 
    216 <tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.runXY" title="Permalink to this definition">¶</a></dt> 
     334<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.runXY" title="Permalink to this definition">¶</a></dt> 
    217335<dd><p>Evaluate the model in cartesian coordinates</p> 
    218336<table class="docutils field-list" frame="void" rules="none"> 
     
    220338<col class="field-body" /> 
    221339<tbody valign="top"> 
    222 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td> 
    223 </tr> 
    224 <tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
     340<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> 
     341</tr> 
     342<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td> 
    225343</tr> 
    226344</tbody> 
     
    230348<dl class="method"> 
    231349<dt id="sans.models.CoreShellModel.CoreShellModel.setParam"> 
    232 <tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.setParam" title="Permalink to this definition">¶</a></dt> 
     350<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.setParam" title="Permalink to this definition">¶</a></dt> 
    233351<dd><p>Set the value of a model parameter</p> 
    234352<table class="docutils field-list" frame="void" rules="none"> 
     
    236354<col class="field-body" /> 
    237355<tbody valign="top"> 
    238 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     356<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    239357<li><strong>name</strong> &#8211; name of the parameter</li> 
    240358<li><strong>value</strong> &#8211; value of the parameter</li> 
     
    248366<dl class="method"> 
    249367<dt id="sans.models.CoreShellModel.CoreShellModel.setParamWithToken"> 
    250 <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.CoreShellModel.CoreShellModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
     368<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.setParamWithToken" title="Permalink to this definition">¶</a></dt> 
    251369<dd></dd></dl> 
    252370 
    253371<dl class="method"> 
    254372<dt id="sans.models.CoreShellModel.CoreShellModel.set_dispersion"> 
    255 <tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
     373<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellModel.CoreShellModel.set_dispersion" title="Permalink to this definition">¶</a></dt> 
    256374<dd><p>Set the dispersion object for a model parameter</p> 
    257375<table class="docutils field-list" frame="void" rules="none"> 
     
    259377<col class="field-body" /> 
    260378<tbody valign="top"> 
    261 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     379<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    262380<li><strong>parameter</strong> &#8211; name of the parameter [string]</li> 
    263381<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li> 
     
    288406  <ul> 
    289407<li><a class="reference internal" href="#">CoreShellModel</a><ul> 
    290 <li><a class="reference internal" href="#module-sans.models.CoreShellModel"><tt class="docutils literal"><span class="pre">sans.models.CoreShellModel</span></tt></a></li> 
     408<li><a class="reference internal" href="#sans-models-coreshellmodel"><tt class="docutils literal"><span class="pre">sans.models.CoreShellModel</span></tt></a></li> 
    291409</ul> 
    292410</li> 
     
    307425  <h3>Quick search</h3> 
    308426    <form class="search" action="../search.html" method="get"> 
    309       <input type="text" name="q" size="18" /> 
     427      <input type="text" name="q" /> 
    310428      <input type="submit" value="Go" /> 
    311429      <input type="hidden" name="check_keywords" value="yes" /> 
     
    336454          <a href="CoreShellEllipsoidModel.html" title="CoreShellEllipsoidModel" 
    337455             >previous</a> |</li> 
    338         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     456        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    339457          <li><a href="index.html" >Reference</a> &raquo;</li>  
    340458      </ul> 
     
    342460    <div class="footer"> 
    343461        &copy; Copyright 2010, sans group. 
    344       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     462      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    345463    </div> 
    346464  </body> 
Note: See TracChangeset for help on using the changeset viewer.