source: sasview/guiframe/docs/sphinx/_build/html/api/data_loader.html @ 7e4a6ff

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

working on documentation
  • Property mode set to 100644
File size: 9.1 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>data_loader &mdash; guiframe 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="guiframe v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="next" title="dataFitting" href="dataFitting.html" />
28    <link rel="prev" title="config" href="config.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="dataFitting.html" title="dataFitting"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="config.html" title="config"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../index.html">guiframe v0.1.0 documentation</a> &raquo;</li>
47          <li><a href="index.html" accesskey="U">Reference</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="data-loader">
57<h1>data_loader<a class="headerlink" href="#data-loader" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.guiframe.data_loader">
59<span id="sans-guiframe-data-loader"></span><h2><a class="reference internal" href="#module-sans.guiframe.data_loader"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.data_loader</span></tt></a><a class="headerlink" href="#module-sans.guiframe.data_loader" title="Permalink to this headline">¶</a></h2>
60<dl class="function">
61<dt id="sans.guiframe.data_loader.choose_data_file">
62<tt class="descclassname">sans.guiframe.data_loader.</tt><tt class="descname">choose_data_file</tt><big>(</big><em>parent</em>, <em>location=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.data_loader.choose_data_file" title="Permalink to this definition">¶</a></dt>
63<dd></dd></dl>
64
65<dl class="function">
66<dt id="sans.guiframe.data_loader.enable_add_data">
67<tt class="descclassname">sans.guiframe.data_loader.</tt><tt class="descname">enable_add_data</tt><big>(</big><em>existing_panel</em>, <em>new_plot</em><big>)</big><a class="headerlink" href="#sans.guiframe.data_loader.enable_add_data" title="Permalink to this definition">¶</a></dt>
68<dd>Enable append data on a plot panel</dd></dl>
69
70<dl class="function">
71<dt id="sans.guiframe.data_loader.load_ascii_1D">
72<tt class="descclassname">sans.guiframe.data_loader.</tt><tt class="descname">load_ascii_1D</tt><big>(</big><em>path</em><big>)</big><a class="headerlink" href="#sans.guiframe.data_loader.load_ascii_1D" title="Permalink to this definition">¶</a></dt>
73<dd>Load a 1D ascii file, with errors</dd></dl>
74
75<dl class="function">
76<dt id="sans.guiframe.data_loader.load_error">
77<tt class="descclassname">sans.guiframe.data_loader.</tt><tt class="descname">load_error</tt><big>(</big><em>error=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.data_loader.load_error" title="Permalink to this definition">¶</a></dt>
78<dd><p>Pop up an error message.</p>
79<table class="docutils field-list" frame="void" rules="none">
80<col class="field-name" />
81<col class="field-body" />
82<tbody valign="top">
83<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
84<li><strong>error</strong> &#8211; details error message to be displayed</li>
85</ul>
86</td>
87</tr>
88</tbody>
89</table>
90</dd></dl>
91
92<dl class="function">
93<dt id="sans.guiframe.data_loader.on_load_error">
94<tt class="descclassname">sans.guiframe.data_loader.</tt><tt class="descname">on_load_error</tt><big>(</big><em>parent</em><big>)</big><a class="headerlink" href="#sans.guiframe.data_loader.on_load_error" title="Permalink to this definition">¶</a></dt>
95<dd></dd></dl>
96
97<dl class="function">
98<dt id="sans.guiframe.data_loader.open_dialog_append_data">
99<tt class="descclassname">sans.guiframe.data_loader.</tt><tt class="descname">open_dialog_append_data</tt><big>(</big><em>panel_name</em>, <em>data_name</em><big>)</big><a class="headerlink" href="#sans.guiframe.data_loader.open_dialog_append_data" title="Permalink to this definition">¶</a></dt>
100<dd><p>Pop up an error message.</p>
101<table class="docutils field-list" frame="void" rules="none">
102<col class="field-name" />
103<col class="field-body" />
104<tbody valign="top">
105<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
106<li><strong>panel_name</strong> &#8211; the name of the current panel</li>
107<li><strong>data_name</strong> &#8211; the name of the current data</li>
108</ul>
109</td>
110</tr>
111</tbody>
112</table>
113</dd></dl>
114
115<dl class="function">
116<dt id="sans.guiframe.data_loader.parse_name">
117<tt class="descclassname">sans.guiframe.data_loader.</tt><tt class="descname">parse_name</tt><big>(</big><em>name</em>, <em>expression</em><big>)</big><a class="headerlink" href="#sans.guiframe.data_loader.parse_name" title="Permalink to this definition">¶</a></dt>
118<dd>remove &#8220;_&#8221; in front of a name</dd></dl>
119
120<dl class="function">
121<dt id="sans.guiframe.data_loader.plot_data">
122<tt class="descclassname">sans.guiframe.data_loader.</tt><tt class="descname">plot_data</tt><big>(</big><em>parent</em>, <em>path</em><big>)</big><a class="headerlink" href="#sans.guiframe.data_loader.plot_data" title="Permalink to this definition">¶</a></dt>
123<dd><p>Use the DataLoader loader to created data to plot.</p>
124<table class="docutils field-list" frame="void" rules="none">
125<col class="field-name" />
126<col class="field-body" />
127<tbody valign="top">
128<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
129<li><strong>path</strong> &#8211; the path of the data to load</li>
130</ul>
131</td>
132</tr>
133</tbody>
134</table>
135</dd></dl>
136
137</div>
138</div>
139
140
141          </div>
142        </div>
143      </div>
144      <div class="sphinxsidebar">
145        <div class="sphinxsidebarwrapper">
146  <h3><a href="../index.html">Table Of Contents</a></h3>
147  <ul>
148<li><a class="reference internal" href="#">data_loader</a><ul>
149<li><a class="reference internal" href="#module-sans.guiframe.data_loader"><tt class="docutils literal"><span class="pre">sans.guiframe.data_loader</span></tt></a></li>
150</ul>
151</li>
152</ul>
153
154  <h4>Previous topic</h4>
155  <p class="topless"><a href="config.html"
156                        title="previous chapter">config</a></p>
157  <h4>Next topic</h4>
158  <p class="topless"><a href="dataFitting.html"
159                        title="next chapter">dataFitting</a></p>
160  <h3>This Page</h3>
161  <ul class="this-page-menu">
162    <li><a href="../_sources/api/data_loader.txt"
163           rel="nofollow">Show Source</a></li>
164  </ul>
165<div id="searchbox" style="display: none">
166  <h3>Quick search</h3>
167    <form class="search" action="../search.html" method="get">
168      <input type="text" name="q" size="18" />
169      <input type="submit" value="Go" />
170      <input type="hidden" name="check_keywords" value="yes" />
171      <input type="hidden" name="area" value="default" />
172    </form>
173    <p class="searchtip" style="font-size: 90%">
174    Enter search terms or a module, class or function name.
175    </p>
176</div>
177<script type="text/javascript">$('#searchbox').show(0);</script>
178        </div>
179      </div>
180      <div class="clearer"></div>
181    </div>
182    <div class="related">
183      <h3>Navigation</h3>
184      <ul>
185        <li class="right" style="margin-right: 10px">
186          <a href="../genindex.html" title="General Index"
187             >index</a></li>
188        <li class="right" >
189          <a href="../py-modindex.html" title="Python Module Index"
190             >modules</a> |</li>
191        <li class="right" >
192          <a href="dataFitting.html" title="dataFitting"
193             >next</a> |</li>
194        <li class="right" >
195          <a href="config.html" title="config"
196             >previous</a> |</li>
197        <li><a href="../index.html">guiframe v0.1.0 documentation</a> &raquo;</li>
198          <li><a href="index.html" >Reference</a> &raquo;</li> 
199      </ul>
200    </div>
201    <div class="footer">
202        &copy; Copyright 2010, sans group.
203      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
204    </div>
205  </body>
206</html>
Note: See TracBrowser for help on using the repository browser.