GCOSInstDir.hpp

Go to the documentation of this file.

/***************************************************************************
 *            GCOSInstDir.hpp - COSI instrument direction 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 GCOSInstDir.hpp
 * @brief COSI instrument direction class definition
 * @author Juergen Knoedlseder
 */
 
#ifndef GCOSINSTDIR_HPP
#define GCOSINSTDIR_HPP
 
/* __ Includes ___________________________________________________________ */
#include <string>
#include <sys/types.h>
#if defined(__sun) && (defined(__svr4__) || defined(__SVR4)) // SOLARIS
    typedef uint64_t u_int64_t;
#endif // SOLARIS
#include "GInstDir.hpp"
#include "GSkyDir.hpp"
 
/* __ Forward declarations _______________________________________________ */
 
/* __ Constants __________________________________________________________ */
 
 
/***********************************************************************//**
 * @class GCOSInstDir
 *
 * @brief COSI instrument direction class
 *
 * The COSI instrument direction defines the spatial information
 * associated to an event.
 ***************************************************************************/
class GCOSInstDir : public GInstDir {
 
public:
    // Constructors and destructors
    GCOSInstDir(void);
    GCOSInstDir(const GCOSInstDir& dir);
    GCOSInstDir(const GSkyDir& dir, const GSkyDir& dir_local, const double& phi);
    virtual ~GCOSInstDir(void);
 
    // Operators
    GCOSInstDir& operator=(const GCOSInstDir& dir);
 
    // Implemented pure virtual base class methods
    virtual void         clear(void);
    virtual GCOSInstDir* clone(void) const;
    virtual std::string  classname(void) const;
    virtual u_int64_t    hash(void) const;
    virtual std::string  print(const GChatter& chatter = NORMAL) const;
 
    // Other methods
    void           dir(const GSkyDir& dir);
    const GSkyDir& dir(void) const;
    void           dir_local(const GSkyDir& dir);
    const GSkyDir& dir_local(void) const;
    void           phi(const double& phi);
    const double&  phi(void) const;
 
protected:
    // Protected methods
    void init_members(void);
    void copy_members(const GCOSInstDir& dir);
    void free_members(void);
 
    // Protected members
    GSkyDir m_dir;       //!< Observed scatter direction of event in celestial coordinates
    GSkyDir m_dir_local; //!< Observed scatter direction of event in local coordinates
    double  m_phi;       //!< Observed scatter angle of event (deg)
};
 
 
/***********************************************************************//**
 * @brief Return class name
 *
 * @return String containing the class name ("GCOSInstDir").
 ***************************************************************************/
inline
std::string GCOSInstDir::classname(void) const
{
    return ("GCOSInstDir");
}
 
 
/***********************************************************************//**
 * @brief Return event scatter direction in celestial coordinates
 *
 * @return Event scatter direction in celestial coordinates.
 *
 * Returns the event scatter direction in celestial coordinates.
 ***************************************************************************/
inline
const GSkyDir& GCOSInstDir::dir(void) const
{
    return (m_dir);
}
 
 
/***********************************************************************//**
 * @brief Set event scatter direction in celestial coordinates
 *
 * @param[in] dir Event scatter direction in celestial coordinates.
 *
 * Set the event scatter direction in celestial coordinates.
 ***************************************************************************/
inline
void GCOSInstDir::dir(const GSkyDir& dir)
{
    m_dir = dir;
    return;
}
 
 
/***********************************************************************//**
 * @brief Return event scatter direction in spacecraft coordinates
 *
 * @return Event scatter direction in spacecraft coordinates.
 *
 * Returns the event scatter direction in spacecraft coordinates.
 ***************************************************************************/
inline
const GSkyDir& GCOSInstDir::dir_local(void) const
{
    return (m_dir_local);
}
 
 
/***********************************************************************//**
 * @brief Set event scatter direction in spacecraft coordinates
 *
 * @param[in] dir Event scatter direction in spacecraft coordinates.
 *
 * Set the event scatter direction in spacecraft coordinates.
 ***************************************************************************/
inline
void GCOSInstDir::dir_local(const GSkyDir& dir)
{
    m_dir_local = dir;
    return;
}
 
 
/***********************************************************************//**
 * @brief Return event Compton scatter angle
 *
 * @return Event Compton scatter angle (deg).
 *
 * Returns the event Compton scatter angle.
 ***************************************************************************/
inline
const double& GCOSInstDir::phi(void) const
{
    return (m_phi);
}
 
 
/***********************************************************************//**
 * @brief Set event Compton scatter angle
 *
 * @param[in] phi Event Compton scatter angle (deg).
 *
 * Set the event Compton scatter angle.
 ***************************************************************************/
inline
void GCOSInstDir::phi(const double& phi)
{
    m_phi = phi;
    return;
}
 
#endif /* GCOSINSTDIR_HPP */