source: sasview/DataLoader/docs/sphinx/_build/html/api/data_info.html @ 7e4a6ff

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 7e4a6ff was 0997158f, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on documentation
  • Property mode set to 100644
File size: 16.2 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>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="manipulations" href="manipulations.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="manipulations.html" title="manipulations"
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"><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>Class to hold collimation information</dd></dl>
74
75<dl class="class">
76<dt id="DataLoader.data_info.Data1D">
77<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>
78<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>
79<p>1D data class</p>
80<dl class="method">
81<dt id="DataLoader.data_info.Data1D.clone_without_data">
82<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>
83<dd><p>Clone the current object, without copying the data (which
84will be filled out by a subsequent operation).
85The data arrays will be initialized to zero.</p>
86<table class="docutils field-list" frame="void" rules="none">
87<col class="field-name" />
88<col class="field-body" />
89<tbody valign="top">
90<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
91<li><strong>length</strong> &#8211; length of the data array to be initialized</li>
92<li><strong>clone</strong> &#8211; if provided, the data will be copied to clone</li>
93</ul>
94</td>
95</tr>
96</tbody>
97</table>
98</dd></dl>
99
100<dl class="method">
101<dt id="DataLoader.data_info.Data1D.is_slit_smeared">
102<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>
103<dd><p>Check whether the data has slit smearing information</p>
104<table class="docutils field-list" frame="void" rules="none">
105<col class="field-name" />
106<col class="field-body" />
107<tbody valign="top">
108<tr class="field"><th class="field-name">Returns:</th><td class="field-body">True is slit smearing info is present, False otherwise</td>
109</tr>
110</tbody>
111</table>
112</dd></dl>
113
114<dl class="method">
115<dt id="DataLoader.data_info.Data1D.xaxis">
116<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>
117<dd></dd></dl>
118
119<dl class="method">
120<dt id="DataLoader.data_info.Data1D.yaxis">
121<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>
122<dd></dd></dl>
123
124</dd></dl>
125
126<dl class="class">
127<dt id="DataLoader.data_info.Data2D">
128<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>
129<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>
130<p>2D data class</p>
131<dl class="method">
132<dt id="DataLoader.data_info.Data2D.clone_without_data">
133<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>
134<dd><p>Clone the current object, without copying the data (which
135will be filled out by a subsequent operation).
136The data arrays will be initialized to zero.</p>
137<table class="docutils field-list" frame="void" rules="none">
138<col class="field-name" />
139<col class="field-body" />
140<tbody valign="top">
141<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
142<li><strong>length</strong> &#8211; length of the data array to be initialized</li>
143<li><strong>clone</strong> &#8211; if provided, the data will be copied to clone</li>
144</ul>
145</td>
146</tr>
147</tbody>
148</table>
149</dd></dl>
150
151<dl class="method">
152<dt id="DataLoader.data_info.Data2D.xaxis">
153<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>
154<dd></dd></dl>
155
156<dl class="method">
157<dt id="DataLoader.data_info.Data2D.yaxis">
158<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>
159<dd></dd></dl>
160
161<dl class="method">
162<dt id="DataLoader.data_info.Data2D.zaxis">
163<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>
164<dd></dd></dl>
165
166</dd></dl>
167
168<dl class="class">
169<dt id="DataLoader.data_info.DataInfo">
170<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>
171<dd>Class to hold the data read from a file.
172It includes four blocks of data for the
173instrument description, the sample description,
174the data itself and any other meta data.</dd></dl>
175
176<dl class="class">
177<dt id="DataLoader.data_info.Detector">
178<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>
179<dd>Class to hold detector information</dd></dl>
180
181<dl class="class">
182<dt id="DataLoader.data_info.Process">
183<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>
184<dd>Class that holds information about the processes
185performed on the data.</dd></dl>
186
187<dl class="class">
188<dt id="DataLoader.data_info.Sample">
189<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>
190<dd>Class to hold the sample description</dd></dl>
191
192<dl class="class">
193<dt id="DataLoader.data_info.Source">
194<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>
195<dd>Class to hold source information</dd></dl>
196
197<dl class="class">
198<dt id="DataLoader.data_info.Vector">
199<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>
200<dd>Vector class to hold multi-dimensional objects</dd></dl>
201
202<dl class="class">
203<dt id="DataLoader.data_info.plottable_1D">
204<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>
205<dd><p>Data1D is a place holder for 1D plottables.</p>
206<dl class="method">
207<dt id="DataLoader.data_info.plottable_1D.xaxis">
208<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>
209<dd></dd></dl>
210
211<dl class="method">
212<dt id="DataLoader.data_info.plottable_1D.yaxis">
213<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>
214<dd></dd></dl>
215
216</dd></dl>
217
218<dl class="class">
219<dt id="DataLoader.data_info.plottable_2D">
220<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>
221<dd><p>Data2D is a place holder for 2D plottables.</p>
222<dl class="method">
223<dt id="DataLoader.data_info.plottable_2D.xaxis">
224<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>
225<dd></dd></dl>
226
227<dl class="method">
228<dt id="DataLoader.data_info.plottable_2D.yaxis">
229<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>
230<dd></dd></dl>
231
232<dl class="method">
233<dt id="DataLoader.data_info.plottable_2D.zaxis">
234<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>
235<dd></dd></dl>
236
237</dd></dl>
238
239</div>
240</div>
241
242
243          </div>
244        </div>
245      </div>
246      <div class="sphinxsidebar">
247        <div class="sphinxsidebarwrapper">
248  <h3><a href="../index.html">Table Of Contents</a></h3>
249  <ul>
250<li><a class="reference internal" href="#">data_info</a><ul>
251<li><a class="reference internal" href="#module-DataLoader.data_info"><tt class="docutils literal"><span class="pre">DataLoader.data_info</span></tt></a></li>
252</ul>
253</li>
254</ul>
255
256  <h4>Previous topic</h4>
257  <p class="topless"><a href="index.html"
258                        title="previous chapter">Reference</a></p>
259  <h4>Next topic</h4>
260  <p class="topless"><a href="manipulations.html"
261                        title="next chapter">manipulations</a></p>
262  <h3>This Page</h3>
263  <ul class="this-page-menu">
264    <li><a href="../_sources/api/data_info.txt"
265           rel="nofollow">Show Source</a></li>
266  </ul>
267<div id="searchbox" style="display: none">
268  <h3>Quick search</h3>
269    <form class="search" action="../search.html" method="get">
270      <input type="text" name="q" size="18" />
271      <input type="submit" value="Go" />
272      <input type="hidden" name="check_keywords" value="yes" />
273      <input type="hidden" name="area" value="default" />
274    </form>
275    <p class="searchtip" style="font-size: 90%">
276    Enter search terms or a module, class or function name.
277    </p>
278</div>
279<script type="text/javascript">$('#searchbox').show(0);</script>
280        </div>
281      </div>
282      <div class="clearer"></div>
283    </div>
284    <div class="related">
285      <h3>Navigation</h3>
286      <ul>
287        <li class="right" style="margin-right: 10px">
288          <a href="../genindex.html" title="General Index"
289             >index</a></li>
290        <li class="right" >
291          <a href="../py-modindex.html" title="Python Module Index"
292             >modules</a> |</li>
293        <li class="right" >
294          <a href="manipulations.html" title="manipulations"
295             >next</a> |</li>
296        <li class="right" >
297          <a href="index.html" title="Reference"
298             >previous</a> |</li>
299        <li><a href="../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li>
300          <li><a href="index.html" >Reference</a> &raquo;</li> 
301      </ul>
302    </div>
303    <div class="footer">
304        &copy; Copyright 2010, sans group.
305      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
306    </div>
307  </body>
308</html>
Note: See TracBrowser for help on using the repository browser.