source: sasview/sansdataloader/docs/sphinx/html/api/readers/abs_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: 7.8 KB
RevLine 
[16771b0]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
[7247844]6
[16771b0]7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
[7247844]11    <title>abs_reader &mdash; DataLoader 0.1.0 documentation</title>
12   
[16771b0]13    <link rel="stylesheet" href="../../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
[7247844]15   
[16771b0]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>
[7247844]28    <link rel="top" title="DataLoader 0.1.0 documentation" href="../../index.html" />
[16771b0]29    <link rel="up" title="Readers" href="index.html" />
30    <link rel="next" title="ascii_reader" href="ascii_reader.html" />
31    <link rel="prev" title="Readers" href="index.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="ascii_reader.html" title="ascii_reader"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="index.html" title="Readers"
48             accesskey="P">previous</a> |</li>
[7247844]49        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li>
[16771b0]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="abs-reader">
60<h1>abs_reader<a class="headerlink" href="#abs-reader" title="Permalink to this headline">¶</a></h1>
[7247844]61<div class="section" id="sans-dataloader-readers-abs-reader">
62<h2><a class="reference internal" href="#module-sans.dataloader.readers.abs_reader" title="sans.dataloader.readers.abs_reader"><tt class="xref py py-mod docutils literal"><span class="pre">sans.dataloader.readers.abs_reader</span></tt></a><a class="headerlink" href="#sans-dataloader-readers-abs-reader" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.dataloader.readers.abs_reader"></span><dl class="class">
64<dt id="sans.dataloader.readers.abs_reader.Reader">
65<em class="property">class </em><tt class="descclassname">sans.dataloader.readers.abs_reader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#sans.dataloader.readers.abs_reader.Reader" title="Permalink to this definition">¶</a></dt>
[16771b0]66<dd><p>Class to load IGOR reduced .ABS files</p>
[7247844]67<dl class="attribute">
68<dt id="sans.dataloader.readers.abs_reader.Reader.__module__">
69<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.readers.abs_reader'</em><a class="headerlink" href="#sans.dataloader.readers.abs_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.abs_reader.Reader.ext">
74<tt class="descname">ext</tt><em class="property"> = ['.abs', '.ABS']</em><a class="headerlink" href="#sans.dataloader.readers.abs_reader.Reader.ext" title="Permalink to this definition">¶</a></dt>
75<dd></dd></dl>
76
[16771b0]77<dl class="method">
[7247844]78<dt id="sans.dataloader.readers.abs_reader.Reader.read">
79<tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.abs_reader.Reader.read" title="Permalink to this definition">¶</a></dt>
[16771b0]80<dd><p>Load data file.</p>
81<table class="docutils field-list" frame="void" rules="none">
82<col class="field-name" />
83<col class="field-body" />
84<tbody valign="top">
[7247844]85<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>
[16771b0]86</td>
87</tr>
[7247844]88<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Data1D object, or None</p>
[16771b0]89</td>
90</tr>
[7247844]91<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
[16771b0]92<li><strong>RuntimeError</strong> &#8211; when the file can&#8217;t be opened</li>
93<li><strong>ValueError</strong> &#8211; when the length of the data vectors are inconsistent</li>
94</ul>
95</td>
96</tr>
97</tbody>
98</table>
99</dd></dl>
100
[7247844]101<dl class="attribute">
102<dt id="sans.dataloader.readers.abs_reader.Reader.type">
103<tt class="descname">type</tt><em class="property"> = ['IGOR 1D files (*.abs)|*.abs']</em><a class="headerlink" href="#sans.dataloader.readers.abs_reader.Reader.type" title="Permalink to this definition">¶</a></dt>
104<dd></dd></dl>
105
106<dl class="attribute">
107<dt id="sans.dataloader.readers.abs_reader.Reader.type_name">
108<tt class="descname">type_name</tt><em class="property"> = 'IGOR 1D'</em><a class="headerlink" href="#sans.dataloader.readers.abs_reader.Reader.type_name" title="Permalink to this definition">¶</a></dt>
109<dd></dd></dl>
110
[16771b0]111</dd></dl>
112
113</div>
114</div>
115
116
117          </div>
118        </div>
119      </div>
120      <div class="sphinxsidebar">
121        <div class="sphinxsidebarwrapper">
122  <h3><a href="../../index.html">Table Of Contents</a></h3>
123  <ul>
124<li><a class="reference internal" href="#">abs_reader</a><ul>
[7247844]125<li><a class="reference internal" href="#sans-dataloader-readers-abs-reader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.abs_reader</span></tt></a></li>
[16771b0]126</ul>
127</li>
128</ul>
129
130  <h4>Previous topic</h4>
131  <p class="topless"><a href="index.html"
132                        title="previous chapter">Readers</a></p>
133  <h4>Next topic</h4>
134  <p class="topless"><a href="ascii_reader.html"
135                        title="next chapter">ascii_reader</a></p>
136  <h3>This Page</h3>
137  <ul class="this-page-menu">
138    <li><a href="../../_sources/api/readers/abs_reader.txt"
139           rel="nofollow">Show Source</a></li>
140  </ul>
141<div id="searchbox" style="display: none">
142  <h3>Quick search</h3>
143    <form class="search" action="../../search.html" method="get">
[7247844]144      <input type="text" name="q" />
[16771b0]145      <input type="submit" value="Go" />
146      <input type="hidden" name="check_keywords" value="yes" />
147      <input type="hidden" name="area" value="default" />
148    </form>
149    <p class="searchtip" style="font-size: 90%">
150    Enter search terms or a module, class or function name.
151    </p>
152</div>
153<script type="text/javascript">$('#searchbox').show(0);</script>
154        </div>
155      </div>
156      <div class="clearer"></div>
157    </div>
158    <div class="related">
159      <h3>Navigation</h3>
160      <ul>
161        <li class="right" style="margin-right: 10px">
162          <a href="../../genindex.html" title="General Index"
163             >index</a></li>
164        <li class="right" >
165          <a href="../../py-modindex.html" title="Python Module Index"
166             >modules</a> |</li>
167        <li class="right" >
168          <a href="ascii_reader.html" title="ascii_reader"
169             >next</a> |</li>
170        <li class="right" >
171          <a href="index.html" title="Readers"
172             >previous</a> |</li>
[7247844]173        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li>
[16771b0]174          <li><a href="index.html" >Readers</a> &raquo;</li> 
175      </ul>
176    </div>
177    <div class="footer">
178        &copy; Copyright 2010, sans group.
[7247844]179      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
[16771b0]180    </div>
181  </body>
182</html>
Note: See TracBrowser for help on using the repository browser.