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

Timestamp:

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

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/CALCULS/level2mask.pro (modified) (3 diffs)

trunk/SRC/ToBeReviewed/CALCULS/level2mask.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:level2mask
 ;
-; PURPOSE: permet de passer d''un tableau 2d de niveau seuil au
-; tableau 3d de mask avec des 1 ds les niveaux au dessus du
-; niveau seuil et des 0 en dessous (et sur).
+; @file_comments
+; Allow to pass from a 2d sill level array to the 3d mask array with 1s in 
+; levels above the sill level and 0s below (and on it)
 ;
-; CATEGORY: SANS BOUCLE
+; @categories 
+; without loop
 ;
-; CALLING SEQUENCE: res=level2mask(niveau)
+; @param TAB {in}{required}
+; 2d level array of sill level (or a structure respecting litchamp criterions)
 ;
-; INPUTS: niveau tableau 2d de niveaux seuil (ou une structure repondant
-; aux criteres de litchamp)
+; @returns
+; It is a 3d array containing the mask associated to the 2d sill level array
 ;
-; KEYWORD PARAMETERS:
+; @uses
+; common.pro
 ;
-; OUTPUTS: un tableau 3d contenant le mask associe au tableau 2d de
-; niveaux seuil
-;
-; 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
 ; Setp 2004: boundary level have 0 values and not 1 (as it was
 ; explained before in the header). see:
 ; print, array_equal(niveau, total(level2mask(niveau),3))
+;
+;
+; @version
+; $Id$
 ;
 ;-
@@ -45 +40 @@
   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 size of the used subdomain
 ;------------------------------------------------------------
    niveaux = litchamp(tab)
    grille,maskterre, -1, -1, -1,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 the array's size and the defined by domdef domain
 ;---------------------------------------------------------------
    IF ny EQ 1 THEN niveaux = reform(niveaux, nx, ny, /over)
@@ -66 +60 @@
 ;------------------------------------------------------------
 ;------------------------------------------------------------
-; on transforme le tableau 2d de niveaux en tableau 3d de mask
+; We transform the 2d leval array in 3d mask array
 ;------------------------------------------------------------
    mask = reform( niveaux[*]#(1./(indgen(nz)+1)), nx, ny, nz )