source: sasview/dev/api/sas.calculator.html @ a462c6a

gh-pages
Last change on this file since a462c6a was a462c6a, checked in by ajj, 9 years ago

Rebuild to fix index and modules docs
  • Property mode set to 100644
File size: 67.9 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6  <head>
7    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8   
9    <title>sas.calculator package &mdash; SasView 3.0.0 documentation</title>
10   
11    <link rel="stylesheet" href="../../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
13   
14    <script type="text/javascript">
15      var DOCUMENTATION_OPTIONS = {
16        URL_ROOT:    '../../',
17        VERSION:     '3.0.0',
18        COLLAPSE_INDEX: false,
19        FILE_SUFFIX: '.html',
20        HAS_SOURCE:  true
21      };
22    </script>
23    <script type="text/javascript" src="../../_static/jquery.js"></script>
24    <script type="text/javascript" src="../../_static/underscore.js"></script>
25    <script type="text/javascript" src="../../_static/doctools.js"></script>
26    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
27    <link rel="top" title="SasView 3.0.0 documentation" href="../../index.html" />
28    <link rel="up" title="sas package" href="sas.html" />
29    <link rel="next" title="sas.data_util package" href="sas.data_util.html" />
30    <link rel="prev" title="sas package" href="sas.html" /> 
31  </head>
32  <body>
33    <div class="related">
34      <h3>Navigation</h3>
35      <ul>
36        <li class="right" style="margin-right: 10px">
37          <a href="../../genindex.html" title="General Index"
38             accesskey="I">index</a></li>
39        <li class="right" >
40          <a href="../../py-modindex.html" title="Python Module Index"
41             >modules</a> |</li>
42        <li class="right" >
43          <a href="sas.data_util.html" title="sas.data_util package"
44             accesskey="N">next</a> |</li>
45        <li class="right" >
46          <a href="sas.html" title="sas package"
47             accesskey="P">previous</a> |</li>
48        <li><a href="../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
49          <li><a href="../dev.html" >Developer Documentation</a> &raquo;</li>
50          <li><a href="modules.html" >lib.macosx-10.5-x86_64-2.7</a> &raquo;</li>
51          <li><a href="sas.html" accesskey="U">sas package</a> &raquo;</li> 
52      </ul>
53    </div> 
54
55    <div class="document">
56      <div class="documentwrapper">
57        <div class="bodywrapper">
58          <div class="body">
59           
60  <div class="section" id="sas-calculator-package">
61<h1>sas.calculator package</h1>
62<div class="section" id="submodules">
63<h2>Submodules</h2>
64</div>
65<div class="section" id="module-sas.calculator.instrument">
66<span id="sas-calculator-instrument-module"></span><h2>sas.calculator.instrument module</h2>
67<p>This module is a small tool to allow user to
68control instrumental parameters</p>
69<dl class="class">
70<dt id="sas.calculator.instrument.Aperture">
71<em class="property">class </em><tt class="descclassname">sas.calculator.instrument.</tt><tt class="descname">Aperture</tt><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Aperture"><span class="viewcode-link">[source]</span></a></dt>
72<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
73<p>An object class that defines the aperture variables</p>
74<dl class="method">
75<dt id="sas.calculator.instrument.Aperture.set_sample_distance">
76<tt class="descname">set_sample_distance</tt><big>(</big><em>distance=[]</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Aperture.set_sample_distance"><span class="viewcode-link">[source]</span></a></dt>
77<dd><p>Set the sample aperture distance</p>
78</dd></dl>
79
80<dl class="method">
81<dt id="sas.calculator.instrument.Aperture.set_sample_size">
82<tt class="descname">set_sample_size</tt><big>(</big><em>size=[]</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Aperture.set_sample_size"><span class="viewcode-link">[source]</span></a></dt>
83<dd><p>Set the sample aperture size</p>
84</dd></dl>
85
86<dl class="method">
87<dt id="sas.calculator.instrument.Aperture.set_source_size">
88<tt class="descname">set_source_size</tt><big>(</big><em>size=[]</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Aperture.set_source_size"><span class="viewcode-link">[source]</span></a></dt>
89<dd><p>Set the source aperture size</p>
90</dd></dl>
91
92</dd></dl>
93
94<dl class="class">
95<dt id="sas.calculator.instrument.Detector">
96<em class="property">class </em><tt class="descclassname">sas.calculator.instrument.</tt><tt class="descname">Detector</tt><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Detector"><span class="viewcode-link">[source]</span></a></dt>
97<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
98<p>An object class that defines the detector variables</p>
99<dl class="method">
100<dt id="sas.calculator.instrument.Detector.set_distance">
101<tt class="descname">set_distance</tt><big>(</big><em>distance=[]</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Detector.set_distance"><span class="viewcode-link">[source]</span></a></dt>
102<dd><p>Set the detector distance</p>
103</dd></dl>
104
105<dl class="method">
106<dt id="sas.calculator.instrument.Detector.set_pix_size">
107<tt class="descname">set_pix_size</tt><big>(</big><em>size=[]</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Detector.set_pix_size"><span class="viewcode-link">[source]</span></a></dt>
108<dd><p>Set the detector pix_size</p>
109</dd></dl>
110
111<dl class="method">
112<dt id="sas.calculator.instrument.Detector.set_size">
113<tt class="descname">set_size</tt><big>(</big><em>size=[]</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Detector.set_size"><span class="viewcode-link">[source]</span></a></dt>
114<dd><p>Set the detector  size</p>
115</dd></dl>
116
117</dd></dl>
118
119<dl class="class">
120<dt id="sas.calculator.instrument.Neutron">
121<em class="property">class </em><tt class="descclassname">sas.calculator.instrument.</tt><tt class="descname">Neutron</tt><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Neutron"><span class="viewcode-link">[source]</span></a></dt>
122<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
123<p>An object that defines the wavelength variables</p>
124<dl class="method">
125<dt id="sas.calculator.instrument.Neutron.get_band">
126<tt class="descname">get_band</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Neutron.get_band"><span class="viewcode-link">[source]</span></a></dt>
127<dd><p>To get the wavelength band</p>
128</dd></dl>
129
130<dl class="method">
131<dt id="sas.calculator.instrument.Neutron.get_default_spectrum">
132<tt class="descname">get_default_spectrum</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Neutron.get_default_spectrum"><span class="viewcode-link">[source]</span></a></dt>
133<dd><p>get default spectrum</p>
134</dd></dl>
135
136<dl class="method">
137<dt id="sas.calculator.instrument.Neutron.get_intensity">
138<tt class="descname">get_intensity</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Neutron.get_intensity"><span class="viewcode-link">[source]</span></a></dt>
139<dd><p>To get the value of intensity</p>
140</dd></dl>
141
142<dl class="method">
143<dt id="sas.calculator.instrument.Neutron.get_mass">
144<tt class="descname">get_mass</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Neutron.get_mass"><span class="viewcode-link">[source]</span></a></dt>
145<dd><p>To get the neutron mass</p>
146</dd></dl>
147
148<dl class="method">
149<dt id="sas.calculator.instrument.Neutron.get_ramdom_value">
150<tt class="descname">get_ramdom_value</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Neutron.get_ramdom_value"><span class="viewcode-link">[source]</span></a></dt>
151<dd><p>To get the value of wave length</p>
152</dd></dl>
153
154<dl class="method">
155<dt id="sas.calculator.instrument.Neutron.get_spectrum">
156<tt class="descname">get_spectrum</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Neutron.get_spectrum"><span class="viewcode-link">[source]</span></a></dt>
157<dd><p>To get the wavelength spectrum</p>
158</dd></dl>
159
160<dl class="method">
161<dt id="sas.calculator.instrument.Neutron.get_wavelength">
162<tt class="descname">get_wavelength</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Neutron.get_wavelength"><span class="viewcode-link">[source]</span></a></dt>
163<dd><p>To get the value of wavelength</p>
164</dd></dl>
165
166<dl class="method">
167<dt id="sas.calculator.instrument.Neutron.get_wavelength_spread">
168<tt class="descname">get_wavelength_spread</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Neutron.get_wavelength_spread"><span class="viewcode-link">[source]</span></a></dt>
169<dd><p>To get the value of wavelength spread</p>
170</dd></dl>
171
172<dl class="method">
173<dt id="sas.calculator.instrument.Neutron.plot_spectrum">
174<tt class="descname">plot_spectrum</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Neutron.plot_spectrum"><span class="viewcode-link">[source]</span></a></dt>
175<dd><p>To plot the wavelength spactrum
176: requirment: matplotlib.pyplot</p>
177</dd></dl>
178
179<dl class="method">
180<dt id="sas.calculator.instrument.Neutron.set_band">
181<tt class="descname">set_band</tt><big>(</big><em>band=[]</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Neutron.set_band"><span class="viewcode-link">[source]</span></a></dt>
182<dd><p>To set the wavelength band</p>
183<table class="docutils field-list" frame="void" rules="none">
184<col class="field-name" />
185<col class="field-body" />
186<tbody valign="top">
187<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>band</strong> &#8211; array of [min, max]</td>
188</tr>
189</tbody>
190</table>
191</dd></dl>
192
193<dl class="method">
194<dt id="sas.calculator.instrument.Neutron.set_full_band">
195<tt class="descname">set_full_band</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Neutron.set_full_band"><span class="viewcode-link">[source]</span></a></dt>
196<dd><p>set band to default value</p>
197</dd></dl>
198
199<dl class="method">
200<dt id="sas.calculator.instrument.Neutron.set_intensity">
201<tt class="descname">set_intensity</tt><big>(</big><em>intensity=368428</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Neutron.set_intensity"><span class="viewcode-link">[source]</span></a></dt>
202<dd><p>Sets the intensity in counts/sec</p>
203</dd></dl>
204
205<dl class="method">
206<dt id="sas.calculator.instrument.Neutron.set_mass">
207<tt class="descname">set_mass</tt><big>(</big><em>mass=1.67492729e-24</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Neutron.set_mass"><span class="viewcode-link">[source]</span></a></dt>
208<dd><p>Sets the wavelength</p>
209</dd></dl>
210
211<dl class="method">
212<dt id="sas.calculator.instrument.Neutron.set_spectrum">
213<tt class="descname">set_spectrum</tt><big>(</big><em>spectrum</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Neutron.set_spectrum"><span class="viewcode-link">[source]</span></a></dt>
214<dd><p>Set spectrum</p>
215<table class="docutils field-list" frame="void" rules="none">
216<col class="field-name" />
217<col class="field-body" />
218<tbody valign="top">
219<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spectrum</strong> &#8211; numpy array</td>
220</tr>
221</tbody>
222</table>
223</dd></dl>
224
225<dl class="method">
226<dt id="sas.calculator.instrument.Neutron.set_wavelength">
227<tt class="descname">set_wavelength</tt><big>(</big><em>wavelength=6.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Neutron.set_wavelength"><span class="viewcode-link">[source]</span></a></dt>
228<dd><p>Sets the wavelength</p>
229</dd></dl>
230
231<dl class="method">
232<dt id="sas.calculator.instrument.Neutron.set_wavelength_spread">
233<tt class="descname">set_wavelength_spread</tt><big>(</big><em>spread=0.125</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Neutron.set_wavelength_spread"><span class="viewcode-link">[source]</span></a></dt>
234<dd><p>Sets the wavelength spread</p>
235</dd></dl>
236
237<dl class="method">
238<dt id="sas.calculator.instrument.Neutron.setup_spectrum">
239<tt class="descname">setup_spectrum</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Neutron.setup_spectrum"><span class="viewcode-link">[source]</span></a></dt>
240<dd><p>To set the wavelength spectrum, and intensity, assumes
241wavelength is already within the spectrum</p>
242</dd></dl>
243
244</dd></dl>
245
246<dl class="class">
247<dt id="sas.calculator.instrument.Sample">
248<em class="property">class </em><tt class="descclassname">sas.calculator.instrument.</tt><tt class="descname">Sample</tt><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Sample"><span class="viewcode-link">[source]</span></a></dt>
249<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
250<p>An object class that defines the sample variables</p>
251<dl class="method">
252<dt id="sas.calculator.instrument.Sample.set_distance">
253<tt class="descname">set_distance</tt><big>(</big><em>distance=[]</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Sample.set_distance"><span class="viewcode-link">[source]</span></a></dt>
254<dd><p>Set the sample distance</p>
255</dd></dl>
256
257<dl class="method">
258<dt id="sas.calculator.instrument.Sample.set_size">
259<tt class="descname">set_size</tt><big>(</big><em>size=[]</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Sample.set_size"><span class="viewcode-link">[source]</span></a></dt>
260<dd><p>Set the sample size</p>
261</dd></dl>
262
263<dl class="method">
264<dt id="sas.calculator.instrument.Sample.set_thickness">
265<tt class="descname">set_thickness</tt><big>(</big><em>thickness=0.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#Sample.set_thickness"><span class="viewcode-link">[source]</span></a></dt>
266<dd><p>Set the sample thickness</p>
267</dd></dl>
268
269</dd></dl>
270
271<dl class="class">
272<dt id="sas.calculator.instrument.TOF">
273<em class="property">class </em><tt class="descclassname">sas.calculator.instrument.</tt><tt class="descname">TOF</tt><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#TOF"><span class="viewcode-link">[source]</span></a></dt>
274<dd><p>Bases: <a class="reference internal" href="#sas.calculator.instrument.Neutron" title="sas.calculator.instrument.Neutron"><tt class="xref py py-class docutils literal"><span class="pre">sas.calculator.instrument.Neutron</span></tt></a></p>
275<p>TOF: make list of wavelength and wave length spreads</p>
276<dl class="method">
277<dt id="sas.calculator.instrument.TOF.get_intensity_list">
278<tt class="descname">get_intensity_list</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#TOF.get_intensity_list"><span class="viewcode-link">[source]</span></a></dt>
279<dd><p>get list of the intensity wrt wavelength_list</p>
280</dd></dl>
281
282<dl class="method">
283<dt id="sas.calculator.instrument.TOF.get_wave_list">
284<tt class="descname">get_wave_list</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#TOF.get_wave_list"><span class="viewcode-link">[source]</span></a></dt>
285<dd><p>Get wavelength and wavelength_spread list</p>
286</dd></dl>
287
288<dl class="method">
289<dt id="sas.calculator.instrument.TOF.set_wave_list">
290<tt class="descname">set_wave_list</tt><big>(</big><em>wavelength=[]</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#TOF.set_wave_list"><span class="viewcode-link">[source]</span></a></dt>
291<dd><p>Set wavelength list</p>
292<table class="docutils field-list" frame="void" rules="none">
293<col class="field-name" />
294<col class="field-body" />
295<tbody valign="top">
296<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>wavelength</strong> &#8211; list of wavelengths</td>
297</tr>
298</tbody>
299</table>
300</dd></dl>
301
302<dl class="method">
303<dt id="sas.calculator.instrument.TOF.set_wave_spread_list">
304<tt class="descname">set_wave_spread_list</tt><big>(</big><em>wavelength_spread=[]</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#TOF.set_wave_spread_list"><span class="viewcode-link">[source]</span></a></dt>
305<dd><p>Set wavelength_spread list</p>
306<table class="docutils field-list" frame="void" rules="none">
307<col class="field-name" />
308<col class="field-body" />
309<tbody valign="top">
310<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>wavelength_spread</strong> &#8211; list of wavelength spreads</td>
311</tr>
312</tbody>
313</table>
314</dd></dl>
315
316</dd></dl>
317
318<dl class="function">
319<dt id="sas.calculator.instrument.validate">
320<tt class="descclassname">sas.calculator.instrument.</tt><tt class="descname">validate</tt><big>(</big><em>value=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/instrument.html#validate"><span class="viewcode-link">[source]</span></a></dt>
321<dd><p>Check if the value is folat &gt; 0.0</p>
322<table class="docutils field-list" frame="void" rules="none">
323<col class="field-name" />
324<col class="field-body" />
325<tbody valign="top">
326<tr class="field-odd field"><th class="field-name">Return value:</th><td class="field-body">True / False</td>
327</tr>
328</tbody>
329</table>
330</dd></dl>
331
332</div>
333<div class="section" id="module-sas.calculator.kiessig_calculator">
334<span id="sas-calculator-kiessig-calculator-module"></span><h2>sas.calculator.kiessig_calculator module</h2>
335<p>This module is a small tool to allow user to quickly
336determine the size value in real space  from the
337fringe width in q space.</p>
338<dl class="class">
339<dt id="sas.calculator.kiessig_calculator.KiessigThicknessCalculator">
340<em class="property">class </em><tt class="descclassname">sas.calculator.kiessig_calculator.</tt><tt class="descname">KiessigThicknessCalculator</tt><a class="reference internal" href="../../_modules/sas/calculator/kiessig_calculator.html#KiessigThicknessCalculator"><span class="viewcode-link">[source]</span></a></dt>
341<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
342<p>compute thickness from the fringe width of data</p>
343<dl class="method">
344<dt id="sas.calculator.kiessig_calculator.KiessigThicknessCalculator.compute_thickness">
345<tt class="descname">compute_thickness</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/kiessig_calculator.html#KiessigThicknessCalculator.compute_thickness"><span class="viewcode-link">[source]</span></a></dt>
346<dd><p>Calculate thickness.</p>
347<table class="docutils field-list" frame="void" rules="none">
348<col class="field-name" />
349<col class="field-body" />
350<tbody valign="top">
351<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the thickness.</td>
352</tr>
353</tbody>
354</table>
355</dd></dl>
356
357<dl class="method">
358<dt id="sas.calculator.kiessig_calculator.KiessigThicknessCalculator.get_deltaq">
359<tt class="descname">get_deltaq</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/kiessig_calculator.html#KiessigThicknessCalculator.get_deltaq"><span class="viewcode-link">[source]</span></a></dt>
360<dd><p>return deltaQ value in 1/A unit</p>
361</dd></dl>
362
363<dl class="method">
364<dt id="sas.calculator.kiessig_calculator.KiessigThicknessCalculator.get_thickness_unit">
365<tt class="descname">get_thickness_unit</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/kiessig_calculator.html#KiessigThicknessCalculator.get_thickness_unit"><span class="viewcode-link">[source]</span></a></dt>
366<dd><table class="docutils field-list" frame="void" rules="none">
367<col class="field-name" />
368<col class="field-body" />
369<tbody valign="top">
370<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the thickness unit.</td>
371</tr>
372</tbody>
373</table>
374</dd></dl>
375
376<dl class="method">
377<dt id="sas.calculator.kiessig_calculator.KiessigThicknessCalculator.set_deltaq">
378<tt class="descname">set_deltaq</tt><big>(</big><em>dq=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/kiessig_calculator.html#KiessigThicknessCalculator.set_deltaq"><span class="viewcode-link">[source]</span></a></dt>
379<dd><p>Receive deltaQ value</p>
380<table class="docutils field-list" frame="void" rules="none">
381<col class="field-name" />
382<col class="field-body" />
383<tbody valign="top">
384<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dq</strong> &#8211; q fringe width in 1/A unit</td>
385</tr>
386</tbody>
387</table>
388</dd></dl>
389
390</dd></dl>
391
392</div>
393<div class="section" id="module-sas.calculator.resolution_calculator">
394<span id="sas-calculator-resolution-calculator-module"></span><h2>sas.calculator.resolution_calculator module</h2>
395<p>This object is a small tool to allow user to quickly
396determine the variance in q  from the
397instrumental parameters.</p>
398<dl class="class">
399<dt id="sas.calculator.resolution_calculator.ResolutionCalculator">
400<em class="property">class </em><tt class="descclassname">sas.calculator.resolution_calculator.</tt><tt class="descname">ResolutionCalculator</tt><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator"><span class="viewcode-link">[source]</span></a></dt>
401<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
402<p>compute resolution in 2D</p>
403<dl class="method">
404<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.compute">
405<tt class="descname">compute</tt><big>(</big><em>wavelength</em>, <em>wavelength_spread</em>, <em>qx_value</em>, <em>qy_value</em>, <em>coord='cartesian'</em>, <em>tof=False</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.compute"><span class="viewcode-link">[source]</span></a></dt>
406<dd><p>Compute the Q resoltuion in || and + direction of 2D
407: qx_value: x component of q
408: qy_value: y component of q</p>
409</dd></dl>
410
411<dl class="method">
412<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.compute_and_plot">
413<tt class="descname">compute_and_plot</tt><big>(</big><em>qx_value</em>, <em>qy_value</em>, <em>qx_min</em>, <em>qx_max</em>, <em>qy_min</em>, <em>qy_max</em>, <em>coord='cartesian'</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.compute_and_plot"><span class="viewcode-link">[source]</span></a></dt>
414<dd><p>Compute the resolution
415: qx_value: x component of q
416: qy_value: y component of q</p>
417</dd></dl>
418
419<dl class="method">
420<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_all_instrument_params">
421<tt class="descname">get_all_instrument_params</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_all_instrument_params"><span class="viewcode-link">[source]</span></a></dt>
422<dd><p>Get all instrumental parameters</p>
423</dd></dl>
424
425<dl class="method">
426<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_default_spectrum">
427<tt class="descname">get_default_spectrum</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_default_spectrum"><span class="viewcode-link">[source]</span></a></dt>
428<dd><p>Get default_spectrum</p>
429</dd></dl>
430
431<dl class="method">
432<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_detector_pix_size">
433<tt class="descname">get_detector_pix_size</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_detector_pix_size"><span class="viewcode-link">[source]</span></a></dt>
434<dd><p>Get detector pixel size</p>
435</dd></dl>
436
437<dl class="method">
438<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_detector_qrange">
439<tt class="descname">get_detector_qrange</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_detector_qrange"><span class="viewcode-link">[source]</span></a></dt>
440<dd><p>get max detector q ranges</p>
441<p>: return: qx_min, qx_max, qy_min, qy_max tuple</p>
442</dd></dl>
443
444<dl class="method">
445<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_detector_size">
446<tt class="descname">get_detector_size</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_detector_size"><span class="viewcode-link">[source]</span></a></dt>
447<dd><p>Get detector size</p>
448</dd></dl>
449
450<dl class="method">
451<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_image">
452<tt class="descname">get_image</tt><big>(</big><em>qx_value</em>, <em>qy_value</em>, <em>sigma_1</em>, <em>sigma_2</em>, <em>sigma_r</em>, <em>qx_min</em>, <em>qx_max</em>, <em>qy_min</em>, <em>qy_max</em>, <em>coord='cartesian'</em>, <em>full_cal=True</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_image"><span class="viewcode-link">[source]</span></a></dt>
453<dd><p>Get the resolution in polar coordinate ready to plot
454: qx_value: qx_value value
455: qy_value: qy_value value
456: sigma_1: variance in r direction
457: sigma_2: variance in phi direction
458: coord: coordinate system of image, &#8216;polar&#8217; or &#8216;cartesian&#8217;</p>
459</dd></dl>
460
461<dl class="method">
462<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_intensity">
463<tt class="descname">get_intensity</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_intensity"><span class="viewcode-link">[source]</span></a></dt>
464<dd><p>Get intensity</p>
465</dd></dl>
466
467<dl class="method">
468<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_intensity_list">
469<tt class="descname">get_intensity_list</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_intensity_list"><span class="viewcode-link">[source]</span></a></dt>
470<dd><p>Set wavelength spread</p>
471</dd></dl>
472
473<dl class="method">
474<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_neutron_mass">
475<tt class="descname">get_neutron_mass</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_neutron_mass"><span class="viewcode-link">[source]</span></a></dt>
476<dd><p>Get Neutron mass</p>
477</dd></dl>
478
479<dl class="method">
480<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_sample2detector_distance">
481<tt class="descname">get_sample2detector_distance</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_sample2detector_distance"><span class="viewcode-link">[source]</span></a></dt>
482<dd><p>Get detector sample2detector_distance</p>
483</dd></dl>
484
485<dl class="method">
486<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_sample2sample_distance">
487<tt class="descname">get_sample2sample_distance</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_sample2sample_distance"><span class="viewcode-link">[source]</span></a></dt>
488<dd><p>Get detector sampleslitsample_distance</p>
489</dd></dl>
490
491<dl class="method">
492<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_sample_aperture_size">
493<tt class="descname">get_sample_aperture_size</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_sample_aperture_size"><span class="viewcode-link">[source]</span></a></dt>
494<dd><p>Get sample aperture size</p>
495</dd></dl>
496
497<dl class="method">
498<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_source2sample_distance">
499<tt class="descname">get_source2sample_distance</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_source2sample_distance"><span class="viewcode-link">[source]</span></a></dt>
500<dd><p>Get detector source2sample_distance</p>
501</dd></dl>
502
503<dl class="method">
504<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_source_aperture_size">
505<tt class="descname">get_source_aperture_size</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_source_aperture_size"><span class="viewcode-link">[source]</span></a></dt>
506<dd><p>Get source aperture size</p>
507</dd></dl>
508
509<dl class="method">
510<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_spectrum">
511<tt class="descname">get_spectrum</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_spectrum"><span class="viewcode-link">[source]</span></a></dt>
512<dd><p>Get _spectrum</p>
513</dd></dl>
514
515<dl class="method">
516<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_variance">
517<tt class="descname">get_variance</tt><big>(</big><em>size=[]</em>, <em>distance=0</em>, <em>phi=0</em>, <em>comp='radial'</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_variance"><span class="viewcode-link">[source]</span></a></dt>
518<dd><p>Get the variance when the slit/pinhole size is given
519: size: list that can be one(diameter for circular) or two components(lengths for rectangular)
520: distance: [z, x] where z along the incident beam, x // qx_value
521: comp: direction of the sigma; can be &#8216;phi&#8217;, &#8216;y&#8217;, &#8216;x&#8217;, and &#8216;radial&#8217;</p>
522<p>: return variance: sigma^2</p>
523</dd></dl>
524
525<dl class="method">
526<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_variance_gravity">
527<tt class="descname">get_variance_gravity</tt><big>(</big><em>s_distance</em>, <em>d_distance</em>, <em>wavelength</em>, <em>spread</em>, <em>phi</em>, <em>comp='radial'</em>, <em>switch='on'</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_variance_gravity"><span class="viewcode-link">[source]</span></a></dt>
528<dd><p>Get the variance from gravity when the wavelength spread is given</p>
529<p>: s_distance: source to sample distance
530: d_distance: sample to detector distance
531: wavelength: wavelength
532: spread: wavelength spread (ratio)
533: comp: direction of the sigma; can be &#8216;phi&#8217;, &#8216;y&#8217;, &#8216;x&#8217;, and &#8216;radial&#8217;</p>
534<p>: return variance: sigma^2</p>
535</dd></dl>
536
537<dl class="method">
538<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_variance_wave">
539<tt class="descname">get_variance_wave</tt><big>(</big><em>A_value</em>, <em>radius</em>, <em>distance</em>, <em>spread</em>, <em>phi</em>, <em>comp='radial'</em>, <em>switch='on'</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_variance_wave"><span class="viewcode-link">[source]</span></a></dt>
540<dd><p>Get the variance when the wavelength spread is given</p>
541<p>: radius: the radial distance from the beam center to the pix of q
542: distance: sample to detector distance
543: spread: wavelength spread (ratio)
544: comp: direction of the sigma; can be &#8216;phi&#8217;, &#8216;y&#8217;, &#8216;x&#8217;, and &#8216;radial&#8217;</p>
545<p>: return variance: sigma^2 for 2d, sigma^2 for 1d [tuple]</p>
546</dd></dl>
547
548<dl class="method">
549<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_wave_list">
550<tt class="descname">get_wave_list</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_wave_list"><span class="viewcode-link">[source]</span></a></dt>
551<dd><p>Set wavelength spread</p>
552</dd></dl>
553
554<dl class="method">
555<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_wavelength">
556<tt class="descname">get_wavelength</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_wavelength"><span class="viewcode-link">[source]</span></a></dt>
557<dd><p>Get wavelength</p>
558</dd></dl>
559
560<dl class="method">
561<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.get_wavelength_spread">
562<tt class="descname">get_wavelength_spread</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.get_wavelength_spread"><span class="viewcode-link">[source]</span></a></dt>
563<dd><p>Get wavelength spread</p>
564</dd></dl>
565
566<dl class="method">
567<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.plot_image">
568<tt class="descname">plot_image</tt><big>(</big><em>image</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.plot_image"><span class="viewcode-link">[source]</span></a></dt>
569<dd><p>Plot image using pyplot
570: image: 2d resolution image</p>
571<p>: return plt: pylab object</p>
572</dd></dl>
573
574<dl class="method">
575<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.reset_image">
576<tt class="descname">reset_image</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.reset_image"><span class="viewcode-link">[source]</span></a></dt>
577<dd><p>Reset image to default (=[])</p>
578</dd></dl>
579
580<dl class="method">
581<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.set_detector_pix_size">
582<tt class="descname">set_detector_pix_size</tt><big>(</big><em>size</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.set_detector_pix_size"><span class="viewcode-link">[source]</span></a></dt>
583<dd><p>Set detector pixel size</p>
584</dd></dl>
585
586<dl class="method">
587<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.set_detector_size">
588<tt class="descname">set_detector_size</tt><big>(</big><em>size</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.set_detector_size"><span class="viewcode-link">[source]</span></a></dt>
589<dd><p>Set detector size in number of pixels
590: param size: [pixel_nums] or [x_pix_num, yx_pix_num]</p>
591</dd></dl>
592
593<dl class="method">
594<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.set_intensity">
595<tt class="descname">set_intensity</tt><big>(</big><em>intensity</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.set_intensity"><span class="viewcode-link">[source]</span></a></dt>
596<dd><p>Set intensity</p>
597</dd></dl>
598
599<dl class="method">
600<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.set_neutron_mass">
601<tt class="descname">set_neutron_mass</tt><big>(</big><em>mass</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.set_neutron_mass"><span class="viewcode-link">[source]</span></a></dt>
602<dd><p>Set Neutron mass</p>
603</dd></dl>
604
605<dl class="method">
606<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.set_sample2detector_distance">
607<tt class="descname">set_sample2detector_distance</tt><big>(</big><em>distance</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.set_sample2detector_distance"><span class="viewcode-link">[source]</span></a></dt>
608<dd><p>Set detector sample2detector_distance</p>
609<p>: param distance: [distance, x_offset]</p>
610</dd></dl>
611
612<dl class="method">
613<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.set_sample2sample_distance">
614<tt class="descname">set_sample2sample_distance</tt><big>(</big><em>distance</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.set_sample2sample_distance"><span class="viewcode-link">[source]</span></a></dt>
615<dd><p>Set detector sample_slit2sample_distance</p>
616<p>: param distance: [distance, x_offset]</p>
617</dd></dl>
618
619<dl class="method">
620<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.set_sample_aperture_size">
621<tt class="descname">set_sample_aperture_size</tt><big>(</big><em>size</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.set_sample_aperture_size"><span class="viewcode-link">[source]</span></a></dt>
622<dd><p>Set sample aperture size</p>
623<p>: param size: [dia_value] or [xheight_value, yheight_value]</p>
624</dd></dl>
625
626<dl class="method">
627<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.set_source2sample_distance">
628<tt class="descname">set_source2sample_distance</tt><big>(</big><em>distance</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.set_source2sample_distance"><span class="viewcode-link">[source]</span></a></dt>
629<dd><p>Set detector source2sample_distance</p>
630<p>: param distance: [distance, x_offset]</p>
631</dd></dl>
632
633<dl class="method">
634<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.set_source_aperture_size">
635<tt class="descname">set_source_aperture_size</tt><big>(</big><em>size</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.set_source_aperture_size"><span class="viewcode-link">[source]</span></a></dt>
636<dd><p>Set source aperture size</p>
637<p>: param size: [dia_value] or [x_value, y_value]</p>
638</dd></dl>
639
640<dl class="method">
641<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.set_spectrum">
642<tt class="descname">set_spectrum</tt><big>(</big><em>spectrum</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.set_spectrum"><span class="viewcode-link">[source]</span></a></dt>
643<dd><p>Set spectrum</p>
644</dd></dl>
645
646<dl class="method">
647<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.set_wave">
648<tt class="descname">set_wave</tt><big>(</big><em>wavelength</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.set_wave"><span class="viewcode-link">[source]</span></a></dt>
649<dd><p>Set wavelength list or wavelength</p>
650</dd></dl>
651
652<dl class="method">
653<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.set_wave_list">
654<tt class="descname">set_wave_list</tt><big>(</big><em>wavelength_list</em>, <em>wavelengthspread_list</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.set_wave_list"><span class="viewcode-link">[source]</span></a></dt>
655<dd><p>Set wavelength and its spread list</p>
656</dd></dl>
657
658<dl class="method">
659<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.set_wave_spread">
660<tt class="descname">set_wave_spread</tt><big>(</big><em>wavelength_spread</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.set_wave_spread"><span class="viewcode-link">[source]</span></a></dt>
661<dd><p>Set wavelength spread  or wavelength spread</p>
662</dd></dl>
663
664<dl class="method">
665<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.set_wavelength">
666<tt class="descname">set_wavelength</tt><big>(</big><em>wavelength</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.set_wavelength"><span class="viewcode-link">[source]</span></a></dt>
667<dd><p>Set wavelength</p>
668</dd></dl>
669
670<dl class="method">
671<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.set_wavelength_spread">
672<tt class="descname">set_wavelength_spread</tt><big>(</big><em>wavelength_spread</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.set_wavelength_spread"><span class="viewcode-link">[source]</span></a></dt>
673<dd><p>Set wavelength spread</p>
674</dd></dl>
675
676<dl class="method">
677<dt id="sas.calculator.resolution_calculator.ResolutionCalculator.setup_tof">
678<tt class="descname">setup_tof</tt><big>(</big><em>wavelength</em>, <em>wavelength_spread</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/resolution_calculator.html#ResolutionCalculator.setup_tof"><span class="viewcode-link">[source]</span></a></dt>
679<dd><p>Setup all parameters in instrument</p>
680<p>: param ind: index of lambda, etc</p>
681</dd></dl>
682
683</dd></dl>
684
685</div>
686<div class="section" id="module-sas.calculator.sas_gen">
687<span id="sas-calculator-sas-gen-module"></span><h2>sas.calculator.sas_gen module</h2>
688<p>SAS generic computation and sld file readers</p>
689<dl class="class">
690<dt id="sas.calculator.sas_gen.GenSAS">
691<em class="property">class </em><tt class="descclassname">sas.calculator.sas_gen.</tt><tt class="descname">GenSAS</tt><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#GenSAS"><span class="viewcode-link">[source]</span></a></dt>
692<dd><p>Bases: <a class="reference internal" href="sas.models.html#sas.models.BaseComponent.BaseComponent" title="sas.models.BaseComponent.BaseComponent"><tt class="xref py py-class docutils literal"><span class="pre">sas.models.BaseComponent.BaseComponent</span></tt></a></p>
693<p>Generic SAS computation Model based on sld (n &amp; m) arrays</p>
694<dl class="method">
695<dt id="sas.calculator.sas_gen.GenSAS.evalDistribution">
696<tt class="descname">evalDistribution</tt><big>(</big><em>qdist</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#GenSAS.evalDistribution"><span class="viewcode-link">[source]</span></a></dt>
697<dd><p>Evaluate a distribution of q-values.
698* For 1D, a numpy array is expected as input: evalDistribution(q) where q is a numpy array.
699* For 2D, a list of numpy arrays are expected: [qx_prime,qy_prime], where 1D arrays.
700:param qdist: ndarray of scalar q-values or list [qx,qy] where qx,qy are 1D ndarrays</p>
701</dd></dl>
702
703<dl class="method">
704<dt id="sas.calculator.sas_gen.GenSAS.getProfile">
705<tt class="descname">getProfile</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#GenSAS.getProfile"><span class="viewcode-link">[source]</span></a></dt>
706<dd><p>Get SLD profile</p>
707<p>: return: sld_data</p>
708</dd></dl>
709
710<dl class="method">
711<dt id="sas.calculator.sas_gen.GenSAS.run">
712<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#GenSAS.run"><span class="viewcode-link">[source]</span></a></dt>
713<dd><p>Evaluate the model
714:param x: simple value
715:return: (I value)</p>
716</dd></dl>
717
718<dl class="method">
719<dt id="sas.calculator.sas_gen.GenSAS.runXY">
720<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#GenSAS.runXY"><span class="viewcode-link">[source]</span></a></dt>
721<dd><p>Evaluate the model
722:param x: simple value
723:return: I value
724:Use this runXY() for the computation</p>
725</dd></dl>
726
727<dl class="method">
728<dt id="sas.calculator.sas_gen.GenSAS.set_is_avg">
729<tt class="descname">set_is_avg</tt><big>(</big><em>is_avg=False</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#GenSAS.set_is_avg"><span class="viewcode-link">[source]</span></a></dt>
730<dd><p>Sets is_avg: [bool]</p>
731</dd></dl>
732
733<dl class="method">
734<dt id="sas.calculator.sas_gen.GenSAS.set_pixel_volumes">
735<tt class="descname">set_pixel_volumes</tt><big>(</big><em>volume</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#GenSAS.set_pixel_volumes"><span class="viewcode-link">[source]</span></a></dt>
736<dd><p>Set the volume of a pixel in (A^3) unit
737:Param volume: pixel volume [float]</p>
738</dd></dl>
739
740<dl class="method">
741<dt id="sas.calculator.sas_gen.GenSAS.set_sld_data">
742<tt class="descname">set_sld_data</tt><big>(</big><em>sld_data=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#GenSAS.set_sld_data"><span class="viewcode-link">[source]</span></a></dt>
743<dd><p>Sets sld_data</p>
744</dd></dl>
745
746</dd></dl>
747
748<dl class="class">
749<dt id="sas.calculator.sas_gen.MagSLD">
750<em class="property">class </em><tt class="descclassname">sas.calculator.sas_gen.</tt><tt class="descname">MagSLD</tt><big>(</big><em>pos_x</em>, <em>pos_y</em>, <em>pos_z</em>, <em>sld_n=None</em>, <em>sld_mx=None</em>, <em>sld_my=None</em>, <em>sld_mz=None</em>, <em>vol_pix=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#MagSLD"><span class="viewcode-link">[source]</span></a></dt>
751<dd><p>Magnetic SLD.</p>
752<dl class="method">
753<dt id="sas.calculator.sas_gen.MagSLD.get_sld_m">
754<tt class="descname">get_sld_m</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#MagSLD.get_sld_m"><span class="viewcode-link">[source]</span></a></dt>
755<dd><p>Returns (sldm, sld_theta, sld_phi)</p>
756</dd></dl>
757
758<dl class="method">
759<dt id="sas.calculator.sas_gen.MagSLD.get_sld_mxyz">
760<tt class="descname">get_sld_mxyz</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#MagSLD.get_sld_mxyz"><span class="viewcode-link">[source]</span></a></dt>
761<dd><p>Returns (sld_mx, sldmy, sld_mz)</p>
762</dd></dl>
763
764<dl class="method">
765<dt id="sas.calculator.sas_gen.MagSLD.get_sldn">
766<tt class="descname">get_sldn</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#MagSLD.get_sldn"><span class="viewcode-link">[source]</span></a></dt>
767<dd><p>Returns nuclear sld</p>
768</dd></dl>
769
770<dl class="attribute">
771<dt id="sas.calculator.sas_gen.MagSLD.pos_x">
772<tt class="descname">pos_x</tt><em class="property"> = None</em></dt>
773<dd></dd></dl>
774
775<dl class="attribute">
776<dt id="sas.calculator.sas_gen.MagSLD.pos_y">
777<tt class="descname">pos_y</tt><em class="property"> = None</em></dt>
778<dd></dd></dl>
779
780<dl class="attribute">
781<dt id="sas.calculator.sas_gen.MagSLD.pos_z">
782<tt class="descname">pos_z</tt><em class="property"> = None</em></dt>
783<dd></dd></dl>
784
785<dl class="method">
786<dt id="sas.calculator.sas_gen.MagSLD.set_conect_lines">
787<tt class="descname">set_conect_lines</tt><big>(</big><em>line_x</em>, <em>line_y</em>, <em>line_z</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#MagSLD.set_conect_lines"><span class="viewcode-link">[source]</span></a></dt>
788<dd><p>Set bonding line data if taken from pdb</p>
789</dd></dl>
790
791<dl class="method">
792<dt id="sas.calculator.sas_gen.MagSLD.set_nodes">
793<tt class="descname">set_nodes</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#MagSLD.set_nodes"><span class="viewcode-link">[source]</span></a></dt>
794<dd><p>Set xnodes, ynodes, and znodes</p>
795</dd></dl>
796
797<dl class="method">
798<dt id="sas.calculator.sas_gen.MagSLD.set_pix_type">
799<tt class="descname">set_pix_type</tt><big>(</big><em>pix_type</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#MagSLD.set_pix_type"><span class="viewcode-link">[source]</span></a></dt>
800<dd><p>Set pixel type
801:Param pix_type: string, &#8216;pixel&#8217; or &#8216;atom&#8217;</p>
802</dd></dl>
803
804<dl class="method">
805<dt id="sas.calculator.sas_gen.MagSLD.set_pixel_symbols">
806<tt class="descname">set_pixel_symbols</tt><big>(</big><em>symbol='pixel'</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#MagSLD.set_pixel_symbols"><span class="viewcode-link">[source]</span></a></dt>
807<dd><p>Set pixel
808:Params pixel: str; pixel or atomic symbol, or array of strings</p>
809</dd></dl>
810
811<dl class="method">
812<dt id="sas.calculator.sas_gen.MagSLD.set_pixel_volumes">
813<tt class="descname">set_pixel_volumes</tt><big>(</big><em>vol</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#MagSLD.set_pixel_volumes"><span class="viewcode-link">[source]</span></a></dt>
814<dd><p>Set pixel volumes
815:Params pixel: str; pixel or atomic symbol, or array of strings</p>
816</dd></dl>
817
818<dl class="method">
819<dt id="sas.calculator.sas_gen.MagSLD.set_sldms">
820<tt class="descname">set_sldms</tt><big>(</big><em>sld_mx</em>, <em>sld_my</em>, <em>sld_mz</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#MagSLD.set_sldms"><span class="viewcode-link">[source]</span></a></dt>
821<dd><p>Sets (|m|, m_theta, m_phi)</p>
822</dd></dl>
823
824<dl class="method">
825<dt id="sas.calculator.sas_gen.MagSLD.set_sldn">
826<tt class="descname">set_sldn</tt><big>(</big><em>sld_n</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#MagSLD.set_sldn"><span class="viewcode-link">[source]</span></a></dt>
827<dd><p>Sets neutron SLD</p>
828</dd></dl>
829
830<dl class="method">
831<dt id="sas.calculator.sas_gen.MagSLD.set_stepsize">
832<tt class="descname">set_stepsize</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#MagSLD.set_stepsize"><span class="viewcode-link">[source]</span></a></dt>
833<dd><p>Set xtepsize, ystepsize, and zstepsize</p>
834</dd></dl>
835
836<dl class="attribute">
837<dt id="sas.calculator.sas_gen.MagSLD.sld_mx">
838<tt class="descname">sld_mx</tt><em class="property"> = None</em></dt>
839<dd></dd></dl>
840
841<dl class="attribute">
842<dt id="sas.calculator.sas_gen.MagSLD.sld_my">
843<tt class="descname">sld_my</tt><em class="property"> = None</em></dt>
844<dd></dd></dl>
845
846<dl class="attribute">
847<dt id="sas.calculator.sas_gen.MagSLD.sld_mz">
848<tt class="descname">sld_mz</tt><em class="property"> = None</em></dt>
849<dd></dd></dl>
850
851<dl class="attribute">
852<dt id="sas.calculator.sas_gen.MagSLD.sld_n">
853<tt class="descname">sld_n</tt><em class="property"> = None</em></dt>
854<dd></dd></dl>
855
856</dd></dl>
857
858<dl class="class">
859<dt id="sas.calculator.sas_gen.OMF2SLD">
860<em class="property">class </em><tt class="descclassname">sas.calculator.sas_gen.</tt><tt class="descname">OMF2SLD</tt><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#OMF2SLD"><span class="viewcode-link">[source]</span></a></dt>
861<dd><p>Convert OMFData to MAgData</p>
862<dl class="method">
863<dt id="sas.calculator.sas_gen.OMF2SLD.get_magsld">
864<tt class="descname">get_magsld</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#OMF2SLD.get_magsld"><span class="viewcode-link">[source]</span></a></dt>
865<dd><p>return MagSLD</p>
866</dd></dl>
867
868<dl class="method">
869<dt id="sas.calculator.sas_gen.OMF2SLD.get_omfdata">
870<tt class="descname">get_omfdata</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#OMF2SLD.get_omfdata"><span class="viewcode-link">[source]</span></a></dt>
871<dd><p>Return all data</p>
872</dd></dl>
873
874<dl class="method">
875<dt id="sas.calculator.sas_gen.OMF2SLD.get_output">
876<tt class="descname">get_output</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#OMF2SLD.get_output"><span class="viewcode-link">[source]</span></a></dt>
877<dd><p>Return output</p>
878</dd></dl>
879
880<dl class="method">
881<dt id="sas.calculator.sas_gen.OMF2SLD.remove_null_points">
882<tt class="descname">remove_null_points</tt><big>(</big><em>remove=False</em>, <em>recenter=False</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#OMF2SLD.remove_null_points"><span class="viewcode-link">[source]</span></a></dt>
883<dd><p>Removes any mx, my, and mz = 0 points</p>
884</dd></dl>
885
886<dl class="method">
887<dt id="sas.calculator.sas_gen.OMF2SLD.set_data">
888<tt class="descname">set_data</tt><big>(</big><em>omfdata</em>, <em>shape='rectangular'</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#OMF2SLD.set_data"><span class="viewcode-link">[source]</span></a></dt>
889<dd><p>Set all data</p>
890</dd></dl>
891
892</dd></dl>
893
894<dl class="class">
895<dt id="sas.calculator.sas_gen.OMFData">
896<em class="property">class </em><tt class="descclassname">sas.calculator.sas_gen.</tt><tt class="descname">OMFData</tt><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#OMFData"><span class="viewcode-link">[source]</span></a></dt>
897<dd><p>OMF Data.</p>
898<dl class="method">
899<dt id="sas.calculator.sas_gen.OMFData.set_m">
900<tt class="descname">set_m</tt><big>(</big><em>mx</em>, <em>my</em>, <em>mz</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#OMFData.set_m"><span class="viewcode-link">[source]</span></a></dt>
901<dd><p>Set the Mx, My, Mz values</p>
902</dd></dl>
903
904</dd></dl>
905
906<dl class="class">
907<dt id="sas.calculator.sas_gen.OMFReader">
908<em class="property">class </em><tt class="descclassname">sas.calculator.sas_gen.</tt><tt class="descname">OMFReader</tt><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#OMFReader"><span class="viewcode-link">[source]</span></a></dt>
909<dd><p>Class to load omf/ascii files (3 columns w/header).</p>
910<dl class="attribute">
911<dt id="sas.calculator.sas_gen.OMFReader.ext">
912<tt class="descname">ext</tt><em class="property"> = ['.omf', '.OMF']</em></dt>
913<dd></dd></dl>
914
915<dl class="method">
916<dt id="sas.calculator.sas_gen.OMFReader.read">
917<tt class="descname">read</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#OMFReader.read"><span class="viewcode-link">[source]</span></a></dt>
918<dd><p>Load data file
919:param path: file path
920:return: x, y, z, sld_n, sld_mx, sld_my, sld_mz</p>
921</dd></dl>
922
923<dl class="attribute">
924<dt id="sas.calculator.sas_gen.OMFReader.type">
925<tt class="descname">type</tt><em class="property"> = ['OMF files (*.OMF, *.omf)|*.omf']</em></dt>
926<dd></dd></dl>
927
928<dl class="attribute">
929<dt id="sas.calculator.sas_gen.OMFReader.type_name">
930<tt class="descname">type_name</tt><em class="property"> = 'OMF ASCII'</em></dt>
931<dd></dd></dl>
932
933</dd></dl>
934
935<dl class="class">
936<dt id="sas.calculator.sas_gen.PDBReader">
937<em class="property">class </em><tt class="descclassname">sas.calculator.sas_gen.</tt><tt class="descname">PDBReader</tt><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#PDBReader"><span class="viewcode-link">[source]</span></a></dt>
938<dd><p>PDB reader class: limited for reading the lines starting with &#8216;ATOM&#8217;</p>
939<dl class="attribute">
940<dt id="sas.calculator.sas_gen.PDBReader.ext">
941<tt class="descname">ext</tt><em class="property"> = ['.pdb', '.PDB']</em></dt>
942<dd></dd></dl>
943
944<dl class="method">
945<dt id="sas.calculator.sas_gen.PDBReader.read">
946<tt class="descname">read</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#PDBReader.read"><span class="viewcode-link">[source]</span></a></dt>
947<dd><p>Load data file</p>
948<table class="docutils field-list" frame="void" rules="none">
949<col class="field-name" />
950<col class="field-body" />
951<tbody valign="top">
952<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> &#8211; file path</td>
953</tr>
954<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">MagSLD</td>
955</tr>
956<tr class="field-odd field"><th class="field-name" colspan="2">Raises RuntimeError:</th></tr>
957<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">when the file can&#8217;t be opened</td>
958</tr>
959</tbody>
960</table>
961</dd></dl>
962
963<dl class="attribute">
964<dt id="sas.calculator.sas_gen.PDBReader.type">
965<tt class="descname">type</tt><em class="property"> = ['pdb files (*.PDB, *.pdb)|*.pdb']</em></dt>
966<dd></dd></dl>
967
968<dl class="attribute">
969<dt id="sas.calculator.sas_gen.PDBReader.type_name">
970<tt class="descname">type_name</tt><em class="property"> = 'PDB'</em></dt>
971<dd></dd></dl>
972
973<dl class="method">
974<dt id="sas.calculator.sas_gen.PDBReader.write">
975<tt class="descname">write</tt><big>(</big><em>path</em>, <em>data</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#PDBReader.write"><span class="viewcode-link">[source]</span></a></dt>
976<dd><p>Write</p>
977</dd></dl>
978
979</dd></dl>
980
981<dl class="class">
982<dt id="sas.calculator.sas_gen.SLDReader">
983<em class="property">class </em><tt class="descclassname">sas.calculator.sas_gen.</tt><tt class="descname">SLDReader</tt><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#SLDReader"><span class="viewcode-link">[source]</span></a></dt>
984<dd><p>Class to load ascii files (7 columns).</p>
985<dl class="attribute">
986<dt id="sas.calculator.sas_gen.SLDReader.ext">
987<tt class="descname">ext</tt><em class="property"> = ['.sld', '.SLD', '.txt', '.TXT', '.*']</em></dt>
988<dd></dd></dl>
989
990<dl class="method">
991<dt id="sas.calculator.sas_gen.SLDReader.read">
992<tt class="descname">read</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#SLDReader.read"><span class="viewcode-link">[source]</span></a></dt>
993<dd><p>Load data file</p>
994<table class="docutils field-list" frame="void" rules="none">
995<col class="field-name" />
996<col class="field-body" />
997<tbody valign="top">
998<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>path</strong> &#8211; file path</p>
999</td>
1000</tr>
1001<tr class="field-even field"><th class="field-name">Return MagSLD:</th><td class="field-body"><p class="first">x, y, z, sld_n, sld_mx, sld_my, sld_mz</p>
1002</td>
1003</tr>
1004<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
1005<li><strong>RuntimeError</strong> &#8211; when the file can&#8217;t be opened</li>
1006<li><strong>ValueError</strong> &#8211; when the length of the data vectors are inconsistent</li>
1007</ul>
1008</td>
1009</tr>
1010</tbody>
1011</table>
1012</dd></dl>
1013
1014<dl class="attribute">
1015<dt id="sas.calculator.sas_gen.SLDReader.type">
1016<tt class="descname">type</tt><em class="property"> = ['sld files (*.SLD, *.sld)|*.sld', 'txt files (*.TXT, *.txt)|*.txt', 'all files (*.*)|*.*']</em></dt>
1017<dd></dd></dl>
1018
1019<dl class="attribute">
1020<dt id="sas.calculator.sas_gen.SLDReader.type_name">
1021<tt class="descname">type_name</tt><em class="property"> = 'SLD ASCII'</em></dt>
1022<dd></dd></dl>
1023
1024<dl class="method">
1025<dt id="sas.calculator.sas_gen.SLDReader.write">
1026<tt class="descname">write</tt><big>(</big><em>path</em>, <em>data</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#SLDReader.write"><span class="viewcode-link">[source]</span></a></dt>
1027<dd><p>Write sld file</p>
1028<table class="docutils field-list" frame="void" rules="none">
1029<col class="field-name" />
1030<col class="field-body" />
1031<tbody valign="top">
1032<tr class="field-odd field"><th class="field-name">Param path:</th><td class="field-body">file path</td>
1033</tr>
1034<tr class="field-even field"><th class="field-name">Param data:</th><td class="field-body">MagSLD data object</td>
1035</tr>
1036</tbody>
1037</table>
1038</dd></dl>
1039
1040</dd></dl>
1041
1042<dl class="function">
1043<dt id="sas.calculator.sas_gen.mag2sld">
1044<tt class="descclassname">sas.calculator.sas_gen.</tt><tt class="descname">mag2sld</tt><big>(</big><em>mag</em>, <em>v_unit=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#mag2sld"><span class="viewcode-link">[source]</span></a></dt>
1045<dd><p>Convert magnetization to magnatic SLD
1046sldm = Dm * mag where Dm = gamma * classical elec. radius/(2*Bohr magneton)
1047Dm ~ 2.853E-12 [A^(-2)] ==&gt; Shouldn&#8217;t be 2.90636E-12 [A^(-2)]???</p>
1048</dd></dl>
1049
1050<dl class="function">
1051<dt id="sas.calculator.sas_gen.test">
1052<tt class="descclassname">sas.calculator.sas_gen.</tt><tt class="descname">test</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#test"><span class="viewcode-link">[source]</span></a></dt>
1053<dd></dd></dl>
1054
1055<dl class="function">
1056<dt id="sas.calculator.sas_gen.test_load">
1057<tt class="descclassname">sas.calculator.sas_gen.</tt><tt class="descname">test_load</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#test_load"><span class="viewcode-link">[source]</span></a></dt>
1058<dd></dd></dl>
1059
1060<dl class="function">
1061<dt id="sas.calculator.sas_gen.transform_center">
1062<tt class="descclassname">sas.calculator.sas_gen.</tt><tt class="descname">transform_center</tt><big>(</big><em>pos_x</em>, <em>pos_y</em>, <em>pos_z</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/sas_gen.html#transform_center"><span class="viewcode-link">[source]</span></a></dt>
1063<dd><p>re-center</p>
1064<table class="docutils field-list" frame="void" rules="none">
1065<col class="field-name" />
1066<col class="field-body" />
1067<tbody valign="top">
1068<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">posx, posy, posz   [arrays]</td>
1069</tr>
1070</tbody>
1071</table>
1072</dd></dl>
1073
1074</div>
1075<div class="section" id="module-sas.calculator.slit_length_calculator">
1076<span id="sas-calculator-slit-length-calculator-module"></span><h2>sas.calculator.slit_length_calculator module</h2>
1077<p>This module is a small tool to allow user to quickly
1078determine the slit length value of data.</p>
1079<dl class="class">
1080<dt id="sas.calculator.slit_length_calculator.SlitlengthCalculator">
1081<em class="property">class </em><tt class="descclassname">sas.calculator.slit_length_calculator.</tt><tt class="descname">SlitlengthCalculator</tt><a class="reference internal" href="../../_modules/sas/calculator/slit_length_calculator.html#SlitlengthCalculator"><span class="viewcode-link">[source]</span></a></dt>
1082<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
1083<p>compute slit length from SAXSess beam profile (1st col. Q , 2nd col. I ,
1084and 3rd col. dI.: don&#8217;t need the 3rd)</p>
1085<dl class="method">
1086<dt id="sas.calculator.slit_length_calculator.SlitlengthCalculator.calculate_slit_length">
1087<tt class="descname">calculate_slit_length</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/slit_length_calculator.html#SlitlengthCalculator.calculate_slit_length"><span class="viewcode-link">[source]</span></a></dt>
1088<dd><p>Calculate slit length.</p>
1089<table class="docutils field-list" frame="void" rules="none">
1090<col class="field-name" />
1091<col class="field-body" />
1092<tbody valign="top">
1093<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the slit length calculated value.</td>
1094</tr>
1095</tbody>
1096</table>
1097</dd></dl>
1098
1099<dl class="method">
1100<dt id="sas.calculator.slit_length_calculator.SlitlengthCalculator.get_slit_length_unit">
1101<tt class="descname">get_slit_length_unit</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/slit_length_calculator.html#SlitlengthCalculator.get_slit_length_unit"><span class="viewcode-link">[source]</span></a></dt>
1102<dd><table class="docutils field-list" frame="void" rules="none">
1103<col class="field-name" />
1104<col class="field-body" />
1105<tbody valign="top">
1106<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the slit length unit.</td>
1107</tr>
1108</tbody>
1109</table>
1110</dd></dl>
1111
1112<dl class="method">
1113<dt id="sas.calculator.slit_length_calculator.SlitlengthCalculator.set_data">
1114<tt class="descname">set_data</tt><big>(</big><em>x=None</em>, <em>y=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/calculator/slit_length_calculator.html#SlitlengthCalculator.set_data"><span class="viewcode-link">[source]</span></a></dt>
1115<dd><blockquote>
1116<div>Receive two vector x, y and prepare the slit calculator for
1117computation.</div></blockquote>
1118<table class="docutils field-list" frame="void" rules="none">
1119<col class="field-name" />
1120<col class="field-body" />
1121<tbody valign="top">
1122<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
1123<li><strong>x</strong> &#8211; array</li>
1124<li><strong>y</strong> &#8211; array</li>
1125</ul>
1126</td>
1127</tr>
1128</tbody>
1129</table>
1130</dd></dl>
1131
1132</dd></dl>
1133
1134</div>
1135<div class="section" id="module-sas.calculator">
1136<span id="module-contents"></span><h2>Module contents</h2>
1137</div>
1138</div>
1139
1140
1141          </div>
1142        </div>
1143      </div>
1144      <div class="sphinxsidebar">
1145        <div class="sphinxsidebarwrapper">
1146  <h3><a href="../../index.html">Table Of Contents</a></h3>
1147  <ul>
1148<li><a class="reference internal" href="#">sas.calculator package</a><ul>
1149<li><a class="reference internal" href="#submodules">Submodules</a></li>
1150<li><a class="reference internal" href="#module-sas.calculator.instrument">sas.calculator.instrument module</a></li>
1151<li><a class="reference internal" href="#module-sas.calculator.kiessig_calculator">sas.calculator.kiessig_calculator module</a></li>
1152<li><a class="reference internal" href="#module-sas.calculator.resolution_calculator">sas.calculator.resolution_calculator module</a></li>
1153<li><a class="reference internal" href="#module-sas.calculator.sas_gen">sas.calculator.sas_gen module</a></li>
1154<li><a class="reference internal" href="#module-sas.calculator.slit_length_calculator">sas.calculator.slit_length_calculator module</a></li>
1155<li><a class="reference internal" href="#module-sas.calculator">Module contents</a></li>
1156</ul>
1157</li>
1158</ul>
1159
1160  <h4>Previous topic</h4>
1161  <p class="topless"><a href="sas.html"
1162                        title="previous chapter">sas package</a></p>
1163  <h4>Next topic</h4>
1164  <p class="topless"><a href="sas.data_util.html"
1165                        title="next chapter">sas.data_util package</a></p>
1166  <h3>This Page</h3>
1167  <ul class="this-page-menu">
1168    <li><a href="../../_sources/dev/api/sas.calculator.txt"
1169           rel="nofollow">Show Source</a></li>
1170  </ul>
1171<div id="searchbox" style="display: none">
1172  <h3>Quick search</h3>
1173    <form class="search" action="../../search.html" method="get">
1174      <input type="text" name="q" />
1175      <input type="submit" value="Go" />
1176      <input type="hidden" name="check_keywords" value="yes" />
1177      <input type="hidden" name="area" value="default" />
1178    </form>
1179    <p class="searchtip" style="font-size: 90%">
1180    Enter search terms or a module, class or function name.
1181    </p>
1182</div>
1183<script type="text/javascript">$('#searchbox').show(0);</script>
1184        </div>
1185      </div>
1186      <div class="clearer"></div>
1187    </div>
1188    <div class="related">
1189      <h3>Navigation</h3>
1190      <ul>
1191        <li class="right" style="margin-right: 10px">
1192          <a href="../../genindex.html" title="General Index"
1193             >index</a></li>
1194        <li class="right" >
1195          <a href="../../py-modindex.html" title="Python Module Index"
1196             >modules</a> |</li>
1197        <li class="right" >
1198          <a href="sas.data_util.html" title="sas.data_util package"
1199             >next</a> |</li>
1200        <li class="right" >
1201          <a href="sas.html" title="sas package"
1202             >previous</a> |</li>
1203        <li><a href="../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
1204          <li><a href="../dev.html" >Developer Documentation</a> &raquo;</li>
1205          <li><a href="modules.html" >lib.macosx-10.5-x86_64-2.7</a> &raquo;</li>
1206          <li><a href="sas.html" >sas package</a> &raquo;</li> 
1207      </ul>
1208    </div>
1209    <div class="footer">
1210        &copy; Copyright 2013, The SasView Project.
1211      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
1212    </div>
1213  </body>
1214</html>
Note: See TracBrowser for help on using the repository browser.