Changeset 142 for trunk/SRC/ToBeReviewed/PLOTS/LABEL

Timestamp:

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

Author:

navarro

Message:

english and nicer header (2a)

Location:

trunk/SRC/ToBeReviewed/PLOTS/LABEL

Files:

• label.pro (modified) (5 diffs)
• label_date.pro (modified) (3 diffs)
• lataxe.pro (modified) (4 diffs)
• lonaxe.pro (modified) (4 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

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

@@ -1 @@
-; $Id$
 ;
 ; Copyright (c) 1993-1998, Research Systems, Inc.  All rights reserved.
@@ -5 +4 @@
 
 ;+
-; NAME:
-;       LABEL_DATE
 ;
-; PURPOSE:
-;       This function labels axes with dates and times.
+; @file_comments
+; This function labels axes with dates and times.
 ;
-; CATEGORY:
-;       Plotting.
+; @categories
+; Plotting.
 ;
-; CALLING SEQUENCE:
-;       To set up:
-;               dummy = LABEL_DATE(DATE_FORMAT='string')
-;       To use:
-;               PLOT, x, y, XTICKFORMAT='LABEL_DATE'
+; @param AXIS {in}{required}
 ;
-; INPUTS:
-;       No explicit user defined inputs. When called from the plotting
-;       routines, the input parameters are (Axis, Index, Value)
+; @param INDEX {in}{required}
 ;
-; KEYWORD PARAMETERS:
-;       DATE_FORMAT: a format string which may contain the following:
-;                      %M for month (3 character abbr)
-;                      %N for month (2 digit abbr)
-;                      %D for day of month,
-;                      %Y for 4 digit year.
-;                      %Z for last two digits of year.
-;            For time:
-;                      %H for Hours, 2 digits.
-;                      %I for mInutes, 2 digits.
-;                      %S for Seconds, 2 digits.
-;                      %% is %.
-;                    Other characters are passed directly thru.
-;                    For example, '%M %D, %Y' prints DEC 11, 1993
-;                      '%M %2Y' yields DEC 93
-;                      '%D-%M' yields 11-DEC
-;                      '%D/%N/%Y' yields 11/12/1993
-;                      '%M!C%Y' yields DEC on the top line, 1993 on
-;                      the bottom (!C is the new line graphic command).
+; @param X {in}{required}
 ;
-;       MONTHS:      The names of the months, a twelve element string array.
-;                    If omitted, use Jan, Feb, ..., Dec.
+; @keyword DATE_FORMAT
+; a format string which may contain the following:
+; %M for month (3 character abbr)
+; %N for month (2 digit abbr)
+; %D for day of month,
+; %Y for 4 digit year.
+; %Z for last two digits of year.
+;  For time:
+; %H for Hours, 2 digits.
+; %I for mInutes, 2 digits.
+; %S for Seconds, 2 digits.
+; %% is %.
+;  Other characters are passed directly thru.
+; For example, '%M %D, %Y' prints DEC 11, 1993
+; '%M %2Y' yields DEC 93
+; '%D-%M' yields 11-DEC
+; '%D/%N/%Y' yields 11/12/1993
+; '%M!C%Y' yields DEC on the top line, 1993 on
+; the bottom (!C is the new line graphic command).
 ;
-;       OFFSET:      An optional starting offset of the plot.
-;               Unfortunately, single precision floating point is not accurate
-;               enough to properly represent Julian times.  This offset, which
-;               may be double precision, contains an offset that is added to
-;               all x values, before conversion to Julian date and time.
-
-; OUTPUTS:
-;       The date string to be plotted.
+; @keyword MONTHS
+; The names of the months, a twelve element string array.
+; If omitted, use Jan, Feb, ..., Dec.
 ;
-; COMMON BLOCKS:
-;       LABEL_DATE_COM.
+; @keyword OFFSET
+; An optional starting offset of the plot.
+; Unfortunately, single precision floating point is not accurate
+; enough to properly represent Julian times.  This offset, which
+; may be double precision, contains an offset that is added to
+; all x values, before conversion to Julian date and time.
 ;
-; RESTRICTIONS:
-;       Only one date axis may be simultaneously active.
+; @uses
+; LABEL_DATE_COM.
 ;
-; PROCEDURE:
-;       Straightforward.
+; @restrictions
+; Only one date axis may be simultaneously active.
 ;
-;       For an alternative way to label a plot axis with dates, refer to
-;       the C() format code accepted within format strings (applicable via
-;       the [XYZ]TICKFORMAT keywords).  This new format code was 
-;       introduced in IDL 5.2.
-;
-; EXAMPLE:
-;       For example, to plot from Jan 1, 1993, to July 12, 1994:
-;         Start_date = julday(1, 1, 1993)
-;         End_date = julday(7, 12, 1994)
-;         Dummy = LABEL_DATE(DATE_FORMAT='%N/%D')  ;Simple mm/dd
-;         x = findgen(end_date+1 - start_date) + start_date ;Time axis
-;         PLOT, x, sqrt(x), XTICKFORMAT = 'LABEL_DATE', XSTYLE=1
-;         (Plot with X axis style set to exact.)
+; @examples
+; For example, to plot from Jan 1, 1993, to July 12, 1994:
+; Start_date = julday(1, 1, 1993)
+; End_date = julday(7, 12, 1994)
+; Dummy = LABEL_DATE(DATE_FORMAT='%N/%D')  ;Simple mm/dd
+; x = findgen(end_date+1 - start_date) + start_date ;Time axis
+; PLOT, x, sqrt(x), XTICKFORMAT = 'LABEL_DATE', XSTYLE=1
+; (Plot with X axis style set to exact.)
 ;       
 ; Example with times:
@@ -92 +76 @@
 ;       PLOT, x, sqrt(x), XTICKFORMAT = 'LABEL_DATE', XSTYLE=1
 ;
-; MODIFICATION HISTORY:
+; @history
 ;       DMS, RSI.       April, 1993.    Written.
 ;       DMS, RSI.       March, 1997.    Added Time format.
+;
+; Copyright (c) 1993-1998, Research Systems, Inc.  All rights reserved.
+;       Unauthorized reproduction prohibited.
+;
+; @version
+; $Id$
+;
 ;-
-
+;-----------------------------------------------------------------------------
 FUNCTION LABEL_DATE, axis, index, x, DATE_FORMAT = format, MONTHS = months, $
               OFFSET= offs, _EXTRA = ex

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

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:LATAXE
 ;
-; PURPOSE:fonction appelee par [XYZ]TICKFORMAT (cf l'help pour voir
-;         comment l'utiliser) pour labeller les axes en latitude.
+; @file_comments
+; function called by [XYZ]TICKFORMAT (see the help to see how to use it) to label axes in latitude.
 ;
-; CATEGORY:graphe
+; @categories
+; graphic
+; 
+; @param AXIS 
+; It is the axis number: 0 for X axis, 1 for Y axis, 2 for Z axis.
 ;
-; CALLING SEQUENCE:[XYZ]TICKFORMAT='lataxe'
+; @param INDEX
+; It is the tick mark index which starts at 0.
+;       
+; @param VALUE
+; It is the default tick mark value (a floating-point number).
 ;
-; INPUTS:fournis (et imposes) automatiquement par IDL: axis, index, value:
-;       Axis is the axis number: 0 for X axis, 1 for Y axis, 2 for Z axis.
-;       Index is the tick mark index which starts at 0.
-;       Value is the default tick mark value (a floating-point number).
-; KEYWORD PARAMETERS:
+; @returns
+; A string, used automatically to label
 ;
-; OUTPUTS:un string, utilise automatiquement pour labeller
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
+;                       ???
+;                       14/10/1999 format of labels
 ;
-; COMMON BLOCKS:
+; @version
+; $Id$
 ;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                       ???
-;                       14/10/1999 format des labels
 ;-
 ;------------------------------------------------------------
@@ -37 +36 @@
 FUNCTION lataxe, axis, index, value
 ;------------------------------------------------------------
-; on ramenne value ds le segment [0,180]
+; We put back value in the segment [0,180]
 ;
   compile_opt idl2, strictarrsubs
@@ -44 +43 @@
    if lat lt 0 then lat=lat+360
    if lat gt 180 then lat=lat-180
-; format des labels:
+; format of labels:
    case 1 of
       lat EQ round(lat):fmt = 'i4'
@@ -50 +49 @@
       ELSE:fmt = 'f7.2'
    endcase
-; on ecrit le label
+; we write the label
    if lat le 90 and lat ne 0 then nom=string(lat,     format='('+fmt+',''N'')')
    if lat gt 90              then nom=string(180-lat, format='('+fmt+',''S'')')

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

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:LONAXE
 ;
-; PURPOSE:fonction appelee par [XYZ]TICKFORMAT (cf l'help pour voir
-;         comment l'utiliser) pour labeller les axes en longitude.
+; @file_comments
+; function called by [XYZ]TICKFORMAT (see the help to see how to use it) to label axes in longitude.
 ;
-; CATEGORY:graphe
+; @categories
+; graphic
+; 
+; @param AXIS 
+; It is the axis number: 0 for X axis, 1 for Y axis, 2 for Z axis.
 ;
-; CALLING SEQUENCE:[XYZ]TICKFORMAT='lonaxe'
+; @param INDEX
+; It is the tick mark index which starts at 0.
+;       
+; @param VALUE
+; It is the default tick mark value (a floating-point number).
 ;
-; INPUTS:fournis (et imposes) automatiquement par IDL: axis, index, value:
-;       Axis is the axis number: 0 for X axis, 1 for Y axis, 2 for Z axis.
-;       Index is the tick mark index which starts at 0.
-;       Value is the default tick mark value (a floating-point number).
-; KEYWORD PARAMETERS:
+; @returns
+; A string, used automatically to label
 ;
-; OUTPUTS:un string, utilise automatiquement pour labeller
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
+;                       ???
+;                       14/10/1999 format of labels
 ;
-; COMMON BLOCKS:
+; @version
+; $Id$
 ;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                       ???
-;                       14/10/1999 format des labels
 ;-
 ;------------------------------------------------------------
@@ -37 +36 @@
 FUNCTION lonaxe, axis, index, value
 ;------------------------------------------------------------
-; on ramenne value ds le segment [0,360[
+; We put back value in the segment [0,360[
 ;
   compile_opt idl2, strictarrsubs
@@ -43 +42 @@
    lon=value mod 360
    if lon lt 0 then lon=lon+360
-; format des labels:
+; format of labels:
    case 1 of
       lon EQ round(lon):fmt = 'i4'
@@ -49 +48 @@
       ELSE:fmt = 'f7.2'
    endcase
-; on ecrit le label
+; we write the label
    if lon lt 180 then nom=string(lon,     format='('+fmt+',''E'')')
    if lon gt 180 then nom=string(360-lon, format='('+fmt+',''W'')')