GCOMResponse.hpp

Go to the documentation of this file.

/***************************************************************************
 *                 GCOMResponse.hpp - COMPTEL Response class               *
 * ----------------------------------------------------------------------- *
 *  copyright (C) 2012-2021 by Juergen Knoedlseder                         *
 * ----------------------------------------------------------------------- *
 *                                                                         *
 *  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 GCOMResponse.hpp
 * @brief COMPTEL instrument response function class interface definition
 * @author Juergen Knoedlseder
 */

#ifndef GCOMRESPONSE_HPP
#define GCOMRESPONSE_HPP

/* __ Includes ___________________________________________________________ */
#include "GResponse.hpp"
#include "GCaldb.hpp"

/* __ Type definitions ___________________________________________________ */

/* __ Forward declaration ________________________________________________ */
class GVector;
class GMatrix;
class GModelSky;
class GEvent;
class GPhoton;
class GSource;
class GEnergy;
class GTime;
class GObservation;
class GFitsImage;
class GFitsImageFloat;


/***********************************************************************//**
 * @class GCOMResponse
 *
 * @brief Interface for the COMPTEL instrument response function
 ***************************************************************************/
class GCOMResponse : public GResponse {

    // Friend classes
    friend class GCOMDri;

public:
    // Constructors and destructors
    GCOMResponse(void);
    GCOMResponse(const GCOMResponse& rsp);
    GCOMResponse(const GCaldb& caldb, const std::string& rspname);
    virtual ~GCOMResponse(void);

    // Operators
    virtual GCOMResponse& operator=(const GCOMResponse & rsp);

    // Implement pure virtual base class methods
    virtual void          clear(void);
    virtual GCOMResponse* clone(void) const;
    virtual std::string   classname(void) const;
    virtual bool          use_edisp(void) const;
    virtual bool          use_tdisp(void) const;
    virtual double        irf(const GEvent&       event,
                              const GPhoton&      photon,
                              const GObservation& obs) const;
    virtual double        nroi(const GModelSky&    model,
                               const GEnergy&      obsEng,
                               const GTime&        obsTime,
                               const GObservation& obs) const;
    virtual GEbounds      ebounds(const GEnergy& obsEnergy) const;
    virtual std::string   print(const GChatter& chatter = NORMAL) const;

    // Other Methods
    void               caldb(const GCaldb& caldb);
    const GCaldb&      caldb(void) const;
    const std::string& rspname(void) const;
    void               load(const std::string& rspname);
    void               read(const GFitsImage& hdu);
    void               write(GFitsImageFloat& image) const;

private:
    // Private methods
    void    init_members(void);
    void    copy_members(const GCOMResponse& rsp);
    void    free_members(void);

    // Overloaded virtual base class methods
    virtual GVector irf_ptsrc(const GModelSky&    model,
                              const GObservation& obs,
                              GMatrix*            gradients = NULL) const;
    virtual GVector irf_radial(const GModelSky&    model,
                               const GObservation& obs,
                               GMatrix*            gradients = NULL) const;
    virtual GVector irf_elliptical(const GModelSky&    model,
                                   const GObservation& obs,
                                   GMatrix*            gradients = NULL) const;
    virtual GVector irf_diffuse(const GModelSky&    model,
                                const GObservation& obs,
                                GMatrix*            gradients = NULL) const;

    // Support methods
    GVector irf_extended(const GModelSky&    model,
                         const GObservation& obs,
                         const GSkyDir&      model_dir,
                         const double&       theta_max,
                         GMatrix*            gradients = NULL) const;

    // Private data members
    GCaldb              m_caldb;             //!< Calibration database
    std::string         m_rspname;           //!< Response name
    std::vector<double> m_iaq;               //!< IAQ array
    int                 m_phigeo_bins;       //!< Number of Phigeo bins
    int                 m_phibar_bins;       //!< Number of Phibar bins
    double              m_phigeo_ref_value;  //!< Phigeo reference value (deg)
    double              m_phigeo_ref_pixel;  //!< Phigeo reference pixel (starting from 1)
    double              m_phigeo_bin_size;   //!< Phigeo binsize (deg)
    double              m_phigeo_min;        //!< Phigeo value of first bin (deg)
    double              m_phibar_ref_value;  //!< Phigeo reference value (deg)
    double              m_phibar_ref_pixel;  //!< Phigeo reference pixel (starting from 1)
    double              m_phibar_bin_size;   //!< Phigeo binsize (deg)
    double              m_phibar_min;        //!< Phigeo value of first bin (deg)
};


/***********************************************************************//**
 * @brief Return class name
 *
 * @return String containing the class name ("GCOMResponse").
 ***************************************************************************/
inline
std::string GCOMResponse::classname(void) const
{
    return ("GCOMResponse");
}


/***********************************************************************//**
 * @brief Signal if energy dispersion will be used
 *
 * @return False.
 ***************************************************************************/
inline
bool GCOMResponse::use_edisp(void) const
{
    return false;
}


/***********************************************************************//**
 * @brief Signal if time dispersion will be used
 *
 * @return False.
 ***************************************************************************/
inline
bool GCOMResponse::use_tdisp(void) const
{
    return false;
}


/***********************************************************************//**
 * @brief Return calibration database
 *
 * @return Calibration database.
 ***************************************************************************/
inline
const GCaldb& GCOMResponse::caldb(void) const
{
    return m_caldb;
}


/***********************************************************************//**
 * @brief Set calibration database
 *
 * @param[in] caldb Calibration database.
 *
 * Sets the calibration database for the COMPTEL response.
 ***************************************************************************/
inline
void GCOMResponse::caldb(const GCaldb& caldb)
{
    m_caldb = caldb;
    return;
}


/***********************************************************************//**
 * @brief Return response name
 *
 * @return Response name.
 ***************************************************************************/
inline
const std::string& GCOMResponse::rspname(void) const
{
    // Return response name
    return m_rspname;
}

#endif /* GCOMRESPONSE_HPP */