Changeset 163 for trunk/SRC/Picture

Timestamp:

08/29/06 14:59:46 (18 years ago)

Author:

navarro

Message:

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

Location:

trunk/SRC/Picture

Files:

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

trunk/SRC/Picture/image_viewer.pro

@@ -31 +31 @@
 ;_
 
-PRO IMAGE_VIEWER_OPEN_FILES,event
+PRO image_viewer_open_files,event
 ;THIS PROCEDURE IS CALLED WHEN A USER SELECTS "File > Open Picture Files" FROM THE MAIN MENU
 ;error handling:
@@ -115 +115 @@
 ; @param event {in}{required}
 ;-
-PRO IMAGE_VIEWER_OPEN_FOLDER,event
+PRO image_viewer_open_folder,event
 ;THIS PROCEDURE IS CALLED WHEN A USER SELECTS "File > Open All In Folder" FROM THE MAIN MENU
 ;error handling:
@@ -200 +200 @@
 ; @param event {in}{required}
 ;-
-PRO IMAGE_VIEWER_CANCEL,event
+PRO image_viewer_cancel,event
 ;obtain state structure for top-level-base from its UVALUE:
 ;
@@ -216 +216 @@
 ; @param event {in}{required}
 ;-
-PRO IMAGE_VIEWER_TIMER,event
+PRO image_viewer_timer,event
 ;obtain state structure for top-level-base from its UVALUE:
 ;
@@ -891 +891 @@
 ; @param event {in}{required}
 ;-
-PRO IMAGE_VIEWER_EXIT,event
+PRO image_viewer_exit,event
 ;THIS PROCEDURE IS CALLED WHEN A USER SELECTS "File > Exit" FROM THE MAIN MENU
 ;terminate the program by destroying the top-level-base (widgetID always stored in event.top):
@@ -906 +906 @@
 ; @param event {in}{required}
 ;-
-PRO IMAGE_VIEWER_HELP,event
+PRO image_viewer_help,event
 ;THIS PROCEDURE IS CALLED WHEN A USER SELECTS "Help > Help on IMAGE_VIEWER"
 ;FROM THE MAIN MENU
@@ -928 +928 @@
 ; @param event {in}{required}
 ;-
-PRO IMAGE_VIEWER_THUMBS,event
+PRO image_viewer_thumbs,event
 ;THIS PROCEDURE IS CALLED WHEN A USER CLICKS ON ONE OF THE THUMBNAIL PICTURES
 ;error handling:
@@ -978 +978 @@
 ; @param widgetID {in}{required}
 ;-
-PRO IMAGE_VIEWER_CLEANUP,widgetID
+PRO image_viewer_cleanup,widgetID
 ;THIS PROCEDURE IS CALLED WHEN THE PROGRAM IS TERMINATED AND XMANAGER REGISTERS A CLEANUP:
 ;obtain state structure for top-level-base from its uvalue:
@@ -1009 +1009 @@
 ; @param event {in}{required}
 ;-
-PRO IMAGE_VIEWER_EVENT,event
+PRO image_viewer_event,event
 ;THIS PROCEDURE IS CALLED WHEN A USER RESIZES THE TOP-LEVEL BASE
 ;error handling:
@@ -1032 +1032 @@
 
 ;*********************************************************************************************
-PRO IMAGE_VIEWER
+PRO image_viewer
 ;error handling:
 ;

trunk/SRC/Picture/imdisp.pro

@@ -3 +3 @@
 ; @hidden
 ;-
-FUNCTION IMDISP_GETPOS, ASPECT, POSITION=POSITION, MARGIN=MARGIN
+FUNCTION imdisp_getpos, ASPECT, POSITION=POSITION, MARGIN=MARGIN
 ;
   compile_opt idl2, strictarrsubs
@@ -53 +53 @@
 ; @hidden
 ;-
-FUNCTION IMDISP_IMSCALE, IMAGE, RANGE=RANGE, BOTTOM=BOTTOM, NCOLORS=NCOLORS, $
+FUNCTION imdisp_imscale, IMAGE, RANGE=RANGE, BOTTOM=BOTTOM, NCOLORS=NCOLORS, $
   NEGATIVE=NEGATIVE
 ;
@@ -87 +87 @@
 ; @hidden
 ;-
-FUNCTION IMDISP_IMREGRID, DATA, NX, NY, INTERP=INTERP
+FUNCTION imdisp_imregrid, DATA, NX, NY, INTERP=INTERP
 ;
   compile_opt idl2, strictarrsubs
@@ -131 +131 @@
 ; @hidden
 ;-
-PRO IMDISP_IMSIZE, IMAGE, X0, Y0, XSIZE, YSIZE, ASPECT=ASPECT, $
+PRO imdisp_imsize, IMAGE, X0, Y0, XSIZE, YSIZE, ASPECT=ASPECT, $
   POSITION=POSITION, MARGIN=MARGIN
 ;
@@ -223 +223 @@
 ; [3, NX, NY], [NX, 3, NY], or [NX, NY, 3] form.
 ;
-; @keyword RANGE
+; @keyword RANGE {type=vector}{default=min and max array values}
 ; 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
+; @keyword BOTTOM {default=0}
 ; Bottom value in the color table to be used
-; for the byte-scaled image
-; (default is 0).
+; for the byte-scaled image.
 ; This keyword is ignored if the NOSCALE keyword is set.
 ;
-; @keyword NCOLORS
+; @keyword NCOLORS {default=!D.TABLE_SIZE - BOTTOM}
 ; 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
+; @keyword MARGIN {default=0.1 or 0.025 if !P.MULTI is set to display multiple images}
 ; 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
+;
+; @keyword INTERP {default=nearest neighbor sampling}
 ; If set, the resized image will be interpolated using
 ; bilinear interpolation
-; (default is nearest neighbor sampling).
-;
-; @keyword DITHER
+;
+; @keyword DITHER {default=no dithering}
 ; If set, true color images will be dithered when displayed
 ; on an 8-bit graphics device
-; (default is no dithering).
-;
-; @keyword ASPECT
+;
+; @keyword ASPECT {default=maintain native aspect ratio}
 ; 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]}
@@ -275 +267 @@
 ; 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
+; @keyword NOSCALE {default=to byte-scale the image}
+; If set, the image will not be byte-scaled.
+;
+; @keyword NORESIZE {default=To resize the image to fit the display}
 ; If set, the image will not be resized.
-; (default is to resize the image to fit the display).
-;
-; @keyword ORDER
+;
+; @keyword ORDER {default=To display the image from the bottom up}
 ; 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
+; @keyword USEPOS {default=To honor ASPECT and MARGIN when POSITION vector is supplied}
 ; 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).
+; POSITION vector, over-riding ASPECT and MARGIN.
 ;
 ; @keyword CHANNEL
@@ -496 +483 @@
 ;-
 ;-------------------------------------------------------------------------------
-PRO IMDISP, IMAGE, RANGE=RANGE, BOTTOM=BOTTOM, NCOLORS=NCOLORS, $
+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, $

trunk/SRC/Picture/saveimage.pro

@@ -17 +17 @@
 ; @categories Input/Output.
 ;
-; @param FILE {in}{required}
-; Name of the output file (GIF format by default).
+; @param FILE {in}{required}{default=format GIF}
+; Name of the output file
 ;
 ; @keyword BMP
@@ -35 +35 @@
 ; Set this keyword to create TIFF format (24-bit true color).
 ;
-; @keyword QUALITY
+; @keyword QUALITY {default=75}
 ; If set to a named variable, specifies the quality for
-; JPEG output (default 75). Ranges from 0 ("terrible") to
+; JPEG output. Ranges from 0 ("terrible") to
 ; 100 ("excellent"). Smaller quality values yield higher
 ; compression ratios and smaller output files.
 ;
-; @keyword DITHER
+; @keyword DITHER {default=no dithering}
 ; 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
+; which is read from a 24-bit display.
+;
+; @keyword CUBE {default=to use statistical method)
 ; 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).
+; creating 8-bit output which is read from a 24-bit display.
+; This may improve the accuracy of colors in the output image, 
+; especially white.
+;
+; @keyword QUIET {default=to print an information message}
+; Set this keyword to suppress the information message.
 ;
 ; @restrictions
@@ -91 +90 @@
 ;
 ;-
-PRO SAVEIMAGE, FILE, BMP=BMP, PNG=PNG, PICT=PICT, JPEG=JPEG, TIFF=TIFF, $
+PRO saveimage, FILE, BMP=BMP, PNG=PNG, PICT=PICT, JPEG=JPEG, TIFF=TIFF, $
   QUALITY=QUALITY, DITHER=DITHER, CUBE=CUBE, QUIET=QUIET, MULTIPLE = multiple
 ;

trunk/SRC/Picture/showimage.pro

@@ -19 +19 @@
 ; Name of the output file (format is identified automatically).
 ;
-; @keyword DITHER
+; @keyword DITHER {default=no dithering}
 ; Set this keyword to dither the input image when displaying
-; 24-bit images on an 8-bit display (default is no dithering).
+; 24-bit images on an 8-bit display.
 ;
 ; @keyword CURRENT
@@ -56 +56 @@
 ;
 ;-
-PRO SHOWIMAGE, FILE, DITHER=DITHER, CURRENT=CURRENT
+PRO showimage, FILE, DITHER=DITHER, CURRENT=CURRENT
 ;
   compile_opt idl2, strictarrsubs