Changeset 231 for trunk/SRC/ToBeReviewed/INIT

Timestamp:

03/19/07 18:15:51 (17 years ago)

Author:

pinsard

Message:

improvements/corrections of some *.pro headers

File:

• trunk/SRC/ToBeReviewed/INIT/initncdf.pro (modified) (20 diffs)

trunk/SRC/ToBeReviewed/INIT/initncdf.pro

@@ -1 @@
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
 ;+
 ;
@@ -10 +7 @@
 ; @categories
 ; Grid
-; 
+;
 ; @param NCFILEIN {in}{required}{type=scalar string}
 ; A string giving the name of the NetCdf file
@@ -18 +15 @@
 ;
 ; @keyword MASKNAME {type=string}
-; A string giving the name of the variable in the file 
+; A string giving the name of the variable in the file
 ; that contains the land/sea mask
 ;
@@ -31 +28 @@
 ;
 ; @keyword USEASMASK {type=scalar string}
-; A string giving the name of the variable in the file 
+; A string giving the name of the variable in the file
 ; that will be used to build the land/sea mask. In this case the
 ; mask is based on the first record (if record dimension
@@ -40 +37 @@
 ;
 ; @keyword ZAXISNAME {default='z', 'level', 'lev', 'depth...'}{type=scalar string}
-; A string giving the name of the variable in the file 
-; that contains the [xyz]axis. 
+; A string giving the name of the variable in the file
+; that contains the [xyz]axis.
 ;
 ; @keyword XYINDEX {default=0}{type=scalar: 0 or 1}
 ; To define the x/y axis with index instead of using
-; the values contained in X/YAXISNAME. 
-; x/yaxis = keyword_set(start1) + findgen(jpi/jpj) 
+; the values contained in X/YAXISNAME.
+; x/yaxis = keyword_set(start1) + findgen(jpi/jpj)
 ; this forces key_onearth = 0
 ;
 ; @keyword ZINDEX {default=0}{type=scalar: 0 or 1}
 ; To define the z axis with index instead of using
-; the values contained in ZAXISNAME. 
-; zaxis = keyword_set(start1) + findgen(jpk) 
-; 
+; the values contained in ZAXISNAME.
+; zaxis = keyword_set(start1) + findgen(jpk)
+;
 ; @keyword _EXTRA
-; Used to pass keywords to computegrid and ncdf_getaxis
+; Used to pass keywords to <pro>computegrid</pro> and <pro>ncdf_getaxis</pro>
 ;
 ; @uses
@@ -61 +58 @@
 ;
 ; @restrictions
-; Change the grid parameters (see computegrid)
+; Change the grid parameters (see <pro>computegrid</pro>)
 ;
 ; @restrictions
@@ -67 +64 @@
 ;
 ; @examples
-;  IDL> initncdf,'toto.nc',glam=[-180,180]
+; IDL> initncdf,'toto.nc',glam=[-180,180]
 ;
 ; @history
@@ -77 +74 @@
 ;
 ;-
-;------------------------------------------------------------
-;------------------------------------------------------------
-;------------------------------------------------------------
+;
 PRO initncdf, ncfilein $
               , ZAXISNAME = zaxisname, MASKNAME = maskname $
@@ -86 +81 @@
               , XYINDEX = xyindex, ZINDEX = zindex $
               , _EXTRA = ex
-;
 ;
   compile_opt idl2, strictarrsubs
@@ -99 +93 @@
   endif
 ; if the file is stored on tape
-  if !version.os_family EQ 'unix' then spawn, 'file '+ncfile+' > /dev/null' 
+  if !version.os_family EQ 'unix' then spawn, 'file '+ncfile+' > /dev/null'
 ;----------------------------------------------------------
 ; open the file
@@ -109 +103 @@
   namedim = strarr(inside.ndims)
   for dimiq = 0, inside.ndims-1 do begin
-    ncdf_diminq, cdfid, dimiq, tmpname, value 
+    ncdf_diminq, cdfid, dimiq, tmpname, value
     namedim[dimiq] = strlowcase(tmpname)
   ENDFOR
@@ -126 +120 @@
 ; find the zaxis
   IF keyword_set(romsgrid) THEN BEGIN
-    FOR i = 0, inside.ndims-1 DO BEGIN 
+    FOR i = 0, inside.ndims-1 DO BEGIN
       ncdf_diminq, cdfid, i, name, size
       CASE strlowcase(name) OF
@@ -136 +130 @@
         ELSE:
       ENDCASE
-    ENDFOR 
+    ENDFOR
     IF (where(namevar EQ 'h'))[0] NE -1 THEN BEGIN
       ncdf_varget, cdfid, 'h', romsh
     ENDIF ELSE romsh = -1
-  ENDIF ELSE BEGIN 
+  ENDIF ELSE BEGIN
     if keyword_set(zaxisname) then zaxisname = strlowcase(zaxisname) ELSE zaxisname = 'z'
     zvarid = (where(namevar EQ 'nav_lev' or namevar EQ zaxisname OR namevar EQ 'level' OR namevar EQ 'lev' OR strmid(namevar, 0, 5) EQ 'depth'))[0]
@@ -149 +143 @@
 ; read the zaxis
     if zvarid NE -1 THEN ncdf_varget, cdfid, zvarid, zaxis
-  ENDELSE 
+  ENDELSE
   IF keyword_set(zindex) AND keyword_set(zaxis) THEN $
      zaxis = keyword_set(start1) + findgen(n_elements(zaxis))
@@ -158 +152 @@
     keyword_set(maskname):BEGIN
       mskid = (where(namevar EQ strlowcase(maskname)))[0]
-      if mskid NE -1 THEN BEGIN 
+      if mskid NE -1 THEN BEGIN
         mskinq = ncdf_varinq(cdfid, mskid)
 ; is the mask variable containing the record dimension?
         withrcd = (where(mskinq.dim EQ inside.recdim))[0]
         IF withrcd NE -1 THEN BEGIN
-; in order to read only the first record          
+; in order to read only the first record
 ; we need to get the size of each dimension
           count = replicate(1L, mskinq.ndims)
@@ -172 +166 @@
             ENDIF
           ENDFOR
-; read the variable for the first record          
+; read the variable for the first record
           ncdf_varget, cdfid, mskid, tmask, count = count
         ENDIF ELSE ncdf_varget, cdfid, mskid, tmask
-; check if we need to applay add_offset and scale factor         
+; check if we need to applay add_offset and scale factor
         FOR a = 0, mskinq.natts-1 DO BEGIN
-          attname = ncdf_attname(cdfid, mskid, a)     
+          attname = ncdf_attname(cdfid, mskid, a)
           CASE strlowcase(attname) OF
             'add_offset':ncdf_attget, cdfid, mskid, attname, add_offset
@@ -188 +182 @@
         if keyword_set(invmask) then tmask = 1-tmask
         tmask = byte(round(tmask))
-      ENDIF ELSE tmask = -1       
+      ENDIF ELSE tmask = -1
     END
 ;..................
     keyword_set(useasmask):BEGIN
       mskid = (where(namevar EQ strlowcase(useasmask)))[0]
-      if mskid NE -1 THEN BEGIN 
+      if mskid NE -1 THEN BEGIN
         mskinq = ncdf_varinq(cdfid, mskid)
 ; is the mask variable containing the record dimension?
         withrcd = (where(mskinq.dim EQ inside.recdim))[0]
         IF withrcd NE -1 THEN BEGIN
-; in order to read only the first record          
+; in order to read only the first record
 ; we need to get the size of each dimension
           count = replicate(1L, mskinq.ndims)
@@ -207 +201 @@
             ENDIF
           ENDFOR
-; read the variable for the first record       
+; read the variable for the first record
           ncdf_varget, cdfid, mskid, tmask, count = count
         ENDIF ELSE ncdf_varget, cdfid, mskid, tmask
-; check if we need to applay add_offset and scale factor       
+; check if we need to applay add_offset and scale factor
         FOR a = 0, mskinq.natts-1 DO BEGIN
-          attname = ncdf_attname(cdfid, mskid, a)     
+          attname = ncdf_attname(cdfid, mskid, a)
           CASE strlowcase(attname) OF
             'add_offset':ncdf_attget, cdfid, mskid, attname, add_offset
@@ -236 +230 @@
           IF min(tmask) EQ 1 THEN BEGIN
             print, 'missing or nan values not found...'
-            tmask = -1          
+            tmask = -1
           ENDIF
         ENDELSE
-      ENDIF ELSE tmask = -1       
+      ENDIF ELSE tmask = -1
     END
 ;..................
@@ -248 +242 @@
 ;
 ; compute the grid
-  if NOT keyword_set(zaxis) then BEGIN 
+  if NOT keyword_set(zaxis) then BEGIN
     computegrid, xaxis = xaxis, yaxis = yaxis $
-                 , mask = tmask, onearth = 1b - keyword_set(xyindex), ROMSH = romsh, _EXTRA = ex 
-  ENDIF ELSE BEGIN 
+                 , mask = tmask, onearth = 1b - keyword_set(xyindex), ROMSH = romsh, _EXTRA = ex
+  ENDIF ELSE BEGIN
     computegrid, xaxis = xaxis, yaxis = yaxis, zaxis = zaxis $
                  , mask = tmask, onearth = 1b - keyword_set(xyindex), ROMSH = romsh, _EXTRA = ex
-  ENDELSE 
+  ENDELSE
   IF n_elements(time) EQ 0 THEN time = 0
-  jpt = n_elements(time) 
+  jpt = n_elements(time)
 ;----------------------------------------------------------