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>boxMask — 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="boxSlicer" href="boxSlicer.html" /> |
---|
28 | <link rel="prev" title="binder" href="binder.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="boxSlicer.html" title="boxSlicer" |
---|
42 | accesskey="N">next</a> |</li> |
---|
43 | <li class="right" > |
---|
44 | <a href="binder.html" title="binder" |
---|
45 | accesskey="P">previous</a> |</li> |
---|
46 | <li><a href="../../../index.html">guiframe v0.1.0 documentation</a> »</li> |
---|
47 | <li><a href="index.html" accesskey="U">Local Perspective: plotting</a> »</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="boxmask"> |
---|
57 | <h1>boxMask<a class="headerlink" href="#boxmask" title="Permalink to this headline">¶</a></h1> |
---|
58 | <div class="section" id="module-sans.guiframe.local_perspectives.plotting.boxMask"> |
---|
59 | <span id="sans-guiframe-local-perspectives-plotting-boxmask"></span><h2><a class="reference internal" href="#module-sans.guiframe.local_perspectives.plotting.boxMask" title="sans.guiframe.local_perspectives.plotting.boxMask"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.boxMask</span></tt></a><a class="headerlink" href="#module-sans.guiframe.local_perspectives.plotting.boxMask" title="Permalink to this headline">¶</a></h2> |
---|
60 | <dl class="class"> |
---|
61 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask"> |
---|
62 | <em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.boxMask.</tt><tt class="descname">BoxMask</tt><big>(</big><em>base</em>, <em>axes</em>, <em>color='black'</em>, <em>zorder=3</em>, <em>side=None</em>, <em>x_min=0.0080000000000000002</em>, <em>x_max=0.0080000000000000002</em>, <em>y_min=0.0025000000000000001</em>, <em>y_max=0.0025000000000000001</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask" 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>BoxMask Class: determine 2 rectangular area to find the pixel of |
---|
65 | a Data inside of box.</p> |
---|
66 | <p>Uses PointerInteractor , VerticalDoubleLine,HorizontalDoubleLine.</p> |
---|
67 | <table class="docutils field-list" frame="void" rules="none"> |
---|
68 | <col class="field-name" /> |
---|
69 | <col class="field-body" /> |
---|
70 | <tbody valign="top"> |
---|
71 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
72 | <li><strong>zorder</strong> – Artists with lower zorder values are drawn first.</li> |
---|
73 | <li><strong>x_min</strong> – the minimum value of the x coordinate</li> |
---|
74 | <li><strong>x_max</strong> – the maximum value of the x coordinate</li> |
---|
75 | <li><strong>y_min</strong> – the minimum value of the y coordinate</li> |
---|
76 | <li><strong>y_max</strong> – the maximum value of the y coordinate</li> |
---|
77 | </ul> |
---|
78 | </td> |
---|
79 | </tr> |
---|
80 | </tbody> |
---|
81 | </table> |
---|
82 | <dl class="method"> |
---|
83 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.clear"> |
---|
84 | <tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.clear" title="Permalink to this definition">¶</a></dt> |
---|
85 | <dd><p>Clear the slicer and all connected events related to this slicer</p> |
---|
86 | </dd></dl> |
---|
87 | |
---|
88 | <dl class="method"> |
---|
89 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.clear_markers"> |
---|
90 | <tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.clear_markers" title="Permalink to this definition">¶</a></dt> |
---|
91 | <dd><p>Clear old markers and interfaces.</p> |
---|
92 | </dd></dl> |
---|
93 | |
---|
94 | <dl class="method"> |
---|
95 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.connect_markers"> |
---|
96 | <tt class="descname">connect_markers</tt><big>(</big><em>markers</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.connect_markers" title="Permalink to this definition">¶</a></dt> |
---|
97 | <dd><p>Connect markers to callbacks</p> |
---|
98 | </dd></dl> |
---|
99 | |
---|
100 | <dl class="method"> |
---|
101 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.dpixel"> |
---|
102 | <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.boxMask.BoxMask.dpixel" title="Permalink to this definition">¶</a></dt> |
---|
103 | <dd><p>Return the step size in data coordinates for a small |
---|
104 | step in screen coordinates. If nudge is False (default) |
---|
105 | the step size is one pixel. If nudge is True, the step |
---|
106 | size is 0.2 pixels.</p> |
---|
107 | </dd></dl> |
---|
108 | |
---|
109 | <dl class="method"> |
---|
110 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.draw"> |
---|
111 | <tt class="descname">draw</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.draw" title="Permalink to this definition">¶</a></dt> |
---|
112 | <dd></dd></dl> |
---|
113 | |
---|
114 | <dl class="method"> |
---|
115 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.freeze_axes"> |
---|
116 | <tt class="descname">freeze_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.freeze_axes" title="Permalink to this definition">¶</a></dt> |
---|
117 | <dd></dd></dl> |
---|
118 | |
---|
119 | <dl class="method"> |
---|
120 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.get_mask"> |
---|
121 | <tt class="descname">get_mask</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.get_mask" title="Permalink to this definition">¶</a></dt> |
---|
122 | <dd><p>return mask as a result of boxcut</p> |
---|
123 | </dd></dl> |
---|
124 | |
---|
125 | <dl class="method"> |
---|
126 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.get_params"> |
---|
127 | <tt class="descname">get_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.get_params" title="Permalink to this definition">¶</a></dt> |
---|
128 | <dd><p>Store a copy of values of parameters of the slicer into a dictionary.</p> |
---|
129 | <table class="docutils field-list" frame="void" rules="none"> |
---|
130 | <col class="field-name" /> |
---|
131 | <col class="field-body" /> |
---|
132 | <tbody valign="top"> |
---|
133 | <tr class="field"><th class="field-name">Return params:</th><td class="field-body">the dictionary created</td> |
---|
134 | </tr> |
---|
135 | </tbody> |
---|
136 | </table> |
---|
137 | </dd></dl> |
---|
138 | |
---|
139 | <dl class="method"> |
---|
140 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.move"> |
---|
141 | <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.boxMask.BoxMask.move" title="Permalink to this definition">¶</a></dt> |
---|
142 | <dd><p>Process move to a new position, making sure that the move is allowed.</p> |
---|
143 | </dd></dl> |
---|
144 | |
---|
145 | <dl class="method"> |
---|
146 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.moveend"> |
---|
147 | <tt class="descname">moveend</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.moveend" title="Permalink to this definition">¶</a></dt> |
---|
148 | <dd><p>After a dragging motion this function is called to compute |
---|
149 | the error and the sum of pixel of a given data 2D</p> |
---|
150 | </dd></dl> |
---|
151 | |
---|
152 | <dl class="method"> |
---|
153 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onClick"> |
---|
154 | <tt class="descname">onClick</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onClick" title="Permalink to this definition">¶</a></dt> |
---|
155 | <dd><p>Prepare to move the artist. Calls save() to preserve the state for |
---|
156 | later restore().</p> |
---|
157 | </dd></dl> |
---|
158 | |
---|
159 | <dl class="method"> |
---|
160 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onDrag"> |
---|
161 | <tt class="descname">onDrag</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onDrag" title="Permalink to this definition">¶</a></dt> |
---|
162 | <dd><p>Move the artist. Calls move() to update the state, or restore() if |
---|
163 | the mouse leaves the window.</p> |
---|
164 | </dd></dl> |
---|
165 | |
---|
166 | <dl class="method"> |
---|
167 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onHilite"> |
---|
168 | <tt class="descname">onHilite</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onHilite" title="Permalink to this definition">¶</a></dt> |
---|
169 | <dd><p>Hilite the artist reporting the event, indicating that it is |
---|
170 | ready to receive a click.</p> |
---|
171 | </dd></dl> |
---|
172 | |
---|
173 | <dl class="method"> |
---|
174 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onKey"> |
---|
175 | <tt class="descname">onKey</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onKey" title="Permalink to this definition">¶</a></dt> |
---|
176 | <dd><p>Respond to keyboard events. Arrow keys move the widget. Escape |
---|
177 | restores it to the position before the last click.</p> |
---|
178 | <p>Calls move() to update the state. Calls restore() on escape.</p> |
---|
179 | </dd></dl> |
---|
180 | |
---|
181 | <dl class="method"> |
---|
182 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onLeave"> |
---|
183 | <tt class="descname">onLeave</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onLeave" title="Permalink to this definition">¶</a></dt> |
---|
184 | <dd><p>Restore the artist to the original colour when the cursor leaves.</p> |
---|
185 | </dd></dl> |
---|
186 | |
---|
187 | <dl class="method"> |
---|
188 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onRelease"> |
---|
189 | <tt class="descname">onRelease</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.onRelease" title="Permalink to this definition">¶</a></dt> |
---|
190 | <dd></dd></dl> |
---|
191 | |
---|
192 | <dl class="method"> |
---|
193 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.restore"> |
---|
194 | <tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.restore" title="Permalink to this definition">¶</a></dt> |
---|
195 | <dd><p>Restore the roughness for this layer.</p> |
---|
196 | </dd></dl> |
---|
197 | |
---|
198 | <dl class="method"> |
---|
199 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.save"> |
---|
200 | <tt class="descname">save</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.save" title="Permalink to this definition">¶</a></dt> |
---|
201 | <dd><p>Remember the roughness for this layer and the next so that we |
---|
202 | can restore on Esc.</p> |
---|
203 | </dd></dl> |
---|
204 | |
---|
205 | <dl class="method"> |
---|
206 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.set_cursor"> |
---|
207 | <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.boxMask.BoxMask.set_cursor" title="Permalink to this definition">¶</a></dt> |
---|
208 | <dd></dd></dl> |
---|
209 | |
---|
210 | <dl class="method"> |
---|
211 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.set_params"> |
---|
212 | <tt class="descname">set_params</tt><big>(</big><em>params</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.set_params" title="Permalink to this definition">¶</a></dt> |
---|
213 | <dd><p>Receive a dictionary and reset the slicer with values contained |
---|
214 | in the values of the dictionary.</p> |
---|
215 | <table class="docutils field-list" frame="void" rules="none"> |
---|
216 | <col class="field-name" /> |
---|
217 | <col class="field-body" /> |
---|
218 | <tbody valign="top"> |
---|
219 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>params</strong> – a dictionary containing name of slicer parameters and |
---|
220 | values the user assigned to the slicer.</td> |
---|
221 | </tr> |
---|
222 | </tbody> |
---|
223 | </table> |
---|
224 | </dd></dl> |
---|
225 | |
---|
226 | <dl class="method"> |
---|
227 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.thaw_axes"> |
---|
228 | <tt class="descname">thaw_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.thaw_axes" title="Permalink to this definition">¶</a></dt> |
---|
229 | <dd></dd></dl> |
---|
230 | |
---|
231 | <dl class="method"> |
---|
232 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.update"> |
---|
233 | <tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask.update" title="Permalink to this definition">¶</a></dt> |
---|
234 | <dd><p>Respond to changes in the model by recalculating the profiles and |
---|
235 | resetting the widgets.</p> |
---|
236 | </dd></dl> |
---|
237 | |
---|
238 | </dd></dl> |
---|
239 | |
---|
240 | <dl class="class"> |
---|
241 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask"> |
---|
242 | <em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.boxMask.</tt><tt class="descname">inner_BoxMask</tt><big>(</big><em>base</em>, <em>axes</em>, <em>color='black'</em>, <em>zorder=3</em>, <em>side=None</em>, <em>x_min=0.0080000000000000002</em>, <em>x_max=0.0080000000000000002</em>, <em>y_min=0.0025000000000000001</em>, <em>y_max=0.0025000000000000001</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask" title="Permalink to this definition">¶</a></dt> |
---|
243 | <dd><p>Bases: <a class="reference internal" href="#sans.guiframe.local_perspectives.plotting.boxMask.BoxMask" title="sans.guiframe.local_perspectives.plotting.boxMask.BoxMask"><tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.boxMask.BoxMask</span></tt></a></p> |
---|
244 | <dl class="method"> |
---|
245 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.clear"> |
---|
246 | <tt class="descname">clear</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.clear" title="Permalink to this definition">¶</a></dt> |
---|
247 | <dd><p>Clear the slicer and all connected events related to this slicer</p> |
---|
248 | </dd></dl> |
---|
249 | |
---|
250 | <dl class="method"> |
---|
251 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.clear_markers"> |
---|
252 | <tt class="descname">clear_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.clear_markers" title="Permalink to this definition">¶</a></dt> |
---|
253 | <dd><p>Clear old markers and interfaces.</p> |
---|
254 | </dd></dl> |
---|
255 | |
---|
256 | <dl class="method"> |
---|
257 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.connect_markers"> |
---|
258 | <tt class="descname">connect_markers</tt><big>(</big><em>markers</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.connect_markers" title="Permalink to this definition">¶</a></dt> |
---|
259 | <dd><p>Connect markers to callbacks</p> |
---|
260 | </dd></dl> |
---|
261 | |
---|
262 | <dl class="method"> |
---|
263 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.dpixel"> |
---|
264 | <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.boxMask.inner_BoxMask.dpixel" title="Permalink to this definition">¶</a></dt> |
---|
265 | <dd><p>Return the step size in data coordinates for a small |
---|
266 | step in screen coordinates. If nudge is False (default) |
---|
267 | the step size is one pixel. If nudge is True, the step |
---|
268 | size is 0.2 pixels.</p> |
---|
269 | </dd></dl> |
---|
270 | |
---|
271 | <dl class="method"> |
---|
272 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.draw"> |
---|
273 | <tt class="descname">draw</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.draw" title="Permalink to this definition">¶</a></dt> |
---|
274 | <dd></dd></dl> |
---|
275 | |
---|
276 | <dl class="method"> |
---|
277 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.freeze_axes"> |
---|
278 | <tt class="descname">freeze_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.freeze_axes" title="Permalink to this definition">¶</a></dt> |
---|
279 | <dd></dd></dl> |
---|
280 | |
---|
281 | <dl class="method"> |
---|
282 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.get_mask"> |
---|
283 | <tt class="descname">get_mask</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.get_mask" title="Permalink to this definition">¶</a></dt> |
---|
284 | <dd><p>return mask as a result of boxcut</p> |
---|
285 | </dd></dl> |
---|
286 | |
---|
287 | <dl class="method"> |
---|
288 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.get_params"> |
---|
289 | <tt class="descname">get_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.get_params" title="Permalink to this definition">¶</a></dt> |
---|
290 | <dd><p>Store a copy of values of parameters of the slicer into a dictionary.</p> |
---|
291 | <table class="docutils field-list" frame="void" rules="none"> |
---|
292 | <col class="field-name" /> |
---|
293 | <col class="field-body" /> |
---|
294 | <tbody valign="top"> |
---|
295 | <tr class="field"><th class="field-name">Return params:</th><td class="field-body">the dictionary created</td> |
---|
296 | </tr> |
---|
297 | </tbody> |
---|
298 | </table> |
---|
299 | </dd></dl> |
---|
300 | |
---|
301 | <dl class="method"> |
---|
302 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.move"> |
---|
303 | <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.boxMask.inner_BoxMask.move" title="Permalink to this definition">¶</a></dt> |
---|
304 | <dd><p>Process move to a new position, making sure that the move is allowed.</p> |
---|
305 | </dd></dl> |
---|
306 | |
---|
307 | <dl class="method"> |
---|
308 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.moveend"> |
---|
309 | <tt class="descname">moveend</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.moveend" title="Permalink to this definition">¶</a></dt> |
---|
310 | <dd><p>After a dragging motion this function is called to compute |
---|
311 | the error and the sum of pixel of a given data 2D</p> |
---|
312 | </dd></dl> |
---|
313 | |
---|
314 | <dl class="method"> |
---|
315 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onClick"> |
---|
316 | <tt class="descname">onClick</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onClick" title="Permalink to this definition">¶</a></dt> |
---|
317 | <dd><p>Prepare to move the artist. Calls save() to preserve the state for |
---|
318 | later restore().</p> |
---|
319 | </dd></dl> |
---|
320 | |
---|
321 | <dl class="method"> |
---|
322 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onDrag"> |
---|
323 | <tt class="descname">onDrag</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onDrag" title="Permalink to this definition">¶</a></dt> |
---|
324 | <dd><p>Move the artist. Calls move() to update the state, or restore() if |
---|
325 | the mouse leaves the window.</p> |
---|
326 | </dd></dl> |
---|
327 | |
---|
328 | <dl class="method"> |
---|
329 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onHilite"> |
---|
330 | <tt class="descname">onHilite</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onHilite" title="Permalink to this definition">¶</a></dt> |
---|
331 | <dd><p>Hilite the artist reporting the event, indicating that it is |
---|
332 | ready to receive a click.</p> |
---|
333 | </dd></dl> |
---|
334 | |
---|
335 | <dl class="method"> |
---|
336 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onKey"> |
---|
337 | <tt class="descname">onKey</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onKey" title="Permalink to this definition">¶</a></dt> |
---|
338 | <dd><p>Respond to keyboard events. Arrow keys move the widget. Escape |
---|
339 | restores it to the position before the last click.</p> |
---|
340 | <p>Calls move() to update the state. Calls restore() on escape.</p> |
---|
341 | </dd></dl> |
---|
342 | |
---|
343 | <dl class="method"> |
---|
344 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onLeave"> |
---|
345 | <tt class="descname">onLeave</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onLeave" title="Permalink to this definition">¶</a></dt> |
---|
346 | <dd><p>Restore the artist to the original colour when the cursor leaves.</p> |
---|
347 | </dd></dl> |
---|
348 | |
---|
349 | <dl class="method"> |
---|
350 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onRelease"> |
---|
351 | <tt class="descname">onRelease</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.onRelease" title="Permalink to this definition">¶</a></dt> |
---|
352 | <dd></dd></dl> |
---|
353 | |
---|
354 | <dl class="method"> |
---|
355 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.restore"> |
---|
356 | <tt class="descname">restore</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.restore" title="Permalink to this definition">¶</a></dt> |
---|
357 | <dd><p>Restore the roughness for this layer.</p> |
---|
358 | </dd></dl> |
---|
359 | |
---|
360 | <dl class="method"> |
---|
361 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.save"> |
---|
362 | <tt class="descname">save</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.save" title="Permalink to this definition">¶</a></dt> |
---|
363 | <dd><p>Remember the roughness for this layer and the next so that we |
---|
364 | can restore on Esc.</p> |
---|
365 | </dd></dl> |
---|
366 | |
---|
367 | <dl class="method"> |
---|
368 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.set_cursor"> |
---|
369 | <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.boxMask.inner_BoxMask.set_cursor" title="Permalink to this definition">¶</a></dt> |
---|
370 | <dd></dd></dl> |
---|
371 | |
---|
372 | <dl class="method"> |
---|
373 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.set_params"> |
---|
374 | <tt class="descname">set_params</tt><big>(</big><em>params</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.set_params" title="Permalink to this definition">¶</a></dt> |
---|
375 | <dd><p>Receive a dictionary and reset the slicer with values contained |
---|
376 | in the values of the dictionary.</p> |
---|
377 | <table class="docutils field-list" frame="void" rules="none"> |
---|
378 | <col class="field-name" /> |
---|
379 | <col class="field-body" /> |
---|
380 | <tbody valign="top"> |
---|
381 | <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>params</strong> – a dictionary containing name of slicer parameters and |
---|
382 | values the user assigned to the slicer.</td> |
---|
383 | </tr> |
---|
384 | </tbody> |
---|
385 | </table> |
---|
386 | </dd></dl> |
---|
387 | |
---|
388 | <dl class="method"> |
---|
389 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.thaw_axes"> |
---|
390 | <tt class="descname">thaw_axes</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.thaw_axes" title="Permalink to this definition">¶</a></dt> |
---|
391 | <dd></dd></dl> |
---|
392 | |
---|
393 | <dl class="method"> |
---|
394 | <dt id="sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.update"> |
---|
395 | <tt class="descname">update</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.boxMask.inner_BoxMask.update" title="Permalink to this definition">¶</a></dt> |
---|
396 | <dd><p>Respond to changes in the model by recalculating the profiles and |
---|
397 | resetting the widgets.</p> |
---|
398 | </dd></dl> |
---|
399 | |
---|
400 | </dd></dl> |
---|
401 | |
---|
402 | </div> |
---|
403 | </div> |
---|
404 | |
---|
405 | |
---|
406 | </div> |
---|
407 | </div> |
---|
408 | </div> |
---|
409 | <div class="sphinxsidebar"> |
---|
410 | <div class="sphinxsidebarwrapper"> |
---|
411 | <h3><a href="../../../index.html">Table Of Contents</a></h3> |
---|
412 | <ul> |
---|
413 | <li><a class="reference internal" href="#">boxMask</a><ul> |
---|
414 | <li><a class="reference internal" href="#module-sans.guiframe.local_perspectives.plotting.boxMask"><tt class="docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.boxMask</span></tt></a></li> |
---|
415 | </ul> |
---|
416 | </li> |
---|
417 | </ul> |
---|
418 | |
---|
419 | <h4>Previous topic</h4> |
---|
420 | <p class="topless"><a href="binder.html" |
---|
421 | title="previous chapter">binder</a></p> |
---|
422 | <h4>Next topic</h4> |
---|
423 | <p class="topless"><a href="boxSlicer.html" |
---|
424 | title="next chapter">boxSlicer</a></p> |
---|
425 | <h3>This Page</h3> |
---|
426 | <ul class="this-page-menu"> |
---|
427 | <li><a href="../../../_sources/api/local_perspectives/plotting/boxMask.txt" |
---|
428 | rel="nofollow">Show Source</a></li> |
---|
429 | </ul> |
---|
430 | <div id="searchbox" style="display: none"> |
---|
431 | <h3>Quick search</h3> |
---|
432 | <form class="search" action="../../../search.html" method="get"> |
---|
433 | <input type="text" name="q" size="18" /> |
---|
434 | <input type="submit" value="Go" /> |
---|
435 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
436 | <input type="hidden" name="area" value="default" /> |
---|
437 | </form> |
---|
438 | <p class="searchtip" style="font-size: 90%"> |
---|
439 | Enter search terms or a module, class or function name. |
---|
440 | </p> |
---|
441 | </div> |
---|
442 | <script type="text/javascript">$('#searchbox').show(0);</script> |
---|
443 | </div> |
---|
444 | </div> |
---|
445 | <div class="clearer"></div> |
---|
446 | </div> |
---|
447 | <div class="related"> |
---|
448 | <h3>Navigation</h3> |
---|
449 | <ul> |
---|
450 | <li class="right" style="margin-right: 10px"> |
---|
451 | <a href="../../../genindex.html" title="General Index" |
---|
452 | >index</a></li> |
---|
453 | <li class="right" > |
---|
454 | <a href="../../../py-modindex.html" title="Python Module Index" |
---|
455 | >modules</a> |</li> |
---|
456 | <li class="right" > |
---|
457 | <a href="boxSlicer.html" title="boxSlicer" |
---|
458 | >next</a> |</li> |
---|
459 | <li class="right" > |
---|
460 | <a href="binder.html" title="binder" |
---|
461 | >previous</a> |</li> |
---|
462 | <li><a href="../../../index.html">guiframe v0.1.0 documentation</a> »</li> |
---|
463 | <li><a href="index.html" >Local Perspective: plotting</a> »</li> |
---|
464 | </ul> |
---|
465 | </div> |
---|
466 | <div class="footer"> |
---|
467 | © Copyright 2010, sans group. |
---|
468 | Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. |
---|
469 | </div> |
---|
470 | </body> |
---|
471 | </html> |
---|