Changeset 142 for trunk/SRC/ToBeReviewed/LECTURE/litchamp.pro

Timestamp:

07/21/06 14:47:49 (18 years ago)

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/LECTURE/litchamp.pro (modified) (4 diffs)

trunk/SRC/ToBeReviewed/LECTURE/litchamp.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:litchamp
 ;
-; PURPOSE:permet de lire un simple tableau ou une structure
-; correspondant a un champ.
-; Si en entree on a :
-;   -un simple tableau, litchamp renvoie le tableau
-;   -une stucture, litchamp renvoie le premier element de la structure
-;   qui doit obligatoirement etre le champ sous forme d''un tableau.
-;   Au passage litchamp regarde les autres elements de la structure et
-;   met a jour si besoin les variables globales qui se rapportent au
-;   champ: vargrid, varname, varunit, vardate, varexp , valmask et time 
+; @file_comments
+; Allows to read an array or a sructure cooresponding to a field.
+; If we have in input: 
+;   -an array, litchamp send back the array.
+;   -a structure, litchamp send back the first element of the structure 
+;   which must be the field in an array.
+;   Litchamp profit of this to look other elements of the structure et
+;   update if needed global variables which refer to the field:
+;   vargrid, varname, varunit, vardate, varexp , valmask et time 
 ;
-; CATEGORY:permet d''appeler plt, pltz, pltt ... avec un tableau ou une
-; structure et de mettre a jour les variables globales liees au champ. 
+; @categories
+; graphic
 ;
-; CALLING SEQUENCE:res=litchamp(struct)
+; @param STRUCT {in}{required}
+; It is either an array or a structure.
+;  If STRUCT is a structure, it must follow following rules:
+;        -the first element is the array containing the field.
+;        -other elements are strings containing informations on the field exept
+;        for the one about the date. This one can be either a string to designate
+;        a particular date (ex: 'August 1999') or a vector of julian days (of IDL)
+;        corresponding  to the calendar to be associated with the field if it is a
+;        temporal series.
+;        -the order of elements (exept the first) has not any importance. 
+;        -the other elements (exept the first) are optional.
+;        -they are recognize by the first letter of their names:
+;             g  to update vargrid
+;             u  to update varunit
+;             e  to update varexp
+;             d  to update vardate
+;             n  to update varname
+;             m  to update valmask
 ;
-; INPUTS:
-;        struct: c''est soit un tableau soit une structure.
-;    Si struct est une structure, elle doit suivre les regles
-;    suivantes:
-;        -le premier element est le tableau contenant le champ.
-;        -les autres elements sont des strings qui contiennent des
-;        informations sur le champ SAUF pour l''element relatif a
-;        date. Ce dernier peut etre soit un string pour designer une date
-;        particuliere (ex: 'August 1999') ou bien un vecteur de jours
-;        juliens (d''IDL) correspondant au calendrier a associer au
-;        champ si c'est une serie temporelle.
-;        -l''ordre des elements (autre que le premier) n''a pas
-;        d''importance. 
-;        -les autres elements (autre que le premier) sont tous
-;        optionnels.
-;        -ils sont reconnus par la premiere lettre de leur nom:
-;             g  pour actualiser vargrid
-;             u  pour actualiser varunit
-;             e  pour actualiser varexp
-;             d  pour actualiser vardate
-;             n  pour actualiser varname
-;             m  pour actualiser valmask
+; @keyword GRID
+; We activate this keyword if we want litchamp to send back the variable 
+; associated with the element of the structure starting by 'g' if it exist 
+; and '' if it does not.
 ;
-; KEYWORD PARAMETERS:
+; @keyword UNIT
+; We activate this keyword if we want litchamp to send back the variable 
+; associated with the element of the structure starting by 'u' if it exist 
+; and '' if it does not.
 ;
-;        /GRID: activer ce mot cle si on veut que litchamp renvoie la
-;        variable associee a l''element de la structure commencant
-;        par 'g' si il existe et '' dans le cas contraire.
+; @keyword EXP
+; We activate this keyword if we want litchamp to send back the variable 
+; associated with the element of the structure starting by 'u' if it exist 
+; and '' if it does not.
 ;
-;        /UNIT: activer ce mot cle si on veut que litchamp renvoie la
-;        variable associee a l''element de la structure commencant
-;        par 'u' si il existe et '' dans le cas contraire.
+; @keyword DATE
+; We activate this keyword if we want litchamp to send back the variable 
+; associated with the element of the structure starting by 'd' if it exist 
+; and '' if it does not.
 ;
-;        /EXP: activer ce mot cle si on veut que litchamp renvoie la
-;        variable associee a l''element de la structure commencant
-;        par 'e' si il existe et '' dans le cas contraire.
+; @keyword NAME
+; We activate this keyword if we want litchamp to send back the variable 
+; associated with the element of the structure starting by 'n' if it exist 
+; and '' if it does not.
 ;
-;        /DATE: activer ce mot cle si on veut que litchamp renvoie la
-;        variable associee a l''element de la structure commencant
-;        par 'd' si il existe et '' dans le cas contraire.
+; @keyword LEVEL
+; We activate this keyword if we want litchamp to send back the variable 
+; associated with the element of the structure starting by 'l' if it exist 
+; and -1 if it does not.
+; 
 ;
-;        /NAME: activer ce mot cle si on veut que litchamp renvoie la
-;        variable associee a l''element de la structure commencant
-;        par 'n' si il existe et '' dans le cas contraire.
+; @keyword MASK
+; We activate this keyword if we want litchamp to send back the variable 
+; associated with the element of the structure starting by 'm' if it exist 
+; and -1 if it does not.
 ;
-;        /LEVEL: activer ce mot cle si on veut que litchamp renvoie la
-;        variable associee a l''element de la structure commencant
-;        par 'l' si il existe et -1 dans le cas contraire.
+; @returns
+; It is the array containing the field.
 ;
-;        /MASK: activer ce mot cle si on veut que litchamp renvoie la
-;        variable associee a l''element de la structure commencant
-;        par 'm' si il existe et -1 dans le cas contraire.
+; @uses
+; common.pro
 ;
-; OUTPUTS:c''est le tableau qui continent le champ.
+; @restrictions
+; Update if needed global variables vargrid,
+; varname, varunit, vardate, varexp, valmask and time.
 ;
-; COMMON BLOCKS:
-;       common.pro
-;
-; SIDE EFFECTS: actualise au besion les variables globales vargrid,
-; varname, varunit, vardate, varexp, valmask et time.
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
+; @examples
 ;     
 ;    IDL> print, vargrid,', ', varname,', ', varunit,', ', vardate,', ', varexp     
@@ -97 +96 @@
 ; 
 ;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                       28/5/1999
+;
+; @version
+; $Id$
+;
 ;-
 ;------------------------------------------------------------
@@ -110 +114 @@
 @common
 ;------------------------------------------------------------
-   if size(struct, /type) ne 8 then BEGIN ; alors contour n''est pas une structure
+  if size(struct, /type) ne 8 then BEGIN ; so contour is not a structure.
       if keyword_set(grid) then return, ''
       if keyword_set(name) then return, ''
@@ -121 +125 @@
    ENDIF  
 ;------------------------------------------------------------
-   IF n_tags(struct) EQ 1 then BEGIN ; la structure n'a qu''un element
+   IF n_tags(struct) EQ 1 then BEGIN ; The structure has only one element.
       if keyword_set(grid) then return, ''
       if keyword_set(name) then return, ''