source: sasview/sansguiframe/docs/sphinx/html/api/local_perspectives/plotting/sectorMask.html @ 67cd7c0

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

sphinx build
  • Property mode set to 100644
File size: 16.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>sectorMask &mdash; guiframe 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="guiframe 0.1.0 documentation" href="../../../index.html" />
29    <link rel="up" title="Local Perspective: plotting" href="index.html" />
30    <link rel="next" title="SectorSlicer" href="SectorSlicer.html" />
31    <link rel="prev" title="profile_dialog" href="profile_dialog.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="SectorSlicer.html" title="SectorSlicer"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="profile_dialog.html" title="profile_dialog"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../../../index.html">guiframe 0.1.0 documentation</a> &raquo;</li>
50          <li><a href="index.html" accesskey="U">Local Perspective: plotting</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="sectormask">
60<h1>sectorMask<a class="headerlink" href="#sectormask" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-guiframe-local-perspectives-plotting-sectormask">
62<h2><a class="reference internal" href="#module-sans.guiframe.local_perspectives.plotting.sectorMask" title="sans.guiframe.local_perspectives.plotting.sectorMask"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.sectorMask</span></tt></a><a class="headerlink" href="#sans-guiframe-local-perspectives-plotting-sectormask" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.guiframe.local_perspectives.plotting.sectorMask"></span><dl class="class">
64<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask">
65<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.sectorMask.</tt><tt class="descname">SectorMask</tt><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask" title="Permalink to this definition">¶</a></dt>
66<dd><p>Bases: <a class="reference internal" href="BaseInteractor.html#sans.guiframe.local_perspectives.plotting.BaseInteractor._BaseInteractor" title="sans.guiframe.local_perspectives.plotting.BaseInteractor._BaseInteractor"><tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.BaseInteractor._BaseInteractor</span></tt></a></p>
67<p>Draw a sector slicer.Allow to find the data 2D inside of the sector lines</p>
68<dl class="method">
69<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.__init__">
70<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.__init__" title="Permalink to this definition">¶</a></dt>
71<dd></dd></dl>
72
73<dl class="attribute">
74<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.__module__">
75<tt class="descname">__module__</tt><em class="property"> = 'sans.guiframe.local_perspectives.plotting.sectorMask'</em><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.__module__" title="Permalink to this definition">¶</a></dt>
76<dd></dd></dl>
77
78<dl class="method">
79<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask._post_data">
80<tt class="descname">_post_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask._post_data" title="Permalink to this definition">¶</a></dt>
81<dd><p>compute sector averaging of data into data1D</p>
82</dd></dl>
83
84<dl class="method">
85<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.clear">
86<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.clear" title="Permalink to this definition">¶</a></dt>
87<dd><p>Clear the slicer and all connected events related to this slicer</p>
88</dd></dl>
89
90<dl class="method">
91<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.clear_markers">
92<tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.clear_markers" title="Permalink to this definition">¶</a></dt>
93<dd><p>Clear old markers and interfaces.</p>
94</dd></dl>
95
96<dl class="method">
97<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.connect_markers">
98<tt class="descname">connect_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.connect_markers" title="Permalink to this definition">¶</a></dt>
99<dd><p>Connect markers to callbacks</p>
100</dd></dl>
101
102<dl class="method">
103<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.dpixel">
104<tt class="descname">dpixel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.dpixel" title="Permalink to this definition">¶</a></dt>
105<dd><p>Return the step size in data coordinates for a small
106step in screen coordinates.  If nudge is False (default)
107the step size is one pixel.  If nudge is True, the step
108size is 0.2 pixels.</p>
109</dd></dl>
110
111<dl class="method">
112<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.draw">
113<tt class="descname">draw</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.draw" title="Permalink to this definition">¶</a></dt>
114<dd></dd></dl>
115
116<dl class="method">
117<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.freeze_axes">
118<tt class="descname">freeze_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.freeze_axes" title="Permalink to this definition">¶</a></dt>
119<dd></dd></dl>
120
121<dl class="method">
122<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.get_params">
123<tt class="descname">get_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.get_params" title="Permalink to this definition">¶</a></dt>
124<dd><p>Store a copy of values of parameters of the slicer into a dictionary.</p>
125<table class="docutils field-list" frame="void" rules="none">
126<col class="field-name" />
127<col class="field-body" />
128<tbody valign="top">
129<tr class="field-odd field"><th class="field-name">Return params:</th><td class="field-body">the dictionary created</td>
130</tr>
131</tbody>
132</table>
133</dd></dl>
134
135<dl class="method">
136<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.move">
137<tt class="descname">move</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.move" title="Permalink to this definition">¶</a></dt>
138<dd><p>Process move to a new position, making sure that the move is allowed.</p>
139</dd></dl>
140
141<dl class="method">
142<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.moveend">
143<tt class="descname">moveend</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.moveend" title="Permalink to this definition">¶</a></dt>
144<dd><p>Called a dragging motion ends.Get slicer event</p>
145</dd></dl>
146
147<dl class="method">
148<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onClick">
149<tt class="descname">onClick</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onClick" title="Permalink to this definition">¶</a></dt>
150<dd><p>Prepare to move the artist.  Calls save() to preserve the state for
151later restore().</p>
152</dd></dl>
153
154<dl class="method">
155<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onDrag">
156<tt class="descname">onDrag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onDrag" title="Permalink to this definition">¶</a></dt>
157<dd><p>Move the artist.  Calls move() to update the state, or restore() if
158the mouse leaves the window.</p>
159</dd></dl>
160
161<dl class="method">
162<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onHilite">
163<tt class="descname">onHilite</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onHilite" title="Permalink to this definition">¶</a></dt>
164<dd><p>Hilite the artist reporting the event, indicating that it is
165ready to receive a click.</p>
166</dd></dl>
167
168<dl class="method">
169<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onKey">
170<tt class="descname">onKey</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onKey" title="Permalink to this definition">¶</a></dt>
171<dd><p>Respond to keyboard events.  Arrow keys move the widget.  Escape
172restores it to the position before the last click.</p>
173<p>Calls move() to update the state.  Calls restore() on escape.</p>
174</dd></dl>
175
176<dl class="method">
177<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onLeave">
178<tt class="descname">onLeave</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onLeave" title="Permalink to this definition">¶</a></dt>
179<dd><p>Restore the artist to the original colour when the cursor leaves.</p>
180</dd></dl>
181
182<dl class="method">
183<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onRelease">
184<tt class="descname">onRelease</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onRelease" title="Permalink to this definition">¶</a></dt>
185<dd></dd></dl>
186
187<dl class="method">
188<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.restore">
189<tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.restore" title="Permalink to this definition">¶</a></dt>
190<dd><p>Restore the roughness for this layer.</p>
191</dd></dl>
192
193<dl class="method">
194<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.save">
195<tt class="descname">save</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.save" title="Permalink to this definition">¶</a></dt>
196<dd><p>Remember the roughness for this layer and the next so that we
197can restore on Esc.</p>
198</dd></dl>
199
200<dl class="method">
201<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.set_cursor">
202<tt class="descname">set_cursor</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.set_cursor" title="Permalink to this definition">¶</a></dt>
203<dd></dd></dl>
204
205<dl class="method">
206<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.set_params">
207<tt class="descname">set_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.set_params" title="Permalink to this definition">¶</a></dt>
208<dd><p>Receive a dictionary and reset the slicer with values contained
209in the values of the dictionary.</p>
210<table class="docutils field-list" frame="void" rules="none">
211<col class="field-name" />
212<col class="field-body" />
213<tbody valign="top">
214<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>params</strong> &#8211; a dictionary containing name of slicer parameters and
215values the user assigned to the slicer.</td>
216</tr>
217</tbody>
218</table>
219</dd></dl>
220
221<dl class="method">
222<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.thaw_axes">
223<tt class="descname">thaw_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.thaw_axes" title="Permalink to this definition">¶</a></dt>
224<dd></dd></dl>
225
226<dl class="method">
227<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.update">
228<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.update" title="Permalink to this definition">¶</a></dt>
229<dd><p>Respond to changes in the model by recalculating the profiles and
230resetting the widgets.</p>
231</dd></dl>
232
233</dd></dl>
234
235</div>
236</div>
237
238
239          </div>
240        </div>
241      </div>
242      <div class="sphinxsidebar">
243        <div class="sphinxsidebarwrapper">
244  <h3><a href="../../../index.html">Table Of Contents</a></h3>
245  <ul>
246<li><a class="reference internal" href="#">sectorMask</a><ul>
247<li><a class="reference internal" href="#sans-guiframe-local-perspectives-plotting-sectormask"><tt class="docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.sectorMask</span></tt></a></li>
248</ul>
249</li>
250</ul>
251
252  <h4>Previous topic</h4>
253  <p class="topless"><a href="profile_dialog.html"
254                        title="previous chapter">profile_dialog</a></p>
255  <h4>Next topic</h4>
256  <p class="topless"><a href="SectorSlicer.html"
257                        title="next chapter">SectorSlicer</a></p>
258  <h3>This Page</h3>
259  <ul class="this-page-menu">
260    <li><a href="../../../_sources/api/local_perspectives/plotting/sectorMask.txt"
261           rel="nofollow">Show Source</a></li>
262  </ul>
263<div id="searchbox" style="display: none">
264  <h3>Quick search</h3>
265    <form class="search" action="../../../search.html" method="get">
266      <input type="text" name="q" />
267      <input type="submit" value="Go" />
268      <input type="hidden" name="check_keywords" value="yes" />
269      <input type="hidden" name="area" value="default" />
270    </form>
271    <p class="searchtip" style="font-size: 90%">
272    Enter search terms or a module, class or function name.
273    </p>
274</div>
275<script type="text/javascript">$('#searchbox').show(0);</script>
276        </div>
277      </div>
278      <div class="clearer"></div>
279    </div>
280    <div class="related">
281      <h3>Navigation</h3>
282      <ul>
283        <li class="right" style="margin-right: 10px">
284          <a href="../../../genindex.html" title="General Index"
285             >index</a></li>
286        <li class="right" >
287          <a href="../../../py-modindex.html" title="Python Module Index"
288             >modules</a> |</li>
289        <li class="right" >
290          <a href="SectorSlicer.html" title="SectorSlicer"
291             >next</a> |</li>
292        <li class="right" >
293          <a href="profile_dialog.html" title="profile_dialog"
294             >previous</a> |</li>
295        <li><a href="../../../index.html">guiframe 0.1.0 documentation</a> &raquo;</li>
296          <li><a href="index.html" >Local Perspective: plotting</a> &raquo;</li> 
297      </ul>
298    </div>
299    <div class="footer">
300        &copy; Copyright 2010, sans group.
301      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
302    </div>
303  </body>
304</html>
Note: See TracBrowser for help on using the repository browser.