Changeset 175 for trunk/src/sst_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/sst_correction_ncdf.pro (modified) (17 diffs)

trunk/src/sst_correction_ncdf.pro

@@ -1 +1 @@
 ;+
-;
-; .. _sst_correction_ncdf.pro:
 ;
 ; =======================
@@ -7 +5 @@
 ; =======================
 ;
+; .. function:: sst_correction_ncdf(yyyymmddb,yyyymmdde)
+;
+; DESCRIPTION
+; ===========
+;
 ; Correction of sst on OAFLUX grid
 ;
-; :file:`${PROJECT_OD}/erai_sst_19890101_20091231_oafluxgrid.nc`
+; :file:`${PROJECT_OD}/erai_sst_{yyyymmdd}_{yyyymmdd}_oafluxgrid.nc`
 ; containing
 ; ++
@@ -17 +20 @@
 ; Corrected sst on OAFLUX grid
 ; is written in
-; :file:`${PROJECT_OD}/TropFlux_sst_19890101_20091231.nc`
+; :file:`${PROJECT_OD}/TropFlux_sst_{yyyymmdd}_{yyyymmdd}.nc`
 ; if this file not already exists.
 ;
 ; This output file
-; :file:`${PROJECT_OD}/TropFlux_sst_19890101_20091231.nc`
+; :file:`${PROJECT_OD}/TropFlux_sst_{yyyymmdd}_{yyyymmdd}.nc`
 ; will be used by
 ; :func:`cronin_gustiness_ncdf`
 ; and
-; :ref:`TropFlux_19890101_20091231.pro`.
+; :func:`tropflux`.
 ;
 ; This output file
-; :file:`${PROJECT_OD}/TropFlux_sst_19890101_20091231.nc`
+; :file:`${PROJECT_OD}/TropFlux_sst_{yyyymmdd}_{yyyymmdd}.nc`
 ; is one of the deliverable of TropFlux.
 ;
@@ -41 +44 @@
 ;        digraph sst_correction_ncdf {
 ;
-;           file_in [shape=ellipse,fontname=Courier,label="${PROJECT_OD}/erai_sst_19890101_20091231_oafluxgrid.nc"];
-;           file_out [shape=ellipse,fontname=Courier,label="${PROJECT_OD}/TropFlux_sst_19890101_20091231.nc"];
+;           file_in [shape=ellipse,fontname=Courier,label="${PROJECT_OD}/erai_sst_{yyyymmdd}_{yyyymmdd}_oafluxgrid.nc"];
+;           file_out [shape=ellipse,fontname=Courier,label="${PROJECT_OD}/TropFlux_sst_{yyyymmdd}_{yyyymmdd}.nc"];
 ;
 ;           sst_correction_ncdf [shape=box,
@@ -57 +60 @@
 ; ========
 ;
+; :ref:`mooring_corrections`
+;
+; Used by :ref:`tropflux.sh`
+;
 ; :ref:`project_profile.sh`
-;
-; :ref:`mooring_corrections`
 ;
 ; :func:`interp_erai_sst`
@@ -74 +79 @@
 ; ::
 ;
-;  IDL> sst_correction_ncdf
+;  IDL> yyyymmddb = 20000101L
+;  IDL> yyyymmdde = 20001231L
+;  IDL> result = sst_correction_ncdf(yyyymmddb, yyyymmdde)
+;  IDL> print, result
 ;
 ; TODO
@@ -80 +88 @@
 ;
 ; make it work on loholt1 idl8:
-; reach end whtiout error but with bad values (9.96921e+36 on time and sst, nb timestep  5716
+; reach end whithout error but with bad values (9.96921e+36 on time and sst, nb timestep  5716
 ;
 ; see commands::
@@ -156 +164 @@
 ; $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
+;   * get rid of timegen
+;
 ; - fplod 20110808T124236Z cratos (Linux)
 ;
@@ -175 +191 @@
 ;
 ;-
-pro sst_correction_ncdf
+function sst_correction_ncdf $
+         , yyyymmddb $
+         , yyyymmdde
+;
+;++compile_opt idl2, strictarrsubs, logical_predicate
 ;
 @cm_4cal
@@ -183 +203 @@
 @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_od_env OF
@@ -188 +222 @@
          msg = 'eee : ${PROJECT_OD} is not defined'
          ras = report(msg)
-       STOP
+       return, result
        END
   ELSE: BEGIN
@@ -203 +237 @@
    msg = 'eee : the directory' + iodirout  + ' is not accessible.'
    ras = report(msg)
-   STOP
+   return, result
 ENDIF
 ;
@@ -210 +244 @@
     msg = 'eee : the directory' + iodirout  + ' was not found.'
     ras = report(msg)
-    STOP
-ENDIF
-;
-da1=19880101
-da2=20091231
+    return, result
+ENDIF
 ;
 ; build data filename
-filename='erai_sst_19890101_20091231_oafluxgrid.nc'
+filename='erai_sst_' +  string(yyyymmddb,format='(I8.8)') + '_' + string(yyyymmdde,format='(I8.8)') + '_oafluxgrid.nc'
 ;
 ; check if this file exists
@@ -226 +257 @@
    msg = 'eee : the file ' + fullfilename + ' was not found.'
    ras = report(msg)
-   STOP
+   return, result
 ENDIF
 ;
 ; build output filename
-filename_out = 'TropFlux_sst_19890101_20091231.nc'
+filename_out = 'TropFlux_sst_' +  string(yyyymmddb,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
 ;
 initncdf, fullfilename
-sst=read_ncdf('sst',da1,da2,file=fullfilename,/nostr)
+sst=read_ncdf('sst',yyyymmddb-.5d,yyyymmdde,file=fullfilename,/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, 'sst in sst_correction_ncdf first date ', cda0
+print, 'sst in sst_correction_ncdf last date ' , cda1
+;
 sst=sst-273.15
 help, sst
@@ -250 +290 @@
 caldat, time,mon,day,yea
 ;
-; debug to understand some time value 9.9692100e+36 on idl 6 lohloht1
-print, time[7080:7090]
+;++ debug to understand some time value 9.9692100e+36 on idl 6 lohloht1
+; print, time[7080:7090] when working on [19890101,19891231]
 ;
 sst_m=sst*0.
 ;
 for jt=0,jpt-1 do begin
-  jtt=(time(jt)-julday(1,1,yea(jt))) < 364
-  t=reform(sst_mean(*,*))
-  sst_m(*,*,jt)=t
+  jtt=(time[jt]-julday(1,1,yea[jt])) < 364
+  t=reform(sst_mean[*,*])
+  sst_m[*,*,jt]=t
 endfor
 help, sst_m
@@ -278 +318 @@
 ;
 ;writing field
-lat=reform(gphit(0,0:jpj-1))
-lon=reform(glamt(0:jpi-1,0))
-time=timegen(7670, start=julday(1,1,1989,0), units='days')
-jpt=n_elements(time)
-;
-cda0=string(jul2date(time(0)),format='(i8.8)')
-cda1=string(jul2date(time(jpt-1)),format='(i8.8)')
-;
-time=time-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
@@ -296 +328 @@
 sst_attr={units:'degK',missing_value:1.e20,long_name:'Sea Surface Temperature',short_name:'sst',axis:'TYX'}
 ;
-ncfields = 'sst[longitude,latitude,time]=sst_new:sst_attr; ' $
+ncfields = 'sst[longitude,latitude,*time]=sst_new:sst_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