Add hidden "fix_spat" parameter to cttsmap (#3562)

Jürgen Knödlseder
1 parent f4c8e23d
Showing 9 changed files with 41 additions and 7 deletions
ChangeLog
NEWS
README.md
cscripts/cstsmapsplit.par
doc/source/admin/release_history/2.0.rst
doc/source/users/reference_manual/cttsmap.rst
src/ctlike/ctlike.cpp
src/cttsmap/cttsmap.cpp
src/cttsmap/cttsmap.par
-2020-03-04
+2021-03-05
         * Version 2.0.0 released
         ========================
+        Add hidden "fix_spat" parameter to cttsmap (#3562)
         Add optimizer setter to ctlikelihood base class
         Add Sphinx tutorials test script (#3510)
         Add "refit_if_failed" parameter to ctlike
 New Features and Important Changes in ctools 2.0.0
-4 March 2021
+5 March 2021
 Introduction
@@ -137,7 +137,8 @@ None
 cttsmap - Generation of Test Statistic map
 ------------------------------------------
-None
+Added hidden "fix_spat" parameter that instructs the tool to fix all spatial
+model parameters (#3562).
 ctulimit - Compute upper limit
 ctools information
 ==================
-* Version:             2.0.0.dev (4 March 2021)
+* Version:             2.0.0.dev (5 March 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/)
@@ -30,6 +30,7 @@ errors,        b, h, no,,, &quot;Compute/store parameter errors?&quot;
 statistic,     s, h, DEFAULT,DEFAULT|CSTAT|WSTAT|CHI2,, "Optimization statistic"
 like_accuracy, r, h, 0.005,1.0e-30,1.0, "Absolute accuracy of maximum likelihood value"
 max_iter,      i, h, 50,1,1000, "Maximum number of fit iterations"
+fix_spat,      b, h, no,,, "Fix spatial parameters for TS map computation?"
 outmap,        f, a, tsmap.fits,,, "Output Test Statistic map file"
 bins_per_job,  i, a, 5,,, "Number of TS map bins per task"
 compute_null,  b, a, yes,,,"Compute null hypothesis first?"
 .. _2.0:
-ctools 2.0 release (4 March 2021)
+ctools 2.0 release (5 March 2021)
 =================================
 Overview
@@ -24,6 +24,8 @@ Bug fixes
 Improvements
 ------------
+* [`3562 <https://cta-redmine.irap.omp.eu/issues/3562>`_] -
+  Add hidden ``fix_spat`` parameter to :ref:`cttsmap`
 * Add optimizer setter to ``ctlikelihood`` base class.
 * Add ``refit_if_failed`` parameter to :ref:`ctlike`
 * [`3441 <https://cta-redmine.irap.omp.eu/issues/3441>`_] -
@@ -83,6 +83,9 @@ General parameters
 ``(max_iter = 50) [integer]``
     Maximum number of fit iterations.
+``(fix_spat = no) [boolean]``
+    Fix spatial parameters for TS map computation.
+
 ``(usepnt = no) [boolean]``
     Use CTA pointing direction for map centre instead of xref/yref parameters?
@@ -715,7 +715,7 @@ GXml ctlike::xml_result(void) const
     // Set flag strings
     std::string refit           = (m_refit) ? "yes" : "no";
-    std::string edisp     = (m_apply_edisp) ? "yes" : "no";
+    std::string edisp           = (m_apply_edisp) ? "yes" : "no";
     std::string fix_spat_for_ts = (m_fix_spat_for_ts) ? "yes" : "no";
     // Write ctlike results into XML instance
 /***************************************************************************
  *                    cttsmap - TS map calculation tool                    *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2014-2019 by Michael Mayer                               *
+ *  copyright (C) 2014-2021 by Michael Mayer                               *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -248,6 +248,28 @@ void cttsmap::run(void)
     // Remove test source
     models.remove(m_srcname);
+    // Fix spatial parameters if requested
+    if ((*this)["fix_spat"].boolean()) {
+
+        // Loop over all models
+        for (int i = 0; i < models.size(); ++i) {
+
+            // Continue only if model is skymodel
+            GModelSky* sky= dynamic_cast<GModelSky*>(models[i]);
+            if (sky != NULL) {
+
+                // Fix all spatial parameters
+                GModelSpatial* spatial = sky->spatial();
+                for (int j = 0; j < spatial->size(); j++) {
+                    (*spatial)[j].fix();
+                }
+
+            } // endif: there was a sky model
+
+        } // endfor: looped over models
+
+    } // endif: spatial parameter should be fixed
+
     // Get likelihood of null hypothesis if not given before
     if (m_logL0 == 0.0) {
@@ -581,6 +603,9 @@ void cttsmap::get_parameters(void)
     m_logL0   = (*this)["logL0"].real();
     m_publish = (*this)["publish"].boolean();
+    // Query other parameters
+    (*this)["fix_spat"].boolean();
+
     // If needed later, query output filename now
     if (read_ahead()) {
         (*this)["outmap"].query();
@@ -35,6 +35,7 @@ errors,        b, h, no,,, &quot;Compute and store parameter errors?&quot;
 statistic,     s, h, DEFAULT,DEFAULT|CSTAT|WSTAT|CHI2,, "Optimization statistic"
 like_accuracy, r, h, 0.005,1.0e-30,1.0, "Absolute accuracy of maximum likelihood value"
 max_iter,      i, h, 50,1,1000, "Maximum number of fit iterations"
+fix_spat,      b, h, no,,, "Fix spatial parameters for TS map computation?"
 #
 # Spatial binning parameters