% @(#)extraccurs.hlq	17.1.1.1 (ESO-IPG) 01/25/02 17:43:34 
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
%.COPYRIGHT  (c)  1990 European Southern Observatory
%.IDENT      extraccurs.hlq
%.AUTHOR     KB, IPG/ESO
%.KEYWORDS   MIDAS, help files, EXTRACT/CURSOR
%.PURPOSE    On-line help file for the command: EXTRACT/CURSOR
%.VERSION    1.0  14-FEB-1985 : Creation, KB
%.VERSION    1.1  11-OCT-1991 : Update, KB
%----------------------------------------------------------------
\se
SECTION./CURS
\es\co
EXTRACT/CURSOR						23-FEB-1994   KB
\oc\su
EXTRACT/CURSOR [subfr] [xpx,ypx] [loop_flag]
	extract a subframe via cursor
\us\pu
Purpose:
          Extract a subframe from the frame currently displayed on the
          ImageDisplay.
\up\sy
Syntax: 
          EXTRACT/CURSOR [subfr] [xpx,ypx] [loop_flag]
\ys\pa
          subfr =   name of extracted subframe, defaulted to 'subframe.bdf'
\ap\pa
          xpx,ypx = no. of pixels in x, y dimension.
\\
                If omitted, a cursor rectangle will be used to determine 
                the center and the actual size of the subframe.
\\
                If given, a single cursor will be used to determine the 
                center of the subframe, its dimensions being determined by 
                xpx,ypx and the actual size of the extracted subframe will
                be drawn in the overlay plane.
\ap\pa
          loop_flag = Loop or NoLoop, if set to Loop more than one subframe
                can be extracted (until you press the ExitButton), then the
                param. `subfr' is used as the root for creating names like
                subfr0001.bdf, subfr0002.bdf, ... for the extracted frames;
\\
                defaulted to NoLoop
\ap\sa
See also:
          EXTRACT/IMAGE, EXTRACT/LINE, EXTRACT/SLIT, EXTRACT/ROTATED_IMAGE
\\
          GET/CURSOR
\as\no
Note: 
          Warning: if the name of the subframe is equal to the name of the
          displayed frame, this frame will be overwritten.
\\
          For a description of how to move and modify the cursor rectangle
          use HELP [ImageDisplay].
\on\exs
Examples:
\ex
          EXTRACT/CURS delicias
            Extract from displayed frame the subframe indicated by the cursor
            rectangle and store it into frame `delicias.bdf'
\xe\ex
          EXTRACT/CURS torreon 100,12
            Extract from displayed frame the subframe centered at cursor
            position, size will be 100 pixels in x-direction and 12 pixels
            in y-direction; finally store it into `torreon.bdf'.
\xe\ex
          EXTRACT/CURS juarez 8,8 LOOP
            Extract from displayed frame the subframes juarez0001.bdf,
            juarez0002.bdf, ... each centered at current cursor position,
            and with size = 8x8 pixels.
\xe\ex
          EXTRACT/CURS chihuahua
            We assume, that frame `chihuahua.bdf' is displayed.
            Proceed as in the first example, but overwrite the frame named
            `chihuahua.bdf' (no new file version will be created for VMS)
\xe \sxe