Changeset 136 for trunk/SRC/Picture

Timestamp:

07/10/06 17:20:19 (18 years ago)

Author:

pinsard

Message:

some improvements and corrections in some .pro file according to
aspell and idldoc log file

Location:

trunk/SRC/Picture

Files:

• image_viewer.pro (modified) (3 diffs)
• imdisp.pro (modified) (6 diffs)
• saveimage.pro (modified) (2 diffs)
• showimage.pro (modified) (3 diffs)

trunk/SRC/Picture/image_viewer.pro

@@ -1 +1 @@
 ;+
 ;
-; @file_comments 
+; @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
@@ -11 +11 @@
 ; @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
-;       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.
+; @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
+; 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.
 ;
 ; @history Written by: AEB, 1/02.
@@ -972 +974 @@
 ;*********************************************************************************************
 ;+
-; @param widjetID {in}{required}
+; @param widgetID {in}{required}
 ;-
 PRO IMAGE_VIEWER_CLEANUP,widgetID

trunk/SRC/Picture/imdisp.pro

@@ -191 +191 @@
 ;+
 ;
-; @file_comments 
+; @file_comments
 ;    Display an image on the current graphics device.
 ;    IMDISP is an advanced replacement for TV and TVSCL.
@@ -216 +216 @@
 ; @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.
-;
-; @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
-;                (default is minimum and maximum array values).
-;                This keyword is ignored for True Color images,
-;                or if the NOSCALE keyword is set.
-;
-; @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.
-;
-; @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.
-;
-; @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).
-;
-; @keyword INTERP If set, the resized image will be interpolated using
-;                bilinear interpolation
-;                (default is nearest neighbor sampling).
-;
-; @keyword DITHER If set, true color images will be dithered when displayed
-;                on an 8-bit graphics device
-;                (default is no dithering).
-;
-; @keyword ASPECT A scalar value specifying the aspect ratio (height/width)
-;                for the displayed image
-;                (default is to maintain native aspect ratio).
-;
-; @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
-;                (default is [0.0,0.0,1.0,1.0]).
-;                See the examples below to display an image where only the
-;                offset and size are known (e.g. MAP_IMAGE output).
-;
-; @keyword OUT_POS On output, a 4-element vector specifying the position
-;                actually used to display the image.
-;
-; @keyword NOSCALE If set, the image will not be byte-scaled
-;                (default is to byte-scale the image).
-;
-; @keyword NORESIZE If set, the image will not be resized.
-;                (default is to resize the image to fit the display).
-;
-; @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.
-;
-; @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).
-;
-; @keyword CHANNEL Display channel (Red, Green, or Blue) to be written.
-;                0 => All channels (the default)
-;                1 => Red channel
-;                2 => Green channel
-;                3 => Blue channel
-;                This keyword is only recognized by graphics devices which
-;                support 24-bit decomposed color (WIN, MAC, X). It is ignored
-;                by all other graphics devices. However True color (RGB)
-;                images can be displayed on any device supported by IMDISP.
-;
-; @keyword BACKGROUND If set to a positive integer, the background will be filled
-;                with the color defined by BACKGROUND.
-;
-; @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.
-;
-; @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.).
-;
-; @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
-;                displayed. It also allows Pseudo color images to be displayed
-;                as negatives without reversing the color table. This keyword
-;                is ignored if the NOSCALE keyword is set.
-;
-; @restrictions The image is displayed on the current graphics device.
-;
-; @restrictions Requires IDL 5.0 or higher (square bracket array syntax).
+; @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.
+;
+; @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
+; (default is minimum and maximum array values).
+; This keyword is ignored for True Color images,
+; or if the NOSCALE keyword is set.
+;
+; @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.
+;
+; @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.
+;
+; @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).
+;
+; @keyword INTERP
+; If set, the resized image will be interpolated using
+; bilinear interpolation
+; (default is nearest neighbor sampling).
+;
+; @keyword DITHER
+; If set, true color images will be dithered when displayed
+; on an 8-bit graphics device
+; (default is no dithering).
+;
+; @keyword ASPECT
+; A scalar value specifying the aspect ratio (height/width)
+; for the displayed image
+; (default is to maintain native aspect ratio).
+;
+; @keyword POSITION {default= [0.0,0.0,1.0,1.0]}
+; On input, a 4-element vector specifying the position
+; of the displayed image in the form [X0,Y0,X1,Y1] in
+; in normal coordinates
+; See the examples below to display an image where only the
+; offset and size are known (e.g. MAP_IMAGE output).
+;
+; @keyword OUT_POS
+; On output, a 4-element vector specifying the position
+; actually used to display the image.
+;
+; @keyword NOSCALE
+; If set, the image will not be byte-scaled
+; (default is to byte-scale the image).
+;
+; @keyword NORESIZE
+; If set, the image will not be resized.
+; (default is to resize the image to fit the display).
+;
+; @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.
+;
+; @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).
+;
+; @keyword CHANNEL
+; Display channel (Red, Green, or Blue) to be written.
+; 0 => All channels (the default)
+; 1 => Red channel
+; 2 => Green channel
+; 3 => Blue channel
+; This keyword is only recognized by graphics devices which
+; support 24-bit decomposed color (WIN, MAC, X). It is ignored
+; by all other graphics devices. However True color (RGB)
+; images can be displayed on any device supported by IMDISP.
+;
+; @keyword BACKGROUND
+; If set to a positive integer, the background will be filled
+; with the color defined by BACKGROUND.
+;
+; @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.
+;
+; @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.).
+;
+; @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
+; displayed. It also allows Pseudo color images to be displayed
+; as negatives without reversing the color table. This keyword
+; is ignored if the NOSCALE keyword is set.
+;
+; @restrictions
+; The image is displayed on the current graphics device.
+;
+; @restrictions
+; Requires IDL 5.0 or higher (square bracket array syntax).
 ;
 ; @examples
@@ -317 +337 @@
 ;;- Load test data
 ;
-;openr, lun, filepath('ctscan.dat', subdir='examples/data'), /get_lun
+; openr, lun, filepath('ctscan.dat', subdir='examples/data'), /get_lun
 ;ctscan = bytarr(256, 256)
 ;readu, lun, ctscan
@@ -452 +472 @@
 ;map_grid
 ;
-; @history Liam.Gumley@ssec.wisc.edu
+; @history Liam.Gumley\@ssec.wisc.edu
 ; http://cimss.ssec.wisc.edu/~gumley
 ;
@@ -471 +491 @@
 ; 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 $
+; @version $Id$
 ;
 ;-
@@ -485 +505 @@
 ;
 
-rcs_id = '$Id: imdisp.pro,v 1.47 2002/06/05 16:31:07 gumley Exp $'
+rcs_id = '$Id$'
 
 ;-------------------------------------------------------------------------------

trunk/SRC/Picture/saveimage.pro

@@ -1 +1 @@
 ;+
 ;
-; @file_comments 
+; @file_comments
 ; Save the current graphics window to an output file (GIF by default).
 ;
@@ -17 +17 @@
 ; @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.
-;
-;@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).
-;
-; @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.
-; @keyword QUIET    Set this keyword to suppress the information message
-;             (default is to print an information message).
-; @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).
+; @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.
+;
+; @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).
+;
+; @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.
+;
+; @keyword QUIET
+; Set this keyword to suppress the information message
+; (default is to print an information message).
+;
+; @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
-;image = bytarr(440, 330)
-;readu, lun, image
-;free_lun, lun
-;loadct, 13
-;tvscl, image
-;saveimage, 'hurric.gif'
+; IDL> openr, lun, filepath('hurric.dat', subdir='examples/data'), /get_lun
+; IDL> image = bytarr(440, 330)
+; IDL> readu, lun, image
+; IDL> free_lun, lun
+; IDL> loadct, 13
+; IDL> tvscl, image
+; IDL> saveimage, 'hurric.gif'
 ;
 ; @history Liam.Gumley@ssec.wisc.edu

trunk/SRC/Picture/showimage.pro

@@ -1 +1 @@
 ;+
 ;
-; @file_comments 
+; @file_comments
 ; Show the contents of a graphics file in the current window.
 ;
@@ -16 +16 @@
 ; @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).
-; @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).
-;
-; @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
+; @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).
+;
+; @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).
+;
+; @restrictions
+; The color table is modified.
+;
+; @restrictions
+; Requires IDL 5.2 or higher (image QUERY functions).
+;
+; @examples $
+; IDL> showimage, filepath('rose.jpg', subdir='examples/data')
+;
+; @history Liam.Gumley\@ssec.wisc.edu
 ; http://cimss.ssec.wisc.edu/~gumley
 ;
@@ -46 +53 @@
 ; Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 ;
-; @version $Id$ 
+; @version $Id$
 ;
 ;-