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

Timestamp:

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

Author:

navarro

Message:

english and nicer header (3a)

File:

• trunk/SRC/ToBeReviewed/TRIANGULATION/drawcoast_c.pro (modified) (4 diffs)

trunk/SRC/ToBeReviewed/TRIANGULATION/drawcoast_c.pro

@@ +1 @@
+;+
+; @file_comments
+;
+;
+; @categories
+;
+; 
+; @param MASK
+;
+; 
+; @param XF
+; 
+;
+; @param YF
+; 
+;
+; @param NX
+; 
+;
+; @param NY
+; 
+;
+; @keyword COAST_COLOR
+; The color of the coastline.
+; defaut value is 0 => black
+;
+; @keyword COAST_THICK
+; The thick of the trait to trace continents
+; By default, it is 1.
+;
+; @keyword XSEUIL
+; To eliminate segments of coasts which are to big (which link points which can 
+; be close on the sphere but distant on the drawing). We delete all segments 
+; whose the size surpass the size of the window following X/XSEUIL. By default, 
+; XSEUIL=5. But it can be to big if we do a big zoom or a little one for some 
+; projections... We specify it the keyword thanks to this keyword!
+;
+; @keyword YSEUIL
+; See XSEUIL
+; 
+; @keyword _EXTRA
+; Used to pass our keywords
+;  
+; @returns
+; 
+; 
+; @uses
+; 
+; 
+; @restrictions
+; 
+; 
+; @examples
+; 
+; 
+; @history
+; 
+; 
+; @version 
+; 
+; @todo 
+; Seb: remplir le header
+;
+;-
+;---------------------------------------------------------
 PRO drawcoast_c, mask, xf, yf, nx, ny, COAST_COLOR = coast_color, COAST_THICK = coast_thick, YSEUIL = yseuil, XSEUIL = xseuil, _extra = ex
-;---------------------------------------------------------
 ;
   compile_opt idl2, strictarrsubs
@@ -10 +74 @@
   ENDIF
 ;---------------------------------------------------------
-   tempsun = systime(1)         ; pour key_performance
+   tempsun = systime(1)         ; For key_performance
 ;---------------------------------------------------------
 ;
-; on trace les segments verticaux:
+; We trace vertical segments:
 ;
    if NOT keyword_set(yseuil) then yseuil = 5. < (min([nx, ny])-2)
    distanceseuil = (!p.position[3]-!p.position[1])/yseuil
-; liste: liste des points i pourlesquels on va tracer un segment entre
-; le point i,j-1 et i,j
-   tempdeux = systime(1)        ; pour key_performance =2
+; list: list of points i for which we will trace a segment between the point i,j-1 and i,j
+   tempdeux = systime(1)        ; For key_performance =2
    liste = where((mask+shift(mask, -1, 0)) EQ 1 $
                  AND ((xf-shift(xf, 0, 1))^2+(yf-shift(yf, 0, 1))^2) LE distanceseuil^2)
    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 an dly 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
+      indice = where(ly NE 0)   ; We do not take points concerning
       if indice[0] NE -1 then begin
-; la premiere ligne car ds ce cas le pt j-1 n''est pas definit
+; the first line because in this case, the point j-1 is undefined.
          lx = lx[indice] & ly = ly[temporary(indice)]
-; boucle sur les points concernes et trace du segment
-; rq: on utilise plost au lieu de plot car plots est bcp plus rapide.
+; Loop on concerned points and drawing of the segment.
+; Comment: we use plots instead of plot because plots goes faster.
          IF testvar(var = key_performance) EQ 2 THEN $
           print, 'temps tracecote: determiner liste des points concernes par un trait vertical', 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]
@@ -45 +107 @@
    ENDIF
 ;
-; pour le trace des segments horizontaux, c''est la meme chose sauf
-; qu'il faut faire attention si on est periodique: 
+; For the drawing of horizontal segments , it is the same thing but we have to be careful if it is periodic.
 ;
-; si on est periodique on duplique la premiere colonne et on la met a
-; la fin. (ceci est fait non pas pour le shift qui est par defaut
-; periodique mais pour le plots 
-   tempdeux = systime(1)        ; pour key_performance =2
+; If it is periodic, we duplicate the first column and we put it at the end. 
+; (This is made not for the shift which is periodic by default but for the plots)
+   tempdeux = systime(1)        ; For key_performance =2
    if keyword_set(key_periodic) AND nx EQ jpi then begin
       mask = [mask, mask[0, *]]
@@ -66 +126 @@
       indice = where(ly NE ny-1 AND lx NE 0)
       if indice[0] NE -1 then begin
-; on ne prend pas les points de la 
-; premiere colonne et de la derniere ligne (car on l''a rajoute artificiellement!))
+; We do not take points of the first column and of the last line (because we added artificially)
          lx = lx[indice] & ly = ly[temporary(indice)]
          IF testvar(var = key_performance) EQ 2 THEN $
           print, 'temps tracecote: determiner liste des points concernes par un trait horizontal', 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]