source: sasview/DataLoader/docs/sphinx/_build/html/api/readers/ascii_reader.html @ a45622a

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

working on documentation
  • Property mode set to 100644
File size: 6.5 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>ascii_reader &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="Readers" href="index.html" />
27    <link rel="next" title="associations" href="associations.html" />
28    <link rel="prev" title="abs_reader" href="abs_reader.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="associations.html" title="associations"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="abs_reader.html" title="abs_reader"
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">Readers</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="ascii-reader">
57<h1>ascii_reader<a class="headerlink" href="#ascii-reader" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-DataLoader.readers.ascii_reader">
59<span id="dataloader-readers-ascii-reader"></span><h2><a class="reference internal" href="#module-DataLoader.readers.ascii_reader"><tt class="xref py py-mod docutils literal"><span class="pre">DataLoader.readers.ascii_reader</span></tt></a><a class="headerlink" href="#module-DataLoader.readers.ascii_reader" title="Permalink to this headline">¶</a></h2>
60<dl class="class">
61<dt id="DataLoader.readers.ascii_reader.Reader">
62<em class="property">class </em><tt class="descclassname">DataLoader.readers.ascii_reader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#DataLoader.readers.ascii_reader.Reader" title="Permalink to this definition">¶</a></dt>
63<dd><p>Class to load ascii files (2, 3 or 4 columns).</p>
64<dl class="method">
65<dt id="DataLoader.readers.ascii_reader.Reader.read">
66<tt class="descname">read</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#DataLoader.readers.ascii_reader.Reader.read" title="Permalink to this definition">¶</a></dt>
67<dd><p>Load data file</p>
68<table class="docutils field-list" frame="void" rules="none">
69<col class="field-name" />
70<col class="field-body" />
71<tbody valign="top">
72<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
73<li><strong>path</strong> &#8211; file path</li>
74</ul>
75</td>
76</tr>
77<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Data1D object, or None</p>
78</td>
79</tr>
80<tr class="field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
81<li><strong>RuntimeError</strong> &#8211; when the file can&#8217;t be opened</li>
82<li><strong>ValueError</strong> &#8211; when the length of the data vectors are inconsistent</li>
83</ul>
84</td>
85</tr>
86</tbody>
87</table>
88</dd></dl>
89
90</dd></dl>
91
92</div>
93</div>
94
95
96          </div>
97        </div>
98      </div>
99      <div class="sphinxsidebar">
100        <div class="sphinxsidebarwrapper">
101  <h3><a href="../../index.html">Table Of Contents</a></h3>
102  <ul>
103<li><a class="reference internal" href="#">ascii_reader</a><ul>
104<li><a class="reference internal" href="#module-DataLoader.readers.ascii_reader"><tt class="docutils literal"><span class="pre">DataLoader.readers.ascii_reader</span></tt></a></li>
105</ul>
106</li>
107</ul>
108
109  <h4>Previous topic</h4>
110  <p class="topless"><a href="abs_reader.html"
111                        title="previous chapter">abs_reader</a></p>
112  <h4>Next topic</h4>
113  <p class="topless"><a href="associations.html"
114                        title="next chapter">associations</a></p>
115  <h3>This Page</h3>
116  <ul class="this-page-menu">
117    <li><a href="../../_sources/api/readers/ascii_reader.txt"
118           rel="nofollow">Show Source</a></li>
119  </ul>
120<div id="searchbox" style="display: none">
121  <h3>Quick search</h3>
122    <form class="search" action="../../search.html" method="get">
123      <input type="text" name="q" size="18" />
124      <input type="submit" value="Go" />
125      <input type="hidden" name="check_keywords" value="yes" />
126      <input type="hidden" name="area" value="default" />
127    </form>
128    <p class="searchtip" style="font-size: 90%">
129    Enter search terms or a module, class or function name.
130    </p>
131</div>
132<script type="text/javascript">$('#searchbox').show(0);</script>
133        </div>
134      </div>
135      <div class="clearer"></div>
136    </div>
137    <div class="related">
138      <h3>Navigation</h3>
139      <ul>
140        <li class="right" style="margin-right: 10px">
141          <a href="../../genindex.html" title="General Index"
142             >index</a></li>
143        <li class="right" >
144          <a href="../../py-modindex.html" title="Python Module Index"
145             >modules</a> |</li>
146        <li class="right" >
147          <a href="associations.html" title="associations"
148             >next</a> |</li>
149        <li class="right" >
150          <a href="abs_reader.html" title="abs_reader"
151             >previous</a> |</li>
152        <li><a href="../../index.html">DataLoader v0.1.0 documentation</a> &raquo;</li>
153          <li><a href="index.html" >Readers</a> &raquo;</li> 
154      </ul>
155    </div>
156    <div class="footer">
157        &copy; Copyright 2010, sans group.
158      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
159    </div>
160  </body>
161</html>
Note: See TracBrowser for help on using the repository browser.