source: sasview/guiframe/docs/sphinx/_build/html/api/local_perspectives/plotting/boxSlicer.html @ d955bf19

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

working on documentation
  • Property mode set to 100644
File size: 57.5 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>boxSlicer &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="Local Perspective: Plotting" href="index.html" />
27    <link rel="next" title="boxSum" href="boxSum.html" />
28    <link rel="prev" title="boxMask" href="boxMask.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="boxSum.html" title="boxSum"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="boxMask.html" title="boxMask"
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">Local Perspective: Plotting</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="boxslicer">
57<h1>boxSlicer<a class="headerlink" href="#boxslicer" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.guiframe.local_perspectives.plotting.boxSlicer">
59<span id="sans-guiframe-local-perspectives-plotting-boxslicer"></span><h2><a class="reference internal" href="#module-sans.guiframe.local_perspectives.plotting.boxSlicer"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.boxSlicer</span></tt></a><a class="headerlink" href="#module-sans.guiframe.local_perspectives.plotting.boxSlicer" title="Permalink to this headline">¶</a></h2>
60<dl class="class">
61<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor">
62<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.boxSlicer.</tt><tt class="descname">BoxInteractor</tt><big>(</big><em>base</em>, <em>axes</em>, <em>color='black'</em>, <em>zorder=3</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor" title="Permalink to this definition">¶</a></dt>
63<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.BaseInteractor._BaseInteractor</span></tt></p>
64<p>BoxInteractor define a rectangle that return data1D average of Data2D
65in a rectangle area defined by -x, x ,y, -y</p>
66<dl class="method">
67<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.clear">
68<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.clear" title="Permalink to this definition">¶</a></dt>
69<dd>Clear the slicer and all connected events related to this slicer</dd></dl>
70
71<dl class="method">
72<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.clear_markers">
73<tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.clear_markers" title="Permalink to this definition">¶</a></dt>
74<dd>Clear old markers and interfaces.</dd></dl>
75
76<dl class="method">
77<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.connect_markers">
78<tt class="descname">connect_markers</tt><big>(</big><em>markers</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.connect_markers" title="Permalink to this definition">¶</a></dt>
79<dd>Connect markers to callbacks</dd></dl>
80
81<dl class="method">
82<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.dpixel">
83<tt class="descname">dpixel</tt><big>(</big><em>x</em>, <em>y</em>, <em>nudge=False</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.dpixel" title="Permalink to this definition">¶</a></dt>
84<dd>Return the step size in data coordinates for a small
85step in screen coordinates.  If nudge is False (default)
86the step size is one pixel.  If nudge is True, the step
87size is 0.2 pixels.</dd></dl>
88
89<dl class="method">
90<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.draw">
91<tt class="descname">draw</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.draw" title="Permalink to this definition">¶</a></dt>
92<dd></dd></dl>
93
94<dl class="method">
95<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.freeze_axes">
96<tt class="descname">freeze_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.freeze_axes" title="Permalink to this definition">¶</a></dt>
97<dd></dd></dl>
98
99<dl class="method">
100<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.get_params">
101<tt class="descname">get_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.get_params" title="Permalink to this definition">¶</a></dt>
102<dd><p>Store a copy of values of parameters of the slicer into a dictionary.</p>
103<table class="docutils field-list" frame="void" rules="none">
104<col class="field-name" />
105<col class="field-body" />
106<tbody valign="top">
107<tr class="field"><th class="field-name">Return params:</th><td class="field-body">the dictionary created</td>
108</tr>
109</tbody>
110</table>
111</dd></dl>
112
113<dl class="method">
114<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.move">
115<tt class="descname">move</tt><big>(</big><em>x</em>, <em>y</em>, <em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.move" title="Permalink to this definition">¶</a></dt>
116<dd>Process move to a new position, making sure that the move is allowed.</dd></dl>
117
118<dl class="method">
119<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.moveend">
120<tt class="descname">moveend</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.moveend" title="Permalink to this definition">¶</a></dt>
121<dd>Called after a dragging event.
122Post the slicer new parameters and creates a new Data1D
123corresponding to the new average</dd></dl>
124
125<dl class="method">
126<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onClick">
127<tt class="descname">onClick</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onClick" title="Permalink to this definition">¶</a></dt>
128<dd>Prepare to move the artist.  Calls save() to preserve the state for
129later restore().</dd></dl>
130
131<dl class="method">
132<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onDrag">
133<tt class="descname">onDrag</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onDrag" title="Permalink to this definition">¶</a></dt>
134<dd>Move the artist.  Calls move() to update the state, or restore() if
135the mouse leaves the window.</dd></dl>
136
137<dl class="method">
138<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onHilite">
139<tt class="descname">onHilite</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onHilite" title="Permalink to this definition">¶</a></dt>
140<dd>Hilite the artist reporting the event, indicating that it is
141ready to receive a click.</dd></dl>
142
143<dl class="method">
144<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onKey">
145<tt class="descname">onKey</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onKey" title="Permalink to this definition">¶</a></dt>
146<dd><p>Respond to keyboard events.  Arrow keys move the widget.  Escape
147restores it to the position before the last click.</p>
148<p>Calls move() to update the state.  Calls restore() on escape.</p>
149</dd></dl>
150
151<dl class="method">
152<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onLeave">
153<tt class="descname">onLeave</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onLeave" title="Permalink to this definition">¶</a></dt>
154<dd>Restore the artist to the original colour when the cursor leaves.</dd></dl>
155
156<dl class="method">
157<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onRelease">
158<tt class="descname">onRelease</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.onRelease" title="Permalink to this definition">¶</a></dt>
159<dd></dd></dl>
160
161<dl class="method">
162<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.post_data">
163<tt class="descname">post_data</tt><big>(</big><em>new_slab=None</em>, <em>nbins=None</em>, <em>direction=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.post_data" title="Permalink to this definition">¶</a></dt>
164<dd><p>post data averaging in Qx or Qy given new_slab type</p>
165<table class="docutils field-list" frame="void" rules="none">
166<col class="field-name" />
167<col class="field-body" />
168<tbody valign="top">
169<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
170<li><strong>new_slab</strong> &#8211; slicer that determine with direction to average</li>
171<li><strong>nbins</strong> &#8211; the number of points plotted when averaging</li>
172<li><strong>direction</strong> &#8211; the direction of averaging</li>
173</ul>
174</td>
175</tr>
176</tbody>
177</table>
178</dd></dl>
179
180<dl class="method">
181<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.restore">
182<tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.restore" title="Permalink to this definition">¶</a></dt>
183<dd>Restore the roughness for this layer.</dd></dl>
184
185<dl class="method">
186<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.save">
187<tt class="descname">save</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.save" title="Permalink to this definition">¶</a></dt>
188<dd>Remember the roughness for this layer and the next so that we
189can restore on Esc.</dd></dl>
190
191<dl class="method">
192<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.set_cursor">
193<tt class="descname">set_cursor</tt><big>(</big><em>x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.set_cursor" title="Permalink to this definition">¶</a></dt>
194<dd></dd></dl>
195
196<dl class="method">
197<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.set_layer">
198<tt class="descname">set_layer</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.set_layer" title="Permalink to this definition">¶</a></dt>
199<dd><p>Allow adding plot to the same panel</p>
200<table class="docutils field-list" frame="void" rules="none">
201<col class="field-name" />
202<col class="field-body" />
203<tbody valign="top">
204<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
205<li><strong>n</strong> &#8211; the number of layer</li>
206</ul>
207</td>
208</tr>
209</tbody>
210</table>
211</dd></dl>
212
213<dl class="method">
214<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.set_params">
215<tt class="descname">set_params</tt><big>(</big><em>params</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.set_params" title="Permalink to this definition">¶</a></dt>
216<dd><p>Receive a dictionary and reset the slicer with values contained
217in the values of the dictionary.</p>
218<table class="docutils field-list" frame="void" rules="none">
219<col class="field-name" />
220<col class="field-body" />
221<tbody valign="top">
222<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
223<li><strong>params</strong> &#8211; a dictionary containing name of slicer parameters and
224values the user assigned to the slicer.</li>
225</ul>
226</td>
227</tr>
228</tbody>
229</table>
230</dd></dl>
231
232<dl class="method">
233<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.thaw_axes">
234<tt class="descname">thaw_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.thaw_axes" title="Permalink to this definition">¶</a></dt>
235<dd></dd></dl>
236
237<dl class="method">
238<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.update">
239<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.update" title="Permalink to this definition">¶</a></dt>
240<dd>Respond to changes in the model by recalculating the profiles and
241resetting the widgets.</dd></dl>
242
243<dl class="method">
244<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.update_and_post">
245<tt class="descname">update_and_post</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor.update_and_post" title="Permalink to this definition">¶</a></dt>
246<dd>Update the slicer and plot the resulting data</dd></dl>
247
248</dd></dl>
249
250<dl class="class">
251<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX">
252<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.boxSlicer.</tt><tt class="descname">BoxInteractorX</tt><big>(</big><em>base</em>, <em>axes</em>, <em>color='black'</em>, <em>zorder=3</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX" title="Permalink to this definition">¶</a></dt>
253<dd><p>Bases: <a class="reference internal" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor" title="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor"><tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor</span></tt></a></p>
254<p>Average in Qx direction</p>
255<dl class="method">
256<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.clear">
257<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.clear" title="Permalink to this definition">¶</a></dt>
258<dd>Clear the slicer and all connected events related to this slicer</dd></dl>
259
260<dl class="method">
261<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.clear_markers">
262<tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.clear_markers" title="Permalink to this definition">¶</a></dt>
263<dd>Clear old markers and interfaces.</dd></dl>
264
265<dl class="method">
266<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.connect_markers">
267<tt class="descname">connect_markers</tt><big>(</big><em>markers</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.connect_markers" title="Permalink to this definition">¶</a></dt>
268<dd>Connect markers to callbacks</dd></dl>
269
270<dl class="method">
271<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.dpixel">
272<tt class="descname">dpixel</tt><big>(</big><em>x</em>, <em>y</em>, <em>nudge=False</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.dpixel" title="Permalink to this definition">¶</a></dt>
273<dd>Return the step size in data coordinates for a small
274step in screen coordinates.  If nudge is False (default)
275the step size is one pixel.  If nudge is True, the step
276size is 0.2 pixels.</dd></dl>
277
278<dl class="method">
279<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.draw">
280<tt class="descname">draw</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.draw" title="Permalink to this definition">¶</a></dt>
281<dd></dd></dl>
282
283<dl class="method">
284<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.freeze_axes">
285<tt class="descname">freeze_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.freeze_axes" title="Permalink to this definition">¶</a></dt>
286<dd></dd></dl>
287
288<dl class="method">
289<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.get_params">
290<tt class="descname">get_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.get_params" title="Permalink to this definition">¶</a></dt>
291<dd><p>Store a copy of values of parameters of the slicer into a dictionary.</p>
292<table class="docutils field-list" frame="void" rules="none">
293<col class="field-name" />
294<col class="field-body" />
295<tbody valign="top">
296<tr class="field"><th class="field-name">Return params:</th><td class="field-body">the dictionary created</td>
297</tr>
298</tbody>
299</table>
300</dd></dl>
301
302<dl class="method">
303<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.move">
304<tt class="descname">move</tt><big>(</big><em>x</em>, <em>y</em>, <em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.move" title="Permalink to this definition">¶</a></dt>
305<dd>Process move to a new position, making sure that the move is allowed.</dd></dl>
306
307<dl class="method">
308<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.moveend">
309<tt class="descname">moveend</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.moveend" title="Permalink to this definition">¶</a></dt>
310<dd>Called after a dragging event.
311Post the slicer new parameters and creates a new Data1D
312corresponding to the new average</dd></dl>
313
314<dl class="method">
315<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onClick">
316<tt class="descname">onClick</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onClick" title="Permalink to this definition">¶</a></dt>
317<dd>Prepare to move the artist.  Calls save() to preserve the state for
318later restore().</dd></dl>
319
320<dl class="method">
321<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onDrag">
322<tt class="descname">onDrag</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onDrag" title="Permalink to this definition">¶</a></dt>
323<dd>Move the artist.  Calls move() to update the state, or restore() if
324the mouse leaves the window.</dd></dl>
325
326<dl class="method">
327<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onHilite">
328<tt class="descname">onHilite</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onHilite" title="Permalink to this definition">¶</a></dt>
329<dd>Hilite the artist reporting the event, indicating that it is
330ready to receive a click.</dd></dl>
331
332<dl class="method">
333<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onKey">
334<tt class="descname">onKey</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onKey" title="Permalink to this definition">¶</a></dt>
335<dd><p>Respond to keyboard events.  Arrow keys move the widget.  Escape
336restores it to the position before the last click.</p>
337<p>Calls move() to update the state.  Calls restore() on escape.</p>
338</dd></dl>
339
340<dl class="method">
341<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onLeave">
342<tt class="descname">onLeave</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onLeave" title="Permalink to this definition">¶</a></dt>
343<dd>Restore the artist to the original colour when the cursor leaves.</dd></dl>
344
345<dl class="method">
346<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onRelease">
347<tt class="descname">onRelease</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.onRelease" title="Permalink to this definition">¶</a></dt>
348<dd></dd></dl>
349
350<dl class="method">
351<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.post_data">
352<tt class="descname">post_data</tt><big>(</big><em>new_slab=None</em>, <em>nbins=None</em>, <em>direction=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.post_data" title="Permalink to this definition">¶</a></dt>
353<dd><p>post data averaging in Qx or Qy given new_slab type</p>
354<table class="docutils field-list" frame="void" rules="none">
355<col class="field-name" />
356<col class="field-body" />
357<tbody valign="top">
358<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
359<li><strong>new_slab</strong> &#8211; slicer that determine with direction to average</li>
360<li><strong>nbins</strong> &#8211; the number of points plotted when averaging</li>
361<li><strong>direction</strong> &#8211; the direction of averaging</li>
362</ul>
363</td>
364</tr>
365</tbody>
366</table>
367</dd></dl>
368
369<dl class="method">
370<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.restore">
371<tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.restore" title="Permalink to this definition">¶</a></dt>
372<dd>Restore the roughness for this layer.</dd></dl>
373
374<dl class="method">
375<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.save">
376<tt class="descname">save</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.save" title="Permalink to this definition">¶</a></dt>
377<dd>Remember the roughness for this layer and the next so that we
378can restore on Esc.</dd></dl>
379
380<dl class="method">
381<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.set_cursor">
382<tt class="descname">set_cursor</tt><big>(</big><em>x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.set_cursor" title="Permalink to this definition">¶</a></dt>
383<dd></dd></dl>
384
385<dl class="method">
386<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.set_layer">
387<tt class="descname">set_layer</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.set_layer" title="Permalink to this definition">¶</a></dt>
388<dd><p>Allow adding plot to the same panel</p>
389<table class="docutils field-list" frame="void" rules="none">
390<col class="field-name" />
391<col class="field-body" />
392<tbody valign="top">
393<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
394<li><strong>n</strong> &#8211; the number of layer</li>
395</ul>
396</td>
397</tr>
398</tbody>
399</table>
400</dd></dl>
401
402<dl class="method">
403<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.set_params">
404<tt class="descname">set_params</tt><big>(</big><em>params</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.set_params" title="Permalink to this definition">¶</a></dt>
405<dd><p>Receive a dictionary and reset the slicer with values contained
406in the values of the dictionary.</p>
407<table class="docutils field-list" frame="void" rules="none">
408<col class="field-name" />
409<col class="field-body" />
410<tbody valign="top">
411<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
412<li><strong>params</strong> &#8211; a dictionary containing name of slicer parameters and
413values the user assigned to the slicer.</li>
414</ul>
415</td>
416</tr>
417</tbody>
418</table>
419</dd></dl>
420
421<dl class="method">
422<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.thaw_axes">
423<tt class="descname">thaw_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.thaw_axes" title="Permalink to this definition">¶</a></dt>
424<dd></dd></dl>
425
426<dl class="method">
427<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.update">
428<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.update" title="Permalink to this definition">¶</a></dt>
429<dd>Respond to changes in the model by recalculating the profiles and
430resetting the widgets.</dd></dl>
431
432<dl class="method">
433<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.update_and_post">
434<tt class="descname">update_and_post</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorX.update_and_post" title="Permalink to this definition">¶</a></dt>
435<dd>Update the slicer and plot the resulting data</dd></dl>
436
437</dd></dl>
438
439<dl class="class">
440<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY">
441<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.boxSlicer.</tt><tt class="descname">BoxInteractorY</tt><big>(</big><em>base</em>, <em>axes</em>, <em>color='black'</em>, <em>zorder=3</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY" title="Permalink to this definition">¶</a></dt>
442<dd><p>Bases: <a class="reference internal" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor" title="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor"><tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractor</span></tt></a></p>
443<p>Average in Qy direction</p>
444<dl class="method">
445<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.clear">
446<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.clear" title="Permalink to this definition">¶</a></dt>
447<dd>Clear the slicer and all connected events related to this slicer</dd></dl>
448
449<dl class="method">
450<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.clear_markers">
451<tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.clear_markers" title="Permalink to this definition">¶</a></dt>
452<dd>Clear old markers and interfaces.</dd></dl>
453
454<dl class="method">
455<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.connect_markers">
456<tt class="descname">connect_markers</tt><big>(</big><em>markers</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.connect_markers" title="Permalink to this definition">¶</a></dt>
457<dd>Connect markers to callbacks</dd></dl>
458
459<dl class="method">
460<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.dpixel">
461<tt class="descname">dpixel</tt><big>(</big><em>x</em>, <em>y</em>, <em>nudge=False</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.dpixel" title="Permalink to this definition">¶</a></dt>
462<dd>Return the step size in data coordinates for a small
463step in screen coordinates.  If nudge is False (default)
464the step size is one pixel.  If nudge is True, the step
465size is 0.2 pixels.</dd></dl>
466
467<dl class="method">
468<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.draw">
469<tt class="descname">draw</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.draw" title="Permalink to this definition">¶</a></dt>
470<dd></dd></dl>
471
472<dl class="method">
473<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.freeze_axes">
474<tt class="descname">freeze_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.freeze_axes" title="Permalink to this definition">¶</a></dt>
475<dd></dd></dl>
476
477<dl class="method">
478<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.get_params">
479<tt class="descname">get_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.get_params" title="Permalink to this definition">¶</a></dt>
480<dd><p>Store a copy of values of parameters of the slicer into a dictionary.</p>
481<table class="docutils field-list" frame="void" rules="none">
482<col class="field-name" />
483<col class="field-body" />
484<tbody valign="top">
485<tr class="field"><th class="field-name">Return params:</th><td class="field-body">the dictionary created</td>
486</tr>
487</tbody>
488</table>
489</dd></dl>
490
491<dl class="method">
492<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.move">
493<tt class="descname">move</tt><big>(</big><em>x</em>, <em>y</em>, <em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.move" title="Permalink to this definition">¶</a></dt>
494<dd>Process move to a new position, making sure that the move is allowed.</dd></dl>
495
496<dl class="method">
497<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.moveend">
498<tt class="descname">moveend</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.moveend" title="Permalink to this definition">¶</a></dt>
499<dd>Called after a dragging event.
500Post the slicer new parameters and creates a new Data1D
501corresponding to the new average</dd></dl>
502
503<dl class="method">
504<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onClick">
505<tt class="descname">onClick</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onClick" title="Permalink to this definition">¶</a></dt>
506<dd>Prepare to move the artist.  Calls save() to preserve the state for
507later restore().</dd></dl>
508
509<dl class="method">
510<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onDrag">
511<tt class="descname">onDrag</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onDrag" title="Permalink to this definition">¶</a></dt>
512<dd>Move the artist.  Calls move() to update the state, or restore() if
513the mouse leaves the window.</dd></dl>
514
515<dl class="method">
516<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onHilite">
517<tt class="descname">onHilite</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onHilite" title="Permalink to this definition">¶</a></dt>
518<dd>Hilite the artist reporting the event, indicating that it is
519ready to receive a click.</dd></dl>
520
521<dl class="method">
522<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onKey">
523<tt class="descname">onKey</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onKey" title="Permalink to this definition">¶</a></dt>
524<dd><p>Respond to keyboard events.  Arrow keys move the widget.  Escape
525restores it to the position before the last click.</p>
526<p>Calls move() to update the state.  Calls restore() on escape.</p>
527</dd></dl>
528
529<dl class="method">
530<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onLeave">
531<tt class="descname">onLeave</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onLeave" title="Permalink to this definition">¶</a></dt>
532<dd>Restore the artist to the original colour when the cursor leaves.</dd></dl>
533
534<dl class="method">
535<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onRelease">
536<tt class="descname">onRelease</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.onRelease" title="Permalink to this definition">¶</a></dt>
537<dd></dd></dl>
538
539<dl class="method">
540<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.post_data">
541<tt class="descname">post_data</tt><big>(</big><em>new_slab=None</em>, <em>nbins=None</em>, <em>direction=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.post_data" title="Permalink to this definition">¶</a></dt>
542<dd><p>post data averaging in Qx or Qy given new_slab type</p>
543<table class="docutils field-list" frame="void" rules="none">
544<col class="field-name" />
545<col class="field-body" />
546<tbody valign="top">
547<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
548<li><strong>new_slab</strong> &#8211; slicer that determine with direction to average</li>
549<li><strong>nbins</strong> &#8211; the number of points plotted when averaging</li>
550<li><strong>direction</strong> &#8211; the direction of averaging</li>
551</ul>
552</td>
553</tr>
554</tbody>
555</table>
556</dd></dl>
557
558<dl class="method">
559<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.restore">
560<tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.restore" title="Permalink to this definition">¶</a></dt>
561<dd>Restore the roughness for this layer.</dd></dl>
562
563<dl class="method">
564<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.save">
565<tt class="descname">save</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.save" title="Permalink to this definition">¶</a></dt>
566<dd>Remember the roughness for this layer and the next so that we
567can restore on Esc.</dd></dl>
568
569<dl class="method">
570<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.set_cursor">
571<tt class="descname">set_cursor</tt><big>(</big><em>x</em>, <em>y</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.set_cursor" title="Permalink to this definition">¶</a></dt>
572<dd></dd></dl>
573
574<dl class="method">
575<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.set_layer">
576<tt class="descname">set_layer</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.set_layer" title="Permalink to this definition">¶</a></dt>
577<dd><p>Allow adding plot to the same panel</p>
578<table class="docutils field-list" frame="void" rules="none">
579<col class="field-name" />
580<col class="field-body" />
581<tbody valign="top">
582<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
583<li><strong>n</strong> &#8211; the number of layer</li>
584</ul>
585</td>
586</tr>
587</tbody>
588</table>
589</dd></dl>
590
591<dl class="method">
592<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.set_params">
593<tt class="descname">set_params</tt><big>(</big><em>params</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.set_params" title="Permalink to this definition">¶</a></dt>
594<dd><p>Receive a dictionary and reset the slicer with values contained
595in the values of the dictionary.</p>
596<table class="docutils field-list" frame="void" rules="none">
597<col class="field-name" />
598<col class="field-body" />
599<tbody valign="top">
600<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
601<li><strong>params</strong> &#8211; a dictionary containing name of slicer parameters and
602values the user assigned to the slicer.</li>
603</ul>
604</td>
605</tr>
606</tbody>
607</table>
608</dd></dl>
609
610<dl class="method">
611<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.thaw_axes">
612<tt class="descname">thaw_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.thaw_axes" title="Permalink to this definition">¶</a></dt>
613<dd></dd></dl>
614
615<dl class="method">
616<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.update">
617<tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.update" title="Permalink to this definition">¶</a></dt>
618<dd>Respond to changes in the model by recalculating the profiles and
619resetting the widgets.</dd></dl>
620
621<dl class="method">
622<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.update_and_post">
623<tt class="descname">update_and_post</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.BoxInteractorY.update_and_post" title="Permalink to this definition">¶</a></dt>
624<dd>Update the slicer and plot the resulting data</dd></dl>
625
626</dd></dl>
627
628<dl class="class">
629<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines">
630<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.boxSlicer.</tt><tt class="descname">HorizontalLines</tt><big>(</big><em>base</em>, <em>axes</em>, <em>color='black'</em>, <em>zorder=5</em>, <em>x=0.5</em>, <em>y=0.5</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines" title="Permalink to this definition">¶</a></dt>
631<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.BaseInteractor._BaseInteractor</span></tt></p>
632<p>Draw 2 Horizontal lines centered on (0,0) that can move
633on the x- direction and in opposite direction</p>
634<dl class="method">
635<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.clear">
636<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.clear" title="Permalink to this definition">¶</a></dt>
637<dd>Clear this slicer  and its markers</dd></dl>
638
639<dl class="method">
640<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.clear_markers">
641<tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.clear_markers" title="Permalink to this definition">¶</a></dt>
642<dd>Clear old markers and interfaces.</dd></dl>
643
644<dl class="method">
645<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.connect_markers">
646<tt class="descname">connect_markers</tt><big>(</big><em>markers</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.connect_markers" title="Permalink to this definition">¶</a></dt>
647<dd>Connect markers to callbacks</dd></dl>
648
649<dl class="method">
650<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.dpixel">
651<tt class="descname">dpixel</tt><big>(</big><em>x</em>, <em>y</em>, <em>nudge=False</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.dpixel" title="Permalink to this definition">¶</a></dt>
652<dd>Return the step size in data coordinates for a small
653step in screen coordinates.  If nudge is False (default)
654the step size is one pixel.  If nudge is True, the step
655size is 0.2 pixels.</dd></dl>
656
657<dl class="method">
658<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.move">
659<tt class="descname">move</tt><big>(</big><em>x</em>, <em>y</em>, <em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.move" title="Permalink to this definition">¶</a></dt>
660<dd>Process move to a new position, making sure that the move is allowed.</dd></dl>
661
662<dl class="method">
663<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.moveend">
664<tt class="descname">moveend</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.moveend" title="Permalink to this definition">¶</a></dt>
665<dd>Called after a dragging this edge and set self.has_move to False
666to specify the end of dragging motion</dd></dl>
667
668<dl class="method">
669<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onClick">
670<tt class="descname">onClick</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onClick" title="Permalink to this definition">¶</a></dt>
671<dd>Prepare to move the artist.  Calls save() to preserve the state for
672later restore().</dd></dl>
673
674<dl class="method">
675<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onDrag">
676<tt class="descname">onDrag</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onDrag" title="Permalink to this definition">¶</a></dt>
677<dd>Move the artist.  Calls move() to update the state, or restore() if
678the mouse leaves the window.</dd></dl>
679
680<dl class="method">
681<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onHilite">
682<tt class="descname">onHilite</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onHilite" title="Permalink to this definition">¶</a></dt>
683<dd>Hilite the artist reporting the event, indicating that it is
684ready to receive a click.</dd></dl>
685
686<dl class="method">
687<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onKey">
688<tt class="descname">onKey</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onKey" title="Permalink to this definition">¶</a></dt>
689<dd><p>Respond to keyboard events.  Arrow keys move the widget.  Escape
690restores it to the position before the last click.</p>
691<p>Calls move() to update the state.  Calls restore() on escape.</p>
692</dd></dl>
693
694<dl class="method">
695<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onLeave">
696<tt class="descname">onLeave</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onLeave" title="Permalink to this definition">¶</a></dt>
697<dd>Restore the artist to the original colour when the cursor leaves.</dd></dl>
698
699<dl class="method">
700<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onRelease">
701<tt class="descname">onRelease</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.onRelease" title="Permalink to this definition">¶</a></dt>
702<dd></dd></dl>
703
704<dl class="method">
705<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.restore">
706<tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.restore" title="Permalink to this definition">¶</a></dt>
707<dd>Restore the roughness for this layer.</dd></dl>
708
709<dl class="method">
710<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.save">
711<tt class="descname">save</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.save" title="Permalink to this definition">¶</a></dt>
712<dd>Remember the roughness for this layer and the next so that we
713can restore on Esc.</dd></dl>
714
715<dl class="method">
716<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.set_layer">
717<tt class="descname">set_layer</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.set_layer" title="Permalink to this definition">¶</a></dt>
718<dd><p>Allow adding plot to the same panel</p>
719<table class="docutils field-list" frame="void" rules="none">
720<col class="field-name" />
721<col class="field-body" />
722<tbody valign="top">
723<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
724<li><strong>n</strong> &#8211; the number of layer</li>
725</ul>
726</td>
727</tr>
728</tbody>
729</table>
730</dd></dl>
731
732<dl class="method">
733<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.update">
734<tt class="descname">update</tt><big>(</big><em>x=None</em>, <em>y=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.HorizontalLines.update" title="Permalink to this definition">¶</a></dt>
735<dd><p>Draw the new roughness on the graph.</p>
736<table class="docutils field-list" frame="void" rules="none">
737<col class="field-name" />
738<col class="field-body" />
739<tbody valign="top">
740<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
741<li><strong>x</strong> &#8211; x-coordinates to reset current class x</li>
742<li><strong>y</strong> &#8211; y-coordinates to reset current class y</li>
743</ul>
744</td>
745</tr>
746</tbody>
747</table>
748</dd></dl>
749
750</dd></dl>
751
752<dl class="class">
753<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines">
754<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.boxSlicer.</tt><tt class="descname">VerticalLines</tt><big>(</big><em>base</em>, <em>axes</em>, <em>color='black'</em>, <em>zorder=5</em>, <em>x=0.5</em>, <em>y=0.5</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines" title="Permalink to this definition">¶</a></dt>
755<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.BaseInteractor._BaseInteractor</span></tt></p>
756<p>Select an annulus through a 2D plot</p>
757<dl class="method">
758<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.clear">
759<tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.clear" title="Permalink to this definition">¶</a></dt>
760<dd>Clear this slicer  and its markers</dd></dl>
761
762<dl class="method">
763<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.clear_markers">
764<tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.clear_markers" title="Permalink to this definition">¶</a></dt>
765<dd>Clear old markers and interfaces.</dd></dl>
766
767<dl class="method">
768<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.connect_markers">
769<tt class="descname">connect_markers</tt><big>(</big><em>markers</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.connect_markers" title="Permalink to this definition">¶</a></dt>
770<dd>Connect markers to callbacks</dd></dl>
771
772<dl class="method">
773<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.dpixel">
774<tt class="descname">dpixel</tt><big>(</big><em>x</em>, <em>y</em>, <em>nudge=False</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.dpixel" title="Permalink to this definition">¶</a></dt>
775<dd>Return the step size in data coordinates for a small
776step in screen coordinates.  If nudge is False (default)
777the step size is one pixel.  If nudge is True, the step
778size is 0.2 pixels.</dd></dl>
779
780<dl class="method">
781<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.move">
782<tt class="descname">move</tt><big>(</big><em>x</em>, <em>y</em>, <em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.move" title="Permalink to this definition">¶</a></dt>
783<dd>Process move to a new position, making sure that the move is allowed.</dd></dl>
784
785<dl class="method">
786<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.moveend">
787<tt class="descname">moveend</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.moveend" title="Permalink to this definition">¶</a></dt>
788<dd>Called after a dragging this edge and set self.has_move to False
789to specify the end of dragging motion</dd></dl>
790
791<dl class="method">
792<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onClick">
793<tt class="descname">onClick</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onClick" title="Permalink to this definition">¶</a></dt>
794<dd>Prepare to move the artist.  Calls save() to preserve the state for
795later restore().</dd></dl>
796
797<dl class="method">
798<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onDrag">
799<tt class="descname">onDrag</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onDrag" title="Permalink to this definition">¶</a></dt>
800<dd>Move the artist.  Calls move() to update the state, or restore() if
801the mouse leaves the window.</dd></dl>
802
803<dl class="method">
804<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onHilite">
805<tt class="descname">onHilite</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onHilite" title="Permalink to this definition">¶</a></dt>
806<dd>Hilite the artist reporting the event, indicating that it is
807ready to receive a click.</dd></dl>
808
809<dl class="method">
810<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onKey">
811<tt class="descname">onKey</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onKey" title="Permalink to this definition">¶</a></dt>
812<dd><p>Respond to keyboard events.  Arrow keys move the widget.  Escape
813restores it to the position before the last click.</p>
814<p>Calls move() to update the state.  Calls restore() on escape.</p>
815</dd></dl>
816
817<dl class="method">
818<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onLeave">
819<tt class="descname">onLeave</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onLeave" title="Permalink to this definition">¶</a></dt>
820<dd>Restore the artist to the original colour when the cursor leaves.</dd></dl>
821
822<dl class="method">
823<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onRelease">
824<tt class="descname">onRelease</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.onRelease" title="Permalink to this definition">¶</a></dt>
825<dd></dd></dl>
826
827<dl class="method">
828<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.restore">
829<tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.restore" title="Permalink to this definition">¶</a></dt>
830<dd>Restore the roughness for this layer.</dd></dl>
831
832<dl class="method">
833<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.save">
834<tt class="descname">save</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.save" title="Permalink to this definition">¶</a></dt>
835<dd>Remember the roughness for this layer and the next so that we
836can restore on Esc.</dd></dl>
837
838<dl class="method">
839<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.set_layer">
840<tt class="descname">set_layer</tt><big>(</big><em>n</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.set_layer" title="Permalink to this definition">¶</a></dt>
841<dd><p>Allow adding plot to the same panel</p>
842<table class="docutils field-list" frame="void" rules="none">
843<col class="field-name" />
844<col class="field-body" />
845<tbody valign="top">
846<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
847<li><strong>n</strong> &#8211; the number of layer</li>
848</ul>
849</td>
850</tr>
851</tbody>
852</table>
853</dd></dl>
854
855<dl class="method">
856<dt id="sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.update">
857<tt class="descname">update</tt><big>(</big><em>x=None</em>, <em>y=None</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxSlicer.VerticalLines.update" title="Permalink to this definition">¶</a></dt>
858<dd><p>Draw the new roughness on the graph.</p>
859<table class="docutils field-list" frame="void" rules="none">
860<col class="field-name" />
861<col class="field-body" />
862<tbody valign="top">
863<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
864<li><strong>x</strong> &#8211; x-coordinates to reset current class x</li>
865<li><strong>y</strong> &#8211; y-coordinates to reset current class y</li>
866</ul>
867</td>
868</tr>
869</tbody>
870</table>
871</dd></dl>
872
873</dd></dl>
874
875</div>
876</div>
877
878
879          </div>
880        </div>
881      </div>
882      <div class="sphinxsidebar">
883        <div class="sphinxsidebarwrapper">
884  <h3><a href="../../../index.html">Table Of Contents</a></h3>
885  <ul>
886<li><a class="reference internal" href="#">boxSlicer</a><ul>
887<li><a class="reference internal" href="#module-sans.guiframe.local_perspectives.plotting.boxSlicer"><tt class="docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.boxSlicer</span></tt></a></li>
888</ul>
889</li>
890</ul>
891
892  <h4>Previous topic</h4>
893  <p class="topless"><a href="boxMask.html"
894                        title="previous chapter">boxMask</a></p>
895  <h4>Next topic</h4>
896  <p class="topless"><a href="boxSum.html"
897                        title="next chapter">boxSum</a></p>
898  <h3>This Page</h3>
899  <ul class="this-page-menu">
900    <li><a href="../../../_sources/api/local_perspectives/plotting/boxSlicer.txt"
901           rel="nofollow">Show Source</a></li>
902  </ul>
903<div id="searchbox" style="display: none">
904  <h3>Quick search</h3>
905    <form class="search" action="../../../search.html" method="get">
906      <input type="text" name="q" size="18" />
907      <input type="submit" value="Go" />
908      <input type="hidden" name="check_keywords" value="yes" />
909      <input type="hidden" name="area" value="default" />
910    </form>
911    <p class="searchtip" style="font-size: 90%">
912    Enter search terms or a module, class or function name.
913    </p>
914</div>
915<script type="text/javascript">$('#searchbox').show(0);</script>
916        </div>
917      </div>
918      <div class="clearer"></div>
919    </div>
920    <div class="related">
921      <h3>Navigation</h3>
922      <ul>
923        <li class="right" style="margin-right: 10px">
924          <a href="../../../genindex.html" title="General Index"
925             >index</a></li>
926        <li class="right" >
927          <a href="../../../py-modindex.html" title="Python Module Index"
928             >modules</a> |</li>
929        <li class="right" >
930          <a href="boxSum.html" title="boxSum"
931             >next</a> |</li>
932        <li class="right" >
933          <a href="boxMask.html" title="boxMask"
934             >previous</a> |</li>
935        <li><a href="../../../index.html">guiframe v0.1.0 documentation</a> &raquo;</li>
936          <li><a href="index.html" >Local Perspective: Plotting</a> &raquo;</li> 
937      </ul>
938    </div>
939    <div class="footer">
940        &copy; Copyright 2010, sans group.
941      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
942    </div>
943  </body>
944</html>
Note: See TracBrowser for help on using the repository browser.