Changeset 1553 in lmdz_wrf for trunk/tools/drawing.py

Timestamp:

May 2, 2017, 7:07:24 PM (8 years ago)

Author:

lfita

Message:

Adding `draw_time_lag': Function to plot a time-lag figure with multiple sources (x, previous values; y, future values)

File:

• trunk/tools/drawing.py (modified) (9 diffs)

trunk/tools/drawing.py

@@ -49 +49 @@
 ## e.g. # drawing.py -o draw_bar_line -f 'Forcing_rainstats_OKstomate_CRUNCEP_spinup_SESA_norm_meanstd_stat2.nc;time_counter,0@12@1;time_counter;rainnorm;bar:Forcing_rainstats_OKstomate_CRUNCEP_spinup_SESA_norm_meanstd_stat2.nc;time_counter,12@24@1;time_counter;rainnorm;bar:Forcing_rainstats_OKstomate_CRUNCEP_spinup_SACZ_norm_meanstd_stat2.nc;time_counter,0@12@1;time_counter;rainnorm;line:Forcing_rainstats_OKstomate_CRUNCEP_spinup_SACZ_norm_meanstd_stat2.nc;time_counter,12@24@1;time_counter;rainnorm;line' -S 'Stringlist,%s,January@Feburary@March@April@May@June@July@August@September@October@November@December@Jan@Feb@Mar@Apr@May@Jun@Jul@Aug@Sept@Oct@Nov@Dec,25,pretty,auto,auto,auto:time!since!1958-01-01:pr:x:-4.,4.:seconds:1:$SESA_{1958}$,$SESA_{1959}$,$SACZ_{1958}$,$SACZ_{1959}$:#AA0000,#0000AA:1000000.:#00AA00,#AAAA00:-.:,:2.:2.:all:normalized!evolution!of!precipitation!with!CRU-NCEP!forcing:0|10:png:bar-line_rain_CRU-NCEP_norm:yes'
 ## e.g. # drawing.py -o draw_bar_line_time -f 'Forcing_rainstats_OKstomate_SESA_DJFmean_norm_meanstd_stat2.nc;time_centered,-1;time_centered;rainnorm;bar:Forcing_rainstats_OKstomate_SACZ_DJFmean_norm_meanstd_stat2.nc;time_centered,-1;time_centered;rainnorm;bar:DiPolo_evapstats_OKstomate_SESA_DJFmean_stat2.nc;time_centered,-1;time_centered;evap_stats;line:DiPolo_evapnustats_OKstomate_SESA_DJFmean_stat2.nc;time_centered,-1;time_centered;evapnu_stats;line:DiPolo_evspsblvegstats_OKstomate_SESA_DJFmean_stat2.nc;time_centered,-1;time_centered;evspsblveg_stats;line:DiPolo_transpirstats_OKstomate_SESA_DJFmean_stat2.nc;time_centered,-1;time_centered;transpir_stats;line:DiPolo_evapstats_OKstomate_SACZ_DJFmean_stat2.nc;time_centered,-1;time_centered;evap_stats;line:DiPolo_evapnustats_OKstomate_SACZ_DJFmean_stat2.nc;time_centered,-1;time_centered;evapnu_stats;line:DiPolo_evspsblvegstats_OKstomate_SACZ_DJFmean_stat2.nc;time_centered,-1;time_centered;evspsblveg_stats;line:DiPolo_transpirstats_OKstomate_SACZ_DJFmean_stat2.nc;time_centered,-1;time_centered;transpir_stats;line' -S 'auto;pr;y;None;1;year|seconds!since!1958-01-01!00:00:00|exct,5,y|%Y;SESA,SACZ,SESA!evap,evapnu,evspblveg,transpir,SACZ!evap,None,None,None;#AA0000,#0000AA;10000000.;#AAAA00,#00AAAA,#AA00AA,#AAAAAA,#AAAA00,#00AAAA,#AA00AA,#AAAAAA;-,-,-,-,--,--,--,--;,;2.;2.;all;normalized!evolution!of!DJFmean!with!WFD3!forcing;0|10;png;bar_time_rain_CRU-NCEP_DJFmean_norm;yes'
+## e.g. # drawing.py -o draw_time_lag -f 'Forcing_rainstats_OKstomate_SESA_norm_meanstd_stat2.nc;time_centered,-1;time_counter;rainnorm%DiPolo_evapstats_SESA_norm_meanstd_OKstomate.nc;time_counter,-1|stats,2;time_counter;evapnorm:Forcing_rainstats_OKstomate_SACZ_norm_meanstd_stat2.nc;time_centered,-1;time_counter;rainnorm%DiPolo_evapstats_SACZ_norm_meanstd_OKstomate.nc;time_counter,-1|stats,2;time_counter;evapnorm' -S 'auto;centered;pr;1;evap;1;-5,5;-2,2;year|seconds!since!1958-01-01!00:00:00|exct,5,y|%Y;SESA,SACZ;simplepts,1,#AA0000@#0000AA,x,2.;1-month!time-lag!at!SACZ!between!pr!&!evap!normalized!by!mean/stddev;0|12;png;mon1_timelag_pr-evap_SACZ;yes'
+
 #######
 # create_movie: Function to create a movie assuming ImageMagick installed!
@@ -72 +74 @@
 # draw_points: Function to plot a series of points
 # draw_points_lonlat: Function to plot a series of lon/lat points
-# draw_ptZvals: Function to plot a given list of points by their Z value and a colorbar 
+# draw_ptZvals: Function to plot a given list of points by their Z value and a colorbar
+# draw_time_lag: Function to plot a time-lag figure with multiple sources (x, previous values; y, future values)
 # draw_timeSeries: Function to draw a time-series
 # draw_topo_geogrid: plotting geo_em.d[nn].nc topography from WPS files
@@ -102 +105 @@
   'draw_points', 'draw_points_lonlat',                                               \
   'draw_ptZvals', 'draw_river_desc', 'draw_subbasin', 'draw_Taylor',                 \
-  'draw_timeSeries', 'draw_topo_geogrid',                                            \
+  'draw_time_lag', 'draw_timeSeries', 'draw_topo_geogrid',                           \
   'draw_topo_geogrid_boxes', 'draw_trajectories', 'draw_vals_trajectories',          \
   'draw_vectors',  'draw_vertical_levels', 'list_graphics', 'draw_WindRose',         \
@@ -6594 +6597 @@
         [yunits]: units of the y-label
         [aval]: which acis should be used for the values ('x' or 'y')
-        [rangevals]: Range of the axis with the values (singel 'None' for 'auto','auto')
+        [rangevals]: Range of the axis with the values (single 'None' for 'auto','auto')
          [vmin],[vmax]: minimum and maximum values
            'auto': the computed minimumm or maximum of the values  
@@ -6810 +6813 @@
         [yunits]: units of the y-label
         [aval]: which acis should be used for the values ('x' or 'y')
-        [rangevals]: Range of the axis with the values (singel 'None' for 'auto','auto')
+        [rangevals]: Range of the axis with the values (single 'None' for 'auto','auto')
          [vmin],[vmax]: minimum and maximum values
            'auto': the computed minimumm or maximum of the values  
@@ -7023 +7026 @@
         [yunits]: units of the y-label
         [aval]: which acis should be used for the values ('x' or 'y')
-        [rangevals]: Range of the axis with the values (singel 'None' for 'auto','auto')
+        [rangevals]: Range of the axis with the values (single 'None' for 'auto','auto')
          [vmin],[vmax]: minimum and maximum values
            'auto': the computed minimumm or maximum of the values  
@@ -7249 +7252 @@
     return
 
+def draw_time_lag(ncfile, values):
+    """ Function to plot a time-lag figure with multiple sources (x, previous values; y, future values)
+      ncfile = ':' list of couples ('%' formed) [prefilen];[predslice];[pretvarn];[prevarn]%[futfilen];
+          [futdslice];[futtvarn];[futvarn]
+        'pre': values to act as previous values
+        'fut': values to act as future values
+
+        [filen]: name of the file
+        [dimslice]: '|' list of [dimn],[dimrange]
+          [dimn]: name of the dimension
+          [dimrange]: range for the slice
+            * [integer]: which value of the dimension
+            * -1: all along the dimension
+            * -9: last value of the dimension
+            * [beg]@[end]@[inc] slice from [beg] to [end] every [inc]
+            * NOTE, no dim name all the dimension size
+        [tvarn]: name of the variable time
+        [yvarn]: name of the variable to use for the values
+      values = [dimxyfmt];[axeskind];[preaxislab];[preunits];[futaxislab];[futunits];[prerangevals];
+          [futrangevals];[timevals];[labels];[figlagkind];[graphtit];[legvalues];[kindfig];[fign];[close]
+        [dimxyfmt]=[dxs],[dxf],[Ndx],[ordx],[dys],[dyf],[Ndy],[ordy]: format of the values at each 
+            axis (or single 'auto' for 'auto','auto')
+          [dxs]: style of x-axis ('auto' for 'pretty')
+            'Nfix', values computed at even 'Ndx'
+            'Stringlist', a given list of strings
+            'Vfix', values computed at even 'Ndx' increments
+            'pretty', values computed following aprox. 'Ndx' at 'pretty' intervals (2.,2.5,4,5,10)
+          [dxf]: format of the labels at the x-axis
+          [Ndx]: Number of ticks at the x-axis (for 'Stringlist', '@' list of labels)
+          [ordx]: angle of orientation of ticks at the x-axis ('auto' for horizontal)
+          [dys]: style of y-axis ('auto' for 'pretty')
+          [dyf]: format of the labels at the y-axis
+          [Ndy]: Number of ticks at the y-axis
+          [ordy]: angle of orientation of ticks at the y-axis ('auto' for horizontal)
+        [axeskind]: type of axes to be plotted
+          'centered': crossed at 0,0 at the center of the figure
+          'box': around the figure
+        [preaxislab]: Label for the future-axis ('!' for spaces)
+        [preunits]: units of the future-label
+        [futaxislab]: Label for the future-axis ('!' for spaces)
+        [futunits]: units of the future-label
+        [prerangevals]: Range of the previous axis with the values (single 'None' for 'auto','auto')
+         [vmin],[vmax]: minimum and maximum values
+           'auto': the computed minimumm or maximum of the values  
+        [futrangevals]: Range of the future axis with the values (single 'None' for 'auto','auto')
+         [vmin],[vmax]: minimum and maximum values
+           'auto': the computed minimumm or maximum of the values  
+        [timevals]: [timen]|[units]|[kind]|[tfmt] time labels characteristics
+          [timen]; name of the time variable
+          [units]; units string according to CF conventions ([tunits] since 
+            [YYYY]-[MM]-[DD] [[HH]:[MI]:[SS]], '!' for spaces)
+          [kind]; kind of output
+            'Nval': according to a given number of values as 'Nval',[Nval]
+            'exct': according to an exact time unit as 'exct',[tunit]; 
+              tunit= [Nunits],[tu]; [tu]= 'c': centuries, 'y': year, 'm': month,
+               'w': week, 'd': day, 'h': hour, 'i': minute, 's': second, 
+               'l': milisecond
+          [tfmt]; desired format
+        [labels]: ',' list of labels for the legend ('None' for no-labels, '!' for spaces)
+        [figlagkind]=[kindname],[valueskind] kind of time-lag plot
+          'repeatPeriod',[Nlag],[period],[colorbar],[cbarfmt],[cbaror],[ltype],[lwidth],[mtype],[msize]: 
+              time-lag for a given repeating sub-period, Line-conected points following a colorbar and time-values
+            [Nlag]: number of time steps as lag
+            [period]: period to be repeated allover the time-data
+            [colorbar]: name of the color bar to use ('auto' for rainbow)
+            [cbarfmt]: format of the numbers in the colorbar
+            [cbaror]: orientation of the colorbar ('auto' for vertical)
+            [ltype]: type of the lines (single value for the same, or 'auto')
+            [lsize]: width of the lines (single value for the same, or 'auto')
+            [mtype]: type of the markers (single value for the same, or 'auto')
+            [msize]: size of the markers (single value for the same, or 'auto')
+          'shadTline',[Nlag],[colorbar],[cbarfmt],[cbaror],[ltype],[lwidth],[mtype],[msize]: Line-conected 
+              points following a colorbar and time-values
+            [Nlag]: number of time steps as lag
+            [colorbar]: name of the color bar to use ('auto' for rainbow)
+            [cbarfmt]: format of the numbers in the colorbar
+            [cbaror]: orientation of the colorbar ('auto' for vertical)
+            [ltype]: type of the lines (single value for the same, or 'auto')
+            [lsize]: width of the lines (single value for the same, or 'auto')
+            [mtype]: type of the markers (single value for the same, or 'auto')
+            [msize]: size of the markers (single value for the same, or 'auto')
+          'simplepts',[Nlag],[col],[type],[size]: Simple points assuming that values have all the same times
+            [Nlag]: number of time steps as lag
+            [col]: '@' list of colors of the points (single value for the same, or 'auto')
+            [type]:types of the points (single value for the same, or 'auto')
+            [size]: sizes of the points kind of lag-time figure (single value for the same, or 'auto')
+      labels= list of labels for legend (None for no legend, and 'None' for no specific label)
+        [graphtit]: title of the figure '!' for spaces
+        [legvalues]=[locleg]|[fontsize]: 
+          [locleg]: location of the legend (0, autmoatic)
+            1: 'upper right', 2: 'upper left', 3: 'lower left', 4: 'lower right',
+            5: 'right', 6: 'center left', 7: 'center right', 8: 'lower center',
+            9: 'upper center', 10: 'center'
+          [fontsize]: font size for the legend (auto for 12)
+        [kindfig]: kind of output figure (png, pdf, ps)
+        [fign]: name of the figure (without extension)
+        [close]: whether figure should be close or not
+    """
+    fname = 'draw_time_lag'
+
+    if values == 'h':
+        print fname + '____________________________________________________________'
+        print draw_time_lag.__doc__
+        quit()
+
+    expectargs = '[dimxyfmt];[axeskind];[preaxislab];[preunits];[futaxislab];' +     \
+      '[futunits];[prerangevals];[futrangevals];[timevals];[labels];[figlagkind];' + \
+      '[graphtit];[legvalues];[kindfig];[fign];[close]'
+    drw.check_arguments(fname,values,expectargs,';')
+
+    dimxyfmt = values.split(';')[0]
+    axeskind = values.split(';')[1]
+    preaxislab = values.split(';')[2].replace('!',' ')
+    preunits = values.split(';')[3]
+    futaxislab = values.split(';')[4].replace('!',' ')
+    futunits = values.split(';')[5]
+    prerangevals = values.split(';')[6]
+    futrangevals = values.split(';')[7]
+    timevals = values.split(';')[8]
+    labels = gen.str_list(values.split(';')[9].replace('!', ' '), ',')
+    figlagkind = values.split(';')[10]
+    graphtit = values.split(';')[11].replace('!',' ')
+    legvalues = values.split(';')[12]
+    kindfig = values.split(';')[13]
+    fign = values.split(';')[14]
+    close = gen.Str_Bool(values.split(';')[15])
+
+    # files and values
+    filedvs = ncfile.split(':')
+    timevalues = []
+    prevalues = []
+    futvalues = []
+
+    # time-values
+    expectargs = '[timen]|[units]|[kind]|[tfmt]'
+    drw.check_arguments('timevals: '+fname,timevals,expectargs,'|')
+
+    timen = timevals.split('|')[0].replace('!',' ')
+    timeunit = timevals.split('|')[1].replace('!',' ')
+    timekind = timevals.split('|')[2]
+    timefmt = timevals.split('|')[3]
+
+    preminval = gen.fillValue
+    premaxval = -gen.fillValue
+    futminval = gen.fillValue
+    futmaxval = -gen.fillValue
+    mintval = gen.fillValue
+    maxtval = -gen.fillValue
+
+    for fdvprefut in filedvs:
+        prefutdv = fdvprefut.split('%')
+        ifile=0
+        for fdv in prefutdv:
+            filen = fdv.split(';')[0]
+            dimrange = fdv.split(';')[1]
+            tvarn = fdv.split(';')[2]
+            yvarn = fdv.split(';')[3]
+            futfdv = fdvprefut.split('%')[1]
+
+            if not os.path.isfile(filen):
+                print errormsg
+                print '  ' + fname + ': file "' + filen + '" does not exist !!'
+                quit(-1)
+
+            onc = NetCDFFile(filen, 'r')
+            if not onc.variables.has_key(tvarn):
+                print errormsg
+                print '  ' +fname+ ': file "' +filen+ "' does not have variable '" + \
+                  tvarn + "' for the time-values !!"
+                print '    available ones:', onc.variables.keys()
+                onc.close()
+                quit(-1)
+            if not onc.variables.has_key(yvarn):
+                print errormsg
+                print '  ' +fname+ ': file "' +filen+ "' does not have variable '" + \
+                  yvarn + "' for the y-values !!"
+                print '    available ones:', onc.variables.keys()
+                onc.close()
+                quit(-1)
+
+            otvar = onc.variables[tvarn]
+            oyvar = onc.variables[yvarn]
+            tvs, tdims = ncvar.slice_variable(otvar, dimrange.replace(',',':'))
+            yvs, ydims = ncvar.slice_variable(oyvar, dimrange.replace(',',':'))
+            tunitsvar = otvar.units
+
+            if len(tvs.shape) != 1:
+                print errormsg
+                print '  ' +fname+ ': provided slice:', dimrange, "for variable '" + \
+                  tvarn + "' does not provide a rank-1 value !!"
+                print '    resultant shape:', tvs.shape, 'dimensions:',tdims,'fix it!!'
+                quit(-1)
+            if len(yvs.shape) != 1:
+                print errormsg
+                print '  ' +fname+ ': provided slice:', dimrange, "for variable '" + \
+                  yvarn + "' does not provide a rank-1 value !!"
+                print '    resultant shape:',yvs.shape, 'dimensions:',ydims,'fix it!!'
+                quit(-1)
+    
+            uvd = timeunit
+            tunitsec = timeunit.split(' ')
+            if len(tunitsec) == 4:
+                refdate = tunitsec[2][0:4]+tunitsec[2][5:7]+tunitsec[2][8:10] +      \
+                  tunitsec[3][0:2] + tunitsec[3][3:5] + tunitsec[3][6:8]
+            else:
+                refdate = tunitsec[2][0:4]+tunitsec[2][5:7]+tunitsec[2][8:10] +      \
+                  '000000'
+            tunitsval = tunitsec[0]
+            # Referring all times to the same reference time!
+            reftvals = gen.coincident_CFtimes(tvs, timeunit, tunitsvar)
+      
+            onc.close()
+
+            reftn = reftvals.min()
+            reftx = reftvals.max()
+            if reftn < mintval: mintval = reftn
+            if reftx > maxtval: maxtval = reftx
+
+            if ifile == 0:
+                timevalues.append(reftvals)
+                prevalues.append(yvs)
+                pren = yvs.min()
+                prex = yvs.max()
+                if pren < preminval: preminval = pren
+                if prex > premaxval: premaxval = prex
+            else:
+                timevalues.append(reftvals)
+                futvalues.append(yvs)
+                futn = yvs.min()
+                futx = yvs.max()
+                if futn < futminval: futminval = futn
+                if futx > futmaxval: futmaxval = futx
+            ifile = ifile + 1
+
+    # Times
+    if figlagkind[0:12] == 'repeatPeriod':
+        per=int(figlagkind.split(',')[2])
+        dtvals = (maxtval - mintval)/10/per
+    else:
+        dtvals = (maxtval - mintval)/10
+    dti = mintval
+    dte = maxtval
+    tvalsticks = np.arange(dti, dte+dtvals, dtvals)
+
+    dtiS = drw.datetimeStr_conversion(str(dti) + ',' + timeunit, 'cfTime',           \
+     'Y/m/d H-M-S')
+    dteS = drw.datetimeStr_conversion(str(dte) + ',' + timeunit, 'cfTime',           \
+     'Y/m/d H-M-S')
+
+    print '  ' + fname + ': plotting from: ' + dtiS + ' to ' + dteS
+
+    timepos, timelabels = drw.CFtimes_plot(tvalsticks, timeunit, timekind, timefmt)
+
+    # ranges
+    if prerangevals == 'None':
+        valmin = preminval
+        valmax = premaxval
+    else:
+        if prerangevals.split(',')[0] != 'auto': 
+            valmin = np.float(prerangevals.split(',')[0])
+        else:
+            valmin = preminval
+        if prerangevals.split(',')[1] != 'auto': 
+            valmax = np.float(prerangevals.split(',')[1])
+        else:
+            valmax = premaxval
+    prerng = [valmin, valmax]
+
+    if futrangevals == 'None':
+        valmin = futminval
+        valmax = futmaxval
+    else:
+        if futrangevals.split(',')[0] != 'auto': 
+            valmin = np.float(futrangevals.split(',')[0])
+        else:
+            valmin = futminval
+        if futrangevals.split(',')[1] != 'auto': 
+            valmax = np.float(futrangevals.split(',')[1])
+        else:
+            valmax = futmaxval
+    futrng = [valmin, valmax]
+
+    xstyl, xaxf, Nxax, xaxor, ystyl, yaxf, Nyax, yaxor = drw.format_axes(dimxyfmt,',')
+    xaxis = [xstyl, xaxf, Nxax, xaxor]
+    yaxis = [ystyl, yaxf, Nyax, yaxor]
+
+    # Legend 
+    legloc, legsiz = drw.legend_values(legvalues,'|')
+
+    drw.plot_time_lag(prevalues, futvalues, timevalues, xaxis, yaxis, axeskind,      \
+      preaxislab, futaxislab, preunits, futunits, prerng, futrng, figlagkind, labels,\
+      timen, timepos, timelabels, graphtit, legloc, legsiz, kindfig, fign, close)
+
+    return
 
 #quit()
@@ -7273 +7570 @@
   'draw_2D_shad_line', 'draw_2D_shad_line_time', 'draw_2lines', 'draw_2lines_time',  \
   'draw_bar', 'draw_bar_line', 'draw_bar_line_time', 'draw_bar_time', 'draw_lines',  \
-  'draw_lines_time', 'draw_points', 'draw_Taylor', 'draw_topo_geogrid_boxes',        \
+  'draw_lines_time', 'draw_points', 'draw_Taylor', 'draw_time_lag',                  \
+  'draw_topo_geogrid_boxes',                                                         \
   'draw_trajectories', 'draw_vals_trajectories', 'variable_values']
 
@@ -7362 +7660 @@
     elif oper == 'draw_Taylor':
         draw_Taylor(opts.ncfile, opts.values, opts.varname)
+    elif oper == 'draw_time_lag':
+        draw_time_lag(opts.ncfile, opts.values)
     elif oper == 'draw_timeSeries':
         draw_timeSeries(opts.ncfile, opts.values, opts.varname)