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>hfir1d_reader — 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="IgorReader" href="IgorReader.html" /> |
---|
31 | <link rel="prev" title="danse_reader" href="danse_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="IgorReader.html" title="IgorReader" |
---|
45 | accesskey="N">next</a> |</li> |
---|
46 | <li class="right" > |
---|
47 | <a href="danse_reader.html" title="danse_reader" |
---|
48 | accesskey="P">previous</a> |</li> |
---|
49 | <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> »</li> |
---|
50 | <li><a href="index.html" accesskey="U">Readers</a> »</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="hfir1d-reader"> |
---|
60 | <h1>hfir1d_reader<a class="headerlink" href="#hfir1d-reader" title="Permalink to this headline">¶</a></h1> |
---|
61 | <div class="section" id="sans-dataloader-readers-hfir1d-reader"> |
---|
62 | <h2><a class="reference internal" href="#module-sans.dataloader.readers.hfir1d_reader" title="sans.dataloader.readers.hfir1d_reader"><tt class="xref py py-mod docutils literal"><span class="pre">sans.dataloader.readers.hfir1d_reader</span></tt></a><a class="headerlink" href="#sans-dataloader-readers-hfir1d-reader" title="Permalink to this headline">¶</a></h2> |
---|
63 | <span class="target" id="module-sans.dataloader.readers.hfir1d_reader"></span><dl class="class"> |
---|
64 | <dt id="sans.dataloader.readers.hfir1d_reader.Reader"> |
---|
65 | <em class="property">class </em><tt class="descclassname">sans.dataloader.readers.hfir1d_reader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader" title="Permalink to this definition">¶</a></dt> |
---|
66 | <dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p> |
---|
67 | <p>Class to load HFIR 1D 4-column files</p> |
---|
68 | <dl class="attribute"> |
---|
69 | <dt id="sans.dataloader.readers.hfir1d_reader.Reader.__class__"> |
---|
70 | <tt class="descname">__class__</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__class__" title="Permalink to this definition">¶</a></dt> |
---|
71 | <dd><p>alias of <a class="reference internal" href="#sans.dataloader.readers.hfir1d_reader.Reader.type" title="sans.dataloader.readers.hfir1d_reader.Reader.type"><tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></a></p> |
---|
72 | </dd></dl> |
---|
73 | |
---|
74 | <dl class="attribute"> |
---|
75 | <dt id="sans.dataloader.readers.hfir1d_reader.Reader.__delattr__"> |
---|
76 | <tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__delattr__" title="Permalink to this definition">¶</a></dt> |
---|
77 | <dd><p>x.__delattr__(‘name’) <==> del x.name</p> |
---|
78 | </dd></dl> |
---|
79 | |
---|
80 | <dl class="attribute"> |
---|
81 | <dt id="sans.dataloader.readers.hfir1d_reader.Reader.__dict__"> |
---|
82 | <tt class="descname">__dict__</tt><em class="property"> = <dictproxy object at 0x0284D830></em><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__dict__" title="Permalink to this definition">¶</a></dt> |
---|
83 | <dd></dd></dl> |
---|
84 | |
---|
85 | <dl class="attribute"> |
---|
86 | <dt id="sans.dataloader.readers.hfir1d_reader.Reader.__getattribute__"> |
---|
87 | <tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__getattribute__" title="Permalink to this definition">¶</a></dt> |
---|
88 | <dd><p>x.__getattribute__(‘name’) <==> x.name</p> |
---|
89 | </dd></dl> |
---|
90 | |
---|
91 | <dl class="attribute"> |
---|
92 | <dt id="sans.dataloader.readers.hfir1d_reader.Reader.__hash__"> |
---|
93 | <tt class="descname">__hash__</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__hash__" title="Permalink to this definition">¶</a></dt> |
---|
94 | <dd><p>x.__hash__() <==> hash(x)</p> |
---|
95 | </dd></dl> |
---|
96 | |
---|
97 | <dl class="attribute"> |
---|
98 | <dt id="sans.dataloader.readers.hfir1d_reader.Reader.__init__"> |
---|
99 | <tt class="descname">__init__</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__init__" title="Permalink to this definition">¶</a></dt> |
---|
100 | <dd><p>x.__init__(...) initializes x; see x.__class__.__doc__ for signature</p> |
---|
101 | </dd></dl> |
---|
102 | |
---|
103 | <dl class="attribute"> |
---|
104 | <dt id="sans.dataloader.readers.hfir1d_reader.Reader.__module__"> |
---|
105 | <tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.readers.hfir1d_reader'</em><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__module__" title="Permalink to this definition">¶</a></dt> |
---|
106 | <dd></dd></dl> |
---|
107 | |
---|
108 | <dl class="staticmethod"> |
---|
109 | <dt id="sans.dataloader.readers.hfir1d_reader.Reader.__new__"> |
---|
110 | <em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> → a new object with type S, a subtype of T<a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__new__" title="Permalink to this definition">¶</a></dt> |
---|
111 | <dd></dd></dl> |
---|
112 | |
---|
113 | <dl class="method"> |
---|
114 | <dt id="sans.dataloader.readers.hfir1d_reader.Reader.__reduce__"> |
---|
115 | <tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__reduce__" title="Permalink to this definition">¶</a></dt> |
---|
116 | <dd><p>helper for pickle</p> |
---|
117 | </dd></dl> |
---|
118 | |
---|
119 | <dl class="method"> |
---|
120 | <dt id="sans.dataloader.readers.hfir1d_reader.Reader.__reduce_ex__"> |
---|
121 | <tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__reduce_ex__" title="Permalink to this definition">¶</a></dt> |
---|
122 | <dd><p>helper for pickle</p> |
---|
123 | </dd></dl> |
---|
124 | |
---|
125 | <dl class="attribute"> |
---|
126 | <dt id="sans.dataloader.readers.hfir1d_reader.Reader.__repr__"> |
---|
127 | <tt class="descname">__repr__</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__repr__" title="Permalink to this definition">¶</a></dt> |
---|
128 | <dd><p>x.__repr__() <==> repr(x)</p> |
---|
129 | </dd></dl> |
---|
130 | |
---|
131 | <dl class="attribute"> |
---|
132 | <dt id="sans.dataloader.readers.hfir1d_reader.Reader.__setattr__"> |
---|
133 | <tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__setattr__" title="Permalink to this definition">¶</a></dt> |
---|
134 | <dd><p>x.__setattr__(‘name’, value) <==> x.name = value</p> |
---|
135 | </dd></dl> |
---|
136 | |
---|
137 | <dl class="attribute"> |
---|
138 | <dt id="sans.dataloader.readers.hfir1d_reader.Reader.__str__"> |
---|
139 | <tt class="descname">__str__</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__str__" title="Permalink to this definition">¶</a></dt> |
---|
140 | <dd><p>x.__str__() <==> str(x)</p> |
---|
141 | </dd></dl> |
---|
142 | |
---|
143 | <dl class="attribute"> |
---|
144 | <dt id="sans.dataloader.readers.hfir1d_reader.Reader.__weakref__"> |
---|
145 | <tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.__weakref__" title="Permalink to this definition">¶</a></dt> |
---|
146 | <dd><p>list of weak references to the object (if defined)</p> |
---|
147 | </dd></dl> |
---|
148 | |
---|
149 | <dl class="attribute"> |
---|
150 | <dt id="sans.dataloader.readers.hfir1d_reader.Reader.ext"> |
---|
151 | <tt class="descname">ext</tt><em class="property"> = ['.d1d']</em><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.ext" title="Permalink to this definition">¶</a></dt> |
---|
152 | <dd></dd></dl> |
---|
153 | |
---|
154 | <dl class="method"> |
---|
155 | <dt id="sans.dataloader.readers.hfir1d_reader.Reader.read"> |
---|
156 | <tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.read" title="Permalink to this definition">¶</a></dt> |
---|
157 | <dd><p>Load data file</p> |
---|
158 | <table class="docutils field-list" frame="void" rules="none"> |
---|
159 | <col class="field-name" /> |
---|
160 | <col class="field-body" /> |
---|
161 | <tbody valign="top"> |
---|
162 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>path</strong> – file path</p> |
---|
163 | </td> |
---|
164 | </tr> |
---|
165 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Data1D object, or None</p> |
---|
166 | </td> |
---|
167 | </tr> |
---|
168 | <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple"> |
---|
169 | <li><strong>RuntimeError</strong> – when the file can’t be opened</li> |
---|
170 | <li><strong>ValueError</strong> – when the length of the data vectors are inconsistent</li> |
---|
171 | </ul> |
---|
172 | </td> |
---|
173 | </tr> |
---|
174 | </tbody> |
---|
175 | </table> |
---|
176 | </dd></dl> |
---|
177 | |
---|
178 | <dl class="attribute"> |
---|
179 | <dt id="sans.dataloader.readers.hfir1d_reader.Reader.type"> |
---|
180 | <tt class="descname">type</tt><em class="property"> = ['HFIR 1D files (*.d1d)|*.d1d']</em><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.type" title="Permalink to this definition">¶</a></dt> |
---|
181 | <dd></dd></dl> |
---|
182 | |
---|
183 | <dl class="attribute"> |
---|
184 | <dt id="sans.dataloader.readers.hfir1d_reader.Reader.type_name"> |
---|
185 | <tt class="descname">type_name</tt><em class="property"> = 'HFIR 1D'</em><a class="headerlink" href="#sans.dataloader.readers.hfir1d_reader.Reader.type_name" title="Permalink to this definition">¶</a></dt> |
---|
186 | <dd></dd></dl> |
---|
187 | |
---|
188 | </dd></dl> |
---|
189 | |
---|
190 | </div> |
---|
191 | </div> |
---|
192 | |
---|
193 | |
---|
194 | </div> |
---|
195 | </div> |
---|
196 | </div> |
---|
197 | <div class="sphinxsidebar"> |
---|
198 | <div class="sphinxsidebarwrapper"> |
---|
199 | <h3><a href="../../index.html">Table Of Contents</a></h3> |
---|
200 | <ul> |
---|
201 | <li><a class="reference internal" href="#">hfir1d_reader</a><ul> |
---|
202 | <li><a class="reference internal" href="#sans-dataloader-readers-hfir1d-reader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.hfir1d_reader</span></tt></a></li> |
---|
203 | </ul> |
---|
204 | </li> |
---|
205 | </ul> |
---|
206 | |
---|
207 | <h4>Previous topic</h4> |
---|
208 | <p class="topless"><a href="danse_reader.html" |
---|
209 | title="previous chapter">danse_reader</a></p> |
---|
210 | <h4>Next topic</h4> |
---|
211 | <p class="topless"><a href="IgorReader.html" |
---|
212 | title="next chapter">IgorReader</a></p> |
---|
213 | <h3>This Page</h3> |
---|
214 | <ul class="this-page-menu"> |
---|
215 | <li><a href="../../_sources/api/readers/hfir1d_reader.txt" |
---|
216 | rel="nofollow">Show Source</a></li> |
---|
217 | </ul> |
---|
218 | <div id="searchbox" style="display: none"> |
---|
219 | <h3>Quick search</h3> |
---|
220 | <form class="search" action="../../search.html" method="get"> |
---|
221 | <input type="text" name="q" /> |
---|
222 | <input type="submit" value="Go" /> |
---|
223 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
224 | <input type="hidden" name="area" value="default" /> |
---|
225 | </form> |
---|
226 | <p class="searchtip" style="font-size: 90%"> |
---|
227 | Enter search terms or a module, class or function name. |
---|
228 | </p> |
---|
229 | </div> |
---|
230 | <script type="text/javascript">$('#searchbox').show(0);</script> |
---|
231 | </div> |
---|
232 | </div> |
---|
233 | <div class="clearer"></div> |
---|
234 | </div> |
---|
235 | <div class="related"> |
---|
236 | <h3>Navigation</h3> |
---|
237 | <ul> |
---|
238 | <li class="right" style="margin-right: 10px"> |
---|
239 | <a href="../../genindex.html" title="General Index" |
---|
240 | >index</a></li> |
---|
241 | <li class="right" > |
---|
242 | <a href="../../py-modindex.html" title="Python Module Index" |
---|
243 | >modules</a> |</li> |
---|
244 | <li class="right" > |
---|
245 | <a href="IgorReader.html" title="IgorReader" |
---|
246 | >next</a> |</li> |
---|
247 | <li class="right" > |
---|
248 | <a href="danse_reader.html" title="danse_reader" |
---|
249 | >previous</a> |</li> |
---|
250 | <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> »</li> |
---|
251 | <li><a href="index.html" >Readers</a> »</li> |
---|
252 | </ul> |
---|
253 | </div> |
---|
254 | <div class="footer"> |
---|
255 | © Copyright 2010, sans group. |
---|
256 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. |
---|
257 | </div> |
---|
258 | </body> |
---|
259 | </html> |
---|