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

Timestamp:

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

Author:

navarro

Message:

english and nicer header (2a)

File:

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

trunk/SRC/ToBeReviewed/CALCULS/depth2mask.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME: depth2mask
 ;
-; PURPOSE: permet de passer d''un tableau 2d de profondeur seuil au
-; tableau 3d de mask avec des 1 ds les niveaux au dessus de la
-; profondeur seuil et des 0 en dessous.
+; @file_comments 
+; Allows to pass from a 2d depth sill array to a 3d array of mask 
+; with one of levels above the sill depth and 0s below.
 ;
-; CATEGORY: SANS BOUCLE
+; @categories
+; Without loop
 ;
-; CALLING SEQUENCE: res=depth2mask(depht2d)
+; @param TAB 
+; 2d sill depth array (or a structure respecting litchamp critrions)
 ;
-; INPUTS: depht2d tableau 2d de profondeur seuil (ou une structure repondant
-; aux criteres de litchamp)
-;
-; KEYWORD PARAMETERS:
-;
-;      /UPPER: (active par defaut) on selectionne le niveau
-;      directement au dessus de la profondeur
-;
-;      /LOWER: on selectionne le niveau directement au dessous de la
-;      profondeur 
-;
-;      /CLOSER: on selectionne le niveau le plus proche de la
-;      profondeur 
-;
-; OUTPUTS: un tableau 3d contenant le mask associe au tableau 2d de
+; @keyword _EXTRA
+; used to pass your keywords
+; 
+; @returns
+; It is a 3d array containing the mas associated to the 2d sill depth array
 ; profondeurs seuil
 ;
-; COMMON BLOCKS:
-;       common.pro
+; @uses
+; common.pro
 ;
-; SIDE EFFECTS:
+; @history
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
+;                       17/6/1999
 ;
-; RESTRICTIONS:
+; @version
+; $Id$
 ;
-; EXAMPLE:
-;
-; MODIFICATION HISTORY: Sebastien Masson (smasson@lodyc.jussieu.fr)
-;                       17/6/1999
 ;-
 ;------------------------------------------------------------
@@ -50 +40 @@
   compile_opt idl2, strictarrsubs
 ;
-   tempsun = systime(1)         ; pour key_performance
+   tempsun = systime(1)         ; For key_performance
 @common
 ;------------------------------------------------------------
-; 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
 ;------------------------------------------------------------
    niveaux = depth2level(tab, _extra = ex)
    IF niveaux[0] EQ -1 THEN return,  -1
 ;------------------------------------------------------------
-; on transforme le tableau 2d de niveaux en tableau 3d de mask
+; We transform the 2d array in a 3d array of mask
 ;------------------------------------------------------------
    mask = level2mask(niveaux)