Changeset 1553 in lmdz_wrf for trunk

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)

Location:

trunk/tools

Files:

• documentation/plotting/gallery.html (modified) (1 diff)
• documentation/plotting/plotting.html (modified) (1 diff)
• documentation/plotting/time_lag.html (added)
• drawing.py (modified) (9 diffs)
• drawing_tools.py (modified) (4 diffs)

trunk/tools/documentation/plotting/gallery.html

@@ -36 +36 @@
       <A HREF="subbasin.html"><IMG SRC="figs/Caceres_subbasin.png" ALT="plot sub-basin from ORCHIDEE's routing" STYLE="float:left;width:200px;height:200px" TARGET="value"></IMG></A>     
       <A HREF="Taylor.html"><IMG SRC="figs/Taylor.png" ALT="Taylor diagram" STYLE="float:left;width:200px;height:200px" TARGET="value"></IMG></A>
+      <A HREF="time_lag.html"><IMG SRC="figs/mon1_timelag_pr-evap_SACZ.png" ALT="Time lag" STYLE="float:left;width:200px;height:200px" TARGET="value"></IMG></A>
+      <A HREF="time_lag.html"><IMG SRC="figs/mon1_timelag_pr-evap_SACZ_shadline.png" ALT="Time lag" STYLE="float:left;width:200px;height:200px" TARGET="value"></IMG></A>
+      <A HREF="time_lag.html"><IMG SRC="figs/mon1_timelag_pr-evap_SACZ_epeatPeriod.png" ALT="Time lag" STYLE="float:left;width:200px;height:200px" TARGET="value"></IMG></A>
       <A HREF="TimeSeries.html"><IMG SRC="figs/TimeSeries_ua.png" ALT="Time Series" STYLE="float:left;width:200px;height:200px" TARGET="value"></IMG></A>
       <A HREF="topo_geogrid.html"><IMG SRC="figs/geo_domain.png" ALT="topography WRF's geogrid" STYLE="float:left;width:200px;height:200px" TARGET="value"></IMG></A>

trunk/tools/documentation/plotting/plotting.html

@@ -31 +31 @@
       <A CLASS="lc" HREF="Taylor.html" TARGET="value">Taylor diagram</A><BR>
       <A CLASS="lc" HREF="TimeSeries.html" TARGET="value">TimeSeries</A><BR>
+      <A CLASS="lc" HREF="time_lag.html" TARGET="value">Time lag</A><BR>
       <A CLASS="lc" HREF="topo_geogrid.html" TARGET="value">topo geogrid</A><BR>
       <A CLASS="lc" HREF="topo_geogrid_boxes.html" TARGET="value">topo geogrid boxes</A><BR>

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)

trunk/tools/drawing_tools.py

@@ -76 +76 @@
 # plot_2D_shadow_time: Plotting a 2D field with one of the axes being time
 # plot_Neighbourghood_evol:Plotting neighbourghood evolution
+# plot_time_lag: Function to plot a time-lag figure (x, previous values; y, future values)
 # plot_Trajectories
 # plot_2D_shadow_contour:
@@ -1769 +1770 @@
         print "  the standard 'rainbow' will be use instead !!"
         print '    colorbars availables with this version:', maps
+        quit(-1)
 
     return
@@ -9827 +9829 @@
         plt.yticks(dimyt, list(dimyl), rotation=yaxv[3])
         plt.xlabel(gen.latex_text(xlabel))
-        plt.ylabel(ylabel + ' (' + units_lunits(dimyu) + ')')
+        plt.ylabel(gen.latex_text(ylabel) + ' (' + units_lunits(dimyu) + ')')
         plt.ylim(dyn, dyx)
 
@@ -9839 +9841 @@
     return
 
-
+def plot_time_lag(prevals, futvals, tvals, xaxv, yaxv, axistype, prelab, futlab,     \
+  preu, futu, prerange, futrange, figtype, labels, tname, tpos, tlab, gtit, lloc,    \
+  lsiz, kfig, figname, ifclose):
+    """ Function to plot a time-lag figure (x, previous values; y, future values)
+      prevals= list with the previous values
+      futvals= list with future values
+      tavals= list of time-values (common for couples)
+      [x/y]axv= values at the axes x and y
+      axistype: type of axis to be plotted
+        'centered': crossed at 0,0 at the center of the figure
+        'box': around the figure
+      [pre/fut]lab= variable label at previous and future-axis
+      [pre/fut]u= units of the previous and future variable-axis
+      [pre/fut]range: ranges of the revious and future variable-axis
+      figtype= [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]: color of the points (single value for the same, or 'auto')
+          [type]:type of the markers (single value for the same, or 'auto')
+          [size]: size of the markers (single value for the same, or 'auto')    
+      labels= list of labels for legend (None for no legend, and 'None' for no specific label)
+      tname= label of the time-axis
+      tpos= position of the time-ticks
+      tlab= labels of the time-ticks
+      gtit= title of the figure
+      lloc= 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'
+      lsiz= font size of the legend
+      kfig= kind of output: pdf, png, ps
+      figname= name of the figure
+      ifclose= whether figure should be closed
+    """
+    fname = 'plot_time_lag'
+
+    Nvalues = len(prevals)
+
+    dxn = gen.fillValue
+    dxx = -gen.fillValue
+    dyn = gen.fillValue
+    dyx = -gen.fillValue
+
+    for iv in range(Nvalues):
+        minv = np.min(prevals[iv])
+        maxv = np.max(prevals[iv])
+        if minv < dxn: dxn = minv
+        if maxv > dxx: dxx = maxv
+        minv = np.min(futvals[iv])
+        maxv = np.max(futvals[iv])
+        if minv < dyn: dyn = minv
+        if maxv > dyx: dyx = maxv
+
+    axstyles = ['pretty', 'Nfix', 'Stringlist', 'Vfix']
+    if xaxv[0] == 'pretty':
+        dimxt = np.array(gen.pretty_int(dxn,dxx,xaxv[2]))
+        dimxl = np.array(dimxt, dtype=str)
+    elif xaxv[0] == 'Nfix':
+        dimxl = np.arange(dxn,dxx,(dxx-dxn)/(xaxv[2]+1))
+        dimxt = np.arange(dxn,dxx,(dxx-dxn)/Lxmaxvals)
+    elif xaxv[0] == 'Stringlist':
+        if len(xaxv[2]) != len(xticks):
+            print warnmsg
+            print '  ' + fname + ': number of ticks to plot=', len(xticks),         \
+              'and number of labels provided', len(xaxv[2]), 'differ !!'
+            print '  ' + fname + ': ticks to plot=', xticks, 'and provided labels', \
+                xaxv[2], 'differ !!'
+
+        dimxl = xaxv[2]
+        dimxt = xticks
+    elif xaxv[0] == 'Vfix':
+        dxnvfix = int(dxn/xaxv[2])
+        dimxt = np.arange(dxnvfix*xaxv[2],dxx,xaxv[2])
+    else:
+        print errormsg
+        print '  ' + fname + ": x-xais style '" + xaxv[0] + "' not ready !!"
+        print '    available ones: ', axstyles
+        quit(-1)
+
+    if yaxv[0] == 'pretty':
+        dimyt = np.array(gen.pretty_int(dyn,dyx,yaxv[2]))
+        dimyl = np.array(dimyt, dtype=str)
+    elif yaxv[0] == 'Nfix':
+        dimyt = np.arange(dyn,dyx,(dyx-dyn)/(yaxv[2]+1))
+        dimyl = np.arange(dyn,dyx,(dyx-dyn)/Lymaxvals)
+        axytype='fixpixel'
+    elif yaxv[0] == 'Vfix':
+        dynvfix = int(dyn/yaxv[2])
+        dimyt = np.arange(dynvfix*xaxv[2],dyx,yaxv[2])
+        axytype='data'
+    else:
+        print errormsg
+        print '  ' + fname + ": x-xais style '" + xaxv[0] + "' not ready !!"
+        print '    available ones: ', axstyles
+        quit(-1)
+
+    # kind of time-lag figure:
+    figv = figtype.split(',') 
+    figtypen = figv[0]
+
+    plt.rc('text', usetex=True)
+    fig, ax = plt.subplots(1)
+
+    for iv in range(Nvalues):
+        xvs = np.array(prevals[iv])
+        yvs = np.array(futvals[iv])
+        try:
+            with gen.Capturing() as output:
+                gen.same_shape(np.array(xvs), np.array(yvs))
+        except:
+            print errormsg
+            print '  ' + fname + ': shape of matrix from couple:', iv, 'differ !!'
+            for sout in output: print sout
+            quit(-1)
+
+        dimt = xvs.shape[0]
+        tvalues = tvals[iv]
+        if figtypen == 'repeatPeriod':
+            expectargs = "'repeatPeriod',[Nlag],[period],[colorbar],[cbarfmt]," +    \
+              "[cbaror],[ltype],[lwidth],[mtype],[msize]"
+            check_arguments(fname + " & 'repeatPeriod'",figtype,expectargs,',')
+
+            Nlag = int(figv[1])
+            period = int(figv[2])
+            colbar = gen.auto_val(figv[3], 'rainbow')
+            check_colorBar(colbar)
+            cbarfmt = figv[4]
+            cbaror = gen.auto_val(figv[5], 'vertical')
+            ltype = gen.str_list_rep(figv[6],'@',Nvalues)
+            lwidth = gen.str_list_rep(figv[7],'@',Nvalues)
+            mtype = gen.str_list_rep(figv[8],'@',Nvalues)
+            msize = gen.str_list_rep(figv[9],'@',Nvalues)
+
+            my_cmap = plt.cm.get_cmap(colbar)
+            Nperiods = dimt/period
+            tminv = np.min(tvals[iv])
+            tmaxv = np.max(tvals[iv])
+            norm = mpl.colors.Normalize(0.,Nperiods)
+
+            # Normalizing position of the ticks
+            if iv == 0:
+                tpos = tpos*Nperiods/tmaxv
+
+            if labels is not None and labels[iv] != 'None':
+                for ip in range(Nperiods):
+                    clv = my_cmap(norm(ip*1.))
+                    for it in range(period+Nlag):
+                        Tt = period*ip+it
+                        if Tt + Nlag + 1 > dimt-1: break
+                        if ip == 0 and it == 0:
+                            plt.plot([xvs[Tt],xvs[Tt+1]], [yvs[Tt+Nlag],yvs[Tt+Nlag+1]], \
+                              ltype[iv], color=clv, linewidth=np.float(lwidth[iv]),      \
+                              marker=mtype[iv], markersize=np.float(msize[iv]),          \
+                              label=gen.latex_text(labels[iv]))
+                        else:
+                            plt.plot([xvs[Tt],xvs[Tt+1]], [yvs[Tt+Nlag],yvs[Tt+Nlag+1]], \
+                              ltype[iv], color=clv, linewidth=np.float(lwidth[iv]),      \
+                              marker=mtype[iv], markersize=np.float(msize[iv]))
+            else:
+                for ip in range(Nperiods):
+                    clv = my_cmap(norm(ip*1.))
+                    for it in range(period+Nlag):
+                        Tt = period*ip+it
+                        if Tt + Nlag + 1 > dimt-1: break
+                        plt.plot([xvs[it], xvs[it+1]], [yvs[it+Nlag], yvs[it+Nlag+1]],   \
+                          ltype[iv], color=clv, linewidth=lwidth[iv], marker=mtype[iv],  \
+                          markersize=msize[iv])
+        elif figtypen == 'shadTline':
+            expectargs = "'shadTline',[Nlag],[colorbar],[cbarfmt],[cbaror]," +       \
+              "[ltype],[lwidth],[mtype],[msize]"
+            check_arguments(fname + " & 'shadTline'",figtype,expectargs,',')
+
+            Nlag = int(figv[1])
+            colbar = gen.auto_val(figv[2], 'rainbow')
+            check_colorBar(colbar)
+            cbarfmt = figv[3]
+            cbaror = gen.auto_val(figv[4], 'vertical')
+            ltype = gen.str_list_rep(figv[5],'@',Nvalues)
+            lwidth = gen.str_list_rep(figv[6],'@',Nvalues)
+            mtype = gen.str_list_rep(figv[7],'@',Nvalues)
+            msize = gen.str_list_rep(figv[8],'@',Nvalues)
+
+            my_cmap = plt.cm.get_cmap(colbar)
+            tminv = np.min(tvals[iv])
+            tmaxv = np.max(tvals[iv])
+            norm = mpl.colors.Normalize(tminv,tmaxv)
+
+            if labels is not None and labels[iv] != 'None':
+                for it in range(dimt-Nlag-1):
+                    clv = my_cmap(norm(tvalues[it]))
+                    if it == 0:
+                        plt.plot([xvs[it],xvs[it+1]], [yvs[it+Nlag],yvs[it+Nlag+1]], \
+                          ltype[iv], color=clv, linewidth=np.float(lwidth[iv]),      \
+                          marker=mtype[iv], markersize=np.float(msize[iv]),          \
+                          label=gen.latex_text(labels[iv]))
+                    else:
+                        plt.plot([xvs[it],xvs[it+1]], [yvs[it+Nlag],yvs[it+Nlag+1]], \
+                          ltype[iv], color=clv, linewidth=np.float(lwidth[iv]),      \
+                          marker=mtype[iv], markersize=np.float(msize[iv]))
+            else:
+                for it in range(dimt-Nlag):
+                    clv = my_cmap(norm(it))       
+                    plt.plot([xvs[it],xvs[it+1]], [yvs[it+Nlag],yvs[it+Nlag+1]],     \
+                      ltype[iv], color=clv, linewidth=lwidth[iv], marker=mtype[iv],  \
+                      markersize=msize[iv])
+        elif figtypen == 'simplepts':
+            expectargs = "'simplepts',[Nlag],[col],[type],[size]"
+            check_arguments(fname + " & 'simplepts'",figtype,expectargs,',')
+
+            Nlag = int(figv[1])
+            col = gen.str_list_rep(figv[2],'@',Nvalues)
+            mark = gen.str_list_rep(figv[3],'@',Nvalues)
+            size = gen.str_list_rep(figv[4],'@',Nvalues)
+            if labels is not None and labels[iv] != 'None':
+                plt.plot(xvs[0:dimt-Nlag], yvs[Nlag:dimt], ',', color=col[iv],       \
+                  marker=mark[iv], markersize=size[iv],                              \
+                  label=gen.latex_text(labels[iv]))
+            else:
+                plt.plot(xvs[0:dimt-Nlag], yvs[Nlag:dimt], ',', color=col[iv],       \
+                  marker=mark[iv], markersize=size[iv])
+        else:
+            print errormsg
+            print '  ' + fname + ": time-lag figure named '" + figtype + "' not ready !!"
+            print '    availabe ones:', ['repeatPeriod', 'shadTline', 'simplepts']
+            quit(-1)
+
+    if axistype == 'box':
+        print infmsg
+        print '    ' + fname + ': plotting with around axes'
+    elif axistype == 'centered':
+        # Drawing centered axes
+        # From http://stackoverflow.com/questions/31556446/drawing-axis-in-the-middle-of-the-figue-in-python
+        # Move left y-axis and bottim x-axis to centre, passing through (0,0)
+        ax.spines['left'].set_position('center')
+        ax.spines['bottom'].set_position('center')
+
+        # Eliminate upper and right axes
+        ax.spines['right'].set_color('none')
+        ax.spines['top'].set_color('none')
+    else:
+        print errormsg
+        print '  ' + fname + ": axis plotting type '" + axistype + "' not ready !!"
+        print '    available ones:', ['box', 'centered']
+        quit(-1)
+
+    plt.yticks(dimxt, list(dimxl), rotation=xaxv[3])
+    plt.yticks(dimyt, list(dimyl), rotation=yaxv[3])
+    if preu != 'None':
+        plt.xlabel(gen.latex_text(prelab) + ' (' + units_lunits(preu) + ')')
+    else:
+        plt.xlabel(gen.latex_text(prelab))
+    if futu != 'None':
+        plt.ylabel(gen.latex_text(futlab) + ' (' + units_lunits(futu) + ')')
+    else:
+        plt.xlabel(gen.latex_text(futlab))
+
+    ax.xaxis.set_label_coords(0.5, -0.025)
+    ax.yaxis.set_label_coords(-0.025, 0.5)
+
+    plt.xlim(prerange[0], prerange[1])
+    plt.ylim(futrange[0], futrange[1])
+
+    if labels is not None:
+        plt.legend(loc=lloc, prop={'size':lsiz})
+
+    # Colorbar
+    if gen.searchInlist(['repeatPeriod', 'shadTline'], figtypen):
+        # FROM: http://stackoverflow.com/questions/8342549/matplotlib-add-colorbar-to-a-sequence-of-line-plots
+        # For matplotlib v1.3 or greater the code becomes:
+        sm = plt.cm.ScalarMappable(cmap=colbar, norm=norm)
+        # fake up the array of the scalar mappable. Urgh...
+        sm._A = []
+        #cbar = plt.colorbar(sm)
+
+        if cbaror == 'horizontal':
+            cbar = plt.colorbar(sm, ticks=[tpos], format=cbarfmt,orientation=cbaror)
+            cbar.ax.set_xticklabels(tlab,rotation=90)
+        else:
+            print warnmsg
+            print '  ' + fname + ": This is odd, because in 'vertical' mode does " + \
+              "not work the re-labelling of the ticking!"
+            cbar = plt.colorbar(sm, ticks=[tpos], format=cbarfmt, orientation=cbaror)
+            cbar.ax.set_xticklabels(tlab)
+
+        cbar.set_label(gen.latex_text(tname))
+
+    plt.title(gen.latex_text(gtit))
+    
+    output_kind(kfig, figname, ifclose)
+
+    return
+