Remove GCOMSelection::zeta_min() and GCOMSelection::zeta_max() methods as those …

…were never used and always introduced confusion about the zetamin argument that is effectively used for Earth Horizon event selection.

Remove GCOMSelection::zeta_min() and GCOMSelection::zeta_max() methods as those …
…were never used and always introduced confusion about the zetamin argument that is effectively used for Earth Horizon event selection.
Jürgen Knödlseder
1 parent 1fbf6770
Showing 7 changed files with 14 additions and 108 deletions
ChangeLog
NEWS
README.md
doc/source/admin/release_history/2.0.rst
inst/com/include/GCOMSelection.hpp
inst/com/pyext/GCOMSelection.i
inst/com/src/GCOMSelection.cpp
-2021-12-02
+2021-12-03
         * Version 2.0.0 released
         ========================
+        Remove GCOMSelection::zeta_min() and GCOMSelection::zeta_max()
+          methods
 	Add GCOMSelection::fpmtflag(), GCOMSelection::use_d1() and 
           GCOMSelection::use_d2() methods (#3917)
         Add GCOMModelDRBPhibarBins class (#3913)
 New Features and Important Changes in GammaLib 2.0.0
-1 December 2021
+3 December 2021
 1. Introduction
@@ -128,6 +128,8 @@ The following methods have been removed:
 - GFitsTableCol::scale()
 - GCOMObservation::drm(GModelSky&)
 - GCOMResponse::irf_spatial()
+- GCOMSelection::zeta_min()
+- GCOMSelection::zeta_max()
 The following methods have been renamed:
 - none
@@ -391,6 +393,11 @@ spatial model gradients (#3203).
 22. COMPTEL interface
 ---------------------
+Removed GCOMSelection::zeta_min() and GCOMSelection::zeta_max() since event-wise
+zeta selection is actually not used and the zeta cut is applied using the minimum
+value of the corresponding Phibar layer. Having this additional selection was always
+a source of confusion.
+
 Added GCOMSelection::use_d1() and GCOMSelection::use_d2() methods to control the usage
 of D1 and D2 modules. The control logic was implemented in GCOMDri and header keywords
 with per module information are now written into the DRE FITS files. A D1 and D2
 GammaLib information
 ====================
-* Version: 2.0.0.dev (2 December 2021)
+* Version: 2.0.0.dev (3 December 2021)
 [![Build Status](https://cta-jenkins.irap.omp.eu/buildStatus/icon?job=gammalib-integrate-os)](https://cta-jenkins.irap.omp.eu/job/gammalib-integrate-os/)
 .. _2.0:
-GammaLib 2.0 release (2 December 2021)
+GammaLib 2.0 release (3 December 2021)
 ======================================
 Overview
@@ -130,6 +130,7 @@ New features
 Clean up
 --------
+* Remove ``GCOMSelection::zeta_min()`` and ``GCOMSelection::zeta_max()`` methods
 * [`3560 <https://cta-redmine.irap.omp.eu/issues/3560>`_] -
   Store DRB, DRG and DRX as instances of ``GCOMDri`` instead of ``GSkyMap`` in ``GCOMObservation``
 * [`2973 <https://cta-redmine.irap.omp.eu/issues/2973>`_] -
@@ -83,10 +83,6 @@ public:
     void                            psd_min(const int& psd_min);
     const int&                      psd_max(void) const;
     void                            psd_max(const int& psd_max);
-    const double&                   zeta_min(void) const;
-    void                            zeta_min(const double& zeta_min);
-    const double&                   zeta_max(void) const;
-    void                            zeta_max(const double& zeta_max);
     const int&                      reflag_min(void) const;
     void                            reflag_min(const int& reflag_min);
     const int&                      reflag_max(void) const;
@@ -123,8 +119,6 @@ protected:
     int                      m_tof_max;      //!< Maximum TOF window
     int                      m_psd_min;      //!< Minimum PSD window
     int                      m_psd_max;      //!< Maximum PSD window
-    double                   m_zeta_min;     //!< Minimum Earth horizon angle - Phibar window
-    double                   m_zeta_max;     //!< Maximum Earth horizon angle - Phibar window
     int                      m_reflag_min;   //!< Minimum rejection flag
     int                      m_reflag_max;   //!< Maximum rejection flag
     int                      m_vetoflag_min; //!< Minimum veto flag
@@ -149,8 +143,6 @@ protected:
     mutable int m_num_tof_max;         //!< Number of events above TOF threshold
     mutable int m_num_psd_min;         //!< Number of events below PSD threshold
     mutable int m_num_psd_max;         //!< Number of events above PSD threshold
-    mutable int m_num_zeta_min;        //!< Number of events below Zeta threshold
-    mutable int m_num_zeta_max;        //!< Number of events above Zeta threshold
     mutable int m_num_reflag_min;      //!< Number of events below rejection flag threshold
     mutable int m_num_reflag_max;      //!< Number of events above rejection flag threshold
     mutable int m_num_vetoflag_min;    //!< Number of events below veto flag threshold
@@ -378,56 +370,6 @@ void GCOMSelection::psd_max(const int&amp; psd_max)
 /***********************************************************************//**
- * @brief Return minimum of Earth horizon selection window
- *
- * @return Minimum of Earth horizon selection window.
- ***************************************************************************/
-inline
-const double& GCOMSelection::zeta_min(void) const
-{
-    return (m_zeta_min);
-}
-
-
-/***********************************************************************//**
- * @brief Set minimum of Earth horizon selection window
- *
- * @param[in] zeta_min Minimum of Earth horizon selection window.
- ***************************************************************************/
-inline
-void GCOMSelection::zeta_min(const double& zeta_min)
-{
-    m_zeta_min = zeta_min;
-    return;
-}
-
-
-/***********************************************************************//**
- * @brief Return maximum of Earth horizon selection window
- *
- * @return Maximum of Earth horizon selection window.
- ***************************************************************************/
-inline
-const double& GCOMSelection::zeta_max(void) const
-{
-    return (m_zeta_max);
-}
-
-
-/***********************************************************************//**
- * @brief Set maximum of Earth horizon selection window
- *
- * @param[in] zeta_max Maximum of Earth horizon selection window.
- ***************************************************************************/
-inline
-void GCOMSelection::zeta_max(const double& zeta_max)
-{
-    m_zeta_max = zeta_max;
-    return;
-}
-
-
-/***********************************************************************//**
  * @brief Return minimum of Rejection Flag selection window
  *
  * @return Minimum of Rejection Flag selection window.
@@ -66,10 +66,6 @@ public:
     void                            psd_min(const int& psd_min);
     const int&                      psd_max(void) const;
     void                            psd_max(const int& psd_max);
-    const double&                   zeta_min(void) const;
-    void                            zeta_min(const double& zeta_min);
-    const double&                   zeta_max(void) const;
-    void                            zeta_max(const double& zeta_max);
     const int&                      reflag_min(void) const;
     void                            reflag_min(const int& reflag_min);
     const int&                      reflag_max(void) const;
@@ -183,8 +183,6 @@ void GCOMSelection::init_statistics(void) const
     m_num_tof_max         = 0;
     m_num_psd_min         = 0;
     m_num_psd_max         = 0;
-    m_num_zeta_min        = 0;
-    m_num_zeta_max        = 0;
     m_num_reflag_min      = 0;
     m_num_reflag_max      = 0;
     m_num_vetoflag_min    = 0;
@@ -225,9 +223,6 @@ bool GCOMSelection::use_event(const GCOMEventAtom&amp; event) const
     // Increment number of checked events
     m_num_events_checked++;
-    // Compute zeta for event
-    double zeta = event.eha() - event.phibar();
-
     // Check for bad minitelescopes
     if (event.modcom() < 1 || event.modcom() > 98) {
         m_num_invalid_modcom++;
@@ -274,14 +269,6 @@ bool GCOMSelection::use_event(const GCOMEventAtom&amp; event) const
         m_num_psd_max++;
         use = false;
     }
-    else if (zeta < m_zeta_min) {
-        m_num_zeta_min++;
-        use = false;
-    }
-    else if (zeta > m_zeta_max) {
-        m_num_zeta_max++;
-        use = false;
-    }
     else if (event.reflag() < m_reflag_min) {
         m_num_reflag_min++;
         use = false;
@@ -546,12 +533,6 @@ void GCOMSelection::read(const GFitsHDU&amp; hdu)
         m_psd_max = hdu.real("PSDMAX");
     }
-    // Read Earth horizon angle - Phibar selection
-    if (hdu.has_card("ZETMIN") && hdu.has_card("ZETMAX")) {
-        m_zeta_min = hdu.real("ZETMIN");
-        m_zeta_max = hdu.real("ZETMAX");
-    }
-
     // Read rejection flag selection
     if (hdu.has_card("RFLMIN") && hdu.has_card("RFLMAX")) {
         m_reflag_min = hdu.integer("RFLMIN");
@@ -615,10 +596,6 @@ void GCOMSelection::read(const GFitsHDU&amp; hdu)
         m_num_psd_min = hdu.integer("NPSDLO");
         m_num_psd_max = hdu.integer("NPSDHI");
     }
-    if (hdu.has_card("NZETLO") && hdu.has_card("NZETHI")) {
-        m_num_zeta_min = hdu.integer("NZETLO");
-        m_num_zeta_max = hdu.integer("NZETHI");
-    }
     if (hdu.has_card("NRFLLO") && hdu.has_card("NRFLHI")) {
         m_num_reflag_min = hdu.integer("NRFLLO");
         m_num_reflag_max = hdu.integer("NRFLHI");
@@ -680,10 +657,6 @@ void GCOMSelection::write(GFitsHDU&amp; hdu) const
     hdu.card("PSDMIN",  m_psd_min, "PSD selection minimum");
     hdu.card("PSDMAX",  m_psd_max, "PSD selection maximum");
-    // Write Earth horizon angle - Phibar selection
-    hdu.card("ZETMIN",  m_zeta_min, "[deg] Earth horizon angle - Phibar minimum");
-    hdu.card("ZETMAX",  m_zeta_max, "[deg] Earth horizon angle - Phibar maximum");
-
     // Write rejection flag selection
     hdu.card("RFLMIN",  m_reflag_min, "Rejection flag minimum");
     hdu.card("RFLMAX",  m_reflag_max, "Rejection flag maximum");
@@ -725,8 +698,6 @@ void GCOMSelection::write(GFitsHDU&amp; hdu) const
     hdu.card("NTOFHI",  m_num_tof_max,         "Number of events > TOFMIN");
     hdu.card("NPSDLO",  m_num_psd_min,         "Number of events < PSDMIN");
     hdu.card("NPSDHI",  m_num_psd_max,         "Number of events > PSDMAX");
-    hdu.card("NZETLO",  m_num_zeta_min,        "Number of events < ZETMIN");
-    hdu.card("NZETHI",  m_num_zeta_max,        "Number of events > ZETMAX");
     hdu.card("NRFLLO",  m_num_reflag_min,      "Number of events < RFLMIN");
     hdu.card("NRFLHI",  m_num_reflag_max,      "Number of events > RFLMAX");
     hdu.card("NVFLLO",  m_num_vetoflag_min,    "Number of events < VFLMIN");
@@ -805,13 +776,6 @@ std::string GCOMSelection::print(const GChatter&amp; chatter) const
         result.append(gammalib::str(m_psd_max)+"] < ");
         result.append(gammalib::str(m_num_psd_max));
-        // Append zeta angle selection statistics
-        result.append("\n"+gammalib::parformat("Zeta angle selection"));
-        result.append(gammalib::str(m_num_zeta_min)+" < [");
-        result.append(gammalib::str(m_zeta_min)+" - ");
-        result.append(gammalib::str(m_zeta_max)+" deg] < ");
-        result.append(gammalib::str(m_num_zeta_max));
-
         // Append rejection flag selection statistics
         result.append("\n"+gammalib::parformat("Rejection flag selection"));
         result.append(gammalib::str(m_num_reflag_min)+" < [");
@@ -902,8 +866,6 @@ void GCOMSelection::init_members(void)
     m_tof_max      =   130;  //!< Maximum TOF window
     m_psd_min      =     0;  //!< Minimum PSD window
     m_psd_max      =   110;  //!< Maximum PSD window
-    m_zeta_min     =   0.0;  //!< Minimum Earth horizon angle - Phibar window
-    m_zeta_max     = 180.0;  //!< Maximum Earth horizon angle - Phibar window
     m_reflag_min   =     1;  //!< Minimum rejection flag
     m_reflag_max   =  1000;  //!< Maximum rejection flag
     m_vetoflag_min =     0;  //!< Minimum veto flag
@@ -942,8 +904,6 @@ void GCOMSelection::copy_members(const GCOMSelection&amp; select)
     m_tof_max      = select.m_tof_max;
     m_psd_min      = select.m_psd_min;
     m_psd_max      = select.m_psd_max;
-    m_zeta_min     = select.m_zeta_min;
-    m_zeta_max     = select.m_zeta_max;
     m_reflag_min   = select.m_reflag_min;
     m_reflag_max   = select.m_reflag_max;
     m_vetoflag_min = select.m_vetoflag_min;
@@ -970,8 +930,6 @@ void GCOMSelection::copy_members(const GCOMSelection&amp; select)
     m_num_tof_max         = select.m_num_tof_max;
     m_num_psd_min         = select.m_num_psd_min;
     m_num_psd_max         = select.m_num_psd_max;
-    m_num_zeta_min        = select.m_num_zeta_min;
-    m_num_zeta_max        = select.m_num_zeta_max;
     m_num_reflag_min      = select.m_num_reflag_min;
     m_num_reflag_max      = select.m_num_reflag_max;
     m_num_vetoflag_min    = select.m_num_vetoflag_min;