source: sasview/sansdataloader/docs/sphinx/html/api/readers/red2d_reader.html @ 7247844

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

updates docs
  • Property mode set to 100644
File size: 8.2 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>red2d_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="tiff_reader" href="tiff_reader.html" />
31    <link rel="prev" title="IgorReader" href="IgorReader.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="tiff_reader.html" title="tiff_reader"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="IgorReader.html" title="IgorReader"
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="red2d-reader">
60<h1>red2d_reader<a class="headerlink" href="#red2d-reader" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-dataloader-readers-red2d-reader">
62<h2><a class="reference internal" href="#module-sans.dataloader.readers.red2d_reader" title="sans.dataloader.readers.red2d_reader"><tt class="xref py py-mod docutils literal"><span class="pre">sans.dataloader.readers.red2d_reader</span></tt></a><a class="headerlink" href="#sans-dataloader-readers-red2d-reader" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.dataloader.readers.red2d_reader"></span><p>TXT/IGOR 2D Q Map file reader</p>
64<dl class="class">
65<dt id="sans.dataloader.readers.red2d_reader.Reader">
66<em class="property">class </em><tt class="descclassname">sans.dataloader.readers.red2d_reader.</tt><tt class="descname">Reader</tt><a class="headerlink" href="#sans.dataloader.readers.red2d_reader.Reader" title="Permalink to this definition">¶</a></dt>
67<dd><p>Simple data reader for Igor data files</p>
68<dl class="attribute">
69<dt id="sans.dataloader.readers.red2d_reader.Reader.__module__">
70<tt class="descname">__module__</tt><em class="property"> = 'sans.dataloader.readers.red2d_reader'</em><a class="headerlink" href="#sans.dataloader.readers.red2d_reader.Reader.__module__" title="Permalink to this definition">¶</a></dt>
71<dd></dd></dl>
72
73<dl class="attribute">
74<dt id="sans.dataloader.readers.red2d_reader.Reader.ext">
75<tt class="descname">ext</tt><em class="property"> = ['.DAT', '.dat']</em><a class="headerlink" href="#sans.dataloader.readers.red2d_reader.Reader.ext" title="Permalink to this definition">¶</a></dt>
76<dd></dd></dl>
77
78<dl class="method">
79<dt id="sans.dataloader.readers.red2d_reader.Reader.read">
80<tt class="descname">read</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.red2d_reader.Reader.read" title="Permalink to this definition">¶</a></dt>
81<dd><p>Read file</p>
82</dd></dl>
83
84<dl class="attribute">
85<dt id="sans.dataloader.readers.red2d_reader.Reader.type">
86<tt class="descname">type</tt><em class="property"> = ['IGOR/DAT 2D file in Q_map (*.dat)|*.DAT']</em><a class="headerlink" href="#sans.dataloader.readers.red2d_reader.Reader.type" title="Permalink to this definition">¶</a></dt>
87<dd></dd></dl>
88
89<dl class="attribute">
90<dt id="sans.dataloader.readers.red2d_reader.Reader.type_name">
91<tt class="descname">type_name</tt><em class="property"> = 'IGOR/DAT 2D Q_map'</em><a class="headerlink" href="#sans.dataloader.readers.red2d_reader.Reader.type_name" title="Permalink to this definition">¶</a></dt>
92<dd></dd></dl>
93
94<dl class="method">
95<dt id="sans.dataloader.readers.red2d_reader.Reader.write">
96<tt class="descname">write</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.red2d_reader.Reader.write" title="Permalink to this definition">¶</a></dt>
97<dd><p>Write to .dat</p>
98<table class="docutils field-list" frame="void" rules="none">
99<col class="field-name" />
100<col class="field-body" />
101<tbody valign="top">
102<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
103<li><strong>filename</strong> &#8211; file name to write</li>
104<li><strong>data</strong> &#8211; data2D</li>
105</ul>
106</td>
107</tr>
108</tbody>
109</table>
110</dd></dl>
111
112</dd></dl>
113
114<dl class="function">
115<dt id="sans.dataloader.readers.red2d_reader.check_point">
116<tt class="descclassname">sans.dataloader.readers.red2d_reader.</tt><tt class="descname">check_point</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.dataloader.readers.red2d_reader.check_point" title="Permalink to this definition">¶</a></dt>
117<dd><p>check point validity</p>
118</dd></dl>
119
120</div>
121</div>
122
123
124          </div>
125        </div>
126      </div>
127      <div class="sphinxsidebar">
128        <div class="sphinxsidebarwrapper">
129  <h3><a href="../../index.html">Table Of Contents</a></h3>
130  <ul>
131<li><a class="reference internal" href="#">red2d_reader</a><ul>
132<li><a class="reference internal" href="#sans-dataloader-readers-red2d-reader"><tt class="docutils literal"><span class="pre">sans.dataloader.readers.red2d_reader</span></tt></a></li>
133</ul>
134</li>
135</ul>
136
137  <h4>Previous topic</h4>
138  <p class="topless"><a href="IgorReader.html"
139                        title="previous chapter">IgorReader</a></p>
140  <h4>Next topic</h4>
141  <p class="topless"><a href="tiff_reader.html"
142                        title="next chapter">tiff_reader</a></p>
143  <h3>This Page</h3>
144  <ul class="this-page-menu">
145    <li><a href="../../_sources/api/readers/red2d_reader.txt"
146           rel="nofollow">Show Source</a></li>
147  </ul>
148<div id="searchbox" style="display: none">
149  <h3>Quick search</h3>
150    <form class="search" action="../../search.html" method="get">
151      <input type="text" name="q" />
152      <input type="submit" value="Go" />
153      <input type="hidden" name="check_keywords" value="yes" />
154      <input type="hidden" name="area" value="default" />
155    </form>
156    <p class="searchtip" style="font-size: 90%">
157    Enter search terms or a module, class or function name.
158    </p>
159</div>
160<script type="text/javascript">$('#searchbox').show(0);</script>
161        </div>
162      </div>
163      <div class="clearer"></div>
164    </div>
165    <div class="related">
166      <h3>Navigation</h3>
167      <ul>
168        <li class="right" style="margin-right: 10px">
169          <a href="../../genindex.html" title="General Index"
170             >index</a></li>
171        <li class="right" >
172          <a href="../../py-modindex.html" title="Python Module Index"
173             >modules</a> |</li>
174        <li class="right" >
175          <a href="tiff_reader.html" title="tiff_reader"
176             >next</a> |</li>
177        <li class="right" >
178          <a href="IgorReader.html" title="IgorReader"
179             >previous</a> |</li>
180        <li><a href="../../index.html">DataLoader 0.1.0 documentation</a> &raquo;</li>
181          <li><a href="index.html" >Readers</a> &raquo;</li> 
182      </ul>
183    </div>
184    <div class="footer">
185        &copy; Copyright 2010, sans group.
186      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
187    </div>
188  </body>
189</html>
Note: See TracBrowser for help on using the repository browser.