Ignore:
Timestamp:
Oct 24, 2011 12: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/smearing_2d.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>smearing_2d &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>smearing_2d &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="SphereModel" href="SphereModel.html" /> 
    … …  
    4447          <a href="SLDCalFunc.html" title="SLDCalFunc" 
    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="smearing-2d"> 
    5760<h1>smearing_2d<a class="headerlink" href="#smearing-2d" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.smearing_2d"> 
    59 <span id="sans-models-smearing-2d"></span><h2><a class="reference internal" href="#module-sans.models.smearing_2d" title="sans.models.smearing_2d"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.smearing_2d</span></tt></a><a class="headerlink" href="#module-sans.models.smearing_2d" title="Permalink to this headline">¶</a></h2> 
    60 <dl class="class"> 
     61<div class="section" id="sans-models-smearing-2d"> 
     62<h2><a class="reference internal" href="#module-sans.models.smearing_2d" title="sans.models.smearing_2d"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.smearing_2d</span></tt></a><a class="headerlink" href="#sans-models-smearing-2d" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.smearing_2d"></span><dl class="class"> 
    6164<dt id="sans.models.smearing_2d.Smearer2D"> 
    62 <em class="property">class </em><tt class="descclassname">sans.models.smearing_2d.</tt><tt class="descname">Smearer2D</tt><big>(</big><em>data=None</em>, <em>model=None</em>, <em>index=None</em>, <em>limit=3.0</em>, <em>accuracy='Low'</em>, <em>coords='polar'</em>, <em>engine='python'</em><big>)</big><a class="headerlink" href="#sans.models.smearing_2d.Smearer2D" title="Permalink to this definition">¶</a></dt> 
     65<em class="property">class </em><tt class="descclassname">sans.models.smearing_2d.</tt><tt class="descname">Smearer2D</tt><a class="headerlink" href="#sans.models.smearing_2d.Smearer2D" title="Permalink to this definition">¶</a></dt> 
    6366<dd><p>Gaussian Q smearing class for SANS 2d data</p> 
     67<dl class="method"> 
     68<dt id="sans.models.smearing_2d.Smearer2D.__init__"> 
     69<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.smearing_2d.Smearer2D.__init__" title="Permalink to this definition">¶</a></dt> 
     70<dd><p>Assumption: equally spaced bins in dq_r, dq_phi space.</p> 
     71<table class="docutils field-list" frame="void" rules="none"> 
     72<col class="field-name" /> 
     73<col class="field-body" /> 
     74<tbody valign="top"> 
     75<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     76<li><strong>data</strong> &#8211; 2d data used to set the smearing parameters</li> 
     77<li><strong>model</strong> &#8211; model function</li> 
     78<li><strong>index</strong> &#8211; 1d array with len(data) to define the range of the calculation: elements are given as True or False</li> 
     79<li><strong>nr</strong> &#8211; number of bins in dq_r-axis</li> 
     80<li><strong>nphi</strong> &#8211; number of bins in dq_phi-axis</li> 
     81<li><strong>coord</strong> &#8211; coordinates [string], &#8216;polar&#8217; or &#8216;cartesian&#8217;</li> 
     82<li><strong>engine</strong> &#8211; engine name [string]; &#8216;c&#8217; or &#8216;numpy&#8217;</li> 
     83</ul> 
     84</td> 
     85</tr> 
     86</tbody> 
     87</table> 
     88</dd></dl> 
     89 
     90<dl class="attribute"> 
     91<dt id="sans.models.smearing_2d.Smearer2D.__module__"> 
     92<tt class="descname">__module__</tt><em class="property"> = 'sans.models.smearing_2d'</em><a class="headerlink" href="#sans.models.smearing_2d.Smearer2D.__module__" title="Permalink to this definition">¶</a></dt> 
     93<dd></dd></dl> 
     94 
    6495<dl class="method"> 
    6596<dt id="sans.models.smearing_2d.Smearer2D.get_data"> 
    … …  
    77108<dl class="method"> 
    78109<dt id="sans.models.smearing_2d.Smearer2D.set_accuracy"> 
    79 <tt class="descname">set_accuracy</tt><big>(</big><em>accuracy='Low'</em><big>)</big><a class="headerlink" href="#sans.models.smearing_2d.Smearer2D.set_accuracy" title="Permalink to this definition">¶</a></dt> 
     110<tt class="descname">set_accuracy</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.smearing_2d.Smearer2D.set_accuracy" title="Permalink to this definition">¶</a></dt> 
    80111<dd><p>Set accuracy.</p> 
    81112<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    83114<col class="field-body" /> 
    84115<tbody valign="top"> 
    85 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>accuracy</strong> &#8211; string</td> 
     116<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>accuracy</strong> &#8211; string</td> 
    86117</tr> 
    87118</tbody> 
    … …  
    91122<dl class="method"> 
    92123<dt id="sans.models.smearing_2d.Smearer2D.set_data"> 
    93 <tt class="descname">set_data</tt><big>(</big><em>data=None</em><big>)</big><a class="headerlink" href="#sans.models.smearing_2d.Smearer2D.set_data" title="Permalink to this definition">¶</a></dt> 
     124<tt class="descname">set_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.smearing_2d.Smearer2D.set_data" title="Permalink to this definition">¶</a></dt> 
    94125<dd><p>Set data.</p> 
    95126<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    97128<col class="field-body" /> 
    98129<tbody valign="top"> 
    99 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> &#8211; DataLoader.Data_info type</td> 
     130<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> &#8211; DataLoader.Data_info type</td> 
    100131</tr> 
    101132</tbody> 
    … …  
    105136<dl class="method"> 
    106137<dt id="sans.models.smearing_2d.Smearer2D.set_index"> 
    107 <tt class="descname">set_index</tt><big>(</big><em>index=None</em><big>)</big><a class="headerlink" href="#sans.models.smearing_2d.Smearer2D.set_index" title="Permalink to this definition">¶</a></dt> 
     138<tt class="descname">set_index</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.smearing_2d.Smearer2D.set_index" title="Permalink to this definition">¶</a></dt> 
    108139<dd><p>Set index.</p> 
    109140<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    111142<col class="field-body" /> 
    112143<tbody valign="top"> 
    113 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>index</strong> &#8211; 1d arrays</td> 
     144<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>index</strong> &#8211; 1d arrays</td> 
    114145</tr> 
    115146</tbody> 
    … …  
    119150<dl class="method"> 
    120151<dt id="sans.models.smearing_2d.Smearer2D.set_model"> 
    121 <tt class="descname">set_model</tt><big>(</big><em>model=None</em><big>)</big><a class="headerlink" href="#sans.models.smearing_2d.Smearer2D.set_model" title="Permalink to this definition">¶</a></dt> 
     152<tt class="descname">set_model</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.smearing_2d.Smearer2D.set_model" title="Permalink to this definition">¶</a></dt> 
    122153<dd><p>Set model.</p> 
    123154<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    125156<col class="field-body" /> 
    126157<tbody valign="top"> 
    127 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> &#8211; sans.models instance</td> 
     158<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> &#8211; sans.models instance</td> 
    128159</tr> 
    129160</tbody> 
    … …  
    133164<dl class="method"> 
    134165<dt id="sans.models.smearing_2d.Smearer2D.set_smearer"> 
    135 <tt class="descname">set_smearer</tt><big>(</big><em>smearer=True</em><big>)</big><a class="headerlink" href="#sans.models.smearing_2d.Smearer2D.set_smearer" title="Permalink to this definition">¶</a></dt> 
     166<tt class="descname">set_smearer</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.smearing_2d.Smearer2D.set_smearer" title="Permalink to this definition">¶</a></dt> 
    136167<dd><p>Set whether or not smearer will be used</p> 
    137168<table class="docutils field-list" frame="void" rules="none"> 
    … …  
    139170<col class="field-body" /> 
    140171<tbody valign="top"> 
    141 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>smearer</strong> &#8211; smear object</td> 
     172<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>smearer</strong> &#8211; smear object</td> 
    142173</tr> 
    143174</tbody> 
    … …  
    159190  <ul> 
    160191<li><a class="reference internal" href="#">smearing_2d</a><ul> 
    161 <li><a class="reference internal" href="#module-sans.models.smearing_2d"><tt class="docutils literal"><span class="pre">sans.models.smearing_2d</span></tt></a></li> 
     192<li><a class="reference internal" href="#sans-models-smearing-2d"><tt class="docutils literal"><span class="pre">sans.models.smearing_2d</span></tt></a></li> 
    162193</ul> 
    163194</li> 
    … …  
    178209  <h3>Quick search</h3> 
    179210    <form class="search" action="../search.html" method="get"> 
    180       <input type="text" name="q" size="18" /> 
     211      <input type="text" name="q" /> 
    181212      <input type="submit" value="Go" /> 
    182213      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    207238          <a href="SLDCalFunc.html" title="SLDCalFunc" 
    208239             >previous</a> |</li> 
    209         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     240        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    210241          <li><a href="index.html" >Reference</a> &raquo;</li>  
    211242      </ul> 
    … …  
    213244    <div class="footer"> 
    214245        &copy; Copyright 2010, sans group. 
    215       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     246      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    216247    </div> 
    217248  </body> 
Note: See TracChangeset for help on using the changeset viewer.