Commit 0c9ae016455a5fd4d3f1e4ba50c76cc901ecd5c2
1 parent
cfa7a20b
Update ctlike method documentations.
Showing
1 changed file
with
9 additions
and
5 deletions
src/ctlike/ctlike.cpp
| 1 | /*************************************************************************** | 1 | /*************************************************************************** |
| 2 | * ctlike - Maximum likelihood fitting tool * | 2 | * ctlike - Maximum likelihood fitting tool * |
| 3 | * ----------------------------------------------------------------------- * | 3 | * ----------------------------------------------------------------------- * |
| 4 | - * copyright (C) 2010-2015 by Juergen Knoedlseder * | 4 | + * copyright (C) 2010-2016 by Juergen Knoedlseder * |
| 5 | * ----------------------------------------------------------------------- * | 5 | * ----------------------------------------------------------------------- * |
| 6 | * * | 6 | * * |
| 7 | * This program is free software: you can redistribute it and/or modify * | 7 | * This program is free software: you can redistribute it and/or modify * |
| @@ -441,7 +441,9 @@ void ctlike::get_parameters(void) | @@ -441,7 +441,9 @@ void ctlike::get_parameters(void) | ||
| 441 | 441 | ||
| 442 | 442 | ||
| 443 | /***********************************************************************//** | 443 | /***********************************************************************//** |
| 444 | - * @brief Optimize model parameters using Levenberg-Marquardt method | 444 | + * @brief Optimise model parameters |
| 445 | + * | ||
| 446 | + * Optimise model parameters using a maximum likelihood fit. | ||
| 445 | ***************************************************************************/ | 447 | ***************************************************************************/ |
| 446 | void ctlike::optimize_lm(void) | 448 | void ctlike::optimize_lm(void) |
| 447 | { | 449 | { |
| @@ -518,8 +520,10 @@ void ctlike::optimize_lm(void) | @@ -518,8 +520,10 @@ void ctlike::optimize_lm(void) | ||
| 518 | 520 | ||
| 519 | 521 | ||
| 520 | /***********************************************************************//** | 522 | /***********************************************************************//** |
| 521 | - * @brief Re-optimize model parameters using Levenberg-Marquardt method | ||
| 522 | - * for TS computation | 523 | + * @brief Re-optimise model parameters for TS computation |
| 524 | + * | ||
| 525 | + * Re-optimise the model parameters using a maximum likelihood fit for | ||
| 526 | + * computation of the Test Statistic value for a given source. | ||
| 523 | ***************************************************************************/ | 527 | ***************************************************************************/ |
| 524 | double ctlike::reoptimize_lm(void) | 528 | double ctlike::reoptimize_lm(void) |
| 525 | { | 529 | { |
| @@ -530,7 +534,7 @@ double ctlike::reoptimize_lm(void) | @@ -530,7 +534,7 @@ double ctlike::reoptimize_lm(void) | ||
| 530 | log.indent(1); | 534 | log.indent(1); |
| 531 | } | 535 | } |
| 532 | 536 | ||
| 533 | - // Create a clone of the optimizer for the re-optimisation | 537 | + // Create a clone of the optimizer for the re-optimisation |
| 534 | GOptimizer* opt = m_opt->clone(); | 538 | GOptimizer* opt = m_opt->clone(); |
| 535 | 539 | ||
| 536 | // Perform LM optimization | 540 | // Perform LM optimization |