source: sasview/sanscalculator/docs/sphinx/_build/html/api/instrument.html @ 0166aa6

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 0166aa6 was 0166aa6, checked in by Jessica Tumarkin <jtumarki@…>, 13 years ago

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 26.0 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>Instrument &mdash; calculator v0.1.0 documentation</title>
11    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13    <script type="text/javascript">
14      var DOCUMENTATION_OPTIONS = {
15        URL_ROOT:    '../',
16        VERSION:     '0.1.0',
17        COLLAPSE_INDEX: false,
18        FILE_SUFFIX: '.html',
19        HAS_SOURCE:  true
20      };
21    </script>
22    <script type="text/javascript" src="../_static/jquery.js"></script>
23    <script type="text/javascript" src="../_static/underscore.js"></script>
24    <script type="text/javascript" src="../_static/doctools.js"></script>
25    <link rel="top" title="calculator v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="next" title="Slit Length Calculator" href="slit_length_calculator.html" />
28    <link rel="prev" title="Reference" href="index.html" /> 
29  </head>
30  <body>
31    <div class="related">
32      <h3>Navigation</h3>
33      <ul>
34        <li class="right" style="margin-right: 10px">
35          <a href="../genindex.html" title="General Index"
36             accesskey="I">index</a></li>
37        <li class="right" >
38          <a href="../py-modindex.html" title="Python Module Index"
39             >modules</a> |</li>
40        <li class="right" >
41          <a href="slit_length_calculator.html" title="Slit Length Calculator"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="index.html" title="Reference"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../index.html">calculator v0.1.0 documentation</a> &raquo;</li>
47          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
48      </ul>
49    </div> 
50
51    <div class="document">
52      <div class="documentwrapper">
53        <div class="bodywrapper">
54          <div class="body">
55           
56  <div class="section" id="instrument">
57<h1>Instrument<a class="headerlink" href="#instrument" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.calculator.instrument">
59<span id="sans-calculator-instrument"></span><h2><a class="reference internal" href="#module-sans.calculator.instrument" title="sans.calculator.instrument"><tt class="xref py py-mod docutils literal"><span class="pre">sans.calculator.instrument</span></tt></a><a class="headerlink" href="#module-sans.calculator.instrument" title="Permalink to this headline">¶</a></h2>
60<p>This module is a small tool to allow user to
61control instrumental parameters</p>
62<dl class="class">
63<dt id="sans.calculator.instrument.Aperture">
64<em class="property">class </em><tt class="descclassname">sans.calculator.instrument.</tt><tt class="descname">Aperture</tt><a class="headerlink" href="#sans.calculator.instrument.Aperture" title="Permalink to this definition">¶</a></dt>
65<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
66<p>An object class that defines the aperture variables</p>
67<dl class="method">
68<dt id="sans.calculator.instrument.Aperture.set_sample_distance">
69<tt class="descname">set_sample_distance</tt><big>(</big><em>distance=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Aperture.set_sample_distance" title="Permalink to this definition">¶</a></dt>
70<dd><p>Set the sample aperture distance</p>
71</dd></dl>
72
73<dl class="method">
74<dt id="sans.calculator.instrument.Aperture.set_sample_size">
75<tt class="descname">set_sample_size</tt><big>(</big><em>size=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Aperture.set_sample_size" title="Permalink to this definition">¶</a></dt>
76<dd><p>Set the sample aperture size</p>
77</dd></dl>
78
79<dl class="method">
80<dt id="sans.calculator.instrument.Aperture.set_source_size">
81<tt class="descname">set_source_size</tt><big>(</big><em>size=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Aperture.set_source_size" title="Permalink to this definition">¶</a></dt>
82<dd><p>Set the source aperture size</p>
83</dd></dl>
84
85</dd></dl>
86
87<dl class="class">
88<dt id="sans.calculator.instrument.Detector">
89<em class="property">class </em><tt class="descclassname">sans.calculator.instrument.</tt><tt class="descname">Detector</tt><a class="headerlink" href="#sans.calculator.instrument.Detector" title="Permalink to this definition">¶</a></dt>
90<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
91<p>An object class that defines the detector variables</p>
92<dl class="method">
93<dt id="sans.calculator.instrument.Detector.set_distance">
94<tt class="descname">set_distance</tt><big>(</big><em>distance=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Detector.set_distance" title="Permalink to this definition">¶</a></dt>
95<dd><p>Set the detector distance</p>
96</dd></dl>
97
98<dl class="method">
99<dt id="sans.calculator.instrument.Detector.set_pix_size">
100<tt class="descname">set_pix_size</tt><big>(</big><em>size=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Detector.set_pix_size" title="Permalink to this definition">¶</a></dt>
101<dd><p>Set the detector pix_size</p>
102</dd></dl>
103
104<dl class="method">
105<dt id="sans.calculator.instrument.Detector.set_size">
106<tt class="descname">set_size</tt><big>(</big><em>size=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Detector.set_size" title="Permalink to this definition">¶</a></dt>
107<dd><p>Set the detector  size</p>
108</dd></dl>
109
110</dd></dl>
111
112<dl class="class">
113<dt id="sans.calculator.instrument.Neutron">
114<em class="property">class </em><tt class="descclassname">sans.calculator.instrument.</tt><tt class="descname">Neutron</tt><a class="headerlink" href="#sans.calculator.instrument.Neutron" title="Permalink to this definition">¶</a></dt>
115<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
116<p>An object that defines the wavelength variables</p>
117<dl class="method">
118<dt id="sans.calculator.instrument.Neutron.get_band">
119<tt class="descname">get_band</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.get_band" title="Permalink to this definition">¶</a></dt>
120<dd><p>To get the wavelength band</p>
121</dd></dl>
122
123<dl class="method">
124<dt id="sans.calculator.instrument.Neutron.get_default_spectrum">
125<tt class="descname">get_default_spectrum</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.get_default_spectrum" title="Permalink to this definition">¶</a></dt>
126<dd><p>get default spectrum</p>
127</dd></dl>
128
129<dl class="method">
130<dt id="sans.calculator.instrument.Neutron.get_intensity">
131<tt class="descname">get_intensity</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.get_intensity" title="Permalink to this definition">¶</a></dt>
132<dd><p>To get the value of intensity</p>
133</dd></dl>
134
135<dl class="method">
136<dt id="sans.calculator.instrument.Neutron.get_mass">
137<tt class="descname">get_mass</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.get_mass" title="Permalink to this definition">¶</a></dt>
138<dd><p>To get the neutron mass</p>
139</dd></dl>
140
141<dl class="method">
142<dt id="sans.calculator.instrument.Neutron.get_ramdom_value">
143<tt class="descname">get_ramdom_value</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.get_ramdom_value" title="Permalink to this definition">¶</a></dt>
144<dd><p>To get the value of wave length</p>
145</dd></dl>
146
147<dl class="method">
148<dt id="sans.calculator.instrument.Neutron.get_spectrum">
149<tt class="descname">get_spectrum</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.get_spectrum" title="Permalink to this definition">¶</a></dt>
150<dd><p>To get the wavelength spectrum</p>
151</dd></dl>
152
153<dl class="method">
154<dt id="sans.calculator.instrument.Neutron.get_wavelength">
155<tt class="descname">get_wavelength</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.get_wavelength" title="Permalink to this definition">¶</a></dt>
156<dd><p>To get the value of wavelength</p>
157</dd></dl>
158
159<dl class="method">
160<dt id="sans.calculator.instrument.Neutron.get_wavelength_spread">
161<tt class="descname">get_wavelength_spread</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.get_wavelength_spread" title="Permalink to this definition">¶</a></dt>
162<dd><p>To get the value of wavelength spread</p>
163</dd></dl>
164
165<dl class="method">
166<dt id="sans.calculator.instrument.Neutron.plot_spectrum">
167<tt class="descname">plot_spectrum</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.plot_spectrum" title="Permalink to this definition">¶</a></dt>
168<dd><p>To plot the wavelength spactrum
169: requirment: matplotlib.pyplot</p>
170</dd></dl>
171
172<dl class="method">
173<dt id="sans.calculator.instrument.Neutron.set_band">
174<tt class="descname">set_band</tt><big>(</big><em>band=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_band" title="Permalink to this definition">¶</a></dt>
175<dd><p>To set the wavelength band</p>
176<table class="docutils field-list" frame="void" rules="none">
177<col class="field-name" />
178<col class="field-body" />
179<tbody valign="top">
180<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>band</strong> &#8211; array of [min, max]</td>
181</tr>
182</tbody>
183</table>
184</dd></dl>
185
186<dl class="method">
187<dt id="sans.calculator.instrument.Neutron.set_full_band">
188<tt class="descname">set_full_band</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_full_band" title="Permalink to this definition">¶</a></dt>
189<dd><p>set band to default value</p>
190</dd></dl>
191
192<dl class="method">
193<dt id="sans.calculator.instrument.Neutron.set_intensity">
194<tt class="descname">set_intensity</tt><big>(</big><em>intensity=368428</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_intensity" title="Permalink to this definition">¶</a></dt>
195<dd><p>Sets the intensity in counts/sec</p>
196</dd></dl>
197
198<dl class="method">
199<dt id="sans.calculator.instrument.Neutron.set_mass">
200<tt class="descname">set_mass</tt><big>(</big><em>mass=1.6749272900000001e-024</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_mass" title="Permalink to this definition">¶</a></dt>
201<dd><p>Sets the wavelength</p>
202</dd></dl>
203
204<dl class="method">
205<dt id="sans.calculator.instrument.Neutron.set_spectrum">
206<tt class="descname">set_spectrum</tt><big>(</big><em>spectrum</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_spectrum" title="Permalink to this definition">¶</a></dt>
207<dd><p>Set spectrum</p>
208<table class="docutils field-list" frame="void" rules="none">
209<col class="field-name" />
210<col class="field-body" />
211<tbody valign="top">
212<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spectrum</strong> &#8211; numpy array</td>
213</tr>
214</tbody>
215</table>
216</dd></dl>
217
218<dl class="method">
219<dt id="sans.calculator.instrument.Neutron.set_wavelength">
220<tt class="descname">set_wavelength</tt><big>(</big><em>wavelength=6.0</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_wavelength" title="Permalink to this definition">¶</a></dt>
221<dd><p>Sets the wavelength</p>
222</dd></dl>
223
224<dl class="method">
225<dt id="sans.calculator.instrument.Neutron.set_wavelength_spread">
226<tt class="descname">set_wavelength_spread</tt><big>(</big><em>spread=0.125</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_wavelength_spread" title="Permalink to this definition">¶</a></dt>
227<dd><p>Sets the wavelength spread</p>
228</dd></dl>
229
230<dl class="method">
231<dt id="sans.calculator.instrument.Neutron.setup_spectrum">
232<tt class="descname">setup_spectrum</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.setup_spectrum" title="Permalink to this definition">¶</a></dt>
233<dd><p>To set the wavelength spectrum, and intensity, assumes
234wavelength is already within the spectrum</p>
235</dd></dl>
236
237</dd></dl>
238
239<dl class="class">
240<dt id="sans.calculator.instrument.Sample">
241<em class="property">class </em><tt class="descclassname">sans.calculator.instrument.</tt><tt class="descname">Sample</tt><a class="headerlink" href="#sans.calculator.instrument.Sample" title="Permalink to this definition">¶</a></dt>
242<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
243<p>An object class that defines the sample variables</p>
244<dl class="method">
245<dt id="sans.calculator.instrument.Sample.set_distance">
246<tt class="descname">set_distance</tt><big>(</big><em>distance=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Sample.set_distance" title="Permalink to this definition">¶</a></dt>
247<dd><p>Set the sample distance</p>
248</dd></dl>
249
250<dl class="method">
251<dt id="sans.calculator.instrument.Sample.set_size">
252<tt class="descname">set_size</tt><big>(</big><em>size=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Sample.set_size" title="Permalink to this definition">¶</a></dt>
253<dd><p>Set the sample size</p>
254</dd></dl>
255
256<dl class="method">
257<dt id="sans.calculator.instrument.Sample.set_thickness">
258<tt class="descname">set_thickness</tt><big>(</big><em>thickness=0.0</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Sample.set_thickness" title="Permalink to this definition">¶</a></dt>
259<dd><p>Set the sample thickness</p>
260</dd></dl>
261
262</dd></dl>
263
264<dl class="class">
265<dt id="sans.calculator.instrument.TOF">
266<em class="property">class </em><tt class="descclassname">sans.calculator.instrument.</tt><tt class="descname">TOF</tt><a class="headerlink" href="#sans.calculator.instrument.TOF" title="Permalink to this definition">¶</a></dt>
267<dd><p>Bases: <a class="reference internal" href="#sans.calculator.instrument.Neutron" title="sans.calculator.instrument.Neutron"><tt class="xref py py-class docutils literal"><span class="pre">sans.calculator.instrument.Neutron</span></tt></a></p>
268<p>TOF: make list of wavelength and wave length spreads</p>
269<dl class="method">
270<dt id="sans.calculator.instrument.TOF.get_band">
271<tt class="descname">get_band</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.get_band" title="Permalink to this definition">¶</a></dt>
272<dd><p>To get the wavelength band</p>
273</dd></dl>
274
275<dl class="method">
276<dt id="sans.calculator.instrument.TOF.get_default_spectrum">
277<tt class="descname">get_default_spectrum</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.get_default_spectrum" title="Permalink to this definition">¶</a></dt>
278<dd><p>get default spectrum</p>
279</dd></dl>
280
281<dl class="method">
282<dt id="sans.calculator.instrument.TOF.get_intensity">
283<tt class="descname">get_intensity</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.get_intensity" title="Permalink to this definition">¶</a></dt>
284<dd><p>To get the value of intensity</p>
285</dd></dl>
286
287<dl class="method">
288<dt id="sans.calculator.instrument.TOF.get_intensity_list">
289<tt class="descname">get_intensity_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.get_intensity_list" title="Permalink to this definition">¶</a></dt>
290<dd><p>get list of the intensity wrt wavelength_list</p>
291</dd></dl>
292
293<dl class="method">
294<dt id="sans.calculator.instrument.TOF.get_mass">
295<tt class="descname">get_mass</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.get_mass" title="Permalink to this definition">¶</a></dt>
296<dd><p>To get the neutron mass</p>
297</dd></dl>
298
299<dl class="method">
300<dt id="sans.calculator.instrument.TOF.get_ramdom_value">
301<tt class="descname">get_ramdom_value</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.get_ramdom_value" title="Permalink to this definition">¶</a></dt>
302<dd><p>To get the value of wave length</p>
303</dd></dl>
304
305<dl class="method">
306<dt id="sans.calculator.instrument.TOF.get_spectrum">
307<tt class="descname">get_spectrum</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.get_spectrum" title="Permalink to this definition">¶</a></dt>
308<dd><p>To get the wavelength spectrum</p>
309</dd></dl>
310
311<dl class="method">
312<dt id="sans.calculator.instrument.TOF.get_wave_list">
313<tt class="descname">get_wave_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.get_wave_list" title="Permalink to this definition">¶</a></dt>
314<dd><p>Get wavelength and wavelength_spread list</p>
315</dd></dl>
316
317<dl class="method">
318<dt id="sans.calculator.instrument.TOF.get_wavelength">
319<tt class="descname">get_wavelength</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.get_wavelength" title="Permalink to this definition">¶</a></dt>
320<dd><p>To get the value of wavelength</p>
321</dd></dl>
322
323<dl class="method">
324<dt id="sans.calculator.instrument.TOF.get_wavelength_spread">
325<tt class="descname">get_wavelength_spread</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.get_wavelength_spread" title="Permalink to this definition">¶</a></dt>
326<dd><p>To get the value of wavelength spread</p>
327</dd></dl>
328
329<dl class="method">
330<dt id="sans.calculator.instrument.TOF.plot_spectrum">
331<tt class="descname">plot_spectrum</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.plot_spectrum" title="Permalink to this definition">¶</a></dt>
332<dd><p>To plot the wavelength spactrum
333: requirment: matplotlib.pyplot</p>
334</dd></dl>
335
336<dl class="method">
337<dt id="sans.calculator.instrument.TOF.set_band">
338<tt class="descname">set_band</tt><big>(</big><em>band=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_band" title="Permalink to this definition">¶</a></dt>
339<dd><p>To set the wavelength band</p>
340<table class="docutils field-list" frame="void" rules="none">
341<col class="field-name" />
342<col class="field-body" />
343<tbody valign="top">
344<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>band</strong> &#8211; array of [min, max]</td>
345</tr>
346</tbody>
347</table>
348</dd></dl>
349
350<dl class="method">
351<dt id="sans.calculator.instrument.TOF.set_full_band">
352<tt class="descname">set_full_band</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_full_band" title="Permalink to this definition">¶</a></dt>
353<dd><p>set band to default value</p>
354</dd></dl>
355
356<dl class="method">
357<dt id="sans.calculator.instrument.TOF.set_intensity">
358<tt class="descname">set_intensity</tt><big>(</big><em>intensity=368428</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_intensity" title="Permalink to this definition">¶</a></dt>
359<dd><p>Sets the intensity in counts/sec</p>
360</dd></dl>
361
362<dl class="method">
363<dt id="sans.calculator.instrument.TOF.set_mass">
364<tt class="descname">set_mass</tt><big>(</big><em>mass=1.6749272900000001e-024</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_mass" title="Permalink to this definition">¶</a></dt>
365<dd><p>Sets the wavelength</p>
366</dd></dl>
367
368<dl class="method">
369<dt id="sans.calculator.instrument.TOF.set_spectrum">
370<tt class="descname">set_spectrum</tt><big>(</big><em>spectrum</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_spectrum" title="Permalink to this definition">¶</a></dt>
371<dd><p>Set spectrum</p>
372<table class="docutils field-list" frame="void" rules="none">
373<col class="field-name" />
374<col class="field-body" />
375<tbody valign="top">
376<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spectrum</strong> &#8211; numpy array</td>
377</tr>
378</tbody>
379</table>
380</dd></dl>
381
382<dl class="method">
383<dt id="sans.calculator.instrument.TOF.set_wave_list">
384<tt class="descname">set_wave_list</tt><big>(</big><em>wavelength=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_wave_list" title="Permalink to this definition">¶</a></dt>
385<dd><p>Set wavelength list</p>
386<table class="docutils field-list" frame="void" rules="none">
387<col class="field-name" />
388<col class="field-body" />
389<tbody valign="top">
390<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>wavelength</strong> &#8211; list of wavelengths</td>
391</tr>
392</tbody>
393</table>
394</dd></dl>
395
396<dl class="method">
397<dt id="sans.calculator.instrument.TOF.set_wave_spread_list">
398<tt class="descname">set_wave_spread_list</tt><big>(</big><em>wavelength_spread=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_wave_spread_list" title="Permalink to this definition">¶</a></dt>
399<dd><p>Set wavelength_spread list</p>
400<table class="docutils field-list" frame="void" rules="none">
401<col class="field-name" />
402<col class="field-body" />
403<tbody valign="top">
404<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>wavelength_spread</strong> &#8211; list of wavelength spreads</td>
405</tr>
406</tbody>
407</table>
408</dd></dl>
409
410<dl class="method">
411<dt id="sans.calculator.instrument.TOF.set_wavelength">
412<tt class="descname">set_wavelength</tt><big>(</big><em>wavelength=6.0</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_wavelength" title="Permalink to this definition">¶</a></dt>
413<dd><p>Sets the wavelength</p>
414</dd></dl>
415
416<dl class="method">
417<dt id="sans.calculator.instrument.TOF.set_wavelength_spread">
418<tt class="descname">set_wavelength_spread</tt><big>(</big><em>spread=0.125</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_wavelength_spread" title="Permalink to this definition">¶</a></dt>
419<dd><p>Sets the wavelength spread</p>
420</dd></dl>
421
422<dl class="method">
423<dt id="sans.calculator.instrument.TOF.setup_spectrum">
424<tt class="descname">setup_spectrum</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.setup_spectrum" title="Permalink to this definition">¶</a></dt>
425<dd><p>To set the wavelength spectrum, and intensity, assumes
426wavelength is already within the spectrum</p>
427</dd></dl>
428
429</dd></dl>
430
431<dl class="function">
432<dt id="sans.calculator.instrument.validate">
433<tt class="descclassname">sans.calculator.instrument.</tt><tt class="descname">validate</tt><big>(</big><em>value=None</em><big>)</big><a class="headerlink" href="#sans.calculator.instrument.validate" title="Permalink to this definition">¶</a></dt>
434<dd><p>Check if the value is folat &gt; 0.0</p>
435<table class="docutils field-list" frame="void" rules="none">
436<col class="field-name" />
437<col class="field-body" />
438<tbody valign="top">
439<tr class="field"><th class="field-name">Return value:</th><td class="field-body">True / False</td>
440</tr>
441</tbody>
442</table>
443</dd></dl>
444
445</div>
446</div>
447
448
449          </div>
450        </div>
451      </div>
452      <div class="sphinxsidebar">
453        <div class="sphinxsidebarwrapper">
454  <h3><a href="../index.html">Table Of Contents</a></h3>
455  <ul>
456<li><a class="reference internal" href="#">Instrument</a><ul>
457<li><a class="reference internal" href="#module-sans.calculator.instrument"><tt class="docutils literal"><span class="pre">sans.calculator.instrument</span></tt></a></li>
458</ul>
459</li>
460</ul>
461
462  <h4>Previous topic</h4>
463  <p class="topless"><a href="index.html"
464                        title="previous chapter">Reference</a></p>
465  <h4>Next topic</h4>
466  <p class="topless"><a href="slit_length_calculator.html"
467                        title="next chapter">Slit Length Calculator</a></p>
468  <h3>This Page</h3>
469  <ul class="this-page-menu">
470    <li><a href="../_sources/api/instrument.txt"
471           rel="nofollow">Show Source</a></li>
472  </ul>
473<div id="searchbox" style="display: none">
474  <h3>Quick search</h3>
475    <form class="search" action="../search.html" method="get">
476      <input type="text" name="q" size="18" />
477      <input type="submit" value="Go" />
478      <input type="hidden" name="check_keywords" value="yes" />
479      <input type="hidden" name="area" value="default" />
480    </form>
481    <p class="searchtip" style="font-size: 90%">
482    Enter search terms or a module, class or function name.
483    </p>
484</div>
485<script type="text/javascript">$('#searchbox').show(0);</script>
486        </div>
487      </div>
488      <div class="clearer"></div>
489    </div>
490    <div class="related">
491      <h3>Navigation</h3>
492      <ul>
493        <li class="right" style="margin-right: 10px">
494          <a href="../genindex.html" title="General Index"
495             >index</a></li>
496        <li class="right" >
497          <a href="../py-modindex.html" title="Python Module Index"
498             >modules</a> |</li>
499        <li class="right" >
500          <a href="slit_length_calculator.html" title="Slit Length Calculator"
501             >next</a> |</li>
502        <li class="right" >
503          <a href="index.html" title="Reference"
504             >previous</a> |</li>
505        <li><a href="../index.html">calculator v0.1.0 documentation</a> &raquo;</li>
506          <li><a href="index.html" >Reference</a> &raquo;</li> 
507      </ul>
508    </div>
509    <div class="footer">
510        &copy; Copyright 2010, Gervaise Alina.
511      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
512    </div>
513  </body>
514</html>
Note: See TracBrowser for help on using the repository browser.