./plotter
click.pro

Last modification date:

Wed Sep 28 13:27:10 2016

click

function click([frame=string], [veldef=string], [/nocrosshair], [/noshow], [label=string])

Get cursor position when the user presses a mouse button. Positions are translated to include channels, frequency, and velocity in the requested reference frame and velocity definition. The return value is a named structure (cvfstruct) containing the following fields:

• x The x value in the data coordinates.
• y The y value in the data coordinates.
• xdevice The x value in device coordinates.
• ydevice The y value in device coordinates.
• button The button pressed (1=left,2=middle,4=right).
• chan The channel number corresponding to x. frame with the voffset.
• velo The velocity (m/s) corresponding to x in frame using veldef and voffset.
• frame The supplied frame argument, defaults to the current frame in the plotter.
• veldef The veldef argument (velocity definition), defaults to the current velocity definition in the plotter.
• voffset The velocity offset (in frame and veldef) as found in the plotter.
• ok If everything went fine, this is 1, otherwise it's 0.

Returns

cfvstruct structure as described above.

Examples

 print,click()
 ; or
 c = click()
 v = c.velo ; velocity at frame and velocity definition in header
 

Uses

chantofreq chantovel freqtochan gbtcursor

Version

$Id$

Common blocks

gbtplot_common

Keywords
frame in, optional string	The desired reference frame for the velocity and frequency values. The list of possible choices can be found in the documentation for frame_velocity. This defaults to the frame currently in use in the plotter.
veldef in, optional string	The velocity definition to use in converting the cursor x position. This must be one of OPTICAL, RADIO or TRUE. This defaults to the veldef currently in use in the plotter.
nocrosshair in, optional boolean	When set, this function will ensure that the plotter's crosshair is on until the click is received. At that point, the plotter's crosshair will be returned to its state before click was invoked. If not set, the plotters crosshair state will not be changed.
noshow in, optional boolean	If set, then the plotter will not be brought to the foreground (shown).
label in, optional string	A label to use in the "Left Click:" field of the plotter. Defaults to "Click a Mouse Button".