From 0c9ae016455a5fd4d3f1e4ba50c76cc901ecd5c2 Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Tue, 9 Feb 2016 09:58:21 +0100 Subject: [PATCH] Update ctlike method documentations. --- src/ctlike/ctlike.cpp | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/src/ctlike/ctlike.cpp b/src/ctlike/ctlike.cpp index 6c0b71f..43ee690 100644 --- a/src/ctlike/ctlike.cpp +++ b/src/ctlike/ctlike.cpp @@ -1,7 +1,7 @@ /*************************************************************************** * ctlike - Maximum likelihood fitting tool * * ----------------------------------------------------------------------- * - * copyright (C) 2010-2015 by Juergen Knoedlseder * + * copyright (C) 2010-2016 by Juergen Knoedlseder * * ----------------------------------------------------------------------- * * * * This program is free software: you can redistribute it and/or modify * @@ -441,7 +441,9 @@ void ctlike::get_parameters(void) /***********************************************************************//** - * @brief Optimize model parameters using Levenberg-Marquardt method + * @brief Optimise model parameters + * + * Optimise model parameters using a maximum likelihood fit. ***************************************************************************/ void ctlike::optimize_lm(void) { @@ -518,8 +520,10 @@ void ctlike::optimize_lm(void) /***********************************************************************//** - * @brief Re-optimize model parameters using Levenberg-Marquardt method - * for TS computation + * @brief Re-optimise model parameters for TS computation + * + * Re-optimise the model parameters using a maximum likelihood fit for + * computation of the Test Statistic value for a given source. ***************************************************************************/ double ctlike::reoptimize_lm(void) { @@ -530,7 +534,7 @@ double ctlike::reoptimize_lm(void) log.indent(1); } - // Create a clone of the optimizer for the re-optimisation + // Create a clone of the optimizer for the re-optimisation GOptimizer* opt = m_opt->clone(); // Perform LM optimization -- libgit2 0.21.4