Add GCTAEventList::ipix() and GCTAEventList::ieng() setter methods (#2171)

Jürgen Knödlseder
1 parent 342c1007
Showing 6 changed files with 56 additions and 12 deletions
ChangeLog
NEWS
doc/source/admin/release_history/1.4.rst
inst/cta/include/GCTAEventBin.hpp
inst/cta/pyext/GCTAEventBin.i
inst/cta/test/test_CTA.cpp
-2017-07-25
+2017-07-27
         * Version 1.4.0 released
         =========================
+        Add GCTAEventBin::ipix() and ieng() setter methods (#2171)
         Write response information into simulated observation definition file (#2170)
         Normalise phase curves by default (#2154)
         Support Python list slicing for container classes (#2128)
 New Features and Important Changes in GammaLib 1.4.0
-25 July 2017
+27 July 2017
 1. Introduction
@@ -29,6 +29,8 @@ The following methods have been added:
 - GModelTemporalPhaseCurve::normalize()
 - GModelTemporalPhaseCurve::value(double&)
 - GOptimizerPars::append(GOptimizerPar&)
+- GCTAEventList::ipix(int&)
+- GCTAEventList::ieng(int&)
 - GLATEventList::append(GLATEventAtom&)
 - GLATEventList::reserve(int&)
 - GLATEventList::remove(int&,int&)
@@ -153,6 +155,9 @@ The response information is now always written in the observation definition
 XML file if it is available, and not only if it has been read in previously
 from another XML file (#2170).
+Add GCTAEventList::ipix() and GCTAEventList::ieng() setter methods (#2171).
+
+
 21. COMPTEL interface
 ---------------------
@@ -20,6 +20,8 @@ Bug fixes
 Improvements
 ------------
+* [`2171 <https://cta-redmine.irap.omp.eu/issues/2171>`_] -
+  Add ``GCTAEventList::ipix()`` and ``GCTAEventList::ieng()`` setter methods
 * [`2170 <https://cta-redmine.irap.omp.eu/issues/2170>`_] -
   Write response information into simulated observation definition file
 * [`2154 <https://cta-redmine.irap.omp.eu/issues/2154>`_] -
 /***************************************************************************
  *                  GCTAEventBin.hpp - CTA event bin class                 *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2010-2016 by Juergen Knoedlseder                         *
+ *  copyright (C) 2010-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -86,6 +86,8 @@ public:
     void           dir(const GCTAInstDir& dir);
     void           energy(const GEnergy& energy);
     void           time(const GTime& time);
+    void           ipix(const int& ipix);
+    void           ieng(const int& ieng);
     void           solidangle(const double& solidangle);
     void           ewidth(const GEnergy& ewidth);
     void           ontime(const double& ontime);
@@ -140,6 +142,21 @@ const int&amp; GCTAEventBin::ipix(void) const
 /***********************************************************************//**
+ * @brief Set the spatial pixel index
+ *
+ * @param[in] ipix Spatial pixel index.
+ *
+ * Sets the spatial index of the event bin in the event cube.
+ ***************************************************************************/
+inline
+void GCTAEventBin::ipix(const int& ipix)
+{
+    m_ipix = ipix;
+    return;
+}
+
+
+/***********************************************************************//**
  * @brief Return the energy layer index
  *
  * @return Energy layer index.
@@ -153,4 +170,19 @@ const int&amp; GCTAEventBin::ieng(void) const
     return (m_ieng);
 }
+
+/***********************************************************************//**
+ * @brief Set the energy layer index
+ *
+ * @param[in] ieng Energy layer index.
+ *
+ * Sets the energy layer of the event bin in the event cube.
+ ***************************************************************************/
+inline
+void GCTAEventBin::ieng(const int& ieng)
+{
+    m_ieng = ieng;
+    return;
+}
+
 #endif /* GCTAEVENTBIN_HPP */
 /***************************************************************************
  *                   GCTAEventBin.i - CTA event bin class                  *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2011-2016 by Juergen Knoedlseder                         *
+ *  copyright (C) 2011-2017 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -67,6 +67,8 @@ public:
     void           dir(const GCTAInstDir& dir);
     void           energy(const GEnergy& energy);
     void           time(const GTime& time);
+    void           ipix(const int& ipix);
+    void           ieng(const int& ieng);
     void           solidangle(const double& solidangle);
     void           ewidth(const GEnergy& ewidth);
     void           ontime(const double& ontime);
@@ -1479,6 +1479,8 @@ void TestGCTAObservation::test_event_bin(void)
     bin.energy(GEnergy(2.0, "TeV"));
     bin.time(GTime(87.3));
     bin.counts(4.0);
+    bin.ipix(5);
+    bin.ieng(7);
     bin.solidangle(3.14);
     bin.ewidth(GEnergy(7.0, "GeV"));
     bin.ontime(101.0);
@@ -1502,8 +1504,8 @@ void TestGCTAObservation::test_event_bin(void)
     test_value(bin.time().secs(), 87.3, 1.0e-10, "Check time() for filled bin");
     test_value(bin.counts(), 4.0, 1.0e-10, "Check counts() for filled bin");
     test_value(bin.error(),  2.0, 1.0e-10, "Check error() for filled bin");
-    test_value(bin.ipix(), -1, "Check ipix() for filled bin");
-    test_value(bin.ieng(), -1, "Check ieng() for filled bin");
+    test_value(bin.ipix(), 5, "Check ipix() for filled bin");
+    test_value(bin.ieng(), 7, "Check ieng() for filled bin");
     test_value(bin.solidangle(), 3.14, 1.0e-10,
                "Check solidangle() for filled bin");
     test_value(bin.ewidth().GeV(), 7.0, 1.0e-10,
@@ -1528,8 +1530,8 @@ void TestGCTAObservation::test_event_bin(void)
     test_value(bin2.time().secs(), 87.3, 1.0e-10, "Check time() for copied bin");
     test_value(bin2.counts(), 4.0, 1.0e-10, "Check counts() for copied bin");
     test_value(bin2.error(),  2.0, 1.0e-10, "Check error() for copied bin");
-    test_value(bin2.ipix(), -1, "Check ipix() for copied bin");
-    test_value(bin2.ieng(), -1, "Check ieng() for copied bin");
+    test_value(bin2.ipix(), 5, "Check ipix() for copied bin");
+    test_value(bin2.ieng(), 7, "Check ieng() for copied bin");
     test_value(bin2.solidangle(), 3.14, 1.0e-10,
                "Check solidangle() for copied bin");
     test_value(bin2.ewidth().GeV(), 7.0, 1.0e-10,
@@ -1555,8 +1557,8 @@ void TestGCTAObservation::test_event_bin(void)
                "Check time() for assigned bin");
     test_value(bin3.counts(), 4.0, 1.0e-10, "Check counts() for assigned bin");
     test_value(bin3.error(),  2.0, 1.0e-10, "Check error() for assigned bin");
-    test_value(bin3.ipix(), -1, "Check ipix() for assigned bin");
-    test_value(bin3.ieng(), -1, "Check ieng() for assigned bin");
+    test_value(bin3.ipix(), 5, "Check ipix() for assigned bin");
+    test_value(bin3.ieng(), 7, "Check ieng() for assigned bin");
     test_value(bin3.solidangle(), 3.14, 1.0e-10,
                "Check solidangle() for assigned bin");
     test_value(bin3.ewidth().GeV(), 7.0, 1.0e-10,
@@ -1582,8 +1584,8 @@ void TestGCTAObservation::test_event_bin(void)
                "Check time() for cloned bin");
     test_value(bin4->counts(), 4.0, 1.0e-10, "Check counts() for cloned bin");
     test_value(bin4->error(),  2.0, 1.0e-10, "Check error() for cloned bin");
-    test_value(bin4->ipix(), -1, "Check ipix() for cloned bin");
-    test_value(bin4->ieng(), -1, "Check ieng() for cloned bin");
+    test_value(bin4->ipix(), 5, "Check ipix() for cloned bin");
+    test_value(bin4->ieng(), 7, "Check ieng() for cloned bin");
     test_value(bin4->solidangle(), 3.14, 1.0e-10,
                "Check solidangle() for cloned bin");
     test_value(bin4->ewidth().GeV(), 7.0, 1.0e-10,