source: sasview/sansdataloader/docs/sphinx/html/api/readers/ascii_reader.html @ bce8148

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

updates docs
  • Property mode set to 100644
File size: 8.3 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>ascii_reader &mdash; DataLoader 0.1.0 documentation</title>
12   
13    <link rel="stylesheet" href="../../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '../../',
19        VERSION:     '0.1.0',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="../../_static/jquery.js"></script>
26    <script type="text/javascript" src="../../_static/underscore.js"></script>
27    <script type="text/javascript" src="../../_static/doctools.js"></script>
28    <link rel="top" title="DataLoader 0.1.0 documentation" href="../../index.html" />
29    <link rel="up" title="Readers" href="index.html" />
30    <link rel="next" title="associations" href="associations.html" />
31    <link rel="prev" title="abs_reader" href="abs_reader.html" /> 
32  </head>
33  <body>
34    <div class="related">
35      <h3>Navigation</h3>
36      <ul>
37        <li class="right" style="margin-right: 10px">
38          <a href="../../genindex.html" title="General Index"
39             accesskey="I">index</a></li>
40        <li class="right" >
41          <a href="../../py-modindex.html" title="Python Module Index"
42             >modules</a> |</li>
43        <li class="right" >
44          <a href="associations.html" title="associations"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="abs_reader.html" title="abs_reader"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li>
50          <li><a href="index.html" accesskey="U">Readers</a> &raquo;</li> 
51      </ul>
52    </div> 
53
54    <div class="document">
55      <div class="documentwrapper">
56        <div class="bodywrapper">
57          <div class="body">
58           
59  <div class="section" id="ascii-reader">
60<h1>ascii_reader<a class="headerlink" href="#ascii-reader" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-dataloader-readers-ascii-reader">
62<h2><a class="reference internal" href="#module-sans.dataloader.readers.ascii_reader" title="sans.dataloader.readers.ascii_reader"><tt class="xref py py-mod docutils literal"><span class="pre">sans.dataloader.readers.ascii_reader</span></tt></a><a class="headerlink" href="#sans-dataloader-readers-ascii-reader" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.dataloader.readers.ascii_reader"></span><dl class="class">
64<dt id="sans.dataloader.readers.ascii_reader.Reader">
65<em class="property">class </em><tt class="descclassname">sans.dataloader.readers.ascii_reader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#sans.dataloader.readers.ascii_reader.Reader" title="Permalink to this definition">¶</a></dt>
66<dd><p>Class to load ascii files (2, 3 or 4 columns).</p>
67<dl class="attribute">
68<dt id="sans.dataloader.readers.ascii_reader.Reader.__module__">
69<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.readers.ascii_reader'</em><a class="headerlink" href="#sans.dataloader.readers.ascii_reader.Reader.__module__" title="Permalink to this definition">¶</a></dt>
70<dd></dd></dl>
71
72<dl class="attribute">
73<dt id="sans.dataloader.readers.ascii_reader.Reader.allow_all">
74<tt class="descname">allow_all</tt><em class="property"> = True</em><a class="headerlink" href="#sans.dataloader.readers.ascii_reader.Reader.allow_all" title="Permalink to this definition">¶</a></dt>
75<dd></dd></dl>
76
77<dl class="attribute">
78<dt id="sans.dataloader.readers.ascii_reader.Reader.ext">
79<tt class="descname">ext</tt><em class="property"> = ['.txt', '.TXT', '.dat', '.DAT', '.abs', '.ABS', 'csv', 'CSV']</em><a class="headerlink" href="#sans.dataloader.readers.ascii_reader.Reader.ext" title="Permalink to this definition">¶</a></dt>
80<dd></dd></dl>
81
82<dl class="method">
83<dt id="sans.dataloader.readers.ascii_reader.Reader.read">
84<tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.ascii_reader.Reader.read" title="Permalink to this definition">¶</a></dt>
85<dd><p>Load data file</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-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>path</strong> &#8211; file path</p>
91</td>
92</tr>
93<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Data1D object, or None</p>
94</td>
95</tr>
96<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
97<li><strong>RuntimeError</strong> &#8211; when the file can&#8217;t be opened</li>
98<li><strong>ValueError</strong> &#8211; when the length of the data vectors are inconsistent</li>
99</ul>
100</td>
101</tr>
102</tbody>
103</table>
104</dd></dl>
105
106<dl class="attribute">
107<dt id="sans.dataloader.readers.ascii_reader.Reader.type">
108<tt class="descname">type</tt><em class="property"> = ['ASCII files (*.txt)|*.txt', 'ASCII files (*.dat)|*.dat', 'ASCII files (*.abs)|*.abs', 'CSV files (*.csv)|*.csv']</em><a class="headerlink" href="#sans.dataloader.readers.ascii_reader.Reader.type" title="Permalink to this definition">¶</a></dt>
109<dd></dd></dl>
110
111<dl class="attribute">
112<dt id="sans.dataloader.readers.ascii_reader.Reader.type_name">
113<tt class="descname">type_name</tt><em class="property"> = 'ASCII'</em><a class="headerlink" href="#sans.dataloader.readers.ascii_reader.Reader.type_name" title="Permalink to this definition">¶</a></dt>
114<dd></dd></dl>
115
116</dd></dl>
117
118</div>
119</div>
120
121
122          </div>
123        </div>
124      </div>
125      <div class="sphinxsidebar">
126        <div class="sphinxsidebarwrapper">
127  <h3><a href="../../index.html">Table Of Contents</a></h3>
128  <ul>
129<li><a class="reference internal" href="#">ascii_reader</a><ul>
130<li><a class="reference internal" href="#sans-dataloader-readers-ascii-reader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.ascii_reader</span></tt></a></li>
131</ul>
132</li>
133</ul>
134
135  <h4>Previous topic</h4>
136  <p class="topless"><a href="abs_reader.html"
137                        title="previous chapter">abs_reader</a></p>
138  <h4>Next topic</h4>
139  <p class="topless"><a href="associations.html"
140                        title="next chapter">associations</a></p>
141  <h3>This Page</h3>
142  <ul class="this-page-menu">
143    <li><a href="../../_sources/api/readers/ascii_reader.txt"
144           rel="nofollow">Show Source</a></li>
145  </ul>
146<div id="searchbox" style="display: none">
147  <h3>Quick search</h3>
148    <form class="search" action="../../search.html" method="get">
149      <input type="text" name="q" />
150      <input type="submit" value="Go" />
151      <input type="hidden" name="check_keywords" value="yes" />
152      <input type="hidden" name="area" value="default" />
153    </form>
154    <p class="searchtip" style="font-size: 90%">
155    Enter search terms or a module, class or function name.
156    </p>
157</div>
158<script type="text/javascript">$('#searchbox').show(0);</script>
159        </div>
160      </div>
161      <div class="clearer"></div>
162    </div>
163    <div class="related">
164      <h3>Navigation</h3>
165      <ul>
166        <li class="right" style="margin-right: 10px">
167          <a href="../../genindex.html" title="General Index"
168             >index</a></li>
169        <li class="right" >
170          <a href="../../py-modindex.html" title="Python Module Index"
171             >modules</a> |</li>
172        <li class="right" >
173          <a href="associations.html" title="associations"
174             >next</a> |</li>
175        <li class="right" >
176          <a href="abs_reader.html" title="abs_reader"
177             >previous</a> |</li>
178        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li>
179          <li><a href="index.html" >Readers</a> &raquo;</li> 
180      </ul>
181    </div>
182    <div class="footer">
183        &copy; Copyright 2010, sans group.
184      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
185    </div>
186  </body>
187</html>
Note: See TracBrowser for help on using the repository browser.