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/dispersion_models.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>dispersion_models &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>dispersion_models &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="DivComponent" href="DivComponent.html" /> 
    … …  
    4447          <a href="DisperseModel.html" title="DisperseModel" 
    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="dispersion-models"> 
    5760<h1>dispersion_models<a class="headerlink" href="#dispersion-models" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.dispersion_models"> 
    59 <span id="sans-models-dispersion-models"></span><h2><a class="reference internal" href="#module-sans.models.dispersion_models" title="sans.models.dispersion_models"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.dispersion_models</span></tt></a><a class="headerlink" href="#module-sans.models.dispersion_models" title="Permalink to this headline">¶</a></h2> 
    60 <p>Class definitions for python dispersion model for  
     61<div class="section" id="sans-models-dispersion-models"> 
     62<h2><a class="reference internal" href="#module-sans.models.dispersion_models" title="sans.models.dispersion_models"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.dispersion_models</span></tt></a><a class="headerlink" href="#sans-models-dispersion-models" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.dispersion_models"></span><p>Class definitions for python dispersion model for  
    6164model parameters. These classes are bridges to the C++ 
    6265dispersion object.</p> 
    … …  
    7679<col class="field-body" /> 
    7780<tbody valign="top"> 
    78 <tr class="field"><th class="field-name">TODO:</th><td class="field-body">For backward compatibility, the model parameters are still kept in 
     81<tr class="field-odd field"><th class="field-name">TODO:</th><td class="field-body">For backward compatibility, the model parameters are still kept in 
    7982a dictionary. The next iteration of refactoring work should involve moving 
    8083away from value-based parameters to object-based parameter. We want to 
    … …  
    9497it is applied to.</p> 
    9598<dl class="method"> 
     99<dt id="sans.models.dispersion_models.ArrayDispersion.__init__"> 
     100<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.dispersion_models.ArrayDispersion.__init__" title="Permalink to this definition">¶</a></dt> 
     101<dd></dd></dl> 
     102 
     103<dl class="attribute"> 
     104<dt id="sans.models.dispersion_models.ArrayDispersion.__module__"> 
     105<tt class="descname">__module__</tt><em class="property"> = 'sans.models.dispersion_models'</em><a class="headerlink" href="#sans.models.dispersion_models.ArrayDispersion.__module__" title="Permalink to this definition">¶</a></dt> 
     106<dd></dd></dl> 
     107 
     108<dl class="method"> 
    96109<dt id="sans.models.dispersion_models.ArrayDispersion.set_weights"> 
    97 <tt class="descname">set_weights</tt><big>(</big><em>values</em>, <em>weights</em><big>)</big><a class="headerlink" href="#sans.models.dispersion_models.ArrayDispersion.set_weights" title="Permalink to this definition">¶</a></dt> 
     110<tt class="descname">set_weights</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.dispersion_models.ArrayDispersion.set_weights" title="Permalink to this definition">¶</a></dt> 
    98111<dd><p>Set the weights of an array dispersion 
    99112Only accept numpy arrays.</p> 
    … …  
    102115<col class="field-body" /> 
    103116<tbody valign="top"> 
    104 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     117<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    105118<li><strong>values</strong> &#8211; numpy array of values</li> 
    106119<li><strong>weights</strong> &#8211; numpy array of weights for each value entry</li> 
    … …  
    120133class with a constant parameter value distribution</p> 
    121134<dl class="method"> 
     135<dt id="sans.models.dispersion_models.DispersionModel.__init__"> 
     136<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.dispersion_models.DispersionModel.__init__" title="Permalink to this definition">¶</a></dt> 
     137<dd></dd></dl> 
     138 
     139<dl class="attribute"> 
     140<dt id="sans.models.dispersion_models.DispersionModel.__module__"> 
     141<tt class="descname">__module__</tt><em class="property"> = 'sans.models.dispersion_models'</em><a class="headerlink" href="#sans.models.dispersion_models.DispersionModel.__module__" title="Permalink to this definition">¶</a></dt> 
     142<dd></dd></dl> 
     143 
     144<dl class="method"> 
    122145<dt id="sans.models.dispersion_models.DispersionModel.set_weights"> 
    123 <tt class="descname">set_weights</tt><big>(</big><em>values</em>, <em>weights</em><big>)</big><a class="headerlink" href="#sans.models.dispersion_models.DispersionModel.set_weights" title="Permalink to this definition">¶</a></dt> 
     146<tt class="descname">set_weights</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.dispersion_models.DispersionModel.set_weights" title="Permalink to this definition">¶</a></dt> 
    124147<dd><p>Set the weights of an array dispersion</p> 
    125148</dd></dl> 
    … …  
    134157on a Gaussian distribution.</p> 
    135158<dl class="method"> 
     159<dt id="sans.models.dispersion_models.GaussianDispersion.__init__"> 
     160<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.dispersion_models.GaussianDispersion.__init__" title="Permalink to this definition">¶</a></dt> 
     161<dd></dd></dl> 
     162 
     163<dl class="attribute"> 
     164<dt id="sans.models.dispersion_models.GaussianDispersion.__module__"> 
     165<tt class="descname">__module__</tt><em class="property"> = 'sans.models.dispersion_models'</em><a class="headerlink" href="#sans.models.dispersion_models.GaussianDispersion.__module__" title="Permalink to this definition">¶</a></dt> 
     166<dd></dd></dl> 
     167 
     168<dl class="method"> 
    136169<dt id="sans.models.dispersion_models.GaussianDispersion.set_weights"> 
    137 <tt class="descname">set_weights</tt><big>(</big><em>values</em>, <em>weights</em><big>)</big><a class="headerlink" href="#sans.models.dispersion_models.GaussianDispersion.set_weights" title="Permalink to this definition">¶</a></dt> 
     170<tt class="descname">set_weights</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.dispersion_models.GaussianDispersion.set_weights" title="Permalink to this definition">¶</a></dt> 
    138171<dd><p>Set the weights of an array dispersion</p> 
    139172</dd></dl> 
    … …  
    148181on a Log Normal distribution.</p> 
    149182<dl class="method"> 
     183<dt id="sans.models.dispersion_models.LogNormalDispersion.__init__"> 
     184<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.dispersion_models.LogNormalDispersion.__init__" title="Permalink to this definition">¶</a></dt> 
     185<dd></dd></dl> 
     186 
     187<dl class="attribute"> 
     188<dt id="sans.models.dispersion_models.LogNormalDispersion.__module__"> 
     189<tt class="descname">__module__</tt><em class="property"> = 'sans.models.dispersion_models'</em><a class="headerlink" href="#sans.models.dispersion_models.LogNormalDispersion.__module__" title="Permalink to this definition">¶</a></dt> 
     190<dd></dd></dl> 
     191 
     192<dl class="method"> 
    150193<dt id="sans.models.dispersion_models.LogNormalDispersion.set_weights"> 
    151 <tt class="descname">set_weights</tt><big>(</big><em>values</em>, <em>weights</em><big>)</big><a class="headerlink" href="#sans.models.dispersion_models.LogNormalDispersion.set_weights" title="Permalink to this definition">¶</a></dt> 
     194<tt class="descname">set_weights</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.dispersion_models.LogNormalDispersion.set_weights" title="Permalink to this definition">¶</a></dt> 
    152195<dd><p>Set the weights of an array dispersion</p> 
    153196</dd></dl> 
    … …  
    162205on a Gaussian distribution.</p> 
    163206<dl class="method"> 
     207<dt id="sans.models.dispersion_models.RectangleDispersion.__init__"> 
     208<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.dispersion_models.RectangleDispersion.__init__" title="Permalink to this definition">¶</a></dt> 
     209<dd></dd></dl> 
     210 
     211<dl class="attribute"> 
     212<dt id="sans.models.dispersion_models.RectangleDispersion.__module__"> 
     213<tt class="descname">__module__</tt><em class="property"> = 'sans.models.dispersion_models'</em><a class="headerlink" href="#sans.models.dispersion_models.RectangleDispersion.__module__" title="Permalink to this definition">¶</a></dt> 
     214<dd></dd></dl> 
     215 
     216<dl class="method"> 
    164217<dt id="sans.models.dispersion_models.RectangleDispersion.set_weights"> 
    165 <tt class="descname">set_weights</tt><big>(</big><em>values</em>, <em>weights</em><big>)</big><a class="headerlink" href="#sans.models.dispersion_models.RectangleDispersion.set_weights" title="Permalink to this definition">¶</a></dt> 
     218<tt class="descname">set_weights</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.dispersion_models.RectangleDispersion.set_weights" title="Permalink to this definition">¶</a></dt> 
    166219<dd><p>Set the weights of an array dispersion</p> 
    167220</dd></dl> 
    … …  
    176229on a Schulz distribution.</p> 
    177230<dl class="method"> 
     231<dt id="sans.models.dispersion_models.SchulzDispersion.__init__"> 
     232<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.dispersion_models.SchulzDispersion.__init__" title="Permalink to this definition">¶</a></dt> 
     233<dd></dd></dl> 
     234 
     235<dl class="attribute"> 
     236<dt id="sans.models.dispersion_models.SchulzDispersion.__module__"> 
     237<tt class="descname">__module__</tt><em class="property"> = 'sans.models.dispersion_models'</em><a class="headerlink" href="#sans.models.dispersion_models.SchulzDispersion.__module__" title="Permalink to this definition">¶</a></dt> 
     238<dd></dd></dl> 
     239 
     240<dl class="method"> 
    178241<dt id="sans.models.dispersion_models.SchulzDispersion.set_weights"> 
    179 <tt class="descname">set_weights</tt><big>(</big><em>values</em>, <em>weights</em><big>)</big><a class="headerlink" href="#sans.models.dispersion_models.SchulzDispersion.set_weights" title="Permalink to this definition">¶</a></dt> 
     242<tt class="descname">set_weights</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.dispersion_models.SchulzDispersion.set_weights" title="Permalink to this definition">¶</a></dt> 
    180243<dd><p>Set the weights of an array dispersion</p> 
    181244</dd></dl> 
    … …  
    195258  <ul> 
    196259<li><a class="reference internal" href="#">dispersion_models</a><ul> 
    197 <li><a class="reference internal" href="#module-sans.models.dispersion_models"><tt class="docutils literal"><span class="pre">sans.models.dispersion_models</span></tt></a></li> 
     260<li><a class="reference internal" href="#sans-models-dispersion-models"><tt class="docutils literal"><span class="pre">sans.models.dispersion_models</span></tt></a></li> 
    198261</ul> 
    199262</li> 
    … …  
    214277  <h3>Quick search</h3> 
    215278    <form class="search" action="../search.html" method="get"> 
    216       <input type="text" name="q" size="18" /> 
     279      <input type="text" name="q" /> 
    217280      <input type="submit" value="Go" /> 
    218281      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    243306          <a href="DisperseModel.html" title="DisperseModel" 
    244307             >previous</a> |</li> 
    245         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     308        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    246309          <li><a href="index.html" >Reference</a> &raquo;</li>  
    247310      </ul> 
    … …  
    249312    <div class="footer"> 
    250313        &copy; Copyright 2010, sans group. 
    251       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     314      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    252315    </div> 
    253316  </body> 
Note: See TracChangeset for help on using the changeset viewer.