Changeset 133 for trunk/SRC/Colors/lct.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)
• lct.pro (moved) (moved from trunk/SRC/ToBeReviewed/COULEURS/lct.pro) (5 diffs)

trunk/SRC/Colors/lct.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; 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)... 
@@ -21 +17 @@
 ;                         > 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
@@ -52 +51 @@
    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)
@@ -58 +57 @@
        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 
@@ -89 +87 @@
 ;
       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 
 ;