source: sasview/sansmodels/docs/sphinx/html/api/qsmearing.html @ 846c724

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 846c724 was 512573a, checked in by Jessica Tumarkin <jtumarki@…>, 13 years ago

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 10.5 KB
Line 
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; sansmodels 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="sansmodels v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="next" title="ReflAdvModel" href="ReflAdvModel.html" />
28    <link rel="prev" title="ProlateModel" href="ProlateModel.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="ReflAdvModel.html" title="ReflAdvModel"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="ProlateModel.html" title="ProlateModel"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../index.html">sansmodels 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-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<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>
64<p>Adaptor for Gaussian Q smearing class and SANS data</p>
65<dl class="method">
66<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>
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="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>
85<dd><p>Determine the range needed in unsmeared-Q to cover
86the smeared Q range
87Take 3 sigmas as the offset between smeared and unsmeared space</p>
88</dd></dl>
89
90</dd></dl>
91
92<dl class="class">
93<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>
96<p>Adaptor for slit smearing class and SANS data</p>
97<dl class="method">
98<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>
100<dd><table class="docutils field-list" frame="void" rules="none">
101<col class="field-name" />
102<col class="field-body" />
103<tbody valign="top">
104<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
105<li><strong>q_min</strong> &#8211; minimum q-value to smear</li>
106<li><strong>q_max</strong> &#8211; maximum q-value to smear</li>
107</ul>
108</td>
109</tr>
110</tbody>
111</table>
112</dd></dl>
113
114<dl class="method">
115<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>
117<dd><p>Determine the range needed in unsmeared-Q to cover
118the smeared Q range</p>
119</dd></dl>
120
121</dd></dl>
122
123<dl class="function">
124<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>
126<dd><p>Make fake data_x points extrapolated outside of the data_x points</p>
127<p>: param width: array of std of q resolution
128: param Data1D.x: Data1D.x array</p>
129<p>: return new_width, data_x_ext: extrapolated width array and x array</p>
130<p>: assumption1: data_x is ordered from lower q to higher q
131: assumption2: len(data) = len(width)
132: assumption3: the distance between the data points is more compact</p>
133<blockquote>
134<div>than the size of width</div></blockquote>
135<p>: Todo1: Make sure that the assumptions are correct for Data1D
136: Todo2: This fixes the edge problem in Qsmearer but still needs to make</p>
137<blockquote>
138<div>smearer interface</div></blockquote>
139</dd></dl>
140
141<dl class="function">
142<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>
144<dd><p>Creates the right type of smearer according
145to the data.</p>
146<p>The canSAS format has a rule that either
147slit smearing data OR resolution smearing data
148is available.</p>
149<p>For the present purpose, we choose the one that
150has none-zero data. If both slit and resolution
151smearing arrays are filled with good data
152(which should not happen), then we choose the
153resolution smearing data.</p>
154<table class="docutils field-list" frame="void" rules="none">
155<col class="field-name" />
156<col class="field-body" />
157<tbody valign="top">
158<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
159<li><strong>data1D</strong> &#8211; Data1D object</li>
160<li><strong>model</strong> &#8211; sans.model instance</li>
161</ul>
162</td>
163</tr>
164</tbody>
165</table>
166</dd></dl>
167
168</div>
169</div>
170
171
172          </div>
173        </div>
174      </div>
175      <div class="sphinxsidebar">
176        <div class="sphinxsidebarwrapper">
177  <h3><a href="../index.html">Table Of Contents</a></h3>
178  <ul>
179<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>
181</ul>
182</li>
183</ul>
184
185  <h4>Previous topic</h4>
186  <p class="topless"><a href="ProlateModel.html"
187                        title="previous chapter">ProlateModel</a></p>
188  <h4>Next topic</h4>
189  <p class="topless"><a href="ReflAdvModel.html"
190                        title="next chapter">ReflAdvModel</a></p>
191  <h3>This Page</h3>
192  <ul class="this-page-menu">
193    <li><a href="../_sources/api/qsmearing.txt"
194           rel="nofollow">Show Source</a></li>
195  </ul>
196<div id="searchbox" style="display: none">
197  <h3>Quick search</h3>
198    <form class="search" action="../search.html" method="get">
199      <input type="text" name="q" size="18" />
200      <input type="submit" value="Go" />
201      <input type="hidden" name="check_keywords" value="yes" />
202      <input type="hidden" name="area" value="default" />
203    </form>
204    <p class="searchtip" style="font-size: 90%">
205    Enter search terms or a module, class or function name.
206    </p>
207</div>
208<script type="text/javascript">$('#searchbox').show(0);</script>
209        </div>
210      </div>
211      <div class="clearer"></div>
212    </div>
213    <div class="related">
214      <h3>Navigation</h3>
215      <ul>
216        <li class="right" style="margin-right: 10px">
217          <a href="../genindex.html" title="General Index"
218             >index</a></li>
219        <li class="right" >
220          <a href="../py-modindex.html" title="Python Module Index"
221             >modules</a> |</li>
222        <li class="right" >
223          <a href="ReflAdvModel.html" title="ReflAdvModel"
224             >next</a> |</li>
225        <li class="right" >
226          <a href="ProlateModel.html" title="ProlateModel"
227             >previous</a> |</li>
228        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
229          <li><a href="index.html" >Reference</a> &raquo;</li> 
230      </ul>
231    </div>
232    <div class="footer">
233        &copy; Copyright 2010, sans group.
234      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
235    </div>
236  </body>
237</html>
Note: See TracBrowser for help on using the repository browser.