From b2d2aab6bfd0b489b35fd26c01166842c5576088 Mon Sep 17 00:00:00 2001
From: Jürgen Knödlseder <jurgen.knodlseder@irap.omp.eu>
Date: Fri, 19 Jan 2018 21:12:53 +0100
Subject: [PATCH] Add show_residuals.py unit test for On/Off spectrum

---
 cscripts/Makefile.am          |  1 +
 examples/show_residuals.py    | 52 +++++++++++++++++++++++++++++-----------------------
 test/data/residual_onoff.fits | Bin 0 -> 8640 bytes
 test/test_examples.py.in      |  7 +++++++
 4 files changed, 37 insertions(+), 23 deletions(-)
 create mode 100644 test/data/residual_onoff.fits

diff --git a/cscripts/Makefile.am b/cscripts/Makefile.am
index c1196b9..d756f8a 100644
--- a/cscripts/Makefile.am
+++ b/cscripts/Makefile.am
@@ -196,6 +196,7 @@ testdata = $(top_srcdir)/test/data/crab.xml \
            $(top_srcdir)/test/data/skymap.fits \
            $(top_srcdir)/test/data/spectrum.fits \
            $(top_srcdir)/test/data/residual.fits \
+           $(top_srcdir)/test/data/residual_onoff.fits \
            $(top_srcdir)/test/data/lightcurve.fits \
            $(top_srcdir)/test/data/ts.dat \
            $(top_srcdir)/test/data/models_spatial.xml \
diff --git a/examples/show_residuals.py b/examples/show_residuals.py
index e147fa8..db9823a 100755
--- a/examples/show_residuals.py
+++ b/examples/show_residuals.py
@@ -36,8 +36,19 @@ except (ImportError, RuntimeError):
 # ======================= #
 def set_residual_label(algorithm):
     """
+    Set residual label text for a given algorithm.
+
+    Parameters
+    ----------
+    algorithm : str
+        Algorithm
+
+    Returns
+    -------
+    label : str
+        Label text
     """
-    # Set algorithm dependent residual level
+    # Set algorithm dependent residual label text
     if algorithm == 'SUB':
         label = 'Residuals (counts)'
     elif algorithm == 'SUBDIV':
@@ -74,11 +85,11 @@ def fill_cmr(row, counts, model, resid, e_counts, e_resid, c_counts, c_model,
         Counts error
     e_resid : list of float
         Residual error
-    c_counts : `~gammalib.GFitsTableCol()'
+    c_counts : `~gammalib.GFitsTableCol'
         Counts FITS table column
-    c_model : `~gammalib.GFitsTableCol()'
+    c_model : `~gammalib.GFitsTableCol'
         Model FITS table column
-    c_resid : `~gammalib.GFitsTableCol()'
+    c_resid : `~gammalib.GFitsTableCol'
         Residual FITS table column
     algorithm : str
         Algorithm
@@ -86,7 +97,7 @@ def fill_cmr(row, counts, model, resid, e_counts, e_resid, c_counts, c_model,
     Returns
     -------
     counts, model, resid, e_counts, e_resid : tuple of float
-        Values
+        Counts, model and residual arrays
     """
     # Extract values
     counts.append(c_counts.real(row))
@@ -96,10 +107,7 @@ def fill_cmr(row, counts, model, resid, e_counts, e_resid, c_counts, c_model,
     # Calculate count error
     err = math.sqrt(c_counts.real(row))
     if err == 1:
-        # this prevents visualization problem in matplotlib
-        err = 0.99
-    else:
-        pass
+        err = 0.99 # This prevents visualization problem in matplotlib
     e_counts.append(err)
 
     # Calculate residual error
@@ -110,15 +118,17 @@ def fill_cmr(row, counts, model, resid, e_counts, e_resid, c_counts, c_model,
     elif algorithm == 'SUBDIVSQRT':
         e_resid.append(err / math.sqrt(c_model.real(row)))
     elif algorithm == 'SIGNIFICANCE':
-        e_resid.append(1.)
+        e_resid.append(1.0)
+    else:
+        e_resid.append(0.0)
 
     # Return tuple
     return counts, model, resid, e_counts, e_resid
 
 
-# ============= #
-# Plot spectrum #
-# ============= #
+# ====================== #
+# Plot residual spectrum #
+# ====================== #
 def plot_residuals(filename, plotfile, hdu):
     """
     Plot spectrum
@@ -129,7 +139,7 @@ def plot_residuals(filename, plotfile, hdu):
         Name of spectrum FITS file
     plotfile : str
         Plot file name
-    hdu      : int
+    hdu : int
         Number of observation to plot
     """
     # Read spectrum file    
@@ -270,20 +280,16 @@ def plot_residuals(filename, plotfile, hdu):
         axarr[3].axhline(0, color='0.5', linestyle='--')
         axarr[3].set_xlabel('Energy (TeV)')
 
-    # Add spectra of individual components
-    skiplist = ['Counts', 'Model', 'Residuals',
-                'Counts_Off', 'Model_Off', 'Residuals_Off',
-                'Emin', 'Emax']
+    # Add spectra of individual components. Skip all standard columns.
+    skiplist = ['Counts', 'Model', 'Residuals', 'Counts_Off', 'Model_Off',
+                'Residuals_Off', 'Emin', 'Emax']
     for s in range(table.ncols()):
-        if table[s].name() in skiplist:
-            pass
-        else:
+        if table[s].name() not in skiplist:
             component = []
             for row in range(nrows):
                 component.append(table[s].real(row))
             component = [component[0]] + component
-            axarr[0].step(ebounds, component, zorder=0,
-                          label=table[s].name())
+            axarr[0].step(ebounds, component, zorder=0, label=table[s].name())
 
     # Add legend
     axarr[0].legend(loc='best')
diff --git a/test/data/residual_onoff.fits b/test/data/residual_onoff.fits
new file mode 100644
index 0000000..aa94c49
Binary files /dev/null and b/test/data/residual_onoff.fits differ
diff --git a/test/test_examples.py.in b/test/test_examples.py.in
index 17f1822..a05e773 100755
--- a/test/test_examples.py.in
+++ b/test/test_examples.py.in
@@ -379,6 +379,13 @@ class Test(gammalib.GPythonTestSuite):
         # Execute script
         self._execute_python('show_residuals', args=args)
 
+        # Set arguments
+        args = ('-p example_show_residuals_onoff.eps %s/residual_onoff.fits' %
+                self._datadir)
+
+        # Execute script
+        self._execute_python('show_residuals', args=args)
+
         # Return
         return
 
--
libgit2 0.21.4