ctulimit.hpp

Go to the documentation of this file.

/***************************************************************************
 *                   ctulimit - Upper limit calculation tool               *
 * ----------------------------------------------------------------------- *
 *  copyright (C) 2015-2022 by Michael Mayer                               *
 * ----------------------------------------------------------------------- *
 *                                                                         *
 *  This program is free software: you can redistribute it and/or modify   *
 *  it under the terms of the GNU General Public License as published by   *
 *  the Free Software Foundation, either version 3 of the License, or      *
 *  (at your option) any later version.                                    *
 *                                                                         *
 *  This program is distributed in the hope that it will be useful,        *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of         *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          *
 *  GNU General Public License for more details.                           *
 *                                                                         *
 *  You should have received a copy of the GNU General Public License      *
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.  *
 *                                                                         *
 ***************************************************************************/
/**
 * @file ctulimit.hpp
 * @brief Upper limit calculation tool interface definition
 * @author Michael Mayer
 */

#ifndef CTULIMIT_HPP
#define CTULIMIT_HPP

/* __ Includes ___________________________________________________________ */
#include "ctlikelihood.hpp"

/* __Definitions _________________________________________________________ */
#define CTULIMIT_NAME "ctulimit"


/***********************************************************************//**
 * @class ctulimit
 *
 * @brief Upper limit calculation tool
 *
 * This class computes and upper limit for a given source.
 *
 * The class operates on predefined observation containers, an individual
 * event list or an observation definition XML file.
 *
 * During the computation the likelihood function is inspected to find the
 * best value for the upper limit.
 ***************************************************************************/
class ctulimit : public ctlikelihood {

public:
    // Constructors and destructors
    ctulimit(void);
    explicit ctulimit(const GObservations& obs);
    ctulimit(int argc, char *argv[]);
    ctulimit(const ctulimit& app);
    virtual ~ctulimit(void);

    // Operators
    ctulimit& operator=(const ctulimit& app);

    // Methods
    void          clear(void);
    void          process(void);
    void          save(void);
    const double& diff_ulimit(void) const;
    const double& flux_ulimit(void) const;
    const double& eflux_ulimit(void) const;

protected:
    // Protected methods
    void init_members(void);
    void copy_members(const ctulimit& app);
    void free_members(void);
    void get_parameters(void);
    void get_model_parameter(void);
    void get_parameter_brackets(double& parmin, double& parmax);
    void ulimit_bisection(const double& parmin, const double& parmax);
    void compute_ulimit(void);

    // User parameters
    std::string   m_srcname;      //!< Name of source for upper limit computation
    std::string   m_parname;      //!< Name of parameter for upper limit computation
    double        m_confidence;   //!< Confidence level
    double        m_sigma_min;    //!< Starting value minimum (multiple fit errors above fit values)
    double        m_sigma_max;    //!< Starting value maximum (multiple fit errors above fit values)
    double        m_eref;         //!< Reference energy for flux limits (TeV)
    double        m_emin;         //!< Minimum energy for flux limits (TeV)
    double        m_emax;         //!< Maximum energy for flux limits (TeV)
    double        m_tol;          //!< Tolerance for limit determination
    int           m_max_iter;     //!< Maximum number of iterations
    bool          m_apply_edisp;  //!< Apply energy dispersion?
    GChatter      m_chatter;      //!< Chattiness

    // Protected members
    double        m_dlogL;        //!< Likelihood difference for upper limit computation
    double        m_best_logL;    //!< Best fit log likelihood of given model
    double        m_best_value;   //!< Best parameter value factor
    double        m_best_error;   //!< Best parameter value error
    double        m_diff_ulimit;  //!< Differential upper limit value
    double        m_flux_ulimit;  //!< Flux upper limit value
    double        m_eflux_ulimit; //!< Energy flux upper limits
    GModelSky*    m_skymodel;     //!< Pointer to sky model
    GModelPar*    m_model_par;    //!< Pointer to model parameter
    bool          m_is_spatial;   //!< Signal that model parameter is spatial parameter
};


/***********************************************************************//**
 * @brief Return differential upper limit
 *
 * @return Differential upper flux limit.
 ***************************************************************************/
inline
const double& ctulimit::diff_ulimit(void) const
{
    return m_diff_ulimit;
}


/***********************************************************************//**
 * @brief Return flux upper limit
 *
 * @return Upper flux limit.
 ***************************************************************************/
inline
const double& ctulimit::flux_ulimit(void) const
{
    return m_flux_ulimit;
}


/***********************************************************************//**
 * @brief return energy flux upper limit
 *
 * @return Upper energy flux limit.
 ***************************************************************************/
inline
const double& ctulimit::eflux_ulimit(void) const
{
    return m_eflux_ulimit;
}

#endif /* CTULIMIT_HPP */