Changeset 224 for trunk/SRC/ReadWrite

Timestamp:

03/15/07 11:22:28 (17 years ago)

Author:

pinsard

Message:

improvements/corrections of some *.pro headers

File:

• trunk/SRC/ReadWrite/ncdf_getaxis.pro (modified) (9 diffs)

trunk/SRC/ReadWrite/ncdf_getaxis.pro

@@ -25 +25 @@
 ;
 ; @keyword START1 {default=0}{type=scalar: 0 or 1}
-; Index the axis from 1 instead of 0 when using /xyindex 
-;
-; @keyword XDIRNAME {default='longitude', 'lon', 'x', 'longitude*', 'lon*', 'x*', '*longitude*', '*lon*' or '*x*'}{type=scalar string}
+; Index the axis from 1 instead of 0 when using /xyindex
+;
+; @keyword XDIMNAME {default='longitude', 'lon', 'x', 'longitude*', 'lon*', 'x*', '*longitude*', '*lon*' or '*x*'}{type=scalar string}
 ; A string giving the name of the x dimension
-;      
-; @keyword YDIRNAME {default='latitude', 'lat', 'y', 'latitude*', 'lat*', 'y*', 'eta_*', '*latitude*', '*lat*', '*y*'}{type=scalar string}
+;
+; @keyword YDIMNAME {default='latitude', 'lat', 'y', 'latitude*', 'lat*', 'y*', 'eta_*', '*latitude*', '*lat*', '*y*'}{type=scalar string}
 ; A string giving the name of the y dimension
-;      
+;
 ; @keyword XAXISNAME {default='x', 'longitude', 'nav_lon', 'lon', 'lon_rho' or 'NbLongitudes'}{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 YAXISNAME {default='y', 'latitude', 'nav_lat','lat', 'lat_rho' or 'NbLatitudes'}{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)
 ;
 ; @keyword XYINDEX {default=0}{type=scalar: 0 or 1}
@@ -72 +72 @@
   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
@@ -89 +89 @@
                   OR namevar EQ 'nav_lon' OR namevar EQ 'lon' $
                   OR namevar EQ 'lon_rho' OR namevar EQ 'nblongitudes'))[0]
-; no xaxis variable found, we will build a fake xaxis based on the size of the x dimension 
+; no xaxis variable found, we will build a fake xaxis based on the size of the x dimension
 ; -> we must find the x dimension
   IF xvarid EQ -1 THEN BEGIN
@@ -124 +124 @@
       ENDCASE
     ENDIF
-    romsgrid = 0b   
-  ENDIF ELSE BEGIN 
+    romsgrid = 0b
+  ENDIF ELSE BEGIN
     romsgrid = strmid(namevar[xvarid], 0, 4) EQ 'lon_'
     xinq = ncdf_varinq(cdfid, xvarid)
@@ -135 +135 @@
     ncdf_diminq, cdfid, dimidx, blabla, jpifromx
 ; should we read or compute the xaxis?
-    IF keyword_set(xyindex) OR xvarid EQ -1 THEN BEGIN 
+    IF keyword_set(xyindex) OR xvarid EQ -1 THEN BEGIN
       xaxis = keyword_set(start1) + findgen(jpifromx)
       xyindex = 1
@@ -143 +143 @@
 ; make sure of the shape of xaxis
       IF n_elements(jpjfromx) NE 0 THEN xaxis = reform(xaxis, jpifromx, jpjfromx, /over)
-    ENDELSE 
+    ENDELSE
   ENDIF
 
@@ -154 +154 @@
                   OR namevar EQ 'lat_rho' OR namevar EQ 'nblatitudes'))[0]
   yvarid = yvarid[0]
-; no yaxis variable found, we will build a fake yaxis based on the size of the y dimension 
+; no yaxis variable found, we will build a fake yaxis based on the size of the y dimension
 ; -> we must find the y dimension
   if yvarid EQ -1 then begin
@@ -189 +189 @@
       ENDCASE
     ENDIF
-  ENDIF ELSE BEGIN 
+  ENDIF ELSE BEGIN
     yinq = ncdf_varinq(cdfid, yvarid)
     IF yinq.ndims GE 2 THEN BEGIN
       ncdf_diminq, cdfid, yinq.dim[0], blabla, jpifromy
-      IF jpifromy NE jpifromx THEN BEGIN 
+      IF jpifromy NE jpifromx THEN BEGIN
         dummy = report('x/y axes do not have the same x dimension...')
         stop
@@ -204 +204 @@
     ncdf_diminq, cdfid, dimidy, blabla, jpjfromy
     IF n_elements(jpjfromx) NE 0 THEN BEGIN
-      IF jpjfromy NE jpjfromx THEN BEGIN 
+      IF jpjfromy NE jpjfromx THEN BEGIN
         dummy = report(' x/y axes do not have the same y dimension...')
         stop
-      ENDIF    
+      ENDIF
     ENDIF
 ; should we read or compute the xaxis?
-    IF keyword_set(xyindex) OR yvarid EQ -1 THEN BEGIN 
+    IF keyword_set(xyindex) OR yvarid EQ -1 THEN BEGIN
       yaxis = keyword_set(start1) + findgen(jpjfromy)
     ENDIF ELSE BEGIN