% @(#)modifyarea.hlq	19.1 (ESO-IPG) 02/25/03 14:03:29 
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
%.COPYRIGHT  (c)  1990 European Southern Observatory
%.IDENT      modifyarea.hlq
%.AUTHOR     KB, IPG/ESO
%.KEYWORDS   MIDAS, help files, MODIFY/AREA
%.PURPOSE    On-line help file for the command: MODIFY/AREA
%.VERSION    1.0  23-SEP-1988 : Creation, KB
%----------------------------------------------------------------
\se
SECTION./AREA
\es\co
MODIFY/AREA					20-OCT-1998  KB
\oc\su
MODIFY/AREA  [source] [resfram] [degree] [constant] [drawflg]
	remove bad data from a circular pixel-area in an image
\us\pu
Purpose:  
          Remove bad data from a circular pixel-area in an image.
\up\sy
Syntax:
          MODIFY/AREA  [source] [resfram] [degree] [constant] [drawflg]
\ys\pa
          source = specifies how the pixel areas we modify will be defined:
\\
               (a) CURSOR to use displayed frame + cursor rectangle to define
                   pixel areas which are to be modified
\\
               (b) frame,table[,flag] to use frame + table to define areas,
                     flag: PIXEL may be appended in order to work with frame
                     pixels otherwise world coordinates of the input frame
                     will be used - see the Notes for column labels;
\\
                     by default `flag' is omitted, i.e. we use world coords.
\\
               (c) frame  to first load that frame into the display and then
                   use the CURSOR option;
\\
               defaulted to CURSOR (a)
\ap\pa
          resfram = name of result frame, will be a copy of the input frame
               except for the "cleaned" areas;
\\
               defaulted to input frame or displayed frame
\ap\pa
          degree = degree of fitting surface (0,1 or 2); defaulted to 2
\ap\pa
          constant = constant in case of degree = 0 (otherwise not used);
\\
               defaulted to 0.
\ap\pa
          drawflg = 1, the cursor defined rectangle is also put into the
               overlay channel,
\\
               2, the modified area is loaded immediately after into the image
               display,
\\
               3, 1 and 2 above,
\\
               0, nothing of the above; 
\\
               defaulted to 3 for parameter `source' = (a), (c);
\\
               defaulted to 0 for parameter `source' = (b)
\ap\sa
See also:
          MODIFY/PIXEL, MODIFY/ROW, MODIFY/COLUMN, REPLACE/IMAGE
\as\no
Note:  
          For `source' = (a) or (c) a cursor rectangle will appear on the 
             image display.
\\
             Use the mouse to move the rectangle and the arrow keys to adjust
             its size. Press the ENTER button on the mouse. 
             To exit press the EXIT button.
\\
          For `source' = (b) the table columns labeled :XSTART, :XEND,
             :YSTART and :YEND containing world coords. must exist and are 
             used to define the areas.
\\
             If table flag is set to PIXEL then the columns labeled :XSTARTPIX,
             :XENDPIX, :YSTARTPIX and :YENDPIX containing frame pixels are 
             used, instead.
\\
             All the columns specified above are e.g. created in the command
             GET/CURSOR with table output.
\\
             For frames with a non-linear world coord-system the PIXEL option
             should be used!
\\
          All pixels inside the circle defined by the cursor_rectangle or table
          entry will be replaced by a 2-dim fitted surface.
\\
          Currently, the command is NOT working on 1-dim images.
\on\exs
Examples:
\ex
          MODIFY/AREA cursor sunshine
            Use the cursor_rectangle to define the pixel area(s) in the 
            displayed frame and put results into frame `sunshine.bdf'.
\xe\ex
          MODIFY/AREA rainbow,cloud sunshine
            Obtain from the columns :XSTART, :XEND, :YSTART and :YEND 
            of table `cloud.tbl' the world coords for area(s) of frame
            `rainbow.bdf' and put results into frame `sunshine.bdf'
\xe\ex
          MODIFY/AREA rainbow,fog,pixel sunshine
            Obtain from the columns :XSTARTPIX, :XENDPIX, :YSTARTPIX and
            :YENDPIX of table `fog.tbl' the pixel area(s) of FORS frame 
            `rainbow.bdf' (which has a non-linear world coord-sys) and put 
            results into frame `sunshine.bdf'
\xe\ex
          MODIFY/AREA rainbow hail
            Load frame `rainbow.bdf' into the image display. Then, use the
            cursor rectangle to define the pixel area(s) in the displayed 
            frame and put results into frame `hail.bdf'.
\xe \sxe
