Changeset 118 for trunk/SRC/Grid/micromeshmask.pro

Timestamp:

06/27/06 17:47:06 (18 years ago)

Author:

pinsard

Message:

add $ in Calendar, Grid, Interpolation, Obsolete and Postscript *.pro files, add svn:keywords Id to all these files, some improvements in header

File:

• trunk/SRC/Grid/micromeshmask.pro (modified) (6 diffs, 1 prop)

trunk/SRC/Grid/micromeshmask.pro

@@ -2 +2 @@
 ;
 ; @file_comments reduce the size of the NetCDF meshmask created by OPA by
-; using bit (and not byte) format for the masks and the foat format
-; for the other fields. 
+; using bit (and not byte) format for the masks and the float format
+; for the other fields.
 ;
 ; @categories for OPA meshmask files
 ;
-; @examples 
-; IDL> reducencmeshmask, ncfilein[, ncfileout]
-;
-; @examples 
-;    IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/'
-;    IDL> micromeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir
+; @param inid {in}{required}
+; @param outid {in}{required}
+; @param inname {in}{required}
+; @param outname {in}{optional}
 ;
 ; @history
 ;      July 2004 Sebastien Masson (smasson\@lodyc.jussieu.fr)
+;
+; @version $Id$
+;
 ;-
 ;------------------------------------------------------
@@ -30 +31 @@
 ;
 ;+
-;    @keyword IODIR to define the files path.
+;
 ;      @param ncfilein {in}{required}
 ;      1) the name of the meshmask file to be reduced. In that case,
@@ -40 +41 @@
 ;      xxx.mask.nc. In that case, the meshmask is split into 3 files.
 ;
-;      @param ncfileout {in}{required} the name of the uniq reduced meshmask file. default
-;      definition is micromeshmask.nc
+; @param ncfileout {in}{optional} the name of the uniq reduced meshmask file.
+; default definition is micromeshmask.nc
+;
+; @keyword IODIR to define the files path.
+;
+; @examples
+; IDL> meshdir='/d1fes2-raid2/smasson/DATA/ORCA05/'
+; IDL> micromeshmask, 'meshmask_ORCA_R05.nc',iodir=meshdir
 ;
 ;-
 PRO micromeshmask, ncfilein, ncfileout, IODIR = iodir
-;
 ;
   compile_opt idl2, strictarrsubs
@@ -68 +74 @@
 ; get the horizontal dimensions
   IF n_elements(filein_hgr) NE 0  THEN cdfid = ncdf_open(filein_hgr) $
-  ELSE cdfid = ncdf_open(filein) 
+  ELSE cdfid = ncdf_open(filein)
   ncdf_diminq, cdfid, 'x', name, jpi
   ncdf_diminq, cdfid, 'y', name, jpj
@@ -81 +87 @@
   ENDIF
   listdims = strlowcase(ncdf_listdims(cdfid))
-  IF (where(listdims EQ 'z'))[0] NE -1 THEN ncdf_diminq, cdfid, 'z', name, jpk ELSE BEGIN 
+  IF (where(listdims EQ 'z'))[0] NE -1 THEN ncdf_diminq, cdfid, 'z', name, jpk ELSE BEGIN
     dimid = (where(strmid(listdims, 0, 5) EQ 'depth'))[0]
-    IF dimid NE -1 THEN ncdf_diminq, cdfid, dimid, name, jpk ELSE BEGIN 
+    IF dimid NE -1 THEN ncdf_diminq, cdfid, dimid, name, jpk ELSE BEGIN
       dummy = report('We could not find the vertical dimension..., its name must be z or start with depth')
       return
-    ENDELSE 
-  ENDELSE 
+    ENDELSE
+  ENDELSE
 ;; get the variables list related to the partial steps
   varlist_ps = ncdf_listvars(cdfid)
@@ -174 +180 @@
   FOR z = 0, n_elements(zgrlist)-1 DO $
     ncdf_transfer, cdfid, cdfidout, zgrlist[z]
-; partial step variables 
+; partial step variables
   IF (where(varlist_ps EQ 'hdept'))[0] NE -1 THEN $
     ncdf_transfer, cdfid, cdfidout, 'hdept'