GCOSResponse.hpp

Go to the documentation of this file.

/***************************************************************************
 *                  GCOSResponse.hpp - COSI response class                 *
 * ----------------------------------------------------------------------- *
 *  copyright (C) 2026 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 GCOSResponse.hpp
 * @brief COSI instrument response function class definition
 * @author Juergen Knoedlseder
 */
 
#ifndef GCOSRESPONSE_HPP
#define GCOSRESPONSE_HPP
 
/* __ Includes ___________________________________________________________ */
#include <stdint.h>       // uint16_t
#include "GNdarray.hpp"
#include "GBounds.hpp"
#include "GHdf5.hpp"
#include "GFilename.hpp"
#include "GEbounds.hpp"
#include "GHealpix.hpp"
#include "GResponse.hpp"
 
/* __ Forward declaration ________________________________________________ */
class GEvent;
class GPhoton;
class GEnergy;
class GTime;
class GSource;
class GObservation;
class GModelSky;
 
/* __ Constants __________________________________________________________ */
 
 
/***********************************************************************//**
 * @class GCOSResponse
 *
 * @brief COSI instrument response function class
 *
 * The COSI instrument response function class defines the function
 * that translates from physical quantities to measured quantities.
 *
 * @todo Complete the class description.
 ***************************************************************************/
class GCOSResponse : public GResponse {
 
public:
    // Constructors and destructors
    GCOSResponse(void);
    GCOSResponse(const GFilename& filename);
    GCOSResponse(const GCOSResponse& rsp);
    virtual ~GCOSResponse(void);
 
    // Operators
    virtual GCOSResponse& operator=(const GCOSResponse & rsp);
 
    // Implement pure virtual base class methods
    virtual void          clear(void);
    virtual GCOSResponse* 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
    const GFilename&      rspfile(void) const;
    const GHdf5&          hdf5(void) const;
    const GHealpix&       src_dirs(void) const;
    const GEbounds&       src_ebounds(void) const;
    const GBounds&        src_polarisations(void) const;
    const GHealpix&       obs_dirs(void) const;
    const GBounds&        obs_phis(void) const;
    const GEbounds&       obs_ebounds(void) const;
    const GNdarray&       eff_areas(void) const;
    int                   get_response_chunk(const int& idir,
                                             const int& ieng = 0,
                                             const int& ipol = 0) const;
    void                  load(const GFilename& filename);
    void                  save(const GFilename& filename,
                               const bool&      clobber = false) const;
    void                  read(const GFits& fits);
    void                  write(GFits& fits) const;
 
private:
    // Private methods
    void               init_members(void);
    void               copy_members(const GCOSResponse& rsp);
    void               free_members(void);
    void               read_response(FILE* fptr);
    GBounds            read_bounds(FILE*              fptr,
                                   const GXmlElement* dataspace,
                                   const GXmlElement* datatype,
                                   const GXmlElement* datalayout);
    GEbounds           read_ebounds(FILE*              fptr,
                                    const GXmlElement* dataspace,
                                    const GXmlElement* datatype,
                                    const GXmlElement* datalayout,
                                    const std::string& unit);
    GNdarray           read_ndarray(FILE*              fptr,
                                    const GXmlElement* dataspace,
                                    const GXmlElement* datatype,
                                    const GXmlElement* datalayout);
    void               read_response_matrix(FILE*              fptr,
                                            const GXmlElement* dataspace,
                                            const GXmlElement* datatype,
                                            const GXmlElement* datalayout,
                                            const GXmlElement* datafilter);
    void               set_response_chunk_pointers(void);
    const GXmlElement* get_response_chunk_key(const int& idir,
                                              const int& ieng = 0,
                                              const int& ipol = 0) const;
    int                get_response_chunk_index(const int& idir,
                                                const int& ieng = 0,
                                                const int& ipol = 0) const;
    int                flat_index(const int& idir,
                                  const int& ieng = 0,
                                  const int& ipol = 0) const;
 
    // Private data members
    GFilename m_rspfile;     //!< Response file name
    GHdf5     m_hdf5;        //!< HDF5 file
    GHealpix  m_src_dirs;    //!< Sky projection for source photons
    GEbounds  m_src_ebounds; //!< Energy boundaries for source photons
    GBounds   m_src_pols;    //!< Boundaries for observed polarisation
    GHealpix  m_obs_dirs;    //!< Sky projection for observed events
    GBounds   m_obs_phis;    //!< Boundaries for observed scatter angles
    GEbounds  m_obs_ebounds; //!< Energy boundaries for observed events
    GNdarray  m_eff_areas;   //!< Array of effective areas
 
    // Private data members for response chunk handling
    const GXmlElement*                          m_rsp_chunk_dataspace;  //!< Data space
    const GXmlElement*                          m_rsp_chunk_datatype;   //!< Data type
    const GXmlElement*                          m_rsp_chunk_datalayout; //!< Data layout
    const GXmlElement*                          m_rsp_chunk_datafilter; //!< Data filter
    mutable std::vector<int>                    m_rsp_chunk_indices;    //!< Loaded indices
    mutable std::vector<std::vector<uint16_t> > m_rsp_chunks;           //!< Loaded chunks
};
 
 
/***********************************************************************//**
 * @brief Return class name
 *
 * @return String containing the class name ("GCOSResponse").
 ***************************************************************************/
inline
std::string GCOSResponse::classname(void) const
{
    return ("GCOSResponse");
}
 
 
/***********************************************************************//**
 * @brief Signal if energy dispersion will be used
 *
 * @return False.
 *
 * @todo Implement method as needed.
 ***************************************************************************/
inline
bool GCOSResponse::use_edisp(void) const
{
    return false;
}
 
 
/***********************************************************************//**
 * @brief Signal if time dispersion will be used
 *
 * @return False.
 *
 * @todo Implement method as needed.
 ***************************************************************************/
inline
bool GCOSResponse::use_tdisp(void) const
{
    return false;
}
 
 
/***********************************************************************//**
 * @brief Return response file name
 *
 * @return Response file name.
 *
 * Returns the file name from which the response was loaded. This may either
 * be a HDF5 file or a FITS file.
 ***************************************************************************/
inline
const GFilename& GCOSResponse::rspfile(void) const
{
    // Return response file name
    return (m_rspfile);
}
 
 
/***********************************************************************//**
 * @brief Return HDF5 file
 *
 * @return HDF5 file.
 *
 * Returns the HDF5 file that was loaded from a COSI response file.
 ***************************************************************************/
inline
const GHdf5& GCOSResponse::hdf5(void) const
{
    return (m_hdf5);
}
 
 
/***********************************************************************//**
 * @brief Return HealPix projection of true photon directions
 *
 * @return HealPix projection of true photon directions.
 *
 * Returns the HealPix projection of true photon directions that was loaded
 * from a COSI response file.
 ***************************************************************************/
inline
const GHealpix& GCOSResponse::src_dirs(void) const
{
    return (m_src_dirs);
}
 
 
/***********************************************************************//**
 * @brief Return true photon energy boundaries
 *
 * @return True photon energy boundaries.
 *
 * Returns the true photon energy boundaries that were loaded from a COSI
 * response file.
 ***************************************************************************/
inline
const GEbounds& GCOSResponse::src_ebounds(void) const
{
    return (m_src_ebounds);
}
 
 
/***********************************************************************//**
 * @brief Return true polarisation angle boundaries
 *
 * @return True polarisation angle boundaries.
 *
 * Returns the true polarisation angle boundaries that were loaded from a
 * COSI response file.
 ***************************************************************************/
inline
const GBounds& GCOSResponse::src_polarisations(void) const
{
    return (m_src_pols);
}
 
 
/***********************************************************************//**
 * @brief Return HealPix projection of measured scatter directions
 *
 * @return HealPix projection of measured scatter directions.
 *
 * Returns the HealPix projection of measured scatter directions that was
 * loaded from a COSI response file.
 ***************************************************************************/
inline
const GHealpix& GCOSResponse::obs_dirs(void) const
{
    return (m_obs_dirs);
}
 
 
/***********************************************************************//**
 * @brief Return measured scatter angle boundaries
 *
 * @return Measured scatter angle boundaries.
 *
 * Returns the measured scatter angle boundaries that were loaded from a
 * COSI response file.
 ***************************************************************************/
inline
const GBounds& GCOSResponse::obs_phis(void) const
{
    return (m_obs_phis);
}
 
 
/***********************************************************************//**
 * @brief Return measured event energy boundaries
 *
 * @return Measured event energy boundaries.
 *
 * Returns the measured event energy boundaries that were loaded from a COSI
 * response file.
 ***************************************************************************/
inline
const GEbounds& GCOSResponse::obs_ebounds(void) const
{
    return (m_obs_ebounds);
}
 
 
/***********************************************************************//**
 * @brief Return effective area array
 *
 * @return Effective area array.
 *
 * Returns the effective area array that was loaded from a COSI response
 * file.
 ***************************************************************************/
inline
const GNdarray& GCOSResponse::eff_areas(void) const
{
    return (m_eff_areas);
}
 
#endif /* GCOSRESPONSE_HPP */