Changeset 136 for trunk/SRC/Colors

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/Colors

Files:

• color24.pro (modified) (4 diffs)
• colorbar.pro (modified) (5 diffs)
• getcolor.pro (modified) (5 diffs)
• lct.pro (modified) (4 diffs)
• newpalette.pro (modified) (1 diff)
• xlct.pro (modified) (1 diff)
• xpal.pro (modified) (18 diffs)

trunk/SRC/Colors/color24.pro

@@ -7 +7 @@
 ; @categories Graphics, Color Specification.
 ;
-; @param RGB_TRIPLE {in}{required} A three-element column or row array representing 
-;       a color triple. The values of the elements must be between 
-;       0 and 255.
+; @param rgb_triple {in}{required} 
+; A three-element column or row array representing 
+; a color triple. The values of the elements must be between 0 and 255.
 ;
-; @returns a 24-bit long integer that is equivalent the input color. 
-; The color is
-; described in terms of a hexidecimal number (e.g., FF206A)
+; @returns 
+; a 24-bit long integer that is equivalent the input color. 
+; The color is described in terms of a hexadecimal number (e.g., FF206A)
 ; where the left two digits represent the blue color, the 
 ; middle two digits represent the green color, and the right 
 ; two digits represent the red color.
 ;
-; @examples To convert the color triple for the color YELLOW, 
-;       (255, 255, 0), to the hexadecimal value '00FFFF'x 
-;       or the decimal number 65535, type:
+; @examples 
+; To convert the color triple for the color YELLOW, 
+; (255, 255, 0), to the hexadecimal value '00FFFF'x 
+; or the decimal number 65535, type:
 ;
-;       color = COLOR24([255, 255, 0])
+; IDL> color = COLOR24([255, 255, 0])
 ;       
-;       This routine was written to be used with routines like 
-;       COLORS or GETCOLOR
+; This routine was written to be used with routines like COLORS or GETCOLOR
 ;
 ; @history
@@ -33 +33 @@
 ;
 ;-
-FUNCTION COLOR24, number
+FUNCTION COLOR24, rgb_triple
 ;
   compile_opt idl2, strictarrsubs
@@ -39 +39 @@
 ON_ERROR, 1
 
-IF N_ELEMENTS(number) NE 3 THEN $
-   MESSAGE, 'Augument must be a three-element vector.'
+IF N_ELEMENTS(rgb_triple) NE 3 THEN $
+   MESSAGE, 'Argument must be a three-element vector.'
 
-IF MAX(number) GT 255 OR MIN(number) LT 0 THEN $
+IF MAX(rgb_triple) GT 255 OR MIN(rgb_triple) LT 0 THEN $
    MESSAGE, 'Argument values must be in range of 0-255'
 
@@ -49 +49 @@
 num24bit = 0L
 
-FOR j=0,2 DO num24bit = num24bit + ((number[j] MOD 16) * base16[0,j]) + $
-   (Fix(number[j]/16) * base16[1,j])
+FOR j=0,2 DO num24bit = num24bit + ((rgb_triple[j] MOD 16) * base16[0,j]) + $
+   (Fix(rgb_triple[j]/16) * base16[1,j])
    
 RETURN, num24bit

trunk/SRC/Colors/colorbar.pro

@@ -1 +1 @@
 ;+
 ;
-; @file_comments 
+; @file_comments
 ; The purpose of this routine is to add a color bar to the current
 ; graphics window.
@@ -7 +7 @@
 ; @categories Graphics, Widgets.
 ;
-; @keyword BOTTOM The lowest color index of the colors to be loaded in
-;                 the bar.
-;
-; @keyword CB_CHARSIZE The character size of the color bar annotations. Default is 1.0.
-;
-; @keyword CB_CHARTICK The character thick of the color bar annotations. Default is 1.0.
-;
-; @keyword CB_COLOR The color index of the bar outline and characters. Default
-;                 is ncolors - 1 + bottom.
-;
-; @keyword CB_LOG to get logarithmic scale for the colorbar
-;
-; @keyword CB_TITLE This is title for the color bar. The default is to have
-;                 no title.
-;
-; @keyword DISCRETE Vector which contain color's indexes to trace in a color bar. Therefore
-;               we obtain a discreet color bar which only contains specified colors in 
-;               order where they appear in the vector
-;
-; @keyword DIVISIONS The number of divisions to divide the bar into. There will
-;                 be (divisions + 1) annotations. The default is 2.
-;
-; @keyword FORMAT The format of the bar annotations. Default is '(F6.2)'.
-;
-; @keyword CB_LABEL It is a vector who specifie sticks's value attend in the color bar.
-;                It allowes, when we use DISCREET, to have colors which don't increase 
-;                by increments in a regular way.
-;
-; @keyword MAX The maximum data value for the bar annotation. Default is
-;                 NCOLORS-1.
-;
-; @keyword MIN The minimum data value for the bar annotation. Default is 0.
-;
-; @keyword NCOLOR This is the number of colors in the color bar.
-;
-; @keyword NOTITLE Force to don't writte title even if CB_TITLE is declarerd.
-;
-; @keyword POSITION A four-element array of normalized coordinates in the same
-;                 form as the POSITION keyword on a plot. Default is
-;                 [0.88, 0.15, 0.95, 0.95] for a vertical bar and
-;                 [0.15, 0.88, 0.95, 0.95] for a horizontal bar.
-;
-; @keyword PSCOLOR This keyword is only applied if the output is being sent to
-;                 a PostScript file. It indicates that the PostScript device
-;                 is configured for color output. If this keyword is set, then
-;                 the annotation is drawn in the color specified by the COLOR
-;                 keyword. If the keyword is not set, the annotation is drawn
-;                 in the color specified by the !P.COLOR system variable
-;                 (usually this will be the color black). In general, this
-;                 gives better looking output on non-color or gray-scale
-;                 printers. If you are not specifically setting the annotation
-;                 color (with the COLOR keyword), it will probably
-;                 be better NOT to set this keyword either, even if you
-;                 are outputting to a color PostScript printer.
-;
-; @keyword RIGHT This puts the labels on the right-hand side of a vertical
-;                 color bar. It applies only to vertical color bars.
-;
-; @keyword TOP This puts the labels on top of the bar rather than under it.
-;                 The keyword only applies if a horizontal color bar is rendered.
-;
-; @keyword VERTICAL Setting this keyword give a vertical color bar. The default
-;                 is a horizontal color bar.
-;
-; @restrictions Color bar is drawn in the current graphics window.
-;
-; @restrictions The number of colors available on the display device (not the
-;       PostScript device) is used unless the NCOLORS keyword is used.
-;
-; @examples To display a horizontal color bar above a contour plot, type:
-;
-;       IDL> LOADCT, 5, NCOLORS=100
-;       IDL> CONTOUR, DIST(31,41), POSITION=[0.15, 0.15, 0.95, 0.75], $
-;       IDL> C_COLORS=INDGEN(25)*4, NLEVELS=25
-;       IDL> COLORBAR, NCOLORS=100
+; @keyword BOTTOM
+; The lowest color index of the colors to be loaded in the bar.
+;
+; @keyword CB_CHARSIZE {default=1.0}
+; The character size of the color bar annotations.
+;
+; @keyword CB_CHARTHICK {default=1.0}
+; The character thick of the color bar annotations.
+;
+; @keyword CB_COLOR {default=ncolors - 1 + bottom}
+; The color index of the bar outline and characters.
+;
+; @keyword CB_LOG
+; to get logarithmic scale for the colorbar
+;
+; @keyword CB_TITLE
+; This is title for the color bar. The default is to have no title.
+;
+; @keyword DISCRETE
+; Vector which contain color's indexes to trace in a color bar. Therefore
+; we obtain a discreet color bar which only contains specified colors in
+; order where they appear in the vector
+;
+; @keyword DIVISIONS {default=2}
+; The number of divisions to divide the bar into.
+; There will be (divisions + 1) annotations.
+;
+; @keyword FORMAT {default='(F6.2)'}
+; The format of the bar annotations.
+;
+; @keyword CB_LABEL
+; It is a vector who specifies sticks's value attend in the color bar.
+; It allowes, when we use DISCREET, to have colors which don't increase
+; by increments in a regular way.
+;
+; @keyword MAX {default=NCOLORS - 1}
+; The maximum data value for the bar annotation.
+;
+; @keyword MIN {default=0}
+; The minimum data value for the bar annotation.
+;
+; @keyword NCOLORS
+; This is the number of colors in the color bar.
+;
+; @keyword NOTITLE
+; Force to don't write title even if CB_TITLE is declared.
+;
+; @keyword POSITION
+; A four-element array of normalized coordinates in the same
+; form as the POSITION keyword on a plot. Default is
+; [0.88, 0.15, 0.95, 0.95] for a vertical bar and
+; [0.15, 0.88, 0.95, 0.95] for a horizontal bar.
+;
+; @keyword PSCOLOR
+; This keyword is only applied if the output is being sent to
+; a Postscript file. It indicates that the Postscript device
+; is configured for color output. If this keyword is set, then
+; the annotation is drawn in the color specified by the COLOR
+; keyword. If the keyword is not set, the annotation is drawn
+; in the color specified by the !P.COLOR system variable
+; (usually this will be the color black). In general, this
+; gives better looking output on non-color or gray-scale
+; printers. If you are not specifically setting the annotation
+; color (with the COLOR keyword), it will probably
+; be better NOT to set this keyword either, even if you
+; are outputting to a color Postscript printer.
+;
+; @keyword RIGHT
+; This puts the labels on the right-hand side of a vertical
+; color bar. It applies only to vertical color bars.
+;
+; @keyword TOP
+; This puts the labels on top of the bar rather than under it.
+; The keyword only applies if a horizontal color bar is rendered.
+;
+; @keyword VERTICAL
+; Setting this keyword give a vertical color bar.
+; The default is a horizontal color bar.
+;
+; @restrictions
+; Color bar is drawn in the current graphics window.
+;
+; @restrictions
+; The number of colors available on the display device (not the
+; Postscript device) is used unless the NCOLORS keyword is used.
+;
+; @examples
+; To display a horizontal color bar above a contour plot, type:
+;
+; IDL> LOADCT, 5, NCOLORS=100
+; IDL> CONTOUR, DIST(31,41), POSITION=[0.15, 0.15, 0.95, 0.75], $
+; IDL> C_COLORS=INDGEN(25)*4, NLEVELS=25
+; IDL> COLORBAR, NCOLORS=100
 ;
 ; @history Written by: David Fanning, 10 JUNE 96.
-;       10/27/96: Added the ability to send output to PostScript. DWF
-;       11/4/96: Substantially rewritten to go to screen or PostScript
-;           file without having to know much about the PostScript device
+;       10/27/96: Added the ability to send output to Postscript. DWF
+;       11/4/96: Substantially rewritten to go to screen or Postscript
+;           file without having to know much about the Postscript device
 ;           or even what the current graphics device is. DWF
 ;       1/27/97: Added the RIGHT and TOP keywords. Also modified the
@@ -93 +111 @@
 ;            no valid data range in them. DWF
 ;       3/3/98:  ajout du keyword discret par
-;                sebastien (smasson@lodyc.jussieu.fr)
+;            sebastien (smasson\@lodyc.jussieu.fr)
 ;
 ; @version $Id$
 ;
 ;-
-
-PRO COLORBAR, BOTTOM=bottom, CB_CHARSIZE=cb_charsize, CB_CHARTHICK=cb_charthick $
+PRO COLORBAR, BOTTOM=bottom, CB_CHARSIZE=cb_charsize, $
+              CB_CHARTHICK=cb_charthick $
               , CB_COLOR=cb_color, $
               DIVISIONS=divisions, DISCRETE=discrete,CB_LABEL = cb_label, $
-              FORMAT=format, POSITION=position, MAX=max, MIN=min, NCOLORS=ncolors, $
-              PSCOLOR=pscolor, CB_TITLE=cb_title, VERTICAL=vertical, TOP=top, RIGHT=right, CB_LOG = CB_log, _extra = ex
-                                ; Is the PostScript device selected?
+              FORMAT=format, POSITION=position, MAX=max, MIN=min, $
+              NCOLORS=ncolors, $
+              PSCOLOR=pscolor, CB_TITLE=cb_title, NOTITLE=notitle, $
+              VERTICAL=vertical, $
+              TOP=top, RIGHT=right, CB_LOG = CB_log, _extra = ex
+                                ; Is the Postscript device selected?
 ;
   compile_opt idl2, strictarrsubs
@@ -175 +196 @@
       IF KEYWORD_SET(discrete) THEN begin
          facteur=256/n_elements(discrete)
-         discrete=reform(replicate(1,facteur) # discrete,facteur*n_elements(discrete), /overwrite) 
+         discrete=reform(replicate(1,facteur) # discrete,facteur*n_elements(discrete), /overwrite)
          bar = REPLICATE(1B,10) # discrete
       endif else  bar = REPLICATE(1B,10) # BINDGEN(256)
@@ -182 +203 @@
       IF KEYWORD_SET(discrete) THEN begin
          facteur=256/n_elements(discrete)
-         discrete=reform(replicate(1,facteur) # discrete,facteur*n_elements(discrete), /overwrite) 
+         discrete=reform(replicate(1,facteur) # discrete,facteur*n_elements(discrete), /overwrite)
          bar =  discrete # REPLICATE(1B,10)
       endif else bar = BINDGEN(256) # REPLICATE(1B, 10)

trunk/SRC/Colors/getcolor.pro

@@ -12 +12 @@
 ; same where color decomposition is turned on or off.
 ;
-;       (The 16 supported colors in GETCOLOR come from the McIDAS color
-;       table offered on the IDL newsgroup by Liam Gumley.)
+; (The 16 supported colors in GETCOLOR come from the McIDAS color
+; table offered on the IDL newsgroup by Liam Gumley.)
 ;
 ; @categories Graphics, Color Specification.
 ;
-; @param thisColor {in}{optional} A string with the "name" of the color. Valid names are:
+; @param thisColor {in}{optional} 
+; A string with the "name" of the color. Valid names are:
 ;           black
 ;           magenta
@@ -46 +47 @@
 ;           IDL 5.2 or higher.
 ;
-; @param index {in}{optional} The color table index where the specified color should be loaded.
+; @param index {in}{optional} 
+; The color table index where the specified color should be loaded.
 ;           If this parameter is passed, then the return value of the function is the
 ;           index number and not the color triple. (If color decomposition is turned
@@ -62 +64 @@
 ;           TVLCT, colors, 100
 ;
-; @keyword NAMES If this keyword is set, the return value of the function is
-;              a 16-element string array containing the names of the colors.
-;              These names would be appropriate, for example, in building
-;              a list widget with the names of the colors. If the NAMES
-;              keyword is set, the COLOR and INDEX parameters are ignored.
-;
-;                 listID = Widget_List(baseID, Value=GetColor(/Names), YSize=16)
-;
-; @keyword LOAD  If this keyword is set, all 16 colors are automatically loaded
-;              starting at the color index specified by the START keyword.
-;              Note that setting this keyword means that the return value of the
-;              function will be a structure, with each field of the structure
-;              corresponding to a color name. The value of each field will be
-;              an index number (set by the START keyword) corresponding to the
-;              associated color, or a 24-bit long integer value that creates the
-;              color on a true-color device. What you have as the field values is
-;              determined by the TRUE keyword or whether color decomposition is on
-;              or off in the absense of the TRUE keyword. It will either be a 1-by-3
-;              byte array or a long integer value.
-;
-; @keyword START The starting color index number if the LOAD keyword is set. This keyword
-;              value is ignored unless the LOAD keyword is also set. The keyword is also
-;              ignored if the TRUE keyword is set or if color decomposition in on in
-;              IDL 5.2 and higher. The default value for the START keyword is
-;              !D.TABLE_SIZE - 17.
-;
-; @keyword TRUE  If this keyword is set, the specified color triple is returned
-;              as a 24-bit integer equivalent. The lowest 8 bits correspond to
-;              the red value; the middle 8 bits to the green value; and the
-;              highest 8 bits correspond to the blue value. In IDL 5.2 and higher,
-;              if color decomposition is turned on, it is as though this keyword
-;              were set.
-;
-; @restrictions The TRUE keyword causes the START keyword to be ignored.
-;       The NAMES keyword causes the COLOR, INDEX, START, and TRUE parameters to be ignored.
-;       The COLOR parameter is ignored if the LOAD keyword is used.
-;       On systems where it is possible to tell the state of color decomposition
-;       (i.e., IDL 5.2 and higher), a 24-bit value (or values) is automatically
-;       returned if color decomposition is ON.
-;
-; 
-; @examples To load a yellow color in color index 100 and plot in yellow, type:
-;
-;          IDL> yellow = GETCOLOR('yellow', 100)
-;          IDL> PLOT, data, COLOR=yellow
+; @keyword NAMES 
+; If this keyword is set, the return value of the function is
+; a 16-element string array containing the names of the colors.
+; These names would be appropriate, for example, in building
+; a list widget with the names of the colors. If the NAMES
+; keyword is set, the COLOR and INDEX parameters are ignored.
+;
+; listID = Widget_List(baseID, Value=GetColor(/Names), YSize=16)
+;
+; @keyword LOAD  
+; If this keyword is set, all 16 colors are automatically loaded
+; starting at the color index specified by the START keyword.
+; Note that setting this keyword means that the return value of the
+; function will be a structure, with each field of the structure
+; corresponding to a color name. The value of each field will be
+; an index number (set by the START keyword) corresponding to the
+; associated color, or a 24-bit long integer value that creates the
+; color on a true-color device. What you have as the field values is
+; determined by the TRUE keyword or whether color decomposition is on
+; or off in the absence of the TRUE keyword. It will either be a 1-by-3
+; byte array or a long integer value.
+;
+; @keyword START {default=!D.TABLE_SIZE - 17}
+; The starting color index number if the LOAD keyword is set. This keyword
+; value is ignored unless the LOAD keyword is also set. The keyword is also
+; ignored if the TRUE keyword is set or if color decomposition in on in
+; IDL 5.2 and higher. The default value for the START keyword is
+;
+; @keyword TRUE  
+; If this keyword is set, the specified color triple is returned
+; as a 24-bit integer equivalent. The lowest 8 bits correspond to
+; the red value; the middle 8 bits to the green value; and the
+; highest 8 bits correspond to the blue value. In IDL 5.2 and higher,
+; if color decomposition is turned on, it is as though this keyword
+; were set.
+;
+; @restrictions 
+; The TRUE keyword causes the START keyword to be ignored.
+; The NAMES keyword causes the COLOR, INDEX, START, and TRUE parameters to be 
+; ignored.
+; The COLOR parameter is ignored if the LOAD keyword is used.
+; On systems where it is possible to tell the state of color decomposition
+; (i.e., IDL 5.2 and higher), a 24-bit value (or values) is automatically
+; returned if color decomposition is ON.
+;
+; @examples 
+; To load a yellow color in color index 100 and plot in yellow, type:
+;
+; IDL> yellow = GETCOLOR('yellow', 100)
+; IDL> PLOT, data, COLOR=yellow
 ;
 ;       or,
 ;
-;          IDL> PLOT, data, COLOR=GETCOLOR('yellow', 100)
-;
-;       To do the same thing on a 24-bit color system with decomposed color on, type:
-;
-;          IDL> PLOT, data, COLOR=GETCOLOR('yellow', /TRUE)
+; IDL> PLOT, data, COLOR=GETCOLOR('yellow', 100)
+;
+; To do the same thing on a 24-bit color system with decomposed color on, type:
+;
+; IDL> PLOT, data, COLOR=GETCOLOR('yellow', /TRUE)
 ;
 ;       or in IDL 5.2 and higher,
 ;
-;          IDL> DEVICE, Decomposed=1
-;          IDL> PLOT, data, COLOR=GETCOLOR('yellow')
-;
-;       To load all 16 colors into the current color table, starting at
-;       color index 200, type:
-;
-;          IDL> TVLCT, GETCOLOR(), 200
-;
-;       To add the color names to a list widget:
-;
-;           IDL> listID = Widget_List(baseID, Value=GetColor(/Names), YSize=16)
-;
-;       To load all 16 colors and have the color indices returned in a structure:
-;
-;           IDL> DEVICE, Decomposed=0
-;           IDL> colors = GetColor(/Load, Start=1)
-;           IDL> HELP, colors, /Structure
-;           PLOT, data, COLOR=colors.yellow
-;
-;       To get the direct color values as 24-bit integers in color structure fields:
-;
-;           IDL> DEVICE, Decomposed=1
-;           IDL> colors = GetColor(/Load)
-;           IDL> PLOT, data, COLOR=colors.yellow
-;
-;       Note that the START keyword value is ignored if on a 24-bit device,
-;       so it is possible to write completely device-independent code by
-;       writing code like this:
-;
-;           IDL> colors = GetColor(/Load)
-;           IDL> PLOT, data, Color=colors.yellow;           IDL> DEVICE, Decomposed=0
-;           IDL> colors = GetColor(/Load, Start=1)
-;           IDL> HELP, colors, /Structure
-;           PLOT, data, COLOR=colors.yellow
-;
-;       To get the direct color values as 24-bit integers in color structure fields:
-;
-;           IDL> DEVICE, Decomposed=1
-;           IDL> colors = GetColor(/Load)
-;           IDL> PLOT, data, COLOR=colors.yellow
-;
-;       Note that the START keyword value is ignored if on a 24-bit device,
-;       so it is possible to write completely device-independent code by
-;       writing code like this:
-;
-;           IDL> colors = GetColor(/Load)
-;           IDL> PLOT, data, Color=colors.yellow
+; IDL> DEVICE, Decomposed=1
+; IDL> PLOT, data, COLOR=GETCOLOR('yellow')
+;
+; To load all 16 colors into the current color table, starting at
+; color index 200, type:
+;
+; IDL> TVLCT, GETCOLOR(), 200
+;
+; To add the color names to a list widget:
+;
+; IDL> listID = Widget_List(baseID, Value=GetColor(/Names), YSize=16)
+;
+; To load all 16 colors and have the color indexes returned in a structure:
+;
+; IDL> DEVICE, Decomposed=0
+; IDL> colors = GetColor(/Load, Start=1)
+; IDL> HELP, colors, /Structure
+; PLOT, data, COLOR=colors.yellow
+;
+; To get the direct color values as 24-bit integers in color structure fields:
+;
+; IDL> DEVICE, Decomposed=1
+; IDL> colors = GetColor(/Load)
+; IDL> PLOT, data, COLOR=colors.yellow
+;
+; Note that the START keyword value is ignored if on a 24-bit device,
+; so it is possible to write completely device-independent code by
+; writing code like this:
+;
+; IDL> colors = GetColor(/Load)
+; IDL> PLOT, data, Color=colors.yellow;           IDL> DEVICE, Decomposed=0
+; IDL> colors = GetColor(/Load, Start=1)
+; IDL> HELP, colors, /Structure
+; IDL> PLOT, data, COLOR=colors.yellow
+;
+; To get the direct color values as 24-bit integers in color structure fields:
+;
+; IDL> DEVICE, Decomposed=1
+; IDL> colors = GetColor(/Load)
+; IDL> PLOT, data, COLOR=colors.yellow
+;
+; Note that the START keyword value is ignored if on a 24-bit device,
+; so it is possible to write completely device-independent code by
+; writing code like this:
+;
+; IDL> colors = GetColor(/Load)
+; IDL> PLOT, data, Color=colors.yellow
 ;
 ; @history Written by: David Fanning, 10 February 96.
@@ -171 +178 @@
 ;       Added the INDEX parameter to the program 8 Mar 99. DWF
 ;       Added the NAMES keyword at insistence of Martin Schultz. 10 Mar 99. DWF
-;       Reorderd the colors so black is first and white is last. 7 June 99. DWF
+;       Reordered the colors so black is first and white is last. 7 June 99. DWF
 ;       Added automatic recognition of DECOMPOSED=1 state. 7 June 99. DWF
 ;       Added LOAD AND START keywords. 7 June 99. DWF.
@@ -292 +299 @@
 colorIndex = WHERE(names EQ thisColor)
 
-   ; If you can't find it. Issue an infomational message,
+   ; If you can't find it. Issue an informational message,
    ; set the index to a YELLOW color, and continue.
 

trunk/SRC/Colors/lct.pro

@@ -12 +12 @@
 ;
 ; @keyword LIGHTNESS a scalar used to change the Lightness of the color
-;            palette to be abble to adjust according to the printer we use,
+;            palette to be able to adjust according to the printer we use,
 ;            the media (paper or slide)... 
 ;               lightness < 1 to get lighter colors
@@ -22 +22 @@
 ;
 ; @keyword GET_NAME Set this keyword to a named variable in which the names of the color tables
-;          are reurned as a string array. No changes are made to the color table.
+;          are returned as a string array. No changes are made to the color table.
 ;
 ; @keyword _EXTRA Used to pass your keywords
@@ -28 +28 @@
 ; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;          30/3/1999: add extra
-;          6/7/1999: mac/windows comptibility
+;          6/7/1999: mac/windows compatibility
 ;
 ; @version $Id$
@@ -43 +43 @@
 ; definition of the name of the file containing colors palettes.
    if keyword_set(file) then nametbl = file ELSE nametbl = 'palette.tbl'
-; What is the full adress of nametbl?
+; What is the full address of nametbl?
    thisOS = strupcase(strmid(!version.os_family, 0, 3))
    CASE thisOS of

trunk/SRC/Colors/newpalette.pro

@@ -11 +11 @@
 ; @categories graphic, color specification
 ;
-; @param namepal {in}{required} It is a string containing the name of the new palettte we want to write.
+; @param namepal {in}{required} 
+; It is a string containing the name of the new palette we want to write.
 ;
-; @keyword  OVER It is a whole number which designate the number of the palette
-;               we want to replace the palette on the screen 
+; @keyword OVER 
+; It is a whole number which designate the number of the palette
+; we want to replace the palette on the screen 
 ;
-; @keyword FILE {default=palette.tbl} is not specified, we are looking  a file containing 
-;              palettes named palette.tbl.
-;              This file can be in any directory of the !path
-;              On the other hand it must be writable
+; @keyword FILE {default=palette.tbl} 
+; if not specified, we are looking a file containing palettes named palette.tbl.
+; This file can be in any directory of the !path
+; On the other hand it must be writable
 ;
-; @keyword _extra Used to pass your keywords
+; @keyword _extra 
+; Used to pass your keywords
 ;
 ; @history Guillaume Roulet (gr@lodyc.jussieu.fr)
-;                       30/3/1999 s.masson, add _extra, research of the full name, OVER
+; 30/3/1999 s.masson, add _extra, research of the full name, OVER
 ;                       5/5/1999 s.masson
 ;

trunk/SRC/Colors/xlct.pro

@@ -383 +383 @@
 ;               this ID is specified, a death of the caller results in a 
 ;               death of Xlct
-; @keyword NCOLORS = number of colors to use.  Use color indices from BOTTOM
+; @keyword NCOLORS = number of colors to use.  Use color indexes from BOTTOM
 ;               to the smaller of !D.TABLE_SIZE-1 and NCOLORS-1.
 ;               Default = !D.TABLE_SIZE = all available colors.
-; @keyword BOTTOM = first color index to use. Use color indices from BOTTOM to
+; @keyword BOTTOM = first color index to use. Use color indexes from BOTTOM to
 ;               BOTTOM+NCOLORS-1.  Default = 0.
 ; @keyword SILENT - Normally, no informational message is printed when

trunk/SRC/Colors/xpal.pro

@@ -1 +1 @@
 ;+
 ;
-; @file_comments 
-; like xpalette but shorter to write and ,moreover,
+; @file_comments
+; like xpalette but shorter to write and, moreover,
 ; possess a hotkey save which (thanks to the newpalette routine)
 ; allows to save the routine that we have just done. Comment: when we
-; press the predefined hotkey, it calls xlct instead of xloadct 
+; press the predefined hotkey, it calls xlct instead of xloadct
 ; No explicit inputs.  The current color table is used as a starting point.
 ;
 ; @categories Color tables, widgets.
 ;
-; @keyword BLOCK Set this keyword to have XMANAGER block when this
-;               application is registered.  By default the Xmanager
-;               keyword NO_BLOCK is set to 1 to provide access to the
-;               command line if active command  line processing is available.
-;               Note that setting BLOCK for this application will cause
-;               all widget applications to block, not only this
-;               application.  For more information see the NO_BLOCK keyword
-;               to XMANAGER.
-; @keyword UPDATECALLBACK Set this keyword to a string containing the name of
-;               a user-supplied procedure that will be called when the color
-;               table is updated by XLOADCT.  The procedure may optionally
-;               accept a keyword called DATA, which will be automatically
-;               set to the value specified by the optional UPDATECBDATA
-;               keyword.
-; @keyword UPDATECBDATA Set this keyword to a value of any type. It will be
-;               passed via the DATA keyword to the user-supplied procedure
-;               specified via the UPDATECALLBACK keyword, if any. If the
-;               UPDATECBDATA keyword is not set the value accepted by the
-;               DATA keyword to the procedure specified by UPDATECALLBACK
-;               will be undefined.
-;
-; @uses COLORS: Contains the current RGB color tables.
 ; @uses XP_COM: Private to this module.
 ;
-; @restrictions XPAL uses two colors from the current color table as
-;       drawing foreground and background colors. These are used
-;       for the RGB plots on the left, and the current index marker on
-;       the right. This means that if the user set these two colors
-;       to the same value, the XPAL display could become unreadable
-;       (like writing on black paper with black ink). XPAL minimizes
-;       this possibility by noting changes to the color map and always
-;       using the brightest available color for the foreground color
-;       and the darkest for the background. Thus, the only way
-;       to make XPAL's display unreadable is to set the entire color
-;       map to a single color, which is highly unlikely. The only side
-;       effect of this policy is that you may notice XPAL redrawing
-;       the entire display after you've modified the current color.
-;       This simply means that the change has made XPAL pick new
-;       drawing colors.
-;
-;       The new color tables are saved in the COLORS common and loaded
-;       to the display.
-;
-; @examples The XPAL widget has the following controls:
+; @restrictions
+; XPAL uses two colors from the current color table as
+; drawing foreground and background colors. These are used
+; for the RGB plots on the left, and the current index marker on
+; the right. This means that if the user set these two colors
+; to the same value, the XPAL display could become unreadable
+; (like writing on black paper with black ink). XPAL minimizes
+; this possibility by noting changes to the color map and always
+; using the brightest available color for the foreground color
+; and the darkest for the background. Thus, the only way
+; to make XPAL's display unreadable is to set the entire color
+; map to a single color, which is highly unlikely. The only side
+; effect of this policy is that you may notice XPAL redrawing
+; the entire display after you've modified the current color.
+; This simply means that the change has made XPAL pick new
+; drawing colors.
+;
+; The new color tables are saved in the COLORS common and loaded
+; to the display.
+;
+; @examples
+; The XPAL widget has the following controls:
 ;
 ;       Left:   Three plots showing the current Red, Green, and Blue vectors.
@@ -106 +86 @@
 ;                        3) The name of the file containing palettes.
 ;                        Comment: May follow instructions gave by the prompter.
-;                
+;
 ;
 ;       Three sliders (R, G, and B) that allow the user to modify the
@@ -125 +105 @@
 ;                          horizontally.
 ;
-; @history addaptation de xpalette pour ajouter un bouton save par
-;          Gima Nicolas (nglod@ipsl.jussieu.fr) et par Masson
-;          Sebastien (smlod@ipsl.jussieu.fr)
+; @history adaptation de xpalette pour ajouter un bouton save par
+;          Grima Nicolas (nglod\@ipsl.jussieu.fr) et par Masson
+;          Sebastien (smlod\@ipsl.jussieu.fr)
 ;
 ; $Id$
@@ -134 +114 @@
 ;
 ;+
-; @file_comments XP_NEW_COLORS: Choose the best foreground and background colors for the current
-;                color maps and set !P appropriately. Returns 1 if the colors changed,
-;                0 otherwise.
-;
-; @returns 1 or 0
-;- 
+; @file_comments
+; XP_NEW_COLORS: Choose the best foreground and background colors for
+; the current color maps and set !P appropriately.
+;
+; @returns
+; 1 if the colors changed, 0 otherwise.
+;-
 function XP_NEW_COLORS
 ;
@@ -162 +143 @@
 end
 
+;+
+; @hidden
+;-
 pro XP_ALERT_CALLER
 ;
@@ -187 +171 @@
 end
 ;+
-; @file_comments XP_XLCTCALLBACK:  For visuals with static colormaps, update the graphics
-;                after a change by XLOADCT.
+; @file_comments
+; XP_XLCTCALLBACK:  For visuals with static colormaps, update the graphics
+; after a change by XLOADCT.
 ;-
 pro XP_XLCTCALLBACK
@@ -201 +186 @@
 end
 
+;+
+; @hidden
+;-
 pro XP_REDRAW
 ;
@@ -216 +204 @@
 
 ;+
-; @file_comments XP_REPLOT: Re-draw the RGB plots. Type has the following possible values.
+; @file_comments
+; XP_REPLOT: Re-draw the RGB plots. Type has the following possible values.
 ;       - 'D': Draw the data part of all three plots
 ;       - 'F': draw all three plots
@@ -222 +211 @@
 ;       - 'G': Draw the data part of the Green plot
 ;       - 'B': Draw the data part of the Blue plot
-;- 
+;-
 pro XP_REPLOT, color_index, type
 ;
@@ -240 +229 @@
   save_x_s = !x.s
   save_y_s = !y.s
-  save_x_type = !x.type 
-  save_y_type = !y.type 
+  save_x_type = !x.type
+  save_y_type = !y.type
 
   !y.margin= [2, 2]
@@ -435 +424 @@
 
       7: goto, do_copy
-      8: BEGIN 
+      8: BEGIN
          COMMON basecommon,  bas212, bas222,  bas232
          base = WIDGET_BASE(/COLUMN, /FRAME)
@@ -476 +465 @@
   THEN BEGIN
     CASE uval OF
-     'ok' :BEGIN 
+     'ok' :BEGIN
         WIDGET_CONTROL, bas212, GET_VALUE = palname
         WIDGET_CONTROL, bas222, GET_VALUE = over
@@ -541 +530 @@
 ;+
 ;
-; @keyword group 
-;
-; @keyword BLOCK Set this keyword to have XMANAGER block when this
-;               application is registered.  By default the Xmanager
-;               keyword NO_BLOCK is set to 1 to provide access to the
-;               command line if active command  line processing is available.
-;               Note that setting BLOCK for this application will cause
-;               all widget applications to block, not only this
-;               application.  For more information see the NO_BLOCK keyword
-;               to XMANAGER.
-; @keyword UPDATECALLBACK Set this keyword to a string containing the name of
-;               a user-supplied procedure that will be called when the color
-;               table is updated by XLOADCT.  The procedure may optionally
-;               accept a keyword called DATA, which will be automatically
-;               set to the value specified by the optional UPDATECBDATA
-;               keyword.
-; @keyword UPDATECBDATA Set this keyword to a value of any type. It will be
-;               passed via the DATA keyword to the user-supplied procedure
-;               specified via the UPDATECALLBACK keyword, if any. If the
-;               UPDATECBDATA keyword is not set the value accepted by the
-;               DATA keyword to the procedure specified by UPDATECALLBACK
-;               will be undefined.
-;
-;-
-
-
-
+; @keyword group
+;
+; @keyword BLOCK
+; Set this keyword to have XMANAGER block when this
+; application is registered.  By default the Xmanager
+; keyword NO_BLOCK is set to 1 to provide access to the
+; command line if active command line processing is available.
+; Note that setting BLOCK for this application will cause
+; all widget applications to block, not only this
+; application.  For more information see the NO_BLOCK keyword
+; to XMANAGER.
+;
+; @keyword UPDATECALLBACK
+; Set this keyword to a string containing the name of
+; a user-supplied procedure that will be called when the color
+; table is updated by XLOADCT.  The procedure may optionally
+; accept a keyword called DATA, which will be automatically
+; set to the value specified by the optional UPDATECBDATA
+; keyword.
+;
+; @keyword UPDATECBDATA
+; Set this keyword to a value of any type. It will be
+; passed via the DATA keyword to the user-supplied procedure
+; specified via the UPDATECALLBACK keyword, if any. If the
+; UPDATECBDATA keyword is not set the value accepted by the
+; DATA keyword to the procedure specified by UPDATECALLBACK
+; will be undefined.
+;
+;-
 pro XPAL, group=group, BLOCK=block, UPDATECALLBACK=updt_cb_name, $
         UPDATECBDATA=updt_cb_data
@@ -584 +575 @@
 
   xpw = { xp_widgets, base:0L, $
-        colorsel:0L, mark_label:0L, idx_label:0L, button_base:0L, rgb_base:0L}
+  colorsel:0L, mark_label:0L, idx_label:0L, button_base:0L, rgb_base:0L}
 
   state = {old_p:!p, $                     ; Original value of !P
-           mark_idx:0, $                   ; Current mark index
-           cur_idx:0, $                    ; Current index
-           cur_color_win:0, $              ; Current Color draw window index
-           plot_win:0, $                   ; RGB plot draw window index
-           updt_callback: updt_callback, $ ; user-defined callback (optional)
-           p_updt_cb_data:p_updt_cb_data}  ; data for callback (optional)
+   mark_idx:0, $                   ; Current mark index
+   cur_idx:0, $                    ; Current index
+   cur_color_win:0, $              ; Current Color draw window index
+   plot_win:0, $                   ; RGB plot draw window index
+   updt_callback: updt_callback, $ ; user-defined callback (optional)
+   p_updt_cb_data:p_updt_cb_data}  ; data for callback (optional)
 
   if (XREGISTERED('XPAL')) then return      ; Only one copy at a time
@@ -610 +601 @@
   save_win = !d.window          ;Previous window
 
-  IF N_ELEMENTS(r_orig) LE 0 THEN BEGIN ;If no common, use current colors
-        TVLCT, r_orig, g_orig, b_orig, /GET
-        r_curr = r_orig
-        b_curr = b_orig
-        g_curr = g_orig
-        ENDIF
+  IF N_ELEMENTS(r_orig) LE 0 THEN BEGIN ;If no common, use current colors
+   TVLCT, r_orig, g_orig, b_orig, /GET
+   r_curr = r_orig
+   b_curr = b_orig
+   g_curr = g_orig
+  ENDIF
 
   ; Create widgets
@@ -631 +622 @@
 
   c1 = WIDGET_BASE(xpw.base, /COLUMN, space=20)
-    status = WIDGET_BASE(c1, /COLUMN, /FRAME)
-      ncw = WIDGET_LABEL(WIDGET_BASE(status), /DYNAMIC_RESIZE)
-      xpw.idx_label = CW_FIELD(status, title='Current Index: ', value='0', $
-                               xsize=20, /STRING)
-      xpw.mark_label = CW_FIELD(status, title='Mark Index:    ', value='0', $
-                                xsize=20, /STRING)
-      c1_1 = widget_base(status, /ROW)
-        junk = WIDGET_LABEL(c1_1, value="Current Color: ")
-          cur_color = WIDGET_DRAW(c1_1, xsize = 125, ysize=50, /frame)
-    names = [ 'Done', 'Predefined', 'Help', 'Redraw', 'Set Mark', $
-                'Switch Mark', 'Copy Current', 'Interpolate', 'save']
-    xpw.button_base = CW_BGROUP(c1, names, COLUMN=3, /FRAME)
-    xpw.rgb_base = CW_RGBSLIDER(c1, /FRAME, /DRAG)
-
-    junk = WIDGET_BASE(xpw.base)        ; Responds to YOFFSET
+  status = WIDGET_BASE(c1, /COLUMN, /FRAME)
+  ncw = WIDGET_LABEL(WIDGET_BASE(status), /DYNAMIC_RESIZE)
+  xpw.idx_label = CW_FIELD(status, title='Current Index: ', value='0', $
+  xsize=20, /STRING)
+  xpw.mark_label = CW_FIELD(status, title='Mark Index:    ', value='0', $
+  xsize=20, /STRING)
+  c1_1 = widget_base(status, /ROW)
+  junk = WIDGET_LABEL(c1_1, value="Current Color: ")
+  cur_color = WIDGET_DRAW(c1_1, xsize = 125, ysize=50, /frame)
+  names = [ 'Done', 'Predefined', 'Help', 'Redraw', 'Set Mark', $
+  'Switch Mark', 'Copy Current', 'Interpolate', 'save']
+  xpw.button_base = CW_BGROUP(c1, names, COLUMN=3, /FRAME)
+  xpw.rgb_base = CW_RGBSLIDER(c1, /FRAME, /DRAG)
+
+  junk = WIDGET_BASE(xpw.base)        ; Responds to YOFFSET
     if (version.style='Motif') then junk2=30 else junk2 = 50
     xpw.colorsel = CW_COLORSEL(junk, yoffset=junk2)
-
 
   state.cur_idx = 0
@@ -658 +648 @@
 
   WIDGET_CONTROL, ncw, $
-        set_value='Number Of Colors: ' + strcompress(!d.n_colors, /REMOVE_ALL)
+ set_value='Number Of Colors: ' + strcompress(!d.n_colors, /REMOVE_ALL)
   WIDGET_CONTROL, get_value=tmp, cur_color
   state.cur_color_win = tmp
@@ -672 +662 @@
 
   XMANAGER, 'Xpal', xpw.base, event_handler='XP_EVENT', group=group, $
-        NO_BLOCK=(NOT(FLOAT(block)))
-end
-
+  NO_BLOCK=(NOT(FLOAT(block)))
+end
+