Maria Benito / ctools

Commit 6cea5977ddec301fa9d2110e3ccd1af00fb5a43a

Authored by Jürgen Knödlseder
1 parent da257d99

Integrate code

Inline Side-by-side
Showing 7 changed files with 61 additions and 39 deletions
... ... @@ -13,3 +13,5 @@ Michael Mayer (michael.mayer@physik.hu-berlin.de)
13 13 Stefan Ohm (stefan.ohm81@gmail.com)
14 14 David Sanchez (david.sanchez@lapp.in2p3.fr)
15 15 Hubert Siejkowski (h.siejkowski@cyfronet.pl)
  16 +Alexander Ziegler (alexander.ziegler@fau.de)
  17 +
... ...
ChangeLog
  View file @6cea597
1   -2016-09-26
  1 +2016-10-17
2 2  
3 3 * Version 1.2.0 released
4 4 ========================
5 5  
  6 + Add outcovmat parameter to ctlike (#1863)
6 7 Fix ctbin segfault bug for varying energy thresholds (#1850)
7 8 Make csresmap enumbins parameter hidden (#1844)
8 9 Rename ctskymap::map() to ctskymap::skymap() (#1828)
... ...
1 1 New Features and Important Changes in ctools 1.2.0
2 2  
3   -26 September 2016
  3 +17 October 2016
4 4  
5 5  
6 6 Introduction
... ... @@ -93,6 +93,10 @@ of the tool (#1835).
93 93  
94 94 The class now derives from ctlikelihood (#1828).
95 95  
  96 +The hidden parameter "outcovmat" has been added that by default is set to "NONE".
  97 +If instead a FITS filename is given, ctlike will write the coraviance matrix of
  98 +the fit into a FITS file (#1863).
  99 +
96 100  
97 101 cttsmap - Generation of Test Statistic map
98 102 ------------------------------------------
... ...
doc/source/users/reference_manual/ctlike.rst
  View file @6cea597
... ... @@ -49,7 +49,7 @@ ctlike generates an output model XML file that contains the values of the
49 49 best fitting model parameters. For all free parameters, an ``error`` attribute
50 50 is added that provides the statistical uncertainty in the parameter estimate.
51 51 In addition, the entire output of the covariance matrix to a separate FITS file
52   -can be queried (parameter ``covmat``). The parameter order given in the file
  52 +can be queried (parameter ``outcovmat``). The parameter order given in the file
53 53 corresponds to the arrangement of the covariance matrix entries. If computation
54 54 of the Test Statistics has been requested for a model component, a ``ts``
55 55 attribute providing the Test Statistics value is added. The output model can be
... ... @@ -88,6 +88,9 @@ General parameters
88 88 Output model XML file with values and uncertainties updated by
89 89 the maximum likelihood fit.
90 90  
  91 +``(outcovmat = NONE) [string]``
  92 + Output FITS file to store covariance matrix.
  93 +
91 94 ``(stat = POISSON) [string]``
92 95 Fitting statistics (POISSON or GAUSSIAN; only affects binned analysis).
93 96  
... ... @@ -97,11 +100,7 @@ General parameters
97 100 ``(fix_spat_for_ts = no) [boolean]``
98 101 Fix spatial parameters for TS computation.
99 102  
100   -``(covmat = NONE) [string]``
101   - Output FITS file to store covariance matrix.
102   -
103 103  
104   -
105 104 Standard parameters
106 105 -------------------
107 106  
... ...
src/ctlike/ctlike.cpp
  View file @6cea597
... ... @@ -228,19 +228,13 @@ void ctlike::run(void)
228 228 // Optimize model parameters using LM optimizer
229 229 optimize_lm();
230 230  
231   - // Save covariance matrix if valid filename is passed
232   - if (is_valid_filename(m_covmat)) {
233   -
234   - // Write header
235   - log_header1(TERSE, "Saving covariance matrix");
236   -
237   - // Log filename
238   - log_value(NORMAL, "Covariance matrix file", m_covmat.url());
239   -
240   - // Save covarianve matrix
241   - m_obs.save_covmat(m_covmat);
242   - }
  231 + // Get pointer to curvature matrix
  232 + GMatrixSparse* curvature_ptr =
  233 + const_cast<GObservations::likelihood&>(m_obs.function()).curvature();
243 234  
  235 + // Store copy of curvature matrix
  236 + GMatrixSparse curvature = *curvature_ptr;
  237 +
244 238 // Store Npred
245 239 double npred = m_obs.npred();
246 240  
... ... @@ -318,6 +312,9 @@ void ctlike::run(void)
318 312 // Restore energy dispersion flags of all CTA observations
319 313 restore_edisp(m_obs, save_edisp);
320 314  
  315 + // Restore curvature matrix
  316 + *curvature_ptr = curvature;
  317 +
321 318 // Return
322 319 return;
323 320 }
... ... @@ -326,15 +323,17 @@ void ctlike::run(void)
326 323 /***********************************************************************//**
327 324 * @brief Save results
328 325 *
329   - * This method saves the fit results in a XML file.
  326 + * This method saves the fit results into a XML file and a FITS file. If
  327 + * the filename parameters are "NONE", the files are not saved.
330 328 ***************************************************************************/
331 329 void ctlike::save(void)
332 330 {
333 331 // Write header
334 332 log_header1(TERSE, "Save results");
335 333  
336   - // Get output filename
337   - m_outmodel = (*this)["outmodel"].filename();
  334 + // Get output filenames
  335 + m_outmodel = (*this)["outmodel"].filename();
  336 + m_outcovmat = (*this)["outcovmat"].filename();
338 337  
339 338 // Save only if filename is valid
340 339 if (is_valid_filename(m_outmodel)) {
... ... @@ -344,6 +343,7 @@ void ctlike::save(void)
344 343  
345 344 // Write results out as XML model
346 345 m_obs.models().save(m_outmodel);
  346 +
347 347 }
348 348  
349 349 // ... otherwise signal that file was not saved
... ... @@ -351,6 +351,22 @@ void ctlike::save(void)
351 351 log_value(NORMAL, "Model definition file", "NONE");
352 352 }
353 353  
  354 + // Save covariance matrix if filename is valid
  355 + if (is_valid_filename(m_outcovmat)) {
  356 +
  357 + // Log filename
  358 + log_value(NORMAL, "Covariance matrix file", m_outcovmat.url());
  359 +
  360 + // Save covarianve matrix
  361 + m_obs.function().save(m_outcovmat);
  362 +
  363 + }
  364 +
  365 + // ... otherwise signal that no covariance matrix was not saved
  366 + else {
  367 + log_value(NORMAL, "Covariance matrix file", "NONE");
  368 + }
  369 +
354 370 // Return
355 371 return;
356 372 }
... ... @@ -405,12 +421,12 @@ void ctlike::get_parameters(void)
405 421 m_apply_edisp = (*this)["edisp"].boolean();
406 422 m_fix_spat_for_ts = (*this)["fix_spat_for_ts"].boolean();
407 423 m_chatter = static_cast<GChatter>((*this)["chatter"].integer());
408   - m_covmat = (*this)["covmat"].filename();
409 424  
410 425 // Optionally read ahead parameters so that they get correctly
411 426 // dumped into the log file
412 427 if (read_ahead()) {
413   - m_outmodel = (*this)["outmodel"].filename();
  428 + m_outmodel = (*this)["outmodel"].filename();
  429 + m_outcovmat = (*this)["outcovmat"].filename();
414 430 }
415 431  
416 432 // Set optimizer logger
... ... @@ -543,7 +559,7 @@ void ctlike::init_members(void)
543 559 {
544 560 // Initialise members
545 561 m_outmodel.clear();
546   - m_covmat.clear();
  562 + m_outcovmat.clear();
547 563 m_refit = false;
548 564 m_max_iter = 100; // Set maximum number of iterations
549 565 m_max_stall = 10; // Set maximum number of stalls
... ... @@ -574,7 +590,7 @@ void ctlike::copy_members(const ctlike&amp; app)
574 590 // Copy attributes
575 591 m_refit = app.m_refit;
576 592 m_outmodel = app.m_outmodel;
577   - m_covmat = app.m_covmat;
  593 + m_outcovmat = app.m_outcovmat;
578 594 m_max_iter = app.m_max_iter;
579 595 m_max_stall = app.m_max_stall;
580 596 m_logL = app.m_logL;
... ...
src/ctlike/ctlike.hpp
  View file @6cea597
... ... @@ -70,10 +70,10 @@ protected:
70 70 // User parameters
71 71 bool m_refit; //!< Refitting
72 72 GFilename m_outmodel; //!< Source model output XML file name
  73 + GFilename m_outcovmat; //!< Covariance matrix output FITS file name
73 74 bool m_apply_edisp; //!< Apply energy dispersion?
74 75 bool m_fix_spat_for_ts; //!< Fix spatial parameters for TS computation?
75 76 GChatter m_chatter; //!< Chattiness
76   - GFilename m_covmat; //!< Covariance matrix output FITS file name
77 77  
78 78 // Members
79 79 int m_max_iter; //!< Maximum number of iterations
... ...
src/ctlike/ctlike.par
  View file @6cea597
... ... @@ -5,7 +5,7 @@
5 5 # ------------------------------------------------------------------------- #
6 6 # #
7 7 # File: ctlike.par #
8   -# Version: 1.1.0 #
  8 +# Version: 1.2.0 #
9 9 # #
10 10 # Author: Jurgen Knodlseder #
11 11 # Jurgen.Knodlseder@irap.omp.eu #
... ... @@ -17,17 +17,17 @@
17 17 #
18 18 # General parameters
19 19 #===================
20   -inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition XML file"
21   -inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model XML file"
22   -expcube, f, a, "NONE",,, "Input exposure cube file (only needed for stacked analysis)"
23   -psfcube, f, a, "NONE",,, "Input PSF cube file (only needed for stacked analysis)"
24   -edispcube, f, a, "NONE",,, "Input energy dispersion cube file (only needed for stacked analysis)"
25   -bkgcube, f, a, "NONE",,, "Input background cube file (only needed for stacked analysis)"
26   -caldb, s, a, "prod2",,, "Calibration database"
27   -irf, s, a, "South_0.5h",,, "Instrument response function"
28   -edisp, b, h, no,,, "Apply energy dispersion?"
29   -outmodel, f, a, "crab_results.xml",,, "Output model XML file"
30   -covmat, f, h, "NONE",,, "Output covariance matrix FITS file"
  20 +inobs, f, a, "events.fits",,, "Input event list, counts cube or observation definition XML file"
  21 +inmodel, f, a, "$CTOOLS/share/models/crab.xml",,, "Input model XML file"
  22 +expcube, f, a, "NONE",,, "Input exposure cube file (only needed for stacked analysis)"
  23 +psfcube, f, a, "NONE",,, "Input PSF cube file (only needed for stacked analysis)"
  24 +edispcube, f, a, "NONE",,, "Input energy dispersion cube file (only needed for stacked analysis)"
  25 +bkgcube, f, a, "NONE",,, "Input background cube file (only needed for stacked analysis)"
  26 +caldb, s, a, "prod2",,, "Calibration database"
  27 +irf, s, a, "South_0.5h",,, "Instrument response function"
  28 +edisp, b, h, no,,, "Apply energy dispersion?"
  29 +outmodel, f, a, "crab_results.xml",,, "Output model XML file"
  30 +outcovmat, f, h, "NONE",,, "Output covariance matrix FITS file"
31 31  
32 32 #
33 33 # Maximisation parameters
... ...