source: sasview/_modules/sas/guiframe/utils.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: 19.2 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.utils &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" href="../guiframe.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><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
41          <li><a href="../../index.html" >Module code</a> &raquo;</li>
42          <li><a href="../guiframe.html" accesskey="U">sas.guiframe</a> &raquo;</li> 
43      </ul>
44    </div> 
45
46    <div class="document">
47      <div class="documentwrapper">
48        <div class="bodywrapper">
49          <div class="body">
50           
51  <h1>Source code for sas.guiframe.utils</h1><div class="highlight"><pre>
52<span class="sd">&quot;&quot;&quot;</span>
53<span class="sd">Contains common classes and functions</span>
54<span class="sd">&quot;&quot;&quot;</span>
55<span class="kn">import</span> <span class="nn">wx</span>
56<span class="kn">import</span> <span class="nn">re</span>
57
58<div class="viewcode-block" id="parse_name"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.utils.parse_name">[docs]</a><span class="k">def</span> <span class="nf">parse_name</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">expression</span><span class="p">):</span>
59    <span class="sd">&quot;&quot;&quot;</span>
60<span class="sd">    remove &quot;_&quot; in front of a name</span>
61<span class="sd">    &quot;&quot;&quot;</span>
62    <span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">expression</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
63        <span class="n">word</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">expression</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
64        <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">word</span><span class="p">:</span>           
65            <span class="k">if</span> <span class="n">item</span><span class="o">.</span><span class="n">lstrip</span><span class="p">()</span><span class="o">.</span><span class="n">rstrip</span><span class="p">()</span> <span class="o">!=</span> <span class="s">&#39;&#39;</span><span class="p">:</span>
66                <span class="k">return</span> <span class="n">item</span>
67    <span class="k">else</span><span class="p">:</span>
68        <span class="k">return</span> <span class="n">name</span></div>
69<div class="viewcode-block" id="format_number"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.utils.format_number">[docs]</a><span class="k">def</span> <span class="nf">format_number</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="n">high</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
70    <span class="sd">&quot;&quot;&quot;</span>
71<span class="sd">    Return a float in a standardized, human-readable formatted string </span>
72<span class="sd">    &quot;&quot;&quot;</span>
73    <span class="k">try</span><span class="p">:</span> 
74        <span class="n">value</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
75    <span class="k">except</span><span class="p">:</span>
76        <span class="n">output</span> <span class="o">=</span> <span class="s">&quot;NaN&quot;</span>
77        <span class="k">return</span> <span class="n">output</span><span class="o">.</span><span class="n">lstrip</span><span class="p">()</span><span class="o">.</span><span class="n">rstrip</span><span class="p">()</span>
78    <span class="k">if</span> <span class="n">high</span><span class="p">:</span>
79        <span class="n">output</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%-7.5g</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">value</span>
80    <span class="k">else</span><span class="p">:</span>
81        <span class="n">output</span> <span class="o">=</span> <span class="s">&quot;</span><span class="si">%-5.3g</span><span class="s">&quot;</span> <span class="o">%</span> <span class="n">value</span>
82    <span class="k">return</span> <span class="n">output</span><span class="o">.</span><span class="n">lstrip</span><span class="p">()</span><span class="o">.</span><span class="n">rstrip</span><span class="p">()</span>
83</div>
84<div class="viewcode-block" id="check_float"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.utils.check_float">[docs]</a><span class="k">def</span> <span class="nf">check_float</span><span class="p">(</span><span class="n">item</span><span class="p">):</span>
85    <span class="sd">&quot;&quot;&quot;</span>
86<span class="sd">    :param item: txtcrtl containing a value</span>
87<span class="sd">    &quot;&quot;&quot;</span>
88    <span class="n">flag</span> <span class="o">=</span> <span class="bp">True</span>
89    <span class="k">try</span><span class="p">:</span>
90        <span class="n">mini</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">item</span><span class="o">.</span><span class="n">GetValue</span><span class="p">())</span>
91        <span class="n">item</span><span class="o">.</span><span class="n">SetBackgroundColour</span><span class="p">(</span><span class="n">wx</span><span class="o">.</span><span class="n">WHITE</span><span class="p">)</span>
92        <span class="n">item</span><span class="o">.</span><span class="n">Refresh</span><span class="p">()</span>
93    <span class="k">except</span><span class="p">:</span>
94        <span class="n">flag</span> <span class="o">=</span> <span class="bp">False</span>
95        <span class="n">item</span><span class="o">.</span><span class="n">SetBackgroundColour</span><span class="p">(</span><span class="s">&quot;pink&quot;</span><span class="p">)</span>
96        <span class="n">item</span><span class="o">.</span><span class="n">Refresh</span><span class="p">()</span>
97    <span class="k">return</span> <span class="n">flag</span>
98
99    </div>
100<div class="viewcode-block" id="PanelMenu"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.utils.PanelMenu">[docs]</a><span class="k">class</span> <span class="nc">PanelMenu</span><span class="p">(</span><span class="n">wx</span><span class="o">.</span><span class="n">Menu</span><span class="p">):</span>
101    <span class="sd">&quot;&quot;&quot;</span>
102<span class="sd">    &quot;&quot;&quot;</span>
103    <span class="n">plots</span> <span class="o">=</span> <span class="bp">None</span>
104    <span class="n">graph</span> <span class="o">=</span> <span class="bp">None</span>
105   
106<div class="viewcode-block" id="PanelMenu.set_plots"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.utils.PanelMenu.set_plots">[docs]</a>    <span class="k">def</span> <span class="nf">set_plots</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">plots</span><span class="p">):</span>
107        <span class="sd">&quot;&quot;&quot;</span>
108<span class="sd">        &quot;&quot;&quot;</span>
109        <span class="bp">self</span><span class="o">.</span><span class="n">plots</span> <span class="o">=</span> <span class="n">plots</span>
110    </div>
111<div class="viewcode-block" id="PanelMenu.set_graph"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.utils.PanelMenu.set_graph">[docs]</a>    <span class="k">def</span> <span class="nf">set_graph</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">graph</span><span class="p">):</span>
112        <span class="sd">&quot;&quot;&quot;</span>
113<span class="sd">        &quot;&quot;&quot;</span>
114        <span class="bp">self</span><span class="o">.</span><span class="n">graph</span> <span class="o">=</span> <span class="n">graph</span>
115       
116</div></div>
117<div class="viewcode-block" id="split_list"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.utils.split_list">[docs]</a><span class="k">def</span> <span class="nf">split_list</span><span class="p">(</span><span class="n">separator</span><span class="p">,</span> <span class="n">mylist</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
118    <span class="sd">&quot;&quot;&quot;</span>
119<span class="sd">    returns a list of string without white space of separator</span>
120<span class="sd">    </span>
121<span class="sd">    :param separator: the string to remove</span>
122<span class="sd">    </span>
123<span class="sd">    &quot;&quot;&quot;</span>
124    <span class="nb">list</span> <span class="o">=</span> <span class="p">[]</span>
125    <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">mylist</span><span class="p">:</span>
126        <span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">separator</span><span class="p">,</span><span class="n">item</span><span class="p">)</span><span class="o">!=</span> <span class="bp">None</span><span class="p">:</span>
127            <span class="k">if</span> <span class="n">n</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
128                <span class="n">word</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">separator</span><span class="p">,</span> <span class="n">item</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">n</span><span class="p">))</span>
129            <span class="k">else</span><span class="p">:</span>
130                <span class="n">word</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">separator</span><span class="p">,</span> <span class="n">item</span><span class="p">)</span>
131            <span class="k">for</span> <span class="n">new_item</span> <span class="ow">in</span> <span class="n">word</span><span class="p">:</span> 
132                <span class="k">if</span> <span class="n">new_item</span><span class="o">.</span><span class="n">lstrip</span><span class="p">()</span><span class="o">.</span><span class="n">rstrip</span><span class="p">()</span> <span class="o">!=</span> <span class="s">&#39;&#39;</span><span class="p">:</span>
133                    <span class="nb">list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">new_item</span><span class="o">.</span><span class="n">lstrip</span><span class="p">()</span><span class="o">.</span><span class="n">rstrip</span><span class="p">())</span>
134    <span class="k">return</span> <span class="nb">list</span>
135</div>
136<div class="viewcode-block" id="split_text"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.utils.split_text">[docs]</a><span class="k">def</span> <span class="nf">split_text</span><span class="p">(</span><span class="n">separator</span><span class="p">,</span> <span class="n">string1</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
137    <span class="sd">&quot;&quot;&quot;</span>
138<span class="sd">    return a list of string without white space of separator</span>
139<span class="sd">    </span>
140<span class="sd">    :param separator: the string to remove</span>
141<span class="sd">    </span>
142<span class="sd">    &quot;&quot;&quot;</span>
143    <span class="nb">list</span> <span class="o">=</span> <span class="p">[]</span>
144    <span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">separator</span><span class="p">,</span> <span class="n">string1</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
145        <span class="k">if</span> <span class="n">n</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
146            <span class="n">word</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">separator</span><span class="p">,</span><span class="n">string1</span><span class="p">,</span><span class="nb">int</span><span class="p">(</span><span class="n">n</span><span class="p">))</span>
147        <span class="k">else</span><span class="p">:</span>
148            <span class="n">word</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">separator</span><span class="p">,</span><span class="n">string1</span><span class="p">)</span>
149        <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">word</span><span class="p">:</span> 
150            <span class="k">if</span> <span class="n">item</span><span class="o">.</span><span class="n">lstrip</span><span class="p">()</span><span class="o">.</span><span class="n">rstrip</span><span class="p">()</span> <span class="o">!=</span> <span class="s">&#39;&#39;</span><span class="p">:</span>
151                <span class="nb">list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">item</span><span class="o">.</span><span class="n">lstrip</span><span class="p">()</span><span class="o">.</span><span class="n">rstrip</span><span class="p">())</span>
152    <span class="k">return</span> <span class="nb">list</span>
153</div>
154<div class="viewcode-block" id="look_for_tag"><a class="viewcode-back" href="../../../dev/api/sas.guiframe.html#sas.guiframe.utils.look_for_tag">[docs]</a><span class="k">def</span> <span class="nf">look_for_tag</span><span class="p">(</span><span class="n">string1</span><span class="p">,</span> <span class="n">begin</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
155    <span class="sd">&quot;&quot;&quot;</span>
156<span class="sd">    this method  remove the begin and end tags given by the user</span>
157<span class="sd">    from the string .</span>
158<span class="sd">    </span>
159<span class="sd">    :param begin: the initial tag</span>
160<span class="sd">    :param end: the final tag</span>
161<span class="sd">    :param string: the string to check</span>
162<span class="sd">    </span>
163<span class="sd">    :return: begin_flag==True if begin was found,</span>
164<span class="sd">     end_flag==if end was found else return false, false</span>
165<span class="sd">     </span>
166<span class="sd">    &quot;&quot;&quot;</span>
167    <span class="n">begin_flag</span> <span class="o">=</span> <span class="bp">False</span>
168    <span class="n">end_flag</span> <span class="o">=</span> <span class="bp">False</span>
169    <span class="k">if</span>  <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">begin</span><span class="p">,</span><span class="n">string1</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
170        <span class="n">begin_flag</span> <span class="o">=</span> <span class="bp">True</span>
171    <span class="k">if</span> <span class="n">end</span>  <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
172        <span class="k">if</span>  <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">end</span><span class="p">,</span><span class="n">string1</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
173            <span class="n">end_flag</span> <span class="o">=</span> <span class="bp">True</span>
174    <span class="k">return</span> <span class="n">begin_flag</span><span class="p">,</span> <span class="n">end_flag</span>
175</pre></div></div>
176
177          </div>
178        </div>
179      </div>
180      <div class="sphinxsidebar">
181        <div class="sphinxsidebarwrapper">
182<div id="searchbox" style="display: none">
183  <h3>Quick search</h3>
184    <form class="search" action="../../../search.html" method="get">
185      <input type="text" name="q" />
186      <input type="submit" value="Go" />
187      <input type="hidden" name="check_keywords" value="yes" />
188      <input type="hidden" name="area" value="default" />
189    </form>
190    <p class="searchtip" style="font-size: 90%">
191    Enter search terms or a module, class or function name.
192    </p>
193</div>
194<script type="text/javascript">$('#searchbox').show(0);</script>
195        </div>
196      </div>
197      <div class="clearer"></div>
198    </div>
199    <div class="related">
200      <h3>Navigation</h3>
201      <ul>
202        <li class="right" style="margin-right: 10px">
203          <a href="../../../genindex.html" title="General Index"
204             >index</a></li>
205        <li class="right" >
206          <a href="../../../py-modindex.html" title="Python Module Index"
207             >modules</a> |</li>
208        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
209          <li><a href="../../index.html" >Module code</a> &raquo;</li>
210          <li><a href="../guiframe.html" >sas.guiframe</a> &raquo;</li> 
211      </ul>
212    </div>
213    <div class="footer">
214        &copy; Copyright 2013, The SasView Project.
215      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
216    </div>
217  </body>
218</html>
Note: See TracBrowser for help on using the repository browser.