Changeset 142 for trunk/SRC/ToBeReviewed/CALCULS/depth2level.pro

Timestamp:

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

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/CALCULS/depth2level.pro (modified) (6 diffs)

trunk/SRC/ToBeReviewed/CALCULS/depth2level.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: depth2level
 ;
-; PURPOSE: permet de passer d''un tableau 2d de profondeur au tableau
-; 2d correspondant de niveaux.
+; @file_comments 
+; Allows to pass from a 2d depth array to a corresponding 2d level array.
 ;
-; CATEGORY: SANS BOUCLE
+; @categories
+; Without loop
 ;
-; CALLING SEQUENCE: res=depth2level(depth2d)
+; @param TAB 
+; 2d depth array (or a structure respecting litchamp critrions)
 ;
-; INPUTS: depth2d tableau 2d de profondeur (ou une structure repondant
-; aux criteres de litchamp)
+; @keyword UPPER
+; (activated by default) We select the level just above the depth
 ;
-; KEYWORD PARAMETERS:
+; @keyword LOWER
+; We select the level just below the depth 
 ;
-;      /UPPER: (active par defaut) on selectionne le niveau
-;      directement au dessus de la profondeur
+; @keyword CLOSER 
+; We select the depth's closer level 
 ;
-;      /LOWER: on selectionne le niveau directement au dessous de la
-;      profondeur 
+; @keyword NOMASK 
+; To do not mask land points
 ;
-;      /CLOSER: on selectionne le niveau le plus proche de la
-;      profondeur 
+; @returns 
+; It is a 2d array containing level's values.
 ;
-;      /NOMASK: pour ne pas masquer les points terres
+; @uses
+; common.pro
 ;
-; OUTPUTS: un tableau 2d contenant les valeurs des niveaux.
+; @restrictions 
+; For depthes out of gdep's values, the value !values.f_nan is sent back.
+; if the depth is superior to this one of the bottom, we send back jpk-1 in 
+; the upper case, and !values.f_nan in the lower case.
 ;
-; COMMON BLOCKS:common.pro
-;
-; SIDE EFFECTS:pour les profondeurs hors des valeurs de gdep, la
-; valeur !values.f_nan est retournee.
-; Si la profondeur est superieur a celle du fond, on retourne
-; jpk-1dans le cas upper, et !values.f_nan ds le cas lower.
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                       17/6/1999
 ;                       15/6/2000 accepte !values.f_nan
+;
+; @version
+; $Id$
 ;-
 ;------------------------------------------------------------
@@ -53 +52 @@
   compile_opt idl2, strictarrsubs
 ;
-   tempsun = systime(1)         ; pour key_performance
+   tempsun = systime(1)         ; for key_performance
 @common
 ;------------------------------------------------------------
@@ -59 +58 @@
    if keyword_set(lower) THEN upper = 0
 ;------------------------------------------------------------
-; lecture du champ d''entree et recuperation de la taille du sous
-; domaine utilise
+; Reading of the input field and recuperation of the used subdomain's size
 ;------------------------------------------------------------
    in = litchamp(tab)
    grille,mask,-1,-1,gdep,nx,ny,nz,firstx,firsty,firstz,lastx,lasty,lastz
 ;---------------------------------------------------------------
-; verification de la coherence entre la taille du tableau et le domaine definit par domdef
+; Verification of the coherence between array's size and the defined by domdef domain
 ;---------------------------------------------------------------
    IF ny EQ 1 THEN in = reform(in, nx, ny, /over)
@@ -78 +76 @@
 ;------------------------------------------------------------
 ;------------------------------------------------------------
-; vire les points a !values.f_nan
+; delete points at !values.f_nan
    notanumber = where(finite(in, /nan) EQ 1)
    if notanumber[0] NE -1 then in[notanumber] = 0
 ;------------------------------------------------------------
-; on transforme le tableau 2d de profondeur en tableau 2d de niveaux
-; correspondant aux profondeurs
+; We transform the 2d deth value in a 2d array of levels corresponding to depthes
 ;------------------------------------------------------------
-; on passe en tableaux qui ont la taille des tableaux 3d
+; We go on array who have the size of 3d arrays
    prof=replicate(1,nx*ny)#gdep[firstz:lastz] 
    in = in[*]#replicate(1, nz)
@@ -99 +96 @@
    IF notvalid[0] NE -1 THEN levels[notvalid] = !values.f_nan
 
-; si closer est active
+; If closer is activated
    if keyword_set(closer) then begin
       test = [ [[litchamp(tab)-level2depth(levels)]] $
@@ -108 +105 @@
    endif
 ;------------------------------------------------------------
-; on replace les points a !values.f_nan
+; We put back points at !values.f_nan
    if notanumber[0] NE -1 then levels[notanumber] = !values.f_nan
-; on masque les points terres a valmask
+; We mask land points at valmask
    if NOT keyword_set(nomask) then begin
       if n_elements(valmask) EQ 0 then valmask = 1e20