GCOSRoi.cpp

Go to the documentation of this file.

/***************************************************************************
 *               GCOSRoi.cpp - 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.cpp
 * @brief COSI region of interest class implementation
 * @author Juergen Knoedlseder
 */
 
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "GEvent.hpp"
#include "GCOSRoi.hpp"
#include "GCOSInstDir.hpp"
 
/* __ Method name definitions ____________________________________________ */
 
/* __ Macros _____________________________________________________________ */
 
/* __ Coding definitions _________________________________________________ */
#define G_RADIUS                                   "GCOSRoi::radius(double&)"
 
/* __ Debug definitions __________________________________________________ */
 
 
 
/*==========================================================================
 =                                                                         =
 =                         Constructors/destructors                        =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Void constructor
 ***************************************************************************/
GCOSRoi::GCOSRoi(void) : GRoi()
{
    // Initialise class members
    init_members();
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Radius constructor
 *
 * @param[in] radius Region of interest radius
 ***************************************************************************/
GCOSRoi::GCOSRoi(const double& radius) : GRoi()
{
    // Initialise class members
    init_members();
 
    // Set radius
    this->radius(radius);
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Copy constructor
 *
 * @param[in] roi COSI region of interest.
 ***************************************************************************/
GCOSRoi::GCOSRoi(const GCOSRoi& roi) : GRoi(roi)
{
    // Initialise class members
    init_members();
 
    // Copy members
    copy_members(roi);
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Destructor
 ***************************************************************************/
GCOSRoi::~GCOSRoi(void)
{
    // Free members
    free_members();
 
    // Return
    return;
}
 
 
/*==========================================================================
 =                                                                         =
 =                               Operators                                 =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Assignment operator
 *
 * @param[in] roi COSI region of interest.
 * @return COSI region of interest.
 ***************************************************************************/
GCOSRoi& GCOSRoi::operator=(const GCOSRoi& roi)
{
    // Execute only if object is not identical
    if (this != &roi) {
 
        // Copy base class members
        this->GRoi::operator=(roi);
 
        // Free members
        free_members();
 
        // Initialise private members
        init_members();
 
        // Copy members
        copy_members(roi);
 
    } // endif: object was not identical
 
    // Return this object
    return *this;
}
 
 
/*==========================================================================
 =                                                                         =
 =                             Public methods                              =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Clear region of interest
 ***************************************************************************/
void GCOSRoi::clear(void)
{
    // Free members
    free_members();
    this->GRoi::free_members();
 
    // Initialise private members
    this->GRoi::init_members();
    init_members();
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Clone region of interest
 *
 * @return Pointer to deep copy of COSI region of interest.
 ***************************************************************************/
GCOSRoi* GCOSRoi::clone(void) const
{
    return new GCOSRoi(*this);
}
 
 
/***********************************************************************//**
 * @brief Check if region of interest contains an event
 *
 * @return True if region of interest contains event, false otherwise.
 *
 * This method checks whether an event is contained in the region of interest.
 * As COSI regions of interest are always 180 deg an event is always
 * contained in the region in case that a region of interest is defined (i.e.
 * it has a radius of 180 deg).
 *
 * If the instrument direction of the event is not of type GCOSInstDir then
 * the method returns false.
 ***************************************************************************/
bool GCOSRoi::contains(const GEvent& event) const
{
    // Initialise flag to non-containment
    bool contains = false;
 
    // Get pointer to COSI instrument direction
    const GCOSInstDir* dir = dynamic_cast<const GCOSInstDir*>(&event.dir());
 
    // If instrument direction is a COSI instrument direction then check on
    // containment
    if (dir != NULL) {
 
        // If region of interest radius is 180 deg then instrument direction
        // is certainty contained into the region
        if (m_radius == 180.0) {
            contains = true;
        }
 
    } // endif: pointer was a COSI instrument direction
 
    // Return containment flag
    return contains;
}
 
 
/***********************************************************************//**
 * @brief Set radius of region of interest
 *
 * @param[in] radius Region of interest radius (degrees).
 *
 * @exception GException::invalid_argument
 *            ROI radius is not 0 or 180 degrees.
 *
 * Set the radius of the region of interest.
 ***************************************************************************/
void GCOSRoi::radius(const double& radius)
{
    // Throw an exception if argument is not valid
    if ((radius != 0.0) && (radius != 180.0)) {
        std::string msg = "Invalid RoI radius "+gammalib::str(radius)+
                          " specified. The radius must be either 0 or 180"
                          " degrees.";
        throw GException::invalid_argument(G_RADIUS, msg);
    }
 
    // Set radius value
    m_radius = radius;
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Print region of interest information
 *
 * @param[in] chatter Chattiness.
 * @return String containing region of interest information.
 ***************************************************************************/
std::string GCOSRoi::print(const GChatter& chatter) const
{
    // Initialise result string
    std::string result;
 
    // Continue only if chatter is not silent
    if (chatter != SILENT) {
 
        // Append header
        result.append("=== GCOSRoi ===");
 
        // Append information
        result.append("\n"+gammalib::parformat("RoI radius"));
        result.append(gammalib::str(m_radius)+" deg");
 
    } // endif: chatter was not silent
 
    // Return result
    return result;
}
 
 
/*==========================================================================
 =                                                                         =
 =                             Private methods                             =
 =                                                                         =
 ==========================================================================*/
 
/***********************************************************************//**
 * @brief Initialise class members
 ***************************************************************************/
void GCOSRoi::init_members(void)
{
    // Initialise members
    m_radius = 0.0;
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Copy class members
 *
 * @param[in] roi COSI region of interest.
 ***************************************************************************/
void GCOSRoi::copy_members(const GCOSRoi& roi)
{
    // Copy members
    m_radius = roi.m_radius;
 
    // Return
    return;
}
 
 
/***********************************************************************//**
 * @brief Delete class members
 ***************************************************************************/
void GCOSRoi::free_members(void)
{
    // Return
    return;
}