Ignore:
Timestamp:
Oct 24, 2011 2:43:40 PM (13 years ago)
Author:
Gervaise Alina <gervyh@…>
Branches:
master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
67cd7c0
Parents:
70ecd530
Message:

sphinx build

File:
1 edited

Legend:

Unmodified
Added
Removed

  • sansguiframe/docs/sphinx/html/api/local_perspectives/plotting/sectorMask.html

    r96cbb53 rbce8148  
    33<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
    44  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 
     5 
    56 
    67<html xmlns="http://www.w3.org/1999/xhtml"> 
    … …  
    89    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 
    910     
    10     <title>sectorMask &mdash; guiframe v0.1.0 documentation</title> 
     11    <title>sectorMask &mdash; guiframe 0.1.0 documentation</title> 
     12     
    1113    <link rel="stylesheet" href="../../../_static/default.css" type="text/css" /> 
    1214    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> 
     15     
    1316    <script type="text/javascript"> 
    1417      var DOCUMENTATION_OPTIONS = { 
    … …  
    2326    <script type="text/javascript" src="../../../_static/underscore.js"></script> 
    2427    <script type="text/javascript" src="../../../_static/doctools.js"></script> 
    25     <link rel="top" title="guiframe v0.1.0 documentation" href="../../../index.html" /> 
     28    <link rel="top" title="guiframe 0.1.0 documentation" href="../../../index.html" /> 
    2629    <link rel="up" title="Local Perspective: plotting" href="index.html" /> 
    2730    <link rel="next" title="SectorSlicer" href="SectorSlicer.html" /> 
    … …  
    4447          <a href="profile_dialog.html" title="profile_dialog" 
    4548             accesskey="P">previous</a> |</li> 
    46         <li><a href="../../../index.html">guiframe v0.1.0 documentation</a> &raquo;</li> 
     49        <li><a href="../../../index.html">guiframe 0.1.0 documentation</a> &raquo;</li> 
    4750          <li><a href="index.html" accesskey="U">Local Perspective: plotting</a> &raquo;</li>  
    4851      </ul> 
    … …  
    5659  <div class="section" id="sectormask"> 
    5760<h1>sectorMask<a class="headerlink" href="#sectormask" title="Permalink to this headline">¶</a></h1> 
    58 <div class="section" id="module-sans.guiframe.local_perspectives.plotting.sectorMask"> 
    59 <span id="sans-guiframe-local-perspectives-plotting-sectormask"></span><h2><a class="reference internal" href="#module-sans.guiframe.local_perspectives.plotting.sectorMask" title="sans.guiframe.local_perspectives.plotting.sectorMask"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.sectorMask</span></tt></a><a class="headerlink" href="#module-sans.guiframe.local_perspectives.plotting.sectorMask" title="Permalink to this headline">¶</a></h2> 
    60 <dl class="class"> 
     61<div class="section" id="sans-guiframe-local-perspectives-plotting-sectormask"> 
     62<h2><a class="reference internal" href="#module-sans.guiframe.local_perspectives.plotting.sectorMask" title="sans.guiframe.local_perspectives.plotting.sectorMask"><tt class="xref py py-mod docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.sectorMask</span></tt></a><a class="headerlink" href="#sans-guiframe-local-perspectives-plotting-sectormask" title="Permalink to this headline">¶</a></h2> 
     63<span class="target" id="module-sans.guiframe.local_perspectives.plotting.sectorMask"></span><dl class="class"> 
    6164<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask"> 
    62 <em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.sectorMask.</tt><tt class="descname">SectorMask</tt><big>(</big><em>base</em>, <em>axes</em>, <em>color='gray'</em>, <em>zorder=3</em>, <em>side=False</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask" 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> 
     65<em class="property">class </em><tt class="descclassname">sans.guiframe.local_perspectives.plotting.sectorMask.</tt><tt class="descname">SectorMask</tt><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask" title="Permalink to this definition">¶</a></dt> 
     66<dd><p>Bases: <a class="reference internal" href="BaseInteractor.html#sans.guiframe.local_perspectives.plotting.BaseInteractor._BaseInteractor" title="sans.guiframe.local_perspectives.plotting.BaseInteractor._BaseInteractor"><tt class="xref py py-class docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.BaseInteractor._BaseInteractor</span></tt></a></p> 
    6467<p>Draw a sector slicer.Allow to find the data 2D inside of the sector lines</p> 
     68<dl class="method"> 
     69<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.__init__"> 
     70<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.__init__" title="Permalink to this definition">¶</a></dt> 
     71<dd></dd></dl> 
     72 
     73<dl class="attribute"> 
     74<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.__module__"> 
     75<tt class="descname">__module__</tt><em class="property"> = 'sans.guiframe.local_perspectives.plotting.sectorMask'</em><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.__module__" title="Permalink to this definition">¶</a></dt> 
     76<dd></dd></dl> 
     77 
     78<dl class="method"> 
     79<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask._post_data"> 
     80<tt class="descname">_post_data</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask._post_data" title="Permalink to this definition">¶</a></dt> 
     81<dd><p>compute sector averaging of data into data1D</p> 
     82</dd></dl> 
     83 
    6584<dl class="method"> 
    6685<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.clear"> 
    … …  
    7796<dl class="method"> 
    7897<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.connect_markers"> 
    79 <tt class="descname">connect_markers</tt><big>(</big><em>markers</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.connect_markers" title="Permalink to this definition">¶</a></dt> 
     98<tt class="descname">connect_markers</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.connect_markers" title="Permalink to this definition">¶</a></dt> 
    8099<dd><p>Connect markers to callbacks</p> 
    81100</dd></dl> 
    … …  
    83102<dl class="method"> 
    84103<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.dpixel"> 
    85 <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.sectorMask.SectorMask.dpixel" title="Permalink to this definition">¶</a></dt> 
     104<tt class="descname">dpixel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.dpixel" title="Permalink to this definition">¶</a></dt> 
    86105<dd><p>Return the step size in data coordinates for a small 
    87106step in screen coordinates.  If nudge is False (default) 
    … …  
    108127<col class="field-body" /> 
    109128<tbody valign="top"> 
    110 <tr class="field"><th class="field-name">Return params:</th><td class="field-body">the dictionary created</td> 
     129<tr class="field-odd field"><th class="field-name">Return params:</th><td class="field-body">the dictionary created</td> 
    111130</tr> 
    112131</tbody> 
    … …  
    116135<dl class="method"> 
    117136<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.move"> 
    118 <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.sectorMask.SectorMask.move" title="Permalink to this definition">¶</a></dt> 
     137<tt class="descname">move</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.move" title="Permalink to this definition">¶</a></dt> 
    119138<dd><p>Process move to a new position, making sure that the move is allowed.</p> 
    120139</dd></dl> 
    … …  
    122141<dl class="method"> 
    123142<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.moveend"> 
    124 <tt class="descname">moveend</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.moveend" title="Permalink to this definition">¶</a></dt> 
     143<tt class="descname">moveend</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.moveend" title="Permalink to this definition">¶</a></dt> 
    125144<dd><p>Called a dragging motion ends.Get slicer event</p> 
    126145</dd></dl> 
    … …  
    128147<dl class="method"> 
    129148<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onClick"> 
    130 <tt class="descname">onClick</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onClick" title="Permalink to this definition">¶</a></dt> 
     149<tt class="descname">onClick</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onClick" title="Permalink to this definition">¶</a></dt> 
    131150<dd><p>Prepare to move the artist.  Calls save() to preserve the state for 
    132151later restore().</p> 
    … …  
    135154<dl class="method"> 
    136155<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onDrag"> 
    137 <tt class="descname">onDrag</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onDrag" title="Permalink to this definition">¶</a></dt> 
     156<tt class="descname">onDrag</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onDrag" title="Permalink to this definition">¶</a></dt> 
    138157<dd><p>Move the artist.  Calls move() to update the state, or restore() if 
    139158the mouse leaves the window.</p> 
    … …  
    142161<dl class="method"> 
    143162<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onHilite"> 
    144 <tt class="descname">onHilite</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onHilite" title="Permalink to this definition">¶</a></dt> 
     163<tt class="descname">onHilite</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onHilite" title="Permalink to this definition">¶</a></dt> 
    145164<dd><p>Hilite the artist reporting the event, indicating that it is 
    146165ready to receive a click.</p> 
    … …  
    149168<dl class="method"> 
    150169<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onKey"> 
    151 <tt class="descname">onKey</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onKey" title="Permalink to this definition">¶</a></dt> 
     170<tt class="descname">onKey</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onKey" title="Permalink to this definition">¶</a></dt> 
    152171<dd><p>Respond to keyboard events.  Arrow keys move the widget.  Escape 
    153172restores it to the position before the last click.</p> 
    … …  
    157176<dl class="method"> 
    158177<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onLeave"> 
    159 <tt class="descname">onLeave</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onLeave" title="Permalink to this definition">¶</a></dt> 
     178<tt class="descname">onLeave</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onLeave" title="Permalink to this definition">¶</a></dt> 
    160179<dd><p>Restore the artist to the original colour when the cursor leaves.</p> 
    161180</dd></dl> 
    … …  
    163182<dl class="method"> 
    164183<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onRelease"> 
    165 <tt class="descname">onRelease</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onRelease" title="Permalink to this definition">¶</a></dt> 
     184<tt class="descname">onRelease</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.onRelease" title="Permalink to this definition">¶</a></dt> 
    166185<dd></dd></dl> 
    167186 
    … …  
    174193<dl class="method"> 
    175194<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.save"> 
    176 <tt class="descname">save</tt><big>(</big><em>ev</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.save" title="Permalink to this definition">¶</a></dt> 
     195<tt class="descname">save</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.save" title="Permalink to this definition">¶</a></dt> 
    177196<dd><p>Remember the roughness for this layer and the next so that we 
    178197can restore on Esc.</p> 
    … …  
    181200<dl class="method"> 
    182201<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.set_cursor"> 
    183 <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.sectorMask.SectorMask.set_cursor" title="Permalink to this definition">¶</a></dt> 
     202<tt class="descname">set_cursor</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.set_cursor" title="Permalink to this definition">¶</a></dt> 
    184203<dd></dd></dl> 
    185204 
    186205<dl class="method"> 
    187206<dt id="sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.set_params"> 
    188 <tt class="descname">set_params</tt><big>(</big><em>params</em><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.set_params" title="Permalink to this definition">¶</a></dt> 
     207<tt class="descname">set_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.guiframe.local_perspectives.plotting.sectorMask.SectorMask.set_params" title="Permalink to this definition">¶</a></dt> 
    189208<dd><p>Receive a dictionary and reset the slicer with values contained  
    190209in the values of the dictionary.</p> 
    … …  
    193212<col class="field-body" /> 
    194213<tbody valign="top"> 
    195 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>params</strong> &#8211; a dictionary containing name of slicer parameters and  
     214<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>params</strong> &#8211; a dictionary containing name of slicer parameters and  
    196215values the user assigned to the slicer.</td> 
    197216</tr> 
    … …  
    226245  <ul> 
    227246<li><a class="reference internal" href="#">sectorMask</a><ul> 
    228 <li><a class="reference internal" href="#module-sans.guiframe.local_perspectives.plotting.sectorMask"><tt class="docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.sectorMask</span></tt></a></li> 
     247<li><a class="reference internal" href="#sans-guiframe-local-perspectives-plotting-sectormask"><tt class="docutils literal"><span class="pre">sans.guiframe.local_perspectives.plotting.sectorMask</span></tt></a></li> 
    229248</ul> 
    230249</li> 
    … …  
    245264  <h3>Quick search</h3> 
    246265    <form class="search" action="../../../search.html" method="get"> 
    247       <input type="text" name="q" size="18" /> 
     266      <input type="text" name="q" /> 
    248267      <input type="submit" value="Go" /> 
    249268      <input type="hidden" name="check_keywords" value="yes" /> 
    … …  
    274293          <a href="profile_dialog.html" title="profile_dialog" 
    275294             >previous</a> |</li> 
    276         <li><a href="../../../index.html">guiframe v0.1.0 documentation</a> &raquo;</li> 
     295        <li><a href="../../../index.html">guiframe 0.1.0 documentation</a> &raquo;</li> 
    277296          <li><a href="index.html" >Local Perspective: plotting</a> &raquo;</li>  
    278297      </ul> 
    … …  
    280299    <div class="footer"> 
    281300        &copy; Copyright 2010, sans group. 
    282       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7. 
     301      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1. 
    283302    </div> 
    284303  </body> 
Note: See TracChangeset for help on using the changeset viewer.