source: sasview/dev/api/sas.dataloader.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: 62.8 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.dataloader 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.dataloader.readers package" href="sas.dataloader.readers.html" />
30    <link rel="prev" title="sas.data_util package" href="sas.data_util.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.dataloader.readers.html" title="sas.dataloader.readers package"
44             accesskey="N">next</a> |</li>
45        <li class="right" >
46          <a href="sas.data_util.html" title="sas.data_util 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-dataloader-package">
61<h1>sas.dataloader package</h1>
62<div class="section" id="subpackages">
63<h2>Subpackages</h2>
64<div class="toctree-wrapper compound">
65<ul>
66<li class="toctree-l1"><a class="reference internal" href="sas.dataloader.readers.html">sas.dataloader.readers package</a><ul>
67<li class="toctree-l2"><a class="reference internal" href="sas.dataloader.readers.html#submodules">Submodules</a></li>
68<li class="toctree-l2"><a class="reference internal" href="sas.dataloader.readers.html#module-sas.dataloader.readers.IgorReader">sas.dataloader.readers.IgorReader module</a></li>
69<li class="toctree-l2"><a class="reference internal" href="sas.dataloader.readers.html#module-sas.dataloader.readers.abs_reader">sas.dataloader.readers.abs_reader module</a></li>
70<li class="toctree-l2"><a class="reference internal" href="sas.dataloader.readers.html#module-sas.dataloader.readers.ascii_reader">sas.dataloader.readers.ascii_reader module</a></li>
71<li class="toctree-l2"><a class="reference internal" href="sas.dataloader.readers.html#module-sas.dataloader.readers.associations">sas.dataloader.readers.associations module</a></li>
72<li class="toctree-l2"><a class="reference internal" href="sas.dataloader.readers.html#module-sas.dataloader.readers.cansas_constants">sas.dataloader.readers.cansas_constants module</a></li>
73<li class="toctree-l2"><a class="reference internal" href="sas.dataloader.readers.html#module-sas.dataloader.readers.cansas_reader">sas.dataloader.readers.cansas_reader module</a></li>
74<li class="toctree-l2"><a class="reference internal" href="sas.dataloader.readers.html#module-sas.dataloader.readers.danse_reader">sas.dataloader.readers.danse_reader module</a></li>
75<li class="toctree-l2"><a class="reference internal" href="sas.dataloader.readers.html#module-sas.dataloader.readers.hfir1d_reader">sas.dataloader.readers.hfir1d_reader module</a></li>
76<li class="toctree-l2"><a class="reference internal" href="sas.dataloader.readers.html#module-sas.dataloader.readers.nexus_reader">sas.dataloader.readers.nexus_reader module</a></li>
77<li class="toctree-l2"><a class="reference internal" href="sas.dataloader.readers.html#module-sas.dataloader.readers.red2d_reader">sas.dataloader.readers.red2d_reader module</a></li>
78<li class="toctree-l2"><a class="reference internal" href="sas.dataloader.readers.html#module-sas.dataloader.readers.tiff_reader">sas.dataloader.readers.tiff_reader module</a></li>
79<li class="toctree-l2"><a class="reference internal" href="sas.dataloader.readers.html#module-sas.dataloader.readers.xml_reader">sas.dataloader.readers.xml_reader module</a></li>
80<li class="toctree-l2"><a class="reference internal" href="sas.dataloader.readers.html#module-sas.dataloader.readers">Module contents</a></li>
81</ul>
82</li>
83</ul>
84</div>
85</div>
86<div class="section" id="submodules">
87<h2>Submodules</h2>
88</div>
89<div class="section" id="module-sas.dataloader.data_info">
90<span id="sas-dataloader-data-info-module"></span><h2>sas.dataloader.data_info module</h2>
91<p>Module that contains classes to hold information read from
92reduced data files.</p>
93<p>A good description of the data members can be found in
94the CanSAS 1D XML data format:</p>
95<p><a class="reference external" href="http://www.smallangles.net/wgwiki/index.php/cansas1d_documentation">http://www.smallangles.net/wgwiki/index.php/cansas1d_documentation</a></p>
96<dl class="class">
97<dt id="sas.dataloader.data_info.Aperture">
98<em class="property">class </em><tt class="descclassname">sas.dataloader.data_info.</tt><tt class="descname">Aperture</tt><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#Aperture"><span class="viewcode-link">[source]</span></a></dt>
99<dd><dl class="attribute">
100<dt id="sas.dataloader.data_info.Aperture.distance">
101<tt class="descname">distance</tt><em class="property"> = None</em></dt>
102<dd></dd></dl>
103
104<dl class="attribute">
105<dt id="sas.dataloader.data_info.Aperture.distance_unit">
106<tt class="descname">distance_unit</tt><em class="property"> = 'mm'</em></dt>
107<dd></dd></dl>
108
109<dl class="attribute">
110<dt id="sas.dataloader.data_info.Aperture.name">
111<tt class="descname">name</tt><em class="property"> = None</em></dt>
112<dd></dd></dl>
113
114<dl class="attribute">
115<dt id="sas.dataloader.data_info.Aperture.size">
116<tt class="descname">size</tt><em class="property"> = None</em></dt>
117<dd></dd></dl>
118
119<dl class="attribute">
120<dt id="sas.dataloader.data_info.Aperture.size_name">
121<tt class="descname">size_name</tt><em class="property"> = None</em></dt>
122<dd></dd></dl>
123
124<dl class="attribute">
125<dt id="sas.dataloader.data_info.Aperture.size_unit">
126<tt class="descname">size_unit</tt><em class="property"> = 'mm'</em></dt>
127<dd></dd></dl>
128
129<dl class="attribute">
130<dt id="sas.dataloader.data_info.Aperture.type">
131<tt class="descname">type</tt><em class="property"> = None</em></dt>
132<dd></dd></dl>
133
134</dd></dl>
135
136<dl class="class">
137<dt id="sas.dataloader.data_info.Collimation">
138<em class="property">class </em><tt class="descclassname">sas.dataloader.data_info.</tt><tt class="descname">Collimation</tt><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#Collimation"><span class="viewcode-link">[source]</span></a></dt>
139<dd><p>Class to hold collimation information</p>
140<dl class="attribute">
141<dt id="sas.dataloader.data_info.Collimation.aperture">
142<tt class="descname">aperture</tt><em class="property"> = None</em></dt>
143<dd></dd></dl>
144
145<dl class="attribute">
146<dt id="sas.dataloader.data_info.Collimation.length">
147<tt class="descname">length</tt><em class="property"> = None</em></dt>
148<dd></dd></dl>
149
150<dl class="attribute">
151<dt id="sas.dataloader.data_info.Collimation.length_unit">
152<tt class="descname">length_unit</tt><em class="property"> = 'mm'</em></dt>
153<dd></dd></dl>
154
155<dl class="attribute">
156<dt id="sas.dataloader.data_info.Collimation.name">
157<tt class="descname">name</tt><em class="property"> = None</em></dt>
158<dd></dd></dl>
159
160</dd></dl>
161
162<dl class="class">
163<dt id="sas.dataloader.data_info.Data1D">
164<em class="property">class </em><tt class="descclassname">sas.dataloader.data_info.</tt><tt class="descname">Data1D</tt><big>(</big><em>x</em>, <em>y</em>, <em>dx=None</em>, <em>dy=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#Data1D"><span class="viewcode-link">[source]</span></a></dt>
165<dd><p>Bases: <a class="reference internal" href="#sas.dataloader.data_info.plottable_1D" title="sas.dataloader.data_info.plottable_1D"><tt class="xref py py-class docutils literal"><span class="pre">sas.dataloader.data_info.plottable_1D</span></tt></a>, <a class="reference internal" href="#sas.dataloader.data_info.DataInfo" title="sas.dataloader.data_info.DataInfo"><tt class="xref py py-class docutils literal"><span class="pre">sas.dataloader.data_info.DataInfo</span></tt></a></p>
166<p>1D data class</p>
167<dl class="method">
168<dt id="sas.dataloader.data_info.Data1D.clone_without_data">
169<tt class="descname">clone_without_data</tt><big>(</big><em>length=0</em>, <em>clone=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#Data1D.clone_without_data"><span class="viewcode-link">[source]</span></a></dt>
170<dd><p>Clone the current object, without copying the data (which
171will be filled out by a subsequent operation).
172The data arrays will be initialized to zero.</p>
173<table class="docutils field-list" frame="void" rules="none">
174<col class="field-name" />
175<col class="field-body" />
176<tbody valign="top">
177<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
178<li><strong>length</strong> &#8211; length of the data array to be initialized</li>
179<li><strong>clone</strong> &#8211; if provided, the data will be copied to clone</li>
180</ul>
181</td>
182</tr>
183</tbody>
184</table>
185</dd></dl>
186
187<dl class="method">
188<dt id="sas.dataloader.data_info.Data1D.is_slit_smeared">
189<tt class="descname">is_slit_smeared</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#Data1D.is_slit_smeared"><span class="viewcode-link">[source]</span></a></dt>
190<dd><p>Check whether the data has slit smearing information</p>
191<table class="docutils field-list" frame="void" rules="none">
192<col class="field-name" />
193<col class="field-body" />
194<tbody valign="top">
195<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True is slit smearing info is present, False otherwise</td>
196</tr>
197</tbody>
198</table>
199</dd></dl>
200
201<dl class="attribute">
202<dt id="sas.dataloader.data_info.Data1D.x_unit">
203<tt class="descname">x_unit</tt><em class="property"> = '1/A'</em></dt>
204<dd></dd></dl>
205
206<dl class="attribute">
207<dt id="sas.dataloader.data_info.Data1D.y_unit">
208<tt class="descname">y_unit</tt><em class="property"> = '1/cm'</em></dt>
209<dd></dd></dl>
210
211</dd></dl>
212
213<dl class="class">
214<dt id="sas.dataloader.data_info.Data2D">
215<em class="property">class </em><tt class="descclassname">sas.dataloader.data_info.</tt><tt class="descname">Data2D</tt><big>(</big><em>data=None</em>, <em>err_data=None</em>, <em>qx_data=None</em>, <em>qy_data=None</em>, <em>q_data=None</em>, <em>mask=None</em>, <em>dqx_data=None</em>, <em>dqy_data=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#Data2D"><span class="viewcode-link">[source]</span></a></dt>
216<dd><p>Bases: <a class="reference internal" href="#sas.dataloader.data_info.plottable_2D" title="sas.dataloader.data_info.plottable_2D"><tt class="xref py py-class docutils literal"><span class="pre">sas.dataloader.data_info.plottable_2D</span></tt></a>, <a class="reference internal" href="#sas.dataloader.data_info.DataInfo" title="sas.dataloader.data_info.DataInfo"><tt class="xref py py-class docutils literal"><span class="pre">sas.dataloader.data_info.DataInfo</span></tt></a></p>
217<p>2D data class</p>
218<dl class="attribute">
219<dt id="sas.dataloader.data_info.Data2D.I_unit">
220<tt class="descname">I_unit</tt><em class="property"> = '1/cm'</em></dt>
221<dd></dd></dl>
222
223<dl class="attribute">
224<dt id="sas.dataloader.data_info.Data2D.Q_unit">
225<tt class="descname">Q_unit</tt><em class="property"> = '1/A'</em></dt>
226<dd></dd></dl>
227
228<dl class="method">
229<dt id="sas.dataloader.data_info.Data2D.clone_without_data">
230<tt class="descname">clone_without_data</tt><big>(</big><em>length=0</em>, <em>clone=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#Data2D.clone_without_data"><span class="viewcode-link">[source]</span></a></dt>
231<dd><p>Clone the current object, without copying the data (which
232will be filled out by a subsequent operation).
233The data arrays will be initialized to zero.</p>
234<table class="docutils field-list" frame="void" rules="none">
235<col class="field-name" />
236<col class="field-body" />
237<tbody valign="top">
238<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
239<li><strong>length</strong> &#8211; length of the data array to be initialized</li>
240<li><strong>clone</strong> &#8211; if provided, the data will be copied to clone</li>
241</ul>
242</td>
243</tr>
244</tbody>
245</table>
246</dd></dl>
247
248<dl class="attribute">
249<dt id="sas.dataloader.data_info.Data2D.x_bins">
250<tt class="descname">x_bins</tt><em class="property"> = None</em></dt>
251<dd></dd></dl>
252
253<dl class="attribute">
254<dt id="sas.dataloader.data_info.Data2D.y_bins">
255<tt class="descname">y_bins</tt><em class="property"> = None</em></dt>
256<dd></dd></dl>
257
258</dd></dl>
259
260<dl class="class">
261<dt id="sas.dataloader.data_info.DataInfo">
262<em class="property">class </em><tt class="descclassname">sas.dataloader.data_info.</tt><tt class="descname">DataInfo</tt><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#DataInfo"><span class="viewcode-link">[source]</span></a></dt>
263<dd><p>Class to hold the data read from a file.
264It includes four blocks of data for the
265instrument description, the sample description,
266the data itself and any other meta data.</p>
267<dl class="method">
268<dt id="sas.dataloader.data_info.DataInfo.add_notes">
269<tt class="descname">add_notes</tt><big>(</big><em>message=''</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#DataInfo.add_notes"><span class="viewcode-link">[source]</span></a></dt>
270<dd><p>Add notes to datainfo</p>
271</dd></dl>
272
273<dl class="method">
274<dt id="sas.dataloader.data_info.DataInfo.append_empty_process">
275<tt class="descname">append_empty_process</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#DataInfo.append_empty_process"><span class="viewcode-link">[source]</span></a></dt>
276<dd></dd></dl>
277
278<dl class="attribute">
279<dt id="sas.dataloader.data_info.DataInfo.collimation">
280<tt class="descname">collimation</tt><em class="property"> = None</em></dt>
281<dd></dd></dl>
282
283<dl class="attribute">
284<dt id="sas.dataloader.data_info.DataInfo.detector">
285<tt class="descname">detector</tt><em class="property"> = None</em></dt>
286<dd></dd></dl>
287
288<dl class="attribute">
289<dt id="sas.dataloader.data_info.DataInfo.errors">
290<tt class="descname">errors</tt><em class="property"> = None</em></dt>
291<dd></dd></dl>
292
293<dl class="attribute">
294<dt id="sas.dataloader.data_info.DataInfo.filename">
295<tt class="descname">filename</tt><em class="property"> = ''</em></dt>
296<dd></dd></dl>
297
298<dl class="attribute">
299<dt id="sas.dataloader.data_info.DataInfo.instrument">
300<tt class="descname">instrument</tt><em class="property"> = ''</em></dt>
301<dd></dd></dl>
302
303<dl class="attribute">
304<dt id="sas.dataloader.data_info.DataInfo.meta_data">
305<tt class="descname">meta_data</tt><em class="property"> = None</em></dt>
306<dd></dd></dl>
307
308<dl class="attribute">
309<dt id="sas.dataloader.data_info.DataInfo.notes">
310<tt class="descname">notes</tt><em class="property"> = None</em></dt>
311<dd></dd></dl>
312
313<dl class="attribute">
314<dt id="sas.dataloader.data_info.DataInfo.process">
315<tt class="descname">process</tt><em class="property"> = None</em></dt>
316<dd></dd></dl>
317
318<dl class="attribute">
319<dt id="sas.dataloader.data_info.DataInfo.run">
320<tt class="descname">run</tt><em class="property"> = None</em></dt>
321<dd></dd></dl>
322
323<dl class="attribute">
324<dt id="sas.dataloader.data_info.DataInfo.run_name">
325<tt class="descname">run_name</tt><em class="property"> = None</em></dt>
326<dd></dd></dl>
327
328<dl class="attribute">
329<dt id="sas.dataloader.data_info.DataInfo.sample">
330<tt class="descname">sample</tt><em class="property"> = None</em></dt>
331<dd></dd></dl>
332
333<dl class="attribute">
334<dt id="sas.dataloader.data_info.DataInfo.source">
335<tt class="descname">source</tt><em class="property"> = None</em></dt>
336<dd></dd></dl>
337
338<dl class="attribute">
339<dt id="sas.dataloader.data_info.DataInfo.title">
340<tt class="descname">title</tt><em class="property"> = ''</em></dt>
341<dd></dd></dl>
342
343<dl class="attribute">
344<dt id="sas.dataloader.data_info.DataInfo.trans_spectrum">
345<tt class="descname">trans_spectrum</tt><em class="property"> = None</em></dt>
346<dd></dd></dl>
347
348</dd></dl>
349
350<dl class="class">
351<dt id="sas.dataloader.data_info.Detector">
352<em class="property">class </em><tt class="descclassname">sas.dataloader.data_info.</tt><tt class="descname">Detector</tt><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#Detector"><span class="viewcode-link">[source]</span></a></dt>
353<dd><p>Class to hold detector information</p>
354<dl class="attribute">
355<dt id="sas.dataloader.data_info.Detector.beam_center">
356<tt class="descname">beam_center</tt><em class="property"> = None</em></dt>
357<dd></dd></dl>
358
359<dl class="attribute">
360<dt id="sas.dataloader.data_info.Detector.beam_center_unit">
361<tt class="descname">beam_center_unit</tt><em class="property"> = 'mm'</em></dt>
362<dd></dd></dl>
363
364<dl class="attribute">
365<dt id="sas.dataloader.data_info.Detector.distance">
366<tt class="descname">distance</tt><em class="property"> = None</em></dt>
367<dd></dd></dl>
368
369<dl class="attribute">
370<dt id="sas.dataloader.data_info.Detector.distance_unit">
371<tt class="descname">distance_unit</tt><em class="property"> = 'mm'</em></dt>
372<dd></dd></dl>
373
374<dl class="attribute">
375<dt id="sas.dataloader.data_info.Detector.name">
376<tt class="descname">name</tt><em class="property"> = None</em></dt>
377<dd></dd></dl>
378
379<dl class="attribute">
380<dt id="sas.dataloader.data_info.Detector.offset">
381<tt class="descname">offset</tt><em class="property"> = None</em></dt>
382<dd></dd></dl>
383
384<dl class="attribute">
385<dt id="sas.dataloader.data_info.Detector.offset_unit">
386<tt class="descname">offset_unit</tt><em class="property"> = 'm'</em></dt>
387<dd></dd></dl>
388
389<dl class="attribute">
390<dt id="sas.dataloader.data_info.Detector.orientation">
391<tt class="descname">orientation</tt><em class="property"> = None</em></dt>
392<dd></dd></dl>
393
394<dl class="attribute">
395<dt id="sas.dataloader.data_info.Detector.orientation_unit">
396<tt class="descname">orientation_unit</tt><em class="property"> = 'degree'</em></dt>
397<dd></dd></dl>
398
399<dl class="attribute">
400<dt id="sas.dataloader.data_info.Detector.pixel_size">
401<tt class="descname">pixel_size</tt><em class="property"> = None</em></dt>
402<dd></dd></dl>
403
404<dl class="attribute">
405<dt id="sas.dataloader.data_info.Detector.pixel_size_unit">
406<tt class="descname">pixel_size_unit</tt><em class="property"> = 'mm'</em></dt>
407<dd></dd></dl>
408
409<dl class="attribute">
410<dt id="sas.dataloader.data_info.Detector.slit_length">
411<tt class="descname">slit_length</tt><em class="property"> = None</em></dt>
412<dd></dd></dl>
413
414<dl class="attribute">
415<dt id="sas.dataloader.data_info.Detector.slit_length_unit">
416<tt class="descname">slit_length_unit</tt><em class="property"> = 'mm'</em></dt>
417<dd></dd></dl>
418
419</dd></dl>
420
421<dl class="class">
422<dt id="sas.dataloader.data_info.Process">
423<em class="property">class </em><tt class="descclassname">sas.dataloader.data_info.</tt><tt class="descname">Process</tt><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#Process"><span class="viewcode-link">[source]</span></a></dt>
424<dd><p>Class that holds information about the processes
425performed on the data.</p>
426<dl class="attribute">
427<dt id="sas.dataloader.data_info.Process.date">
428<tt class="descname">date</tt><em class="property"> = ''</em></dt>
429<dd></dd></dl>
430
431<dl class="attribute">
432<dt id="sas.dataloader.data_info.Process.description">
433<tt class="descname">description</tt><em class="property"> = ''</em></dt>
434<dd></dd></dl>
435
436<dl class="attribute">
437<dt id="sas.dataloader.data_info.Process.name">
438<tt class="descname">name</tt><em class="property"> = ''</em></dt>
439<dd></dd></dl>
440
441<dl class="attribute">
442<dt id="sas.dataloader.data_info.Process.notes">
443<tt class="descname">notes</tt><em class="property"> = None</em></dt>
444<dd></dd></dl>
445
446<dl class="attribute">
447<dt id="sas.dataloader.data_info.Process.term">
448<tt class="descname">term</tt><em class="property"> = None</em></dt>
449<dd></dd></dl>
450
451</dd></dl>
452
453<dl class="class">
454<dt id="sas.dataloader.data_info.Sample">
455<em class="property">class </em><tt class="descclassname">sas.dataloader.data_info.</tt><tt class="descname">Sample</tt><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#Sample"><span class="viewcode-link">[source]</span></a></dt>
456<dd><p>Class to hold the sample description</p>
457<dl class="attribute">
458<dt id="sas.dataloader.data_info.Sample.ID">
459<tt class="descname">ID</tt><em class="property"> = ''</em></dt>
460<dd></dd></dl>
461
462<dl class="attribute">
463<dt id="sas.dataloader.data_info.Sample.details">
464<tt class="descname">details</tt><em class="property"> = None</em></dt>
465<dd></dd></dl>
466
467<dl class="attribute">
468<dt id="sas.dataloader.data_info.Sample.name">
469<tt class="descname">name</tt><em class="property"> = ''</em></dt>
470<dd></dd></dl>
471
472<dl class="attribute">
473<dt id="sas.dataloader.data_info.Sample.orientation">
474<tt class="descname">orientation</tt><em class="property"> = None</em></dt>
475<dd></dd></dl>
476
477<dl class="attribute">
478<dt id="sas.dataloader.data_info.Sample.orientation_unit">
479<tt class="descname">orientation_unit</tt><em class="property"> = 'degree'</em></dt>
480<dd></dd></dl>
481
482<dl class="attribute">
483<dt id="sas.dataloader.data_info.Sample.position">
484<tt class="descname">position</tt><em class="property"> = None</em></dt>
485<dd></dd></dl>
486
487<dl class="attribute">
488<dt id="sas.dataloader.data_info.Sample.position_unit">
489<tt class="descname">position_unit</tt><em class="property"> = 'mm'</em></dt>
490<dd></dd></dl>
491
492<dl class="attribute">
493<dt id="sas.dataloader.data_info.Sample.temperature">
494<tt class="descname">temperature</tt><em class="property"> = None</em></dt>
495<dd></dd></dl>
496
497<dl class="attribute">
498<dt id="sas.dataloader.data_info.Sample.temperature_unit">
499<tt class="descname">temperature_unit</tt><em class="property"> = 'C'</em></dt>
500<dd></dd></dl>
501
502<dl class="attribute">
503<dt id="sas.dataloader.data_info.Sample.thickness">
504<tt class="descname">thickness</tt><em class="property"> = None</em></dt>
505<dd></dd></dl>
506
507<dl class="attribute">
508<dt id="sas.dataloader.data_info.Sample.thickness_unit">
509<tt class="descname">thickness_unit</tt><em class="property"> = 'mm'</em></dt>
510<dd></dd></dl>
511
512<dl class="attribute">
513<dt id="sas.dataloader.data_info.Sample.transmission">
514<tt class="descname">transmission</tt><em class="property"> = None</em></dt>
515<dd></dd></dl>
516
517</dd></dl>
518
519<dl class="class">
520<dt id="sas.dataloader.data_info.Source">
521<em class="property">class </em><tt class="descclassname">sas.dataloader.data_info.</tt><tt class="descname">Source</tt><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#Source"><span class="viewcode-link">[source]</span></a></dt>
522<dd><p>Class to hold source information</p>
523<dl class="attribute">
524<dt id="sas.dataloader.data_info.Source.beam_shape">
525<tt class="descname">beam_shape</tt><em class="property"> = None</em></dt>
526<dd></dd></dl>
527
528<dl class="attribute">
529<dt id="sas.dataloader.data_info.Source.beam_size">
530<tt class="descname">beam_size</tt><em class="property"> = None</em></dt>
531<dd></dd></dl>
532
533<dl class="attribute">
534<dt id="sas.dataloader.data_info.Source.beam_size_name">
535<tt class="descname">beam_size_name</tt><em class="property"> = None</em></dt>
536<dd></dd></dl>
537
538<dl class="attribute">
539<dt id="sas.dataloader.data_info.Source.beam_size_unit">
540<tt class="descname">beam_size_unit</tt><em class="property"> = 'mm'</em></dt>
541<dd></dd></dl>
542
543<dl class="attribute">
544<dt id="sas.dataloader.data_info.Source.name">
545<tt class="descname">name</tt><em class="property"> = None</em></dt>
546<dd></dd></dl>
547
548<dl class="attribute">
549<dt id="sas.dataloader.data_info.Source.radiation">
550<tt class="descname">radiation</tt><em class="property"> = None</em></dt>
551<dd></dd></dl>
552
553<dl class="attribute">
554<dt id="sas.dataloader.data_info.Source.wavelength">
555<tt class="descname">wavelength</tt><em class="property"> = None</em></dt>
556<dd></dd></dl>
557
558<dl class="attribute">
559<dt id="sas.dataloader.data_info.Source.wavelength_max">
560<tt class="descname">wavelength_max</tt><em class="property"> = None</em></dt>
561<dd></dd></dl>
562
563<dl class="attribute">
564<dt id="sas.dataloader.data_info.Source.wavelength_max_unit">
565<tt class="descname">wavelength_max_unit</tt><em class="property"> = 'nm'</em></dt>
566<dd></dd></dl>
567
568<dl class="attribute">
569<dt id="sas.dataloader.data_info.Source.wavelength_min">
570<tt class="descname">wavelength_min</tt><em class="property"> = None</em></dt>
571<dd></dd></dl>
572
573<dl class="attribute">
574<dt id="sas.dataloader.data_info.Source.wavelength_min_unit">
575<tt class="descname">wavelength_min_unit</tt><em class="property"> = 'nm'</em></dt>
576<dd></dd></dl>
577
578<dl class="attribute">
579<dt id="sas.dataloader.data_info.Source.wavelength_spread">
580<tt class="descname">wavelength_spread</tt><em class="property"> = None</em></dt>
581<dd></dd></dl>
582
583<dl class="attribute">
584<dt id="sas.dataloader.data_info.Source.wavelength_spread_unit">
585<tt class="descname">wavelength_spread_unit</tt><em class="property"> = 'percent'</em></dt>
586<dd></dd></dl>
587
588<dl class="attribute">
589<dt id="sas.dataloader.data_info.Source.wavelength_unit">
590<tt class="descname">wavelength_unit</tt><em class="property"> = 'A'</em></dt>
591<dd></dd></dl>
592
593</dd></dl>
594
595<dl class="class">
596<dt id="sas.dataloader.data_info.TransmissionSpectrum">
597<em class="property">class </em><tt class="descclassname">sas.dataloader.data_info.</tt><tt class="descname">TransmissionSpectrum</tt><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#TransmissionSpectrum"><span class="viewcode-link">[source]</span></a></dt>
598<dd><p>Class that holds information about transmission spectrum
599for white beams and spallation sources.</p>
600<dl class="attribute">
601<dt id="sas.dataloader.data_info.TransmissionSpectrum.name">
602<tt class="descname">name</tt><em class="property"> = ''</em></dt>
603<dd></dd></dl>
604
605<dl class="attribute">
606<dt id="sas.dataloader.data_info.TransmissionSpectrum.timestamp">
607<tt class="descname">timestamp</tt><em class="property"> = ''</em></dt>
608<dd></dd></dl>
609
610<dl class="attribute">
611<dt id="sas.dataloader.data_info.TransmissionSpectrum.transmission">
612<tt class="descname">transmission</tt><em class="property"> = None</em></dt>
613<dd></dd></dl>
614
615<dl class="attribute">
616<dt id="sas.dataloader.data_info.TransmissionSpectrum.transmission_deviation">
617<tt class="descname">transmission_deviation</tt><em class="property"> = None</em></dt>
618<dd></dd></dl>
619
620<dl class="attribute">
621<dt id="sas.dataloader.data_info.TransmissionSpectrum.transmission_deviation_unit">
622<tt class="descname">transmission_deviation_unit</tt><em class="property"> = ''</em></dt>
623<dd></dd></dl>
624
625<dl class="attribute">
626<dt id="sas.dataloader.data_info.TransmissionSpectrum.transmission_unit">
627<tt class="descname">transmission_unit</tt><em class="property"> = ''</em></dt>
628<dd></dd></dl>
629
630<dl class="attribute">
631<dt id="sas.dataloader.data_info.TransmissionSpectrum.wavelength">
632<tt class="descname">wavelength</tt><em class="property"> = None</em></dt>
633<dd></dd></dl>
634
635<dl class="attribute">
636<dt id="sas.dataloader.data_info.TransmissionSpectrum.wavelength_unit">
637<tt class="descname">wavelength_unit</tt><em class="property"> = 'A'</em></dt>
638<dd></dd></dl>
639
640</dd></dl>
641
642<dl class="class">
643<dt id="sas.dataloader.data_info.Vector">
644<em class="property">class </em><tt class="descclassname">sas.dataloader.data_info.</tt><tt class="descname">Vector</tt><big>(</big><em>x=None</em>, <em>y=None</em>, <em>z=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#Vector"><span class="viewcode-link">[source]</span></a></dt>
645<dd><p>Vector class to hold multi-dimensional objects</p>
646<dl class="attribute">
647<dt id="sas.dataloader.data_info.Vector.x">
648<tt class="descname">x</tt><em class="property"> = None</em></dt>
649<dd></dd></dl>
650
651<dl class="attribute">
652<dt id="sas.dataloader.data_info.Vector.y">
653<tt class="descname">y</tt><em class="property"> = None</em></dt>
654<dd></dd></dl>
655
656<dl class="attribute">
657<dt id="sas.dataloader.data_info.Vector.z">
658<tt class="descname">z</tt><em class="property"> = None</em></dt>
659<dd></dd></dl>
660
661</dd></dl>
662
663<dl class="class">
664<dt id="sas.dataloader.data_info.plottable_1D">
665<em class="property">class </em><tt class="descclassname">sas.dataloader.data_info.</tt><tt class="descname">plottable_1D</tt><big>(</big><em>x</em>, <em>y</em>, <em>dx=None</em>, <em>dy=None</em>, <em>dxl=None</em>, <em>dxw=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#plottable_1D"><span class="viewcode-link">[source]</span></a></dt>
666<dd><p>Data1D is a place holder for 1D plottables.</p>
667<dl class="attribute">
668<dt id="sas.dataloader.data_info.plottable_1D.dx">
669<tt class="descname">dx</tt><em class="property"> = None</em></dt>
670<dd></dd></dl>
671
672<dl class="attribute">
673<dt id="sas.dataloader.data_info.plottable_1D.dxl">
674<tt class="descname">dxl</tt><em class="property"> = None</em></dt>
675<dd></dd></dl>
676
677<dl class="attribute">
678<dt id="sas.dataloader.data_info.plottable_1D.dxw">
679<tt class="descname">dxw</tt><em class="property"> = None</em></dt>
680<dd></dd></dl>
681
682<dl class="attribute">
683<dt id="sas.dataloader.data_info.plottable_1D.dy">
684<tt class="descname">dy</tt><em class="property"> = None</em></dt>
685<dd></dd></dl>
686
687<dl class="attribute">
688<dt id="sas.dataloader.data_info.plottable_1D.x">
689<tt class="descname">x</tt><em class="property"> = None</em></dt>
690<dd></dd></dl>
691
692<dl class="method">
693<dt id="sas.dataloader.data_info.plottable_1D.xaxis">
694<tt class="descname">xaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#plottable_1D.xaxis"><span class="viewcode-link">[source]</span></a></dt>
695<dd><p>set the x axis label and unit</p>
696</dd></dl>
697
698<dl class="attribute">
699<dt id="sas.dataloader.data_info.plottable_1D.y">
700<tt class="descname">y</tt><em class="property"> = None</em></dt>
701<dd></dd></dl>
702
703<dl class="method">
704<dt id="sas.dataloader.data_info.plottable_1D.yaxis">
705<tt class="descname">yaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#plottable_1D.yaxis"><span class="viewcode-link">[source]</span></a></dt>
706<dd><p>set the y axis label and unit</p>
707</dd></dl>
708
709</dd></dl>
710
711<dl class="class">
712<dt id="sas.dataloader.data_info.plottable_2D">
713<em class="property">class </em><tt class="descclassname">sas.dataloader.data_info.</tt><tt class="descname">plottable_2D</tt><big>(</big><em>data=None</em>, <em>err_data=None</em>, <em>qx_data=None</em>, <em>qy_data=None</em>, <em>q_data=None</em>, <em>mask=None</em>, <em>dqx_data=None</em>, <em>dqy_data=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#plottable_2D"><span class="viewcode-link">[source]</span></a></dt>
714<dd><p>Data2D is a place holder for 2D plottables.</p>
715<dl class="attribute">
716<dt id="sas.dataloader.data_info.plottable_2D.data">
717<tt class="descname">data</tt><em class="property"> = None</em></dt>
718<dd></dd></dl>
719
720<dl class="attribute">
721<dt id="sas.dataloader.data_info.plottable_2D.dqx_data">
722<tt class="descname">dqx_data</tt><em class="property"> = None</em></dt>
723<dd></dd></dl>
724
725<dl class="attribute">
726<dt id="sas.dataloader.data_info.plottable_2D.dqy_data">
727<tt class="descname">dqy_data</tt><em class="property"> = None</em></dt>
728<dd></dd></dl>
729
730<dl class="attribute">
731<dt id="sas.dataloader.data_info.plottable_2D.err_data">
732<tt class="descname">err_data</tt><em class="property"> = None</em></dt>
733<dd></dd></dl>
734
735<dl class="attribute">
736<dt id="sas.dataloader.data_info.plottable_2D.mask">
737<tt class="descname">mask</tt><em class="property"> = None</em></dt>
738<dd></dd></dl>
739
740<dl class="attribute">
741<dt id="sas.dataloader.data_info.plottable_2D.q_data">
742<tt class="descname">q_data</tt><em class="property"> = None</em></dt>
743<dd></dd></dl>
744
745<dl class="attribute">
746<dt id="sas.dataloader.data_info.plottable_2D.qx_data">
747<tt class="descname">qx_data</tt><em class="property"> = None</em></dt>
748<dd></dd></dl>
749
750<dl class="attribute">
751<dt id="sas.dataloader.data_info.plottable_2D.qy_data">
752<tt class="descname">qy_data</tt><em class="property"> = None</em></dt>
753<dd></dd></dl>
754
755<dl class="method">
756<dt id="sas.dataloader.data_info.plottable_2D.xaxis">
757<tt class="descname">xaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#plottable_2D.xaxis"><span class="viewcode-link">[source]</span></a></dt>
758<dd><p>set the x axis label and unit</p>
759</dd></dl>
760
761<dl class="attribute">
762<dt id="sas.dataloader.data_info.plottable_2D.xmax">
763<tt class="descname">xmax</tt><em class="property"> = None</em></dt>
764<dd></dd></dl>
765
766<dl class="attribute">
767<dt id="sas.dataloader.data_info.plottable_2D.xmin">
768<tt class="descname">xmin</tt><em class="property"> = None</em></dt>
769<dd></dd></dl>
770
771<dl class="method">
772<dt id="sas.dataloader.data_info.plottable_2D.yaxis">
773<tt class="descname">yaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#plottable_2D.yaxis"><span class="viewcode-link">[source]</span></a></dt>
774<dd><p>set the y axis label and unit</p>
775</dd></dl>
776
777<dl class="attribute">
778<dt id="sas.dataloader.data_info.plottable_2D.ymax">
779<tt class="descname">ymax</tt><em class="property"> = None</em></dt>
780<dd></dd></dl>
781
782<dl class="attribute">
783<dt id="sas.dataloader.data_info.plottable_2D.ymin">
784<tt class="descname">ymin</tt><em class="property"> = None</em></dt>
785<dd></dd></dl>
786
787<dl class="method">
788<dt id="sas.dataloader.data_info.plottable_2D.zaxis">
789<tt class="descname">zaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/data_info.html#plottable_2D.zaxis"><span class="viewcode-link">[source]</span></a></dt>
790<dd><p>set the z axis label and unit</p>
791</dd></dl>
792
793</dd></dl>
794
795</div>
796<div class="section" id="module-sas.dataloader.loader">
797<span id="sas-dataloader-loader-module"></span><h2>sas.dataloader.loader module</h2>
798<p>File handler to support different file extensions.
799Uses reflectometry&#8217;s registry utility.</p>
800<p>The default readers are found in the &#8216;readers&#8217; sub-module
801and registered by default at initialization time.</p>
802<p>To add a new default reader, one must register it in
803the register_readers method found in readers/__init__.py.</p>
804<p>A utility method (find_plugins) is available to inspect
805a directory (for instance, a user plug-in directory) and
806look for new readers/writers.</p>
807<dl class="class">
808<dt id="sas.dataloader.loader.Loader">
809<em class="property">class </em><tt class="descclassname">sas.dataloader.loader.</tt><tt class="descname">Loader</tt><a class="reference internal" href="../../_modules/sas/dataloader/loader.html#Loader"><span class="viewcode-link">[source]</span></a></dt>
810<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
811<p>Utility class to use the Registry as a singleton.</p>
812<dl class="method">
813<dt id="sas.dataloader.loader.Loader.associate_file_reader">
814<tt class="descname">associate_file_reader</tt><big>(</big><em>ext</em>, <em>loader</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/loader.html#Loader.associate_file_reader"><span class="viewcode-link">[source]</span></a></dt>
815<dd><p>Append a reader object to readers</p>
816<table class="docutils field-list" frame="void" rules="none">
817<col class="field-name" />
818<col class="field-body" />
819<tbody valign="top">
820<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
821<li><strong>ext</strong> &#8211; file extension [string]</li>
822<li><strong>module</strong> &#8211; reader object</li>
823</ul>
824</td>
825</tr>
826</tbody>
827</table>
828</dd></dl>
829
830<dl class="method">
831<dt id="sas.dataloader.loader.Loader.associate_file_type">
832<tt class="descname">associate_file_type</tt><big>(</big><em>ext</em>, <em>module</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/loader.html#Loader.associate_file_type"><span class="viewcode-link">[source]</span></a></dt>
833<dd><p>Look into a module to find whether it contains a
834Reader class. If so, append it to readers and (potentially)
835to the list of writers for the given extension</p>
836<table class="docutils field-list" frame="void" rules="none">
837<col class="field-name" />
838<col class="field-body" />
839<tbody valign="top">
840<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
841<li><strong>ext</strong> &#8211; file extension [string]</li>
842<li><strong>module</strong> &#8211; module object</li>
843</ul>
844</td>
845</tr>
846</tbody>
847</table>
848</dd></dl>
849
850<dl class="method">
851<dt id="sas.dataloader.loader.Loader.find_plugins">
852<tt class="descname">find_plugins</tt><big>(</big><em>dir</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/loader.html#Loader.find_plugins"><span class="viewcode-link">[source]</span></a></dt>
853<dd><p>Find plugins in a given directory</p>
854<table class="docutils field-list" frame="void" rules="none">
855<col class="field-name" />
856<col class="field-body" />
857<tbody valign="top">
858<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dir</strong> &#8211; directory to look into to find new readers/writers</td>
859</tr>
860</tbody>
861</table>
862</dd></dl>
863
864<dl class="method">
865<dt id="sas.dataloader.loader.Loader.get_wildcards">
866<tt class="descname">get_wildcards</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/loader.html#Loader.get_wildcards"><span class="viewcode-link">[source]</span></a></dt>
867<dd></dd></dl>
868
869<dl class="method">
870<dt id="sas.dataloader.loader.Loader.load">
871<tt class="descname">load</tt><big>(</big><em>file</em>, <em>format=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/loader.html#Loader.load"><span class="viewcode-link">[source]</span></a></dt>
872<dd><p>Load a file</p>
873<table class="docutils field-list" frame="void" rules="none">
874<col class="field-name" />
875<col class="field-body" />
876<tbody valign="top">
877<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
878<li><strong>file</strong> &#8211; file name (path)</li>
879<li><strong>format</strong> &#8211; specified format to use (optional)</li>
880</ul>
881</td>
882</tr>
883<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">DataInfo object</p>
884</td>
885</tr>
886</tbody>
887</table>
888</dd></dl>
889
890<dl class="method">
891<dt id="sas.dataloader.loader.Loader.save">
892<tt class="descname">save</tt><big>(</big><em>file</em>, <em>data</em>, <em>format</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/loader.html#Loader.save"><span class="viewcode-link">[source]</span></a></dt>
893<dd><p>Save a DataInfo object to file
894:param file: file name (path)
895:param data: DataInfo object
896:param format: format to write the data in</p>
897</dd></dl>
898
899</dd></dl>
900
901<dl class="class">
902<dt id="sas.dataloader.loader.Registry">
903<em class="property">class </em><tt class="descclassname">sas.dataloader.loader.</tt><tt class="descname">Registry</tt><a class="reference internal" href="../../_modules/sas/dataloader/loader.html#Registry"><span class="viewcode-link">[source]</span></a></dt>
904<dd><p>Bases: <a class="reference internal" href="sas.data_util.html#sas.data_util.registry.ExtensionRegistry" title="sas.data_util.registry.ExtensionRegistry"><tt class="xref py py-class docutils literal"><span class="pre">sas.data_util.registry.ExtensionRegistry</span></tt></a></p>
905<p>Registry class for file format extensions.
906Readers and writers are supported.</p>
907<dl class="method">
908<dt id="sas.dataloader.loader.Registry.associate_file_reader">
909<tt class="descname">associate_file_reader</tt><big>(</big><em>ext</em>, <em>loader</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/loader.html#Registry.associate_file_reader"><span class="viewcode-link">[source]</span></a></dt>
910<dd><p>Append a reader object to readers</p>
911<table class="docutils field-list" frame="void" rules="none">
912<col class="field-name" />
913<col class="field-body" />
914<tbody valign="top">
915<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
916<li><strong>ext</strong> &#8211; file extension [string]</li>
917<li><strong>module</strong> &#8211; reader object</li>
918</ul>
919</td>
920</tr>
921</tbody>
922</table>
923</dd></dl>
924
925<dl class="method">
926<dt id="sas.dataloader.loader.Registry.associate_file_type">
927<tt class="descname">associate_file_type</tt><big>(</big><em>ext</em>, <em>module</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/loader.html#Registry.associate_file_type"><span class="viewcode-link">[source]</span></a></dt>
928<dd><p>Look into a module to find whether it contains a
929Reader class. If so, APPEND it to readers and (potentially)
930to the list of writers for the given extension</p>
931<table class="docutils field-list" frame="void" rules="none">
932<col class="field-name" />
933<col class="field-body" />
934<tbody valign="top">
935<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
936<li><strong>ext</strong> &#8211; file extension [string]</li>
937<li><strong>module</strong> &#8211; module object</li>
938</ul>
939</td>
940</tr>
941</tbody>
942</table>
943</dd></dl>
944
945<dl class="method">
946<dt id="sas.dataloader.loader.Registry.find_plugins">
947<tt class="descname">find_plugins</tt><big>(</big><em>dir</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/loader.html#Registry.find_plugins"><span class="viewcode-link">[source]</span></a></dt>
948<dd><p>Find readers in a given directory. This method
949can be used to inspect user plug-in directories to
950find new readers/writers.</p>
951<table class="docutils field-list" frame="void" rules="none">
952<col class="field-name" />
953<col class="field-body" />
954<tbody valign="top">
955<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dir</strong> &#8211; directory to search into</td>
956</tr>
957<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">number of readers found</td>
958</tr>
959</tbody>
960</table>
961</dd></dl>
962
963<dl class="method">
964<dt id="sas.dataloader.loader.Registry.load">
965<tt class="descname">load</tt><big>(</big><em>path</em>, <em>format=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/loader.html#Registry.load"><span class="viewcode-link">[source]</span></a></dt>
966<dd><p>Call the loader for the file type of path.</p>
967<table class="docutils field-list" frame="void" rules="none">
968<col class="field-name" />
969<col class="field-body" />
970<tbody valign="top">
971<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
972<li><strong>path</strong> &#8211; file path</li>
973<li><strong>format</strong> &#8211; explicit extension, to force the use
974of a particular reader</li>
975</ul>
976</td>
977</tr>
978</tbody>
979</table>
980<p>Defaults to the ascii (multi-column) reader
981if no reader was registered for the file&#8217;s
982extension.</p>
983</dd></dl>
984
985<dl class="method">
986<dt id="sas.dataloader.loader.Registry.lookup_writers">
987<tt class="descname">lookup_writers</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/loader.html#Registry.lookup_writers"><span class="viewcode-link">[source]</span></a></dt>
988<dd><table class="docutils field-list" frame="void" rules="none">
989<col class="field-name" />
990<col class="field-body" />
991<tbody valign="top">
992<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the loader associated with the file type of path.</td>
993</tr>
994<tr class="field-even field"><th class="field-name" colspan="2">Raises ValueError:</th></tr>
995<tr class="field-even field"><td>&nbsp;</td><td class="field-body">if file type is not known.</td>
996</tr>
997</tbody>
998</table>
999</dd></dl>
1000
1001<dl class="method">
1002<dt id="sas.dataloader.loader.Registry.save">
1003<tt class="descname">save</tt><big>(</big><em>path</em>, <em>data</em>, <em>format=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/loader.html#Registry.save"><span class="viewcode-link">[source]</span></a></dt>
1004<dd><p>Call the writer for the file type of path.</p>
1005<p>Raises ValueError if no writer is available.
1006Raises KeyError if format is not available.</p>
1007<p>May raise a writer-defined exception if writer fails.</p>
1008</dd></dl>
1009
1010</dd></dl>
1011
1012</div>
1013<div class="section" id="module-sas.dataloader.manipulations">
1014<span id="sas-dataloader-manipulations-module"></span><h2>sas.dataloader.manipulations module</h2>
1015<p>Data manipulations for 2D data sets.
1016Using the meta data information, various types of averaging
1017are performed in Q-space</p>
1018<dl class="class">
1019<dt id="sas.dataloader.manipulations.Boxavg">
1020<em class="property">class </em><tt class="descclassname">sas.dataloader.manipulations.</tt><tt class="descname">Boxavg</tt><big>(</big><em>x_min=0.0</em>, <em>x_max=0.0</em>, <em>y_min=0.0</em>, <em>y_max=0.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/manipulations.html#Boxavg"><span class="viewcode-link">[source]</span></a></dt>
1021<dd><p>Bases: <a class="reference internal" href="#sas.dataloader.manipulations.Boxsum" title="sas.dataloader.manipulations.Boxsum"><tt class="xref py py-class docutils literal"><span class="pre">sas.dataloader.manipulations.Boxsum</span></tt></a></p>
1022<p>Perform the average of counts in a 2D region of interest.</p>
1023</dd></dl>
1024
1025<dl class="class">
1026<dt id="sas.dataloader.manipulations.Boxcut">
1027<em class="property">class </em><tt class="descclassname">sas.dataloader.manipulations.</tt><tt class="descname">Boxcut</tt><big>(</big><em>x_min=0.0</em>, <em>x_max=0.0</em>, <em>y_min=0.0</em>, <em>y_max=0.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/manipulations.html#Boxcut"><span class="viewcode-link">[source]</span></a></dt>
1028<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
1029<p>Find a rectangular 2D region of interest.</p>
1030</dd></dl>
1031
1032<dl class="class">
1033<dt id="sas.dataloader.manipulations.Boxsum">
1034<em class="property">class </em><tt class="descclassname">sas.dataloader.manipulations.</tt><tt class="descname">Boxsum</tt><big>(</big><em>x_min=0.0</em>, <em>x_max=0.0</em>, <em>y_min=0.0</em>, <em>y_max=0.0</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/manipulations.html#Boxsum"><span class="viewcode-link">[source]</span></a></dt>
1035<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
1036<p>Perform the sum of counts in a 2D region of interest.</p>
1037</dd></dl>
1038
1039<dl class="class">
1040<dt id="sas.dataloader.manipulations.CircularAverage">
1041<em class="property">class </em><tt class="descclassname">sas.dataloader.manipulations.</tt><tt class="descname">CircularAverage</tt><big>(</big><em>r_min=0.0</em>, <em>r_max=0.0</em>, <em>bin_width=0.0005</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/manipulations.html#CircularAverage"><span class="viewcode-link">[source]</span></a></dt>
1042<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
1043<p>Perform circular averaging on 2D data</p>
1044<p>The data returned is the distribution of counts
1045as a function of Q</p>
1046</dd></dl>
1047
1048<dl class="class">
1049<dt id="sas.dataloader.manipulations.Ring">
1050<em class="property">class </em><tt class="descclassname">sas.dataloader.manipulations.</tt><tt class="descname">Ring</tt><big>(</big><em>r_min=0</em>, <em>r_max=0</em>, <em>center_x=0</em>, <em>center_y=0</em>, <em>nbins=20</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/manipulations.html#Ring"><span class="viewcode-link">[source]</span></a></dt>
1051<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
1052<p>Defines a ring on a 2D data set.
1053The ring is defined by r_min, r_max, and
1054the position of the center of the ring.</p>
1055<p>The data returned is the distribution of counts
1056around the ring as a function of phi.</p>
1057<p>Phi_min and phi_max should be defined between 0 and 2*pi
1058in anti-clockwise starting from the x- axis on the left-hand side</p>
1059</dd></dl>
1060
1061<dl class="class">
1062<dt id="sas.dataloader.manipulations.Ringcut">
1063<em class="property">class </em><tt class="descclassname">sas.dataloader.manipulations.</tt><tt class="descname">Ringcut</tt><big>(</big><em>r_min=0</em>, <em>r_max=0</em>, <em>center_x=0</em>, <em>center_y=0</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/manipulations.html#Ringcut"><span class="viewcode-link">[source]</span></a></dt>
1064<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
1065<p>Defines a ring on a 2D data set.
1066The ring is defined by r_min, r_max, and
1067the position of the center of the ring.</p>
1068<p>The data returned is the region inside the ring</p>
1069<p>Phi_min and phi_max should be defined between 0 and 2*pi
1070in anti-clockwise starting from the x- axis on the left-hand side</p>
1071</dd></dl>
1072
1073<dl class="class">
1074<dt id="sas.dataloader.manipulations.SectorPhi">
1075<em class="property">class </em><tt class="descclassname">sas.dataloader.manipulations.</tt><tt class="descname">SectorPhi</tt><big>(</big><em>r_min</em>, <em>r_max</em>, <em>phi_min=0</em>, <em>phi_max=6.283185307179586</em>, <em>nbins=20</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/manipulations.html#SectorPhi"><span class="viewcode-link">[source]</span></a></dt>
1076<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sas.dataloader.manipulations._Sector</span></tt></p>
1077<p>Sector average as a function of phi.
1078I(phi) is return and the data is averaged over Q.</p>
1079<p>A sector is defined by r_min, r_max, phi_min, phi_max.
1080The number of bin in phi also has to be defined.</p>
1081</dd></dl>
1082
1083<dl class="class">
1084<dt id="sas.dataloader.manipulations.SectorQ">
1085<em class="property">class </em><tt class="descclassname">sas.dataloader.manipulations.</tt><tt class="descname">SectorQ</tt><big>(</big><em>r_min</em>, <em>r_max</em>, <em>phi_min=0</em>, <em>phi_max=6.283185307179586</em>, <em>nbins=20</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/manipulations.html#SectorQ"><span class="viewcode-link">[source]</span></a></dt>
1086<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sas.dataloader.manipulations._Sector</span></tt></p>
1087<p>Sector average as a function of Q for both symatric wings.
1088I(Q) is return and the data is averaged over phi.</p>
1089<p>A sector is defined by r_min, r_max, phi_min, phi_max.
1090r_min, r_max, phi_min, phi_max &gt;0.
1091The number of bin in Q also has to be defined.</p>
1092</dd></dl>
1093
1094<dl class="class">
1095<dt id="sas.dataloader.manipulations.Sectorcut">
1096<em class="property">class </em><tt class="descclassname">sas.dataloader.manipulations.</tt><tt class="descname">Sectorcut</tt><big>(</big><em>phi_min=0</em>, <em>phi_max=3.141592653589793</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/manipulations.html#Sectorcut"><span class="viewcode-link">[source]</span></a></dt>
1097<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
1098<p>Defines a sector (major + minor) region on a 2D data set.
1099The sector is defined by phi_min, phi_max,
1100where phi_min and phi_max are defined by the right
1101and left lines wrt central line.</p>
1102<p>Phi_min and phi_max are given in units of radian
1103and (phi_max-phi_min) should not be larger than pi</p>
1104</dd></dl>
1105
1106<dl class="class">
1107<dt id="sas.dataloader.manipulations.SlabX">
1108<em class="property">class </em><tt class="descclassname">sas.dataloader.manipulations.</tt><tt class="descname">SlabX</tt><big>(</big><em>x_min=0.0</em>, <em>x_max=0.0</em>, <em>y_min=0.0</em>, <em>y_max=0.0</em>, <em>bin_width=0.001</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/manipulations.html#SlabX"><span class="viewcode-link">[source]</span></a></dt>
1109<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sas.dataloader.manipulations._Slab</span></tt></p>
1110<p>Compute average I(Qx) for a region of interest</p>
1111</dd></dl>
1112
1113<dl class="class">
1114<dt id="sas.dataloader.manipulations.SlabY">
1115<em class="property">class </em><tt class="descclassname">sas.dataloader.manipulations.</tt><tt class="descname">SlabY</tt><big>(</big><em>x_min=0.0</em>, <em>x_max=0.0</em>, <em>y_min=0.0</em>, <em>y_max=0.0</em>, <em>bin_width=0.001</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/manipulations.html#SlabY"><span class="viewcode-link">[source]</span></a></dt>
1116<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sas.dataloader.manipulations._Slab</span></tt></p>
1117<p>Compute average I(Qy) for a region of interest</p>
1118</dd></dl>
1119
1120<dl class="function">
1121<dt id="sas.dataloader.manipulations.flip_phi">
1122<tt class="descclassname">sas.dataloader.manipulations.</tt><tt class="descname">flip_phi</tt><big>(</big><em>phi</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/manipulations.html#flip_phi"><span class="viewcode-link">[source]</span></a></dt>
1123<dd><p>Correct phi to within the 0 &lt;= to &lt;= 2pi range</p>
1124<table class="docutils field-list" frame="void" rules="none">
1125<col class="field-name" />
1126<col class="field-body" />
1127<tbody valign="top">
1128<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">phi in &gt;=0 and &lt;=2Pi</td>
1129</tr>
1130</tbody>
1131</table>
1132</dd></dl>
1133
1134<dl class="function">
1135<dt id="sas.dataloader.manipulations.get_intercept">
1136<tt class="descclassname">sas.dataloader.manipulations.</tt><tt class="descname">get_intercept</tt><big>(</big><em>q</em>, <em>q_0</em>, <em>q_1</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/manipulations.html#get_intercept"><span class="viewcode-link">[source]</span></a></dt>
1137<dd><p>Returns the fraction of the side at which the
1138q-value intercept the pixel, None otherwise.
1139The values returned is the fraction ON THE SIDE
1140OF THE LOWEST Q.</p>
1141<div class="highlight-python"><div class="highlight"><pre>    A           B
1142+-----------+--------+    &lt;--- pixel size
11430                    1
1144Q_0 -------- Q ----- Q_1   &lt;--- equivalent Q range
1145if Q_1 &gt; Q_0, A is returned
1146if Q_1 &lt; Q_0, B is returned
1147if Q is outside the range of [Q_0, Q_1], None is returned
1148</pre></div>
1149</div>
1150</dd></dl>
1151
1152<dl class="function">
1153<dt id="sas.dataloader.manipulations.get_pixel_fraction">
1154<tt class="descclassname">sas.dataloader.manipulations.</tt><tt class="descname">get_pixel_fraction</tt><big>(</big><em>qmax</em>, <em>q_00</em>, <em>q_01</em>, <em>q_10</em>, <em>q_11</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/manipulations.html#get_pixel_fraction"><span class="viewcode-link">[source]</span></a></dt>
1155<dd><p>Returns the fraction of the pixel defined by
1156the four corners (q_00, q_01, q_10, q_11) that
1157has q &lt; qmax.:</p>
1158<div class="highlight-python"><div class="highlight"><pre>        q_01                q_11
1159y=1         +--------------+
1160            |              |
1161            |              |
1162            |              |
1163y=0         +--------------+
1164        q_00                q_10
1165
1166            x=0            x=1
1167</pre></div>
1168</div>
1169</dd></dl>
1170
1171<dl class="function">
1172<dt id="sas.dataloader.manipulations.get_pixel_fraction_square">
1173<tt class="descclassname">sas.dataloader.manipulations.</tt><tt class="descname">get_pixel_fraction_square</tt><big>(</big><em>x</em>, <em>xmin</em>, <em>xmax</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/manipulations.html#get_pixel_fraction_square"><span class="viewcode-link">[source]</span></a></dt>
1174<dd><p>Return the fraction of the length
1175from xmin to x.:</p>
1176<div class="highlight-python"><div class="highlight"><pre>    A            B
1177+-----------+---------+
1178xmin        x         xmax
1179</pre></div>
1180</div>
1181<table class="docutils field-list" frame="void" rules="none">
1182<col class="field-name" />
1183<col class="field-body" />
1184<tbody valign="top">
1185<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
1186<li><strong>x</strong> &#8211; x-value</li>
1187<li><strong>xmin</strong> &#8211; minimum x for the length considered</li>
1188<li><strong>xmax</strong> &#8211; minimum x for the length considered</li>
1189</ul>
1190</td>
1191</tr>
1192<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">(x-xmin)/(xmax-xmin) when xmin &lt; x &lt; xmax</p>
1193</td>
1194</tr>
1195</tbody>
1196</table>
1197</dd></dl>
1198
1199<dl class="function">
1200<dt id="sas.dataloader.manipulations.get_q">
1201<tt class="descclassname">sas.dataloader.manipulations.</tt><tt class="descname">get_q</tt><big>(</big><em>dx</em>, <em>dy</em>, <em>det_dist</em>, <em>wavelength</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/manipulations.html#get_q"><span class="viewcode-link">[source]</span></a></dt>
1202<dd><table class="docutils field-list" frame="void" rules="none">
1203<col class="field-name" />
1204<col class="field-body" />
1205<tbody valign="top">
1206<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
1207<li><strong>dx</strong> &#8211; x-distance from beam center [mm]</li>
1208<li><strong>dy</strong> &#8211; y-distance from beam center [mm]</li>
1209</ul>
1210</td>
1211</tr>
1212<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">q-value at the given position</p>
1213</td>
1214</tr>
1215</tbody>
1216</table>
1217</dd></dl>
1218
1219<dl class="function">
1220<dt id="sas.dataloader.manipulations.get_q_compo">
1221<tt class="descclassname">sas.dataloader.manipulations.</tt><tt class="descname">get_q_compo</tt><big>(</big><em>dx</em>, <em>dy</em>, <em>det_dist</em>, <em>wavelength</em>, <em>compo=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/manipulations.html#get_q_compo"><span class="viewcode-link">[source]</span></a></dt>
1222<dd><p>This reduces tiny error at very large q.
1223Implementation of this func is not started yet.&lt;&#8211;ToDo</p>
1224</dd></dl>
1225
1226<dl class="function">
1227<dt id="sas.dataloader.manipulations.reader2D_converter">
1228<tt class="descclassname">sas.dataloader.manipulations.</tt><tt class="descname">reader2D_converter</tt><big>(</big><em>data2d=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/dataloader/manipulations.html#reader2D_converter"><span class="viewcode-link">[source]</span></a></dt>
1229<dd><p>convert old 2d format opened by IhorReader or danse_reader
1230to new Data2D format</p>
1231<table class="docutils field-list" frame="void" rules="none">
1232<col class="field-name" />
1233<col class="field-body" />
1234<tbody valign="top">
1235<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data2d</strong> &#8211; 2d array of Data2D object</td>
1236</tr>
1237<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">1d arrays of Data2D object</td>
1238</tr>
1239</tbody>
1240</table>
1241</dd></dl>
1242
1243</div>
1244<div class="section" id="module-sas.dataloader">
1245<span id="module-contents"></span><h2>Module contents</h2>
1246</div>
1247</div>
1248
1249
1250          </div>
1251        </div>
1252      </div>
1253      <div class="sphinxsidebar">
1254        <div class="sphinxsidebarwrapper">
1255  <h3><a href="../../index.html">Table Of Contents</a></h3>
1256  <ul>
1257<li><a class="reference internal" href="#">sas.dataloader package</a><ul>
1258<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
1259<li><a class="reference internal" href="#submodules">Submodules</a></li>
1260<li><a class="reference internal" href="#module-sas.dataloader.data_info">sas.dataloader.data_info module</a></li>
1261<li><a class="reference internal" href="#module-sas.dataloader.loader">sas.dataloader.loader module</a></li>
1262<li><a class="reference internal" href="#module-sas.dataloader.manipulations">sas.dataloader.manipulations module</a></li>
1263<li><a class="reference internal" href="#module-sas.dataloader">Module contents</a></li>
1264</ul>
1265</li>
1266</ul>
1267
1268  <h4>Previous topic</h4>
1269  <p class="topless"><a href="sas.data_util.html"
1270                        title="previous chapter">sas.data_util package</a></p>
1271  <h4>Next topic</h4>
1272  <p class="topless"><a href="sas.dataloader.readers.html"
1273                        title="next chapter">sas.dataloader.readers package</a></p>
1274  <h3>This Page</h3>
1275  <ul class="this-page-menu">
1276    <li><a href="../../_sources/dev/api/sas.dataloader.txt"
1277           rel="nofollow">Show Source</a></li>
1278  </ul>
1279<div id="searchbox" style="display: none">
1280  <h3>Quick search</h3>
1281    <form class="search" action="../../search.html" method="get">
1282      <input type="text" name="q" />
1283      <input type="submit" value="Go" />
1284      <input type="hidden" name="check_keywords" value="yes" />
1285      <input type="hidden" name="area" value="default" />
1286    </form>
1287    <p class="searchtip" style="font-size: 90%">
1288    Enter search terms or a module, class or function name.
1289    </p>
1290</div>
1291<script type="text/javascript">$('#searchbox').show(0);</script>
1292        </div>
1293      </div>
1294      <div class="clearer"></div>
1295    </div>
1296    <div class="related">
1297      <h3>Navigation</h3>
1298      <ul>
1299        <li class="right" style="margin-right: 10px">
1300          <a href="../../genindex.html" title="General Index"
1301             >index</a></li>
1302        <li class="right" >
1303          <a href="../../py-modindex.html" title="Python Module Index"
1304             >modules</a> |</li>
1305        <li class="right" >
1306          <a href="sas.dataloader.readers.html" title="sas.dataloader.readers package"
1307             >next</a> |</li>
1308        <li class="right" >
1309          <a href="sas.data_util.html" title="sas.data_util package"
1310             >previous</a> |</li>
1311        <li><a href="../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
1312          <li><a href="../dev.html" >Developer Documentation</a> &raquo;</li>
1313          <li><a href="modules.html" >lib.macosx-10.5-x86_64-2.7</a> &raquo;</li>
1314          <li><a href="sas.html" >sas package</a> &raquo;</li> 
1315      </ul>
1316    </div>
1317    <div class="footer">
1318        &copy; Copyright 2013, The SasView Project.
1319      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
1320    </div>
1321  </body>
1322</html>
Note: See TracBrowser for help on using the repository browser.