source: sasview/sansdataloader/docs/sphinx/html/api/data_info.html @ fe10df5

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 fe10df5 was fc5d49e3, checked in by Jessica Tumarkin <jtumarki@…>, 13 years ago
  • Property mode set to 100644
File size: 18.3 KB
RevLine 
[16771b0]1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>data_info &mdash; DataLoader v0.1.0 documentation</title>
11    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13    <script type="text/javascript">
14      var DOCUMENTATION_OPTIONS = {
15        URL_ROOT:    '../',
16        VERSION:     '0.1.0',
17        COLLAPSE_INDEX: false,
18        FILE_SUFFIX: '.html',
19        HAS_SOURCE:  true
20      };
21    </script>
22    <script type="text/javascript" src="../_static/jquery.js"></script>
23    <script type="text/javascript" src="../_static/underscore.js"></script>
24    <script type="text/javascript" src="../_static/doctools.js"></script>
25    <link rel="top" title="DataLoader v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="next" title="loader" href="loader.html" />
28    <link rel="prev" title="Reference" href="index.html" /> 
29  </head>
30  <body>
31    <div class="related">
32      <h3>Navigation</h3>
33      <ul>
34        <li class="right" style="margin-right: 10px">
35          <a href="../genindex.html" title="General Index"
36             accesskey="I">index</a></li>
37        <li class="right" >
38          <a href="../py-modindex.html" title="Python Module Index"
39             >modules</a> |</li>
40        <li class="right" >
41          <a href="loader.html" title="loader"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="index.html" title="Reference"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li>
47          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
48      </ul>
49    </div> 
50
51    <div class="document">
52      <div class="documentwrapper">
53        <div class="bodywrapper">
54          <div class="body">
55           
56  <div class="section" id="data-info">
57<h1>data_info<a class="headerlink" href="#data-info" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-DataLoader.data_info">
59<span id="dataloader-data-info"></span><h2><a class="reference internal" href="#module-DataLoader.data_info" title="DataLoader.data_info"><tt class="xref py py-mod docutils literal"><span class="pre">DataLoader.data_info</span></tt></a><a class="headerlink" href="#module-DataLoader.data_info" title="Permalink to this headline">¶</a></h2>
60<p>Module that contains classes to hold information read from
61reduced data files.</p>
62<p>A good description of the data members can be found in
63the CanSAS 1D XML data format:</p>
64<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>
65<dl class="class">
66<dt id="DataLoader.data_info.Aperture">
67<em class="property">class </em><tt class="descclassname">DataLoader.data_info.</tt><tt class="descname">Aperture</tt><a class="headerlink" href="#DataLoader.data_info.Aperture" title="Permalink to this definition">¶</a></dt>
68<dd></dd></dl>
69
70<dl class="class">
71<dt id="DataLoader.data_info.Collimation">
72<em class="property">class </em><tt class="descclassname">DataLoader.data_info.</tt><tt class="descname">Collimation</tt><a class="headerlink" href="#DataLoader.data_info.Collimation" title="Permalink to this definition">¶</a></dt>
73<dd><p>Class to hold collimation information</p>
74</dd></dl>
75
76<dl class="class">
77<dt id="DataLoader.data_info.Data1D">
78<em class="property">class </em><tt class="descclassname">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="headerlink" href="#DataLoader.data_info.Data1D" title="Permalink to this definition">¶</a></dt>
79<dd><p>Bases: <a class="reference internal" href="#DataLoader.data_info.plottable_1D" title="DataLoader.data_info.plottable_1D"><tt class="xref py py-class docutils literal"><span class="pre">DataLoader.data_info.plottable_1D</span></tt></a>, <a class="reference internal" href="#DataLoader.data_info.DataInfo" title="DataLoader.data_info.DataInfo"><tt class="xref py py-class docutils literal"><span class="pre">DataLoader.data_info.DataInfo</span></tt></a></p>
80<p>1D data class</p>
81<dl class="method">
82<dt id="DataLoader.data_info.Data1D.add_notes">
83<tt class="descname">add_notes</tt><big>(</big><em>message=''</em><big>)</big><a class="headerlink" href="#DataLoader.data_info.Data1D.add_notes" title="Permalink to this definition">¶</a></dt>
84<dd><p>Add notes to datainfo</p>
85</dd></dl>
86
87<dl class="method">
88<dt id="DataLoader.data_info.Data1D.append_empty_process">
89<tt class="descname">append_empty_process</tt><big>(</big><big>)</big><a class="headerlink" href="#DataLoader.data_info.Data1D.append_empty_process" title="Permalink to this definition">¶</a></dt>
90<dd></dd></dl>
91
92<dl class="method">
93<dt id="DataLoader.data_info.Data1D.clone_without_data">
94<tt class="descname">clone_without_data</tt><big>(</big><em>length=0</em>, <em>clone=None</em><big>)</big><a class="headerlink" href="#DataLoader.data_info.Data1D.clone_without_data" title="Permalink to this definition">¶</a></dt>
95<dd><p>Clone the current object, without copying the data (which
96will be filled out by a subsequent operation).
97The data arrays will be initialized to zero.</p>
98<table class="docutils field-list" frame="void" rules="none">
99<col class="field-name" />
100<col class="field-body" />
101<tbody valign="top">
102<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
103<li><strong>length</strong> &#8211; length of the data array to be initialized</li>
104<li><strong>clone</strong> &#8211; if provided, the data will be copied to clone</li>
105</ul>
106</td>
107</tr>
108</tbody>
109</table>
110</dd></dl>
111
112<dl class="method">
113<dt id="DataLoader.data_info.Data1D.is_slit_smeared">
114<tt class="descname">is_slit_smeared</tt><big>(</big><big>)</big><a class="headerlink" href="#DataLoader.data_info.Data1D.is_slit_smeared" title="Permalink to this definition">¶</a></dt>
115<dd><p>Check whether the data has slit smearing information</p>
116<table class="docutils field-list" frame="void" rules="none">
117<col class="field-name" />
118<col class="field-body" />
119<tbody valign="top">
120<tr class="field"><th class="field-name">Returns:</th><td class="field-body">True is slit smearing info is present, False otherwise</td>
121</tr>
122</tbody>
123</table>
124</dd></dl>
125
126<dl class="method">
127<dt id="DataLoader.data_info.Data1D.xaxis">
128<tt class="descname">xaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#DataLoader.data_info.Data1D.xaxis" title="Permalink to this definition">¶</a></dt>
129<dd><p>set the x axis label and unit</p>
130</dd></dl>
131
132<dl class="method">
133<dt id="DataLoader.data_info.Data1D.yaxis">
134<tt class="descname">yaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#DataLoader.data_info.Data1D.yaxis" title="Permalink to this definition">¶</a></dt>
135<dd><p>set the y axis label and unit</p>
136</dd></dl>
137
138</dd></dl>
139
140<dl class="class">
141<dt id="DataLoader.data_info.Data2D">
142<em class="property">class </em><tt class="descclassname">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="headerlink" href="#DataLoader.data_info.Data2D" title="Permalink to this definition">¶</a></dt>
143<dd><p>Bases: <a class="reference internal" href="#DataLoader.data_info.plottable_2D" title="DataLoader.data_info.plottable_2D"><tt class="xref py py-class docutils literal"><span class="pre">DataLoader.data_info.plottable_2D</span></tt></a>, <a class="reference internal" href="#DataLoader.data_info.DataInfo" title="DataLoader.data_info.DataInfo"><tt class="xref py py-class docutils literal"><span class="pre">DataLoader.data_info.DataInfo</span></tt></a></p>
144<p>2D data class</p>
145<dl class="method">
146<dt id="DataLoader.data_info.Data2D.add_notes">
147<tt class="descname">add_notes</tt><big>(</big><em>message=''</em><big>)</big><a class="headerlink" href="#DataLoader.data_info.Data2D.add_notes" title="Permalink to this definition">¶</a></dt>
148<dd><p>Add notes to datainfo</p>
149</dd></dl>
150
151<dl class="method">
152<dt id="DataLoader.data_info.Data2D.append_empty_process">
153<tt class="descname">append_empty_process</tt><big>(</big><big>)</big><a class="headerlink" href="#DataLoader.data_info.Data2D.append_empty_process" title="Permalink to this definition">¶</a></dt>
154<dd></dd></dl>
155
156<dl class="method">
157<dt id="DataLoader.data_info.Data2D.clone_without_data">
158<tt class="descname">clone_without_data</tt><big>(</big><em>length=0</em>, <em>clone=None</em><big>)</big><a class="headerlink" href="#DataLoader.data_info.Data2D.clone_without_data" title="Permalink to this definition">¶</a></dt>
159<dd><p>Clone the current object, without copying the data (which
160will be filled out by a subsequent operation).
161The data arrays will be initialized to zero.</p>
162<table class="docutils field-list" frame="void" rules="none">
163<col class="field-name" />
164<col class="field-body" />
165<tbody valign="top">
166<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
167<li><strong>length</strong> &#8211; length of the data array to be initialized</li>
168<li><strong>clone</strong> &#8211; if provided, the data will be copied to clone</li>
169</ul>
170</td>
171</tr>
172</tbody>
173</table>
174</dd></dl>
175
176<dl class="method">
177<dt id="DataLoader.data_info.Data2D.xaxis">
178<tt class="descname">xaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#DataLoader.data_info.Data2D.xaxis" title="Permalink to this definition">¶</a></dt>
179<dd><p>set the x axis label and unit</p>
180</dd></dl>
181
182<dl class="method">
183<dt id="DataLoader.data_info.Data2D.yaxis">
184<tt class="descname">yaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#DataLoader.data_info.Data2D.yaxis" title="Permalink to this definition">¶</a></dt>
185<dd><p>set the y axis label and unit</p>
186</dd></dl>
187
188<dl class="method">
189<dt id="DataLoader.data_info.Data2D.zaxis">
190<tt class="descname">zaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#DataLoader.data_info.Data2D.zaxis" title="Permalink to this definition">¶</a></dt>
191<dd><p>set the z axis label and unit</p>
192</dd></dl>
193
194</dd></dl>
195
196<dl class="class">
197<dt id="DataLoader.data_info.DataInfo">
198<em class="property">class </em><tt class="descclassname">DataLoader.data_info.</tt><tt class="descname">DataInfo</tt><a class="headerlink" href="#DataLoader.data_info.DataInfo" title="Permalink to this definition">¶</a></dt>
199<dd><p>Class to hold the data read from a file.
200It includes four blocks of data for the
201instrument description, the sample description,
202the data itself and any other meta data.</p>
203<dl class="method">
204<dt id="DataLoader.data_info.DataInfo.add_notes">
205<tt class="descname">add_notes</tt><big>(</big><em>message=''</em><big>)</big><a class="headerlink" href="#DataLoader.data_info.DataInfo.add_notes" title="Permalink to this definition">¶</a></dt>
206<dd><p>Add notes to datainfo</p>
207</dd></dl>
208
209<dl class="method">
210<dt id="DataLoader.data_info.DataInfo.append_empty_process">
211<tt class="descname">append_empty_process</tt><big>(</big><big>)</big><a class="headerlink" href="#DataLoader.data_info.DataInfo.append_empty_process" title="Permalink to this definition">¶</a></dt>
212<dd></dd></dl>
213
214</dd></dl>
215
216<dl class="class">
217<dt id="DataLoader.data_info.Detector">
218<em class="property">class </em><tt class="descclassname">DataLoader.data_info.</tt><tt class="descname">Detector</tt><a class="headerlink" href="#DataLoader.data_info.Detector" title="Permalink to this definition">¶</a></dt>
219<dd><p>Class to hold detector information</p>
220</dd></dl>
221
222<dl class="class">
223<dt id="DataLoader.data_info.Process">
224<em class="property">class </em><tt class="descclassname">DataLoader.data_info.</tt><tt class="descname">Process</tt><a class="headerlink" href="#DataLoader.data_info.Process" title="Permalink to this definition">¶</a></dt>
225<dd><p>Class that holds information about the processes
226performed on the data.</p>
227</dd></dl>
228
229<dl class="class">
230<dt id="DataLoader.data_info.Sample">
231<em class="property">class </em><tt class="descclassname">DataLoader.data_info.</tt><tt class="descname">Sample</tt><a class="headerlink" href="#DataLoader.data_info.Sample" title="Permalink to this definition">¶</a></dt>
232<dd><p>Class to hold the sample description</p>
233</dd></dl>
234
235<dl class="class">
236<dt id="DataLoader.data_info.Source">
237<em class="property">class </em><tt class="descclassname">DataLoader.data_info.</tt><tt class="descname">Source</tt><a class="headerlink" href="#DataLoader.data_info.Source" title="Permalink to this definition">¶</a></dt>
238<dd><p>Class to hold source information</p>
239</dd></dl>
240
241<dl class="class">
242<dt id="DataLoader.data_info.Vector">
243<em class="property">class </em><tt class="descclassname">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="headerlink" href="#DataLoader.data_info.Vector" title="Permalink to this definition">¶</a></dt>
244<dd><p>Vector class to hold multi-dimensional objects</p>
245</dd></dl>
246
247<dl class="class">
248<dt id="DataLoader.data_info.plottable_1D">
249<em class="property">class </em><tt class="descclassname">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="headerlink" href="#DataLoader.data_info.plottable_1D" title="Permalink to this definition">¶</a></dt>
250<dd><p>Data1D is a place holder for 1D plottables.</p>
251<dl class="method">
252<dt id="DataLoader.data_info.plottable_1D.xaxis">
253<tt class="descname">xaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#DataLoader.data_info.plottable_1D.xaxis" title="Permalink to this definition">¶</a></dt>
254<dd><p>set the x axis label and unit</p>
255</dd></dl>
256
257<dl class="method">
258<dt id="DataLoader.data_info.plottable_1D.yaxis">
259<tt class="descname">yaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#DataLoader.data_info.plottable_1D.yaxis" title="Permalink to this definition">¶</a></dt>
260<dd><p>set the y axis label and unit</p>
261</dd></dl>
262
263</dd></dl>
264
265<dl class="class">
266<dt id="DataLoader.data_info.plottable_2D">
267<em class="property">class </em><tt class="descclassname">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="headerlink" href="#DataLoader.data_info.plottable_2D" title="Permalink to this definition">¶</a></dt>
268<dd><p>Data2D is a place holder for 2D plottables.</p>
269<dl class="method">
270<dt id="DataLoader.data_info.plottable_2D.xaxis">
271<tt class="descname">xaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#DataLoader.data_info.plottable_2D.xaxis" title="Permalink to this definition">¶</a></dt>
272<dd><p>set the x axis label and unit</p>
273</dd></dl>
274
275<dl class="method">
276<dt id="DataLoader.data_info.plottable_2D.yaxis">
277<tt class="descname">yaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#DataLoader.data_info.plottable_2D.yaxis" title="Permalink to this definition">¶</a></dt>
278<dd><p>set the y axis label and unit</p>
279</dd></dl>
280
281<dl class="method">
282<dt id="DataLoader.data_info.plottable_2D.zaxis">
283<tt class="descname">zaxis</tt><big>(</big><em>label</em>, <em>unit</em><big>)</big><a class="headerlink" href="#DataLoader.data_info.plottable_2D.zaxis" title="Permalink to this definition">¶</a></dt>
284<dd><p>set the z axis label and unit</p>
285</dd></dl>
286
287</dd></dl>
288
289</div>
290</div>
291
292
293          </div>
294        </div>
295      </div>
296      <div class="sphinxsidebar">
297        <div class="sphinxsidebarwrapper">
298  <h3><a href="../index.html">Table Of Contents</a></h3>
299  <ul>
300<li><a class="reference internal" href="#">data_info</a><ul>
301<li><a class="reference internal" href="#module-DataLoader.data_info"><tt class="docutils literal"><span class="pre">DataLoader.data_info</span></tt></a></li>
302</ul>
303</li>
304</ul>
305
306  <h4>Previous topic</h4>
307  <p class="topless"><a href="index.html"
308                        title="previous chapter">Reference</a></p>
309  <h4>Next topic</h4>
310  <p class="topless"><a href="loader.html"
311                        title="next chapter">loader</a></p>
312  <h3>This Page</h3>
313  <ul class="this-page-menu">
314    <li><a href="../_sources/api/data_info.txt"
315           rel="nofollow">Show Source</a></li>
316  </ul>
317<div id="searchbox" style="display: none">
318  <h3>Quick search</h3>
319    <form class="search" action="../search.html" method="get">
320      <input type="text" name="q" size="18" />
321      <input type="submit" value="Go" />
322      <input type="hidden" name="check_keywords" value="yes" />
323      <input type="hidden" name="area" value="default" />
324    </form>
325    <p class="searchtip" style="font-size: 90%">
326    Enter search terms or a module, class or function name.
327    </p>
328</div>
329<script type="text/javascript">$('#searchbox').show(0);</script>
330        </div>
331      </div>
332      <div class="clearer"></div>
333    </div>
334    <div class="related">
335      <h3>Navigation</h3>
336      <ul>
337        <li class="right" style="margin-right: 10px">
338          <a href="../genindex.html" title="General Index"
339             >index</a></li>
340        <li class="right" >
341          <a href="../py-modindex.html" title="Python Module Index"
342             >modules</a> |</li>
343        <li class="right" >
344          <a href="loader.html" title="loader"
345             >next</a> |</li>
346        <li class="right" >
347          <a href="index.html" title="Reference"
348             >previous</a> |</li>
349        <li><a href="../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li>
350          <li><a href="index.html" >Reference</a> &raquo;</li> 
351      </ul>
352    </div>
353    <div class="footer">
354        &copy; Copyright 2010, sans group.
355      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
356    </div>
357  </body>
358</html>
Note: See TracBrowser for help on using the repository browser.