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

Timestamp:

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

Author:

navarro

Message:

english and nicer header (2a)

File:

• trunk/SRC/ToBeReviewed/CALCULS/depth2floatlevel.pro (modified) (5 diffs)

trunk/SRC/ToBeReviewed/CALCULS/depth2floatlevel.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; NAME:depth2floatlevel
+; @file_comments
+; Rather comparable to depth2level but here, the calculated level is in float. 
+; For example, the level 5.4 correspond to a depth equal 
+; to gdep[5]+.4*(gdep[6]-gdep[5])
 ;
-; PURPOSE: assez comparable a depth2level mais ici le niveau calcule
-; est en float. Par ex le niveau 5.4 correspond a une profondeur egale
-; a gdep[5]+.4*(gdep[6]-gdep[5])
+; @categories 
+; Without loop.
 ;
-; CATEGORY: SANS BOUCLE
+; @param TAB {in}{required}
+; 2d depth array (or a structure respecting litchamp criterions)
 ;
-; CALLING SEQUENCE:res=depth2floatlevel(depth2d)
-; 
-; INPUTS: depth2d tableau 2d de profondeur (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
+; An 2d array of float containing levels's values.
 ;
-; OUTPUTS: un tableau 2d de float contenant les valeurs des niveaux.
+; @uses
+; common.pro
 ;
-; COMMON BLOCKS:common.pro
+; @restrictions
+; Accept values at !values.f_nan and mask land points at valmask.
 ;
-; SIDE EFFECTS:accepte les vcaleurs a !values.f_nan et masque les
-; points terres a valmask.
-;
-; RESTRICTIONS:
-;
-; EXAMPLE:
-;
+; @examples
 ;    IDL> a=(jpk-1)/(1.*jpi*jpj)*findgen(jpi,jpj)
 ;    IDL> plt, 1e6*(a-floatlevel2depth(depth2floatlevel(a))),/nocontour
@@ -35 +32 @@
 ;  ->champ nul a 1e-6 pres
 ;
-; MODIFICATION HISTORY:Sebastien Masson (smasson@lodyc.jussieu.fr)
+; @history 
+; Sebastien Masson (smasson@lodyc.jussieu.fr)
 ;                      15/06/2000
+; 
+; @version
+; $Id$
+;
 ;-
 ;------------------------------------------------------------
@@ -45 +47 @@
   compile_opt idl2, strictarrsubs
 ;
-   tempsun = systime(1)         ; pour key_performance
+   tempsun = systime(1)         ; for key_performance
 @common
 ;------------------------------------------------------------
@@ -55 +57 @@
    levellow = depth2level(depthin, /lower, /nomask)
    depthlow = level2depth(levellow, /nomask)
-; calcule de la distance depthlow-depthup et gestion du cas ou cette
-; distance est nulle ou egale a !values.f_nan
+; calculate the distance depthlow-depthup and management of the case 
+; of this distance is null or eqal to !values.f_nan
    divi = depthlow-depthup
    nan = where(finite(divi) EQ 0)
@@ -62 +64 @@
    nan = where(divi EQ 0)
    if nan[0] NE -1 then divi[nan] = !values.f_nan
-; calcule du resultat
+; calculation of the result
    res = levelup+(depthin-depthup)/divi
-; on masque les points terre a valmask
+; We mask land point at valmask
    if NOT keyword_set(nomask) then begin
       grille,mask