Commit 9872a7d13b3e012a9ad21d0408404f869f7cf9bc
1 parent
df508d5f
Update comments and documentation
Showing
3 changed files
with
9 additions
and
9 deletions
doc/source/users/reference_manual/ctlike.rst
| @@ -48,12 +48,12 @@ the spatial model parameters can be kept fixed during that computation | @@ -48,12 +48,12 @@ the spatial model parameters can be kept fixed during that computation | ||
| 48 | ctlike generates an output model XML file that contains the values of the | 48 | ctlike generates an output model XML file that contains the values of the |
| 49 | best fitting model parameters. For all free parameters, an ``error`` attribute | 49 | best fitting model parameters. For all free parameters, an ``error`` attribute |
| 50 | is added that provides the statistical uncertainty in the parameter estimate. | 50 | is added that provides the statistical uncertainty in the parameter estimate. |
| 51 | -In addition, the entire output of the covariance matrix to a separate FITS file | ||
| 52 | -can be queried (parameter ``outcovmat``). The parameter order given in the file | ||
| 53 | -corresponds to the arrangement of the covariance matrix entries. If computation | ||
| 54 | -of the Test Statistics has been requested for a model component, a ``ts`` | ||
| 55 | -attribute providing the Test Statistics value is added. The output model can be | ||
| 56 | -used as an input model for other ctools. | 51 | +In addition, the entire output of the covariance matrix to a separate file in CSV |
| 52 | +format can be queried (parameter ``outcovmat``). The parameter order given in the | ||
| 53 | +file header corresponds to the arrangement of the covariance matrix entries. | ||
| 54 | +If computation of the Test Statistics has been requested for a model component, | ||
| 55 | +a ``ts`` attribute providing the Test Statistics value is added. The output model | ||
| 56 | +can be used as an input model for other ctools. | ||
| 57 | 57 | ||
| 58 | 58 | ||
| 59 | 59 | ||
| @@ -89,7 +89,7 @@ General parameters | @@ -89,7 +89,7 @@ General parameters | ||
| 89 | the maximum likelihood fit. | 89 | the maximum likelihood fit. |
| 90 | 90 | ||
| 91 | ``(outcovmat = NONE) [string]`` | 91 | ``(outcovmat = NONE) [string]`` |
| 92 | - Output FITS file to store covariance matrix. | 92 | + Output CSV file to store covariance matrix. |
| 93 | 93 | ||
| 94 | ``(stat = POISSON) [string]`` | 94 | ``(stat = POISSON) [string]`` |
| 95 | Fitting statistics (POISSON or GAUSSIAN; only affects binned analysis). | 95 | Fitting statistics (POISSON or GAUSSIAN; only affects binned analysis). |
src/ctlike/ctlike.cpp
| @@ -321,7 +321,7 @@ void ctlike::run(void) | @@ -321,7 +321,7 @@ void ctlike::run(void) | ||
| 321 | /***********************************************************************//** | 321 | /***********************************************************************//** |
| 322 | * @brief Save results | 322 | * @brief Save results |
| 323 | * | 323 | * |
| 324 | - * This method saves the fit results into a XML file and a FITS file. If | 324 | + * This method saves the fit results into a XML file and a CSV file. If |
| 325 | * the filename parameters are "NONE", the files are not saved. | 325 | * the filename parameters are "NONE", the files are not saved. |
| 326 | ***************************************************************************/ | 326 | ***************************************************************************/ |
| 327 | void ctlike::save(void) | 327 | void ctlike::save(void) |
src/ctlike/ctlike.hpp
| @@ -70,7 +70,7 @@ protected: | @@ -70,7 +70,7 @@ protected: | ||
| 70 | // User parameters | 70 | // User parameters |
| 71 | bool m_refit; //!< Refitting | 71 | bool m_refit; //!< Refitting |
| 72 | GFilename m_outmodel; //!< Source model output XML file name | 72 | GFilename m_outmodel; //!< Source model output XML file name |
| 73 | - GFilename m_outcovmat; //!< Covariance matrix output FITS file name | 73 | + GFilename m_outcovmat; //!< Covariance matrix output CSV file name |
| 74 | bool m_apply_edisp; //!< Apply energy dispersion? | 74 | bool m_apply_edisp; //!< Apply energy dispersion? |
| 75 | bool m_fix_spat_for_ts; //!< Fix spatial parameters for TS computation? | 75 | bool m_fix_spat_for_ts; //!< Fix spatial parameters for TS computation? |
| 76 | GChatter m_chatter; //!< Chattiness | 76 | GChatter m_chatter; //!< Chattiness |