source: sasview/sanscalculator/docs/sphinx/html/api/instrument.html @ b4293d2

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

edit doc
  • Property mode set to 100644
File size: 46.3 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>instrument &mdash; calculator 0.1.0 documentation</title>
12   
13    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '../',
19        VERSION:     '0.1.0',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="../_static/jquery.js"></script>
26    <script type="text/javascript" src="../_static/underscore.js"></script>
27    <script type="text/javascript" src="../_static/doctools.js"></script>
28    <link rel="top" title="calculator 0.1.0 documentation" href="../index.html" />
29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="kiessig_calculator" href="kiessig_calculator.html" />
31    <link rel="prev" title="Reference" href="index.html" /> 
32  </head>
33  <body>
34    <div class="related">
35      <h3>Navigation</h3>
36      <ul>
37        <li class="right" style="margin-right: 10px">
38          <a href="../genindex.html" title="General Index"
39             accesskey="I">index</a></li>
40        <li class="right" >
41          <a href="../py-modindex.html" title="Python Module Index"
42             >modules</a> |</li>
43        <li class="right" >
44          <a href="kiessig_calculator.html" title="kiessig_calculator"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="index.html" title="Reference"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../index.html">calculator 0.1.0 documentation</a> &raquo;</li>
50          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
51      </ul>
52    </div> 
53
54    <div class="document">
55      <div class="documentwrapper">
56        <div class="bodywrapper">
57          <div class="body">
58           
59  <div class="section" id="instrument">
60<h1>instrument<a class="headerlink" href="#instrument" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-calculator-instrument">
62<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="#sans-calculator-instrument" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.calculator.instrument"></span><p>This module is a small tool to allow user to
64control instrumental parameters</p>
65<dl class="class">
66<dt id="sans.calculator.instrument.Aperture">
67<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>
68<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
69<p>An object class that defines the aperture variables</p>
70<dl class="attribute">
71<dt id="sans.calculator.instrument.Aperture.__class__">
72<tt class="descname">__class__</tt><a class="headerlink" href="#sans.calculator.instrument.Aperture.__class__" title="Permalink to this definition">¶</a></dt>
73<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
74</dd></dl>
75
76<dl class="attribute">
77<dt id="sans.calculator.instrument.Aperture.__delattr__">
78<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.calculator.instrument.Aperture.__delattr__" title="Permalink to this definition">¶</a></dt>
79<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
80</dd></dl>
81
82<dl class="attribute">
83<dt id="sans.calculator.instrument.Aperture.__dict__">
84<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01A48250&gt;</em><a class="headerlink" href="#sans.calculator.instrument.Aperture.__dict__" title="Permalink to this definition">¶</a></dt>
85<dd></dd></dl>
86
87<dl class="attribute">
88<dt id="sans.calculator.instrument.Aperture.__getattribute__">
89<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.calculator.instrument.Aperture.__getattribute__" title="Permalink to this definition">¶</a></dt>
90<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
91</dd></dl>
92
93<dl class="attribute">
94<dt id="sans.calculator.instrument.Aperture.__hash__">
95<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.calculator.instrument.Aperture.__hash__" title="Permalink to this definition">¶</a></dt>
96<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
97</dd></dl>
98
99<dl class="method">
100<dt id="sans.calculator.instrument.Aperture.__init__">
101<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Aperture.__init__" title="Permalink to this definition">¶</a></dt>
102<dd></dd></dl>
103
104<dl class="attribute">
105<dt id="sans.calculator.instrument.Aperture.__module__">
106<tt class="descname">__module__</tt><em class="property"> = 'sans.calculator.instrument'</em><a class="headerlink" href="#sans.calculator.instrument.Aperture.__module__" title="Permalink to this definition">¶</a></dt>
107<dd></dd></dl>
108
109<dl class="staticmethod">
110<dt id="sans.calculator.instrument.Aperture.__new__">
111<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.calculator.instrument.Aperture.__new__" title="Permalink to this definition">¶</a></dt>
112<dd></dd></dl>
113
114<dl class="method">
115<dt id="sans.calculator.instrument.Aperture.__reduce__">
116<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Aperture.__reduce__" title="Permalink to this definition">¶</a></dt>
117<dd><p>helper for pickle</p>
118</dd></dl>
119
120<dl class="method">
121<dt id="sans.calculator.instrument.Aperture.__reduce_ex__">
122<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Aperture.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
123<dd><p>helper for pickle</p>
124</dd></dl>
125
126<dl class="attribute">
127<dt id="sans.calculator.instrument.Aperture.__repr__">
128<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.calculator.instrument.Aperture.__repr__" title="Permalink to this definition">¶</a></dt>
129<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
130</dd></dl>
131
132<dl class="attribute">
133<dt id="sans.calculator.instrument.Aperture.__setattr__">
134<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.calculator.instrument.Aperture.__setattr__" title="Permalink to this definition">¶</a></dt>
135<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
136</dd></dl>
137
138<dl class="attribute">
139<dt id="sans.calculator.instrument.Aperture.__str__">
140<tt class="descname">__str__</tt><a class="headerlink" href="#sans.calculator.instrument.Aperture.__str__" title="Permalink to this definition">¶</a></dt>
141<dd><p>x.__str__() &lt;==&gt; str(x)</p>
142</dd></dl>
143
144<dl class="attribute">
145<dt id="sans.calculator.instrument.Aperture.__weakref__">
146<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.calculator.instrument.Aperture.__weakref__" title="Permalink to this definition">¶</a></dt>
147<dd><p>list of weak references to the object (if defined)</p>
148</dd></dl>
149
150<dl class="method">
151<dt id="sans.calculator.instrument.Aperture.set_sample_distance">
152<tt class="descname">set_sample_distance</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Aperture.set_sample_distance" title="Permalink to this definition">¶</a></dt>
153<dd><p>Set the sample aperture distance</p>
154</dd></dl>
155
156<dl class="method">
157<dt id="sans.calculator.instrument.Aperture.set_sample_size">
158<tt class="descname">set_sample_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Aperture.set_sample_size" title="Permalink to this definition">¶</a></dt>
159<dd><p>Set the sample aperture size</p>
160</dd></dl>
161
162<dl class="method">
163<dt id="sans.calculator.instrument.Aperture.set_source_size">
164<tt class="descname">set_source_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Aperture.set_source_size" title="Permalink to this definition">¶</a></dt>
165<dd><p>Set the source aperture size</p>
166</dd></dl>
167
168</dd></dl>
169
170<dl class="class">
171<dt id="sans.calculator.instrument.Detector">
172<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>
173<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
174<p>An object class that defines the detector variables</p>
175<dl class="attribute">
176<dt id="sans.calculator.instrument.Detector.__class__">
177<tt class="descname">__class__</tt><a class="headerlink" href="#sans.calculator.instrument.Detector.__class__" title="Permalink to this definition">¶</a></dt>
178<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
179</dd></dl>
180
181<dl class="attribute">
182<dt id="sans.calculator.instrument.Detector.__delattr__">
183<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.calculator.instrument.Detector.__delattr__" title="Permalink to this definition">¶</a></dt>
184<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
185</dd></dl>
186
187<dl class="attribute">
188<dt id="sans.calculator.instrument.Detector.__dict__">
189<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01A3DEF0&gt;</em><a class="headerlink" href="#sans.calculator.instrument.Detector.__dict__" title="Permalink to this definition">¶</a></dt>
190<dd></dd></dl>
191
192<dl class="attribute">
193<dt id="sans.calculator.instrument.Detector.__getattribute__">
194<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.calculator.instrument.Detector.__getattribute__" title="Permalink to this definition">¶</a></dt>
195<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
196</dd></dl>
197
198<dl class="attribute">
199<dt id="sans.calculator.instrument.Detector.__hash__">
200<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.calculator.instrument.Detector.__hash__" title="Permalink to this definition">¶</a></dt>
201<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
202</dd></dl>
203
204<dl class="method">
205<dt id="sans.calculator.instrument.Detector.__init__">
206<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Detector.__init__" title="Permalink to this definition">¶</a></dt>
207<dd></dd></dl>
208
209<dl class="attribute">
210<dt id="sans.calculator.instrument.Detector.__module__">
211<tt class="descname">__module__</tt><em class="property"> = 'sans.calculator.instrument'</em><a class="headerlink" href="#sans.calculator.instrument.Detector.__module__" title="Permalink to this definition">¶</a></dt>
212<dd></dd></dl>
213
214<dl class="staticmethod">
215<dt id="sans.calculator.instrument.Detector.__new__">
216<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.calculator.instrument.Detector.__new__" title="Permalink to this definition">¶</a></dt>
217<dd></dd></dl>
218
219<dl class="method">
220<dt id="sans.calculator.instrument.Detector.__reduce__">
221<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Detector.__reduce__" title="Permalink to this definition">¶</a></dt>
222<dd><p>helper for pickle</p>
223</dd></dl>
224
225<dl class="method">
226<dt id="sans.calculator.instrument.Detector.__reduce_ex__">
227<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Detector.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
228<dd><p>helper for pickle</p>
229</dd></dl>
230
231<dl class="attribute">
232<dt id="sans.calculator.instrument.Detector.__repr__">
233<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.calculator.instrument.Detector.__repr__" title="Permalink to this definition">¶</a></dt>
234<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
235</dd></dl>
236
237<dl class="attribute">
238<dt id="sans.calculator.instrument.Detector.__setattr__">
239<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.calculator.instrument.Detector.__setattr__" title="Permalink to this definition">¶</a></dt>
240<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
241</dd></dl>
242
243<dl class="attribute">
244<dt id="sans.calculator.instrument.Detector.__str__">
245<tt class="descname">__str__</tt><a class="headerlink" href="#sans.calculator.instrument.Detector.__str__" title="Permalink to this definition">¶</a></dt>
246<dd><p>x.__str__() &lt;==&gt; str(x)</p>
247</dd></dl>
248
249<dl class="attribute">
250<dt id="sans.calculator.instrument.Detector.__weakref__">
251<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.calculator.instrument.Detector.__weakref__" title="Permalink to this definition">¶</a></dt>
252<dd><p>list of weak references to the object (if defined)</p>
253</dd></dl>
254
255<dl class="method">
256<dt id="sans.calculator.instrument.Detector.set_distance">
257<tt class="descname">set_distance</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Detector.set_distance" title="Permalink to this definition">¶</a></dt>
258<dd><p>Set the detector distance</p>
259</dd></dl>
260
261<dl class="method">
262<dt id="sans.calculator.instrument.Detector.set_pix_size">
263<tt class="descname">set_pix_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Detector.set_pix_size" title="Permalink to this definition">¶</a></dt>
264<dd><p>Set the detector pix_size</p>
265</dd></dl>
266
267<dl class="method">
268<dt id="sans.calculator.instrument.Detector.set_size">
269<tt class="descname">set_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Detector.set_size" title="Permalink to this definition">¶</a></dt>
270<dd><p>Set the detector  size</p>
271</dd></dl>
272
273</dd></dl>
274
275<dl class="class">
276<dt id="sans.calculator.instrument.Neutron">
277<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>
278<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
279<p>An object that defines the wavelength variables</p>
280<dl class="attribute">
281<dt id="sans.calculator.instrument.Neutron.__class__">
282<tt class="descname">__class__</tt><a class="headerlink" href="#sans.calculator.instrument.Neutron.__class__" title="Permalink to this definition">¶</a></dt>
283<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
284</dd></dl>
285
286<dl class="attribute">
287<dt id="sans.calculator.instrument.Neutron.__delattr__">
288<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.calculator.instrument.Neutron.__delattr__" title="Permalink to this definition">¶</a></dt>
289<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
290</dd></dl>
291
292<dl class="attribute">
293<dt id="sans.calculator.instrument.Neutron.__dict__">
294<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01A4F410&gt;</em><a class="headerlink" href="#sans.calculator.instrument.Neutron.__dict__" title="Permalink to this definition">¶</a></dt>
295<dd></dd></dl>
296
297<dl class="attribute">
298<dt id="sans.calculator.instrument.Neutron.__getattribute__">
299<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.calculator.instrument.Neutron.__getattribute__" title="Permalink to this definition">¶</a></dt>
300<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
301</dd></dl>
302
303<dl class="attribute">
304<dt id="sans.calculator.instrument.Neutron.__hash__">
305<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.calculator.instrument.Neutron.__hash__" title="Permalink to this definition">¶</a></dt>
306<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
307</dd></dl>
308
309<dl class="method">
310<dt id="sans.calculator.instrument.Neutron.__init__">
311<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.__init__" title="Permalink to this definition">¶</a></dt>
312<dd></dd></dl>
313
314<dl class="attribute">
315<dt id="sans.calculator.instrument.Neutron.__module__">
316<tt class="descname">__module__</tt><em class="property"> = 'sans.calculator.instrument'</em><a class="headerlink" href="#sans.calculator.instrument.Neutron.__module__" title="Permalink to this definition">¶</a></dt>
317<dd></dd></dl>
318
319<dl class="staticmethod">
320<dt id="sans.calculator.instrument.Neutron.__new__">
321<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.calculator.instrument.Neutron.__new__" title="Permalink to this definition">¶</a></dt>
322<dd></dd></dl>
323
324<dl class="method">
325<dt id="sans.calculator.instrument.Neutron.__reduce__">
326<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.__reduce__" title="Permalink to this definition">¶</a></dt>
327<dd><p>helper for pickle</p>
328</dd></dl>
329
330<dl class="method">
331<dt id="sans.calculator.instrument.Neutron.__reduce_ex__">
332<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
333<dd><p>helper for pickle</p>
334</dd></dl>
335
336<dl class="attribute">
337<dt id="sans.calculator.instrument.Neutron.__repr__">
338<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.calculator.instrument.Neutron.__repr__" title="Permalink to this definition">¶</a></dt>
339<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
340</dd></dl>
341
342<dl class="attribute">
343<dt id="sans.calculator.instrument.Neutron.__setattr__">
344<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.calculator.instrument.Neutron.__setattr__" title="Permalink to this definition">¶</a></dt>
345<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
346</dd></dl>
347
348<dl class="attribute">
349<dt id="sans.calculator.instrument.Neutron.__str__">
350<tt class="descname">__str__</tt><a class="headerlink" href="#sans.calculator.instrument.Neutron.__str__" title="Permalink to this definition">¶</a></dt>
351<dd><p>x.__str__() &lt;==&gt; str(x)</p>
352</dd></dl>
353
354<dl class="attribute">
355<dt id="sans.calculator.instrument.Neutron.__weakref__">
356<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.calculator.instrument.Neutron.__weakref__" title="Permalink to this definition">¶</a></dt>
357<dd><p>list of weak references to the object (if defined)</p>
358</dd></dl>
359
360<dl class="method">
361<dt id="sans.calculator.instrument.Neutron.get_band">
362<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>
363<dd><p>To get the wavelength band</p>
364</dd></dl>
365
366<dl class="method">
367<dt id="sans.calculator.instrument.Neutron.get_default_spectrum">
368<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>
369<dd><p>get default spectrum</p>
370</dd></dl>
371
372<dl class="method">
373<dt id="sans.calculator.instrument.Neutron.get_intensity">
374<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>
375<dd><p>To get the value of intensity</p>
376</dd></dl>
377
378<dl class="method">
379<dt id="sans.calculator.instrument.Neutron.get_mass">
380<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>
381<dd><p>To get the neutron mass</p>
382</dd></dl>
383
384<dl class="method">
385<dt id="sans.calculator.instrument.Neutron.get_ramdom_value">
386<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>
387<dd><p>To get the value of wave length</p>
388</dd></dl>
389
390<dl class="method">
391<dt id="sans.calculator.instrument.Neutron.get_spectrum">
392<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>
393<dd><p>To get the wavelength spectrum</p>
394</dd></dl>
395
396<dl class="method">
397<dt id="sans.calculator.instrument.Neutron.get_wavelength">
398<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>
399<dd><p>To get the value of wavelength</p>
400</dd></dl>
401
402<dl class="method">
403<dt id="sans.calculator.instrument.Neutron.get_wavelength_spread">
404<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>
405<dd><p>To get the value of wavelength spread</p>
406</dd></dl>
407
408<dl class="method">
409<dt id="sans.calculator.instrument.Neutron.plot_spectrum">
410<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>
411<dd><p>To plot the wavelength spactrum
412: requirment: matplotlib.pyplot</p>
413</dd></dl>
414
415<dl class="method">
416<dt id="sans.calculator.instrument.Neutron.set_band">
417<tt class="descname">set_band</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_band" title="Permalink to this definition">¶</a></dt>
418<dd><p>To set the wavelength band</p>
419<table class="docutils field-list" frame="void" rules="none">
420<col class="field-name" />
421<col class="field-body" />
422<tbody valign="top">
423<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>band</strong> &#8211; array of [min, max]</td>
424</tr>
425</tbody>
426</table>
427</dd></dl>
428
429<dl class="method">
430<dt id="sans.calculator.instrument.Neutron.set_full_band">
431<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>
432<dd><p>set band to default value</p>
433</dd></dl>
434
435<dl class="method">
436<dt id="sans.calculator.instrument.Neutron.set_intensity">
437<tt class="descname">set_intensity</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_intensity" title="Permalink to this definition">¶</a></dt>
438<dd><p>Sets the intensity in counts/sec</p>
439</dd></dl>
440
441<dl class="method">
442<dt id="sans.calculator.instrument.Neutron.set_mass">
443<tt class="descname">set_mass</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_mass" title="Permalink to this definition">¶</a></dt>
444<dd><p>Sets the wavelength</p>
445</dd></dl>
446
447<dl class="method">
448<dt id="sans.calculator.instrument.Neutron.set_spectrum">
449<tt class="descname">set_spectrum</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_spectrum" title="Permalink to this definition">¶</a></dt>
450<dd><p>Set spectrum</p>
451<table class="docutils field-list" frame="void" rules="none">
452<col class="field-name" />
453<col class="field-body" />
454<tbody valign="top">
455<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spectrum</strong> &#8211; numpy array</td>
456</tr>
457</tbody>
458</table>
459</dd></dl>
460
461<dl class="method">
462<dt id="sans.calculator.instrument.Neutron.set_wavelength">
463<tt class="descname">set_wavelength</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_wavelength" title="Permalink to this definition">¶</a></dt>
464<dd><p>Sets the wavelength</p>
465</dd></dl>
466
467<dl class="method">
468<dt id="sans.calculator.instrument.Neutron.set_wavelength_spread">
469<tt class="descname">set_wavelength_spread</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Neutron.set_wavelength_spread" title="Permalink to this definition">¶</a></dt>
470<dd><p>Sets the wavelength spread</p>
471</dd></dl>
472
473<dl class="method">
474<dt id="sans.calculator.instrument.Neutron.setup_spectrum">
475<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>
476<dd><p>To set the wavelength spectrum, and intensity, assumes
477wavelength is already within the spectrum</p>
478</dd></dl>
479
480</dd></dl>
481
482<dl class="class">
483<dt id="sans.calculator.instrument.Sample">
484<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>
485<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
486<p>An object class that defines the sample variables</p>
487<dl class="attribute">
488<dt id="sans.calculator.instrument.Sample.__class__">
489<tt class="descname">__class__</tt><a class="headerlink" href="#sans.calculator.instrument.Sample.__class__" title="Permalink to this definition">¶</a></dt>
490<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
491</dd></dl>
492
493<dl class="attribute">
494<dt id="sans.calculator.instrument.Sample.__delattr__">
495<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.calculator.instrument.Sample.__delattr__" title="Permalink to this definition">¶</a></dt>
496<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
497</dd></dl>
498
499<dl class="attribute">
500<dt id="sans.calculator.instrument.Sample.__dict__">
501<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01A4F530&gt;</em><a class="headerlink" href="#sans.calculator.instrument.Sample.__dict__" title="Permalink to this definition">¶</a></dt>
502<dd></dd></dl>
503
504<dl class="attribute">
505<dt id="sans.calculator.instrument.Sample.__getattribute__">
506<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.calculator.instrument.Sample.__getattribute__" title="Permalink to this definition">¶</a></dt>
507<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
508</dd></dl>
509
510<dl class="attribute">
511<dt id="sans.calculator.instrument.Sample.__hash__">
512<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.calculator.instrument.Sample.__hash__" title="Permalink to this definition">¶</a></dt>
513<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
514</dd></dl>
515
516<dl class="method">
517<dt id="sans.calculator.instrument.Sample.__init__">
518<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Sample.__init__" title="Permalink to this definition">¶</a></dt>
519<dd></dd></dl>
520
521<dl class="attribute">
522<dt id="sans.calculator.instrument.Sample.__module__">
523<tt class="descname">__module__</tt><em class="property"> = 'sans.calculator.instrument'</em><a class="headerlink" href="#sans.calculator.instrument.Sample.__module__" title="Permalink to this definition">¶</a></dt>
524<dd></dd></dl>
525
526<dl class="staticmethod">
527<dt id="sans.calculator.instrument.Sample.__new__">
528<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.calculator.instrument.Sample.__new__" title="Permalink to this definition">¶</a></dt>
529<dd></dd></dl>
530
531<dl class="method">
532<dt id="sans.calculator.instrument.Sample.__reduce__">
533<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Sample.__reduce__" title="Permalink to this definition">¶</a></dt>
534<dd><p>helper for pickle</p>
535</dd></dl>
536
537<dl class="method">
538<dt id="sans.calculator.instrument.Sample.__reduce_ex__">
539<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Sample.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
540<dd><p>helper for pickle</p>
541</dd></dl>
542
543<dl class="attribute">
544<dt id="sans.calculator.instrument.Sample.__repr__">
545<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.calculator.instrument.Sample.__repr__" title="Permalink to this definition">¶</a></dt>
546<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
547</dd></dl>
548
549<dl class="attribute">
550<dt id="sans.calculator.instrument.Sample.__setattr__">
551<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.calculator.instrument.Sample.__setattr__" title="Permalink to this definition">¶</a></dt>
552<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
553</dd></dl>
554
555<dl class="attribute">
556<dt id="sans.calculator.instrument.Sample.__str__">
557<tt class="descname">__str__</tt><a class="headerlink" href="#sans.calculator.instrument.Sample.__str__" title="Permalink to this definition">¶</a></dt>
558<dd><p>x.__str__() &lt;==&gt; str(x)</p>
559</dd></dl>
560
561<dl class="attribute">
562<dt id="sans.calculator.instrument.Sample.__weakref__">
563<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.calculator.instrument.Sample.__weakref__" title="Permalink to this definition">¶</a></dt>
564<dd><p>list of weak references to the object (if defined)</p>
565</dd></dl>
566
567<dl class="method">
568<dt id="sans.calculator.instrument.Sample.set_distance">
569<tt class="descname">set_distance</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Sample.set_distance" title="Permalink to this definition">¶</a></dt>
570<dd><p>Set the sample distance</p>
571</dd></dl>
572
573<dl class="method">
574<dt id="sans.calculator.instrument.Sample.set_size">
575<tt class="descname">set_size</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Sample.set_size" title="Permalink to this definition">¶</a></dt>
576<dd><p>Set the sample size</p>
577</dd></dl>
578
579<dl class="method">
580<dt id="sans.calculator.instrument.Sample.set_thickness">
581<tt class="descname">set_thickness</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.Sample.set_thickness" title="Permalink to this definition">¶</a></dt>
582<dd><p>Set the sample thickness</p>
583</dd></dl>
584
585</dd></dl>
586
587<dl class="class">
588<dt id="sans.calculator.instrument.TOF">
589<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>
590<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>
591<p>TOF: make list of wavelength and wave length spreads</p>
592<dl class="attribute">
593<dt id="sans.calculator.instrument.TOF.__class__">
594<tt class="descname">__class__</tt><a class="headerlink" href="#sans.calculator.instrument.TOF.__class__" title="Permalink to this definition">¶</a></dt>
595<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
596</dd></dl>
597
598<dl class="attribute">
599<dt id="sans.calculator.instrument.TOF.__delattr__">
600<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.calculator.instrument.TOF.__delattr__" title="Permalink to this definition">¶</a></dt>
601<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
602</dd></dl>
603
604<dl class="attribute">
605<dt id="sans.calculator.instrument.TOF.__dict__">
606<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01A5B830&gt;</em><a class="headerlink" href="#sans.calculator.instrument.TOF.__dict__" title="Permalink to this definition">¶</a></dt>
607<dd></dd></dl>
608
609<dl class="attribute">
610<dt id="sans.calculator.instrument.TOF.__getattribute__">
611<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.calculator.instrument.TOF.__getattribute__" title="Permalink to this definition">¶</a></dt>
612<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
613</dd></dl>
614
615<dl class="attribute">
616<dt id="sans.calculator.instrument.TOF.__hash__">
617<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.calculator.instrument.TOF.__hash__" title="Permalink to this definition">¶</a></dt>
618<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
619</dd></dl>
620
621<dl class="method">
622<dt id="sans.calculator.instrument.TOF.__init__">
623<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.__init__" title="Permalink to this definition">¶</a></dt>
624<dd><p>Init</p>
625</dd></dl>
626
627<dl class="attribute">
628<dt id="sans.calculator.instrument.TOF.__module__">
629<tt class="descname">__module__</tt><em class="property"> = 'sans.calculator.instrument'</em><a class="headerlink" href="#sans.calculator.instrument.TOF.__module__" title="Permalink to this definition">¶</a></dt>
630<dd></dd></dl>
631
632<dl class="staticmethod">
633<dt id="sans.calculator.instrument.TOF.__new__">
634<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.calculator.instrument.TOF.__new__" title="Permalink to this definition">¶</a></dt>
635<dd></dd></dl>
636
637<dl class="method">
638<dt id="sans.calculator.instrument.TOF.__reduce__">
639<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.__reduce__" title="Permalink to this definition">¶</a></dt>
640<dd><p>helper for pickle</p>
641</dd></dl>
642
643<dl class="method">
644<dt id="sans.calculator.instrument.TOF.__reduce_ex__">
645<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
646<dd><p>helper for pickle</p>
647</dd></dl>
648
649<dl class="attribute">
650<dt id="sans.calculator.instrument.TOF.__repr__">
651<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.calculator.instrument.TOF.__repr__" title="Permalink to this definition">¶</a></dt>
652<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
653</dd></dl>
654
655<dl class="attribute">
656<dt id="sans.calculator.instrument.TOF.__setattr__">
657<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.calculator.instrument.TOF.__setattr__" title="Permalink to this definition">¶</a></dt>
658<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
659</dd></dl>
660
661<dl class="attribute">
662<dt id="sans.calculator.instrument.TOF.__str__">
663<tt class="descname">__str__</tt><a class="headerlink" href="#sans.calculator.instrument.TOF.__str__" title="Permalink to this definition">¶</a></dt>
664<dd><p>x.__str__() &lt;==&gt; str(x)</p>
665</dd></dl>
666
667<dl class="attribute">
668<dt id="sans.calculator.instrument.TOF.__weakref__">
669<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.calculator.instrument.TOF.__weakref__" title="Permalink to this definition">¶</a></dt>
670<dd><p>list of weak references to the object (if defined)</p>
671</dd></dl>
672
673<dl class="method">
674<dt id="sans.calculator.instrument.TOF.get_band">
675<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>
676<dd><p>To get the wavelength band</p>
677</dd></dl>
678
679<dl class="method">
680<dt id="sans.calculator.instrument.TOF.get_default_spectrum">
681<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>
682<dd><p>get default spectrum</p>
683</dd></dl>
684
685<dl class="method">
686<dt id="sans.calculator.instrument.TOF.get_intensity">
687<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>
688<dd><p>To get the value of intensity</p>
689</dd></dl>
690
691<dl class="method">
692<dt id="sans.calculator.instrument.TOF.get_intensity_list">
693<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>
694<dd><p>get list of the intensity wrt wavelength_list</p>
695</dd></dl>
696
697<dl class="method">
698<dt id="sans.calculator.instrument.TOF.get_mass">
699<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>
700<dd><p>To get the neutron mass</p>
701</dd></dl>
702
703<dl class="method">
704<dt id="sans.calculator.instrument.TOF.get_ramdom_value">
705<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>
706<dd><p>To get the value of wave length</p>
707</dd></dl>
708
709<dl class="method">
710<dt id="sans.calculator.instrument.TOF.get_spectrum">
711<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>
712<dd><p>To get the wavelength spectrum</p>
713</dd></dl>
714
715<dl class="method">
716<dt id="sans.calculator.instrument.TOF.get_wave_list">
717<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>
718<dd><p>Get wavelength and wavelength_spread list</p>
719</dd></dl>
720
721<dl class="method">
722<dt id="sans.calculator.instrument.TOF.get_wavelength">
723<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>
724<dd><p>To get the value of wavelength</p>
725</dd></dl>
726
727<dl class="method">
728<dt id="sans.calculator.instrument.TOF.get_wavelength_spread">
729<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>
730<dd><p>To get the value of wavelength spread</p>
731</dd></dl>
732
733<dl class="method">
734<dt id="sans.calculator.instrument.TOF.plot_spectrum">
735<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>
736<dd><p>To plot the wavelength spactrum
737: requirment: matplotlib.pyplot</p>
738</dd></dl>
739
740<dl class="method">
741<dt id="sans.calculator.instrument.TOF.set_band">
742<tt class="descname">set_band</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_band" title="Permalink to this definition">¶</a></dt>
743<dd><p>To set the wavelength band</p>
744<table class="docutils field-list" frame="void" rules="none">
745<col class="field-name" />
746<col class="field-body" />
747<tbody valign="top">
748<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>band</strong> &#8211; array of [min, max]</td>
749</tr>
750</tbody>
751</table>
752</dd></dl>
753
754<dl class="method">
755<dt id="sans.calculator.instrument.TOF.set_full_band">
756<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>
757<dd><p>set band to default value</p>
758</dd></dl>
759
760<dl class="method">
761<dt id="sans.calculator.instrument.TOF.set_intensity">
762<tt class="descname">set_intensity</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_intensity" title="Permalink to this definition">¶</a></dt>
763<dd><p>Sets the intensity in counts/sec</p>
764</dd></dl>
765
766<dl class="method">
767<dt id="sans.calculator.instrument.TOF.set_mass">
768<tt class="descname">set_mass</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_mass" title="Permalink to this definition">¶</a></dt>
769<dd><p>Sets the wavelength</p>
770</dd></dl>
771
772<dl class="method">
773<dt id="sans.calculator.instrument.TOF.set_spectrum">
774<tt class="descname">set_spectrum</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_spectrum" title="Permalink to this definition">¶</a></dt>
775<dd><p>Set spectrum</p>
776<table class="docutils field-list" frame="void" rules="none">
777<col class="field-name" />
778<col class="field-body" />
779<tbody valign="top">
780<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>spectrum</strong> &#8211; numpy array</td>
781</tr>
782</tbody>
783</table>
784</dd></dl>
785
786<dl class="method">
787<dt id="sans.calculator.instrument.TOF.set_wave_list">
788<tt class="descname">set_wave_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_wave_list" title="Permalink to this definition">¶</a></dt>
789<dd><p>Set wavelength list</p>
790<table class="docutils field-list" frame="void" rules="none">
791<col class="field-name" />
792<col class="field-body" />
793<tbody valign="top">
794<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>wavelength</strong> &#8211; list of wavelengths</td>
795</tr>
796</tbody>
797</table>
798</dd></dl>
799
800<dl class="method">
801<dt id="sans.calculator.instrument.TOF.set_wave_spread_list">
802<tt class="descname">set_wave_spread_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_wave_spread_list" title="Permalink to this definition">¶</a></dt>
803<dd><p>Set wavelength_spread list</p>
804<table class="docutils field-list" frame="void" rules="none">
805<col class="field-name" />
806<col class="field-body" />
807<tbody valign="top">
808<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>
809</tr>
810</tbody>
811</table>
812</dd></dl>
813
814<dl class="method">
815<dt id="sans.calculator.instrument.TOF.set_wavelength">
816<tt class="descname">set_wavelength</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_wavelength" title="Permalink to this definition">¶</a></dt>
817<dd><p>Sets the wavelength</p>
818</dd></dl>
819
820<dl class="method">
821<dt id="sans.calculator.instrument.TOF.set_wavelength_spread">
822<tt class="descname">set_wavelength_spread</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.TOF.set_wavelength_spread" title="Permalink to this definition">¶</a></dt>
823<dd><p>Sets the wavelength spread</p>
824</dd></dl>
825
826<dl class="method">
827<dt id="sans.calculator.instrument.TOF.setup_spectrum">
828<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>
829<dd><p>To set the wavelength spectrum, and intensity, assumes
830wavelength is already within the spectrum</p>
831</dd></dl>
832
833</dd></dl>
834
835<dl class="function">
836<dt id="sans.calculator.instrument.validate">
837<tt class="descclassname">sans.calculator.instrument.</tt><tt class="descname">validate</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.instrument.validate" title="Permalink to this definition">¶</a></dt>
838<dd><p>Check if the value is folat &gt; 0.0</p>
839<table class="docutils field-list" frame="void" rules="none">
840<col class="field-name" />
841<col class="field-body" />
842<tbody valign="top">
843<tr class="field-odd field"><th class="field-name">Return value:</th><td class="field-body">True / False</td>
844</tr>
845</tbody>
846</table>
847</dd></dl>
848
849</div>
850</div>
851
852
853          </div>
854        </div>
855      </div>
856      <div class="sphinxsidebar">
857        <div class="sphinxsidebarwrapper">
858  <h3><a href="../index.html">Table Of Contents</a></h3>
859  <ul>
860<li><a class="reference internal" href="#">instrument</a><ul>
861<li><a class="reference internal" href="#sans-calculator-instrument"><tt class="docutils literal"><span class="pre">sans.calculator.instrument</span></tt></a></li>
862</ul>
863</li>
864</ul>
865
866  <h4>Previous topic</h4>
867  <p class="topless"><a href="index.html"
868                        title="previous chapter">Reference</a></p>
869  <h4>Next topic</h4>
870  <p class="topless"><a href="kiessig_calculator.html"
871                        title="next chapter">kiessig_calculator</a></p>
872  <h3>This Page</h3>
873  <ul class="this-page-menu">
874    <li><a href="../_sources/api/instrument.txt"
875           rel="nofollow">Show Source</a></li>
876  </ul>
877<div id="searchbox" style="display: none">
878  <h3>Quick search</h3>
879    <form class="search" action="../search.html" method="get">
880      <input type="text" name="q" />
881      <input type="submit" value="Go" />
882      <input type="hidden" name="check_keywords" value="yes" />
883      <input type="hidden" name="area" value="default" />
884    </form>
885    <p class="searchtip" style="font-size: 90%">
886    Enter search terms or a module, class or function name.
887    </p>
888</div>
889<script type="text/javascript">$('#searchbox').show(0);</script>
890        </div>
891      </div>
892      <div class="clearer"></div>
893    </div>
894    <div class="related">
895      <h3>Navigation</h3>
896      <ul>
897        <li class="right" style="margin-right: 10px">
898          <a href="../genindex.html" title="General Index"
899             >index</a></li>
900        <li class="right" >
901          <a href="../py-modindex.html" title="Python Module Index"
902             >modules</a> |</li>
903        <li class="right" >
904          <a href="kiessig_calculator.html" title="kiessig_calculator"
905             >next</a> |</li>
906        <li class="right" >
907          <a href="index.html" title="Reference"
908             >previous</a> |</li>
909        <li><a href="../index.html">calculator 0.1.0 documentation</a> &raquo;</li>
910          <li><a href="index.html" >Reference</a> &raquo;</li> 
911      </ul>
912    </div>
913    <div class="footer">
914        &copy; Copyright 2010, Gervaise Alina.
915      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
916    </div>
917  </body>
918</html>
Note: See TracBrowser for help on using the repository browser.