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

Timestamp:

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

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/CALCULS/level2depth.pro (modified) (2 diffs)

trunk/SRC/ToBeReviewed/CALCULS/level2depth.pro

@@ -4 +4 @@
 ;------------------------------------------------------------
 ;+
-; NAME:level2depht
 ;
-; PURPOSE: permet de passer d''un tableau 2d de niveau au
-; tableau 2d de profondeur correspondant a ces niveaux
+; @file_comments
+; Allows to pass from a 2d level array to a 2d depth array corresponding o these levels
 ;
-; CATEGORY: SANS BOUCLE
+; @categories
+; Without loop
 ;
-; CALLING SEQUENCE: res=level2depth(niveau)
+; @param TAB {in}{required}
+; 2d level array of sill levels (or a structure respecting litchamp criterions)
 ;
-; INPUTS: niveau tableau 2d de niveaux seuil (ou une structure repondant
-; aux criteres de litchamp)
+; @keyword NOMASK
+; To do not mask land points.
 ;
-; KEYWORD PARAMETERS:
-;       /NOMASK: pour ne pas masquer les points terres
+; @returns 
+; 2d array containing depthes
 ;
-; OUTPUTS: un tableau 2d contenant des profondeurs
+; @uses
+; common.pro
 ;
-; COMMON BLOCKS:
-;       common.pro
-;
-; SIDE EFFECTS:
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                       17/6/1999
 ;                       14/6/2000 accepte !values.f_nan
+;
+; @version
+; $Id$
+;
 ;-
 ;------------------------------------------------------------
@@ -41 +39 @@
   compile_opt idl2, strictarrsubs
 ;
-   tempsun = systime(1)         ; pour key_performance
+   tempsun = systime(1)         ; To key_performance
 @common
 ;------------------------------------------------------------
-; lecture du champ d''entree et recuperation de la taille du sous
-; domaine utilise
+; Reading of the input field  and recovery of the used subdomain's size
 ;------------------------------------------------------------
    niveaux = 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 domain definied by domdef
 ;---------------------------------------------------------------
    taille = size(niveaux)