GCOSRoi.hpp

Go to the documentation of this file.

/***************************************************************************
 *               GCOSRoi.hpp - COSI region of interest 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 GCOSRoi.hpp
 * @brief COSI region of interest class definition
 * @author Juergen Knoedlseder
 */
 
#ifndef GCOSROI_HPP
#define GCOSROI_HPP
 
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GRoi.hpp"
 
/* __ Forward declaration ________________________________________________ */
class GEvent;
 
/* __ Constants __________________________________________________________ */
 
 
/***********************************************************************//**
 * @class GCOSRoi
 *
 * @brief COSI region of interest class
 *
 * The COSI region of interest class defines the event direction region that
 * is used for unbinned data analysis. By definition, COSI is always doing
 * an allsky analysis, hence the class simply sets the radius to 180 deg
 * once the region is defined.
 ***************************************************************************/
class GCOSRoi : public GRoi {
 
public:
    // Constructors and destructors
    GCOSRoi(void);
    explicit GCOSRoi(const double& radius);
    GCOSRoi(const GCOSRoi& roi);
    virtual ~GCOSRoi(void);
 
    // Operators
    GCOSRoi& operator=(const GCOSRoi& roi);
 
    // Implemented pure virtual base class methods
    virtual void        clear(void);
    virtual GCOSRoi*    clone(void) const;
    virtual std::string classname(void) const;
    virtual bool        contains(const GEvent& event) const;
    virtual std::string print(const GChatter& chatter = NORMAL) const;
 
    // Other methods
    const double& radius(void) const;
    void          radius(const double& radius);
 
protected:
    // Protected methods
    void init_members(void);
    void copy_members(const GCOSRoi& roi);
    void free_members(void);
 
    // Protected members
    double m_radius; //!< Region of interest radius
};
 
 
/***********************************************************************//**
 * @brief Return class name
 *
 * @return String containing the class name ("GCOSRoi").
 ***************************************************************************/
inline
std::string GCOSRoi::classname(void) const
{
    return ("GCOSRoi");
}
 
 
/***********************************************************************//**
 * @brief Returns region of interest radius
 *
 * @return Region of interest radius (degrees).
 *
 * Returns the radius of the region of interest in degrees.
 ***************************************************************************/
inline
const double& GCOSRoi::radius(void) const
{
    return (m_radius);
}
 
#endif /* GCOSROI_HPP */