GCOSSpaceCraft.hpp

Go to the documentation of this file.

/***************************************************************************
 *              GCOSSpaceCraft.hpp - COSI space craft 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 GCOSSpaceCraft.hpp
 * @brief COSI space craft class definition
 * @author Juergen Knoedlseder
 */
 
#ifndef GCOSSPACECRAFT_HPP
#define GCOSSPACECRAFT_HPP
 
/* __ Includes ___________________________________________________________ */
#include <string>
#include <vector>
#include "GBase.hpp"
#include "GGti.hpp"
#include "GCOSPointing.hpp"
 
/* __ Forward declaration ________________________________________________ */
class GSkyDir;
class GSkyMap;
class GFits;
class GFilename;
 
/* __ Constants __________________________________________________________ */
 
 
/***********************************************************************//**
 * @class GCOSSpaceCraft
 *
 * @brief COSI space craft class
 *
 * The COSI space craft class provides spacecraft attitude and detector
 * livetime information as function of time.
 ***************************************************************************/
class GCOSSpaceCraft : public GBase {
 
public:
    // Constructors and destructors
    GCOSSpaceCraft(void);
    explicit GCOSSpaceCraft(const GFilename& filename);
    GCOSSpaceCraft(const GCOSSpaceCraft& spacecraft);
    virtual ~GCOSSpaceCraft(void);
 
    // Operators
    GCOSSpaceCraft&     operator=(const GCOSSpaceCraft& spacecraft);
    GCOSPointing&       operator[](const int& index);
    const GCOSPointing& operator[](const int& index) const;
 
    // Methods
    void                       clear(void);
    GCOSSpaceCraft*            clone(void) const;
    std::string                classname(void) const;
    bool                       is_empty(void) const;
    int                        size(void) const;
    const GGti&                gti(void) const;
    const std::vector<double>& livetimes(void) const;
    const double&              ontime(void) const;
    const double&              livetime(void) const;
    double                     livetime(const GSkyDir& dir) const;
    GSkyMap                    livetime(const GSkyMap& map) const;
    const double&              deadc(void) const;
    void                       load(const GFilename& filename);
    void                       save(const GFilename& filename,
                                    const bool&      clobber = false) const;
    void                       read(const GFits& fits);
    void                       write(GFits& fits) const;
    std::string                print(const GChatter& chatter = NORMAL) const;
 
protected:
    // Protected methods
    void init_members(void);
    void copy_members(const GCOSSpaceCraft& spacecraft);
    void free_members(void);
    void load_ori(const GFilename& filename);
    void load_fits(const GFilename& filename);
    void read_pointings(const GFits& fits);
    void read_livetimes(const GFits& fits);
    void write_pointings(GFits& fits) const;
    void write_livetimes(GFits& fits) const;
 
    // Protected members
    GGti                      m_gti;       //!< Good Time Intervals
    std::vector<double>       m_livetimes; //!< Livetimes for each Good Time Interval (sec)
    std::vector<GCOSPointing> m_pointings; //!< Pointings
    double                    m_ontime;    //!< Ontime (sec)
    double                    m_livetime;  //!< Livetime (sec)
    double                    m_deadc;     //!< Deadtime correction
};
 
 
/***********************************************************************//**
 * @brief Return class name
 *
 * @return String containing the class name ("GCOSSpaceCraft").
 ***************************************************************************/
inline
std::string GCOSSpaceCraft::classname(void) const
{
    return ("GCOSSpaceCraft");
}
 
 
/***********************************************************************//**
 * @brief Signals whether there are no pointing entries
 *
 * @return True if instance does not hold any pointing entries.
 ***************************************************************************/
inline
bool GCOSSpaceCraft::is_empty(void) const
{
    return (m_pointings.empty());
}
 
 
/***********************************************************************//**
 * @brief Return number of pointing entries
 *
 * @return Number of pointing entries.
 ***************************************************************************/
inline
int GCOSSpaceCraft::size(void) const
{
    return (m_pointings.size());
}
 
 
/***********************************************************************//**
 * @brief Return Good Time Intervals
 *
 * @return Good Time Intervals.
 ***************************************************************************/
inline
const GGti& GCOSSpaceCraft::gti(void) const
{
    return (m_gti);
}
 
 
/***********************************************************************//**
 * @brief Return vector of livetimes
 *
 * @return Vector of livetimes.
 ***************************************************************************/
inline
const std::vector<double>& GCOSSpaceCraft::livetimes(void) const
{
    return (m_livetimes);
}
 
 
/***********************************************************************//**
 * @brief Return ontime in seconds
 *
 * @return Ontime (sec).
 ***************************************************************************/
inline
const double& GCOSSpaceCraft::ontime(void) const
{
    return (m_ontime);
}
 
 
/***********************************************************************//**
 * @brief Return livetime in seconds
 *
 * @return Livetime (sec).
 ***************************************************************************/
inline
const double& GCOSSpaceCraft::livetime(void) const
{
    return (m_livetime);
}
 
 
/***********************************************************************//**
 * @brief Return deadtime correction factor
 *
 * @return Deadtime correction factor.
 ***************************************************************************/
inline
const double& GCOSSpaceCraft::deadc(void) const
{
    return (m_deadc);
}
 
#endif /* GCOSSPACECRAFT_HPP */