GCOSEventBin.hpp

Go to the documentation of this file.

/***************************************************************************
 *                 GCOSEventBin.hpp - COSI event bin 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 GCOSEventBin.hpp
 * @brief COSI event bin class definition
 * @author Juergen Knoedlseder
 */
 
#ifndef GCOSEVENTBIN_HPP
#define GCOSEVENTBIN_HPP
 
/* __ Includes ___________________________________________________________ */
#include "GEventBin.hpp"
#include "GEnergy.hpp"
#include "GTime.hpp"
#include "GCOSInstDir.hpp"
 
/* __ Forward declarations _______________________________________________ */
 
/* __ Constants __________________________________________________________ */
 
 
/***********************************************************************//**
 * @class GCOSEventBin
 *
 * @brief COSI event bin class
 *
 * This class defines an event bin of the COSI event cube.
 *
 * Since many event bins share the same attributes (for example many bins
 * will actually have the same energy), it would be a waste of memory to
 * store all bin attributes together with the bin. Therefore, the
 * GCOSEventBin class implements it's own memory management. Either the
 * class allocates memory for all attributes, or it takes pointers to
 * GCOSEventCube class members that store the information in an efficient
 * way.
 *
 * The data member m_alloc signals in which mode the bin operates. If true,
 * GCOSEventBin has allocated itself the memory for all attributes, and
 * hence has to take care about the memory allocation upon destruction.
 * Otherwise the pointers are just released.
 ***************************************************************************/
class GCOSEventBin : public GEventBin {
 
    // Friend classes
    friend class GCOSEventCube;
 
public:
    // Constructors and destructors
    GCOSEventBin(void);
    GCOSEventBin(const GCOSEventBin& bin);
    virtual ~GCOSEventBin(void);
 
    // Operators
    virtual GCOSEventBin& operator=(const GCOSEventBin& bin);
 
    // Implemented pure virtual base class methods
    virtual void               clear(void);
    virtual GCOSEventBin*      clone(void) const;
    virtual std::string        classname(void) const;
    virtual double             size(void) const;
    virtual const GCOSInstDir& dir(void) const;
    virtual const GEnergy&     energy(void) const;
    virtual const GTime&       time(void) const;
    virtual double             counts(void) const;
    virtual double             error(void) const;
    virtual void               counts(const double& counts);
    virtual std::string        print(const GChatter& chatter = NORMAL) const;
 
    // Other methods
    const int&     index(void) const;
    double         chi(void) const;
    double         psi(void) const;
    const double&  phi(void) const;
    const double&  solidangle(void) const;
    const double&  phiwidth(void) const;
    const GEnergy& ewidth(void) const;
    const double&  ontime(void) const;
    void           index(const int& index);
    void           dir(const GCOSInstDir& dir);
    void           dir(const double& chi, const double& psi, const double& phi);
    void           energy(const GEnergy& energy);
    void           time(const GTime& time);
    void           solidangle(const double& solidangle);
    void           phiwidth(const double& phiwidth);
    void           ewidth(const GEnergy& ewidth);
    void           ontime(const double& ontime);
 
protected:
    // Protected methods
    void init_members(void);
    void copy_members(const GCOSEventBin& bin);
    void free_members(void);
 
    // Protected members
    bool         m_alloc;       //!< Signals proper memory allocation
    int          m_index;       //!< Dataspace index
    double*      m_counts;      //!< Pointer to number of counts
    GCOSInstDir* m_dir;         //!< Pointer to bin direction
    double*      m_solidangle;  //!< Pointer to solid angle of pixel (sr)
    GTime*       m_time;        //!< Pointer to bin time
    double*      m_ontime;      //!< Pointer to ontime of bin (seconds)
    double*      m_phiwidth;    //!< Pointer to Phi width
    GEnergy*     m_energy;      //!< Pointer to bin energy
    GEnergy*     m_ewidth;      //!< Pointer to energy width of bin
};
 
 
/***********************************************************************//**
 * @brief Return class name
 *
 * @return String containing the class name ("GCOSEventBin").
 ***************************************************************************/
inline
std::string GCOSEventBin::classname(void) const
{
    return ("GCOSEventBin");
}
 
 
/***********************************************************************//**
 * @brief Return bin index
 *
 * @return Bin index.
 *
 * Returns the index of the event bin if the bin is part of an event cube. If
 * the event is not part of an event cube, -1 is returned.
 ***************************************************************************/
inline
const int& GCOSEventBin::index(void) const
{
    return (m_index);
}
 
 
/***********************************************************************//**
 * @brief Set bin index
 *
 * @param[in] index Bin index.
 *
 * Set the index of the event bin if the bin is part of an event cube. If
 * the event is not part of an event cube the index should be set to -1.
 ***************************************************************************/
inline
void GCOSEventBin::index(const int& index)
{
    m_index = index;
    return;
}
 
#endif /* GCOSEVENTBIN_HPP */