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/qsmearing.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>qsmearing &mdash; sansmodels v0.1.0 documentation</title> 
     11    <title>qsmearing &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="ReflAdvModel" href="ReflAdvModel.html" /> 
    … …  
    4447          <a href="ProlateModel.html" title="ProlateModel" 
    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="qsmearing"> 
    5760<h1>qsmearing<a class="headerlink" href="#qsmearing" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.models.qsmearing"> 
    59 <span id="sans-models-qsmearing"></span><h2><a class="reference internal" href="#module-sans.models.qsmearing" title="sans.models.qsmearing"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.qsmearing</span></tt></a><a class="headerlink" href="#module-sans.models.qsmearing" title="Permalink to this headline">¶</a></h2> 
    60 <dl class="class"> 
     61<div class="section" id="sans-models-qsmearing"> 
     62<h2><a class="reference internal" href="#module-sans.models.qsmearing" title="sans.models.qsmearing"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.qsmearing</span></tt></a><a class="headerlink" href="#sans-models-qsmearing" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.models.qsmearing"></span><dl class="class"> 
    6164<dt id="sans.models.qsmearing.QSmearer"> 
    62 <em class="property">class </em><tt class="descclassname">sans.models.qsmearing.</tt><tt class="descname">QSmearer</tt><big>(</big><em>data1D</em>, <em>model=None</em><big>)</big><a class="headerlink" href="#sans.models.qsmearing.QSmearer" title="Permalink to this definition">¶</a></dt> 
    63 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.models.qsmearing._QSmearer</span></tt></p> 
     65<em class="property">class </em><tt class="descclassname">sans.models.qsmearing.</tt><tt class="descname">QSmearer</tt><a class="headerlink" href="#sans.models.qsmearing.QSmearer" title="Permalink to this definition">¶</a></dt> 
     66<dd><p>Bases: <a class="reference internal" href="#sans.models.qsmearing._QSmearer" title="sans.models.qsmearing._QSmearer"><tt class="xref py py-class docutils literal"><span class="pre">sans.models.qsmearing._QSmearer</span></tt></a></p> 
    6467<p>Adaptor for Gaussian Q smearing class and SANS data</p> 
    6568<dl class="method"> 
     69<dt id="sans.models.qsmearing.QSmearer.__call__"> 
     70<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.QSmearer.__call__" title="Permalink to this definition">¶</a></dt> 
     71<dd><p>Perform smearing</p> 
     72</dd></dl> 
     73 
     74<dl class="attribute"> 
     75<dt id="sans.models.qsmearing.QSmearer.__class__"> 
     76<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.qsmearing.QSmearer.__class__" title="Permalink to this definition">¶</a></dt> 
     77<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     78</dd></dl> 
     79 
     80<dl class="method"> 
     81<dt id="sans.models.qsmearing.QSmearer.__deepcopy__"> 
     82<tt class="descname">__deepcopy__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.QSmearer.__deepcopy__" title="Permalink to this definition">¶</a></dt> 
     83<dd><p>Return a valid copy of self. 
     84Avoid copying the _smearer C object and force a matrix recompute 
     85when the copy is used.</p> 
     86</dd></dl> 
     87 
     88<dl class="attribute"> 
     89<dt id="sans.models.qsmearing.QSmearer.__delattr__"> 
     90<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.qsmearing.QSmearer.__delattr__" title="Permalink to this definition">¶</a></dt> 
     91<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     92</dd></dl> 
     93 
     94<dl class="attribute"> 
     95<dt id="sans.models.qsmearing.QSmearer.__dict__"> 
     96<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x02933CD0&gt;</em><a class="headerlink" href="#sans.models.qsmearing.QSmearer.__dict__" title="Permalink to this definition">¶</a></dt> 
     97<dd></dd></dl> 
     98 
     99<dl class="attribute"> 
     100<dt id="sans.models.qsmearing.QSmearer.__getattribute__"> 
     101<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.qsmearing.QSmearer.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     102<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     103</dd></dl> 
     104 
     105<dl class="attribute"> 
     106<dt id="sans.models.qsmearing.QSmearer.__hash__"> 
     107<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.qsmearing.QSmearer.__hash__" title="Permalink to this definition">¶</a></dt> 
     108<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     109</dd></dl> 
     110 
     111<dl class="method"> 
     112<dt id="sans.models.qsmearing.QSmearer.__init__"> 
     113<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.QSmearer.__init__" title="Permalink to this definition">¶</a></dt> 
     114<dd><p>Assumption: equally spaced bins of increasing q-values.</p> 
     115<table class="docutils field-list" frame="void" rules="none"> 
     116<col class="field-name" /> 
     117<col class="field-body" /> 
     118<tbody valign="top"> 
     119<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data1D</strong> &#8211; data used to set the smearing parameters</td> 
     120</tr> 
     121</tbody> 
     122</table> 
     123</dd></dl> 
     124 
     125<dl class="attribute"> 
     126<dt id="sans.models.qsmearing.QSmearer.__module__"> 
     127<tt class="descname">__module__</tt><em class="property"> = 'sans.models.qsmearing'</em><a class="headerlink" href="#sans.models.qsmearing.QSmearer.__module__" title="Permalink to this definition">¶</a></dt> 
     128<dd></dd></dl> 
     129 
     130<dl class="staticmethod"> 
     131<dt id="sans.models.qsmearing.QSmearer.__new__"> 
     132<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.qsmearing.QSmearer.__new__" title="Permalink to this definition">¶</a></dt> 
     133<dd></dd></dl> 
     134 
     135<dl class="method"> 
     136<dt id="sans.models.qsmearing.QSmearer.__reduce__"> 
     137<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.QSmearer.__reduce__" title="Permalink to this definition">¶</a></dt> 
     138<dd><p>helper for pickle</p> 
     139</dd></dl> 
     140 
     141<dl class="method"> 
     142<dt id="sans.models.qsmearing.QSmearer.__reduce_ex__"> 
     143<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.QSmearer.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     144<dd><p>helper for pickle</p> 
     145</dd></dl> 
     146 
     147<dl class="attribute"> 
     148<dt id="sans.models.qsmearing.QSmearer.__repr__"> 
     149<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.qsmearing.QSmearer.__repr__" title="Permalink to this definition">¶</a></dt> 
     150<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     151</dd></dl> 
     152 
     153<dl class="attribute"> 
     154<dt id="sans.models.qsmearing.QSmearer.__setattr__"> 
     155<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.qsmearing.QSmearer.__setattr__" title="Permalink to this definition">¶</a></dt> 
     156<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     157</dd></dl> 
     158 
     159<dl class="attribute"> 
     160<dt id="sans.models.qsmearing.QSmearer.__str__"> 
     161<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.qsmearing.QSmearer.__str__" title="Permalink to this definition">¶</a></dt> 
     162<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     163</dd></dl> 
     164 
     165<dl class="attribute"> 
     166<dt id="sans.models.qsmearing.QSmearer.__weakref__"> 
     167<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.qsmearing.QSmearer.__weakref__" title="Permalink to this definition">¶</a></dt> 
     168<dd><p>list of weak references to the object (if defined)</p> 
     169</dd></dl> 
     170 
     171<dl class="method"> 
     172<dt id="sans.models.qsmearing.QSmearer._compute_matrix"> 
     173<tt class="descname">_compute_matrix</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.QSmearer._compute_matrix" title="Permalink to this definition">¶</a></dt> 
     174<dd></dd></dl> 
     175 
     176<dl class="method"> 
     177<dt id="sans.models.qsmearing.QSmearer._get_extrapolated_bin"> 
     178<tt class="descname">_get_extrapolated_bin</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.QSmearer._get_extrapolated_bin" title="Permalink to this definition">¶</a></dt> 
     179<dd><p>Get extrapolated first bin and the last bin</p> 
     180<p>: param first_bin: unextrapolated first_bin 
     181: param last_bin: unextrapolated last_bin</p> 
     182<p>: return first_bin, last_bin: extrapolated first and last bin</p> 
     183</dd></dl> 
     184 
     185<dl class="method"> 
     186<dt id="sans.models.qsmearing.QSmearer._get_unextrapolated_bin"> 
     187<tt class="descname">_get_unextrapolated_bin</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.QSmearer._get_unextrapolated_bin" title="Permalink to this definition">¶</a></dt> 
     188<dd><p>Get unextrapolated first bin and the last bin</p> 
     189<p>: param first_bin: extrapolated first_bin 
     190: param last_bin: extrapolated last_bin</p> 
     191<p>: return fist_bin, last_bin: unextrapolated first and last bin</p> 
     192</dd></dl> 
     193 
     194<dl class="method"> 
     195<dt id="sans.models.qsmearing.QSmearer._initialize_smearer"> 
     196<tt class="descname">_initialize_smearer</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.QSmearer._initialize_smearer" title="Permalink to this definition">¶</a></dt> 
     197<dd><p>Initialize the C++ smearer object. 
     198This method HAS to be called before smearing</p> 
     199</dd></dl> 
     200 
     201<dl class="method"> 
    66202<dt id="sans.models.qsmearing.QSmearer.get_bin_range"> 
    67 <tt class="descname">get_bin_range</tt><big>(</big><em>q_min=None</em>, <em>q_max=None</em><big>)</big><a class="headerlink" href="#sans.models.qsmearing.QSmearer.get_bin_range" title="Permalink to this definition">¶</a></dt> 
     203<tt class="descname">get_bin_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.QSmearer.get_bin_range" title="Permalink to this definition">¶</a></dt> 
    68204<dd><table class="docutils field-list" frame="void" rules="none"> 
    69205<col class="field-name" /> 
    70206<col class="field-body" /> 
    71207<tbody valign="top"> 
    72 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     208<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    73209<li><strong>q_min</strong> &#8211; minimum q-value to smear</li> 
    74210<li><strong>q_max</strong> &#8211; maximum q-value to smear</li> 
    … …  
    82218<dl class="method"> 
    83219<dt id="sans.models.qsmearing.QSmearer.get_unsmeared_range"> 
    84 <tt class="descname">get_unsmeared_range</tt><big>(</big><em>q_min</em>, <em>q_max</em><big>)</big><a class="headerlink" href="#sans.models.qsmearing.QSmearer.get_unsmeared_range" title="Permalink to this definition">¶</a></dt> 
     220<tt class="descname">get_unsmeared_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.QSmearer.get_unsmeared_range" title="Permalink to this definition">¶</a></dt> 
    85221<dd><p>Determine the range needed in unsmeared-Q to cover 
    86222the smeared Q range 
    … …  
    92228<dl class="class"> 
    93229<dt id="sans.models.qsmearing.SlitSmearer"> 
    94 <em class="property">class </em><tt class="descclassname">sans.models.qsmearing.</tt><tt class="descname">SlitSmearer</tt><big>(</big><em>data1D</em>, <em>model=None</em><big>)</big><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer" title="Permalink to this definition">¶</a></dt> 
    95 <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.models.qsmearing._SlitSmearer</span></tt></p> 
     230<em class="property">class </em><tt class="descclassname">sans.models.qsmearing.</tt><tt class="descname">SlitSmearer</tt><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer" title="Permalink to this definition">¶</a></dt> 
     231<dd><p>Bases: <a class="reference internal" href="#sans.models.qsmearing._SlitSmearer" title="sans.models.qsmearing._SlitSmearer"><tt class="xref py py-class docutils literal"><span class="pre">sans.models.qsmearing._SlitSmearer</span></tt></a></p> 
    96232<p>Adaptor for slit smearing class and SANS data</p> 
    97233<dl class="method"> 
     234<dt id="sans.models.qsmearing.SlitSmearer.__call__"> 
     235<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer.__call__" title="Permalink to this definition">¶</a></dt> 
     236<dd><p>Perform smearing</p> 
     237</dd></dl> 
     238 
     239<dl class="attribute"> 
     240<dt id="sans.models.qsmearing.SlitSmearer.__class__"> 
     241<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer.__class__" title="Permalink to this definition">¶</a></dt> 
     242<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     243</dd></dl> 
     244 
     245<dl class="method"> 
     246<dt id="sans.models.qsmearing.SlitSmearer.__deepcopy__"> 
     247<tt class="descname">__deepcopy__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer.__deepcopy__" title="Permalink to this definition">¶</a></dt> 
     248<dd><p>Return a valid copy of self. 
     249Avoid copying the _smearer C object and force a matrix recompute 
     250when the copy is used.</p> 
     251</dd></dl> 
     252 
     253<dl class="attribute"> 
     254<dt id="sans.models.qsmearing.SlitSmearer.__delattr__"> 
     255<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer.__delattr__" title="Permalink to this definition">¶</a></dt> 
     256<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     257</dd></dl> 
     258 
     259<dl class="attribute"> 
     260<dt id="sans.models.qsmearing.SlitSmearer.__dict__"> 
     261<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x02933CB0&gt;</em><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer.__dict__" title="Permalink to this definition">¶</a></dt> 
     262<dd></dd></dl> 
     263 
     264<dl class="attribute"> 
     265<dt id="sans.models.qsmearing.SlitSmearer.__getattribute__"> 
     266<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     267<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     268</dd></dl> 
     269 
     270<dl class="attribute"> 
     271<dt id="sans.models.qsmearing.SlitSmearer.__hash__"> 
     272<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer.__hash__" title="Permalink to this definition">¶</a></dt> 
     273<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     274</dd></dl> 
     275 
     276<dl class="method"> 
     277<dt id="sans.models.qsmearing.SlitSmearer.__init__"> 
     278<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer.__init__" title="Permalink to this definition">¶</a></dt> 
     279<dd><p>Assumption: equally spaced bins of increasing q-values.</p> 
     280<table class="docutils field-list" frame="void" rules="none"> 
     281<col class="field-name" /> 
     282<col class="field-body" /> 
     283<tbody valign="top"> 
     284<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data1D</strong> &#8211; data used to set the smearing parameters</td> 
     285</tr> 
     286</tbody> 
     287</table> 
     288</dd></dl> 
     289 
     290<dl class="attribute"> 
     291<dt id="sans.models.qsmearing.SlitSmearer.__module__"> 
     292<tt class="descname">__module__</tt><em class="property"> = 'sans.models.qsmearing'</em><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer.__module__" title="Permalink to this definition">¶</a></dt> 
     293<dd></dd></dl> 
     294 
     295<dl class="staticmethod"> 
     296<dt id="sans.models.qsmearing.SlitSmearer.__new__"> 
     297<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.qsmearing.SlitSmearer.__new__" title="Permalink to this definition">¶</a></dt> 
     298<dd></dd></dl> 
     299 
     300<dl class="method"> 
     301<dt id="sans.models.qsmearing.SlitSmearer.__reduce__"> 
     302<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer.__reduce__" title="Permalink to this definition">¶</a></dt> 
     303<dd><p>helper for pickle</p> 
     304</dd></dl> 
     305 
     306<dl class="method"> 
     307<dt id="sans.models.qsmearing.SlitSmearer.__reduce_ex__"> 
     308<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     309<dd><p>helper for pickle</p> 
     310</dd></dl> 
     311 
     312<dl class="attribute"> 
     313<dt id="sans.models.qsmearing.SlitSmearer.__repr__"> 
     314<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer.__repr__" title="Permalink to this definition">¶</a></dt> 
     315<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     316</dd></dl> 
     317 
     318<dl class="attribute"> 
     319<dt id="sans.models.qsmearing.SlitSmearer.__setattr__"> 
     320<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer.__setattr__" title="Permalink to this definition">¶</a></dt> 
     321<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     322</dd></dl> 
     323 
     324<dl class="attribute"> 
     325<dt id="sans.models.qsmearing.SlitSmearer.__str__"> 
     326<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer.__str__" title="Permalink to this definition">¶</a></dt> 
     327<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     328</dd></dl> 
     329 
     330<dl class="attribute"> 
     331<dt id="sans.models.qsmearing.SlitSmearer.__weakref__"> 
     332<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer.__weakref__" title="Permalink to this definition">¶</a></dt> 
     333<dd><p>list of weak references to the object (if defined)</p> 
     334</dd></dl> 
     335 
     336<dl class="method"> 
     337<dt id="sans.models.qsmearing.SlitSmearer._compute_matrix"> 
     338<tt class="descname">_compute_matrix</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer._compute_matrix" title="Permalink to this definition">¶</a></dt> 
     339<dd></dd></dl> 
     340 
     341<dl class="method"> 
     342<dt id="sans.models.qsmearing.SlitSmearer._get_extrapolated_bin"> 
     343<tt class="descname">_get_extrapolated_bin</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer._get_extrapolated_bin" title="Permalink to this definition">¶</a></dt> 
     344<dd><p>Get extrapolated first bin and the last bin</p> 
     345<p>: param first_bin: unextrapolated first_bin 
     346: param last_bin: unextrapolated last_bin</p> 
     347<p>: return first_bin, last_bin: extrapolated first and last bin</p> 
     348</dd></dl> 
     349 
     350<dl class="method"> 
     351<dt id="sans.models.qsmearing.SlitSmearer._get_unextrapolated_bin"> 
     352<tt class="descname">_get_unextrapolated_bin</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer._get_unextrapolated_bin" title="Permalink to this definition">¶</a></dt> 
     353<dd><p>Get unextrapolated first bin and the last bin</p> 
     354<p>: param first_bin: extrapolated first_bin 
     355: param last_bin: extrapolated last_bin</p> 
     356<p>: return fist_bin, last_bin: unextrapolated first and last bin</p> 
     357</dd></dl> 
     358 
     359<dl class="method"> 
     360<dt id="sans.models.qsmearing.SlitSmearer._initialize_smearer"> 
     361<tt class="descname">_initialize_smearer</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer._initialize_smearer" title="Permalink to this definition">¶</a></dt> 
     362<dd><p>Initialize the C++ smearer object. 
     363This method HAS to be called before smearing</p> 
     364</dd></dl> 
     365 
     366<dl class="method"> 
    98367<dt id="sans.models.qsmearing.SlitSmearer.get_bin_range"> 
    99 <tt class="descname">get_bin_range</tt><big>(</big><em>q_min=None</em>, <em>q_max=None</em><big>)</big><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer.get_bin_range" title="Permalink to this definition">¶</a></dt> 
     368<tt class="descname">get_bin_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer.get_bin_range" title="Permalink to this definition">¶</a></dt> 
    100369<dd><table class="docutils field-list" frame="void" rules="none"> 
    101370<col class="field-name" /> 
    102371<col class="field-body" /> 
    103372<tbody valign="top"> 
    104 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     373<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    105374<li><strong>q_min</strong> &#8211; minimum q-value to smear</li> 
    106375<li><strong>q_max</strong> &#8211; maximum q-value to smear</li> 
    … …  
    114383<dl class="method"> 
    115384<dt id="sans.models.qsmearing.SlitSmearer.get_unsmeared_range"> 
    116 <tt class="descname">get_unsmeared_range</tt><big>(</big><em>q_min</em>, <em>q_max</em><big>)</big><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer.get_unsmeared_range" title="Permalink to this definition">¶</a></dt> 
     385<tt class="descname">get_unsmeared_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.SlitSmearer.get_unsmeared_range" title="Permalink to this definition">¶</a></dt> 
    117386<dd><p>Determine the range needed in unsmeared-Q to cover 
    118387the smeared Q range</p> 
    … …  
    121390</dd></dl> 
    122391 
     392<dl class="class"> 
     393<dt id="sans.models.qsmearing._BaseSmearer"> 
     394<em class="property">class </em><tt class="descclassname">sans.models.qsmearing.</tt><tt class="descname">_BaseSmearer</tt><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer" title="Permalink to this definition">¶</a></dt> 
     395<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> 
     396<dl class="method"> 
     397<dt id="sans.models.qsmearing._BaseSmearer.__call__"> 
     398<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer.__call__" title="Permalink to this definition">¶</a></dt> 
     399<dd><p>Perform smearing</p> 
     400</dd></dl> 
     401 
     402<dl class="attribute"> 
     403<dt id="sans.models.qsmearing._BaseSmearer.__class__"> 
     404<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer.__class__" title="Permalink to this definition">¶</a></dt> 
     405<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     406</dd></dl> 
     407 
     408<dl class="method"> 
     409<dt id="sans.models.qsmearing._BaseSmearer.__deepcopy__"> 
     410<tt class="descname">__deepcopy__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer.__deepcopy__" title="Permalink to this definition">¶</a></dt> 
     411<dd><p>Return a valid copy of self. 
     412Avoid copying the _smearer C object and force a matrix recompute 
     413when the copy is used.</p> 
     414</dd></dl> 
     415 
     416<dl class="attribute"> 
     417<dt id="sans.models.qsmearing._BaseSmearer.__delattr__"> 
     418<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer.__delattr__" title="Permalink to this definition">¶</a></dt> 
     419<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     420</dd></dl> 
     421 
     422<dl class="attribute"> 
     423<dt id="sans.models.qsmearing._BaseSmearer.__dict__"> 
     424<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x026EAB70&gt;</em><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer.__dict__" title="Permalink to this definition">¶</a></dt> 
     425<dd></dd></dl> 
     426 
     427<dl class="attribute"> 
     428<dt id="sans.models.qsmearing._BaseSmearer.__getattribute__"> 
     429<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     430<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     431</dd></dl> 
     432 
     433<dl class="attribute"> 
     434<dt id="sans.models.qsmearing._BaseSmearer.__hash__"> 
     435<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer.__hash__" title="Permalink to this definition">¶</a></dt> 
     436<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     437</dd></dl> 
     438 
     439<dl class="method"> 
     440<dt id="sans.models.qsmearing._BaseSmearer.__init__"> 
     441<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer.__init__" title="Permalink to this definition">¶</a></dt> 
     442<dd></dd></dl> 
     443 
     444<dl class="attribute"> 
     445<dt id="sans.models.qsmearing._BaseSmearer.__module__"> 
     446<tt class="descname">__module__</tt><em class="property"> = 'sans.models.qsmearing'</em><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer.__module__" title="Permalink to this definition">¶</a></dt> 
     447<dd></dd></dl> 
     448 
     449<dl class="staticmethod"> 
     450<dt id="sans.models.qsmearing._BaseSmearer.__new__"> 
     451<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.qsmearing._BaseSmearer.__new__" title="Permalink to this definition">¶</a></dt> 
     452<dd></dd></dl> 
     453 
     454<dl class="method"> 
     455<dt id="sans.models.qsmearing._BaseSmearer.__reduce__"> 
     456<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer.__reduce__" title="Permalink to this definition">¶</a></dt> 
     457<dd><p>helper for pickle</p> 
     458</dd></dl> 
     459 
     460<dl class="method"> 
     461<dt id="sans.models.qsmearing._BaseSmearer.__reduce_ex__"> 
     462<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     463<dd><p>helper for pickle</p> 
     464</dd></dl> 
     465 
     466<dl class="attribute"> 
     467<dt id="sans.models.qsmearing._BaseSmearer.__repr__"> 
     468<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer.__repr__" title="Permalink to this definition">¶</a></dt> 
     469<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     470</dd></dl> 
     471 
     472<dl class="attribute"> 
     473<dt id="sans.models.qsmearing._BaseSmearer.__setattr__"> 
     474<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer.__setattr__" title="Permalink to this definition">¶</a></dt> 
     475<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     476</dd></dl> 
     477 
     478<dl class="attribute"> 
     479<dt id="sans.models.qsmearing._BaseSmearer.__str__"> 
     480<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer.__str__" title="Permalink to this definition">¶</a></dt> 
     481<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     482</dd></dl> 
     483 
     484<dl class="attribute"> 
     485<dt id="sans.models.qsmearing._BaseSmearer.__weakref__"> 
     486<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer.__weakref__" title="Permalink to this definition">¶</a></dt> 
     487<dd><p>list of weak references to the object (if defined)</p> 
     488</dd></dl> 
     489 
     490<dl class="method"> 
     491<dt id="sans.models.qsmearing._BaseSmearer._compute_matrix"> 
     492<tt class="descname">_compute_matrix</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer._compute_matrix" title="Permalink to this definition">¶</a></dt> 
     493<dd></dd></dl> 
     494 
     495<dl class="method"> 
     496<dt id="sans.models.qsmearing._BaseSmearer._get_extrapolated_bin"> 
     497<tt class="descname">_get_extrapolated_bin</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer._get_extrapolated_bin" title="Permalink to this definition">¶</a></dt> 
     498<dd><p>Get extrapolated first bin and the last bin</p> 
     499<p>: param first_bin: unextrapolated first_bin 
     500: param last_bin: unextrapolated last_bin</p> 
     501<p>: return first_bin, last_bin: extrapolated first and last bin</p> 
     502</dd></dl> 
     503 
     504<dl class="method"> 
     505<dt id="sans.models.qsmearing._BaseSmearer._get_unextrapolated_bin"> 
     506<tt class="descname">_get_unextrapolated_bin</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer._get_unextrapolated_bin" title="Permalink to this definition">¶</a></dt> 
     507<dd><p>Get unextrapolated first bin and the last bin</p> 
     508<p>: param first_bin: extrapolated first_bin 
     509: param last_bin: extrapolated last_bin</p> 
     510<p>: return fist_bin, last_bin: unextrapolated first and last bin</p> 
     511</dd></dl> 
     512 
     513<dl class="method"> 
     514<dt id="sans.models.qsmearing._BaseSmearer._initialize_smearer"> 
     515<tt class="descname">_initialize_smearer</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer._initialize_smearer" title="Permalink to this definition">¶</a></dt> 
     516<dd></dd></dl> 
     517 
     518<dl class="method"> 
     519<dt id="sans.models.qsmearing._BaseSmearer.get_bin_range"> 
     520<tt class="descname">get_bin_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._BaseSmearer.get_bin_range" title="Permalink to this definition">¶</a></dt> 
     521<dd><table class="docutils field-list" frame="void" rules="none"> 
     522<col class="field-name" /> 
     523<col class="field-body" /> 
     524<tbody valign="top"> 
     525<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     526<li><strong>q_min</strong> &#8211; minimum q-value to smear</li> 
     527<li><strong>q_max</strong> &#8211; maximum q-value to smear</li> 
     528</ul> 
     529</td> 
     530</tr> 
     531</tbody> 
     532</table> 
     533</dd></dl> 
     534 
     535</dd></dl> 
     536 
     537<dl class="class"> 
     538<dt id="sans.models.qsmearing._QSmearer"> 
     539<em class="property">class </em><tt class="descclassname">sans.models.qsmearing.</tt><tt class="descname">_QSmearer</tt><a class="headerlink" href="#sans.models.qsmearing._QSmearer" title="Permalink to this definition">¶</a></dt> 
     540<dd><p>Bases: <a class="reference internal" href="#sans.models.qsmearing._BaseSmearer" title="sans.models.qsmearing._BaseSmearer"><tt class="xref py py-class docutils literal"><span class="pre">sans.models.qsmearing._BaseSmearer</span></tt></a></p> 
     541<p>Perform Gaussian Q smearing</p> 
     542<dl class="method"> 
     543<dt id="sans.models.qsmearing._QSmearer.__call__"> 
     544<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._QSmearer.__call__" title="Permalink to this definition">¶</a></dt> 
     545<dd><p>Perform smearing</p> 
     546</dd></dl> 
     547 
     548<dl class="attribute"> 
     549<dt id="sans.models.qsmearing._QSmearer.__class__"> 
     550<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.qsmearing._QSmearer.__class__" title="Permalink to this definition">¶</a></dt> 
     551<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     552</dd></dl> 
     553 
     554<dl class="method"> 
     555<dt id="sans.models.qsmearing._QSmearer.__deepcopy__"> 
     556<tt class="descname">__deepcopy__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._QSmearer.__deepcopy__" title="Permalink to this definition">¶</a></dt> 
     557<dd><p>Return a valid copy of self. 
     558Avoid copying the _smearer C object and force a matrix recompute 
     559when the copy is used.</p> 
     560</dd></dl> 
     561 
     562<dl class="attribute"> 
     563<dt id="sans.models.qsmearing._QSmearer.__delattr__"> 
     564<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.qsmearing._QSmearer.__delattr__" title="Permalink to this definition">¶</a></dt> 
     565<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     566</dd></dl> 
     567 
     568<dl class="attribute"> 
     569<dt id="sans.models.qsmearing._QSmearer.__dict__"> 
     570<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x02933890&gt;</em><a class="headerlink" href="#sans.models.qsmearing._QSmearer.__dict__" title="Permalink to this definition">¶</a></dt> 
     571<dd></dd></dl> 
     572 
     573<dl class="attribute"> 
     574<dt id="sans.models.qsmearing._QSmearer.__getattribute__"> 
     575<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.qsmearing._QSmearer.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     576<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     577</dd></dl> 
     578 
     579<dl class="attribute"> 
     580<dt id="sans.models.qsmearing._QSmearer.__hash__"> 
     581<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.qsmearing._QSmearer.__hash__" title="Permalink to this definition">¶</a></dt> 
     582<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     583</dd></dl> 
     584 
     585<dl class="method"> 
     586<dt id="sans.models.qsmearing._QSmearer.__init__"> 
     587<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._QSmearer.__init__" title="Permalink to this definition">¶</a></dt> 
     588<dd><p>Initialization</p> 
     589<table class="docutils field-list" frame="void" rules="none"> 
     590<col class="field-name" /> 
     591<col class="field-body" /> 
     592<tbody valign="top"> 
     593<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     594<li><strong>nbins</strong> &#8211; number of Q bins</li> 
     595<li><strong>width</strong> &#8211; array standard deviation in Q [A-1]</li> 
     596<li><strong>min</strong> &#8211; Q_min [A-1]</li> 
     597<li><strong>max</strong> &#8211; Q_max [A-1]</li> 
     598</ul> 
     599</td> 
     600</tr> 
     601</tbody> 
     602</table> 
     603</dd></dl> 
     604 
     605<dl class="attribute"> 
     606<dt id="sans.models.qsmearing._QSmearer.__module__"> 
     607<tt class="descname">__module__</tt><em class="property"> = 'sans.models.qsmearing'</em><a class="headerlink" href="#sans.models.qsmearing._QSmearer.__module__" title="Permalink to this definition">¶</a></dt> 
     608<dd></dd></dl> 
     609 
     610<dl class="staticmethod"> 
     611<dt id="sans.models.qsmearing._QSmearer.__new__"> 
     612<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.qsmearing._QSmearer.__new__" title="Permalink to this definition">¶</a></dt> 
     613<dd></dd></dl> 
     614 
     615<dl class="method"> 
     616<dt id="sans.models.qsmearing._QSmearer.__reduce__"> 
     617<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._QSmearer.__reduce__" title="Permalink to this definition">¶</a></dt> 
     618<dd><p>helper for pickle</p> 
     619</dd></dl> 
     620 
     621<dl class="method"> 
     622<dt id="sans.models.qsmearing._QSmearer.__reduce_ex__"> 
     623<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._QSmearer.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     624<dd><p>helper for pickle</p> 
     625</dd></dl> 
     626 
     627<dl class="attribute"> 
     628<dt id="sans.models.qsmearing._QSmearer.__repr__"> 
     629<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.qsmearing._QSmearer.__repr__" title="Permalink to this definition">¶</a></dt> 
     630<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     631</dd></dl> 
     632 
     633<dl class="attribute"> 
     634<dt id="sans.models.qsmearing._QSmearer.__setattr__"> 
     635<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.qsmearing._QSmearer.__setattr__" title="Permalink to this definition">¶</a></dt> 
     636<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     637</dd></dl> 
     638 
     639<dl class="attribute"> 
     640<dt id="sans.models.qsmearing._QSmearer.__str__"> 
     641<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.qsmearing._QSmearer.__str__" title="Permalink to this definition">¶</a></dt> 
     642<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     643</dd></dl> 
     644 
     645<dl class="attribute"> 
     646<dt id="sans.models.qsmearing._QSmearer.__weakref__"> 
     647<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.qsmearing._QSmearer.__weakref__" title="Permalink to this definition">¶</a></dt> 
     648<dd><p>list of weak references to the object (if defined)</p> 
     649</dd></dl> 
     650 
     651<dl class="method"> 
     652<dt id="sans.models.qsmearing._QSmearer._compute_matrix"> 
     653<tt class="descname">_compute_matrix</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._QSmearer._compute_matrix" title="Permalink to this definition">¶</a></dt> 
     654<dd></dd></dl> 
     655 
     656<dl class="method"> 
     657<dt id="sans.models.qsmearing._QSmearer._get_extrapolated_bin"> 
     658<tt class="descname">_get_extrapolated_bin</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._QSmearer._get_extrapolated_bin" title="Permalink to this definition">¶</a></dt> 
     659<dd><p>Get extrapolated first bin and the last bin</p> 
     660<p>: param first_bin: unextrapolated first_bin 
     661: param last_bin: unextrapolated last_bin</p> 
     662<p>: return first_bin, last_bin: extrapolated first and last bin</p> 
     663</dd></dl> 
     664 
     665<dl class="method"> 
     666<dt id="sans.models.qsmearing._QSmearer._get_unextrapolated_bin"> 
     667<tt class="descname">_get_unextrapolated_bin</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._QSmearer._get_unextrapolated_bin" title="Permalink to this definition">¶</a></dt> 
     668<dd><p>Get unextrapolated first bin and the last bin</p> 
     669<p>: param first_bin: extrapolated first_bin 
     670: param last_bin: extrapolated last_bin</p> 
     671<p>: return fist_bin, last_bin: unextrapolated first and last bin</p> 
     672</dd></dl> 
     673 
     674<dl class="method"> 
     675<dt id="sans.models.qsmearing._QSmearer._initialize_smearer"> 
     676<tt class="descname">_initialize_smearer</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._QSmearer._initialize_smearer" title="Permalink to this definition">¶</a></dt> 
     677<dd><p>Initialize the C++ smearer object. 
     678This method HAS to be called before smearing</p> 
     679</dd></dl> 
     680 
     681<dl class="method"> 
     682<dt id="sans.models.qsmearing._QSmearer.get_bin_range"> 
     683<tt class="descname">get_bin_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._QSmearer.get_bin_range" title="Permalink to this definition">¶</a></dt> 
     684<dd><table class="docutils field-list" frame="void" rules="none"> 
     685<col class="field-name" /> 
     686<col class="field-body" /> 
     687<tbody valign="top"> 
     688<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     689<li><strong>q_min</strong> &#8211; minimum q-value to smear</li> 
     690<li><strong>q_max</strong> &#8211; maximum q-value to smear</li> 
     691</ul> 
     692</td> 
     693</tr> 
     694</tbody> 
     695</table> 
     696</dd></dl> 
     697 
     698<dl class="method"> 
     699<dt id="sans.models.qsmearing._QSmearer.get_unsmeared_range"> 
     700<tt class="descname">get_unsmeared_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._QSmearer.get_unsmeared_range" title="Permalink to this definition">¶</a></dt> 
     701<dd><p>Determine the range needed in unsmeared-Q to cover 
     702the smeared Q range 
     703Take 3 sigmas as the offset between smeared and unsmeared space</p> 
     704</dd></dl> 
     705 
     706</dd></dl> 
     707 
     708<dl class="class"> 
     709<dt id="sans.models.qsmearing._SlitSmearer"> 
     710<em class="property">class </em><tt class="descclassname">sans.models.qsmearing.</tt><tt class="descname">_SlitSmearer</tt><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer" title="Permalink to this definition">¶</a></dt> 
     711<dd><p>Bases: <a class="reference internal" href="#sans.models.qsmearing._BaseSmearer" title="sans.models.qsmearing._BaseSmearer"><tt class="xref py py-class docutils literal"><span class="pre">sans.models.qsmearing._BaseSmearer</span></tt></a></p> 
     712<p>Slit smearing for I(q) array</p> 
     713<dl class="method"> 
     714<dt id="sans.models.qsmearing._SlitSmearer.__call__"> 
     715<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer.__call__" title="Permalink to this definition">¶</a></dt> 
     716<dd><p>Perform smearing</p> 
     717</dd></dl> 
     718 
     719<dl class="attribute"> 
     720<dt id="sans.models.qsmearing._SlitSmearer.__class__"> 
     721<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer.__class__" title="Permalink to this definition">¶</a></dt> 
     722<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p> 
     723</dd></dl> 
     724 
     725<dl class="method"> 
     726<dt id="sans.models.qsmearing._SlitSmearer.__deepcopy__"> 
     727<tt class="descname">__deepcopy__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer.__deepcopy__" title="Permalink to this definition">¶</a></dt> 
     728<dd><p>Return a valid copy of self. 
     729Avoid copying the _smearer C object and force a matrix recompute 
     730when the copy is used.</p> 
     731</dd></dl> 
     732 
     733<dl class="attribute"> 
     734<dt id="sans.models.qsmearing._SlitSmearer.__delattr__"> 
     735<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer.__delattr__" title="Permalink to this definition">¶</a></dt> 
     736<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p> 
     737</dd></dl> 
     738 
     739<dl class="attribute"> 
     740<dt id="sans.models.qsmearing._SlitSmearer.__dict__"> 
     741<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01926250&gt;</em><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer.__dict__" title="Permalink to this definition">¶</a></dt> 
     742<dd></dd></dl> 
     743 
     744<dl class="attribute"> 
     745<dt id="sans.models.qsmearing._SlitSmearer.__getattribute__"> 
     746<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer.__getattribute__" title="Permalink to this definition">¶</a></dt> 
     747<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p> 
     748</dd></dl> 
     749 
     750<dl class="attribute"> 
     751<dt id="sans.models.qsmearing._SlitSmearer.__hash__"> 
     752<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer.__hash__" title="Permalink to this definition">¶</a></dt> 
     753<dd><p>x.__hash__() &lt;==&gt; hash(x)</p> 
     754</dd></dl> 
     755 
     756<dl class="method"> 
     757<dt id="sans.models.qsmearing._SlitSmearer.__init__"> 
     758<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer.__init__" title="Permalink to this definition">¶</a></dt> 
     759<dd><p>Initialization</p> 
     760<table class="docutils field-list" frame="void" rules="none"> 
     761<col class="field-name" /> 
     762<col class="field-body" /> 
     763<tbody valign="top"> 
     764<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     765<li><strong>iq</strong> &#8211; I(q) array [cm-1]</li> 
     766<li><strong>width</strong> &#8211; slit width [A-1]</li> 
     767<li><strong>height</strong> &#8211; slit height [A-1]</li> 
     768<li><strong>min</strong> &#8211; Q_min [A-1]</li> 
     769<li><strong>max</strong> &#8211; Q_max [A-1]</li> 
     770</ul> 
     771</td> 
     772</tr> 
     773</tbody> 
     774</table> 
     775</dd></dl> 
     776 
     777<dl class="attribute"> 
     778<dt id="sans.models.qsmearing._SlitSmearer.__module__"> 
     779<tt class="descname">__module__</tt><em class="property"> = 'sans.models.qsmearing'</em><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer.__module__" title="Permalink to this definition">¶</a></dt> 
     780<dd></dd></dl> 
     781 
     782<dl class="staticmethod"> 
     783<dt id="sans.models.qsmearing._SlitSmearer.__new__"> 
     784<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.qsmearing._SlitSmearer.__new__" title="Permalink to this definition">¶</a></dt> 
     785<dd></dd></dl> 
     786 
     787<dl class="method"> 
     788<dt id="sans.models.qsmearing._SlitSmearer.__reduce__"> 
     789<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer.__reduce__" title="Permalink to this definition">¶</a></dt> 
     790<dd><p>helper for pickle</p> 
     791</dd></dl> 
     792 
     793<dl class="method"> 
     794<dt id="sans.models.qsmearing._SlitSmearer.__reduce_ex__"> 
     795<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer.__reduce_ex__" title="Permalink to this definition">¶</a></dt> 
     796<dd><p>helper for pickle</p> 
     797</dd></dl> 
     798 
     799<dl class="attribute"> 
     800<dt id="sans.models.qsmearing._SlitSmearer.__repr__"> 
     801<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer.__repr__" title="Permalink to this definition">¶</a></dt> 
     802<dd><p>x.__repr__() &lt;==&gt; repr(x)</p> 
     803</dd></dl> 
     804 
     805<dl class="attribute"> 
     806<dt id="sans.models.qsmearing._SlitSmearer.__setattr__"> 
     807<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer.__setattr__" title="Permalink to this definition">¶</a></dt> 
     808<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p> 
     809</dd></dl> 
     810 
     811<dl class="attribute"> 
     812<dt id="sans.models.qsmearing._SlitSmearer.__str__"> 
     813<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer.__str__" title="Permalink to this definition">¶</a></dt> 
     814<dd><p>x.__str__() &lt;==&gt; str(x)</p> 
     815</dd></dl> 
     816 
     817<dl class="attribute"> 
     818<dt id="sans.models.qsmearing._SlitSmearer.__weakref__"> 
     819<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer.__weakref__" title="Permalink to this definition">¶</a></dt> 
     820<dd><p>list of weak references to the object (if defined)</p> 
     821</dd></dl> 
     822 
     823<dl class="method"> 
     824<dt id="sans.models.qsmearing._SlitSmearer._compute_matrix"> 
     825<tt class="descname">_compute_matrix</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer._compute_matrix" title="Permalink to this definition">¶</a></dt> 
     826<dd></dd></dl> 
     827 
     828<dl class="method"> 
     829<dt id="sans.models.qsmearing._SlitSmearer._get_extrapolated_bin"> 
     830<tt class="descname">_get_extrapolated_bin</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer._get_extrapolated_bin" title="Permalink to this definition">¶</a></dt> 
     831<dd><p>Get extrapolated first bin and the last bin</p> 
     832<p>: param first_bin: unextrapolated first_bin 
     833: param last_bin: unextrapolated last_bin</p> 
     834<p>: return first_bin, last_bin: extrapolated first and last bin</p> 
     835</dd></dl> 
     836 
     837<dl class="method"> 
     838<dt id="sans.models.qsmearing._SlitSmearer._get_unextrapolated_bin"> 
     839<tt class="descname">_get_unextrapolated_bin</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer._get_unextrapolated_bin" title="Permalink to this definition">¶</a></dt> 
     840<dd><p>Get unextrapolated first bin and the last bin</p> 
     841<p>: param first_bin: extrapolated first_bin 
     842: param last_bin: extrapolated last_bin</p> 
     843<p>: return fist_bin, last_bin: unextrapolated first and last bin</p> 
     844</dd></dl> 
     845 
     846<dl class="method"> 
     847<dt id="sans.models.qsmearing._SlitSmearer._initialize_smearer"> 
     848<tt class="descname">_initialize_smearer</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer._initialize_smearer" title="Permalink to this definition">¶</a></dt> 
     849<dd><p>Initialize the C++ smearer object. 
     850This method HAS to be called before smearing</p> 
     851</dd></dl> 
     852 
     853<dl class="method"> 
     854<dt id="sans.models.qsmearing._SlitSmearer.get_bin_range"> 
     855<tt class="descname">get_bin_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer.get_bin_range" title="Permalink to this definition">¶</a></dt> 
     856<dd><table class="docutils field-list" frame="void" rules="none"> 
     857<col class="field-name" /> 
     858<col class="field-body" /> 
     859<tbody valign="top"> 
     860<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     861<li><strong>q_min</strong> &#8211; minimum q-value to smear</li> 
     862<li><strong>q_max</strong> &#8211; maximum q-value to smear</li> 
     863</ul> 
     864</td> 
     865</tr> 
     866</tbody> 
     867</table> 
     868</dd></dl> 
     869 
     870<dl class="method"> 
     871<dt id="sans.models.qsmearing._SlitSmearer.get_unsmeared_range"> 
     872<tt class="descname">get_unsmeared_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing._SlitSmearer.get_unsmeared_range" title="Permalink to this definition">¶</a></dt> 
     873<dd><p>Determine the range needed in unsmeared-Q to cover 
     874the smeared Q range</p> 
     875</dd></dl> 
     876 
     877</dd></dl> 
     878 
    123879<dl class="function"> 
    124880<dt id="sans.models.qsmearing.get_qextrapolate"> 
    125 <tt class="descclassname">sans.models.qsmearing.</tt><tt class="descname">get_qextrapolate</tt><big>(</big><em>width</em>, <em>data_x</em><big>)</big><a class="headerlink" href="#sans.models.qsmearing.get_qextrapolate" title="Permalink to this definition">¶</a></dt> 
     881<tt class="descclassname">sans.models.qsmearing.</tt><tt class="descname">get_qextrapolate</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.get_qextrapolate" title="Permalink to this definition">¶</a></dt> 
    126882<dd><p>Make fake data_x points extrapolated outside of the data_x points</p> 
    127883<p>: param width: array of std of q resolution 
    … …  
    141897<dl class="function"> 
    142898<dt id="sans.models.qsmearing.smear_selection"> 
    143 <tt class="descclassname">sans.models.qsmearing.</tt><tt class="descname">smear_selection</tt><big>(</big><em>data1D</em>, <em>model=None</em><big>)</big><a class="headerlink" href="#sans.models.qsmearing.smear_selection" title="Permalink to this definition">¶</a></dt> 
     899<tt class="descclassname">sans.models.qsmearing.</tt><tt class="descname">smear_selection</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.qsmearing.smear_selection" title="Permalink to this definition">¶</a></dt> 
    144900<dd><p>Creates the right type of smearer according  
    145901to the data.</p> 
    … …  
    156912<col class="field-body" /> 
    157913<tbody valign="top"> 
    158 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
     914<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> 
    159915<li><strong>data1D</strong> &#8211; Data1D object</li> 
    160916<li><strong>model</strong> &#8211; sans.model instance</li> 
    … …  
    178934  <ul> 
    179935<li><a class="reference internal" href="#">qsmearing</a><ul> 
    180 <li><a class="reference internal" href="#module-sans.models.qsmearing"><tt class="docutils literal"><span class="pre">sans.models.qsmearing</span></tt></a></li> 
     936<li><a class="reference internal" href="#sans-models-qsmearing"><tt class="docutils literal"><span class="pre">sans.models.qsmearing</span></tt></a></li> 
    181937</ul> 
    182938</li> 
    … …  
    197953  <h3>Quick search</h3> 
    198954    <form class="search" action="../search.html" method="get"> 
    199       <input type="text" name="q" size="18" /> 
     955      <input type="text" name="q" /> 
    200956      <input type="submit" value="Go" /> 
    201957      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    226982          <a href="ProlateModel.html" title="ProlateModel" 
    227983             >previous</a> |</li> 
    228         <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li> 
     984        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li> 
    229985          <li><a href="index.html" >Reference</a> &raquo;</li>  
    230986      </ul> 
    … …  
    232988    <div class="footer"> 
    233989        &copy; Copyright 2010, sans group. 
    234       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     990      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    235991    </div> 
    236992  </body> 
Note: See TracChangeset for help on using the changeset viewer.