Add phi_first and phi_last parameters to comlixfit and comlixmap (#3912)

Jürgen Knödlseder
1 parent 8d9ce025
Showing 9 changed files with 60 additions and 13 deletions
ChangeLog
NEWS
README.md
doc/source/users/reference_manual/comlixfit.rst
doc/source/users/reference_manual/comlixmap.rst
modules/comscripts/comlixfit.par
modules/comscripts/comlixfit.py
modules/comscripts/comlixmap.par
modules/comscripts/comlixmap.py
-2021-09-30
+2021-11-29
         * Version 2.0.0 released
         ========================
+        Add phi_first and phi_last parameters to comlixfit and comlixmap (#3912)
         Add csadd2caldb script
         Add restart of bisection in case of bad convergence in ctulimit
         Add COMPTEL analysis scripts (#3738)
 New Features and Important Changes in ctools 2.0.0
-30 September 2021
+29 November 2021
 Introduction
@@ -399,52 +399,58 @@ regions (#3248).
 comlixfit - COMPTEL maximum likelihood fitting using SRCLIX algorithm
 ---------------------------------------------------------------------
-Added script (#3738)
+Added phi_first and phi_last parameters to allow selection of the Phibar layers
+during the maximum likelihood fit (#3912).
+
+Added script (#3738).
 comlixmap - Generation of COMPTEL Test Statistic map using SRCLIX algorithm
 ---------------------------------------------------------------------------
-Added script (#3738)
+Added phi_first and phi_last parameters to allow selection of the Phibar layers
+during the maximum likelihood fit (#3912).
+
+Added script (#3738).
 comobsadd - Combine COMPTEL observations
 ----------------------------------------
-Added script (#3738)
+Added script (#3738).
 comobsback - Generate background model for COMPTEL observations
 ---------------------------------------------------------------
-Added script (#3738)
+Added script (#3738).
 comobsbin - Bin COMPTEL observations
 ------------------------------------
-Added script (#3738)
+Added script (#3738).
 comobsmodel - Generate model for binned COMPTEL observations
 ------------------------------------------------------------
-Added script (#3738)
+Added script (#3738).
 comobsres - Generate residuals of COMPTEL observations
 ------------------------------------------------------
-Added script (#3738)
+Added script (#3738).
 comobsselect - Select observations from COMPTEL database
 --------------------------------------------------------
-Added script (#3738)
+Added script (#3738).
 comobssim - Simulate COMPTEL observations
 -----------------------------------------
-Added script (#3738)
+Added script (#3738).
 comsrcdetect - Detect source in Test Statistic map
 --------------------------------------------------
-Added script (#3738)
+Added script (#3738).
 Examples
 ctools information
 ==================
-* Version:             2.0.0.dev (30 September 2021)
+* Version:             2.0.0.dev (29 November 2021)
 * GammaLib dependency: 2.0.0.dev
 [![Build Status](https://cta-jenkins.irap.omp.eu/buildStatus/icon?job=ctools-integrate-os)](https://cta-jenkins.irap.omp.eu/job/ctools-integrate-os/)
@@ -59,6 +59,14 @@ General parameters
     Number of Phibar layers to exclude (relevant for ``BGDLIXA`` and ``BGDLIXE``
     methods).
+``(phi_first = -1)  [integer]``
+    First Phibar layer for likelihood fitting, starting from 0. If -1 is specified
+    there is no first Phibar layer selection.
+
+``(phi_last = -1)  [integer]``
+    Last Phibar layer for likelihood fitting, starting from 0. If -1 is specified
+    there is no last Phibar layer selection.
+
 Standard parameters
 -------------------
@@ -73,6 +73,14 @@ General parameters
     Number of Phibar layers to exclude (relevant for ``BGDLIXA`` and ``BGDLIXE``
     methods).
+``(phi_first = -1)  [integer]``
+    First Phibar layer for likelihood fitting, starting from 0. If -1 is specified
+    there is no first Phibar layer selection.
+
+``(phi_last = -1)  [integer]``
+    Last Phibar layer for likelihood fitting, starting from 0. If -1 is specified
+    there is no last Phibar layer selection.
+
 Standard parameters
 -------------------
@@ -35,6 +35,8 @@ nrunav,              i, h, 3,,, &quot;Number of Chi/Psi bins used for running average
 navgr,               i, h, 5,,, "Number of Chi/Psi bins used for averaging"
 nincl,               i, h, 5,,, "Number of Phibar layers to include"
 nexcl,               i, h, 0,,, "Number of Phibar layers to exclude"
+phi_first,           i, h, -1,,, "First Phibar layer for fitting (starting from 0; -1: no selection)"
+phi_last,            i, h, -1,,, "Last Phibar layer for fitting (starting from 0;-1: no selection)"
 #
 # Standard parameters
@@ -70,6 +70,8 @@ class comlixfit(ctools.cslikelihood):
         navgr     = self['navgr'].integer()
         nincl     = self['nincl'].integer()
         nexcl     = self['nexcl'].integer()
+        phi_first = self['phi_first'].integer()
+        phi_last  = self['phi_last'].integer()
         # Check for incorrect parameters
         if nexcl < 0 or nexcl >= nincl:
@@ -92,6 +94,14 @@ class comlixfit(ctools.cslikelihood):
             self['outobs'].filename()
             self['outmodel'].filename()
+        # Set Phibar layers for fitting
+        for obs in self.obs():
+            if obs.classname() == 'GCOMObservation':
+                if phi_first >= 0:
+                    obs.phi_first(phi_first)
+                if phi_last >= 0:
+                    obs.phi_last(phi_last)
+
         #  Write input parameters into logger
         self._log_parameters(gammalib.TERSE)
@@ -43,6 +43,8 @@ nrunav,        i, h, 3,,, &quot;Number of Chi/Psi bins used for running average&quot;
 navgr,         i, h, 9,,, "Number of Chi/Psi bins used for averaging"
 nincl,         i, h, 5,,, "Number of Phibar layers to include"
 nexcl,         i, h, 0,,, "Number of Phibar layers to exclude"
+phi_first,     i, h, -1,,, "First Phibar layer for fitting (starting from 0; -1: no selection)"
+phi_last,      i, h, -1,,, "Last Phibar layer for fitting (starting from 0;-1: no selection)"
 #
 # Standard parameters
@@ -84,6 +84,8 @@ class comlixmap(ctools.cslikelihood):
         navgr     = self['navgr'].integer()
         nincl     = self['nincl'].integer()
         nexcl     = self['nexcl'].integer()
+        phi_first = self['phi_first'].integer()
+        phi_last  = self['phi_last'].integer()
         # Check for incorrect parameters
         if nexcl < 0 or nexcl >= nincl:
@@ -103,6 +105,14 @@ class comlixmap(ctools.cslikelihood):
         if self._read_ahead():
             self['outmap'].filename()
+        # Set Phibar layers for fitting
+        for obs in self.obs():
+            if obs.classname() == 'GCOMObservation':
+                if phi_first >= 0:
+                    obs.phi_first(phi_first)
+                if phi_last >= 0:
+                    obs.phi_last(phi_last)
+
         #  Write input parameters into logger
         self._log_parameters(gammalib.TERSE)