Changeset 161 for trunk/tools/density_binning/density_bin_IDL_gm/bining2.pro

Timestamp:

11/12/09 17:15:09 (15 years ago)

Author:

pinsard

Message:

conversion from IDL help header syntax to IDLDOC 2. header syntax

File:

• trunk/tools/density_binning/density_bin_IDL_gm/bining2.pro (modified) (2 diffs)

trunk/tools/density_binning/density_bin_IDL_gm/bining2.pro

@@ -1 @@
-PRO bining2, $                   ;
-;INPUTS
-   density, $                   ; density at T points (3D array)
-   x1,      $                   ; field at T points (e.g. Salinity or Temperature)
-   sobwlmax, $                 ; bowl depth array
-   sig_bowl, $                  ; switch for bowl overlay
-;OUTPUTS 
-   depth_bin, $                 ; depth of layers (3D array)
-   thick_bin, $                 ; thickness of layers (3D array)
-   x1_bin,    $                 ; X averaged for each sigma-layer (3D array)
-   bowl_bin, $                  ; bowl depth binned on density
-; KEYWORDS
-   SIGMA = sigma,      $        ; bining values (optionnal)
-   DEPTH_T = depth_t,  $        ; depth of T level (NECESSARY)
-   DEPTH_W = depth_w,  $        ; depth of W level (NECESSARY)
+PRO bining2, $
+   density, $
+   x1, $
+   sobwlmax, $
+   sig_bowl, $
+   depth_bin, $
+   thick_bin, $
+   x1_bin, $
+   bowl_bin, $
+   SIGMA = sigma, $
+   DEPTH_T = depth_t, $
+   DEPTH_W = depth_w,  $
    E3T = e3t,          $
    E3W = e3w,          $
-   TMASK = tmask                ; tmask (3D array) (NECESSARY)
-            
+   TMASK = tmask
 ;;
 ;;  PRINCIPE DU BINING
@@ -41 +37 @@
 ;;    et l'apparition d'un +1 dans la declaration des tableaux de sortie
 ;;    la couche 0   contient tous les points dont la densite est inferieure a la densite minimale du bining
-;;    la couche N+1  "                   "                     " superieure      "       maximale        
-;;
-;;
-;; Creation : 19/10/99 G. Roullet
-;;
+;;    la couche N+1  "                   "                     " superieure      "       maximale
+;;
+;;
+; @param DENSITY {in}
+; density at T points (3D array)
+;
+; @param X1 {in}
+; field at T points (e.g. Salinity or Temperature)
+;
+; @param SOBWLMAX {in}
+; bowl depth array
+;
+; @param SIG_BOWL {in}
+; switch for bowl overlay
+;
+; @param DEPTH_BIN {out}
+; depth of layers (3D array)
+;
+; @param THICK_BIN {out}
+; thickness of layers (3D array)
+;
+; @param X1_BIN {out}
+; X averaged for each sigma-layer (3D array)
+;
+; @param BOWL_BIN {out}
+; bowl depth binned on density
+;
+; @keyword SIGMA {in}{optional}
+; bining values
+;
+; @keyword DEPTH_T {in}{required}
+; depth of T level
+;
+; @keyword DEPTH_W {in}{required}
+; depth of W level
+; 
+; @keyword E3T
+;
+; @keyword E3W
+;
+; @keyword TMASK{in}{required}
+; tmask (3D array)
+;
+; @history 
+; 19/10/99 G. Roullet
+;-
+
    size3d = size(density)
    jpi = size3d(1)