Changeset 130 for trunk/SRC/ReadWrite/read_grads.pro

Timestamp:

07/06/06 16:48:41 (18 years ago)

Author:

pinsard

Message:

improvements of ReadWrite/?*.pro header

File:

• trunk/SRC/ReadWrite/read_grads.pro (modified) (3 diffs, 2 props)

trunk/SRC/ReadWrite/read_grads.pro

@@ -3 +3 @@
 ;------------------------------------------------------------
 ;+
-; @file_comments reading grads file (except "data type station" or "grib")
+; @file_comments
+; reading grads file (except "data type station" or "grib")
 ; from the grads control file even if there is multiple data files.
 ;
 ; @categories reading function
 ;
-;       @param var {in}{required} the variable name
-;       @param date1 {in}{required} date of the beginning (yyyymmdd if TIMESTEP is not activate)
-;       @param date2 {in}{optional} last date. Optionnal, if not scpecified date2=date1
-;      
-; @keyword FILENAME the grads control file name: 'xxxx.ctl'
-;
-; @file_comments keyword GLAMBOUNDARY (via computegrid.pro) a 2 elements vector,
-;       {lon1,lon2], giving the longitude boundaries that should be
-;       used to visualize the data.
+; @param var {in}{required}
+; the variable name
+;
+; @param date1 {in}{required}
+; date of the beginning (yyyymmdd if TIMESTEP is not activate)
+;
+; @param date2 {in}{optional}
+; last date. Optionnal, if not scpecified date2=date1
+;
+; @keyword FILENAME
+; the grads control file name: 'xxxx.ctl'
+;
+; @file_comments
+; keyword GLAMBOUNDARY (via computegrid.pro) a 2 elements vector,
+; {lon1,lon2], giving the longitude boundaries that should be
+; used to visualize the data.
 ;         lon2 > lon1
 ;         lon2 - lon1 eq 360
-;       key_shift will be automatically defined according to
-;       GLAMBOUNDARY.
-;
-;       @keyword /TIMESTEP to specify that the dates are time steps instead of 
-;       true calendar.
-;
-;        @file_comments keyword IODIRECTORY a string giving the name of iodirectory (see
-;       isafile.pro for all possibilities). default value is common 
-;       variable iodir
+; key_shift will be automatically defined according to GLAMBOUNDARY.
+;
+; @keyword TIMESTEP
+; to specify that the dates are time steps instead of true calendar.
 ;
 ; @file_comments
+; keyword IODIRECTORY
+; a string giving the name of iodirectory
+; (see isafile.pro for all possibilities).
+; default value is common variable iodir
+;
+; @todo
 ;---------------
 ; NOT yet available
 ;---------------
 ;
-;       @hidden BOX a 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1, 
+;       BOX a 4 or 6 elements 1d array, [lon1,lon2,lat1,lat2, depth1,
 ;       depth2], that specifies the area where data must be read
 ;
-;       @hidden EVERYTHING
-; 
-;       @hidden NOSTRUCTURE
-;       
-; @returns an array
+;       EVERYTHING
+;
+;       NOSTRUCTURE
+;
+; @returns
+; an array
 ;
 ; @uses common
 ;
-; @restriction define all the grid parameters (defined in common.pro)
+; @restriction
+; define all the grid parameters (defined in common.pro)
 ; associated to the data.
 ;
-; @restrictions this function call the procedure scanfile that use the 
-; unix commands grep and sed 
+; @restrictions
+; this function call the procedure scanfile that use the
+; unix commands grep and sed
 ;
 ; @examples
-;    IDL> a=read_grads('sst',19900101,19900131,filename='outputs.ctl')
-;    IDL> plt, a
+; IDL> a=read_grads('sst',19900101,19900131,filename='outputs.ctl')
+; IDL> plt, a
 ;
 ; @history Sebastien Masson (smasson\@lodyc.jussieu.fr)
+;
+; @version $Id$
 ;
 ;-
@@ -211 +225 @@
             'float':a=assoc(unit,fltarr(jpi,jpj,/nozero), offset+4*f77sequential)
          endcase
-         res[*, *, i+alreadyread]=a[0] 
+         res[*, *, i+alreadyread]=a[0]
       ENDIF ELSE BEGIN ; more than 1 level to be read
          if f77sequential then BEGIN ; sequential access
@@ -238 +252 @@
                'float':a=assoc(unit,fltarr(jpi,jpj,varslev[varid],/nozero),offset)
             endcase
-            if keyword_set(key_zreverse) then res[*, *, *, i+alreadyread]=reverse(a[0], 3) ELSE res[*, *, *, i+alreadyread]=a[0] 
+            if keyword_set(key_zreverse) then res[*, *, *, i+alreadyread]=reverse(a[0], 3) ELSE res[*, *, *, i+alreadyread]=a[0]
          ENDELSE
       ENDELSE