Changeset 133 for trunk

trunk/SRC/Calendar/caldat.pro

-                      r132
+                      r133
 ; $Id$
+;+
+;
+; Copyright (c) 1992-2003, Research Systems, Inc.  All rights reserved.
+;       Unauthorized reproduction prohibited.
+;
+;+
+; NAME:
+;       CALDAT
+;
+; PURPOSE:
+; @file_comments
 ;       Return the calendar date and time given julian date.
 ;       This is the inverse of the function JULDAY.
 ; CATEGORY:
 ;       Misc.
+;
+; @categories Calendar
+;
-; CALLING SEQUENCE:
-;       CALDAT, Julian, Month, Day, Year, Hour, Minute, Second
-;       See also: julday, the inverse of this function.
+;
+; INPUTS:
+;       JULIAN contains the Julian Day Number (which begins at noon) of the
+; @param JULIAN {in}{required} contains the Julian Day Number (which begins at noon) of the
 ;       specified calendar date.  It should be a long integer.
-; OUTPUTS:
-;       (Trailing parameters may be omitted if not required.)
-;       MONTH:  Number of the desired month (1 = January, ..., 12 = December).
+;
 ;       DAY:    Number of day of the month.
+; @param MONTH {out} Number of the desired month (1 = January, ..., 12 = December).
+;
 ;       YEAR:   Number of the desired year.
+; @param DAY {out} Number of day of the month.
+;
+;       HOUR:   Hour of the day
+;       Minute: Minute of the day
+;       Second: Second (and fractions) of the day.
+; @param YEAR {out} Number of the desired year.
+;
 ; KEYWORD PARAMETERS:
+; @param HOUR {out} Hour of the day
+;
+;       NDAYSPM: for using a calendar with fixed number of days per
+;                months. defaut value of NDAYSPM=30
+; @param Minute {out} Minute of the day
+;
 ; COMMON BLOCKS: cm_4cal
+; @param Second {out} Second (and fractions) of the day.
+;
-; SIDE EFFECTS:
-;       None.
+;
+; RESTRICTIONS:
+;       Accuracy using IEEE double precision numbers is approximately
+; @keyword NDAYSPM {default=30} for using a calendar with fixed number of days per
+;                months.
+;
+; @uses cm_4cal
+;
+;
+; @restrictions Accuracy using IEEE double precision numbers is approximately
 ;       1/10000th of a second.
+;
+; MODIFICATION HISTORY:
+;       Translated from "Numerical Recipies in C", by William H. Press,
+; @history Translated from "Numerical Recipies in C", by William H. Press,
 ;       Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling.
 ;       Cambridge University Press, 1988 (second printing).
 …
+;
 ;       AB, 3 January 2000, Make seconds output as DOUBLE in array output.
+;
+; @version $Id$
 ;-
+;
 pro CALDAT, julian, month, day, year, hour, minute, second, NDAYSPM = ndayspm
 ;------------------------------------------------------------

trunk/SRC/Calendar/julday.pro

-                      r132
+                      r133
-; $Id$
+;
-; Copyright (c) 1988-2003, Research Systems, Inc.  All rights reserved.
-;       Unauthorized reproduction prohibited.
 ;+
+; NAME:
+;       JULDAY
+;
+; PURPOSE:
+;       Calculate the Julian Day Number for a given month, day, and year.
+;
+; @file_comments
+;       Calculate the Julian Day Number for a given month, day, and year.
 ;       This is the inverse of the library function CALDAT.
 ;       See also caldat, the inverse of this function.
+;
+; CATEGORY:
+;       Misc.
+;
+; CALLING SEQUENCE:
+;       Result = JULDAY([[[[Month, Day, Year], Hour], Minute], Second])
+;
+; INPUTS:
+;       MONTH:  Number of the desired month (1 = January, ..., 12 = December).
+;
+;       DAY:    Number of day of the month.
+;
+;       YEAR:   Number of the desired year.Year parameters must be valid
+; @categories Calendar
+;
+; @param MONTH {in}{required} Number of the desired month (1 = January, ..., 12 = December). Can be scalar or array
+;
+; @param DAY {in}{required} Number of day of the month.Can be scalar or array
+;
+; @param YEAR {in}{required} Number of the desired year.Year parameters must be valid
 ;               values from the civil calendar.  Years B.C.E. are represented
 ;               as negative integers.  Years in the common era are represented
 ;               as positive integers.  In particular, note that there is no
 ;               year 0 in the civil calendar.  1 B.C.E. (-1) is followed by
+;               1 C.E. (1).
+;
+;       HOUR:   Number of the hour of the day.
+;
+;       MINUTE: Number of the minute of the hour.
+;
+;       SECOND: Number of the second of the minute.
+;
+;   Note: Month, Day, Year, Hour, Minute, and Second can all be arrays.
+;         The Result will have the same dimensions as the smallest array, or
+;               1 C.E. (1). Can be scalar or array
+;
+; @param HOUR {in}{optional} Number of the hour of the day. Can be scalar or array
+;
+; @param MINUTE {in}{optional} Number of the minute of the hour. Can be scalar or array
+;
+; @param SECOND {in}{optional} Number of the second of the minute. Can be scalar or array
+;
+; @restrictions The Result will have the same dimensions as the smallest array, or
 ;         will be a scalar if all arguments are scalars.
+;
+; OPTIONAL INPUT PARAMETERS:
+;       Hour, Minute, Second = optional time of day.
+;
+; KEYWORD PARAMETERS:
+;
+;       NDAYSPM: for using a calendar with fixed number of days per
+;                months. defaut value of NDAYSPM=30
+;
+; OUTPUTS:
+;       JULDAY returns the Julian Day Number (which begins at noon) of the
+;
+;
+; @keywords NDAYSPM {default=30} for using a calendar with fixed number of days per
+;                months.
+;
+; @ returns JULDAY: the Julian Day Number (which begins at noon) of the
 ;       specified calendar date.  If Hour, Minute, and Second are not specified,
 ;       then the result will be a long integer, otherwise the result is a
 ;       double precision floating point number.
+;
+; COMMON BLOCKS: cm_4cal
+;
+; SIDE EFFECTS:
+;       None.
+;
+; RESTRICTIONS:
+;       Accuracy using IEEE double precision numbers is approximately
+; @uses cm_4cal
+;
+; @restrictions Accuracy using IEEE double precision numbers is approximately
 ;   1/10000th of a second, with higher accuracy for smaller (earlier)
 ;   Julian dates.
+;
+; MODIFICATION HISTORY:
+;       Translated from "Numerical Recipies in C", by William H. Press,
+; @history Translated from "Numerical Recipies in C", by William H. Press,
 ;       Brian P. Flannery, Saul A. Teukolsky, and William T. Vetterling.
 ;       Cambridge University Press, 1988 (second printing).
 …
+;
 ;   CT, April 2000, Now accepts vectors or scalars.
+;
+; @version $Id$
 ;-
+;

trunk/SRC/Colors/color24.pro

-                      r132
+                      r133
 ;+
-; NAME:
-;       COLOR24
+;
 ; PURPOSE:
 ;       The purpose of this function is to convert a RGB color triple
 ;       into the equivalent 24-big long integer.
+; @file_comments
+; The purpose of this function is to convert a RGB color triple
+; into the equivalent 24-big long integer.
+;
+; CATEGORY:
+;       Graphics, Color Specification.
+; @categories Graphics, Color Specification.
+;
+; CALLING SEQUENCE:
+;       color = COLOR24(rgb_triple)
+;
+; INPUTS:
+;       RGB_TRIPLE: A three-element column or row array representing
+; @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.
+;
+; KEYWORD PARAMETERS:
+;       None.
+; @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)
+; 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.
+;
+; COMMON BLOCKS:
+;       None.
+;
+; SIDE EFFECTS:
+;       None.
+;
+; RESTRICTIONS:
+;       None.
+;
+; EXAMPLE:
+;       To convert the color triple for the color YELLOW,
+; @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:
 …
 ;       COLORS or GETCOLOR
+;
 ; MODIFICATION HISTORY:
+; @history
 ;       Written by:     David Fanning, 3 February 96.
+;
+; @version $Id$
+;
 ;-
 FUNCTION COLOR24, number
+;
   compile_opt idl2, strictarrsubs
+;
+   ; This FUNCTION accepts a [red, green, blue] triple that
+   ; describes a particular color and returns a 24-bit long
+   ; integer that is equivalent to that color. The color is
+   ; described in terms of a hexidecimal 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.
+   ;
+   ; The triple can be either a row or column vector of 3 elements.
+;
 ON_ERROR, 1

trunk/SRC/Colors/colorbar.pro

-                      r132
+                      r133
 ;+
+; NAME:
+;   COLORBAR
+;
+; PURPOSE:
+;       The purpose of this routine is to add a color bar to the current
+;       graphics window.
+;
+; CATEGORY:
+;       Graphics, Widgets.
+;
+; CALLING SEQUENCE:
+;       COLORBAR
+;
+; INPUTS:
+;       None.
+;
+; KEYWORD PARAMETERS:
+;
+;       BOTTOM: The lowest color index of the colors to be loaded in
+;
+; @file_comments
+; The purpose of this routine is to add a color bar to the current
+; graphics window.
+;
+; @categories Graphics, Widgets.
+;
+; @keyword BOTTOM The lowest color index of the colors to be loaded in
 ;                 the bar.
+;
 ;       CB_CHARSIZE: The character size of the color bar annotations. Default is 1.0.
+;
 ;       CB_CHARTICK: The character thick of the color bar annotations. Default is 1.0.
+;
 ;       CB_COLOR:    The color index of the bar outline and characters. Default
+; @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.
+;
 ;       CB_LOG: to get logarithmic scale for the colorbar
+;
 ;       CB_TITLE:    This is title for the color bar. The default is to have
+; @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.
+;
 ;       DISCRET:  Vecteur contenant les incices des couleurs a tracer en barre
 ; de couleur. On obtient ainsi une barre de couleur discrete ne comportant que
 ; les couleurs specifiees ds l'ordre ou elles apparaissent ds le vecteur.
+;
 ;       DIVISIONS: The number of divisions to divide the bar into. There will
+; @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.
+;
+;       FORMAT:   The format of the bar annotations. Default is '(F6.2)'.
+;
+;       CB_LABEL:    C''est un vecteur qui specifie la valeur des sticks
+;       presents dans la barre de couleur. Il permet qd on utilise
+;       DISCRET d''avoir des couleurs qui ne s''incrementent pas de
+;       facon regulieres.
+;
+;       MAX:      The maximum data value for the bar annotation. Default is
+; @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.
+;
 ;       MIN:      The minimum data value for the bar annotation. Default is 0.
+;
 ;       NCOLORS:  This is the number of colors in the color bar.
+;
 ;       NOTITLE:  oblige a ne pas mettre de titre meme si cb_title est declare
+;
 ;       POSITION: A four-element array of normalized coordinates in the same
+; @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.
+;
 ;       PSCOLOR:  This keyword is only applied if the output is being sent to
+; @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
 …
 ;                 are outputting to a color PostScript printer.
+;
 ;       RIGHT:    This puts the labels on the right-hand side of a vertical
+; @keyword RIGHT This puts the labels on the right-hand side of a vertical
 ;                 color bar. It applies only to vertical color bars.
+;
 ;       TOP:      This puts the labels on top of the bar rather than under it.
+; @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.
+;
 ;       VERTICAL: Setting this keyword give a vertical color bar. The default
+; @keyword VERTICAL Setting this keyword give a vertical color bar. The default
 ;                 is a horizontal color bar.
+;
+; COMMON BLOCKS:
+;       None.
+;
+; SIDE EFFECTS:
+;       Color bar is drawn in the current graphics window.
+;
+; RESTRICTIONS:
+;       The number of colors available on the display device (not the
+; @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.
+;
+; EXAMPLE:
+;       To display a horizontal color bar above a contour plot, type:
+;
+;       LOADCT, 5, NCOLORS=100
+;       CONTOUR, DIST(31,41), POSITION=[0.15, 0.15, 0.95, 0.75], $
+;          C_COLORS=INDGEN(25)*4, NLEVELS=25
+;       COLORBAR, NCOLORS=100
+;
+; MODIFICATION HISTORY:
+;       Written by: David Fanning, 10 JUNE 96.
+; @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
 …
 ;       3/3/98:  ajout du keyword discret par
 ;                sebastien (smasson@lodyc.jussieu.fr)
+;
+; @version $Id$
+;
 ;-
 PRO COLORBAR, BOTTOM=bottom, CB_CHARSIZE=cb_charsize, CB_CHARTHICK=cb_charthick $
               , CB_COLOR=cb_color, $
               DIVISIONS=divisions, DISCRET=discret,CB_LABEL = cb_label, $
+              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
 …
    IF KEYWORD_SET(vertical) THEN BEGIN
       IF KEYWORD_SET(discret) THEN begin
          facteur=256/n_elements(discret)
          discret=reform(replicate(1,facteur) # discret,facteur*n_elements(discret), /overwrite)
          bar = REPLICATE(1B,10) # discret
+      IF KEYWORD_SET(discrete) THEN begin
+         facteur=256/n_elements(discrete)
+         discrete=reform(replicate(1,facteur) # discrete,facteur*n_elements(discrete), /overwrite)
+         bar = REPLICATE(1B,10) # discrete
       endif else  bar = REPLICATE(1B,10) # BINDGEN(256)
       IF N_ELEMENTS(position) EQ 0 THEN position = [0.88, 0.15, 0.95, 0.95]
    ENDIF ELSE BEGIN
       IF KEYWORD_SET(discret) THEN begin
          facteur=256/n_elements(discret)
          discret=reform(replicate(1,facteur) # discret,facteur*n_elements(discret), /overwrite)
          bar =  discret # REPLICATE(1B,10)
+      IF KEYWORD_SET(discrete) THEN begin
+         facteur=256/n_elements(discrete)
+         discrete=reform(replicate(1,facteur) # discrete,facteur*n_elements(discrete), /overwrite)
+         bar =  discrete # REPLICATE(1B,10)
       endif else bar = BINDGEN(256) # REPLICATE(1B, 10)
       IF N_ELEMENTS(position) EQ 0 THEN position = [0.15, 0.88, 0.95, 0.95]
 …
                                 ; Scale the color bar.
    IF NOT KEYWORD_SET(discret) THEN $
+   IF NOT KEYWORD_SET(discrete) THEN $
     bar = BYTSCL(bar, TOP=ncolors-1) + bottom

trunk/SRC/Colors/getcolor.pro

-                      r132
+                      r133
 ;+
+; NAME:
+;       GETCOLOR
+;
+; PURPOSE:
+;       The original purpose of this function was to enable the
+;       user to specify one of the 16 colors supported by the
+;       McIDAS color map by name. Over time, however, the function
+;       has become a general purpose function for handling and
+;       supporting drawing colors in a device-independent way.
+;       In particular, I have been looking for ways to write color
+;       handling code that will work transparently on both 8-bit and
+;       24-bit machines. On 24-bit machines, the code should work the
+;       same where color decomposition is turned on or off.
+;
+; @file_comments
+; The original purpose of this function was to enable the
+; user to specify one of the 16 colors supported by the
+; McIDAS color map by name. Over time, however, the function
+; has become a general purpose function for handling and
+; supporting drawing colors in a device-independent way.
+; In particular, I have been looking for ways to write color
+; handling code that will work transparently on both 8-bit and
+; 24-bit machines. On 24-bit machines, the code should work the
+; 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.)
+;
+; CATEGORY:
+;       Graphics, Color Specification.
+;
+; CALLING SEQUENCE:
+;       result = GETCOLOR(color)
+;
+; OPTIONAL INPUT PARAMETERS:
+;       COLOR: A string with the "name" of the color. Valid names are:
+; @categories Graphics, Color Specification.
+;
+; @param thisColor {in}{optional} A string with the "name" of the color. Valid names are:
 ;           black
 ;           magenta
 …
 ;           IDL 5.2 or higher.
+;
 ;       INDEX: 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
 …
 ;           TVLCT, colors, 100
+;
+;
+; INPUT KEYWORD PARAMETERS:
+;
+;       NAMES: If this keyword is set, the return value of the function is
+; @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
 …
 ;                 listID = Widget_List(baseID, Value=GetColor(/Names), YSize=16)
+;
 ;       LOAD:  If this keyword is set, all 16 colors are automatically loaded
+; @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
 …
 ;              byte array or a long integer value.
+;
 ;       START: The starting color index number if the LOAD keyword is set. This keyword
+; @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
 …
 ;              !D.TABLE_SIZE - 17.
+;
 ;       TRUE:  If this keyword is set, the specified color triple is returned
+; @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
 …
 ;              were set.
+;
+; COMMON BLOCKS:
+;       None.
+;
+; SIDE EFFECTS:
+;       None.
+;
+; RESTRICTIONS:
+;       The TRUE keyword causes the START keyword to be ignored.
+; @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.
 …
 ;       returned if color decomposition is ON.
+;
 ; EXAMPLE:
 ;       To load a yellow color in color index 100 and plot in yellow, type:
+;
 ;          yellow = GETCOLOR('yellow', 100)
 ;          PLOT, data, COLOR=yellow
+;
+; @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,
+;
 ;          PLOT, data, COLOR=GETCOLOR('yellow', 100)
+;          IDL> PLOT, data, COLOR=GETCOLOR('yellow', 100)
+;
 ;       To do the same thing on a 24-bit color system with decomposed color on, type:
+;
 ;          PLOT, data, COLOR=GETCOLOR('yellow', /TRUE)
+;          IDL> PLOT, data, COLOR=GETCOLOR('yellow', /TRUE)
+;
 ;       or in IDL 5.2 and higher,
+;
 ;          DEVICE, Decomposed=1
 ;          PLOT, data, COLOR=GETCOLOR('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:
+;
 ;          TVLCT, GETCOLOR(), 200
+;          IDL> TVLCT, GETCOLOR(), 200
+;
 ;       To add the color names to a list widget:
+;
 ;           listID = Widget_List(baseID, Value=GetColor(/Names), YSize=16)
+;           IDL> listID = Widget_List(baseID, Value=GetColor(/Names), YSize=16)
+;
 ;       To load all 16 colors and have the color indices returned in a structure:
+;
 ;           DEVICE, Decomposed=0
 ;           colors = GetColor(/Load, Start=1)
 ;           HELP, colors, /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:
+;
 ;           DEVICE, Decomposed=1
 ;           colors = GetColor(/Load)
 ;           PLOT, data, COLOR=colors.yellow
+;           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,
 …
 ;       writing code like this:
+;
+;           colors = GetColor(/Load)
+;           PLOT, data, Color=colors.yellow
+;
+; MODIFICATION HISTORY:
+;       Written by: David Fanning, 10 February 96.
+;           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
+;
+; @history Written by: David Fanning, 10 February 96.
 ;       Fixed a bug in which N_ELEMENTS was spelled wrong. 7 Dec 96. DWF
 ;       Added the McIDAS colors to the program. 24 Feb 99. DWF
 …
 ;       Added automatic recognition of DECOMPOSED=1 state. 7 June 99. DWF
 ;       Added LOAD AND START keywords. 7 June 99. DWF.
+;
+; @version $Id$
 ;-
-FUNCTION COLOR24, number
+;
-  compile_opt idl2, strictarrsubs
+;
-   ; This FUNCTION accepts a [red, green, blue] triple that
-   ; describes a particular color and returns a 24-bit long
-   ; integer that is equivalent to that color. The color is
-   ; described in terms of a hexidecimal 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.
+   ;
-   ; The triple can be either a row or column vector of 3 elements.
-ON_ERROR, 1
-IF N_ELEMENTS(number) NE 3 THEN $
-   MESSAGE, 'Augument must be a three-element vector.'
-IF MAX(number) GT 255 OR MIN(number) LT 0 THEN $
-   MESSAGE, 'Argument values must be in range of 0-255'
-base16 = [[1L, 16L], [256L, 4096L], [65536L, 1048576L]]
-num24bit = 0L
-FOR j=0,2 DO num24bit = num24bit + ((number[j] MOD 16) * base16[0,j]) + $
-   (Fix(number[j]/16) * base16[1,j])
-RETURN, num24bit
-END ; ************************  of COLOR24  ******************************
 FUNCTION GETCOLOR, thisColor, index, TRUE=truecolor, $

trunk/SRC/Colors/lct.pro

-                      r132
+                      r133
 ;------------------------------------------------------------
 ;+
-; NAME:lct
+;
+; PURPOSE:plus court que de taper loadct,file='palette.tbl'
+; @file_comments
+; Fastest than type loadct,file='palette.tbl'
+;
 ; CATEGORY:flemme
+; @categories graphics, color specification
+;
 ; CALLING SEQUENCE:lct[,numerp_couleur]
+; @param numpal {in}{optional} number of the color palette we want to select in the file palette.tbl
+;
+; INPUTS:optionnel: numero de la couleur que l''on veut ds palette.tbl
+;
+; KEYWORD PARAMETERS: ceux de loadct
+;
+;        LIGHTNESS: a scalar used to change the Lightness of the color
+; @keyword LIGHTNESS a scalar used to change the Lightness of the color
 ;            palette to be abble to adjust according to the printer we use,
 ;            the media (paper or slide)...
 …
 ;                         > 1 to get darker colors
+;
 ; rq: si le mot cle file n''est pas specifie, on cherche un fichier
 ; contenant les palette du nom de palette.tbl.
 ; Ce fichier peut etre dans n''importe quel repertoire du !path
+; @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
+;
+; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+;                       30/3/1999 ajout de _extra, de la recherche
+;                       du nom complet et pour que ca marche aussi en
+;                       mode PS et Z
+;                       6/7/1999: compatibilite mac et windows
+; @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.
+;
+; @keyword _EXTRA Used to pass your keywords
+;
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
+;          30/3/1999: add extra
+;          6/7/1999: mac/windows comptibility
+;
+; @version $Id$
+;
 ;-
 ;------------------------------------------------------------
 ;------------------------------------------------------------
 ;------------------------------------------------------------
 PRO lct, numero, GET_NAME = get_name, LIGHTNESS = Lightness, _EXTRA = ex
+PRO lct, numpal, FILE = file, GET_NAME = get_name, LIGHTNESS = Lightness, _EXTRA = ex
+;
   compile_opt idl2, strictarrsubs
+;
 @common
+; le mot cle file est passe par l''intermediere de EXTRA?
+; definition du mon du fichier qui contient les palettes de couleur
+   if n_elements(ex) NE 0 then BEGIN
+      if (where(tag_names(ex) EQ 'FILE'))[0] NE -1 then nompal=ex.FILE ELSE nompal='palette.tbl'
+   ENDIF ELSE nompal = 'palette.tbl'
+; quelle est l''adresse complete de nompal?
+; 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?
    thisOS = strupcase(strmid(!version.os_family, 0, 3))
    CASE thisOS of
 …
    ENDCASE
    cd, current = current
    if strpos(nompal,sep) lt 0 then BEGIN
+   if strpos(nametbl,sep) lt 0 then BEGIN
       if rstrpos(current,sep) NE strlen(current)-1 then current = current+sep
       multipath = str_sep(!path,pathsep)
 …
        if rstrpos(multipath[i],sep) NE strlen(multipath[i])-1 then $
        multipath[i] = multipath[i] +sep
       nompal = [current, multipath]+ nompal
+      nametbl = [current, multipath]+ nametbl
    ENDIF
 ; on test tous les noms possibles pour trouver ou est le fichier
    nfile=n_elements(nompal)
+; we test all possible name in order to find where file is.
+   nfile=n_elements(nametbl)
    n = 0
    repeat begin
       res = findfile(nompal[n])
+      res = findfile(nametbl[n])
       n = n+1
    endrep until res[0] NE '' OR n EQ n_elements(nompal)
+   endrep until res[0] NE '' OR n EQ n_elements(nametbl)
    if res[0] NE '' then BEGIN
       nompal = nompal[n-1]
+      nametbl = nametbl[n-1]
       if n_elements(ex) NE 0 then $
+       if (where(tag_names(ex) EQ 'FILE'))[0] NE -1 then ex.FILE = nompal
+; si on est en mode POSTSCRIPT, il faut repasser en mode X pour
+; changer la palette de couleur
+        if (where(tag_names(ex) EQ 'FILE'))[0] NE -1 then ex.FILE = nametbl
+; if we are in POSTSCRIPT mode, we have to pass in X mode in order to change the color palette
       oldname = !d.name
       if !d.name EQ 'PS' OR !d.name EQ 'Z' then BEGIN
 …
+;
       if arg_present(get_name) then begin
          if n_elements(numero) EQ 0 then loadct, file=nompal, GET_NAME = get_name, _EXTRA = ex $
          ELSE loadct,numero, file=nompal, /silent, GET_NAME = get_name,_EXTRA = ex
+         if n_elements(numpal) EQ 0 then loadct, file=nametbl, GET_NAME = get_name, _EXTRA = ex $
+         ELSE loadct,numpal, file=nametbl, /silent, GET_NAME = get_name,_EXTRA = ex
       ENDIF ELSE BEGIN
          if n_elements(numero) EQ 0 then loadct, file=nompal, _EXTRA = ex $
          ELSE loadct,numero, file=nompal, /silent, _EXTRA = ex
+         if n_elements(numpal) EQ 0 then loadct, file=nametbl, _EXTRA = ex $
+         ELSE loadct,numpal, file=nametbl, /silent, _EXTRA = ex
       ENDELSE
+;

trunk/SRC/Colors/newpalette.pro

-                      r132
+                      r133
 ;------------------------------------------------------------
 ;+
-; NAME:newpalette
+;
+; PURPOSE:permet de stocker la palette qui est a l''ecran dans un
+; fichier du meme type que celui fournit par defaut dans IDL:
+; @file_comments
+; Allows to stock the palette which is on the screen
+; in a same type file than the one gave by default in IDL
 ; 'colors1.tbl'.
+;
 ; CATEGORY:pour garder ses jolies palettes perso.
+; @categories graphic, color specification
+;
 ; CALLING SEQUENCE:newpalette,nom_de_palette
+; @param namepal {in}{required} It is a string containing the name of the new palettte we want to write.
+;
 ; INPUTS:nom_de_palette: c'est un string qui contient le nom de la
 ; nouvelle palette que l''on veut ecrire.
+; @keyword  OVER It is a whole number which designate the number of the palette
+;               we want to replace the palette on the screen
+;
+; KEYWORD PARAMETERS:
+; @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
+;
+; OVER: c''est un entier qui designe le numero de la palette que l''on
+; veut remplacer par la palette a l''ecran.
+;
+; + ceux de modifyct
+; @keyword _extra Used to pass your keywords
+;
+; rq: si le mot cle file n''est pas specifie, on cherche un fichier
+; contenant les palettes du nom de palette.tbl.
+; Ce fichier peut etre dans n''importe quel repertoire du !path
+; Par contre il doit etre en droit d''ecriture
+; @history Guillaume Roulet (gr@lodyc.jussieu.fr)
+;                       30/3/1999 s.masson, add _extra, research of the full name, OVER
+;                       5/5/1999 s.masson
+;
+; MODIFICATION HISTORY: Guillaume Roulet (gr@lodyc.jussieu.fr)
+;                       30/3/1999 s.masson, ajout de _extra, de le
+;                       recherche du nom complet, de OVER et du blabla
+;                       5/5/1999 s.masson, va copie eventuelle du
+;                       fichier contenant les palettes
+; @version $Id$
+;
+; @todo seb cleaning + traduction
 ;-
 ;------------------------------------------------------------
 ;------------------------------------------------------------
 ;------------------------------------------------------------
+pro newpalette,nom, OVER = over, _extra = ex
+; le mot cle file est passe par l''intermediere de EXTRA?
+; definition du mon du fichier qui contient les palettes de couleur
+pro newpalette,namepal, FILE = file, OVER = over, _extra = ex
+;
   compile_opt idl2, strictarrsubs
+;
+   if n_elements(ex) NE 0 then BEGIN
+      if (where(tag_names(ex) EQ 'FILE'))[0] NE -1 then nompal=ex.FILE ELSE nompal='palette.tbl'
+   ENDIF ELSE nompal = 'palette.tbl'
+   nomcourt = nompal
+; quelle est l''adresse complete de nompal?
+   nompal = find(nompal)
+   if nompal[0] NE 'NOT FOUND' then begin
+      nompal = nompal[0]
+; nompal nous appartient???
+; definition of the name of the file containing colors palettes.
+   if keyword_set(file) then nametbl = file ELSE nametbl = 'palette.tbl'
+   nomcourt = nametbl
+; What is the full adress of nametbl?
+   nametbl = find(nametbl)
+   if nametbl[0] NE 'NOT FOUND' then begin
+      nametbl = nametbl[0]
+; does nametbl is our?
       spawn, 'whoami', login
       appartient = strpos(nompal, login[0])
+      appartient = strpos(nametbl, login[0])
       if appartient EQ -1 then begin
          ouinon = report('Le fichier '+nompal+' ne vous appartient pas, Voulez-vous copier le fichier '+nomcourt+' dans le repertoire courant: '+current+' ?', /default_no, /question)
+         ouinon = report('Le fichier '+nametbl+' ne vous appartient pas, Voulez-vous copier le fichier '+nomcourt+' dans le repertoire courant: '+current+' ?', /default_no, /question)
          if ouinon then return ELSE BEGIN
             spawn, 'cp '+nompal+' '+nomcourt ; on copie
             nompal = nomcourt
             spawn,  'chmod u+w '+nompal ; on se donne les droits d''ecriture
+            spawn, 'cp '+nametbl+' '+nomcourt ; copy
+            nametbl = nomcourt
+            spawn,  'chmod u+w '+nametbl ; give writing rights
          ENDELSE
       endif
    ENDIF ELSE BEGIN             ; aucun fichier nompal a ete trouve
       nompal = nomcourt         ; on recupe le nompal d''origine
       ouinon = report('le fichier de palettes demande '+nompal+' n''existe pas ds les repertoires !path. Voulez-vous cree un fichier '+nompal+' dans le repertoire courant', /default_no, /question)
+   ENDIF ELSE BEGIN             ; no file nametbl found
+      nametbl = nomcourt         ; we reclaim the nametbl source
+      ouinon = report('le fichier de palettes demande '+nametbl+' n''existe pas ds les repertoires !path. Voulez-vous cree un fichier '+nametbl+' dans le repertoire courant', /default_no, /question)
       if NOT ouinon then return
       nomfichsource = filepath('colors1.tbl', subdir=['resource', 'colors'])
       spawn,'cp '+nomfichsource+' '+nompal ; on copie
       spawn,  'chmod u+w '+nompal ; on se donne les droits d''ecriture
+      spawn,'cp '+nomfichsource+' '+nametbl ; copy
+      spawn,  'chmod u+w '+nametbl ; give writing rights
    ENDELSE
    if n_elements(ex) NE 0 then $
     if (where(tag_names(ex) EQ 'FILE'))[0] NE -1 then ex.FILE = nompal
+    if (where(tag_names(ex) EQ 'FILE'))[0] NE -1 then ex.FILE = nametbl
+;
    tvlct,r,g,b,/get
 …
    b=congrid(b,256)
    IF n_elements(over) EQ 0 then over = 255
    modifyct,over,nom,r,g,b,file=nompal, _extra = ex
+   modifyct,over,namepal,r,g,b,file=nametbl, _extra = ex
+;
    return

trunk/SRC/Colors/xlct.pro

-                      r132
+                      r133
-; $Id$
+;
-; Copyright (c) 1991-1998, Research Systems, Inc.  All rights reserved.
-;       Unauthorized reproduction prohibited.
 PRO XLCT_PSAVE                  ;Save/Restore our plotting state.
 …
 ;+
+; NAME:
+;       XLCT
+; PURPOSE:
+;       comme xloadct mais plus cour a ecrire et appelle par defaut la
+;       palette palette.tbl qui peut etre situee dans n''importe quel
+;       repertoire de !path.
+;
+; CATEGORY:
+;       Widgets
+; CALLING SEQUENCE:
+;       XLCT
+; INPUTS:
+;       None.
+; KEYWORDS:
+;       FILE:   If this keyword is set, the file by the given name is used
+; @file_comments
+; Like xloadct but fastest to write and call by default the palette
+; palette.tbl which can be in any directory
+;
+; @categories Widgets
+;
+; @keyword FILE If this keyword is set, the file by the given name is used
 ;               instead of the file colors1.tbl in the IDL directory.  This
 ;               allows multiple IDL users to have their own color table file.
 ;       GROUP = The widget ID of the widget that calls Xlct.  When
+; @keyword GROUP The widget ID of the widget that calls Xlct.  When
 ;               this ID is specified, a death of the caller results in a
 ;               death of Xlct
 ;       NCOLORS = number of colors to use.  Use color indices from BOTTOM
+; @keyword NCOLORS = number of colors to use.  Use color indices from BOTTOM
 ;               to the smaller of !D.TABLE_SIZE-1 and NCOLORS-1.
 ;               Default = !D.TABLE_SIZE = all available colors.
 ;       BOTTOM = first color index to use. Use color indices from BOTTOM to
+; @keyword BOTTOM = first color index to use. Use color indices from BOTTOM to
 ;               BOTTOM+NCOLORS-1.  Default = 0.
 ;       SILENT - Normally, no informational message is printed when
+; @keyword SILENT - Normally, no informational message is printed when
 ;               a color map is loaded. If this keyword is present and
 ;               zero, this message is printed.
 ;       USE_CURRENT: If set, use the current color tables, regardless of
+; @keyword USE_CURRENT: If set, use the current color tables, regardless of
 ;               the contents of the COMMON block COLORS.
 ;       MODAL:  If set, then XLCT runs in "modal" mode, meaning that
+; @keyword MODAL:  If set, then XLCT runs in "modal" mode, meaning that
 ;               all other widgets are blocked until the user quits XLCT.
 ;               A group leader must be specified (via the GROUP keyword)
 ;               for the MODAL keyword to have any effect.   The default
 ;               is to not run in modal mode.
 ;       BLOCK:  Set this keyword to have XMANAGER block when this
+; @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
 …
 ;               application.  For more information see the NO_BLOCK keyword
 ;               to XMANAGER.
 ;       UPDATECALLBACK: Set this keyword to a string containing the name of
+; @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 XLCT.  The procedure may optionally
 …
 ;               set to the value specified by the optional UPDATECBDATA
 ;               keyword.
 ;       UPDATECBDATA: Set this keyword to a value of any type. It will be
+; @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
 …
 ;               will be undefined.
+;
+; OUTPUTS:
+;       None.
+; COMMON BLOCKS:
+;       None.
+; SIDE EFFECTS:
+;       One of the predefined color maps may be loaded.
+; RESTRICTIONS:
+;       This routine uses the LOADCT user library procedure to
+; @restrictions One of the predefined color maps may be loaded.
+;
+; @restrictions This routine uses the LOADCT user library procedure to
 ;       do the actual work.
+; MODIFICATION HISTORY:
+;       5/5/1999 copie de xloadct par Sebastien Masson (smlod@ipsl.jussieu.fr)
+;
+; @history 5/5/1999 copie de xloadct par Sebastien Masson (smlod@ipsl.jussieu.fr)
+;
+; @version $Id$
+;
 ;-
 …
    IF KEYWORD_SET(SILENT_f) THEN silent = SILENT_F ELSE silent = 1
 ;-----------------------------------------------------------------------------
 ; changements effectues par S.Masson
+; Changes made by S.Masson
 ;-----------------------------------------------------------------------------
    IF N_ELEMENTS(file) GT 0 THEN filename = file ELSE BEGIN

trunk/SRC/Colors/xpal.pro

-                      r132
+                      r133
-; $Id$
+;
-; Copyright (c) 1992-1998, Research Systems, Inc.  All rights reserved.
-;       Unauthorized reproduction prohibited.
 ;+
+; NAME:
+;       XPAL
+;
+; PURPOSE:
+;       comme xpalette mais plus court a ecrire et possede en plus
+;       une touche save qui (grace a la routine newpalette) permet de
+;       sauver la routine que l''on vient de faire. Rq qd on appuie
+;       sur la touche predefined appelle xlct plutot que xloadct
+;
+; CATEGORY:
+;       Color tables, widgets.
+;
+; CALLING SEQUENCE:
+;       XPAL
+;
+; INPUTS:
+;       No explicit inputs.  The current color table is used as a starting
+;       point.
+;
+; KEYWORD PARAMETERS:
+;       BLOCK:  Set this keyword to have XMANAGER block when this
+;
+; @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
+; 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
 …
 ;               application.  For more information see the NO_BLOCK keyword
 ;               to XMANAGER.
 ;       UPDATECALLBACK: Set this keyword to a string containing the name of
+; @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
 …
 ;               set to the value specified by the optional UPDATECBDATA
 ;               keyword.
 ;       UPDATECBDATA: Set this keyword to a value of any type. It will be
+; @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
 …
 ;               will be undefined.
+;
+; OUTPUTS:
+;       None.
+;
+; COMMON BLOCKS:
+;       COLORS: Contains the current RGB color tables.
+;       XP_COM: Private to this module.
+;
+; SIDE EFFECTS:
+;       XPAL uses two colors from the current color table as
+; @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
 …
 ;       to the display.
+;
+; PROCEDURE:
+;       The XPAL widget has the following controls:
+; @examples The XPAL widget has the following controls:
+;
 ;       Left:   Three plots showing the current Red, Green, and Blue vectors.
 …
 ;               pressed:
+;
 ;               Done:   Exits XPAL.
+;
 ;         Predefined:   Starts XLOADCT to allow selection of one of the
+;                 Done: Exits XPAL.
+;
+;           Predefined: Starts XLOADCT to allow selection of one of the
 ;                       predefined color tables.
+;
 ;               Help:   Supplies help information similar to this header.
+;                 Help: Supplies help information similar to this header.
+;
 ;               Redraw: Completely redraws the display using the current
 …
 ;                       index and the mark index are interpolated linearly
 ;                       to lie between the colors of two endpoints.
+;                 save: permet de sauver la palette qui est
+;                       actuellement a l''ecran. Qd on appuie sur ce
+;                       bouton, un widget apparait qui demande:
+;                        1) le nom a donner a la palette que l''on veut sauver
+;                        2) le numero de la palette que l''on veut
+;                        eventuellement ecrase par la nouvelle
+;                        palette.Si aucun numero n''est specifie la
+;                        nouvelle palette estajoutee aux anciennes.
+;                        3) le nom du fichier qui contient les
+;                        palettes. Rq: suivre eventuellement les
+;                        indications fournis au prompteur.
+;                 save: Allows to save  the palette which is currently
+;                       on the screen. When we press this hotkey, there is a
+;                       widget who appear and ask:
+;                        1) the name of the palette we want to save.
+;                        2) The number of the palette we may want to erase
+;                        by the new palette. If there is not any number
+;                        specified, the new palette is add to elders.
+;                        3) The name of the file containing palettes.
+;                        Comment: May follow instructions gave by the prompter.
+;
+;
 …
 ;                          horizontally.
+;
+; MODIFICATION HISTORY:
+;          addaptation de xpalette pour ajouter un bouton save par
+; @history addaptation de xpalette pour ajouter un bouton save par
 ;          Gima Nicolas (nglod@ipsl.jussieu.fr) et par Masson
 ;          Sebastien (smlod@ipsl.jussieu.fr)
+;
+; $Id$
+;
 ;-
+;
+;+
+; @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
+;-
 function 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.
+;
   compile_opt idl2, strictarrsubs
 …
   endif
 end
+;+
+; @file_comments XP_XLCTCALLBACK:  For visuals with static colormaps, update the graphics
+;                after a change by XLOADCT.
+;-
 pro XP_XLCTCALLBACK
-  ; For visuals with static colormaps, update the graphics
-  ; after a change by XLOADCT.
+;
   compile_opt idl2, strictarrsubs
 …
 end
+pro XP_REPLOT, color_index, type
+; Re-draw the RGB plots. Type has the following possible values.
+;;      - 'D': Draw the data part of all three plots
+;+
+; @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
 ;       - 'R': Draw the data part of the Red plot
 ;       - 'G': Draw the data part of the Green plot
 ;       - 'B': Draw the data part of the Blue plot
+;-
+pro XP_REPLOT, color_index, type
+;
   compile_opt idl2, strictarrsubs
 …
+pro XP_CHANGE_COLOR, type, value
+; Change current color. Type has the following possible values.
+;+
+; @file_comments XP_CHANGE_COLOR:  Change current color. Type has the following possible values.
 ;       - 'R': Change the R part of the current color
 ;       - 'G': ...
 ;       - 'B': ...
+;-
+pro XP_CHANGE_COLOR, type, value
+;
   compile_opt idl2, strictarrsubs
 …
+;+
+;
+; @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.
+;
+;-
 …
   !p.color = nc -1              ;Foreground color
   !p.font = 0                   ;Hdw font
   save_win = !d.window  ;Previous window
+  save_win = !d.window          ;Previous window
   IF N_ELEMENTS(r_orig) LE 0 THEN BEGIN ;If no common, use current colors

trunk/SRC/ForOldVersion/updatekwd.pro

r122	r133
35	35	old = [old, 'petitdessin'] & new = [new, 'small']
36	36	old = [old, 'ysurx'] & new = [new, 'yxaspect']
	37	old = [old, 'discret'] & new = [new, 'discrete']
37	38	; old = [old, ''] & new = [new, '']
38	39	; supress the first dummy argument and make sure we use lowcase

trunk/SRC/Interpolation/inrecgrid.pro

r125	r133
2	2	;
3	3	; @file_comments
4		, given - a list of points, (x,y) position
	4	; given - a list of points, (x,y) position
5	5	; - the x and y limits of a rectangular grid
6	6	; find in which cell is located each given point.

trunk/SRC/Matrix/cmapply.pro

-                      r132
+                      r133
+;; Utility function, adapted from CMPRODUCT
 ;+
+; NAME:
+;   CMAPPLY
+;
+; AUTHOR:
+;   Craig B. Markwardt, NASA/GSFC Code 662, Greenbelt, MD 20770
+;   craigm@lheamail.gsfc.nasa.gov
+;
+; PURPOSE:
+;   Applies a function to specified dimensions of an array
+;
+; MAJOR TOPICS:
+;   Arrays
+;
+; CALLING SEQUENCE:
+;   XX = CMAPPLY(OP, ARRAY, DIMS, [/DOUBLE], [TYPE=TYPE])
+;
+; DESCRIPTION:
+;   CMAPPLY will apply one of a few select functions to specified
+; @todo seb
+;-
+;
+function cmapply_product, x
+;
+  compile_opt idl2, strictarrsubs
+;
+  sz = size(x)
+  n = sz[1]
+  while n GT 1 do begin
+      if (n mod 2) EQ 1 then x[0,*] = x[0,*] * x[n-1,*]
+      n2 = floor(n/2)
+      x = x[0:n2-1,*] * x[n2:*,*]
+      n = n2
+  endwhile
+  return, reform(x[0,*], /overwrite)
+end
+;; Utility function, used to collect collaped dimensions
+;+
+; @todo seb
+;-
+;
+pro cmapply_redim, newarr, dimapply, dimkeep, nkeep, totcol, totkeep
+;
+  compile_opt idl2, strictarrsubs
+;
+  sz = size(newarr)
+  ;; First task: rearrange dimensions so that the dimensions
+  ;; that are "kept" (ie, uncollapsed) are at the back
+  dimkeep = where(histogram(dimapply,min=1,max=sz[0]) ne 1, nkeep)
+  if nkeep EQ 0 then return
+  newarr = transpose(temporary(newarr), [dimapply-1, dimkeep])
+  ;; totcol is the total number of collapsed elements
+  totcol = sz[dimapply[0]]
+  for i = 1, n_elements(dimapply)-1 do totcol = totcol * sz[dimapply[i]]
+  totkeep = sz[dimkeep[0]+1]
+  for i = 1, n_elements(dimkeep)-1 do totkeep = totkeep * sz[dimkeep[i]+1]
+  ;; this new array has two dimensions:
+  ;;   * the first, all elements that will be collapsed
+  ;;   * the second, all dimensions that will be preserved
+  ;; (the ordering is so that all elements to be collapsed are
+  ;;  adjacent in memory)
+  newarr = reform(newarr, [totcol, totkeep], /overwrite)
+end
+;; Main function
+;+
+;
+; @file_comments
+; Applies a function to specified dimensions of an array
+;
+;   Description:
+;
+;      CMAPPLY will apply one of a few select functions to specified
 ;   dimensions of an array.  Unlike some IDL functions, you *do* have
 ;   a choice of which dimensions that are to be "collapsed" by this
 …
 ;   elements is large.
+;
+;
+; INPUTS:
+;
+;   OP - The operation to perform, as a string.  May be upper or lower
+; @categories Arrays
+;
+; @param OP {in}{required} The operation to perform, as a string.  May be upper or lower
 ;        case.
+;
 …
 ;        the user-defined function.
+;
 ;   ARRAY - An array of values to be operated on.  Must not be of type
+; @param ARRAY {in}{required} An array of values to be operated on.  Must not be of type
 ;           STRING (7) or STRUCTURE (8).
+;
+; OPTIONAL INPUTS:
+;
+;   DIMS - An array of dimensions that are to be "collapsed", where
+; @param DIMS {in}{optional}{default=1 (ie, first dimension)}
+;          An array of dimensions that are to be "collapsed", where
 ;          the the first dimension starts with 1 (ie, same convention
 ;          as IDL function TOTAL).  Whereas TOTAL only allows one
 …
 ;          DEFAULT: 1 (ie, first dimension)
+;
+; KEYWORDS:
+;
+;   DOUBLE - Set this if you wish the internal computations to be done
+; @keyword DOUBLE Set this if you wish the internal computations to be done
 ;            in double precision if necessary.  If ARRAY is double
 ;            precision (real or complex) then DOUBLE=1 is implied.
 ;            DEFAULT: not set
+;
 ;   TYPE - Set this to the IDL code of the desired output type (refer
+; @keyword TYPE Set this to the IDL code of the desired output type (refer
 ;          to documentation of SIZE()).  Internal results will be
 ;          rounded to the nearest integer if the output type is an
 …
 ;          DEFAULT: same is input type
+;
 ;   FUNCTARGS - If OP is 'USER:...', then the contents of this keyword
+; @keyword FUNCTARGS If OP is 'USER:...', then the contents of this keyword
 ;               are passed to the user function using the _EXTRA
 ;               mechanism.  This way you can pass additional data to
 …
 ;               DEFAULT: undefined (i.e., no keywords passed by _EXTRA)
+;
+; RETURN VALUE:
+;
+;   An array of the required TYPE, whose elements are the result of
+; @returns An array of the required TYPE, whose elements are the result of
 ;   the requested operation.  Depending on the operation and number of
 ;   elements in the input array, the result may be vulnerable to
 ;   overflow or underflow.
+;
+; EXAMPLES:
+;   Shows how CMAPPLY can be used to total the second dimension of the
+; @examples
+;
+;   First example:  Shows how CMAPPLY can be used to total the second dimension of the
 ;   array called IN.  This is equivalent to OUT = TOTAL(IN, 2)
+;
 …
 ;   OUT             INT       = Array[5]
+;
 ;   Second example.  Input is assumed to be an 5x100 array of 1's and
+;   Second example:  Input is assumed to be an 5x100 array of 1's and
 ;   0's indicating the status of 5 detectors at 100 points in time.
 ;   The desired output is an array of 100 values, indicating whether
 …
 ;   although there would have been more loop iterations).
+;
 ;   Third example.  Shows sum over first and third dimensions in an
+;   Third example:  Shows sum over first and third dimensions in an
 ;   array with dimensions 4x4x4:
+;
 …
 ;        408     472     536     600
+;
 ;   Fourth example. A user-function (MEDIAN) is used:
+;   Fourth example:  A user-function (MEDIAN) is used:
+;
 ;   IDL> IN = RANDOMN(SEED,10,10,5)
 …
 ;   (OUT[i,j] is the median value of IN[i,j,*])
+;
+; MODIFICATION HISTORY:
+;   Mar 1998, Written, CM
+; @history Mar 1998, Written, CM
 ;   Changed usage message to not bomb, 24 Mar 2000, CM
 ;   Signficant rewrite for *, MIN and MAX (inspired by Todd Clements
 …
 ;   Correct bug in MAX/MIN initialization of RESULT, CM, 05 Dec 2002
+;
+;  $Id$
+;  Author: Craig B. Markwardt, NASA/GSFC Code 662, Greenbelt, MD 20770
+;  craigm@lheamail.gsfc.nasa.gov
+;
+; @version $Id$
+;
 ;-
-; Copyright (C) 1998, 2000, 2002, Craig Markwardt
-; This software is provided as is without any warranty whatsoever.
-; Permission to use, copy, modify, and distribute modified or
-; unmodified copies is granted, provided this copyright and disclaimer
-; are included unchanged.
-;-
-;; Utility function, adapted from CMPRODUCT
-function cmapply_product, x
+;
-  compile_opt idl2, strictarrsubs
+;
-  sz = size(x)
-  n = sz[1]
-  while n GT 1 do begin
-      if (n mod 2) EQ 1 then x[0,*] = x[0,*] * x[n-1,*]
-      n2 = floor(n/2)
-      x = x[0:n2-1,*] * x[n2:*,*]
-      n = n2
-  endwhile
-  return, reform(x[0,*], /overwrite)
-end
-;; Utility function, used to collect collaped dimensions
-pro cmapply_redim, newarr, dimapply, dimkeep, nkeep, totcol, totkeep
+;
-  compile_opt idl2, strictarrsubs
+;
-  sz = size(newarr)
-  ;; First task: rearrange dimensions so that the dimensions
-  ;; that are "kept" (ie, uncollapsed) are at the back
-  dimkeep = where(histogram(dimapply,min=1,max=sz[0]) ne 1, nkeep)
-  if nkeep EQ 0 then return
-  newarr = transpose(temporary(newarr), [dimapply-1, dimkeep])
-  ;; totcol is the total number of collapsed elements
-  totcol = sz[dimapply[0]]
-  for i = 1, n_elements(dimapply)-1 do totcol = totcol * sz[dimapply[i]]
-  totkeep = sz[dimkeep[0]+1]
-  for i = 1, n_elements(dimkeep)-1 do totkeep = totkeep * sz[dimkeep[i]+1]
-  ;; this new array has two dimensions:
-  ;;   * the first, all elements that will be collapsed
-  ;;   * the second, all dimensions that will be preserved
-  ;; (the ordering is so that all elements to be collapsed are
-  ;;  adjacent in memory)
-  newarr = reform(newarr, [totcol, totkeep], /overwrite)
-end
-;; Main function
 function cmapply, op, array, dimapply, double=dbl, type=type, $
                   functargs=functargs, nocatch=nocatch

trunk/SRC/Matrix/cmset_op.pro

-                      r132
+                      r133
 ;+
+; NAME:
+;   CMSET_OP
+;
+; AUTHOR:
+;   Craig B. Markwardt, NASA/GSFC Code 662, Greenbelt, MD 20770
+;   craigm@lheamail.gsfc.nasa.gov
+;
+; PURPOSE:
+;   Performs an AND, OR, or XOR operation between two sets
+;
+; CALLING SEQUENCE:
+;   SET      = CMSET_OP(A, OP, B)
+;
+; DESCRIPTION:
+;
+;   SET_OP performs three common operations between two sets.  The
+; @hidden
+;
+; @todo seb
+;-
+;
+;; Simplified version of CMSET_OP_UNIQ which sorts, and takes the
+;; "first" value, whatever that may mean.
+function cmset_op_uniq, a
+;
+  compile_opt idl2, strictarrsubs
+;
+  if n_elements(a) LE 1 then return, 0L
+  ii = sort(a) & b = a[ii]
+  wh = where(b NE shift(b, +1L), ct)
+  if ct GT 0 then return, ii[wh]
+  return, 0L
+;
+end
+;+
+;
+; @file_comments
+; Performs an AND, OR, or XOR operation between two sets
+;
+;   Description: SET_OP performs three common operations between two sets.  The
 ;   three supported functions of OP are:
+;
 …
 ;   benefit.
+;
 ; INPUTS:
+;
 ;   A, B - the two sets to be operated on.  A one dimensional array of
+; @categories array
+;
+; @param A {in}{required} The two sets to be operated on.  A one dimensional array of
 ;          either numeric or string type.  A and B must be of the same
 ;          type.  Empty sets are permitted, and are either represented
 ;          as an undefined variable, or by setting EMPTY1 or EMPTY2.
+;
+;   OP - a string, the operation to be performed.  Must be one of
+; @param B {in}{required} See A
+;
+; @param OP {in}{required} a string, the operation to be performed.  Must be one of
 ;        'AND', 'OR' or 'XOR' (lower or mixed case is permitted).
 ;        Other operations will cause an error message to be produced.
+;
+; KEYWORDS:
+;
+;   NOT1, NOT2 - if set and OP is 'AND', then the complement of A (for
+; @keyword NOT1 If set and OP is 'AND', then the complement of A (for
 ;                NOT1) or B (for NOT2) will be used in the operation.
 ;                NOT1 and NOT2 cannot be set simultaneously.
+;
+;   EMPTY1, EMPTY2 - if set, then A (for EMPTY1) or B (for EMPTY2) are
+;                    assumed to be the empty set.  The actual values
+;                    passed as A or B are then ignored.
+;
+;   INDEX - if set, then return a list of indices instead of the array
+; @keyword NOT2 See NOT1
+;
+; @keyword EMPTY1 If set, then A (for EMPTY1) or B (for EMPTY2) are
+;                 assumed to be the empty set.  The actual values
+;                 passed as A or B are then ignored.
+;
+; @keyword EMPTY2 See EMPTY1
+;
+; @keyword INDEX if set, then return a list of indices instead of the array
 ;           values themselves.  The "slower" set operations are always
 ;           performed in this case.
 …
 ;           from NA to NA+NB-1 refer to B[I-NA].
+;
 ;   COUNT - upon return, the number of elements in the result set.
+; @keyword COUNT upon return, the number of elements in the result set.
 ;           This is only important when the result set is the empty
 ;           set, in which case COUNT is set to zero.
+;
+; RETURNS:
+;
+;   The resulting set as a one-dimensional array.  The set may be
+; @returns The resulting set as a one-dimensional array.  The set may be
 ;   represented by either an array of data values (default), or an
 ;   array of indices (if INDEX is set).  Duplicate elements, if any,
 …
 ;   SET_UTILS.PRO by RSI
+;
+; MODIFICATION HISTORY:
+;   Written, CM, 23 Feb 2000
+; @history Written, CM, 23 Feb 2000
 ;   Added empty set capability, CM, 25 Feb 2000
 ;   Documentation clarification, CM 02 Mar 2000
 …
 ;      range of the input variable (thanks to Will Maddox), CM, 16 Jan 2006
+;
+;  $Id: cmset_op.pro,v 1.6 2006/01/16 19:45:22 craigm Exp $
+;
+;-
+; Copyright (C) 2000, 2004, 2005, 2006, Craig Markwardt
+; This software is provided as is without any warranty whatsoever.
+; Permission to use, copy, modify, and distribute modified or
+; unmodified copies is granted, provided this copyright and disclaimer
+; are included unchanged.
+;-
+;; Utility function, similar to UNIQ, but allowing choice of taking
+;; first or last unique element, or non-unique elements.
+;; Unfortunately this doesn't work because of implementation dependent
+;; versions of the SORT() function.
+;   Author: Craig B. Markwardt, NASA/GSFC Code 662, Greenbelt, MD 20770
+;   craigm@lheamail.gsfc.nasa.gov
+;
+; @version $Id: cmset_op.pro,v 1.6 2006/01/16 19:45:22 craigm Exp $
+;
+; @examples Utility function, similar to UNIQ, but allowing choice of taking
+; first or last unique element, or non-unique elements.
+; Unfortunately this doesn't work because of implementation dependent
+; versions of the SORT() function.
+;
 ; function cmset_op_uniq, a, first=first, non=non, count=ct, sort=sortit
 ;   if n_elements(a) LE 1 then return, 0L
 …
 ; end
+;; Simplified version of CMSET_OP_UNIQ which sorts, and takes the
+;; "first" value, whatever that may mean.
+function cmset_op_uniq, a
+;
+  compile_opt idl2, strictarrsubs
+;
+  if n_elements(a) LE 1 then return, 0L
+  ii = sort(a) & b = a[ii]
+  wh = where(b NE shift(b, +1L), ct)
+  if ct GT 0 then return, ii[wh]
+  return, 0L
+end
+; Simplified version of CMSET_OP_UNIQ which sorts, and takes the
+; "first" value, whatever that may mean.
+;
+;-
 function cmset_op, a, op0, b, not1=not1, not2=not2, count=count, $

trunk/SRC/Matrix/congridseb.pro

-                      r132
+                      r133
 ;------------------------------------------------------------
 ;+
+; NAME:CONGRIDSEB
+;
+; PURPOSE:meme chose que congrid mais qui marche ...
+;        cf par ex:
+; @file_comment
+; Like congrid but here, it works...
+;        example:
 ;IDL> print, congrid([[1,2,3,4],[5,6,7,8]],12,4)
 ;       1 1 1 2 2 2 3 3 3 3 4 4
 …
 ;       5 5 5 6 6 6 7 7 7 8 8 8
+;
 ; CATEGORY:bidouille matrices
+; @categories utilities
+;
 ; CALLING SEQUENCE:res=congridseb(tableau,x[,y])
+; @param tableau {in}{required} A table 1 ou 2d
+;
+; INPUTS:tableau:un tableau 1 ou 2d
+;        x:dim en x du resultat doit etre un multiple de dim en x de tableau
+;        y:dim en y du resultat doit etre un multiple de dim en y de tableau
+; @param x {in}{required} dimension in x of the result which must be
+;                         a multiple of the dimension in x of the table.
+;
+; KEYWORD PARAMETERS:
+; @param y {in}{required} dimension in y of the result which must be
+;                         a multiple of the dimension in y of the table.
+;
 ; OUTPUTS:res un tableau de dim x * y
+; @returns res a table dim x * y
+;
+; COMMON BLOCKS:
+;
+; SIDE EFFECTS:
+;
+; RESTRICTIONS:
+;
+; EXAMPLE:
+;
+; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                      20/3/98
 ;                      18/6/1999 supression d''une horrible boucle
+;
+; @version $Id$
+;
 ;-
 ;------------------------------------------------------------

trunk/SRC/Matrix/different.pro

-                      r132
+                      r133
 ;------------------------------------------------------------
 ;+
-; NAME:different
+;
+; PURPOSE:calcule les elements differents de 2 matrices D'ENTIERS POSITIFS
+; @file_comments
+; calculate the different elements of 2 matrix of positif whole numbers.
+;
 ; CATEGORY:calcule sur les matrices
+; @categories Calculation of matrixes
+;
+; CALLING SEQUENCE:res=different(a,b)
+;
+; INPUTS:a et b:arrays of positive integers, which need
+; @param a {in}{required} arrays of positive integers, which need
 ;               not be sorted. Duplicate elements are ignored, as they have no
 ;               effect on the result
+;
 ; KEYWORD PARAMETERS:
+; @param b {in}{required} see a
+;
 ; OUTPUTS:tableau
+; @returns tableau
+;
+; COMMON BLOCKS:
+;
+; SIDE EFFECTS:
+;
+; The empty set is denoted by an array with the first element equal to
+; @restrictions The empty set is denoted by an array with the first element equal to
 ; -1.
+;
+; RESTRICTIONS:
+;
+; These functions will not be efficient on sparse sets with wide
+; @restrictions These functions will not be efficient on sparse sets with wide
 ; ranges, as they trade memory for efficiency. The HISTOGRAM function
 ; is used, which creates arrays of size equal to the range of the
 ; resulting set.
+;
 ; EXAMPLE:
+; @examples
+;
 ;   a = [2,4,6,8]
 …
 ;   different(a,b) = [ 4, 8]         ; Elements in A but not in B
+;
 ; MODIFICATION HISTORY:
+; @history http://www.dfanning.com/tips/set_operations.html
+;
+; http://www.dfanning.com/tips/set_operations.html
+; @version $Id$
+;
 ;-
 ;------------------------------------------------------------

trunk/SRC/Matrix/inter.pro

-                      r132
+                      r133
 ;------------------------------------------------------------
 ;+
-; NAME:inter
+;
+; PURPOSE:calcule l''intersection de 2 matrices D'ENTIERS POSITIFS
+; @file_comments
+; calculate the intersection between 2 matrixes of whole numbers
+;
 ; CATEGORY:calcule sur les matrices
+; @categories calculation of matrixes
+;
+; CALLING SEQUENCE:res=inter(a,b)
+;
+; INPUTS:a et b:arrays of positive integers, which need not to be
+; @param a {in}{required} arrays of positive integers, which need not to be
 ; sorted. Duplicate elements are ignored, as they have noeffect on the
 ; result
+;
 ; KEYWORD PARAMETERS:
+; @param b {in}{required} see a
+;
 ; OUTPUTS:tableau
+; @returns tableau
+;
+; COMMON BLOCKS:
+;
+; SIDE EFFECTS:
+;
+; The empty set is denoted by an array with the first element equal to
+; @restrictions The empty set is denoted by an array with the first element equal to
 ; -1.
+;
+; RESTRICTIONS:
+;
+; These functions will not be efficient on sparse sets with wide
+; @restrictions These functions will not be efficient on sparse sets with wide
 ; ranges, as they trade memory for efficiency. The HISTOGRAM function
 ; is used, which creates arrays of size equal to the range of the
 ; resulting set.
+;
+; EXAMPLE:
+; @examples  a = [2,4,6,8]
+;   b = [6,1,3,2]
+;   inter(a,b) = [ 2, 6]       ; Common elements
+;
+;   a = [2,4,6,8]
+;   b = [6,1,3,2]
+;   inter(a,b) = [ 2, 6]       ; Common elements
+; @history  http://www.dfanning.com/tips/set_operations.html
+;
 ; MODIFICATION HISTORY:
+; @version $Id$
+;
-; http://www.dfanning.com/tips/set_operations.html
 ;-
 ;------------------------------------------------------------

trunk/SRC/Matrix/make_selection.pro

-                      r132
+                      r133
-; $Id$
-;-------------------------------------------------------------
 ;+
-; NAME:
-;        MAKE_SELECTION (function)
+;
 ; PURPOSE:
 ;        Convert an array of selected values to an index
+; file_comments
+; Convert an array of selected values to an index
 ;        array that identifies the selected values in a list
 ;        or data array.
+;
+; CATEGORY:
+;        Tools
+; categories tools
+;
+; @param NAMES {in}{required} A list or array of values to choose from
+;
+; CALLING SEQUENCE:
+;        index = MAKE_SELECTION(NAMES,SELNAMES [,keywords])
+; @param SELNAMES {in}{required} A list of selected values
+;
+; INPUTS:
+;        NAMES -> A list or array of values to choose from
+;
+;        SELNAMES -> A list of selected values
+;
+; KEYWORD PARAMETERS:
+;        ONLY_VALID -> Return only indices of found values. Values not
+; @keyword ONLY_VALID Return only indices of found values. Values not
 ;            found are skipped. Default is to return 1 index value for
 ;            each SELNAME, which is -1 if SELNAME is not contained in
 …
 ;            at all.
+;
 ;        REQUIRED -> Normally, MAKE_SELECTION will return indices for
+; @keyword REQUIRED Normally, MAKE_SELECTION will return indices for
 ;            all values that are found, simply ignoring the selected
 ;            values that are not in the NAMES array (although an error
 …
 ;            -1 as soon as a selected value is not found.
+;
 ;        QUIET -> Suppress printing of the error message if a
+; @keyword QUIET Suppress printing of the error message if a
 ;            selected value is not found (the error condition will
 ;            still be set).
+;
+; OUTPUTS:
+;        A (long) array with indices to reference the selected values
+; @returns A (long) array with indices to reference the selected values
 ;        in the NAMES array.
+;
+; SUBROUTINES:
+;
+; REQUIREMENTS:
+;
+; NOTES:
+;        If the NAMES array contains multiple entries of the same value,
+; @restrictions If the NAMES array contains multiple entries of the same value,
 ;        only the index to the first entry will be returned.
+;
 …
 ;        (See example below)
+;
+; EXAMPLE:
+;        names = [ 'Alfred','Anton','Peter','John','Mary']
+;        index = MAKE_SELECTION(names,['Peter','Mary'])
+;        print,index
+;        ; prints  2  4
+; @examples names = [ 'Alfred','Anton','Peter','John','Mary']
+;           index = MAKE_SELECTION(names,['Peter','Mary'])
+;           print,index
+;           ; prints  2  4
+;
 ;        vals = indgen(20)
 ;        index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9])
 ;        print,index
 ;        ; prints  9  -1  8  7  7  8  9
+;           vals = indgen(20)
+;           index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9])
+;           print,index
+;           ; prints  9  -1  8  7  7  8  9
+;
 ;        index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/ONLY_VALID)
 ;        print,index
 ;        ; prints  9  8  7  7  8  9
+;           index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/ONLY_VALID)
+;           print,index
+;           ; prints  9  8  7  7  8  9
+;
 ;        index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/REQUIRED)
 ;        print,index
 ;        ; prints  -1
+;           index = MAKE_SELECTION(vals,[9,-5,8,7,7,8,9],/REQUIRED)
+;           print,index
+;           ; prints  -1
+;
+; @history mgs, 28 Aug 1998: VERSION 1.00
+;          mgs, 29 Aug 1998: - changed behaviour and added ONLY_VALID keyword
+;
+; MODIFICATION HISTORY:
+;        mgs, 28 Aug 1998: VERSION 1.00
+;        mgs, 29 Aug 1998: - changed behaviour and added ONLY_VALID keyword
+; @version $Id$
+;
 ;-

trunk/SRC/Matrix/union.pro

-                      r132
+                      r133
 ;------------------------------------------------------------
 ;+
-; NAME:union
+;
+; PURPOSE:calcule l''union de 2 matrices D'ENTIERS POSITIFS
+; @file_comments
+; calculate tne union between 2 matrixes of whole numbers
+;
 ; CATEGORY:calcule sur les matrices
+; @categories calculation of matrixes
+;
+; CALLING SEQUENCE:res=union(a,b)
+;
+; INPUTS:a et b:arrays of positive integers, which need
+; @param a {in}{required} arrays of positive integers, which need
 ;               not be sorted. Duplicate elements are ignored, as they have no
 ;               effect on the result
+;
 ; KEYWORD PARAMETERS:
+; @param b {in}{required} see a
+;
 ; OUTPUTS:tableau
+; @returns tableau
+;
+; COMMON BLOCKS:
+;
+; SIDE EFFECTS:
+;
+; The empty set is denoted by an array with the first element equal to
+; @restrictions The empty set is denoted by an array with the first element equal to
 ; -1.
+;
+; RESTRICTIONS:
+;
+; These functions will not be efficient on sparse sets with wide
+; @restrictions These functions will not be efficient on sparse sets with wide
 ; ranges, as they trade memory for efficiency. The HISTOGRAM function
 ; is used, which creates arrays of size equal to the range of the
 ; resulting set.
+;
+; EXAMPLE:
+; @examples a = [2,4,6,8]
+;           b = [6,1,3,2]
+;           union(a,b) = [ 1, 2, 3, 4, 6, 8]  ; Elements in either set
+;
+;   a = [2,4,6,8]
+;   b = [6,1,3,2]
+;   union(a,b) = [ 1, 2, 3, 4, 6, 8]  ; Elements in either set
+; @history  http://www.dfanning.com/tips/set_operations.html
+;
 ; MODIFICATION HISTORY:
+; @version $Id$
+;
-; http://www.dfanning.com/tips/set_operations.html
 ;-
 ;------------------------------------------------------------

trunk/SRC/Obsolete/extrait.pro

-                      r132
+                      r133
 ;------------------------------------------------------------
 ;+
-; NAME:extrait
+;
 ; PURPOSE:extraction de sous domaines de matrices. Meme si le sous
 ; domaine est "troue". cf. : l''exemple
 ; Par defaut IDL peut faire des extractions de sous domaines:
+; @fie-comments
+; extractoin of subdomains of matrixes; Even if the subdomain is "pierced" (see the example)
+; By default, IDL can make extractions of subdomain:
+;
 ;      IDL> a=indgen(5,5)
 …
 ;            15      17
 ;            20      22
 ; mais
+; but
 ;      IDL> print, a[[0,2],[3,4]]
 ;            15      22
 ; alors que
+; while
 ;      IDL> print, extrait(a,[0,2],[3,4])
 ;            15      17
 ;            20      22
+;
-; CATEGORY:bidouille avec les matrices
+;
 ; CALLING SEQUENCE:res=extrait(tab,indicex[,indicey[,indicez,[indicet]]])
+; you better use extrac2
+;
+; INPUTS:
+;        tab: un tableau 1,2,3 ou 4 d
+; @obsolete
+;
+;        indicex: indicex peut avoir deux formes:
+;              1)un vecteur contenant les indices des lignes a garder
+;              2)le string '*' dans ce cas touts les lignes sont
+;              gardees
+; @categories utilities
+;
+;        indicey/z/t: la meme chose que indicex mais pour les
+;        dimensions 2,3 et 4.
+; @param tab {in}{required} a 1,2,3 or 4 dim table
+;
+;        rq: il faut autant de vecteurs indice que tab a de dimensions
+; @param indicex {in}{required} can have 2 forms:
+;              1)a vector containing indexes of lines we want to keep
+;              2)the string '*' if we want to keep all lines.
+;
 ; KEYWORD PARAMETERS:
+; @param indicey {in}{required} the same thing that indicex but for dim 2.
+;
+; OUTPUTS:
+;         res: une matice 1,2,3 ou 4d extraite a partir de tab
+; @param indicez {in}{required} the same thing that indicex but for dim 3.
+;
+; @param indicet {in}{required} the same thing that indicex but for dim 4.
+;
 ; COMMON BLOCKS:
+; @returns a matrix 1,2,3 or 4d extract from tab
+;
 ; SIDE EFFECTS:res=-1 en cas d''erreur
+; @restrictions res=-1 in case of mistake
+;
+; RESTRICTIONS:
+;
+; EXAMPLE:
+; j''ai une matrice A de dim 2. je veux en extraire une petite matrice
+; 2d interscetion de la ligne 2,3 et 7 et de la colonne 0 et 1
+;
+; @examples I have a dim 2 matrix named A. I want extract a small intersection
+;          matrix 2d of the line 2,3 and 7 and of the column 0 and 1:
+;
 ;      res=extrait(A,[2,3,7],[0,1])
+;
 ;autre ex:
+;other ex:
 ;      IDL> print, a
 ;      a b c
 …
 ;      g i
+;
 ; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                       12/1/1999
+;                       29/4/1999: correction d''un bug et complement
+;                       de l''en-tete
+;                       29/4/1999: correction of a bug and complement of the heading
+;
+; @version $Id$
+;
 ;-
 ;------------------------------------------------------------
 …
   compile_opt idl2, strictarrsubs
+;
+   taille = size(tab)
+;------------------------------------------------------------
+; test du nombre de parametres
+; et de la nature de indice (pour LE cas 'x')
+;------------------------------------------------------------
+   if n_params() NE taille[0]+1 THEN $
+    return, report('il faut autant d''indices que de dimension du tableau')
+   IF n_params() GE 5 THEN BEGIN
+      if size(indicet,/type) EQ 7 then indicet = lindgen(taille[4]) $
+      ELSE indicet = long(indicet)
+      nt = n_elements(indicet)
+   ENDIF
+   IF n_params() GE 4 THEN BEGIN
+      if size(indicez,/type) EQ 7 then indicez = lindgen(taille[3]) $
+      ELSE indicez = long(indicez)
+      nz = n_elements(indicez)
+   ENDIF
+   IF n_params() GE 3 THEN BEGIN
+      if size(indicey,/type) EQ 7 then indicey = lindgen(taille[2]) $
+      ELSE indicey = long(indicey)
+      ny = n_elements(indicey)
+   ENDIF
+   IF n_params() GE 2 THEN BEGIN
+      if size(indicex,/type) EQ 7 then indicex = lindgen(taille[1]) $
+      ELSE indicex = long(indicex)
+      nx = n_elements(indicex)
+   ENDIF
+;------------------------------------------------------------
+; construction du tableau d''indice et du resultat suivant la taille
+; de tab
+;------------------------------------------------------------
+  case taille[0] of
+:res = tab[indicex]
+:BEGIN
+         indice = indicex#replicate(1, ny)+taille[1]*replicate(1, nx)#indicey
+         res = tab[indice]
+      END
+:BEGIN
+         indice = indicex#replicate(1, ny)+taille[1]*replicate(1, nx)#indicey
+         indice = temporary(indice[*])#replicate(1, nz) $
+          +taille[1]*taille[2]*replicate(1, nx*ny)#indicez
+         res = tab[reform(indice, nx, ny, nz, /over)]
+      END
+:BEGIN
+         indice = indicex#replicate(1, ny)+taille[1]*replicate(1, nx)#indicey
+         indice = temporary(indice[*])#replicate(1, nz) $
+          +taille[1]*taille[2]*replicate(1, nx*ny)#indicez
+         indice = temporary(indice[*])#replicate(1, nt) $
+          +taille[1]*taille[2]*taille[3]*replicate(1, nx*ny*nz)#indicet
+         res = tab[reform(indice, nx, ny, nz, nz, /over)]
+      END
+   endcase
+;------------------------------------------------------------
+;------------------------------------------------------------
+   return, res
+  case n_params() of
+:return, extrac2()
+:return, extrac2(tab)
+:return, extrac2(tab, indicex)
+:return, extrac2(tab, indicex, indicey)
+:return, extrac2(tab, indicex, indicey, indicez)
+:return, extrac2(tab, indicex, indicey, indicez, indicet)
+  endcase
 end

trunk/SRC/Obsolete/zeroun.pro

-                      r132
+                      r133
 ;------------------------------------------------------------
 ;+
+; NAME:zeroun
+; @file_comments
+; Send back a vector or a matrix constituate of 0 and 1 in alternation
+;
+; PURPOSE:renvoie un vecteur ou une matrice constitue de o et de 1 en
+; alternance
+; you better use zero_one
+;
 ; CATEGORY:function, matrices
+; @obsolete
+;
 ; CALLING SEQUENCE:resultat=zeroun(n1 [,n2])
+; @categories function, matrixes
+;
+; INPUTS:
+;       n1=nombre d'elements dans la premiere dimension
+;       n2=nombre d'elements dans la deuxieme dimension
+; @param n1 {in}{required} number of elements in the first dimension
+; @param n2 {in}{required} numbre of elements in the second dimension
+;
+; KEYWORD PARAMETERS:
+; @returns resultat
+;
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
+;                       1/12/98
+;
 ; OUTPUTS:resultat
+; @version $Id$
+;
-; COMMON BLOCKS:
+;
-; SIDE EFFECTS:
+;
-; RESTRICTIONS:
+;
-; EXAMPLE:
+;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                       1/12/98
 ;-
 ;------------------------------------------------------------
 …
   compile_opt idl2, strictarrsubs
+;
+   CASE N_PARAMS() OF
+:return, findgen(n1) mod 2
+:BEGIN
+         if fix(n1/2) EQ n1/2. then BEGIN ;nombre pair de colonnes
+            res = findgen(n1+1,n2) mod 2
+            return, res[0:n1-1, *]
+         ENDIF ELSE return, findgen(n1,n2) mod 2 ;nombre impair de colonnes
+      END
+      else: return,  report('Mauvais nombre de parametre dans l''appel de ZEROUN')
+   endcase
+  case n_params() of
+:return, zero_one()
+:return, zero_one(n1)
+:return, zero_one(n1, n2)
+  endcase
 end

trunk/SRC/Picture/image_viewer.pro

-                      r132
+                      r133
 ;+
+; 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
 …
 ;*********************************************************************************************
+;+
+; @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
 …
 ;*********************************************************************************************
+;+
+; @param event {in}{required}
+;-
 PRO IMAGE_VIEWER_CANCEL,event
 ;obtain state structure for top-level-base from its UVALUE:
 …
 ;*********************************************************************************************
+;+
+; @param event {in}{required}
+;-
 PRO IMAGE_VIEWER_TIMER,event
 ;obtain state structure for top-level-base from its UVALUE:
 …
 ;*********************************************************************************************
+;+
+; @param event {in}{required}
+;-
 PRO IMAGE_VIEWER_EXIT,event
 ;THIS PROCEDURE IS CALLED WHEN A USER SELECTS "File > Exit" FROM THE MAIN MENU
 …
 ;*********************************************************************************************
+;+
+; @param event {in}{required}
+;-
 PRO IMAGE_VIEWER_HELP,event
 ;THIS PROCEDURE IS CALLED WHEN A USER SELECTS "Help > Help on IMAGE_VIEWER"
 …
 ;*********************************************************************************************
+;+
+; @param event {in}{required}
+;-
 PRO IMAGE_VIEWER_THUMBS,event
 ;THIS PROCEDURE IS CALLED WHEN A USER CLICKS ON ONE OF THE THUMBNAIL PICTURES
 …
 ;*********************************************************************************************
+;+
+; @param widjetID {in}{required}
+;-
 PRO IMAGE_VIEWER_CLEANUP,widgetID
 ;THIS PROCEDURE IS CALLED WHEN THE PROGRAM IS TERMINATED AND XMANAGER REGISTERS A CLEANUP:
 …
 ;*********************************************************************************************
+;+
+; @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

-                      r132
+                      r133
 ;-------------------------------------------------------------------------------
+;+
+; @hidden
+;-
 FUNCTION IMDISP_GETPOS, ASPECT, POSITION=POSITION, MARGIN=MARGIN
+;
 …
 END
 ;-------------------------------------------------------------------------------
+;+
+; @hidden
+;-
 FUNCTION IMDISP_IMSCALE, IMAGE, RANGE=RANGE, BOTTOM=BOTTOM, NCOLORS=NCOLORS, $
   NEGATIVE=NEGATIVE
 …
 END
 ;-------------------------------------------------------------------------------
+;+
+; @hidden
+;-
 FUNCTION IMDISP_IMREGRID, DATA, NX, NY, INTERP=INTERP
+;
 …
 END
 ;-------------------------------------------------------------------------------
+;+
+; @hidden
+;-
 PRO IMDISP_IMSIZE, IMAGE, X0, Y0, XSIZE, YSIZE, ASPECT=ASPECT, $
   POSITION=POSITION, MARGIN=MARGIN
 …
 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.
 …
 ;    - 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
 …
 ;                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
 …
 ;                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
 …
 ;                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
 …
 ;                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
 …
 ;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
 …
 ; 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

-                      r132
+                      r133
-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:
 …
 ;    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
 …
 ;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
 …
 ; 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

-                      r132
+                      r133
-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:
 …
 ;    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
 …
 ; 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$'

trunk/SRC/ToBeReviewed/CALENDRIER/def_month.pro

r114	r133
	1	;+
	2	; @todo seb
	3	;-
1	4	FUNCTION def_month, timave, date
2	5	;

trunk/SRC/ToBeReviewed/COULEURS/palit.pro

-                      r114
+                      r133
 ;+
+;  Eclaircit la palette courante en jouant sur la luminosite
+; @file_comments
+; Clarify the current palette playing with brightness
+;
+;          coef = regle l'attenuation des couleurs
+;          par defaut divise par 2 la luminosite
+; @param coef {in}{required} The rule of attenuation of colors divide by 2 the brightness by default
+;
+;  coef = 0.1 pour la QMS papier de l'IPSL convient tres bien
+; @param red
+;
+; @param green
+;
+; @param blue
+;
+; @todo Seb: compléter param red/green/blue
 ;-
 PRO palit, coef, red, green, blue
 …
    l = 1.-coef*(1.-l)
+;
 ;  Le noir doit rester bien noir !
 ;  toutes mes palettes commencent par du noir et finissent par du blanc
+;  Black must stay really black!
+;  Each palette starts by Black and ends by white
+;
    l[0] = 0.

trunk/SRC/ToBeReviewed/IMAGE/animgif.pro

-                      r114
+                      r133
 ;------------------------------------------------------------
 ;+
-; NAME:animgif
+;
+; PURPOSE:construire une animation gif
+; @file_comments
+; Build a gif animation
+;
 ; CATEGORY:pour faire des dessins animes
+; @categories Animated drawings.
+;
+; CALLING SEQUENCE:animgif, 'toto.gif'
+; @param toto.gif {in}{required} It is the name of the gif file containing the animation.
+;                         Comment: this file is placed in the directory defined by iodir.
+;
+; INPUTS:toto.gif: c''est le nom du fichier gif contenant
+; l''animation. Rq ce fichier est place dans le repertoire definit par
+; iodir.
+; @uses common.pro
+;
+; KEYWORD PARAMETERS:
+;
+; OUTPUTS:
+;
+; COMMON BLOCKS:
+;       common.pro
+;
+; SIDE EFFECTS:on utilise le Z buffer pour aller plus vite!.
+;              donc si on plante ds animgif il faut faire:
+; @restrictions We use the Z buffer to go faster!.
+;              So, if it failed in animgif, you have to do:
 ;              IDL> device, /close
 ;              IDL> set_plot, 'x'
 ;              IDL> retall
+;
 ; RESTRICTIONS: si on veut supprimer le @common,
 ;               il faut definir a la main la taille de l''image (les
 ;               variables xsize et ysize) ainsi que iodir.
+; @restrictions If we want to delete the @common,
+;               we have to define manually the picture's size
+;               (variables xsize and ysize) just as iodir.
+;
+; EXAMPLE:
+; @history Guillaume Roullet (grlod@ipsl.jussieu.fr)
+;          Sebastien Masson (smasson@lodyc.jussieu.fr)
+;          30/4/1999
+;
+; MODIFICATION HISTORY: Guillaume Roullet (grlod@ipsl.jussieu.fr)
+;                       Sebastien Masson (smasson@lodyc.jussieu.fr)
+;                       30/4/1999
+; @version $Id$
+;
 ;-
 ;------------------------------------------------------------
 …
 @common
+;
 ;  recupere la palette de couleur et la place dans rouge, vert, bleu
+;  It recuperates the color palette and put it in red, green, blue.
+;
    tvlct,  rouge,vert,bleu,/get
+;
 ;  complete la palette courante sur 256 couleurs
+;  It completes the current palette on 256 colors.
+;
    red = [rouge, replicate(255, 256-n_elements(rouge))]
 …
    blue = [bleu, replicate(255, 256-n_elements(rouge))]
+;
+; bascule sur le z device, permettant de creer l''image sans
+; l''afficher
+; It rocks on the z device, allowing to create the picture without display it.
    thisOS = !VERSION.OS_FAMILY
    thisOS = STRMID(thisOS, 0, 3)
    thisOS = STRUPCASE(thisOS)
    set_plot, 'z'
 ; taille de l''image (en nombre de pixel:
+; size of the picture (in pixel):
    xsize = 30*(min(page_size, max = ma)*key_portrait + ma*(1-key_portrait))
    ysize = 30*(min(page_size, max = ma)*(1-key_portrait) + ma*key_portrait)
    device, set_resolution = [xsize, ysize]
+;
 ; commencement du fichier gif. ecriture d''une image vide
+; Beginning of the gif file. Writing of an empty picture.
+;
    reinitplt
 …
+;
 ;----------------------------------------------------------------
 ; debut de la partie a changer
+; Beggining of the part we want to change.
 ;----------------------------------------------------------------
+;
 ; boucle de creation de l''image
+; Loop of picture's creation.
+;
    calen = TIMEGEN(366, START=JULDAY(1,1,2000))
 …
 ;      plt, norme(nlec('unsurf', date, 'RE3'), nlec('vnsurf', date, 'RE3')), 0, 1.2, int = .1, /noerase
+;
 ;     Ecriture de l''image dans le fichier .gif
+;     Writing of the picture in the file .gif.
+;
       write_gif,iodir+nomfic,tvrd(),red, green, blue, /multiple
    ENDFOR
 ;----------------------------------------------------------------
 ; fin de la partie a changer
+; End of the part we want to change.
 ;----------------------------------------------------------------
+;
 ; fermeture du fichier
+; Closing of the file.
    write_gif,iodir+nomfic,/close
 ; rebascule en mode terminal X
    device, /close
+; Rerock on terminal X mode.
+;   device, /close
    CASE thisOS of
       'MAC': SET_PLOT, thisOS

trunk/SRC/ToBeReviewed/MATRICE/colle.pro

-                      r114
+                      r133
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 ;+
+; NAME:colle
+; @file_comments
+; This concatenation function exist in IDL so long
+;as we do not try to stick with a dimension superior or equal at 4.
+;
+; PURPOSE: Cette fonction de concatenation existe ds IDL (avec [] cf
+; ds le programme ds le case pour direc egale 1,2,3) tant que l''on ne
+; cherche pas a coller suivant une dimensionsuperieure ou egale a 4.
+; @categories utilities
+;
 ; CATEGORY:bidouillage de matrice
+; @param a0 {in}{required}
+;
+; CALLING SEQUENCE:res=colle(bableau_de_pointeur,direc) ou bien
+;                  res=colle(tab1,tab2,tab3,tab4,.....,direc)
+; @param a1 {in}{required}
+;
+; INPUTS:
+;
+;        CAS 1:
+;        tableau_de_pointeur:comme son nom l''indique c'est un tableau
+;        de pointeur, dont chaque elements pointe sur tableau a coller
+; @param a2 {in}{required}
+;
+;        par ex ds un programme, on veut coller n tableaux entre eux
+; @param a3 {in}{required}
+;
+; @param a4 {in}{required}
+;
+; @param a5 {in}{required}
+;
+; @param a6 {in}{required}
+;
+; @param a7 {in}{required}
+;
+; @param a8 {in}{required}
+;
+; @param a9 {in}{required}
+;
+; @param a10 {in}{required}
+;
+; @param a11 {in}{required}
+;
+; @param a12 {in}{required}
+;
+; @param a13 {in}{required}
+;
+; @param a14 {in}{required}
+;
+; @param a15 {in}{required}
+;
+; @param a16 {in}{required}
+;
+; @param a17 {in}{required}
+;
+; @param a18 {in}{required}
+;
+; @param a19 {in}{required}
+;
+; @param a20 {in}{required}
+;
+; @param CAS 1 {in}{required}
+;        table_of_pointer: It is a table of pointers, where each
+;        element point on a table to stick
+;
+;        For exemple, in a program, we want to stick n table ones with others.
+;
 ;          tab=ptrarr(n,/allocate_heap)
 …
 ;          res=colle(tab,1)
+;
 ;        CAS 2:
 ;        on donne directement les tableaux a coller
 ;        rq: ds ce cas on peut au plus donner 20 tableaux en entree.
+; @param CAS 2 {in}{required}
+;        we directly give tables to stick
+;        Comment: In this case, the plus we can give is 20 tables.
+;
+;        ATTENTION : sans le mot cle /SAUVE les arguments en entree
+;        sont detruits lorsque l''on construit res. ds le cas 1 on
+;        detruit le tableau de pointeurs et les variables sur
+;        lesquelles on pointe.
+;        BEWARE: whitout the keyword /SAUVE entry arguments are
+;                delete when, we build res. In the first case,we
+;                delete the table of pointers and variables on which we point.
+;
 ;        direc: la direction suivant laquelle les coller, 1,2,3...
+; @param direc {in}{required} The direction on which stick them, 1,2,3...
+;
+; KEYWORD PARAMETERS:
+;
+;         /SAUVE: mot cle qui force a sauvegarder le tableau de
+; @keyword SAUVE mot cle qui force a sauvegarder le tableau de
 ;         pointeur et les tableaux a coller.
+;
 ; OUTPUTS:res=matrice resultat
+; @returns res=matrice resultat
+;
+; RESTRICTIONS:
+;
+; EXAMPLE:
+;
+;         IDL> print, colle(replicate(1,2,2,2),indgen(2,2,2),2)
+; @examples IDL> print, colle(replicate(1,2,2,2),indgen(2,2,2),2)
 ;                1       1
 ;                1       1
 …
 ;                6       7
+;
 ; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                       13/1/98
+;
+; @version $Id$
+;
 ;-
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
-; pour suprimer une variable.
-;------------------------------------------------------------
-   PRO UNDEFINE, varname
+;
-  compile_opt idl2, strictarrsubs
+;
-      tempvar = SIZE(TEMPORARY(varname))
-   END
-;------------------------------------------------------------
-;------------------------------------------------------------
 FUNCTION colle, a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, a11, a12, a13, a14, a15, a16, a17, a18, a19, a20, SAUVE = sauve
+;

trunk/SRC/ToBeReviewed/UTILITAIRE/get_extra.pro

r114	r133
	1	;+
	2	; @todo seb
	3	;-
	4	;
1	5	; elle fait quoi ?
2	6

trunk/SRC/ToBeReviewed/UTILITAIRE/oups.pro

-                      r11
+                      r133
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 ;+
-; NAME:oups
+;
 ; PURPOSE: Sorte de UNDO:
 ; permet de refaire toute la serie de dessin depuis
 ; l''ouverture de la derniere fenetre sans reexecuter la derniere
 ; commande. cf. je fais un dessin avec 10 plt dessus au 10 eme je me
 ; plante, un coup de @oups et je peux refaire mon plt rate!
+; @file_comments
+;       Kind of UNDO:
+;         Allows to redo all the chain of drawing since the opening of the last window without
+;         reexecute the last order Example: I do a drawing with 10 plot over it, if I make a
+;         mistake, I execute this program and i can redo the only plot missed.
+;
 ; CATEGORY: pour faciliter les dessins
+; @categories utilities
+;
 ; CALLING SEQUENCE: @oups
+; @restrictions compatible with @ps @vzoom text_box...
+;
 ; SIDE EFFECTS: compatible avec @ps @vzoom text_box...
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
+;
-; RESTRICTIONS:
+;
 ; EXAMPLE:
+; @version $Id$
+;
 ; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @todo seb
+;
 ;-
 ;------------------------------------------------------------
+;------------------------------------------------------------
+;------------------------------------------------------------
+;------------------------------------------------------------
+; il faut fermer le journal!
+; Close the journal!
 ;------------------------------------------------------------
  journal
 ; on recupere le journal sous la forme d''un vecteur de string:
+; we recuperate the journal as a vector of string:
    vectjournal = getfile(myuniquetmpdir+'idlsave.pro')
 ; on coupe la derniere ligne qui est oups
+; we cut the last line which is oups
    vectjournal = vectjournal[0:n_elements(vectjournal)-2 ]
 ;------------------------------------------------------------
 ; on le corrige si besoin est...
+; we correct it if there is the need...
 ;------------------------------------------------------------
 for i = 0, n_elements(vectjournal)-1 do $
  if strpos(vectjournal[i],'text_box' ) EQ -1 then $
  vectjournal[i] = strtrim(strcompress(vectjournal[i]), 2)
 ;2 lignes sont identiques ??
+;2 line are identical ??
 for i = 0, n_elements(vectjournal)-2 do $
  if vectjournal[i] EQ vectjournal[i+1] then vectjournal[i] = ' '
 …
+;
 ; on vire la derniere ligne pour tout reexecuter sauf la derniere commande
+; we erase the last line to reexecute all the programm but the last order.
+;
  IF strpos(vectjournal[n_elements(vectjournal)-1],';,pos=[' ) NE -1 then $
  vectjournal[n_elements(vectjournal)-2] = '' $
  ELSE vectjournal[n_elements(vectjournal)-1] = ''
 ; on reecrit idlsave.pro
+; we rewrite idlsave.pro
 putfile, myuniquetmpdir+'idlsave.pro', vectjournal
 ; on compile puis applique idlsave
+; we compile, then we apply idlsave
 cd,  current = curdir
 cd, myuniquetmpdir
 @idlsave
 cd, curdir
+; le journal vient d'etre reouvert, et on y met les elements de
+; vectjournal
+; the journal has just been reopened, and we put elements of vectjournal in it.
 for i = 0, n_elements(vectjournal)-1 DO $
 journal, vectjournal[i]

trunk/SRC/ToBeReviewed/UTILITAIRE/vzoom.pro

-                      r11
+                      r133
 ;------------------------------------------------------------
 ;+
-; NAME:vraizoom
+;
+; PURPOSE:fait un vari zoom dans un plot, contrairement a la fonction
+; ZOOM  preecrite par IDL qui ne fait que grossir les pixels
+; @file_comments
+; Make a real zoom in a plot, contrarly at the function
+; ZOOM prewritten by IDL which just get pixels bigger.
+;
 ; CATEGORY:petit outil
+; @categories utilities
+;
+; CALLING SEQUENCE:@vzoom
+; @restrictions use the journal.
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
+;          29/4/1999
+;
 ; SIDE EFFECTS:utilise le journal.
+; @version $Id$
+;
 ; RESTRICTIONS:
+; @todo seb
+;
-; EXAMPLE:
+;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                       29/4/1999
 ;-
 ;------------------------------------------------------------
 …
    y = y[sort(y)]
    domdef, [x, y, vert1, vert2]
 ; il faut fermer le journal!
+; we must close the journal!
    journal
 ; on recupere le journal sous la forme d''un vecteur de string:
+; we recuperate the journal as a vector of string:
    vectjournal = getfile(myuniquetmpdir+'idlsave.pro')
 ; on coupe la derniere ligne qui est vraizoom
+; we cut the last line which is vraizoom
    vectjournal = vectjournal[0:n_elements(vectjournal)-2 ]
 ;------------------------------------------------------------
 ; on le corrige si besoin est...
+; we correct it if there is the need to...
 ;------------------------------------------------------------
 for i = 0, n_elements(vectjournal)-1 do $
  if strpos(vectjournal[i],'text_box' ) EQ -1 then $
  vectjournal[i] = strtrim(strcompress(vectjournal[i]), 2)
 ;2 lignes sont identiques ??
+;2 line are identical ??
 for i = 0, n_elements(vectjournal)-2 do $
  if vectjournal[i] EQ vectjournal[i+1] then vectjournal[i] = ' '
 …
+;
 ; on reecrit idlsave.pro
+; we rewrite idlsave.pro
 putfile, myuniquetmpdir+'idlsave.pro', vectjournal
 ; applique idlsave
+; apply idlsave
    cd,  current = curdir
    cd, myuniquetmpdir
 @idlsave
    cd, curdir
+; le journal vient d'etre reouvert, et on y met les elements de
+; vectjournal
+; the journal has just been reopened, and we put in elements of vectjournal.
 for i = 0, n_elements(vectjournal)-1 DO $
 journal, vectjournal[i]

trunk/SRC/Utilities/fitintobox.pro

-                      r132
+                      r133
 ;------------------------------------------------------------
 ;+
 ; NAME:fitintobox
+;
 ; PURPOSE: check that the input array has size and dimensions
+;
+; @file_comments
+; Check that the input array has size and dimensions
 ; compatible with the domain that was defined with the previous call
 ; of domdef.
+;
+; CATEGORY: domain compatibility
+;
+; CALLING SEQUENCE:
+;     res = fitintobox(field[, nx, ny, nz, firstx, firsty, firstz
+;                                        ,  lastx,  lasty,  lastz])
+;
+; INPUTS:
+;     field: an array or a structure that can be read by the function
+;     litchamp.pro
+;
+;     nx, ny, nz, firstx, firsty, firstz,  lastx,  lasty,  lastz:
+;     optional parameters. If not given they will be define with a
+;     call to the procedure grille.pro
+;
+; KEYWORD PARAMETERS: none
+;
+; OUTPUTS: an array with dimensions matching the domain
+;          or -1 if there is an error...
+;
+; COMMON BLOCKS: cm_4mesh and cm_4cal
+;
+; SIDE EFFECTS:
+;
+; RESTRICTIONS:
+;
+; EXAMPLE:
+;
+;   IDL> help, fitintobox(findgen(jpi,jpj))
+;   <Expression>    FLOAT     = Array[41, 3]
+;   IDL> help, fitintobox(findgen(jpi,jpj,78))
+;   Error:
+;   the array dimensions [180,148,78] are incompatible
+;   with the the domain dimensions
+;   [jpi/nx, jpj/ny, jpk/nz, jpt] = [180/41, 148/3, 31/31, 1]
+;   <Expression>    INT       =       -1
+;
+; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+;                     10 juin 2000.
+; June 2005: S. Masson rewrite all.
+; @categories domain compatibility
+;
+; @param sz {in}{required}
+;
+; @param nx {in}{required}
+;
+; @param ny {in}{required}
+;
+; @param nz {in}{required}
+;
+; @param jpi {in}{required}
+;
+; @param jpj {in}{required}
+;
+; @param jpk {in}{required}
+;
+; @param jpt {in}{required}
+;
+; @returns -1
+;
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
+;          10 juin 2000.
+;          June 2005: S. Masson rewrite all.
+;
+; @version $Id$
+;
+; @hidden
+;
 ;-
 ;------------------------------------------------------------
 …
   RETURN, report(['Error: ' $
                   , 'the array dimensions ' + tostr(sz) + ' are incompatible' $
                   , 'with the the domain dimensions ' $
+                  , 'with the the domain dimensions ' $
                   , '[jpi/nx, jpj/ny, jpk/nz, jpt] = [' $
                   + strtrim(jpi, 1) + '/' + strtrim(nx, 1) $
 …
                   + ', ' + strtrim(jpt, 1) + ']'], /simple)
 END
+;
+;+
+;
+; @categories domain compatibility
+;
+; @param field {in}{required} an array or a structure that can be read by the function
+;     litchamp.pro
+;
+; @param nx {in}{optional}{default=define by grille.pro}
+;
+; @param ny {in}{optional}{default=define by grille.pro}
+;
+; @param nz {in}{optional}{default=define by grille.pro}
+;
+; @param firstx {in}{optional}{default=define by grille.pro}
+;
+; @param firsty {in}{optional}{default=define by grille.pro}
+;
+; @param firstz {in}{optional}{default=define by grille.pro}
+;
+; @param lastx {in}{optional}{default=define by grille.pro}
+;
+; @param lasty {in}{optional}{default=define by grille.pro}
+;
+; @param lastz {in}{optional}{default=define by grille.pro}
+;
+; @keyword WDEPTH To specify that we are at W level
+;
+; @returns an array with dimensions matching the domain
+;          or -1 if there is an error...
+;
+; @uses cm_4mesh
+; @uses cm_4cal
+;
+; @examples IDL> help, fitintobox(findgen(jpi,jpj))
+;           <Expression>    FLOAT     = Array[41, 3]
+;           IDL> help, fitintobox(findgen(jpi,jpj,78))
+;        Error:
+;           the array dimensions [180,148,78] are incompatible
+;           with the the domain dimensions
+;           [jpi/nx, jpj/ny, jpk/nz, jpt] = [180/41, 148/3, 31/31, 1]
+;           <Expression>    INT       =       -1
+;
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
+;          10 juin 2000.
+;          June 2005: S. Masson rewrite all.
+;
+; @version $Id$
+;-
 ;------------------------------------------------------------
 FUNCTION fitintobox, field, nx, ny, nz, firstx, firsty $

trunk/SRC/Utilities/linearequation.pro

-                      r132
+                      r133
 ;------------------------------------------------------------
 ;+
-; NAME: linearequation
+;
+; PURPOSE:calcule une equation de droite du type ax+by+c=0 a partir
+; des coordonnees de 2 points. Rq: on peut avoir un tableau de couple
+; de points.
+; @file_comments
+; Calculate a linear equation of the type ax+by+c=0
+; thanks to coordinates of 2 points.
+; comment: we can have a table with pairs of points.
+;
+; CATEGORY:petit truc qui peut etre utile (sans boucles, ca va de soit!)
+; @categories utilities
+;
+; @param point1 {in}{required} This is the first point of(the) straight
+; line(s) whose we want to calculate equation(s)
+;
+; CALLING SEQUENCE:abc=linearequation(point1, point2)
+;
+; INPUTS: point1 et point2 dont deux point de(s) la droite(s) dont on
+; veut calculer l(es) equations(s).
+; deux possibilites sont possibles:
+;      1) point est un complexe ou un tableau de complexes, ou chaque
+;      element du complexe est les coordonnees du point
+;      2) points est un tableau de reels de dimensions 2
+;      ,nbre_de_droite. ou pour chaque ligne du tableau on a les
+;      coordonnees du point.
+; @param point2 {in}{required} This is the second point of(the) straight
+; line(s) whose we want to calculate equation(s)
+;
+; KEYWORD PARAMETERS:
+;    There is 2 possibilities:
+;      1) point is a complex or a table ofcomplex, where each element is the coordinates of the point.
+;      2) point is a table of real of dimension 2,number_of_straight_line.
+;         For each row of the table, we have coordinates of the point.
+;
 ; OUTPUTS:abc c''est un tableau de dimensions 3, nbre_de_droite, ou
 ; pour chaque ligne du tableau on obtient les 3 parametres a, b, c de
 ; l'equation de la droite ax+by+c=0
+; @returns abc is a table of dimension 3, number_of_straight_line,
+;          where for each lign of the table we obtain the 3 parameters
+;          a, b and c of the linear equation ax+by+c=0
+;
+; COMMON BLOCKS:
+; @examples IDL> abc=linearequation(complex(1,2),[3,4])
+;           IDL> print, abc[0]*1+abc[1]*2+abc[2]
+;           0.00000
+;
+; SIDE EFFECTS:
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
+;          10 juin 2000
+;
 ; RESTRICTIONS:
+; @version $Id$
+;
-; EXAMPLE:
-;    IDL> abc=linearequation(complex(1,2),[3,4])
-;    IDL> print, abc[0]*1+abc[1]*2+abc[2]
-;          0.00000
+;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                       10 juin 2000
 ;-
 ;------------------------------------------------------------

trunk/SRC/Utilities/lineintersection.pro

-                      r132
+                      r133
 ;------------------------------------------------------------
 ;+
-; NAME: lineintersection
+;
+; PURPOSE: Calcule les coordonnees de l''intersection de 2 droites ou
+; d''une serie de 2 droites
+; @file_comments
+; Calculate coordinates of the intersection between 2 straight lines
+; or of a succession of 2 straight lines.
+;
+; CATEGORY:petit truc qui peut etre utile (sans boucles, ca va de soit!)
+; @categories utilities
+;
+; @param abc1 {in}{required} is the first table of dimension 3, number_of_pairs_of_straight_lines,
+;         whose each line contain the 3 parameters a,b and c of the first linear
+;         equation of the type ax+by+c=0
+;
+; CALLING SEQUENCE: point=lineintersection(abc1, abc2)
+;
+; INPUTS: abc est un tableau de dimensions 3,
+; nbre_de_couple_de_droites, dont chaque ligne contient les 3
+; parametres a, b, c de l''equation de droite du type ax+by+c=0
+; @param abc2 {in}{required} is second table of dimension 3, number_of_pairs_of_straight_lines,
+;         whose each line contain the 3 parameters a,b and c of the second linear
+;         equation of the type ax+by+c=0
+;
+; KEYWORD PARAMETERS:
+;       /FLOAT: pour retourner l''output sous forme de tableau de
+;       reel plutot que de vecteur decomplexes (par defaut)
+; @keyword FLOAT To return the output as a table of real numbers instead of vectors of complex (by default)
+;
+; OUTPUTS:2 possibilites:
+;      1) par defaut: c''est une vecteur de complexe dont chaque
+;      element est les coordonnees du point d''intersection d''un
+;      couple de droites.
+;      2) si /FLOAT est active, c'est un tableau de reels de
+;      dimensiones 2, nbre_de_couple_de_droites dont chaque
+;      ligne est les coordonnees du point d''intersection d''un
+;      couple de droites
+; @returns 2 possibilities:
+;      1) by default: it is a vector of complex whose each element is the coordinates
+;                     of the intersection point of a pair of straight lines.
+;      2) if FLOAT is activated, it is a table of reals of dimension 2,
+;         number_of_pairs_of_straight_lines whose each row is the coordinates
+;         of the intersection point of a pair of straight line.
+;
 ; COMMON BLOCKS:
+; @restrictions If the 2 straight line are parallel, we return coordinates (!values.f_nan,!values.f_nan)
+;
+; SIDE EFFECTS:si les deux droites dont paralleles, on retourne les
+; coordonnes (!values.f_nan,!values.f_nan)
+; @restrictions Beware of the precision of the machine which make
+;               that calculated coordinates may not exactly verify
+;               equations of the pair of straight lines.
+;
+; RESTRICTIONS:attention a la precision de la machine qui fait que
+; les coordonnees calcules de verifient peut-etre pas exactement les
+; equations du couple de droites.
+; @examples IDL> abc1=linearequation(complex(1,2),[3,4])
+;           IDL> abc2=linearequation(complex(1,2),[8,15])
+;           IDL> print, lineintersection(abc1, abc2)
+;           (      1.00000,      2.00000)
+;           IDL> print, lineintersection(abc1, abc2,/float)
+;                 1.00000      2.00000
+;
+; EXAMPLE:
+;     IDL> abc1=linearequation(complex(1,2),[3,4])
+;     IDL> abc2=linearequation(complex(1,2),[8,15])
+;     IDL> print, lineintersection(abc1, abc2)
+;     (      1.00000,      2.00000)
+;     IDL> print, lineintersection(abc1, abc2,/float)
+;           1.00000      2.00000
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
+;          10 juin 2000
+;
 ; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                      10 juin 2000
+; @version $Id$
+;
 ;-
 ;------------------------------------------------------------

trunk/SRC/Utilities/pwd.pro

-                      r132
+                      r133
 ;------------------------------------------------------------
 ;+
-; NAME:pwd
+;
+; PURPOSE:print the current directory
+; @file_comments
+; print the current directory
+;
+; CATEGORY:like unix function
+; @categories like unix function
+;
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
+;
+; CALLING SEQUENCE:pwd
+;
+; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @version $Id$
+;
 ;-

trunk/SRC/Utilities/report.pro

-                      r132
+                      r133
 ;------------------------------------------------------------
 ;+
-; NAME:report
+;
+; PURPOSE: comme dialog_message.pro si il y a deja des widgets actives
+; ou comme message.pro si il n''y a pas de widgets actives. pour poser
+; des question dont la reponse n''est pas oui/non utiliser xquestion
+; @file_comments
+; Like dialog_message.pro if there is already some widget
+; active or like message.pro if there is not any widget active.
+; To ask a question whose answer is not yes/no,use xquestion.
+;
+; CATEGORY:
+;
+; CALLING SEQUENCE:res = report(text)
+;
+; INPUTS: text: un string on un vecteur de string. Si le string ne
+; @param text {in}{required} un string on un vecteur de string. Si le string ne
 ; comporte qu''un element, on cherche les eventuels characteres de
 ; retour a la ligne: '!C'. If text is set to an array of strings, each
 ; array element is displayed as a separate line of text.
+;
+; KEYWORD PARAMETERS:
+;         SIMPLE: activate to print only the message without the name
+; @keyword SIMPLE activate to print only the message without the name
 ;             and the line of the routine (defined by calling routine_name)
+;
+; ceux dialog_message.pro et message.pro avec en +
+; PARENT qui fait la meme chose que DIALOG_PARENT de dialog_message.pro
+; @keyword _extra used to pass keywords from dialog_message.pro and message.pro
+;
+; OUTPUTS: -1 si le mot cle QUESTION n''est pas activer
+;          si le mot cle est active la fonction retourne 1 pour yes et
+;          0 pour no.
+; @keyword PARENT same as DIALOG_PARENT de dialog_message.pro
+;
+; COMMON BLOCKS:
+; @keyword QUESTION Set this keyword to create a "Question" dialog.
+;                   The default dialog type is "Warning"
+;
+; SIDE EFFECTS:
+; @keyword DEFAULT_NO Set this keyword to make the "No" button the default
+;                     selection for "Question" dialog. Normally, the default is yes.
+;
+; RESTRICTIONS:
+; @keyword SIMPLE Activate to print the error message without printing
+;                 the routine name with its full path.
+;
+; EXAMPLE:
+; @returns -1 if the keyword QUESTION is not activated
+;          If the keyword is activated, return 1 for yes and 0 for no.
+;
 ; si aucun widget n''est active:
+; @example If there is not any widget activated:
+;
 ;     IDL> help, report('toto tata')
 ;     % $MAIN$: toto tata
 ;     <Expression>    INT       =       -1
 ;     IDL> help, report('ca marche ?',/question)
 ;     ca marche ? y/n (default answer is y)
+;     IDL> help, report('does it works ?',/question)
+;     does it works ? y/n (default answer is y)
 ;     <Expression>    BYTE      =    1
 ;     IDL> help, report('question1: !C ca marche ?',/question)
+;     IDL> help, report('question1: !C does it works ?',/question)
 ;     question1:
 ;     ca marche ? y/n (default answer is y)
+;     does it works ? y/n (default answer is y)
 ;     <Expression>    BYTE      =    1
+;
+; si des widgets sont deja actives, c''est la meme chose mais avec des
+; widgets!
+; If widgets are already activated, it is the same thing but with widgets!
+;
 ; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                      21/10/1999
+;
+; @version $ID$
+;
 ;-
 ;------------------------------------------------------------
 …
   compile_opt idl2, strictarrsubs
+;
+   res = -1                     ;
+; on separe le texte en differentes lignes (separees par !C) si ce
+; n''est pas deja fait...
+  res = -1                      ;
+; we separate the text in different lines (separated by !C) if it is not already done...
    if n_elements(text) EQ 1 then text = str_sep(text, '!C', /trim)
 ; il y a des widgets actifs, c''est facile on appelle dialog_massage
+; there is some widgets activated, it is easy, we call dialog_massage
    if (widget_info(/managed))[0] NE 0 then BEGIN
       res = dialog_message(text, dialog_parent = parent, QUESTION = question $
 …
       if keyword_set(question) THEN res = res EQ 'Yes' ELSE res = -1
    ENDIF ELSE BEGIN
 ; aucun widget n''est actif
 ; on pose une question ?
+; there is not any widget activated
+; do we ask a question ?
       if keyword_set(question) then BEGIN
 ; quelle est la reponse par defaut ?
+; what i sthe answer by default ?
          if keyword_set(default_no) then answer = 'n' ELSE answer = 'y'
          default_answer = answer
 …
          read, text[n_elements(text)-1]+' y/n (default answer is '+default_answer+')' , answer
          answer = strlowcase(answer) ;
 ; si la reponse ne convient pas
+; if the answer is not appropriated
          while answer NE '' and answer NE 'y' and answer NE 'n' do begin
             read, text[n_elements(text)-1]+' y/n (default answer is '+default_answer+')' , answer
             answer = strlowcase(answer)
          ENDWHILE               ;
 ; on ajuste res en fonction de la reponse
+; we adjust res in function of th answer
          case answer of
             '':res = default_answer EQ 'y'
 …
          endcase
       endif ELSE BEGIN
 ; si on ne pose pas de question on fait juste un print
+; If we do not ask any question, we just make a print
         IF keyword_set(simple) THEN prefix = '' ELSE prefix = '% '+routine_name(1)+': '
          if n_elements(text) GT 1 THEN $

trunk/SRC/Utilities/routine_name.pro

-                      r132
+                      r133
 ;------------------------------------------------------------
 ;+
-; NAME:routine_name,remonte
+;
 ; PURPOSE:retourne le nom de la routine (procedure ou function) ds
 ; lequel on se trouve
+; @file_comments
+; Give us the name of the routine (procedure or function) where we are.
+;
+; CATEGORY:utilitaire
+; @categories utilities
+;
+; @param pilingnum {in}{optional} A whole number which give us how many level we have to reascend
+;                in the piling up of routines and subroutines to find the looked for routine.
+;
-; CALLING SEQUENCE:res=routine_name([remonte])
+;
-; INPUTS: remonte: un entier qui donne de combien de niveau on doit
-; remonter ds l''empillement des routines ewt sous-routines pour
-; retrouver le nom de la routine cherchee
+;
 ; KEYWORD PARAMETERS:
+; @returns a string giving either the full name of the routine (with the path) or '$MAIN$'
+;
+; OUTPUTS:un string donnant soit le nom de la routine en entier (avec
+; le path) soit '$MAIN$'
+; @restriction This function use the keyword OUTPUT in help.pro and it is specified
+;              in the online help that the return syntax of this word can change in
+;              function of the version of the code. This version works with IDL 5.2.
+;
+; COMMON BLOCKS:
+;
+; SIDE EFFECTS:
+;
+; RESTRICTIONS:
+;   cette fonction utilise le mot cle OUTPUT ds help.pro et il est
+;   specifie ds l''aide en ligne que la syntaxe du retour de ce mot cle
+;   peut changer suivant la version du code. Cette version marche avec
+;   IDL 5.2
+;
+; EXAMPLE:
+;
+;  IDL> print, routine_name()
+; @example IDL> print, routine_name()
 ;  /usr1/com/smasson/IDL_RD/UTILITAIRE/report.pro
 ;  IDL> print, routine_name(1)
 …
 ;  $MAIN$
+;
 ; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                      21/10/1999
+;
+; @version $Id$
+;
 ;-
 ;------------------------------------------------------------
 ;------------------------------------------------------------
 ;------------------------------------------------------------
 FUNCTION routine_name,  remonte
+FUNCTION routine_name,  pilingnum
+;
+;
 …
+;
   help,  /traceback, output = name
   name = strtrim(name, 1)     ; on enleve les blancs en debut de ligne
 ; on va mettre les elements du vecteur bout a bout pour former un
 ; unique sring
+  name = strtrim(name, 1)       ; we remove blanks at the beginning of lines and
+;                               we put elements of the vector stuck ones with
+;                               each others to make an unique string.
   allnames = ''
   for i = 0, n_elements(name)-1 do allnames = allnames+name[i]
+;
   name = str_sep(allnames, '%') ; on le redecoupe
   name = strtrim(name, 2)     ; on eleve les blancs devant et derriere
   name = strcompress(name)      ; on compresse les blancs
 ; on ne retient pas les 2 premiers elements qui sont 1  un vide et la
 ; ligne concernant routine_name
+  name = str_sep(allnames, '%') ; we cut it out again.
+  name = strtrim(name, 2)     ; we remouve blanks in front of and behind
+  name = strcompress(name)      ; we compress blanks
+; we do not hold back the two first elements who are a blanck  and the line concerning
+; routine_name.
   name = name[2: n_elements(name)-1]
 ; on choisit la ligne qui nous concerne
   if NOT keyword_set(remonte) then remonte = 0
   if remonte GE n_elements(name) then return,  '$MAIN$'
   name = name[remonte]
+; we choose the line which concern us.
+  if NOT keyword_set(pilingnum) then pilingnum = 0
+  if pilingnum GE n_elements(name) then return,  '$MAIN$'
+  name = name[pilingnum]
   if strpos(name, '$MAIN$') NE -1 then return,  '$MAIN$'
   name = str_sep(name, ' ')

trunk/SRC/Utilities/testvar.pro

-                      r132
+                      r133
 ;------------------------------------------------------------
 ;+
-; NAME:testvar
+;
 ; PURPOSE:une sorte de keyword_set mais qd la valeur existe renvoie
 ; celle-ci
+; @file_comments
+; A  kind of keyword_set but when the value exist, it send it back
+;
 ; CATEGORY:comme keyword_set
+; @categories utlities
+;
+; CALLING SEQUENCE:res=testvar(var=variable)
+;
+; INPUTS:rien
+; @keyword var any kind of
+;
 ; KEYWORD PARAMETERS:var : n''importe quoi
+; @returns 0 if the variable does not exist
+;
+; OUTPUTS:0 si la variable n''existe pas
+;
+; COMMON BLOCKS:
+;
+; SIDE EFFECTS:
+;
+; RESTRICTIONS:
+;
+; EXAMPLE:
+;
+;    IDL> print, testvar(var=toto)
+; @examples IDL> print, testvar(var=toto)
 ;           0
 ;    IDL> print, testvar(var='toto')
 ;    toto
+;
 ; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                      14/12/1999
+;
+; @version $Id$
+;
 ;-
 ;------------------------------------------------------------

trunk/SRC/Utilities/text_box.pro

-                      r132
+                      r133
 ;+
-; Name        : text_box
+;
+; Purpose     : Writes a text message within a box in a graphics window.
+; @file_comments
+; This procedure writes a short text message within a box-shaped
+; area in a graphics window.  The message may be split at word
+; boundaries into several lines, and the character size and
+ ;orientation may be adjusted for the text to fit within the box.
+;
+; @param TEXT {in}{required} ASCII text string containing the message.
+;
+; Description:  This procedure writes a short text message within a box-shaped
+;               area in a graphics window.  The message may be split at word
+;               boundaries into several lines, and the character size and
+;               orientation may be adjusted for the text to fit within the box.
+;
+; Useage:       text_box,text,pos=pos,color=color,$
+;                    justify=justify,vert_space=vert_space
+;
+; Inputs
+; TEXT          ASCII text string containing the message.
+;
+; keywords
+;  pos          4 element vector specifying the box position and size
+; @keyword pos  4 element vector specifying the box position and size
 ;               pos[0],pos[1] specify the lower left corner coordinate
 ;               pos[2],pos[3] specify the upper right corner coordinate
 ;               data window normalized coordinates are use
+;
 ;   fg_color    color of box and legend titles (default=0)
+; @keyword fg_color color of box and legend titles (default=0)
+;
 ;   bg_color    background color. Setting BG_COLOR erases the area
+; @keyword bg_color background color. Setting BG_COLOR erases the area
 ;               covered by the text box (filling it with color BG_COLOR)
 ;               prior to writing the text.  If both BG_COLOR and !p.color
 …
 ;               gaurantee a readability.
+;
+;  right        if set, right justify text
+;  center       if set, center the text
+; @keyword right if set, right justify text
+;
+;  vert_space   vertical spacing of lines in units of character height
+;               (default = 1.5)
+; @keyword center if set, center the text
+;
+; @keyword vert_space {default=1.5}vertical spacing of lines in units of character height
+;
+;  author:  Paul Ricchiazzi                            7Jul93
+; @keyword _EXTRA used to pass your keyword
+;
+; @keyword box activate to show the box on graphics window.
+;
+; @history  Paul Ricchiazzi                            7Jul93
 ;           Institute for Computational Earth System Science
 ;           University of California, Santa Barbara
+;
+; @version $Id$
+;
 ;-
 PRO text_box,text,pos=pos,fg_color=fg_color,bg_color=bg_color,$

trunk/SRC/Utilities/undefine.pro

-                      r132
+                      r133
 ;------------------------------------------------------------
 ;+
-; NAME: undefine
+;
+; PURPOSE: effacer une variable
+;           meme chose que delvar mais utiulisable ds un programme et
+;           utilisable que pour une variable a la fois
+; @file_comments
+; erase a variable
+; same thing that delvar but usable in a program and usable
+; for one variable simultaneously
+;
+; CATEGORY:
+; @categories utilities
+;
+; @param varname {in}{required} The name of the variable we want erase
+;
+; CALLING SEQUENCE: UNDEFINE, varname
+;
+; INPUTS: varname: la variable a detruire
+; @example IDL> a=1
+;          IDL> undefine,a
+;          % Compiled module: UNDEFINE.
+;          IDL> help, a
+;          A               UNDEFINED = <Undefined>
+;
+; EXAMPLE:
+;
+;    IDL> a=1
+;    IDL> undefine,a
+;    % Compiled module: UNDEFINE.
+;    IDL> help, a
+;    A               UNDEFINED = <Undefined>
+;
+; MODIFICATION HISTORY: trouve sur la page web de D.Fanning
+; @history trouve sur la page web de D.Fanning
 ; http://www.dfanning.com :
 ;QUESTION: How do I make an IDL variable have a type "undefined"?

trunk/SRC/Utilities/xfile.pro

-                      r132
+                      r133
 ;------------------------------------------------------------
 ;+
-; NAME: xfile
+;
+; PURPOSE: affiche ds un widget un fichier ASCII.
+;          c''est la meme chose que xdisplaydife mais ici on l''utilise pour
+;          visualiser le contenu d''une procedure ou d''une fonction
+;          meme si elle n''est pas ds le repertoire courant (grace a !path)
+; @file_comments
+; display in a widget an ASCII file.
+; It is the same thing that xdisplaydife but here, we use it
+; to display the content of a procedure or of a function,
+; even if it is not in the current directory (thanks to the path).
+;
 ; CATEGORY: help
+; @categories utilities
+;
+; CALLING SEQUENCE: xfile,'nom_fichier'
+; @param filename {in}{required} It is the name of the procedure or of the function
+;                    we want to display (with or without .pro at the end).
+;
+; INPUTS:
+;        nom_fichier:le nom d''une procedure ou d''une fonction a
+;        visualiser avec ou sans le .pro a la fin
+; @keyword _extra used to pass your keywords
+;
 ; KEYWORD PARAMETERS:ceux de xdisplayfile
+; @examples xfile,'plt'
+;
+; EXAMPLE:xfile,'plt'
+;
+; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                       7/1/99
 ;                       6/7/1999: compatibilite mac et windows
+;
+; @version $Id$
+;
 ;-
 ;------------------------------------------------------------
 …
 pfile = strlowcase(filename)
+;
 ; il faut trouver le nom complet
+; we have to find the full name.
+;
    if strpos(pfile,".pro") lt 0 then pfile=pfile+".pro"
 …
    endrep until res[0] NE '' OR i EQ n_elements(pfile)
    if res[0] NE  '' then BEGIN
 ; on ouvre le fichier ds un widget
+; we open the file in a widget
    xdisplayfile, pfile[i-1], _extra = ex
    ENDIF ELSE ras = report('le fichier demande n''existe pas...')

trunk/SRC/Utilities/xhelp.pro

-                      r132
+                      r133
 ;+
-; NAME:
-;       xhelp
+;
 ; PURPOSE:
 ;       Display an IDL procedure header using widgets and the widget manager.
+; @file_comments
+; Display an IDL procedure header using widgets and the widget manager.
+;
+; CATEGORY:
+;       Widgets.
+; @categories Widgets.
+;
+; CALLING SEQUENCE:
+;       xhelp, Filename,_extra=ex
+;
+; INPUTS:
+;     Filename: A scalar string that contains the filename of the file
+; @param Filename {in}{required} A scalar string that contains the filename of the file
 ;               to display.  If FILENAME does not include a complete path
 ;               specification, xhelp will search for the file in
 …
 ;               ".pro" file suffix will be appended if it is not supplied.
+;
+; KEYWORD PARAMETERS:
+;       Ceux de xdisplayfile
+; @keyword _extra used to pass your keywords
+;
+; OUTPUTS:
+;       No explicit outputs.  A file viewing widget is created.
+; @restrictions Triggers the XMANAGER if it is not already in use.
+;
+; SIDE EFFECTS:
+;       Triggers the XMANAGER if it is not already in use.
+; @examples Open a file and create a widget to display its contents.
+;
+; RESTRICTIONS:
+;       None.
+;
+; PROCEDURE:
+;       Open a file and create a widget to display its contents.
+;
+; MODIFICATION HISTORY:
+;       Written By Steve Richards, December 1990
+; @history Written By Steve Richards, December 1990
 ;       Graceful error recovery, DMS, Feb, 1992.
 ;       Modified to extract .pro documentation headers, PJR/ESRG mar94
+;
+;  author:  Paul Ricchiazzi                            jun93
+;           Institute for Computational Earth System Science
+;           University of California, Santa Barbara
+;
+;       Paul Ricchiazzi                            jun93
+;       Institute for Computational Earth System Science
+;       University of California, Santa Barbara
 ;  7/1/99 : legeres mofification par Sebastien Masson : utilisation de
 ;  xdisplayfile, de findfile et de _extra.
 ;  6/7/1999: compatibilite mac et windows
+;
+; @version $Id$
+;
 ;-
 PRO xhelp, filename, _extra=ex
 …
+;
 ; filename est bien un string?
+; Are we sure filename is a string?
    cquoidonc = size(filename, /type)
    if cquoidonc NE 7 then begin
 …
       return
    endif
 ; il faut trouver le nom complet
+; We have to find the full name
    pfile=FILENAME
    if strpos(pfile,".pro") lt 0 then pfile=pfile+".pro"
 …
       pfile = [current, multipath]+ pfile
    ENDIF
 ; on test tous les noms possibles pour trouver ou est le fichier
+; We test each possile name to find where the file is.
    nfile=n_elements(pfile)
    n = 0
 …
    endrep until res[0] NE '' OR n EQ n_elements(pfile)
    if res[0] NE '' then BEGIN
       openr, unit,pfile[n-1], /get_lun ; ouverture du fichier
 ; on selectionne le morceaux en-tete
+      openr, unit,pfile[n-1], /get_lun ; opening of the file
+; we select the heading piece
       a = strarr(1000)          ;Maximum # of lines
       xsize=0
 …
          ras = report('le programme a etait mal ecrit, il n''y a pas d''en-tete... utiliser xfile.pro.') ELSE BEGIN
          a = a[0:i-1]
 ; on ecrit le contenu de a ds un widget
+; we wrote the a's content in a widget
          xdisplayfile,'toto',text = a,title=pfile[n-1], _extra = ex
       ENDELSE

Context Navigation

Legend:

Download in other formats: