Changeset 133 for trunk/SRC/Picture/imdisp.pro

Timestamp:

07/07/06 11:57:27 (18 years ago)

Author:

navarro

Message:

english and nicer header (1)

Location:

trunk/SRC/Picture

Files:

• . (added)
• imdisp.pro (moved) (moved from trunk/SRC/ToBeReviewed/IMAGE/imdisp.pro) (12 diffs)

trunk/SRC/Picture/imdisp.pro

@@ -1 +1 @@
 ;-------------------------------------------------------------------------------
+;+
+; @hidden
+;-
 FUNCTION IMDISP_GETPOS, ASPECT, POSITION=POSITION, MARGIN=MARGIN
 ;
@@ -47 +50 @@
 END
 ;-------------------------------------------------------------------------------
+;+
+; @hidden
+;-
 FUNCTION IMDISP_IMSCALE, IMAGE, RANGE=RANGE, BOTTOM=BOTTOM, NCOLORS=NCOLORS, $
   NEGATIVE=NEGATIVE
@@ -78 +84 @@
 END
 ;-------------------------------------------------------------------------------
+;+
+; @hidden
+;-
 FUNCTION IMDISP_IMREGRID, DATA, NX, NY, INTERP=INTERP
 ;
@@ -119 +128 @@
 END
 ;-------------------------------------------------------------------------------
+;+
+; @hidden
+;-
 PRO IMDISP_IMSIZE, IMAGE, X0, Y0, XSIZE, YSIZE, ASPECT=ASPECT, $
   POSITION=POSITION, MARGIN=MARGIN
@@ -176 +188 @@
 
 END
-;-------------------------------------------------------------------------------
-PRO IMDISP, IMAGE, RANGE=RANGE, BOTTOM=BOTTOM, NCOLORS=NCOLORS, $
-  MARGIN=MARGIN, INTERP=INTERP, DITHER=DITHER, ASPECT=ASPECT, $
-  POSITION=POSITION, OUT_POS=OUT_POS, NOSCALE=NOSCALE, NORESIZE=NORESIZE, $
-  ORDER=ORDER, USEPOS=USEPOS, CHANNEL=CHANNEL, $
-  BACKGROUND=BACKGROUND, ERASE=ERASE, $
-  AXIS=AXIS, NEGATIVE=NEGATIVE, _EXTRA=EXTRA_KEYWORDS
-;
-  compile_opt idl2, strictarrsubs
-;
-
+;*******************************************************************************
 ;+
-; NAME:
-;    IMDISP
-;
-; PURPOSE:
+;
+; @file_comments 
 ;    Display an image on the current graphics device.
 ;    IMDISP is an advanced replacement for TV and TVSCL.
@@ -214 +214 @@
 ;    - Photographic negative images can be displayed via the NEGATIVE keyword.
 ;
-; CATEGORY:
-;    Image display
-;
-; CALLING SEQUENCE:
-;    IMDISP, IMAGE
-;
-; INPUTS:
-;    IMAGE       Array containing image data.
+; @categories Image display
+;
+; @param IMAGE {in}{required} Array containing image data.
 ;                Pseudo (indexed) color images must have 2 dimensions.
 ;                True color images must have 3 dimensions, in either
 ;                [3, NX, NY], [NX, 3, NY], or [NX, NY, 3] form.
 ;
-; OPTIONAL INPUTS:
-;    None.
-;
-; KEYWORD PARAMETERS:
-;    RANGE       For Pseudo Color images only, a vector with two elements
+; @keyword RANGE For Pseudo Color images only, a vector with two elements
 ;                specifying the minimum and maximum values of the image
 ;                array to be considered when the image is byte-scaled
@@ -237 +228 @@
 ;                or if the NOSCALE keyword is set.
 ;
-;    BOTTOM      Bottom value in the color table to be used
+; @keyword BOTTOM Bottom value in the color table to be used
 ;                for the byte-scaled image
 ;                (default is 0).
 ;                This keyword is ignored if the NOSCALE keyword is set.
 ;
-;    NCOLORS     Number of colors in the color table to be used
+; @keyword NCOLORS Number of colors in the color table to be used
 ;                for the byte-scaled image
 ;                (default is !D.TABLE_SIZE - BOTTOM).
 ;                This keyword is ignored if the NOSCALE keyword is set.
 ;
-;    MARGIN      A scalar value specifying the margin to be maintained
+; @keyword MARGIN A scalar value specifying the margin to be maintained
 ;                around the image in normal coordinates
 ;                (default is 0.1, or 0.025 if !P.MULTI is set to display
 ;                multiple images).
 ;
-;    INTERP      If set, the resized image will be interpolated using
+; @keyword INTERP If set, the resized image will be interpolated using
 ;                bilinear interpolation
 ;                (default is nearest neighbor sampling).
 ;
-;    DITHER      If set, true color images will be dithered when displayed
+; @keyword DITHER If set, true color images will be dithered when displayed
 ;                on an 8-bit graphics device
 ;                (default is no dithering).
 ;
-;    ASPECT      A scalar value specifying the aspect ratio (height/width)
+; @keyword ASPECT A scalar value specifying the aspect ratio (height/width)
 ;                for the displayed image
 ;                (default is to maintain native aspect ratio).
 ;
-;    POSITION    On input, a 4-element vector specifying the position
+; @keyword POSITION On input, a 4-element vector specifying the position
 ;                of the displayed image in the form [X0,Y0,X1,Y1] in
 ;                in normal coordinates
@@ -271 +262 @@
 ;                offset and size are known (e.g. MAP_IMAGE output).
 ;
-;    OUT_POS     On output, a 4-element vector specifying the position
+; @keyword OUT_POS On output, a 4-element vector specifying the position
 ;                actually used to display the image.
 ;
-;    NOSCALE     If set, the image will not be byte-scaled
+; @keyword NOSCALE If set, the image will not be byte-scaled
 ;                (default is to byte-scale the image).
 ;
-;    NORESIZE    If set, the image will not be resized.
+; @keyword NORESIZE If set, the image will not be resized.
 ;                (default is to resize the image to fit the display).
 ;
-;    ORDER       If set, the image is displayed from the top down
+; @keyword ORDER If set, the image is displayed from the top down
 ;                (default is to display the image from the bottom up).
 ;                Note that the system variable !ORDER is always ignored.
 ;
-;    USEPOS      If set, the image will be sized to exactly fit a supplied
+; @keyword USEPOS If set, the image will be sized to exactly fit a supplied
 ;                POSITION vector, over-riding ASPECT and MARGIN
 ;                (default is to honor ASPECT and MARGIN when a POSITION
 ;                vector is supplied).
 ;
-;    CHANNEL     Display channel (Red, Green, or Blue) to be written.
+; @keyword CHANNEL Display channel (Red, Green, or Blue) to be written.
 ;                0 => All channels (the default)
 ;                1 => Red channel
@@ -299 +290 @@
 ;                images can be displayed on any device supported by IMDISP.
 ;
-;    BACKGROUND  If set to a positive integer, the background will be filled
+; @keyword BACKGROUND If set to a positive integer, the background will be filled
 ;                with the color defined by BACKGROUND.
 ;
-;    ERASE       If set, the screen contents will be erased. Note that if
+; @keyword ERASE If set, the screen contents will be erased. Note that if
 ;                !P.MULTI is set to display multiple images, the screen is
 ;                always erased when the first image is displayed.
 ;
-;    AXIS        If set, plot axes will be drawn on the image. The default
+; @keyword AXIS If set, plot axes will be drawn on the image. The default
 ;                x and y axis ranges are determined by the size of the image.
 ;                When the AXIS keyword is set, IMDISP accepts any keywords
 ;                supported by PLOT (e.g. TITLE, COLOR, CHARSIZE etc.).
 ;
-;    NEGATIVE    If set, a photographic negative of the image is displayed.
+; @keyword NEGATIVE If set, a photographic negative of the image is displayed.
 ;                The values of BOTTOM and NCOLORS are honored. This keyword
 ;                allows True color images scanned from color negatives to be
@@ -318 +309 @@
 ;                is ignored if the NOSCALE keyword is set.
 ;
-; OUTPUTS:
-;    None.
-;
-; OPTIONAL OUTPUTS:
-;    None
-;
-; COMMON BLOCKS:
-;    None
-;
-; SIDE EFFECTS:
-;    The image is displayed on the current graphics device.
-;
-; RESTRICTIONS:
-;    Requires IDL 5.0 or higher (square bracket array syntax).
-;
-; EXAMPLE:
+; @restrictions The image is displayed on the current graphics device.
+;
+; @restrictions Requires IDL 5.0 or higher (square bracket array syntax).
+;
+; @examples
 ;
 ;;- Load test data
@@ -472 +452 @@
 ;map_grid
 ;
-; MODIFICATION HISTORY:
-; Liam.Gumley@ssec.wisc.edu
+; @history Liam.Gumley@ssec.wisc.edu
 ; http://cimss.ssec.wisc.edu/~gumley
-; $Id: imdisp.pro,v 1.47 2002/06/05 16:31:07 gumley Exp $
 ;
 ; Copyright (C) 1999, 2000 Liam E. Gumley
@@ -492 +470 @@
 ; along with this program; if not, write to the Free Software
 ; Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+;
+; @version $Id: imdisp.pro,v 1.47 2002/06/05 16:31:07 gumley Exp $
+;
 ;-
+;-------------------------------------------------------------------------------
+PRO IMDISP, IMAGE, RANGE=RANGE, BOTTOM=BOTTOM, NCOLORS=NCOLORS, $
+  MARGIN=MARGIN, INTERP=INTERP, DITHER=DITHER, ASPECT=ASPECT, $
+  POSITION=POSITION, OUT_POS=OUT_POS, NOSCALE=NOSCALE, NORESIZE=NORESIZE, $
+  ORDER=ORDER, USEPOS=USEPOS, CHANNEL=CHANNEL, $
+  BACKGROUND=BACKGROUND, ERASE=ERASE, $
+  AXIS=AXIS, NEGATIVE=NEGATIVE, _EXTRA=EXTRA_KEYWORDS
+;
+  compile_opt idl2, strictarrsubs
+;
 
 rcs_id = '$Id: imdisp.pro,v 1.47 2002/06/05 16:31:07 gumley Exp $'