Changeset 133 for trunk/SRC/Picture/saveimage.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)
• saveimage.pro (moved) (moved from trunk/SRC/ToBeReviewed/IMAGE/saveimage.pro) (4 diffs)

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