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