GCOSEventList.hpp

Go to the documentation of this file.

/***************************************************************************
 *                GCOSEventList.hpp - COSI event list 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 GCOSEventList.hpp
 * @brief COSI event list class definition
 * @author Juergen Knoedlseder
 */
 
#ifndef GCOSEVENTLIST_HPP
#define GCOSEVENTLIST_HPP
 
/* __ Includes ___________________________________________________________ */
#include <string>
#include <vector>
#include "GEventList.hpp"
#include "GCOSEventAtom.hpp"
#include "GCOSRoi.hpp"
 
/* __ Forward declarations _______________________________________________ */
class GRoi;
class GFits;
class GFilename;
 
/* __ Constants __________________________________________________________ */
 
 
/***********************************************************************//**
 * @class GCOSEventList
 *
 * @brief COSI event list class
 ***************************************************************************/
class GCOSEventList : public GEventList {
 
public:
    // Constructors and destructors
    GCOSEventList(void);
    explicit GCOSEventList(const GFilename& filename);
    GCOSEventList(const GCOSEventList& list);
    virtual ~GCOSEventList(void);
 
    // Operators
    virtual GCOSEventList&       operator=(const GCOSEventList& list);
    virtual GCOSEventAtom*       operator[](const int& index);
    virtual const GCOSEventAtom* operator[](const int& index) const;
 
    // Implemented pure virtual base class methods
    virtual void           clear(void);
    virtual GCOSEventList* clone(void) const;
    virtual std::string    classname(void) const;
    virtual int            size(void) 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 void           roi(const GRoi& roi);
    virtual const GCOSRoi& roi(void) const;
    virtual std::string    print(const GChatter& chatter = NORMAL) const;
 
    // Other methods
    void append(const GCOSEventAtom& event);
    void extend(const GCOSEventList& list);
    void reserve(const int& number);
    void remove(const int& index, const int& number = 1);
    void sort(void);
 
protected:
    // Protected methods
    void         init_members(void);
    void         copy_members(const GCOSEventList& list);
    void         free_members(void);
    virtual void set_energies(void);
    virtual void set_times(void);
 
    // Protected members
    GCOSRoi                    m_roi;          //!< Region of interest
    std::vector<GCOSEventAtom> m_events;       //!< Events
};
 
 
/***********************************************************************//**
 * @brief Return class name
 *
 * @return String containing the class name ("GCOSEventList").
 ***************************************************************************/
inline
std::string GCOSEventList::classname(void) const
{
    return ("GCOSEventList");
}
 
 
/***********************************************************************//**
 * @brief Return number of events in list
 *
 * @return Number of events in list.
 ***************************************************************************/
inline
int GCOSEventList::size(void) const
{
    return (int)m_events.size();
}
 
 
/***********************************************************************//**
 * @brief Return number of events in list
 *
 * @return Number of events in list.
 ***************************************************************************/
inline
double GCOSEventList::number(void) const
{
    return (double)m_events.size();
}
 
 
/***********************************************************************//**
 * @brief Return Region of Interest
 *
 * @return Region of Interest.
 ***************************************************************************/
inline
const GCOSRoi& GCOSEventList::roi(void) const
{
    return m_roi;
}
 
 
/***********************************************************************//**
 * @brief Reserves space for events
 *
 * @param[in] number Number of events.
 *
 * Reserves space for a @p number events in the event list.
 ***************************************************************************/
inline
void GCOSEventList::reserve(const int& number)
{
    m_events.reserve(number);
    return;
}
 
 
/***********************************************************************//**
 * @brief Set energies
 *
 * Sets energies.
 ***************************************************************************/
inline
void GCOSEventList::set_energies(void)
{
    return;
}
 
 
/***********************************************************************//**
 * @brief Set times
 *
 * Sets times.
 ***************************************************************************/
inline
void GCOSEventList::set_times(void)
{
    return;
}
 
#endif /* GLATEVENTLIST_HPP */