Changeset 133 for trunk/SRC/Picture

Timestamp:

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

Author:

navarro

Message:

english and nicer header (1)

Location:

trunk/SRC/Picture

Files:

• . (added)
• image_viewer.pro (moved) (moved from trunk/SRC/ToBeReviewed/IMAGE/image_viewer.pro) (9 diffs)
• imdisp.pro (moved) (moved from trunk/SRC/ToBeReviewed/IMAGE/imdisp.pro) (12 diffs)
• saveimage.pro (moved) (moved from trunk/SRC/ToBeReviewed/IMAGE/saveimage.pro) (4 diffs)
• showimage.pro (moved) (moved from trunk/SRC/ToBeReviewed/IMAGE/showimage.pro) (3 diffs)

trunk/SRC/Picture/image_viewer.pro

@@ -1 +1 @@
 ;+
-; NAME:
-;       IMAGE_VIEWER
-;
-; PURPOSE:
-;       The purpose of this program is to provide an interactive tool that can be used
-;       to view JPEG, BMP, GIF, PNG, and TIFF picture files.  Images are loaded into
-;       memory, so the initial file access may take a while, but once each picture has
-;       been opened they can all be viewed in a very rapid fashion.
-;
-; CATEGORY:
-;       Visualization, Widgets
-;
-; CALLING SEQUENCE:
-;       image_viewer
-;
-; INPUT PARAMETERS:
-;       None.
-;
-; KEYWORD PARAMETERS:
-;       None.
-;
-; OUTPUTS:
-;       None.
-;
-; COMMON BLOCKS:
-;       None.
-;
-; SIDE EFFECTS:
-;       While this program is running in an IDL session it will change the current
+;
+; @file_comments 
+; The purpose of this program is to provide an interactive tool that can be used
+; to view JPEG, BMP, GIF, PNG, and TIFF picture files.  Images are loaded into
+; memory, so the initial file access may take a while, but once each picture has
+; been opened they can all be viewed in a very rapid fashion.
+;
+; @categories Visualization, Widgets
+;
+; @param event {in}{required}
+;
+; @restrictions While this program is running in an IDL session it will change the current
 ;       working directory, enables/disables color decomposition, and sets !QUIET=1,
 ;       !ORDER=0, & !P.BACKGROUND=0.  These settings are returned to their initial
 ;       settings before the program was initiated once it is terminated.
 ;
-; RESTRICTIONS:
-;       This program is supported in IDL version 5.5 and newer.  In order to open
+; @restrictions This program is supported in IDL version 5.5 and newer.  In order to open
 ;       GIF files or TIFF files with LZW compression the copy of IDL being used must
 ;       be licensed with these features.  IDL only supports BMP files in the standard
 ;       Windows format and does not support OS2 bitmaps.
 ;
-; MODIFICATION HISTORY:
-;       Written by: AEB, 1/02.
-;-
-
-
-;*********************************************************************************************
+; @history Written by: AEB, 1/02.
+;
+; @version $Id$
+;*********************************************************************************************
+;_
+
 PRO IMAGE_VIEWER_OPEN_FILES,event
 ;THIS PROCEDURE IS CALLED WHEN A USER SELECTS "File > Open Picture Files" FROM THE MAIN MENU
@@ -126 +108 @@
 
 ;*********************************************************************************************
+;+
+; @param event {in}{required}
+;-
 PRO IMAGE_VIEWER_OPEN_FOLDER,event
 ;THIS PROCEDURE IS CALLED WHEN A USER SELECTS "File > Open All In Folder" FROM THE MAIN MENU
@@ -208 +193 @@
 
 ;*********************************************************************************************
+;+
+; @param event {in}{required}
+;-
 PRO IMAGE_VIEWER_CANCEL,event
 ;obtain state structure for top-level-base from its UVALUE:
@@ -221 +209 @@
 
 ;*********************************************************************************************
+;+
+; @param event {in}{required}
+;-
 PRO IMAGE_VIEWER_TIMER,event
 ;obtain state structure for top-level-base from its UVALUE:
@@ -893 +884 @@
 
 ;*********************************************************************************************
+;+
+; @param event {in}{required}
+;-
 PRO IMAGE_VIEWER_EXIT,event
 ;THIS PROCEDURE IS CALLED WHEN A USER SELECTS "File > Exit" FROM THE MAIN MENU
@@ -905 +899 @@
 
 ;*********************************************************************************************
+;+
+; @param event {in}{required}
+;-
 PRO IMAGE_VIEWER_HELP,event
 ;THIS PROCEDURE IS CALLED WHEN A USER SELECTS "Help > Help on IMAGE_VIEWER"
@@ -924 +921 @@
 
 ;*********************************************************************************************
+;+
+; @param event {in}{required}
+;-
 PRO IMAGE_VIEWER_THUMBS,event
 ;THIS PROCEDURE IS CALLED WHEN A USER CLICKS ON ONE OF THE THUMBNAIL PICTURES
@@ -971 +971 @@
 
 ;*********************************************************************************************
+;+
+; @param widjetID {in}{required}
+;-
 PRO IMAGE_VIEWER_CLEANUP,widgetID
 ;THIS PROCEDURE IS CALLED WHEN THE PROGRAM IS TERMINATED AND XMANAGER REGISTERS A CLEANUP:
@@ -999 +1002 @@
 
 ;*********************************************************************************************
+;+
+; @param event {in}{required}
+;-
 PRO IMAGE_VIEWER_EVENT,event
 ;THIS PROCEDURE IS CALLED WHEN A USER RESIZES THE TOP-LEVEL BASE

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 $'

trunk/SRC/Picture/saveimage.pro

@@ -1 @@
-PRO SAVEIMAGE, FILE, BMP=BMP, PNG=PNG, PICT=PICT, JPEG=JPEG, TIFF=TIFF, $
-  QUALITY=QUALITY, DITHER=DITHER, CUBE=CUBE, QUIET=QUIET, MULTIPLE = multiple
-;
-  compile_opt idl2, strictarrsubs
-;
-
 ;+
-; NAME:
-;    SAVEIMAGE
-;
-; PURPOSE:
-;    Save the current graphics window to an output file (GIF by default).
+;
+; @file_comments 
+; Save the current graphics window to an output file (GIF by default).
 ;
 ;    The output formats supported are:
@@ -23 +15 @@
 ;    8-bit or 24-bit output files are done automatically.
 ;
-; CATEGORY:
-;    Input/Output.
-;
-; CALLING SEQUENCE:
-;    SAVEIMAGE, FILE
-;
-; INPUTS:
-;    FILE     Name of the output file (GIF format by default).
-;
-; OPTIONAL INPUTS:
-;    None.
-;
-; KEYWORD PARAMETERS:
-;    BMP      Set this keyword to create BMP format (8-bit with color table).
-;    PNG      Set this keyword to create PNG format (8-bit with color table).
-;    PICT     Set this keyword to create PICT format (8-bit with color table).
-;    JPEG     Set this keyword to create JPEG format (24-bit true color).
-;    TIFF     Set this keyword to create TIFF format (24-bit true color).
-;    QUALITY  If set to a named variable, specifies the quality for
+; @categories Input/Output.
+;
+; @param FILE {in}{required} Name of the output file (GIF format by default).
+;
+; @keyword BMP Set this keyword to create BMP format (8-bit with color table).
+;
+; @keyword PNG Set this keyword to create PNG format (8-bit with color table).
+;
+; @keyword PICT Set this keyword to create PICT format (8-bit with color table).
+;
+; @keyword JPEG Set this keyword to create JPEG format (24-bit true color).
+;
+; @keyword TIFF Set this keyword to create TIFF format (24-bit true color).
+;
+; @keyword QUALITY  If set to a named variable, specifies the quality for
 ;             JPEG output (default 75). Ranges from 0 ("terrible") to
 ;             100 ("excellent"). Smaller quality values yield higher
 ;             compression ratios and smaller output files.
-;    DITHER   If set, dither the output image when creating 8-bit output
+;
+;@keyword DITHER   If set, dither the output image when creating 8-bit output
 ;             which is read from a 24-bit display (default is no dithering).
-;    CUBE     If set, use the color cube method to quantize colors when
+;
+; @keyword CUBE     If set, use the color cube method to quantize colors when
 ;             creating 8-bit output which is read from a 24-bit display
 ;             (default is to use the statistical method). This may improve
 ;             the accuracy of colors in the output image, especially white.
-;    QUIET    Set this keyword to suppress the information message
+; @keyword QUIET    Set this keyword to suppress the information message
 ;             (default is to print an information message).
-;    MULTIPLE to write multiple gif image
-;
-; OUTPUTS:
-;    None.
-;
-; OPTIONAL OUTPUTS:
-;    None
-;
-; COMMON BLOCKS:
-;    None
-;
-; SIDE EFFECTS:
-;    The output file is overwritten if it exists.
-;
-; RESTRICTIONS:
-;    Requires IDL 5.0 or higher (square bracket array syntax).
-;
-; EXAMPLE:
+; @keyword MULTIPLE to write multiple gif image.
+;
+; @restrictions The output file is overwritten if it exists.
+;
+; 
+; @restrictions requires IDL 5.0 or higher (square bracket array syntax).
+;
+; @examples
 ;
 ;openr, lun, filepath('hurric.dat', subdir='examples/data'), /get_lun
@@ -80 +60 @@
 ;saveimage, 'hurric.gif'
 ;
-; MODIFICATION HISTORY:
-; Liam.Gumley@ssec.wisc.edu
+; @history Liam.Gumley@ssec.wisc.edu
 ; http://cimss.ssec.wisc.edu/~gumley
-; $Id$
-;
-; Copyright (C) 1999 Liam E. Gumley
 ;
 ; This program is free software; you can redistribute it and/or
@@ -100 +76 @@
 ; 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$
+;
 ;-
+PRO SAVEIMAGE, FILE, BMP=BMP, PNG=PNG, PICT=PICT, JPEG=JPEG, TIFF=TIFF, $
+  QUALITY=QUALITY, DITHER=DITHER, CUBE=CUBE, QUIET=QUIET, MULTIPLE = multiple
+;
+  compile_opt idl2, strictarrsubs
+;
 
 rcs_id = '$Id$'

trunk/SRC/Picture/showimage.pro

@@ -1 @@
-PRO SHOWIMAGE, FILE, DITHER=DITHER, CURRENT=CURRENT
-;
-  compile_opt idl2, strictarrsubs
-;
-
 ;+
-; NAME:
-;    SHOWIMAGE
-;
-; PURPOSE:
-;    Show the contents of a graphics file in the current window.
+;
+; @file_comments 
+; Show the contents of a graphics file in the current window.
 ;
 ;    The input formats supported are:
@@ -21 +14 @@
 ;    to 8-bit or 24-bit images on-screen are done automatically.
 ;
-; CATEGORY:
-;    Input/Output.
-;
-; CALLING SEQUENCE:
-;    SHOWIMAGE, FILE
-;
-; INPUTS:
-;    FILE     Name of the output file (format is identified automatically).
-;
-; OPTIONAL INPUTS:
-;    None.
-;
-; KEYWORD PARAMETERS:
-;    DITHER   Set this keyword to dither the input image when displaying
+; @categories Input/Output.
+;
+; @param FILE {in}{required} Name of the output file (format is identified automatically).
+;
+; @keyword DITHER Set this keyword to dither the input image when displaying
 ;             24-bit images on an 8-bit display (default is no dithering).
-;    CURRENT  Set this keyword to display the image in the current window
+; @keyword CURRENT Set this keyword to display the image in the current window
 ;             (default is to create a new window sized to fit the image).
 ;
-; OUTPUTS:
-;    None.
-;
-; OPTIONAL OUTPUTS:
-;    None
-;
-; COMMON BLOCKS:
-;    None
-;
-; SIDE EFFECTS:
-;    The color table is modified.
-;
-; RESTRICTIONS:
-;    Requires IDL 5.2 or higher (image QUERY functions).
-;
-; EXAMPLE:
-;
-;showimage, filepath('rose.jpg', subdir='examples/data')
-;
-; MODIFICATION HISTORY:
-; Liam.Gumley@ssec.wisc.edu
+; @restrictions The color table is modified.
+;
+; @restrictions Requires IDL 5.2 or higher (image QUERY functions).
+;
+; @examples showimage, filepath('rose.jpg', subdir='examples/data')
+;
+; @history Liam.Gumley@ssec.wisc.edu
 ; http://cimss.ssec.wisc.edu/~gumley
-; $Id$
-;
-; Copyright (C) 1999 Liam E. Gumley
 ;
 ; This program is free software; you can redistribute it and/or
@@ -78 +45 @@
 ; 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$ 
+;
 ;-
-
+PRO SHOWIMAGE, FILE, DITHER=DITHER, CURRENT=CURRENT
+;
+  compile_opt idl2, strictarrsubs
+;
 rcs_id = '$Id$'