source: sasview/dev/api/sas.guiframe.local_perspectives.data_loader.html @ a462c6a

gh-pages
Last change on this file since a462c6a was a462c6a, checked in by ajj, 9 years ago

Rebuild to fix index and modules docs
  • Property mode set to 100644
File size: 16.7 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6  <head>
7    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8   
9    <title>sas.guiframe.local_perspectives.data_loader package &mdash; SasView 3.0.0 documentation</title>
10   
11    <link rel="stylesheet" href="../../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
13   
14    <script type="text/javascript">
15      var DOCUMENTATION_OPTIONS = {
16        URL_ROOT:    '../../',
17        VERSION:     '3.0.0',
18        COLLAPSE_INDEX: false,
19        FILE_SUFFIX: '.html',
20        HAS_SOURCE:  true
21      };
22    </script>
23    <script type="text/javascript" src="../../_static/jquery.js"></script>
24    <script type="text/javascript" src="../../_static/underscore.js"></script>
25    <script type="text/javascript" src="../../_static/doctools.js"></script>
26    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
27    <link rel="top" title="SasView 3.0.0 documentation" href="../../index.html" />
28    <link rel="up" title="sas.guiframe.local_perspectives package" href="sas.guiframe.local_perspectives.html" />
29    <link rel="next" title="sas.guiframe.local_perspectives.plotting package" href="sas.guiframe.local_perspectives.plotting.html" />
30    <link rel="prev" title="sas.guiframe.local_perspectives package" href="sas.guiframe.local_perspectives.html" /> 
31  </head>
32  <body>
33    <div class="related">
34      <h3>Navigation</h3>
35      <ul>
36        <li class="right" style="margin-right: 10px">
37          <a href="../../genindex.html" title="General Index"
38             accesskey="I">index</a></li>
39        <li class="right" >
40          <a href="../../py-modindex.html" title="Python Module Index"
41             >modules</a> |</li>
42        <li class="right" >
43          <a href="sas.guiframe.local_perspectives.plotting.html" title="sas.guiframe.local_perspectives.plotting package"
44             accesskey="N">next</a> |</li>
45        <li class="right" >
46          <a href="sas.guiframe.local_perspectives.html" title="sas.guiframe.local_perspectives package"
47             accesskey="P">previous</a> |</li>
48        <li><a href="../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
49          <li><a href="../dev.html" >Developer Documentation</a> &raquo;</li>
50          <li><a href="modules.html" >lib.macosx-10.5-x86_64-2.7</a> &raquo;</li>
51          <li><a href="sas.html" >sas package</a> &raquo;</li>
52          <li><a href="sas.guiframe.html" >sas.guiframe package</a> &raquo;</li>
53          <li><a href="sas.guiframe.local_perspectives.html" accesskey="U">sas.guiframe.local_perspectives package</a> &raquo;</li> 
54      </ul>
55    </div> 
56
57    <div class="document">
58      <div class="documentwrapper">
59        <div class="bodywrapper">
60          <div class="body">
61           
62  <div class="section" id="sas-guiframe-local-perspectives-data-loader-package">
63<h1>sas.guiframe.local_perspectives.data_loader package</h1>
64<div class="section" id="submodules">
65<h2>Submodules</h2>
66</div>
67<div class="section" id="module-sas.guiframe.local_perspectives.data_loader.data_loader">
68<span id="sas-guiframe-local-perspectives-data-loader-data-loader-module"></span><h2>sas.guiframe.local_perspectives.data_loader.data_loader module</h2>
69<p>plugin DataLoader responsible of loading data</p>
70<dl class="class">
71<dt id="sas.guiframe.local_perspectives.data_loader.data_loader.Plugin">
72<em class="property">class </em><tt class="descclassname">sas.guiframe.local_perspectives.data_loader.data_loader.</tt><tt class="descname">Plugin</tt><big>(</big><em>standalone=False</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/local_perspectives/data_loader/data_loader.html#Plugin"><span class="viewcode-link">[source]</span></a></dt>
73<dd><p>Bases: <a class="reference internal" href="sas.guiframe.html#sas.guiframe.plugin_base.PluginBase" title="sas.guiframe.plugin_base.PluginBase"><tt class="xref py py-class docutils literal"><span class="pre">sas.guiframe.plugin_base.PluginBase</span></tt></a></p>
74<dl class="method">
75<dt id="sas.guiframe.local_perspectives.data_loader.data_loader.Plugin.can_load_data">
76<tt class="descname">can_load_data</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/local_perspectives/data_loader/data_loader.html#Plugin.can_load_data"><span class="viewcode-link">[source]</span></a></dt>
77<dd><p>if return True, then call handler to laod data</p>
78</dd></dl>
79
80<dl class="method">
81<dt id="sas.guiframe.local_perspectives.data_loader.data_loader.Plugin.get_data">
82<tt class="descname">get_data</tt><big>(</big><em>path</em>, <em>format=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/local_perspectives/data_loader/data_loader.html#Plugin.get_data"><span class="viewcode-link">[source]</span></a></dt>
83<dd></dd></dl>
84
85<dl class="method">
86<dt id="sas.guiframe.local_perspectives.data_loader.data_loader.Plugin.get_file_path">
87<tt class="descname">get_file_path</tt><big>(</big><em>path</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/local_perspectives/data_loader/data_loader.html#Plugin.get_file_path"><span class="viewcode-link">[source]</span></a></dt>
88<dd><p>Receive a list containing folder then return a list of file</p>
89</dd></dl>
90
91<dl class="method">
92<dt id="sas.guiframe.local_perspectives.data_loader.data_loader.Plugin.help">
93<tt class="descname">help</tt><big>(</big><em>evt</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/local_perspectives/data_loader/data_loader.html#Plugin.help"><span class="viewcode-link">[source]</span></a></dt>
94<dd><p>Show a general help dialog.</p>
95</dd></dl>
96
97<dl class="method">
98<dt id="sas.guiframe.local_perspectives.data_loader.data_loader.Plugin.load_complete">
99<tt class="descname">load_complete</tt><big>(</big><em>output</em>, <em>message=''</em>, <em>error_message=''</em>, <em>path=None</em>, <em>info='warning'</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/local_perspectives/data_loader/data_loader.html#Plugin.load_complete"><span class="viewcode-link">[source]</span></a></dt>
100<dd><p>post message to  status bar and return list of data</p>
101</dd></dl>
102
103<dl class="method">
104<dt id="sas.guiframe.local_perspectives.data_loader.data_loader.Plugin.load_data">
105<tt class="descname">load_data</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/local_perspectives/data_loader/data_loader.html#Plugin.load_data"><span class="viewcode-link">[source]</span></a></dt>
106<dd><p>Load data</p>
107</dd></dl>
108
109<dl class="method">
110<dt id="sas.guiframe.local_perspectives.data_loader.data_loader.Plugin.load_error">
111<tt class="descname">load_error</tt><big>(</big><em>error=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/local_perspectives/data_loader/data_loader.html#Plugin.load_error"><span class="viewcode-link">[source]</span></a></dt>
112<dd><p>Pop up an error message.</p>
113<table class="docutils field-list" frame="void" rules="none">
114<col class="field-name" />
115<col class="field-body" />
116<tbody valign="top">
117<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>error</strong> &#8211; details error message to be displayed</td>
118</tr>
119</tbody>
120</table>
121</dd></dl>
122
123<dl class="method">
124<dt id="sas.guiframe.local_perspectives.data_loader.data_loader.Plugin.load_update">
125<tt class="descname">load_update</tt><big>(</big><em>output=None</em>, <em>message=''</em>, <em>info='warning'</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/local_perspectives/data_loader/data_loader.html#Plugin.load_update"><span class="viewcode-link">[source]</span></a></dt>
126<dd><p>print update on the status bar</p>
127</dd></dl>
128
129<dl class="method">
130<dt id="sas.guiframe.local_perspectives.data_loader.data_loader.Plugin.populate_file_menu">
131<tt class="descname">populate_file_menu</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/local_perspectives/data_loader/data_loader.html#Plugin.populate_file_menu"><span class="viewcode-link">[source]</span></a></dt>
132<dd><p>get a menu item and append it under file menu of the application
133add load file menu item and load folder item</p>
134</dd></dl>
135
136</dd></dl>
137
138</div>
139<div class="section" id="module-sas.guiframe.local_perspectives.data_loader.help_panel">
140<span id="sas-guiframe-local-perspectives-data-loader-help-panel-module"></span><h2>sas.guiframe.local_perspectives.data_loader.help_panel module</h2>
141<p>Help panel for data_loader plugins</p>
142<dl class="class">
143<dt id="sas.guiframe.local_perspectives.data_loader.help_panel.HelpWindow">
144<em class="property">class </em><tt class="descclassname">sas.guiframe.local_perspectives.data_loader.help_panel.</tt><tt class="descname">HelpWindow</tt><big>(</big><em>parent</em>, <em>title='DataLoader Help'</em>, <em>pageToOpen=None</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/local_perspectives/data_loader/help_panel.html#HelpWindow"><span class="viewcode-link">[source]</span></a></dt>
145<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._windows.Frame</span></tt></p>
146<dl class="method">
147<dt id="sas.guiframe.local_perspectives.data_loader.help_panel.HelpWindow.OnLinkClicked">
148<tt class="descname">OnLinkClicked</tt><big>(</big><em>event</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/local_perspectives/data_loader/help_panel.html#HelpWindow.OnLinkClicked"><span class="viewcode-link">[source]</span></a></dt>
149<dd><p>Function to diplay html page related to the hyperlinktext selected</p>
150</dd></dl>
151
152</dd></dl>
153
154<dl class="class">
155<dt id="sas.guiframe.local_perspectives.data_loader.help_panel.ViewApp">
156<em class="property">class </em><tt class="descclassname">sas.guiframe.local_perspectives.data_loader.help_panel.</tt><tt class="descname">ViewApp</tt><big>(</big><em>redirect=False</em>, <em>filename=None</em>, <em>useBestVisual=False</em>, <em>clearSigInt=True</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/local_perspectives/data_loader/help_panel.html#ViewApp"><span class="viewcode-link">[source]</span></a></dt>
157<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">wx._core.App</span></tt></p>
158<dl class="method">
159<dt id="sas.guiframe.local_perspectives.data_loader.help_panel.ViewApp.OnInit">
160<tt class="descname">OnInit</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/local_perspectives/data_loader/help_panel.html#ViewApp.OnInit"><span class="viewcode-link">[source]</span></a></dt>
161<dd></dd></dl>
162
163</dd></dl>
164
165</div>
166<div class="section" id="module-sas.guiframe.local_perspectives.data_loader.load_thread">
167<span id="sas-guiframe-local-perspectives-data-loader-load-thread-module"></span><h2>sas.guiframe.local_perspectives.data_loader.load_thread module</h2>
168<dl class="class">
169<dt id="sas.guiframe.local_perspectives.data_loader.load_thread.DataReader">
170<em class="property">class </em><tt class="descclassname">sas.guiframe.local_perspectives.data_loader.load_thread.</tt><tt class="descname">DataReader</tt><big>(</big><em>path</em>, <em>loader</em>, <em>flag=True</em>, <em>transform_data=None</em>, <em>completefn=None</em>, <em>updatefn=None</em>, <em>yieldtime=0.01</em>, <em>worktime=0.01</em><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/local_perspectives/data_loader/load_thread.html#DataReader"><span class="viewcode-link">[source]</span></a></dt>
171<dd><p>Bases: <a class="reference internal" href="sas.data_util.html#sas.data_util.calcthread.CalcThread" title="sas.data_util.calcthread.CalcThread"><tt class="xref py py-class docutils literal"><span class="pre">sas.data_util.calcthread.CalcThread</span></tt></a></p>
172<p>Load a data given a filename</p>
173<dl class="method">
174<dt id="sas.guiframe.local_perspectives.data_loader.load_thread.DataReader.compute">
175<tt class="descname">compute</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/local_perspectives/data_loader/load_thread.html#DataReader.compute"><span class="viewcode-link">[source]</span></a></dt>
176<dd><p>read some data</p>
177</dd></dl>
178
179<dl class="method">
180<dt id="sas.guiframe.local_perspectives.data_loader.load_thread.DataReader.isquit">
181<tt class="descname">isquit</tt><big>(</big><big>)</big><a class="reference internal" href="../../_modules/sas/guiframe/local_perspectives/data_loader/load_thread.html#DataReader.isquit"><span class="viewcode-link">[source]</span></a></dt>
182<dd><table class="docutils field-list" frame="void" rules="none">
183<col class="field-name" />
184<col class="field-body" />
185<tbody valign="top">
186<tr class="field-odd field"><th class="field-name" colspan="2">Raises KeyboardInterrupt:</th></tr>
187<tr class="field-odd field"><td>&nbsp;</td><td class="field-body">when the thread is interrupted</td>
188</tr>
189</tbody>
190</table>
191</dd></dl>
192
193</dd></dl>
194
195</div>
196<div class="section" id="module-sas.guiframe.local_perspectives.data_loader">
197<span id="module-contents"></span><h2>Module contents</h2>
198</div>
199</div>
200
201
202          </div>
203        </div>
204      </div>
205      <div class="sphinxsidebar">
206        <div class="sphinxsidebarwrapper">
207  <h3><a href="../../index.html">Table Of Contents</a></h3>
208  <ul>
209<li><a class="reference internal" href="#">sas.guiframe.local_perspectives.data_loader package</a><ul>
210<li><a class="reference internal" href="#submodules">Submodules</a></li>
211<li><a class="reference internal" href="#module-sas.guiframe.local_perspectives.data_loader.data_loader">sas.guiframe.local_perspectives.data_loader.data_loader module</a></li>
212<li><a class="reference internal" href="#module-sas.guiframe.local_perspectives.data_loader.help_panel">sas.guiframe.local_perspectives.data_loader.help_panel module</a></li>
213<li><a class="reference internal" href="#module-sas.guiframe.local_perspectives.data_loader.load_thread">sas.guiframe.local_perspectives.data_loader.load_thread module</a></li>
214<li><a class="reference internal" href="#module-sas.guiframe.local_perspectives.data_loader">Module contents</a></li>
215</ul>
216</li>
217</ul>
218
219  <h4>Previous topic</h4>
220  <p class="topless"><a href="sas.guiframe.local_perspectives.html"
221                        title="previous chapter">sas.guiframe.local_perspectives package</a></p>
222  <h4>Next topic</h4>
223  <p class="topless"><a href="sas.guiframe.local_perspectives.plotting.html"
224                        title="next chapter">sas.guiframe.local_perspectives.plotting package</a></p>
225  <h3>This Page</h3>
226  <ul class="this-page-menu">
227    <li><a href="../../_sources/dev/api/sas.guiframe.local_perspectives.data_loader.txt"
228           rel="nofollow">Show Source</a></li>
229  </ul>
230<div id="searchbox" style="display: none">
231  <h3>Quick search</h3>
232    <form class="search" action="../../search.html" method="get">
233      <input type="text" name="q" />
234      <input type="submit" value="Go" />
235      <input type="hidden" name="check_keywords" value="yes" />
236      <input type="hidden" name="area" value="default" />
237    </form>
238    <p class="searchtip" style="font-size: 90%">
239    Enter search terms or a module, class or function name.
240    </p>
241</div>
242<script type="text/javascript">$('#searchbox').show(0);</script>
243        </div>
244      </div>
245      <div class="clearer"></div>
246    </div>
247    <div class="related">
248      <h3>Navigation</h3>
249      <ul>
250        <li class="right" style="margin-right: 10px">
251          <a href="../../genindex.html" title="General Index"
252             >index</a></li>
253        <li class="right" >
254          <a href="../../py-modindex.html" title="Python Module Index"
255             >modules</a> |</li>
256        <li class="right" >
257          <a href="sas.guiframe.local_perspectives.plotting.html" title="sas.guiframe.local_perspectives.plotting package"
258             >next</a> |</li>
259        <li class="right" >
260          <a href="sas.guiframe.local_perspectives.html" title="sas.guiframe.local_perspectives package"
261             >previous</a> |</li>
262        <li><a href="../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
263          <li><a href="../dev.html" >Developer Documentation</a> &raquo;</li>
264          <li><a href="modules.html" >lib.macosx-10.5-x86_64-2.7</a> &raquo;</li>
265          <li><a href="sas.html" >sas package</a> &raquo;</li>
266          <li><a href="sas.guiframe.html" >sas.guiframe package</a> &raquo;</li>
267          <li><a href="sas.guiframe.local_perspectives.html" >sas.guiframe.local_perspectives package</a> &raquo;</li> 
268      </ul>
269    </div>
270    <div class="footer">
271        &copy; Copyright 2013, The SasView Project.
272      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
273    </div>
274  </body>
275</html>
Note: See TracBrowser for help on using the repository browser.