GCOSEventCube.hpp

Go to the documentation of this file.

/***************************************************************************
 *                GCOSEventCube.hpp - COSI event cube 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 GCOSEventCube.hpp
 * @brief COSI event bin container class definition
 * @author Juergen Knoedlseder
 */
 
#ifndef GCOSEVENTCUBE_HPP
#define GCOSEVENTCUBE_HPP
 
/* __ Includes ___________________________________________________________ */
#include <string>
#include <vector>
#include "GBounds.hpp"
#include "GEventCube.hpp"
#include "GCOSEventBin.hpp"
#include "GCOSInstDir.hpp"
#include "GSkyDir.hpp"
#include "GSkyMap.hpp"
#include "GEnergy.hpp"
#include "GTime.hpp"
 
/* __ Forward declarations _______________________________________________ */
class GFilename;
class GEbounds;
class GGti;
class GFits;
class GCOSEventList;
 
/* __ Constants __________________________________________________________ */
 
 
/***********************************************************************//**
 * @class GCOSEventCube
 *
 * @brief COSI event bin container class
 *
 * This class is a container class for COSI event bins.
 ***************************************************************************/
class GCOSEventCube : public GEventCube {
 
public:
    // Constructors and destructors
    GCOSEventCube(void);
    explicit GCOSEventCube(const GFilename& filename);
    GCOSEventCube(const std::string& coords,
                  const int&         nside,
                  const std::string& order,
                  const GBounds&     phibounds,
                  const GEbounds&    ebounds,
                  const GGti&        gti);
    GCOSEventCube(const GCOSEventCube& cube);
    virtual ~GCOSEventCube(void);
 
    // Operators
    virtual GCOSEventCube&      operator=(const GCOSEventCube& cube);
    virtual GCOSEventBin*       operator[](const int& index);
    virtual const GCOSEventBin* operator[](const int& index) const;
 
    // Implemented pure virtual base class methods
    virtual void           clear(void);
    virtual GCOSEventCube* clone(void) const;
    virtual std::string    classname(void) const;
    virtual int            size(void) const;
    virtual int            dim(void) const;
    virtual int            naxis(const int& axis) const;
    virtual void           load(const GFilename& filename);
    virtual void           save(const GFilename& filename,
                                const bool&      clobber = false) const;
    virtual void           read(const GFits& fits);
    virtual void           write(GFits& fits) const;
    virtual double         number(void) const;
    virtual std::string    print(const GChatter& chatter = NORMAL) const;
 
    // Other methods
    void           set(const std::string& coords,
                       const int&         nside,
                       const std::string& order,
                       const GBounds&     phibounds,
                       const GEbounds&    ebounds,
                       const GGti&        gti);
    const GSkyMap& cube(void) const;
    const GBounds& phibounds(void) const;
    const GTime&   time(void) const;
    const double&  ontime(void) const;
    const double&  solidangle(void) const;
    void           fill(const GCOSEventList& list);
 
protected:
    // Protected methods
    void         init_members(void);
    void         copy_members(const GCOSEventCube& cube);
    void         free_members(void);
    void         set_scatter_directions(void);
    void         set_scatter_angles(void);
    virtual void set_energies(void);
    virtual void set_times(void);
    void         init_bin(void);
    void         set_bin(const int& index);
 
    // Protected members
    GSkyMap              m_cube;        //!< Event cube
    GBounds              m_phibounds;   //!< Phi layer boundaries
    GCOSEventBin         m_bin;         //!< Current event bin
    GCOSInstDir          m_dir;         //!< Current event direction
    GTime                m_time;        //!< Event cube mean time
    double               m_ontime;      //!< Event cube ontime (sec)
    double               m_solidangle;  //!< Event bin solid angle (sr)
    int                  m_npix;        //!< Number of HealPix pixels
    int                  m_nphi;        //!< Number of Phi layers
    std::vector<GSkyDir> m_dirs;        //!< Cube pixel scatter directions
    std::vector<double>  m_phis;        //!< Array of scatter angles
    std::vector<double>  m_phiwidths;   //!< Array of scatter angles bin widths
    std::vector<GEnergy> m_energies;    //!< Cube energy bin mean energies
    std::vector<GEnergy> m_ewidths;     //!< Cube energy bin widths
 
    // Event filling statistics
    int m_num_events_checked;    //!< Number of checked events
    int m_num_events_used;       //!< Number of used events
    int m_num_outside_gti;       //!< Number of events outside GTI
    int m_num_outside_ebounds;   //!< Number of events outside energy boundaries
    int m_num_outside_phibounds; //!< Number of events outside scatter angle bounds.
};
 
 
/***********************************************************************//**
 * @brief Return class name
 *
 * @return String containing the class name ("GCOSEventCube").
 ***************************************************************************/
inline
std::string GCOSEventCube::classname(void) const
{
    return ("GCOSEventCube");
}
 
 
/***********************************************************************//**
 * @brief Return event cube
 *
 * @return Event cube.
 ***************************************************************************/
inline
const GSkyMap& GCOSEventCube::cube(void) const
{
    return (m_cube);
}
 
 
/***********************************************************************//**
 * @brief Return Phi boundaries
 *
 * @return Phi boundaries.
 ***************************************************************************/
inline
const GBounds& GCOSEventCube::phibounds(void) const
{
    return (m_phibounds);
}
 
 
/***********************************************************************//**
 * @brief Return event cube time
 *
 * @return Event cube time.
 ***************************************************************************/
inline
const GTime& GCOSEventCube::time(void) const
{
    return (m_time);
}
 
 
/***********************************************************************//**
 * @brief Return event cube ontime
 *
 * @return Event cube ontime.
 ***************************************************************************/
inline
const double& GCOSEventCube::ontime(void) const
{
    return (m_ontime);
}
 
 
/***********************************************************************//**
 * @brief Return event cube pixels solid angles
 *
 * @return Event cube  pixels solid angles.
 ***************************************************************************/
inline
const double& GCOSEventCube::solidangle(void) const
{
    return (m_solidangle);
}
 
#endif /* GCOSEVENTCUBE_HPP */