source: sasview/sansmodels/docs/sphinx/html/api/smearing_2d.html @ dbdff5e

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 dbdff5e was c0d873f, checked in by Gervaise Alina <gervyh@…>, 13 years ago

edit docs for models
  • 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
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>smearing_2d &mdash; sansmodels 0.1.0 documentation</title>
12   
13    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '../',
19        VERSION:     '0.1.0',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="../_static/jquery.js"></script>
26    <script type="text/javascript" src="../_static/underscore.js"></script>
27    <script type="text/javascript" src="../_static/doctools.js"></script>
28    <link rel="top" title="sansmodels 0.1.0 documentation" href="../index.html" />
29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="SphereModel" href="SphereModel.html" />
31    <link rel="prev" title="SLDCalFunc" href="SLDCalFunc.html" /> 
32  </head>
33  <body>
34    <div class="related">
35      <h3>Navigation</h3>
36      <ul>
37        <li class="right" style="margin-right: 10px">
38          <a href="../genindex.html" title="General Index"
39             accesskey="I">index</a></li>
40        <li class="right" >
41          <a href="../py-modindex.html" title="Python Module Index"
42             >modules</a> |</li>
43        <li class="right" >
44          <a href="SphereModel.html" title="SphereModel"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="SLDCalFunc.html" title="SLDCalFunc"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
50          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
51      </ul>
52    </div> 
53
54    <div class="document">
55      <div class="documentwrapper">
56        <div class="bodywrapper">
57          <div class="body">
58           
59  <div class="section" id="smearing-2d">
60<h1>smearing_2d<a class="headerlink" href="#smearing-2d" title="Permalink to this headline">¶</a></h1>
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">
64<dt id="sans.models.smearing_2d.Smearer2D">
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>
66<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
95<dl class="method">
96<dt id="sans.models.smearing_2d.Smearer2D.get_data">
97<tt class="descname">get_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.smearing_2d.Smearer2D.get_data" title="Permalink to this definition">¶</a></dt>
98<dd><p>get qx_data, qy_data, dqx_data,dqy_data,and calculate phi_data=arctan(qx_data/qy_data)</p>
99</dd></dl>
100
101<dl class="method">
102<dt id="sans.models.smearing_2d.Smearer2D.get_value">
103<tt class="descname">get_value</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.smearing_2d.Smearer2D.get_value" title="Permalink to this definition">¶</a></dt>
104<dd><p>Over sampling of r_nbins times phi_nbins, calculate Gaussian weights,
105then find smeared intensity</p>
106</dd></dl>
107
108<dl class="method">
109<dt id="sans.models.smearing_2d.Smearer2D.set_accuracy">
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>
111<dd><p>Set accuracy.</p>
112<table class="docutils field-list" frame="void" rules="none">
113<col class="field-name" />
114<col class="field-body" />
115<tbody valign="top">
116<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>accuracy</strong> &#8211; string</td>
117</tr>
118</tbody>
119</table>
120</dd></dl>
121
122<dl class="method">
123<dt id="sans.models.smearing_2d.Smearer2D.set_data">
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>
125<dd><p>Set data.</p>
126<table class="docutils field-list" frame="void" rules="none">
127<col class="field-name" />
128<col class="field-body" />
129<tbody valign="top">
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>
131</tr>
132</tbody>
133</table>
134</dd></dl>
135
136<dl class="method">
137<dt id="sans.models.smearing_2d.Smearer2D.set_index">
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>
139<dd><p>Set index.</p>
140<table class="docutils field-list" frame="void" rules="none">
141<col class="field-name" />
142<col class="field-body" />
143<tbody valign="top">
144<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>index</strong> &#8211; 1d arrays</td>
145</tr>
146</tbody>
147</table>
148</dd></dl>
149
150<dl class="method">
151<dt id="sans.models.smearing_2d.Smearer2D.set_model">
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>
153<dd><p>Set model.</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-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> &#8211; sans.models instance</td>
159</tr>
160</tbody>
161</table>
162</dd></dl>
163
164<dl class="method">
165<dt id="sans.models.smearing_2d.Smearer2D.set_smearer">
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>
167<dd><p>Set whether or not smearer will be used</p>
168<table class="docutils field-list" frame="void" rules="none">
169<col class="field-name" />
170<col class="field-body" />
171<tbody valign="top">
172<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>smearer</strong> &#8211; smear object</td>
173</tr>
174</tbody>
175</table>
176</dd></dl>
177
178</dd></dl>
179
180</div>
181</div>
182
183
184          </div>
185        </div>
186      </div>
187      <div class="sphinxsidebar">
188        <div class="sphinxsidebarwrapper">
189  <h3><a href="../index.html">Table Of Contents</a></h3>
190  <ul>
191<li><a class="reference internal" href="#">smearing_2d</a><ul>
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>
193</ul>
194</li>
195</ul>
196
197  <h4>Previous topic</h4>
198  <p class="topless"><a href="SLDCalFunc.html"
199                        title="previous chapter">SLDCalFunc</a></p>
200  <h4>Next topic</h4>
201  <p class="topless"><a href="SphereModel.html"
202                        title="next chapter">SphereModel</a></p>
203  <h3>This Page</h3>
204  <ul class="this-page-menu">
205    <li><a href="../_sources/api/smearing_2d.txt"
206           rel="nofollow">Show Source</a></li>
207  </ul>
208<div id="searchbox" style="display: none">
209  <h3>Quick search</h3>
210    <form class="search" action="../search.html" method="get">
211      <input type="text" name="q" />
212      <input type="submit" value="Go" />
213      <input type="hidden" name="check_keywords" value="yes" />
214      <input type="hidden" name="area" value="default" />
215    </form>
216    <p class="searchtip" style="font-size: 90%">
217    Enter search terms or a module, class or function name.
218    </p>
219</div>
220<script type="text/javascript">$('#searchbox').show(0);</script>
221        </div>
222      </div>
223      <div class="clearer"></div>
224    </div>
225    <div class="related">
226      <h3>Navigation</h3>
227      <ul>
228        <li class="right" style="margin-right: 10px">
229          <a href="../genindex.html" title="General Index"
230             >index</a></li>
231        <li class="right" >
232          <a href="../py-modindex.html" title="Python Module Index"
233             >modules</a> |</li>
234        <li class="right" >
235          <a href="SphereModel.html" title="SphereModel"
236             >next</a> |</li>
237        <li class="right" >
238          <a href="SLDCalFunc.html" title="SLDCalFunc"
239             >previous</a> |</li>
240        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
241          <li><a href="index.html" >Reference</a> &raquo;</li> 
242      </ul>
243    </div>
244    <div class="footer">
245        &copy; Copyright 2010, sans group.
246      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
247    </div>
248  </body>
249</html>
Note: See TracBrowser for help on using the repository browser.