Changeset 175 for trunk/src/t2m_correction_ncdf.pro

Timestamp:

03/22/12 14:40:17 (12 years ago)

Author:

pinsard

Message:

an other bunch of new functions

File:

• trunk/src/t2m_correction_ncdf.pro (modified) (18 diffs)

trunk/src/t2m_correction_ncdf.pro

@@ -1 +1 @@
 ;+
-;
-; .. _t2m_correction_ncdf.pro:
 ;
 ; =======================
@@ -7 +5 @@
 ; =======================
 ;
+; .. function:: t2m_correction_ncdf(yyyymmddb,yyyymmdde)
+;
+; DESCRIPTION
+; ===========
+;
 ; Mean correction for air temperature bias and correction for variability are
 ; applied.
 ;
-; :file:`${PROJECT_ID}/erai_t2m_19890101_20091231_oafluxgrid.nc`
+; :file:`${PROJECT_ID}/erai_t2m_{yyyymmdd}_{yyyymmdd}_oafluxgrid.nc`
 ; containing
 ; air temperature at 2 m height from ERA-I interpolated on OAFLUX grid
@@ -18 +21 @@
 ; Corrected air temperature at 2 m height
 ; is written in
-; :file:`${PROJECT_OD}/TropFlux_t2m_19890101_20091231.nc`
+; :file:`${PROJECT_OD}/TropFlux_t2m_{yyyymmdd}_{yyyymmdd}.nc`
 ; if this file not already exists.
 ;
 ; This output file
-; :file:`${PROJECT_OD}/TropFlux_t2m_19890101_20091231.nc`
+; :file:`${PROJECT_OD}/TropFlux_t2m_{yyyymmdd}_{yyyymmdd}.nc`
 ; will be used by
-; :ref:`TropFlux_19890101_20091231.pro`.
+; :func:`tropflux`.
 ;
 ; .. only:: man
@@ -36 +39 @@
 ;        digraph t2m_correction_ncdf {
 ;
-;           file_in [shape=ellipse,fontname=Courier,label="${PROJECT_OD}/erai_t2m_19890101_20091231_oafluxgrid.nc"];
-;           file_out [shape=ellipse,fontname=Courier,label="${PROJECT_OD}/TropFlux_t2m_19890101_20091231.nc"];
+;           file_in [shape=ellipse,fontname=Courier,label="${PROJECT_OD}/erai_t2m_{yyyymmdd}_{yyyymmdd}_oafluxgrid.nc"];
+;           file_out [shape=ellipse,fontname=Courier,label="${PROJECT_OD}/TropFlux_t2m_{yyyymmdd}_{yyyymmdd}.nc"];
 ;
 ;           t2m_correction_ncdf [shape=box,
@@ -52 +55 @@
 ; ========
 ;
+; :ref:`mooring_corrections`
+;
+; Used by :ref:`tropflux.sh`
+;
 ; :ref:`project_profile.sh`
-;
-; :ref:`mooring_corrections`
 ;
 ; :func:`interp_erai_t2m`
@@ -72 +77 @@
 ; ::
 ;
-;  IDL> t2m_correction_ncdf
+;  IDL> yyyymmddb = 20000101L
+;  IDL> yyyymmdde = 20001231L
+;  IDL> result = t2m_correction_ncdf(yyyymmddb, yyyymmdde)
+;  IDL> print, result
 ;
 ; TODO
@@ -97 +105 @@
 ; check time values
 ;
-; hard coded time in module name and in output filename
-;
 ; hard coded correction values
 ;
@@ -121 +127 @@
 ;
 ; $URL$
+;
+; - fplod 20120322
+;
+;   * taking project_overwite into account
+;   * try to add compile_opt seems to be incompatible with ncdf_quickwrite
+;   * pro -> function
+;   * hard coded da1 and da2 replaced by yyyymmddb and yyyymmdde parameters
+;   * replace t2m=ncdf_lec(... by a t2m=read_ncdf(
 ;
 ; - fplod 20110822T112525Z aedon.locean-ipsl.upmc.fr (Darwin)
@@ -156 +170 @@
 ;
 ;-
-pro t2m_correction_ncdf
+function t2m_correction_ncdf $
+         , yyyymmddb $
+         , yyyymmdde
+;
+;++compile_opt idl2, strictarrsubs, logical_predicate
 ;
 @cm_4cal
@@ -164 +182 @@
 @cm_project
 ;
+; Return to caller if errors
+ON_ERROR, 2
+;
+result = -1
+;
+usage = 'result = sst_correction_ncdf(yyyymmddb, yyyymmdde)'
+nparam = N_PARAMS()
+IF (nparam NE 2) THEN BEGIN
+    ras = report(['Incorrect number of arguments.' $
+          + '!C' $
+          + 'Usage : ' + usage])
+    return, result
+ENDIF
+
 ; test if ${PROJECT_OD} defined
 CASE project_id_env OF
@@ -169 +201 @@
      msg = 'eee : ${PROJECT_OD} is not defined'
      ras = report(msg)
-     STOP
+     return, result
            END
  ELSE: BEGIN
@@ -184 +216 @@
    msg = 'eee : the directory' + iodirout  + ' is not accessible.'
    ras = report(msg)
-   STOP
+   return, result
 ENDIF
 ;
@@ -191 +223 @@
     msg = 'eee : the directory' + iodirout  + ' was not found.'
     ras = report(msg)
-    STOP
-ENDIF
-;
-da1=19890101
-da2=20091231
+    return, result
+ENDIF
 ;
 ; build uncorrected t2 filename
 filename_t2_uncor = 'erai_t2m_' $
-    + string(da1,format='(i8.8)') $
+    + string(yyyymmddb,format='(i8.8)') $
     + '_' $
-    + string(da2,format='(i8.8)') $
+    + string(yyyymmdde,format='(i8.8)') $
     + '_oafluxgrid.nc'
 ;
@@ -211 +240 @@
    msg = 'eee : the file ' + fullfilename_t2_uncor + ' was not found.'
    ras = report(msg)
-   STOP
+   return, result
 ENDIF
 ;
 ; build output filename
 filename_out = 'TropFlux_t2m_' $
-    + string(da1,format='(i8.8)') $
+    + string(yyyymmddb,format='(i8.8)') $
     + '_' $
-    + string(da2,format='(i8.8)') $
+    + string(yyyymmdde,format='(i8.8)') $
     + '.nc'
 ;
 fullfilename_out = iodirout + filename_out
 ; in order to avoid unexpected overwritten
-IF (FILE_TEST(fullfilename_out) EQ 1) THEN BEGIN
+IF ((FILE_TEST(fullfilename_out) EQ 1)  AND (project_overwrite EQ 0)) THEN BEGIN
    msg = 'eee : the file ' + fullfilename_out  + ' already exists.'
    ras = report(msg)
-   STOP
+   return, result
 ENDIF
 ;
@@ -239 +268 @@
 ;
 ; find first and last dates yyyymmdd
-; they will be written in global attributes of output file
 da=jul2date(julday(01, 01, 1957,timein[0]))
 cda0=string(da,format='(i8.8)')
 da=jul2date(julday(01, 01, 1957,timein[jptin-1]))
 cda1=string(da,format='(i8.8)')
-print, 'first date ', cda0
-print, 'last date ' , cda1
+print, 'for time checking first date ', cda0
+print, 'for time checking last date ' , cda1
 ;
 ; read t2 data
-t2m=ncdf_lec(fullfilename_t2_uncor,var='t2m')
+initncdf, fullfilename_t2_uncor
+t2m=read_ncdf('t2m',yyyymmddb-.5d,yyyymmdde,file=fullfilename_t2_uncor,/nostr)
+timein=24.d*(time-julday(1,1,1957,0,0,0))
+jpt=n_elements(timein)
+da=jul2date(time[0])
+cda0=string(da,format='(i8.8)')
+da=jul2date(time[jpt-1])
+cda1=string(da,format='(i8.8)')
+print, 't2m in t2m_correction_ncdf first date ', cda0
+print, 't2m in t2m_correction_ncdf last date ' , cda1
 ;
 t2m=t2m-273.15
@@ -267 +304 @@
   ;++print,day
   jtt=(julday(01, 01, 1957,timein[jt])-julday(1,1,yea)) < 364
-  t=reform(t2m_mean(*,*))
-  t2m_m(*,*,jt)=t
-  bias_cor(*,*,jt)=(((t-22.6)*0.4004896/(28-22.6)) > 0.) <0.4     ; (2000-2009)
+  t=reform(t2m_mean[*,*])
+  t2m_m[*,*,jt]=t
+  bias_cor[*,*,jt]=(((t-22.6)*0.4004896/(28-22.6)) > 0.) <0.4     ; (2000-2009)
 endfor
 help, t2m_m,bias_cor
@@ -290 +327 @@
 ;
 ;writing field
-lat=reform(gphit(0,0:jpj-1))
-lon=reform(glamt(0:jpi-1,0))
-cda0=string(da1)
-cda1=string(da2)
-;
-; conversion for hours since 19570101 to days from 19500101
-time=julday(01, 01, 1957,timein)-julday(1,1,1950)
-jpt=n_elements(time)
+lat=reform(gphit[0,0:jpj-1])
+lon=reform(glamt[0:jpi-1,0])
 ;
 ncfile='!' + fullfilename_out
@@ -313 +344 @@
 t2m_attr={units:units,missing_value:1.e20,long_name:long_name,short_name:'t2m',axis:'TYX'}
 ;
-ncfields = 't2m[longitude,latitude,time]=t2m_new:t2m_attr; ' $
+ncfields = 't2m[longitude,latitude,*time]=t2m_new:t2m_attr; ' $
                       + 'longitude[]=lon:lon_attr; ' $
                       + 'latitude[]=lat:lat_attr; ' $
-                      + 'time[*time]=time:time_attr ' $
+                      + 'time[]=timein:time_attr ' $
                       + ' @ globattr'
 ;
 @ncdf_quickwrite
 ;
+result = 0
+return, result
+;
 end