Changeset 150 for trunk/SRC/ToBeReviewed/TRIANGULATION/tracemask.pro

Timestamp:

08/09/06 12:12:54 (18 years ago)

Author:

navarro

Message:

english and nicer header (3a)

File:

• trunk/SRC/ToBeReviewed/TRIANGULATION/tracemask.pro (modified) (5 diffs)

trunk/SRC/ToBeReviewed/TRIANGULATION/tracemask.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:tracemask
 ;
-; PURPOSE:dessiner des contour d''un mask
+; @file_comments
+; Draw contours of a mask
 ;
-; CATEGORY:plus simple que tracecote, car ne s''occuppe pas du type de
-; projection et de la periodicite de la grille
+; @categories
+; utilities
+; 
+; @param MASKENTREE {in}{required}
+; 2d array specifing the mask
+; 
+; @param XIN {in}{required},
+; 2d array specifing longitude coordinates.
+; 
+; @param YIN {in}{required},
+; 2d array specifing latitude coordinates.
 ;
-; CALLING SEQUENCE: tracemask, maskentree, xentree, yentree
-; 
-; INPUTS:maskentree, xentree, yentree tableaux 2d specifiant le mask
-; et ses coordonees en longitude te latitude.
+; @keyword COAST_COLOR
+; The color of the coastline.
+; defaut value is 0 => black
 ;
-; KEYWORD PARAMETERS:
+; @keyword COAST_THICK
+; The thick of the trait to trace continents
+; It is 1 by default.
 ;
-;        COAST_COLOR: the color of the coastline.
-;                     defaut value is 0 => black
+; @keyword OVERPLOT
+; To do a plot over an other one.
 ;
-;        COAST_THICK: l''epaisseur du trait pour tracer les
-;        continents. par defaut c''est 1.
+; @keyword _EXTRA
+; used to pass your keywords
 ;
-; OUTPUTS: none
+; @uses
+; common.pro
 ;
-; COMMON BLOCKS:common.pro
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @version
+; $Id$
 ;
 ;-
@@ -51 +58 @@
   ENDIF
 ;--------------------------------------------------------- 
-   tempsun = systime(1)         ; pour key_performance
-; on s''afranchit des problemes de bord:
-   tempdeux = systime(1)        ; pour key_performance =2
+   tempsun = systime(1)         ; For key_performance
+; We avoid edging problems:
+   tempdeux = systime(1)        ; For key_performance =2
    tailleentree = size(maskentree)
    nx = tailleentree[1]+1
@@ -62 +69 @@
   IF n_elements(yin) EQ 0 THEN yentree = findgen(ny-1) ELSE yentree = yin
   IF (size(yentree))[0] EQ 1 THEN yentree = replicate(1,nx-1)#yentree
-; on agrandi le mask de une colonne a gauche et de une colonne en bas
+; We enlarge the mask by 1 column to the left an d1 line to the bottom
    mask = intarr(tailleentree[1]+1, tailleentree[2]+1)
    mask[1:tailleentree[1], 1:tailleentree[2]] = maskentree
-; les 2 premieres colonnes sont identiques
+; The 2 first columns are identical.
    mask[0, 1:tailleentree[2]] = maskentree[0, *]
-; les 2 premieres lignes sont identiques
+; The 2 first lines are identical.
    mask[1:tailleentree[1], 0] = maskentree[*, 0]
-; on calcul la position suivant x des points qui seviront a tracer le
-; masque. ils sont situes entre chaque points du masque, sauf pour la
-; derniere colonne que l''on ne peut pas calculer et que l''on met
-; donc a max(!x.range)
-   xrange = !x.range[sort(!x.range)] ; si reverse_x est utilise!
+; We calculate the position following x of points which will serve to trace the mask. They are situated between each points of the mask, exept for the last column we can not calculate and so we put at max (!x.range).
+   xrange = !x.range[sort(!x.range)] ; if REVERSE_X is used
    xentree = .5*(xentree+shift(xentree, -1, 0))
    IF not keyword_set(overplot) THEN xentree[nx-2, *] = xrange[1] $
    ELSE xentree[nx-2, *] = xentree[nx-3, *]
-; on seuil
+; we sill
    xentree = xrange[0] > xentree < xrange[1]
-; on agrandit le tableau
+; we enlarge the array 
    xf = fltarr(nx, ny)
    xf[1:nx-1, 1:ny-1] = xentree
@@ -103 +107 @@
     print, 'temps tracemask: determination du mask et des ses coordonnes', systime(1)-tempdeux
 ;
-; on trace les segments verticaux:
+; We trace vertical segments:
 ;
-   tempdeux = systime(1)        ; pour key_performance =2
+   tempdeux = systime(1)        ; For key_performance =2
    liste = where(mask+shift(mask, -1, 0) EQ 1)
    IF liste[0] NE -1 THEN BEGIN
-; on recupere lx et ly qui sont les indices ds un tableau 2d des
-; points donnes par liste
+; We recuperate lx and ly which are indexes in a 2d array of points given by list
       ly = liste/nx & lx = temporary(liste)-nx*ly
-      indice = where(ly NE 0)   ; on ne prend pas les points concernant 
-; la premiere ligne car ds ce cas le pt j-1 n''est pas definit
+      indice = where(ly NE 0) ; We do not take points concernining 
+; the first line because in this case, the point j-1 is not defined 
       if indice[0] NE -1 then begin
          lx = lx[indice] & ly = ly[temporary(indice)]
          IF testvar(var = key_performance) EQ 2 THEN $
           print, 'temps tracemask: liste traits verticaux', systime(1)-tempdeux
-         tempdeux = systime(1)  ; pour key_performance =2
-; boucle sur les points concernes et trace du segment
-; rq: on utilise plots au lieu de plot car plots est bcp plus rapide.
+         tempdeux = systime(1)  ; For key_performance =2
+; loop on concerned points and drawing of the segment.
+; comments: we use plots instead of plot because plots is faster.
          for pt = 0L, n_elements(lx)-1 do BEGIN 
             i = lx[pt] & j = ly[pt]
@@ -132 +135 @@
    ENDIF
 ;
-; on trace les segments horizontaux:
+; We trace horizontal segments:
 ;
-   tempdeux = systime(1)        ; pour key_performance =2
+   tempdeux = systime(1)        ; For key_performance =2
    liste = where(mask+shift(mask, 0, -1) EQ 1)
    IF liste[0] NE -1 THEN BEGIN
       ly = liste/nx & lx = temporary(liste)-nx*ly
-      indice = where(lx NE 0)   ; on ne prend pas les points de la  premiere colonne
+      indice = where(lx NE 0)   ; We do not take point sof the first column.
       if indice[0] EQ -1 then return
       lx = lx[indice] & ly = ly[temporary(indice)]
       IF testvar(var = key_performance) EQ 2 THEN $
        print, 'temps tracemask: liste traits horizontaux', systime(1)-tempdeux
-      tempdeux = systime(1)     ; pour key_performance =2
+      tempdeux = systime(1)     ; For key_performance =2
       for pt = 0L, n_elements(lx)-1 do BEGIN 
          i = lx[pt] & j = ly[pt]