Changeset 226 for trunk/SRC/ToBeReviewed/LECTURE/read_ncdf.pro

Timestamp:

03/16/07 10:22:26 (17 years ago)

Author:

pinsard

Message:

corrections of some misspellings in some *.pro

File:

• trunk/SRC/ToBeReviewed/LECTURE/read_ncdf.pro (modified) (20 diffs)

trunk/SRC/ToBeReviewed/LECTURE/read_ncdf.pro

@@ -2 +2 @@
 ; @file_comments
 ; Reading function for the file net_cdf.
-; This program is less universal than ncdf_lec (it appeal to declared 
+; This program is less universal than ncdf_lec (it appeal to declared
 ; variables in common.pro) but it is very easier to be used. It considerate
 ; the declaration of the different zooms which have been defined
 ; (ixminmesh...premierx...), the declaration of the variable key_shift...
 ; To put it in a nutshell, the result of read_ncdf can be directly used in plt...
-; This is also this program which is used by default in our reading widgets.  
+; This is also this program which is used by default in our reading widgets.
 ;
 ; @categories
 ; Reading
-; 
+;
 ; @param NAME {in}{required}{type=string}
 ; It define the field to be read.
@@ -18 +18 @@
 ; Relative with the time axis.
 ; These can be
-;  - 2 date of the  type yyyymmdd and in this case, we select dates 
+;  - 2 date of the  type yyyymmdd and in this case, we select dates
 ;  which are included between these two dates.
-;  - 2 indexes which define between which and which time step we have 
+;  - 2 indexes which define between which and which time step we have
 ;  to extract the temporal dimension.
 ;
@@ -26 +26 @@
 ; Relative with the time axis.
 ; See BEGINNING.
-; 
+;
 ; @param COMPATIBILITY {in}{optional}
 ; Useless, defined for compatibility
-;  
-; @keyword BOXZOOM 
-; Contain the boxzoom on which we have to do the reading 
-; 
+;
+; @keyword BOXZOOM
+; Contain the boxzoom on which we have to do the reading
+;
 ; @keyword CALLITSELF {default=0}{type=scalar: 0 or 1}
 ; For ROMS outputs. Use by read_ncdf itself to access auxilliary data (h and zeta).
-; 
+;
 ; @keyword FILENAME {required}{type=string}
 ; It contains he file's name.
-; 
+;
 ; @keyword INIT {default=0}{type=scalar: 0 or 1}
 ; To call automatically initncdf, filename and thus
 ; redefine all the grid parameters
-; 
+;
 ; @keyword GRID
 ; ='[UTVWF]' to specify the type of grid. Default is (1)
@@ -48 +48 @@
 ; GRID[._][TUVFW].NC (not case sensible) or (2) T if case (1)
 ; is not found.
-; 
+;
 ; @keyword TIMESTEP {default=0}{type=scalar: 0 or 1}
 ; Specify that BEGINNING and ENDING refer to indexes of the time axis and not to dates
 ;
 ; @keyword TOUT {default=0}{type=scalar: 0 or 1}
-; We activate it if we want to read the file on the whole domain without 
-; considerate the sub-domain defined by the boxzoom or 
+; We activate it if we want to read the file on the whole domain without
+; considerate the sub-domain defined by the boxzoom or
 ; lon1,lon2,lat1,lat2,vert1,vert2.
-; 
+;
 ; @keyword NOSTRUCT {default=0}{type=scalar: 0 or 1}
-; We activate it if we do not want that read_ncdf send back a structure 
+; We activate it if we do not want that read_ncdf send back a structure
 ; but only the array referring to the field.
-; 
+;
 ; @keyword TIMEVAR {type=string}
 ; It define the name of the variable that
@@ -74 +74 @@
 ;
 ; @keyword _EXTRA
-; Used to pass your keywords 
+; Used to pass your keywords
 ;
 ; @returns
 ; Structure readable by litchamp.pro or an array if NOSTRUCT is activated.
-; 
+;
 ; @uses
 ; common.pro
-; 
+;
 ; @restrictions
 ; The field must have a temporal dimension.
-; 
+;
 ; @history
 ; Sebastien Masson (smasson\@lodyc.jussieu.fr)
-;                      15/10/1999 
-; 
+;                      15/10/1999
+;
 ; @version
-; $Id$ 
+; $Id$
 ;-
 ;---------------------------------------------------------
@@ -116 +116 @@
 ; we find the filename.
 ;------------------------------------------------------------
-;  print,filename 
+;  print,filename
 ; is parent a valid widget ?
   if keyword_set(parentin) then BEGIN
@@ -145 +145 @@
     ncdf_diminq, cdfid, varcontient.dim[i], tmp, dimsize
     dimnames[i] = tmp
-  ENDFOR 
+  ENDFOR
 ;------------------------------------------------------------
 ; shall we redefine the grid parameters
@@ -174 +174 @@
       lasttps = where(time EQ date2) & lasttps = lasttps[0]
     ENDIF ELSE BEGIN
-      IF keyword_set(timevar) THEN BEGIN 
+      IF keyword_set(timevar) THEN BEGIN
         timeid = ncdf_varid(cdfid, timevar)
         IF timeid EQ -1 THEN BEGIN
@@ -183 +183 @@
         timecontient = ncdf_varinq(cdfid, timeid)
         contient.recdim = timecontient.dim[0]
-      ENDIF ELSE BEGIN 
+      ENDIF ELSE BEGIN
 ; we find the infinite dimension
         timedim = contient.recdim
@@ -190 +190 @@
           return, report('the file '+filename+' as no infinite dimension. !C Use TIMESTEP or TIMEVAR keyword')
         endif
-; we find the FIRST time axis      
+; we find the FIRST time axis
         timeid = 0
         repeat BEGIN       ; As long as we have not find a variable having only one dimension: the infinite one
@@ -204 +204 @@
         endif
         timeid = timeid-1
-      ENDELSE 
+      ENDELSE
 ; we must found the time origin of the julian calendar used in the
-; time axis. 
+; time axis.
 ; does the attribut units an dcalendar exist for the variable time axis?
       if timecontient.natts EQ 0 then BEGIN
@@ -231 +231 @@
           'greg':IF n_elements(key_caltype) EQ 0 THEN key_caltype = 'greg'
           ELSE:BEGIN
-;            notused = report('Unknown calendar: '+value+', we use greg calendar.') 
+;            notused = report('Unknown calendar: '+value+', we use greg calendar.')
             key_caltype = 'greg'
           END
         ENDCASE
       ENDIF ELSE BEGIN
-;        notused = report('Unknown calendar, we use '+key_caltype+' calendar.') 
+;        notused = report('Unknown calendar, we use '+key_caltype+' calendar.')
         IF n_elements(key_caltype) EQ 0 THEN key_caltype = 'greg'
       ENDELSE
@@ -272 +272 @@
         'hour':time = julday(depart[1], depart[2], depart[0])+time/24.d
         'day':time = julday(depart[1], depart[2], depart[0])+time
-        'month':BEGIN 
+        'month':BEGIN
           if total(fix(time) NE time) NE 0 then $ ; we switch to days with 30d/m
             time = julday(depart[1], depart[2], depart[0])+round(time*30) $
@@ -327 +327 @@
         dimnames[0] EQ 'xi_u'   AND dimnames[1] EQ 'eta_rho':vargrid = 'U'
         dimnames[0] EQ 'xi_u'   AND dimnames[1] EQ 'eta_v'  :vargrid = 'F'
-        ELSE:BEGIN 
+        ELSE:BEGIN
 ; could we define the grid type from the file name??
           pattern = ['GRID.', 'GRID_', 'GRID', 'UPID_', '30ID_']
@@ -369 +369 @@
     endcase
   ENDIF ELSE BEGIN
-    if keyword_set(boxzoom) then BEGIN 
+    if keyword_set(boxzoom) then BEGIN
       Case 1 Of
         N_Elements(Boxzoom) Eq 1:bte = [lon1, lon2, lat1, lat2, 0., boxzoom[0]]
@@ -386 +386 @@
     ENDIF
     grille, mask, glam, gphi, gdep, nx, ny, nz, firstx, firsty, firstz, lastx, lasty, lastz
-    undefine, glam & undefine, gphi & ; We liberate some memoty!
+    undefine, glam & undefine, gphi & ; We liberate some memory!
   ENDELSE
 ;---------------------------------------------------------------------
@@ -442 +442 @@
     if found NE -1 then ncdf_attget, cdfid, name, attnames[found], missing_value
 ;
-  ENDIF ELSE BEGIN 
+  ENDIF ELSE BEGIN
     IF NOT keyword_set(callitself) THEN varunit = ''
     add_offset = 0.
@@ -484 +484 @@
 ; we look for  missing_value
   IF size(missing_value, /type) NE 7 then BEGIN
-    IF size(missing_value, /type) EQ 1 THEN BEGIN 
+    IF size(missing_value, /type) EQ 1 THEN BEGIN
       missing_value = strlowcase(string(missing_value))
-      IF strmid(missing_value, 0, 1, /reverse_offset) EQ 'f' THEN $ 
+      IF strmid(missing_value, 0, 1, /reverse_offset) EQ 'f' THEN $
         missing_value = strmid(missing_value, 0, strlen(missing_value)-1)
-      IF isnumber(string(missing_value), tmp) EQ 1 THEN missing_value = tmp ELSE BEGIN 
+      IF isnumber(string(missing_value), tmp) EQ 1 THEN missing_value = tmp ELSE BEGIN
         print, 'Warning: missing value is not a number: ', missing_value
         missing_value = - 1
       ENDELSE
-    ENDIF 
+    ENDIF
 ;    if missing_value NE valmask then begin
     if abs(missing_value) LT 1e6 then missing = where(res EQ missing_value) $
@@ -498 +498 @@
 ;    ENDIF ELSE missing = -1
   ENDIF ELSE missing = -1
-; we apply add_offset, scale_factor and missing_value 
+; we apply add_offset, scale_factor and missing_value
   if scale_factor NE 1 then res = temporary(res)*scale_factor
   if add_offset NE 0 then res = temporary(res)+add_offset
@@ -538 +538 @@
   IF keyword_set(nostruct) THEN return, res
   IF keyword_set(key_forgetold) THEN BEGIN
-    return, {arr:temporary(res), grid:vargrid, unit:varunit, experiment:varexp, name:varname} 
-  ENDIF ELSE BEGIN 
+    return, {arr:temporary(res), grid:vargrid, unit:varunit, experiment:varexp, name:varname}
+  ENDIF ELSE BEGIN
     return, {tab:temporary(res), grille:vargrid, unite:varunit, experience:varexp, nom:varname}
   ENDELSE