Changeset 142 for trunk/SRC/ToBeReviewed/PLOTS/LABEL/label.pro

Timestamp:

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

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/PLOTS/LABEL/label.pro (modified) (5 diffs)

trunk/SRC/ToBeReviewed/PLOTS/LABEL/label.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:label
 ;
-; PURPOSE:permet de choisir le stype de label que l'on veut utiliser
-; lors d'un contour
+; @file_comments
+; Allows to choose the type of the label we want to use at the time of a contour.
 ;
-; CATEGORY:graphique
+; @categories
+; graphic
 ;
-; CALLING SEQUENCE:pro label,cas,min,max,ncontour,level_z2d
+; @param CAS {in}{required}
+; Number of the type of the label we want to trace
+;       
+; @param MIN {in}{required} 
+; Smallest value for the drawing of the contour.
 ;
-; INPUTS:
-;       cas=numero du type de label que l'on veut tracer
-;       min et max = valeures min et max entre lesquelles on veut faire
-; des contours
+; @param MAX {in}{required}
+; Biggest value for the drawing of the contour.
 ;
-; KEYWORD PARAMETERS:
+; @keyword INTERVALLE
+; Value of an interval betwenn two isolines. By default, it is calculated to 
+; draw 20 isolines. In all cases, this keyword must be returnedt have a nice
+; caption. If levels do not contain regular intervals, put it at -1.
 ;
-;       INTERVALLE: valeur d'un intervalle entre deux isolignes. par defaut
-; est calcule pour tracer 20 isolighnes. Dans tous les cas ce not cle
-; doit etre retourne pour pouvoir avoir une belle legende. Si les
-; niveaux ne comportent pas d''intevalle regulier, le mettre a -1
+; @keyword NLEVEL
+; Number of contour to be drawn. By default =20. Active if LABEL=0 or is not specified.
 ;
-;       NLEVEL: nombre de contours a dessiner. par defaut =20. actif si
-; LABEL=0 ou nest pas specifie.
+; @param NCONTOUR {out}
+; Number of contour to be drawn.
+; 
+; @param LEVEL_Z2D {out}
+; Vector containing values of contours we draw.
 ;
-; OUTPUTS:
-;       ncontour=nombre de contour a tracer
-;       level_z2d=vecteur contenant les valeurs des contours que l'on trace
-;       colnumb: un vecteur contenant le numero des couleurs qui serviront a
-;               remplir entre les contours)
+; @param COLNUMB {out}
+; Vector containing the number of colors which will serve to fill contours.
 ;
-; COMMON BLOCKS:
-;       common.pro
+; @uses
+; common.pro
 ;
-; SIDE EFFECTS:
+; @history 
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
+;                       7/5/98
 ;
-; RESTRICTIONS:
+; @version 
+; $Id$
 ;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                       7/5/98
 ;-
 ;------------------------------------------------------------
@@ -72 +74 @@
    case cas of
       0: begin
-;nlevel label entre le min et le max
+; nlevel label between the min and the max
          if keyword_set(Nlevel) eq 0 then ncontour=20 else ncontour=nlevel
          ncontour = 1 > ncontour
@@ -80 +82 @@
       end
       1: begin
-;un certain nombre de label en partant du min jusqu'au plus pres de max avec
-; un pas fixe par intervalle
+; a certain number of label from the min to the nearest possible to the
+; max with a constant step by interval
          ncontour  = fix((max-min)/intervalle)
          ncontour = 1 > ncontour
@@ -88 +90 @@
          max=level_z2d[Ncontour-1]+intervalle
       end
-; label pour faire les memes sss que dessier
+; label to do same sss than dessier
 
       2: begin
@@ -100 +102 @@
       end
       3: begin
-; lecture intervalles + palette dans fichier GMT
+; Readinf of intervals + palette in the file GMT
 
          label_gmt, min, max, intervalle, ncoul, ncontour, level_z2d, colnumb