Defer import of ROOT module in csroot2caldb to run method (#2652)

Jürgen Knödlseder
1 parent 58732e19
Showing 6 changed files with 28 additions and 21 deletions
ChangeLog
NEWS
cscripts/__init__.py.in
cscripts/csroot2caldb.py
doc/source/admin/release_history/1.6.rst
test/test_csroot2caldb.py
@@ -3,7 +3,7 @@
         * Version 1.6.0 released
         ========================
-        Do no longer automatically import csroot2caldb (#2652)
+        Defer import of ROOT module in csroot2caldb to run method (#2652)
         Transparently update parameter files (#2513)
         Change formula for number of true energy bins in csphagen (#2490)
         Remove ctools::is_valid_filename() method
@@ -288,10 +288,8 @@ parameter due to a bug in the code. This bug was fixed (#2448).
 csroot2caldb - Generates calibration database from ROOT file
 ------------------------------------------------------------
-The script is no longer automatically imported by a "import cscript" statement
-since this led to some conflicts with the "--help" option due to the automatic
-opening of a X windows link. To use the tool in Python, use
-"from cscripts.csroot2caldb import csroot2caldb" (#2652).
+The ROOT Python module is now imported in the run method and not globally so
+that no conflit arises with the "--help" option (#2652).
 cssens - Computes sensitivity curve
@@ -80,6 +80,7 @@ from cscripts.csphasecrv    import csphasecrv
 from cscripts.cspull        import cspull
 from cscripts.csresmap      import csresmap
 from cscripts.csresspec     import csresspec
+from cscripts.csroot2caldb  import csroot2caldb
 from cscripts.cssens        import cssens
 from cscripts.csspec        import csspec
 from cscripts.cssrcdetect   import cssrcdetect
@@ -27,13 +27,6 @@ import gammalib
 import ctools
 from cscripts import calutils
-# Optional ROOT import
-try:
-    from ROOT import TFile, TH2F, TH3F
-    _has_root = True
-except ImportError:
-    _has_root = False
-
 # ================== #
 # csroot2caldb class #
@@ -329,7 +322,7 @@ class csroot2caldb(ctools.cscript):
             ds['PSF_FITS'].close()
             ds['EDISP_FITS'].close()
             ds['BGD_FITS'].close()
- 
+
         # Return
         return
@@ -533,6 +526,9 @@ class csroot2caldb(ctools.cscript):
         ds : dict
             Directory structure dictionary
         """
+        # Import TFile from ROOT module
+        from ROOT import TFile
+
         # Open ROOT performance file
         tfile = TFile(self['infile'].filename().url())
@@ -554,7 +550,7 @@ class csroot2caldb(ctools.cscript):
     def _root2ea(self, tfile, irf, ds):
         """
         Translate ROOT to CALDB effective area extension
- 
+
         The following ROOT histograms are used:
         - EffectiveAreaEtrueNoTheta2cut_offaxis -> EFFAREA
         - EffectiveAreaEtrueNoTheta2cut (for normalization)
@@ -675,6 +671,9 @@ class csroot2caldb(ctools.cscript):
         ndist   = dists.GetNbins()
         noffset = offsets.GetNbins()
+        # Import TH2F histograms from ROOT module
+        from ROOT import TH2F
+
         # Create r68 and r80 histograms
         r68 = TH2F('AngRes68Etrue_offaxis',
                    'Angular resolution (68% containment)',
@@ -688,7 +687,7 @@ class csroot2caldb(ctools.cscript):
         # Loop over all energy and offset angle bins
         for ieng in range(neng):
             for ioff in range(noffset):
-            
+
                 # Compute PDF integral
                 pdf_integral = 0.0
                 for idist in range(ndist):
@@ -911,7 +910,7 @@ class csroot2caldb(ctools.cscript):
                                     'ieng=%d ioff=%d%s' % (ieng,ioff,status),
                                     'r68=%f r80=%f gamma=%f sigma=%f' %
                                     (r_68, r_80, gamma, sigma))
-    
+
                     # Store surrent result as last result
                     last_gamma = gamma
                     last_sigma = sigma
@@ -967,6 +966,9 @@ class csroot2caldb(ctools.cscript):
         # Set number of migration bins
         nmigra = 300
+        # Import TH3F histogram from ROOT module
+        from ROOT import TH3F
+
         # Create migra histograms
         migra = TH3F('EestOverEtrue_offaxis',
                      'Migration',
@@ -979,7 +981,7 @@ class csroot2caldb(ctools.cscript):
             # Get true energy in TeV
             e_true = math.pow(10.0, migra.GetXaxis().GetBinCenter(ietrue+1))
-            
+
             # Loop over migration values
             for imigra in range(nmigra):
@@ -1738,6 +1740,13 @@ class csroot2caldb(ctools.cscript):
         """
         Run the script
         """
+        # Optional ROOT import
+        try:
+            from ROOT import TFile, TH2F, TH3F
+            _has_root = True
+        except ImportError:
+            _has_root = False
+
         # Warn if ROOT module is missing
         if not _has_root:
             gammalib.warning('csroot2caldb', 'ROOT Python module not present, '
@@ -20,7 +20,7 @@ Bug fixes
 ---------
 * [`2652 <https://cta-redmine.irap.omp.eu/issues/2652>`_] -
-  Do no longer automatically import :ref:`csroot2caldb`
+  Defer import of ``ROOT`` module in :ref:`csroot2caldb` to run method
 * [`2456 <https://cta-redmine.irap.omp.eu/issues/2456>`_] -
   Handle zero model for ``SUBDIV method`` in ``show_response.py``
 * [`2448 <https://cta-redmine.irap.omp.eu/issues/2448>`_] -
@@ -19,7 +19,7 @@
 #
 # ==========================================================================
 import os
-from cscripts.csroot2caldb import csroot2caldb
+import cscripts
 from testing import test
@@ -98,8 +98,7 @@ class Test(test):
         """
         # Set-up csroot2caldb with a maximum of parameters so that the
         # corresponding code gets tests
-        #caldb = cscripts.csroot2caldb()
-        caldb = csroot2caldb()
+        caldb = cscripts.csroot2caldb()
         caldb['infile']        = self._infile
         caldb['outdir']        = 'csroot2caldb_py1'
         caldb['inst']          = 'prod3'