Changeset 544 for trunk

Timestamp:

04/30/12 15:35:40 (12 years ago)

Author:

pinsard

Message:

replace pro by function

Location:

trunk/src

Files:

• cresamsu.pro (modified) (17 diffs)
• cresamsu.sh (modified) (6 diffs)
• idl_amsu_netcdf.pro (modified) (10 diffs)

trunk/src/cresamsu.pro

@@ -1 +1 @@
 ; docformat = 'rst'
 ;+
-; .. _cresamsu.pro:
 ;
 ; ============
@@ -7 +6 @@
 ; ============
 ;
+; .. function: cresamsu(numch, yyyyb, mmb, ddb, yyyye, mme, dde, lonmin, lonmax, latmin, latmax, temp, rtemp, rhdeg)
+;
 ; DESCRIPTION
 ; ===========
 ;
 ; programme d'interpolation avec algorithme de Cressmann
+;
+; grille de sortie en long / lat
+; recoit en entree les jours de l'annee jdeb et jfin correspondant au debut et la fin du mois
 ;
 ; adaptation aux donnees Tb AMSU lues avec la nouvelle chaîne de lecture
@@ -64 +68 @@
 ;    rtemp = 0.5
 ;    rhdeg = 1.
-;    cresamsu, numch, yyyyb, mmb, ddb $
+;    result = cresamsu(numch, yyyyb, mmb, ddb $
 ;            , yyyye, mme, dde $
 ;            , lonmin, lonmax, latmin, latmax $
-;            , temp, rtemp, rhdeg
+;            , temp, rtemp, rhdeg)
 ;
 ; SEE ALSO
@@ -113 +117 @@
 ; - fplod 20120430
 ;
+;   * pro -> function
+;   * idl_amsu_netcdf is a function
 ;   * add digraph
 ;
@@ -165 +171 @@
 ;-
 
-pro cresamsu $
+function cresamsu $
     , numch $
     , yyyyb $
@@ -177 +183 @@
     , latmin $
     , latmax $
-    , temp $ 
+    , temp $
     , rtemp $
     , rhdeg
-
-; grille de sortie en long / lat
-; recoit en entree les jours de l'annee jdeb et jfin correspondant au debut et la fin du mois
 
 compile_opt idl2, strictarrsubs
@@ -193 +196 @@
 if key_performance EQ 1 THEN BEGIN
     time1 = SYSTIME(1)
+ENDIF
+;
+; Return to caller if errors
+ON_ERROR, 2
+result = -1
+;
+usage = 'result = cresamsu(numch, yyyyb, mmb, ddb, yyyye, mme, dde, lonmin, lonmax, latmin, latmax, temp, rtemp, rhdeg)'
+;
+nparam = N_PARAMS()
+IF (nparam NE 14) THEN BEGIN
+    ras = report(['Incorrect number of arguments.' $
+          + '!C' $
+          + 'Usage : ' + usage])
+    return, result
 ENDIF
 ;
@@ -223 +240 @@
 ;rtemp=0.5 ;en jours rayon de Cressmann (0.25, 0.5, 1, 2,... - nb entiers!)
 rtemphor=rtemp*24. ; en heures
-print,'rayon temporel en heures',rtemphor
+msg = report(['iii : ' + routine + ' : rayon temporel en heures' + string(rtemphor)])
 ; valeurs utiles et conversions degres / radians
 vbidon=-999.
@@ -248 +265 @@
 hrdeb=jdeb*24
 hrfin=jfin*24
-print,'debut et fin', jdeb,jfin
+msg = report(['iii : ' + routine + ' : debut et fin = ' + string(jdeb) + ' ' + string(jfin)])
 
 ; grille des donnees en sortie
@@ -255 +272 @@
 la1=latmin+rhdeg
 la2=latmax-rhdeg
-print,"bornes de la grille de sortie",lo1,lo2,la1,la2,jdeb,jfin
+msg = report(['iii : ' + routine + ' : bornes de la grille de sortie = ' + string(lo1) + ' ' + string(lo2)+ ' ' + string(la1) + ' ' + string(la2) + ' ' + string(jdeb) + ' ' + string(jfin)])
 kmax=fix((lo2-lo1)/pash) ; pour valeurs de 0 a kmax
 nblon=kmax+1
@@ -262 +279 @@
 jmax=fix((hrfin-hrdeb)/pasthor) ; valeurs de 0 a jmax
 nbjour=jmax+1
-print,'nb pas de temps',nbjour, ' nb lat',nblat,' nblon',nblon
+msg = report(['iii : ' + routine + ' : nb pas de temps = ' + string(nbjour)])
+msg = report(['iii : ' + routine + ' : nb lat = ' + string(nblat)])
+msg = report(['iii : ' + routine + ' : nb lon = ' + string(nblon)])
 
 ;____________________________________
@@ -276 +295 @@
 la2=max(yylat)
 hrfin=max(jjours)*24.
-print, 'pas de temps du fichier ncdf en jours decimaux',jjours
-print,'derniers points de la grille',max(xxlon),max(yylat),hrfin
+msg = report(['iii : ' + routine + ' : pas de temps du fichier ncdf en jours decimaux= ' + string(jjours)])
+msg = report(['iii : ' + routine + ' : derniers points de la grille (lon) = ' + string(max(xxlon))])
+msg = report(['iii : ' + routine + ' : derniers points de la grille (lat) = ' + string(max(yylat))])
+msg = report(['iii : ' + routine + ' : derniers points de la grille (temps) = ' + string(max(hrfin))])
 ;-----------------------------------
 t=indgen(nbjour)*pasthor+hrdeb ; en heures
-print,'t',t
+msg = report(['iii : ' + routine + ' : t = ' + string(t)])
 
 ; initialisation des tableaux de sortie (s valeurs, z poids, kont nb points)
@@ -312 +333 @@
       if yyyy eq yyyye then mmye=mme
    endif
-   print,"traitement annee ",yyyy,'mois ',mmyb,'a ',mmye
+   msg = report(['iii : ' + routine + ' : traitement annee ' + string(yyyy) + ' '  + string(mmyb) + ' a ' +  string(mmye)])
    for mm=mmyb,mmye do begin
       if (mme ne mmb) then begin
@@ -320 +341 @@
          if mm eq mme then ddme=dde
      endif
-      print,"mois ",mm,"jours ",ddmb,"a ",ddme
+      msg = report(['iii : ' + routine + ' : mois' + string(mm) + ' ' + string(ddmb) + ' a ' +  string(ddme)])
       for dd=ddmb,ddme do begin
-         print, 'iii : traitement du jour ',yyyy,mm,dd
+         msg = report(['iii : ' + routine + ' : traitement du jour ' + string(yyyy) + string(mm) + string(dd)])
          ; lecture du fichier journalier
          result=file_amsu_t2_to_mem( yyyy, mm, dd, numch $
@@ -405 +426 @@
          goto, nextday
 nofile:
-    print, 'www : no data to read for this day'
+    msg = report(['www : ' + routine + ' : no data to read for this day'])
     goto, nextday
 
@@ -421 +442 @@
 if nbfile GT 0 THEN BEGIN
     good=where (kont1 ge 1,nb)
-    print,'points valides',nb
+    msg = report(['iii : ' + routine + ' : points valides = ' + string(nb)])
     if (nb ne 0) then tb1fin[good]=stb1[good]/z1[good]
     bad=where (kont1 eq 0,nbad)
-    print,'bad',nbad
+    msg = report(['iii : ' + routine + ' : nb bad = ' + string(nbad)])
     if (nbad ne 0) then tb1fin[bad]=!values.f_Nan
                                     ; print,tb1fin
-    print,'extremes du compteur',min(kont1),max(kont1)
-    
+    msg = report(['iii : ' + routine + ' : extremes du compteur = ' + string(min(kont1)) + ' ' + string(max(kont1))])
+
     ;toto=reform(tb1fin[*,*,0])
                                 ;plt,xxlon,yylat,toto
-    idl_amsu_netcdf, numch, temp,rtemp,rhdeg, tb1fin, yylat, xxlon, jjours
+    result = idl_amsu_netcdf(numch, temp,rtemp,rhdeg, tb1fin, yylat, xxlon, jjours)
+    result_type=size(result,/type)
+    IF (result_type EQ 3) THEN BEGIN
+       IF (result NE 0) THEN BEGIN
+           msg = report(['eee : ' + routine + ' : pb idl_amsu_netcdf'])
+           ;return, result
+           STOP
+       ENDIF
+    ENDIF
+
 ENDIF  ELSE BEGIN
-    print, 'www : no files at all'
+    msg = report(['www : ' + routine + 'no files at all'])
     goto, realend
 ENDELSE
@@ -439 +469 @@
 realend:
     IF key_performance EQ 1 THEN BEGIN
-         PRINT, 'ppp : durée totale cresamsu', SYSTIME(1)-time1, format='(a, 1x, F12.6)'
+         msg = report(['ppp : ' + routine $
+         + ' : durée totale = ' $
+         + string(SYSTIME(1)-time1, format='(a, 1x, F12.6)')])
     ENDIF
 
-    print,'fin cresamsu'
-
+msg = report(['iii : ' + routine + ': fin'])
+
+result = 0
+return, result
 end

trunk/src/cresamsu.sh

@@ -40 +40 @@
 # :file:`${PROJECT_ID}/AMSU/{numch}{temp}rt{rtemp}rh{rhdeg}_{yyyymmdd}_{yyyymmdd}_{geomin}_{geomax}_03150e4150n.nc`
 #
-# :ref:`cresamsu` is launched here using ${IDL_CMD} command
+# :func:`cresamsu` is launched here using ${IDL_CMD} command
 # (see :ref:`varamma_profile.sh` to know how to set this environnement variable).
 #
@@ -103 +103 @@
 #
 # Use :
-# :ref:`cresamsu.pro`
-# :ref:`geolocation_to_string_sh.sh`
+# :func:`cresamsu`
 #
 # .. todo::
@@ -132 +131 @@
 # - fplod 20120430
 # 
+#   * cresamsu is now a function
 #   * creation
 #
@@ -371 +371 @@
 result = -1
 ;
-cresamsu, '${numch}', ${yyyyb}, ${mmb}, ${ddb} $
+result_cresamsu = cresamsu('${numch}', ${yyyyb}, ${mmb}, ${ddb} $
         , ${yyyye}, ${mme}, ${dde} $
         , ${lonmin}, ${lonmax}, ${latmin}, ${latmax} $
-        , '${temp}' , ${rtemp} , ${rhdeg}
+        , '${temp}' , ${rtemp} , ${rhdeg})
+result_type=size(result_cresamsu,/type)
+result_type=size(result_cresamsu,/type)
+IF (result_type EQ 3) THEN BEGIN
+   IF (result_cresamsu NE 0) THEN BEGIN
+       print, 'eee : pb cresamsu'
+       return, result_cresamsu
+   ENDIF
+ENDIF
 result = 0
 ;
@@ -409 +417 @@
 Profiler
 result = cresamsu_${$}()
+print, 'result : ', result
 print, 'ppp : profiler report begin'
 Profiler, /REPORT
@@ -443 +452 @@
 #
 # end
-set
+#set
 exit

trunk/src/idl_amsu_netcdf.pro

@@ -1 @@
-;
 ;+
-;
-; .. _idl_amsu_netcdf.pro:
 ;
 ; ===================
 ; idl_amsu_netcdf.pro
 ; ===================
+;
+; .. function:: idl_amsu_netcdf(numch, temp, rtemp, rhdeg, datain, lats, lons, timesin)
 ;
 ; DESCRIPTION
@@ -27 +26 @@
 ;           lats [shape=tab, label="latitude 1d array"]
 ;           timesin [shape=tab, label="time 1d array"]
-;
-;           amsu_t5 [shape=ellipse,fontname=Courier,label="${PROJECT_OD}/AMSU/numch_yyyymmdd_yyyymmdd_geomin_geomax.nc"];
+;           temp [shape=tab, label="temp"]
+;           rtemp [shape=tab, label="rtemp"]
+;           rhdeg [shape=tab, label="rhdeg"]
+;
+;           amsu_t5 [shape=ellipse,
+;               fontname=Courier,
+;               label="${PROJECT_OD}/AMSU/numch_temprtrtemprhrhdeg_yyyymmdd_yyyymmdd_geomin_geomax.nc"];
 ;
 ;           idl_amsu_netcdf [shape=box,
@@ -47 +51 @@
 ;
 ;    numch = 'a5'
+;    temp = 'm'
+;    rtemp = 0.5
+;    rhdeg = 1.
 ;    lons = findgen(10) - 10
 ;    lats = findgen(11) + 20
 ;    timesin = indgen(12) + julday(8,1,2006L)
 ;    datain = findgen(size(lons,/dim), size(lats,/dim), size(timesin,/dim))
-;    idl_amsu_netcdf, numch , datain, lats, lons, timesin
+;    result = idl_amsu_netcdf(numch, temp, rtemp, rhdeg, datain, lats, lons, timesin)
 ;
 ; TIPS
@@ -65 +72 @@
 ; :ref:`data_amsu`
 ;
-; Called by :ref:`cresamsu_cdf.pro`
+; Called by :func:`cresamsu`
 ;
 ; use :func:`geolocation_to_string_idl`, :func:`jul2date <saxo:jul2date>`
@@ -84 +91 @@
 ; coding rules
 ;
-; replace pro by function
-;
 ; check time in netcdf
 ;
@@ -101 +106 @@
 ; - fplod 20120430
 ;
+;   * add temp, rtemp, rhdeg in example
+;   * pro -> function
 ;   * time unlimited
 ;   * time origine is a ttribute of time not of tb
@@ -156 +163 @@
 ;
 ;-
-pro idl_amsu_netcdf, numch, temp, rtemp, rhdeg, datain, lats, lons, timesin
+function idl_amsu_netcdf, numch, temp, rtemp, rhdeg, datain, lats, lons, timesin
 ;
 compile_opt idl2, strictarrsubs
 ;
 @cm_project
+;
+s = size(SCOPE_TRACEBACK(/STRUCTURE),/DIMENSION)
+routine = (SCOPE_TRACEBACK(/STRUCTURE))[s-1].Routine
+;
+key_performance=0
+if key_performance EQ 1 THEN BEGIN
+    time1 = SYSTIME(1)
+ENDIF
+;
+; Return to caller if errors
+ON_ERROR, 2
+;
+result = -1
+;
+usage = 'result = idl_amsu_netcdf(numch, temp, rtemp, rhdeg, datain, lats, lons, timesin)'
+nparam = N_PARAMS()
+IF (nparam NE 8) THEN BEGIN
+    ras = report(['Incorrect number of arguments.' $
+          + '!C' $
+          + 'Usage : ' + usage])
+    return, result
+ENDIF
 ;
 nblat = size(lats,/dim)
@@ -205 +234 @@
    moyenne_tb[ind]=-9999.
 endif
-print,"nb valeurs manquantes", nnbad
+msg = report(['iii : ' + routine + ' : nb valeurs manquantes = ' + string(nnbad)])
 ;
 ; ++ test si toutes les valeurs sont des valeurs manquantes/aberantes
@@ -221 +250 @@
 ENDIF
 ;
-print, 'ouverture pour ecriture de ', cdfout
+msg = report(['iii : ' + routine + ' : ouverture pour ecriture de ' + cdfout])
 id = ncdf_create(cdfout,/clobber)
 ncdf_control, id, /nofill
@@ -274 +303 @@
 ncdf_close, id
 ;
+result = 0
+return, result
+;
 end