source: sasview/DataLoader/docs/sphinx/_build/html/api/readers/hfir1d_reader.html @ 6c79243

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

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