source: sasview/DataLoader/docs/sphinx/_build/html/api/qsmearing.html @ 0997158f

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 0997158f was 0997158f, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on documentation
  • Property mode set to 100644
File size: 9.3 KB
RevLine 
[0997158f]1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>qsmearing &mdash; DataLoader v0.1.0 documentation</title>
11    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13    <script type="text/javascript">
14      var DOCUMENTATION_OPTIONS = {
15        URL_ROOT:    '../',
16        VERSION:     '0.1.0',
17        COLLAPSE_INDEX: false,
18        FILE_SUFFIX: '.html',
19        HAS_SOURCE:  true
20      };
21    </script>
22    <script type="text/javascript" src="../_static/jquery.js"></script>
23    <script type="text/javascript" src="../_static/underscore.js"></script>
24    <script type="text/javascript" src="../_static/doctools.js"></script>
25    <link rel="top" title="DataLoader v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="next" title="smearing_2d" href="smearing_2d.html" />
28    <link rel="prev" title="manipulations" href="manipulations.html" /> 
29  </head>
30  <body>
31    <div class="related">
32      <h3>Navigation</h3>
33      <ul>
34        <li class="right" style="margin-right: 10px">
35          <a href="../genindex.html" title="General Index"
36             accesskey="I">index</a></li>
37        <li class="right" >
38          <a href="../py-modindex.html" title="Python Module Index"
39             >modules</a> |</li>
40        <li class="right" >
41          <a href="smearing_2d.html" title="smearing_2d"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="manipulations.html" title="manipulations"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li>
47          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
48      </ul>
49    </div> 
50
51    <div class="document">
52      <div class="documentwrapper">
53        <div class="bodywrapper">
54          <div class="body">
55           
56  <div class="section" id="qsmearing">
57<h1>qsmearing<a class="headerlink" href="#qsmearing" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-DataLoader.qsmearing">
59<span id="dataloader-qsmearing"></span><h2><a class="reference internal" href="#module-DataLoader.qsmearing"><tt class="xref py py-mod docutils literal"><span class="pre">DataLoader.qsmearing</span></tt></a><a class="headerlink" href="#module-DataLoader.qsmearing" title="Permalink to this headline">¶</a></h2>
60<dl class="class">
61<dt id="DataLoader.qsmearing.QSmearer">
62<em class="property">class </em><tt class="descclassname">DataLoader.qsmearing.</tt><tt class="descname">QSmearer</tt><big>(</big><em>data1D</em><big>)</big><a class="headerlink" href="#DataLoader.qsmearing.QSmearer" title="Permalink to this definition">¶</a></dt>
63<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">DataLoader.qsmearing._QSmearer</span></tt></p>
64<p>Adaptor for Gaussian Q smearing class and SANS data</p>
65<dl class="method">
66<dt id="DataLoader.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="#DataLoader.qsmearing.QSmearer.get_bin_range" title="Permalink to this definition">¶</a></dt>
68<dd><table class="docutils field-list" frame="void" rules="none">
69<col class="field-name" />
70<col class="field-body" />
71<tbody valign="top">
72<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
73<li><strong>q_min</strong> &#8211; minimum q-value to smear</li>
74<li><strong>q_max</strong> &#8211; maximum q-value to smear</li>
75</ul>
76</td>
77</tr>
78</tbody>
79</table>
80</dd></dl>
81
82<dl class="method">
83<dt id="DataLoader.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="#DataLoader.qsmearing.QSmearer.get_unsmeared_range" title="Permalink to this definition">¶</a></dt>
85<dd>Determine the range needed in unsmeared-Q to cover
86the smeared Q range
87Take 3 sigmas as the offset between smeared and unsmeared space</dd></dl>
88
89</dd></dl>
90
91<dl class="class">
92<dt id="DataLoader.qsmearing.SlitSmearer">
93<em class="property">class </em><tt class="descclassname">DataLoader.qsmearing.</tt><tt class="descname">SlitSmearer</tt><big>(</big><em>data1D</em><big>)</big><a class="headerlink" href="#DataLoader.qsmearing.SlitSmearer" title="Permalink to this definition">¶</a></dt>
94<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">DataLoader.qsmearing._SlitSmearer</span></tt></p>
95<p>Adaptor for slit smearing class and SANS data</p>
96<dl class="method">
97<dt id="DataLoader.qsmearing.SlitSmearer.get_bin_range">
98<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="#DataLoader.qsmearing.SlitSmearer.get_bin_range" title="Permalink to this definition">¶</a></dt>
99<dd><table class="docutils field-list" frame="void" rules="none">
100<col class="field-name" />
101<col class="field-body" />
102<tbody valign="top">
103<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
104<li><strong>q_min</strong> &#8211; minimum q-value to smear</li>
105<li><strong>q_max</strong> &#8211; maximum q-value to smear</li>
106</ul>
107</td>
108</tr>
109</tbody>
110</table>
111</dd></dl>
112
113<dl class="method">
114<dt id="DataLoader.qsmearing.SlitSmearer.get_unsmeared_range">
115<tt class="descname">get_unsmeared_range</tt><big>(</big><em>q_min</em>, <em>q_max</em><big>)</big><a class="headerlink" href="#DataLoader.qsmearing.SlitSmearer.get_unsmeared_range" title="Permalink to this definition">¶</a></dt>
116<dd>Determine the range needed in unsmeared-Q to cover
117the smeared Q range</dd></dl>
118
119</dd></dl>
120
121<dl class="function">
122<dt id="DataLoader.qsmearing.smear_selection">
123<tt class="descclassname">DataLoader.qsmearing.</tt><tt class="descname">smear_selection</tt><big>(</big><em>data1D</em><big>)</big><a class="headerlink" href="#DataLoader.qsmearing.smear_selection" title="Permalink to this definition">¶</a></dt>
124<dd><p>Creates the right type of smearer according
125to the data.</p>
126<p>The canSAS format has a rule that either
127slit smearing data OR resolution smearing data
128is available.</p>
129<p>For the present purpose, we choose the one that
130has none-zero data. If both slit and resolution
131smearing arrays are filled with good data
132(which should not happen), then we choose the
133resolution smearing data.</p>
134<table class="docutils field-list" frame="void" rules="none">
135<col class="field-name" />
136<col class="field-body" />
137<tbody valign="top">
138<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
139<li><strong>data1D</strong> &#8211; Data1D object</li>
140</ul>
141</td>
142</tr>
143</tbody>
144</table>
145</dd></dl>
146
147</div>
148</div>
149
150
151          </div>
152        </div>
153      </div>
154      <div class="sphinxsidebar">
155        <div class="sphinxsidebarwrapper">
156  <h3><a href="../index.html">Table Of Contents</a></h3>
157  <ul>
158<li><a class="reference internal" href="#">qsmearing</a><ul>
159<li><a class="reference internal" href="#module-DataLoader.qsmearing"><tt class="docutils literal"><span class="pre">DataLoader.qsmearing</span></tt></a></li>
160</ul>
161</li>
162</ul>
163
164  <h4>Previous topic</h4>
165  <p class="topless"><a href="manipulations.html"
166                        title="previous chapter">manipulations</a></p>
167  <h4>Next topic</h4>
168  <p class="topless"><a href="smearing_2d.html"
169                        title="next chapter">smearing_2d</a></p>
170  <h3>This Page</h3>
171  <ul class="this-page-menu">
172    <li><a href="../_sources/api/qsmearing.txt"
173           rel="nofollow">Show Source</a></li>
174  </ul>
175<div id="searchbox" style="display: none">
176  <h3>Quick search</h3>
177    <form class="search" action="../search.html" method="get">
178      <input type="text" name="q" size="18" />
179      <input type="submit" value="Go" />
180      <input type="hidden" name="check_keywords" value="yes" />
181      <input type="hidden" name="area" value="default" />
182    </form>
183    <p class="searchtip" style="font-size: 90%">
184    Enter search terms or a module, class or function name.
185    </p>
186</div>
187<script type="text/javascript">$('#searchbox').show(0);</script>
188        </div>
189      </div>
190      <div class="clearer"></div>
191    </div>
192    <div class="related">
193      <h3>Navigation</h3>
194      <ul>
195        <li class="right" style="margin-right: 10px">
196          <a href="../genindex.html" title="General Index"
197             >index</a></li>
198        <li class="right" >
199          <a href="../py-modindex.html" title="Python Module Index"
200             >modules</a> |</li>
201        <li class="right" >
202          <a href="smearing_2d.html" title="smearing_2d"
203             >next</a> |</li>
204        <li class="right" >
205          <a href="manipulations.html" title="manipulations"
206             >previous</a> |</li>
207        <li><a href="../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li>
208          <li><a href="index.html" >Reference</a> &raquo;</li> 
209      </ul>
210    </div>
211    <div class="footer">
212        &copy; Copyright 2010, sans group.
213      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
214    </div>
215  </body>
216</html>
Note: See TracBrowser for help on using the repository browser.