public distro 2.1.0

pmsco/graphics/scan.py

@@ -36,7 +36,7 @@ except ImportError:
     logger.warning("error importing matplotlib. graphics rendering disabled.")
 
 
-def render_1d_scan(filename, data, scan_mode, canvas=None, is_modf=False):
+def render_1d_scan(filename, data, scan_mode, canvas=None, is_modf=False, ref_data=None):
     """
     produce a graphics file from a one-dimensional scan file.
 
@@ -47,14 +47,22 @@ def render_1d_scan(filename, data, scan_mode, canvas=None, is_modf=False):
 
     @param filename: path and name of the scan file.
         this is used to derive the output file path by adding the extension of the graphics file format.
+
     @param data: numpy-structured array of EI, ETPI or ETPAI data.
+
     @param scan_mode: list containing the field name of the scanning axis of the data array.
         it must contain one element exactly.
+
     @param canvas: a FigureCanvas class reference from a matplotlib backend.
         if None, the default FigureCanvasAgg is used which produces a bitmap file in PNG format.
+
     @param is_modf: whether data contains a modulation function (True) or intensity (False, default).
         this parameter is used to set axis labels.
 
+    @param ref_data: numpy-structured array of EI, ETPI or ETPAI data.
+        this is reference data (e.g. experimental data) that should be plotted with the main dataset.
+        both datasets will be plotted on the same axis and should have similar data range.
+
     @return (str) path and name of the generated graphics file.
         empty string if an error occurred.
 
@@ -66,6 +74,8 @@ def render_1d_scan(filename, data, scan_mode, canvas=None, is_modf=False):
     canvas(fig)
 
     ax = fig.add_subplot(111)
+    if ref_data is not None:
+        ax.plot(ref_data[scan_mode[0]], ref_data['i'], 'k.')
     ax.plot(data[scan_mode[0]], data['i'])
 
     ax.set_xlabel(scan_mode[0])
@@ -225,7 +235,7 @@ def render_tp_scan(filename, data, canvas=None, is_modf=False):
     return out_filename
 
 
-def render_scan(filename, data=None):
+def render_scan(filename, data=None, ref_data=None):
     """
     produce a graphics file from a scan file.
 
@@ -248,6 +258,11 @@ def render_scan(filename, data=None):
     @param data: numpy-structured array of ETPI or ETPAI data.
         if this argument is omitted, the data is loaded from the file referenced by the filename argument.
 
+    @param ref_data: numpy-structured array of ETPI or ETPAI data.
+        this is reference data (e.g. experimental data) that should be plotted with the main dataset.
+        this is supported for 1d scans only.
+        both datasets will be plotted on the same axis and should have similar data range.
+
     @return (str) path and name of the generated graphics file.
         empty string if an error occurred.
     """
@@ -258,7 +273,7 @@ def render_scan(filename, data=None):
 
     try:
         if len(scan_mode) == 1:
-            out_filename = render_1d_scan(filename, data, scan_mode, is_modf=is_modf)
+            out_filename = render_1d_scan(filename, data, scan_mode, is_modf=is_modf, ref_data=ref_data)
         elif len(scan_mode) == 2 and 'e' in scan_mode:
             out_filename = render_ea_scan(filename, data, scan_mode, is_modf=is_modf)
         elif len(scan_mode) == 2 and 't' in scan_mode and 'p' in scan_mode: