Add GResponse::use_source() method (#3312)

Jürgen Knödlseder
1 parent c51109f5
Showing 2 changed files with 74 additions and 42 deletions
include/GResponse.hpp
src/obs/GResponse.cpp
@@ -119,6 +119,9 @@ protected:
                      const bool&         grad) const;
  
     // Virtual protected methods
+    virtual bool   use_source(const GEvent&       event,
+                              const GSource&      source,
+                              const GObservation& obs) const;
     virtual double irf_ptsrc(const GEvent&       event,
                              const GSource&      source,
                              const GObservation& obs) const;
@@ -308,50 +308,55 @@ double GResponse::irf_spatial(const GEvent&amp;       event,
     // Initialise IRF value
     double irf = 0.0;
  
-    // Set IRF value attributes
-    std::string     name  = obs.id() + "::" + source.name();
-    const GInstDir& dir   = event.dir();
-    const GEnergy&  ereco = event.energy();
-    const GEnergy&  etrue = source.energy();
-
-    // Signal if spatial model has free parameters
-    bool has_free_pars = source.model()->has_free_pars();
-
-    // If the spatial model component has free parameters, or the response
-    // cache should not be used, or the cache does not contain the requested
-    // IRF value then compute the IRF value for the spatial model.
-    if (has_free_pars    ||
-        !m_use_irf_cache ||
-        !m_irf_cache.contains(name, dir, ereco, etrue, &irf)) {
-
-        // Compute IRF for spatial model
-        switch (source.model()->code()) {
-            case GMODEL_SPATIAL_POINT_SOURCE:
-                irf = irf_ptsrc(event, source, obs);
-                break;
-            case GMODEL_SPATIAL_RADIAL:
-                irf = irf_radial(event, source, obs);
-                break;
-            case GMODEL_SPATIAL_ELLIPTICAL:
-                irf = irf_elliptical(event, source, obs);
-                break;
-            case GMODEL_SPATIAL_DIFFUSE:
-                irf = irf_diffuse(event, source, obs);
-                break;
-            case GMODEL_SPATIAL_COMPOSITE:
-                irf = irf_composite(event, source, obs);
-                break;
-            default:
-                break;
-        }
+    // Continue only if source should be used
+    if (use_source(event, source, obs)) {
+
+        // Set IRF value attributes
+        std::string     name  = obs.id() + "::" + source.name();
+        const GInstDir& dir   = event.dir();
+        const GEnergy&  ereco = event.energy();
+        const GEnergy&  etrue = source.energy();
+
+        // Signal if spatial model has free parameters
+        bool has_free_pars = source.model()->has_free_pars();
+
+        // If the spatial model component has free parameters, or the response
+        // cache should not be used, or the cache does not contain the requested
+        // IRF value then compute the IRF value for the spatial model.
+        if (has_free_pars    ||
+            !m_use_irf_cache ||
+            !m_irf_cache.contains(name, dir, ereco, etrue, &irf)) {
+
+            // Compute IRF for spatial model
+            switch (source.model()->code()) {
+                case GMODEL_SPATIAL_POINT_SOURCE:
+                    irf = irf_ptsrc(event, source, obs);
+                    break;
+                case GMODEL_SPATIAL_RADIAL:
+                    irf = irf_radial(event, source, obs);
+                    break;
+                case GMODEL_SPATIAL_ELLIPTICAL:
+                    irf = irf_elliptical(event, source, obs);
+                    break;
+                case GMODEL_SPATIAL_DIFFUSE:
+                    irf = irf_diffuse(event, source, obs);
+                    break;
+                case GMODEL_SPATIAL_COMPOSITE:
+                    irf = irf_composite(event, source, obs);
+                    break;
+                default:
+                    break;
+            }
  
-    } // endif: computed spatial model
+        } // endif: computed spatial model
  
-    // If the spatial model has no free parameters and the response cache
-    // should be used then put the IRF value in the response cache.
-    if (!has_free_pars && m_use_irf_cache) {
-        m_irf_cache.set(name, dir, ereco, etrue, irf);
-    }
+        // If the spatial model has no free parameters and the response cache
+        // should be used then put the IRF value in the response cache.
+        if (!has_free_pars && m_use_irf_cache) {
+            m_irf_cache.set(name, dir, ereco, etrue, irf);
+        }
+
+    } // endif: source was used
  
     // Return IRF value
     return irf;
@@ -439,6 +444,30 @@ void GResponse::free_members(void)
  
  
 /***********************************************************************//**
+ * @brief Check if source should be used
+ *
+ * @param[in] event Observed event.
+ * @param[in] source Source.
+ * @param[in] obs Observation.
+ * @return True if source should be used.
+ *
+ * Returns true if the source should be used.
+ *
+ * This method is a hook. The base class version of this method returns
+ * always true, but derived classes may implement a version of this method
+ * that actually evaluates whether a source should be used or not for a given
+ * event.
+ ***************************************************************************/
+bool GResponse::use_source(const GEvent&       event,
+                           const GSource&      source,
+                           const GObservation& obs) const
+{
+    // Return true
+    return true;
+}
+
+
+/***********************************************************************//**
  * @brief Return instrument response to point source
  *
  * @param[in] event Observed event.