source: sasview/sanscalculator/docs/sphinx/html/api/resolution_calculator.html @ 6df04e43

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

edit doc
  • Property mode set to 100644
File size: 35.3 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>resolution_calculator &mdash; calculator 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="calculator 0.1.0 documentation" href="../index.html" />
29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="slit_length_calculator" href="slit_length_calculator.html" />
31    <link rel="prev" title="kiessig_calculator" href="kiessig_calculator.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="slit_length_calculator.html" title="slit_length_calculator"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="kiessig_calculator.html" title="kiessig_calculator"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../index.html">calculator 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="resolution-calculator">
60<h1>resolution_calculator<a class="headerlink" href="#resolution-calculator" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-calculator-resolution-calculator">
62<h2><a class="reference internal" href="#module-sans.calculator.resolution_calculator" title="sans.calculator.resolution_calculator"><tt class="xref py py-mod docutils literal"><span class="pre">sans.calculator.resolution_calculator</span></tt></a><a class="headerlink" href="#sans-calculator-resolution-calculator" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.calculator.resolution_calculator"></span><p>This object is a small tool to allow user to quickly
64determine the variance in q  from the
65instrumental parameters.</p>
66<dl class="class">
67<dt id="sans.calculator.resolution_calculator.ResolutionCalculator">
68<em class="property">class </em><tt class="descclassname">sans.calculator.resolution_calculator.</tt><tt class="descname">ResolutionCalculator</tt><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator" title="Permalink to this definition">¶</a></dt>
69<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
70<p>compute resolution in 2D</p>
71<dl class="attribute">
72<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__class__">
73<tt class="descname">__class__</tt><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__class__" title="Permalink to this definition">¶</a></dt>
74<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
75</dd></dl>
76
77<dl class="attribute">
78<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__delattr__">
79<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__delattr__" title="Permalink to this definition">¶</a></dt>
80<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
81</dd></dl>
82
83<dl class="attribute">
84<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__dict__">
85<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x0205AC50&gt;</em><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__dict__" title="Permalink to this definition">¶</a></dt>
86<dd></dd></dl>
87
88<dl class="attribute">
89<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__getattribute__">
90<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__getattribute__" title="Permalink to this definition">¶</a></dt>
91<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
92</dd></dl>
93
94<dl class="attribute">
95<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__hash__">
96<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__hash__" title="Permalink to this definition">¶</a></dt>
97<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
98</dd></dl>
99
100<dl class="method">
101<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__init__">
102<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__init__" title="Permalink to this definition">¶</a></dt>
103<dd></dd></dl>
104
105<dl class="attribute">
106<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__module__">
107<tt class="descname">__module__</tt><em class="property"> = 'sans.calculator.resolution_calculator'</em><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__module__" title="Permalink to this definition">¶</a></dt>
108<dd></dd></dl>
109
110<dl class="staticmethod">
111<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__new__">
112<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.calculator.resolution_calculator.ResolutionCalculator.__new__" title="Permalink to this definition">¶</a></dt>
113<dd></dd></dl>
114
115<dl class="method">
116<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__reduce__">
117<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__reduce__" title="Permalink to this definition">¶</a></dt>
118<dd><p>helper for pickle</p>
119</dd></dl>
120
121<dl class="method">
122<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__reduce_ex__">
123<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
124<dd><p>helper for pickle</p>
125</dd></dl>
126
127<dl class="attribute">
128<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__repr__">
129<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__repr__" title="Permalink to this definition">¶</a></dt>
130<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
131</dd></dl>
132
133<dl class="attribute">
134<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__setattr__">
135<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__setattr__" title="Permalink to this definition">¶</a></dt>
136<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
137</dd></dl>
138
139<dl class="attribute">
140<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__str__">
141<tt class="descname">__str__</tt><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__str__" title="Permalink to this definition">¶</a></dt>
142<dd><p>x.__str__() &lt;==&gt; str(x)</p>
143</dd></dl>
144
145<dl class="attribute">
146<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.__weakref__">
147<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.__weakref__" title="Permalink to this definition">¶</a></dt>
148<dd><p>list of weak references to the object (if defined)</p>
149</dd></dl>
150
151<dl class="method">
152<dt id="sans.calculator.resolution_calculator.ResolutionCalculator._atan_phi">
153<tt class="descname">_atan_phi</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._atan_phi" title="Permalink to this definition">¶</a></dt>
154<dd><p>Find the angle phi of q on the detector plane for qx_value, qy_value given
155: qx_value: x component of q
156: qy_value: y component of q</p>
157<p>: return phi: the azimuthal angle of q on x-y plane</p>
158</dd></dl>
159
160<dl class="method">
161<dt id="sans.calculator.resolution_calculator.ResolutionCalculator._cal_A_value">
162<tt class="descname">_cal_A_value</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._cal_A_value" title="Permalink to this definition">¶</a></dt>
163<dd><p>Calculate A value for gravity</p>
164<p>: s_distance: source to sample distance
165: d_distance: sample to detector distance</p>
166</dd></dl>
167
168<dl class="method">
169<dt id="sans.calculator.resolution_calculator.ResolutionCalculator._gaussian1d">
170<tt class="descname">_gaussian1d</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._gaussian1d" title="Permalink to this definition">¶</a></dt>
171<dd><p>Calculate 1D Gaussian distribution
172: value: value
173: mean: mean value
174: sigma: variance</p>
175<p>: return: gaussian (value)</p>
176</dd></dl>
177
178<dl class="method">
179<dt id="sans.calculator.resolution_calculator.ResolutionCalculator._gaussian2d">
180<tt class="descname">_gaussian2d</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._gaussian2d" title="Permalink to this definition">¶</a></dt>
181<dd><p>Calculate 2D Gaussian distribution
182: x_val: x value
183: y_val: y value
184: x0_val: mean value in x-axis
185: y0_val: mean value in y-axis
186: sigma_x: variance in x-direction
187: sigma_y: variance in y-direction</p>
188<p>: return: gaussian (value)</p>
189</dd></dl>
190
191<dl class="method">
192<dt id="sans.calculator.resolution_calculator.ResolutionCalculator._gaussian2d_polar">
193<tt class="descname">_gaussian2d_polar</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._gaussian2d_polar" title="Permalink to this definition">¶</a></dt>
194<dd><p>Calculate 2D Gaussian distribution for polar coodinate
195: x_val: x value
196: y_val: y value
197: x0_val: mean value in x-axis
198: y0_val: mean value in y-axis
199: sigma_x: variance in r-direction
200: sigma_y: variance in phi-direction
201: sigma_r: wavelength variance in r-direction</p>
202<p>: return: gaussian (value)</p>
203</dd></dl>
204
205<dl class="method">
206<dt id="sans.calculator.resolution_calculator.ResolutionCalculator._get_beamcenter_drop">
207<tt class="descname">_get_beamcenter_drop</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._get_beamcenter_drop" title="Permalink to this definition">¶</a></dt>
208<dd><p>Get the beam center drop (delta y) in y diection due to gravity</p>
209<table class="docutils field-list" frame="void" rules="none">
210<col class="field-name" />
211<col class="field-body" />
212<tbody valign="top">
213<tr class="field-odd field"><th class="field-name">Return delta y:</th><td class="field-body">the beam center drop in cm</td>
214</tr>
215</tbody>
216</table>
217</dd></dl>
218
219<dl class="method">
220<dt id="sans.calculator.resolution_calculator.ResolutionCalculator._get_beamcenter_position">
221<tt class="descname">_get_beamcenter_position</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._get_beamcenter_position" title="Permalink to this definition">¶</a></dt>
222<dd><table class="docutils field-list" frame="void" rules="none">
223<col class="field-name" />
224<col class="field-body" />
225<tbody valign="top">
226<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
227<li><strong>num_x</strong> &#8211; number of pixel in x-direction</li>
228<li><strong>num_y</strong> &#8211; number of pixel in y-direction</li>
229<li><strong>offset</strong> &#8211; detector offset in x-direction in pix number</li>
230</ul>
231</td>
232</tr>
233<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">pix number; pos_x, pos_y in pix index</p>
234</td>
235</tr>
236</tbody>
237</table>
238</dd></dl>
239
240<dl class="method">
241<dt id="sans.calculator.resolution_calculator.ResolutionCalculator._get_detector_qxqy_pixels">
242<tt class="descname">_get_detector_qxqy_pixels</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._get_detector_qxqy_pixels" title="Permalink to this definition">¶</a></dt>
243<dd><p>Get the pixel positions of the detector in the qx_value-qy_value space</p>
244</dd></dl>
245
246<dl class="method">
247<dt id="sans.calculator.resolution_calculator.ResolutionCalculator._get_polar_value">
248<tt class="descname">_get_polar_value</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._get_polar_value" title="Permalink to this definition">¶</a></dt>
249<dd><p>Find qr_value and phi from qx_value and qy_value values</p>
250<p>: return qr_value, phi</p>
251</dd></dl>
252
253<dl class="method">
254<dt id="sans.calculator.resolution_calculator.ResolutionCalculator._get_qx">
255<tt class="descname">_get_qx</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._get_qx" title="Permalink to this definition">¶</a></dt>
256<dd><table class="docutils field-list" frame="void" rules="none">
257<col class="field-name" />
258<col class="field-body" />
259<tbody valign="top">
260<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
261<li><strong>dx_size</strong> &#8211; x-distance from beam center [cm]</li>
262<li><strong>det_dist</strong> &#8211; sample to detector distance [cm]</li>
263</ul>
264</td>
265</tr>
266<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">q-value at the given position</p>
267</td>
268</tr>
269</tbody>
270</table>
271</dd></dl>
272
273<dl class="method">
274<dt id="sans.calculator.resolution_calculator.ResolutionCalculator._rotate_z">
275<tt class="descname">_rotate_z</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._rotate_z" title="Permalink to this definition">¶</a></dt>
276<dd><p>Rotate x-y cordinate around z-axis by theta
277: x_value: numpy array of x values
278: y_value: numpy array of y values
279: theta: angle to rotate by in rad</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">Returns:</th><td class="field-body">x_prime, y-prime</td>
285</tr>
286</tbody>
287</table>
288</dd></dl>
289
290<dl class="method">
291<dt id="sans.calculator.resolution_calculator.ResolutionCalculator._within_detector_range">
292<tt class="descname">_within_detector_range</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator._within_detector_range" title="Permalink to this definition">¶</a></dt>
293<dd><p>check if qvalues are within detector range</p>
294</dd></dl>
295
296<dl class="method">
297<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.compute">
298<tt class="descname">compute</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.compute" title="Permalink to this definition">¶</a></dt>
299<dd><p>Compute the Q resoltuion in || and + direction of 2D
300: qx_value: x component of q
301: qy_value: y component of q</p>
302</dd></dl>
303
304<dl class="method">
305<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.compute_and_plot">
306<tt class="descname">compute_and_plot</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.compute_and_plot" title="Permalink to this definition">¶</a></dt>
307<dd><p>Compute the resolution
308: qx_value: x component of q
309: qy_value: y component of q</p>
310</dd></dl>
311
312<dl class="method">
313<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_all_instrument_params">
314<tt class="descname">get_all_instrument_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_all_instrument_params" title="Permalink to this definition">¶</a></dt>
315<dd><p>Get all instrumental parameters</p>
316</dd></dl>
317
318<dl class="method">
319<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_default_spectrum">
320<tt class="descname">get_default_spectrum</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_default_spectrum" title="Permalink to this definition">¶</a></dt>
321<dd><p>Get default_spectrum</p>
322</dd></dl>
323
324<dl class="method">
325<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_detector_pix_size">
326<tt class="descname">get_detector_pix_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_detector_pix_size" title="Permalink to this definition">¶</a></dt>
327<dd><p>Get detector pixel size</p>
328</dd></dl>
329
330<dl class="method">
331<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_detector_qrange">
332<tt class="descname">get_detector_qrange</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_detector_qrange" title="Permalink to this definition">¶</a></dt>
333<dd><p>get max detector q ranges</p>
334<p>: return: qx_min, qx_max, qy_min, qy_max tuple</p>
335</dd></dl>
336
337<dl class="method">
338<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_detector_size">
339<tt class="descname">get_detector_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_detector_size" title="Permalink to this definition">¶</a></dt>
340<dd><p>Get detector size</p>
341</dd></dl>
342
343<dl class="method">
344<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_image">
345<tt class="descname">get_image</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_image" title="Permalink to this definition">¶</a></dt>
346<dd><p>Get the resolution in polar coordinate ready to plot
347: qx_value: qx_value value
348: qy_value: qy_value value
349: sigma_1: variance in r direction
350: sigma_2: variance in phi direction
351: coord: coordinate system of image, &#8216;polar&#8217; or &#8216;cartesian&#8217;</p>
352</dd></dl>
353
354<dl class="method">
355<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_intensity">
356<tt class="descname">get_intensity</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_intensity" title="Permalink to this definition">¶</a></dt>
357<dd><p>Get intensity</p>
358</dd></dl>
359
360<dl class="method">
361<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_intensity_list">
362<tt class="descname">get_intensity_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_intensity_list" title="Permalink to this definition">¶</a></dt>
363<dd><p>Set wavelength spread</p>
364</dd></dl>
365
366<dl class="method">
367<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_neutron_mass">
368<tt class="descname">get_neutron_mass</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_neutron_mass" title="Permalink to this definition">¶</a></dt>
369<dd><p>Get Neutron mass</p>
370</dd></dl>
371
372<dl class="method">
373<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_sample2detector_distance">
374<tt class="descname">get_sample2detector_distance</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_sample2detector_distance" title="Permalink to this definition">¶</a></dt>
375<dd><p>Get detector sample2detector_distance</p>
376</dd></dl>
377
378<dl class="method">
379<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_sample2sample_distance">
380<tt class="descname">get_sample2sample_distance</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_sample2sample_distance" title="Permalink to this definition">¶</a></dt>
381<dd><p>Get detector sampleslitsample_distance</p>
382</dd></dl>
383
384<dl class="method">
385<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_sample_aperture_size">
386<tt class="descname">get_sample_aperture_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_sample_aperture_size" title="Permalink to this definition">¶</a></dt>
387<dd><p>Get sample aperture size</p>
388</dd></dl>
389
390<dl class="method">
391<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_source2sample_distance">
392<tt class="descname">get_source2sample_distance</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_source2sample_distance" title="Permalink to this definition">¶</a></dt>
393<dd><p>Get detector source2sample_distance</p>
394</dd></dl>
395
396<dl class="method">
397<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_source_aperture_size">
398<tt class="descname">get_source_aperture_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_source_aperture_size" title="Permalink to this definition">¶</a></dt>
399<dd><p>Get source aperture size</p>
400</dd></dl>
401
402<dl class="method">
403<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_spectrum">
404<tt class="descname">get_spectrum</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_spectrum" title="Permalink to this definition">¶</a></dt>
405<dd><p>Get _spectrum</p>
406</dd></dl>
407
408<dl class="method">
409<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_variance">
410<tt class="descname">get_variance</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_variance" title="Permalink to this definition">¶</a></dt>
411<dd><p>Get the variance when the slit/pinhole size is given
412: size: list that can be one(diameter for circular)</p>
413<blockquote>
414<div>or two components(lengths for rectangular)</div></blockquote>
415<p>: distance: [z, x] where z along the incident beam, x // qx_value
416: comp: direction of the sigma; can be &#8216;phi&#8217;, &#8216;y&#8217;, &#8216;x&#8217;, and &#8216;radial&#8217;</p>
417<p>: return variance: sigma^2</p>
418</dd></dl>
419
420<dl class="method">
421<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_variance_gravity">
422<tt class="descname">get_variance_gravity</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_variance_gravity" title="Permalink to this definition">¶</a></dt>
423<dd><p>Get the variance from gravity when the wavelength spread is given</p>
424<p>: s_distance: source to sample distance
425: d_distance: sample to detector distance
426: wavelength: wavelength
427: spread: wavelength spread (ratio)
428: comp: direction of the sigma; can be &#8216;phi&#8217;, &#8216;y&#8217;, &#8216;x&#8217;, and &#8216;radial&#8217;</p>
429<p>: return variance: sigma^2</p>
430</dd></dl>
431
432<dl class="method">
433<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_variance_wave">
434<tt class="descname">get_variance_wave</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_variance_wave" title="Permalink to this definition">¶</a></dt>
435<dd><p>Get the variance when the wavelength spread is given</p>
436<p>: radius: the radial distance from the beam center to the pix of q
437: distance: sample to detector distance
438: spread: wavelength spread (ratio)
439: comp: direction of the sigma; can be &#8216;phi&#8217;, &#8216;y&#8217;, &#8216;x&#8217;, and &#8216;radial&#8217;</p>
440<p>: return variance: sigma^2 for 2d, sigma^2 for 1d [tuple]</p>
441</dd></dl>
442
443<dl class="method">
444<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_wave_list">
445<tt class="descname">get_wave_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_wave_list" title="Permalink to this definition">¶</a></dt>
446<dd><p>Set wavelength spread</p>
447</dd></dl>
448
449<dl class="method">
450<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_wavelength">
451<tt class="descname">get_wavelength</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_wavelength" title="Permalink to this definition">¶</a></dt>
452<dd><p>Get wavelength</p>
453</dd></dl>
454
455<dl class="method">
456<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.get_wavelength_spread">
457<tt class="descname">get_wavelength_spread</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.get_wavelength_spread" title="Permalink to this definition">¶</a></dt>
458<dd><p>Get wavelength spread</p>
459</dd></dl>
460
461<dl class="method">
462<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.plot_image">
463<tt class="descname">plot_image</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.plot_image" title="Permalink to this definition">¶</a></dt>
464<dd><p>Plot image using pyplot
465: image: 2d resolution image</p>
466<p>: return plt: pylab object</p>
467</dd></dl>
468
469<dl class="method">
470<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.reset_image">
471<tt class="descname">reset_image</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.reset_image" title="Permalink to this definition">¶</a></dt>
472<dd><p>Reset image to default (=[])</p>
473</dd></dl>
474
475<dl class="method">
476<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_detector_pix_size">
477<tt class="descname">set_detector_pix_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_detector_pix_size" title="Permalink to this definition">¶</a></dt>
478<dd><p>Set detector pixel size</p>
479</dd></dl>
480
481<dl class="method">
482<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_detector_size">
483<tt class="descname">set_detector_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_detector_size" title="Permalink to this definition">¶</a></dt>
484<dd><p>Set detector size in number of pixels
485: param size: [pixel_nums] or [x_pix_num, yx_pix_num]</p>
486</dd></dl>
487
488<dl class="method">
489<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_intensity">
490<tt class="descname">set_intensity</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_intensity" title="Permalink to this definition">¶</a></dt>
491<dd><p>Set intensity</p>
492</dd></dl>
493
494<dl class="method">
495<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_neutron_mass">
496<tt class="descname">set_neutron_mass</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_neutron_mass" title="Permalink to this definition">¶</a></dt>
497<dd><p>Set Neutron mass</p>
498</dd></dl>
499
500<dl class="method">
501<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_sample2detector_distance">
502<tt class="descname">set_sample2detector_distance</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_sample2detector_distance" title="Permalink to this definition">¶</a></dt>
503<dd><p>Set detector sample2detector_distance</p>
504<p>: param distance: [distance, x_offset]</p>
505</dd></dl>
506
507<dl class="method">
508<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_sample2sample_distance">
509<tt class="descname">set_sample2sample_distance</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_sample2sample_distance" title="Permalink to this definition">¶</a></dt>
510<dd><p>Set detector sample_slit2sample_distance</p>
511<p>: param distance: [distance, x_offset]</p>
512</dd></dl>
513
514<dl class="method">
515<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_sample_aperture_size">
516<tt class="descname">set_sample_aperture_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_sample_aperture_size" title="Permalink to this definition">¶</a></dt>
517<dd><p>Set sample aperture size</p>
518<p>: param size: [dia_value] or [xheight_value, yheight_value]</p>
519</dd></dl>
520
521<dl class="method">
522<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_source2sample_distance">
523<tt class="descname">set_source2sample_distance</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_source2sample_distance" title="Permalink to this definition">¶</a></dt>
524<dd><p>Set detector source2sample_distance</p>
525<p>: param distance: [distance, x_offset]</p>
526</dd></dl>
527
528<dl class="method">
529<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_source_aperture_size">
530<tt class="descname">set_source_aperture_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_source_aperture_size" title="Permalink to this definition">¶</a></dt>
531<dd><p>Set source aperture size</p>
532<p>: param size: [dia_value] or [x_value, y_value]</p>
533</dd></dl>
534
535<dl class="method">
536<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_spectrum">
537<tt class="descname">set_spectrum</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_spectrum" title="Permalink to this definition">¶</a></dt>
538<dd><p>Set spectrum</p>
539</dd></dl>
540
541<dl class="method">
542<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_wave">
543<tt class="descname">set_wave</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_wave" title="Permalink to this definition">¶</a></dt>
544<dd><p>Set wavelength list or wavelength</p>
545</dd></dl>
546
547<dl class="method">
548<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_wave_list">
549<tt class="descname">set_wave_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_wave_list" title="Permalink to this definition">¶</a></dt>
550<dd><p>Set wavelength and its spread list</p>
551</dd></dl>
552
553<dl class="method">
554<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_wave_spread">
555<tt class="descname">set_wave_spread</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_wave_spread" title="Permalink to this definition">¶</a></dt>
556<dd><p>Set wavelength spread  or wavelength spread</p>
557</dd></dl>
558
559<dl class="method">
560<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_wavelength">
561<tt class="descname">set_wavelength</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_wavelength" title="Permalink to this definition">¶</a></dt>
562<dd><p>Set wavelength</p>
563</dd></dl>
564
565<dl class="method">
566<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.set_wavelength_spread">
567<tt class="descname">set_wavelength_spread</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.set_wavelength_spread" title="Permalink to this definition">¶</a></dt>
568<dd><p>Set wavelength spread</p>
569</dd></dl>
570
571<dl class="method">
572<dt id="sans.calculator.resolution_calculator.ResolutionCalculator.setup_tof">
573<tt class="descname">setup_tof</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.resolution_calculator.ResolutionCalculator.setup_tof" title="Permalink to this definition">¶</a></dt>
574<dd><p>Setup all parameters in instrument</p>
575<p>: param ind: index of lambda, etc</p>
576</dd></dl>
577
578</dd></dl>
579
580</div>
581</div>
582
583
584          </div>
585        </div>
586      </div>
587      <div class="sphinxsidebar">
588        <div class="sphinxsidebarwrapper">
589  <h3><a href="../index.html">Table Of Contents</a></h3>
590  <ul>
591<li><a class="reference internal" href="#">resolution_calculator</a><ul>
592<li><a class="reference internal" href="#sans-calculator-resolution-calculator"><tt class="docutils literal"><span class="pre">sans.calculator.resolution_calculator</span></tt></a></li>
593</ul>
594</li>
595</ul>
596
597  <h4>Previous topic</h4>
598  <p class="topless"><a href="kiessig_calculator.html"
599                        title="previous chapter">kiessig_calculator</a></p>
600  <h4>Next topic</h4>
601  <p class="topless"><a href="slit_length_calculator.html"
602                        title="next chapter">slit_length_calculator</a></p>
603  <h3>This Page</h3>
604  <ul class="this-page-menu">
605    <li><a href="../_sources/api/resolution_calculator.txt"
606           rel="nofollow">Show Source</a></li>
607  </ul>
608<div id="searchbox" style="display: none">
609  <h3>Quick search</h3>
610    <form class="search" action="../search.html" method="get">
611      <input type="text" name="q" />
612      <input type="submit" value="Go" />
613      <input type="hidden" name="check_keywords" value="yes" />
614      <input type="hidden" name="area" value="default" />
615    </form>
616    <p class="searchtip" style="font-size: 90%">
617    Enter search terms or a module, class or function name.
618    </p>
619</div>
620<script type="text/javascript">$('#searchbox').show(0);</script>
621        </div>
622      </div>
623      <div class="clearer"></div>
624    </div>
625    <div class="related">
626      <h3>Navigation</h3>
627      <ul>
628        <li class="right" style="margin-right: 10px">
629          <a href="../genindex.html" title="General Index"
630             >index</a></li>
631        <li class="right" >
632          <a href="../py-modindex.html" title="Python Module Index"
633             >modules</a> |</li>
634        <li class="right" >
635          <a href="slit_length_calculator.html" title="slit_length_calculator"
636             >next</a> |</li>
637        <li class="right" >
638          <a href="kiessig_calculator.html" title="kiessig_calculator"
639             >previous</a> |</li>
640        <li><a href="../index.html">calculator 0.1.0 documentation</a> &raquo;</li>
641          <li><a href="index.html" >Reference</a> &raquo;</li> 
642      </ul>
643    </div>
644    <div class="footer">
645        &copy; Copyright 2010, Gervaise Alina.
646      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
647    </div>
648  </body>
649</html>
Note: See TracBrowser for help on using the repository browser.