Changeset 133 for trunk/SRC/Colors/colorbar.pro

Timestamp:

07/07/06 11:57:27 (18 years ago)

Author:

navarro

Message:

english and nicer header (1)

Location:

trunk/SRC/Colors

Files:

• . (added)
• colorbar.pro (moved) (moved from trunk/SRC/ToBeReviewed/COULEURS/colorbar.pro) (5 diffs)

trunk/SRC/Colors/colorbar.pro

@@ -1 +1 @@
 ;+
-; 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
@@ -74 +62 @@
 ;                 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
@@ -113 +94 @@
 ;       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
@@ -189 +173 @@
 
    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]
@@ -205 +189 @@
 
                                 ; Scale the color bar.
-   IF NOT KEYWORD_SET(discret) THEN $
+   IF NOT KEYWORD_SET(discrete) THEN $
     bar = BYTSCL(bar, TOP=ncolors-1) + bottom