GCOSObservation.hpp

Go to the documentation of this file.

/***************************************************************************
 *               GCOSObservation.hpp - COSI observation 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 GCOSObservation.hpp
 * @brief COSI observation class definition
 * @author Juergen Knoedlseder
 */
 
#ifndef GCOSOBSERVATION_HPP
#define GCOSOBSERVATION_HPP
 
/* __ Includes ___________________________________________________________ */
#include <string>
#include <vector>
#include "GFilename.hpp"
#include "GObservation.hpp"
#include "GCOSResponse.hpp"
#include "GCOSSpaceCraft.hpp"
#include "GCOSEventList.hpp"
#include "GCOSEventCube.hpp"
 
/* __ Forward declarations _______________________________________________ */
class GTime;
class GResponse;
class GXmlElement;
 
/* __ Constants __________________________________________________________ */
 
 
/***********************************************************************//**
 * @class GCOSObservation
 *
 * @brief COSI observation class
 *
 * The COSI observation class defines an observation.
 *
 * @todo Complete the class description.
 ***************************************************************************/
class GCOSObservation : public GObservation {
 
public:
    // Constructors and destructors
    GCOSObservation(void);
    explicit GCOSObservation(const GXmlElement& xml);
    GCOSObservation(const GFilename& eventname,
                    const GFilename& spacename,
                    const GFilename& rspname);
    GCOSObservation(const std::vector<GFilename>& eventnames,
                    const GFilename&              spacename,
                    const GFilename&              rspname);
    GCOSObservation(const GCOSObservation& obs);
    virtual ~GCOSObservation(void);
 
    // Operators
    virtual GCOSObservation& operator=(const GCOSObservation& obs);
 
    // Implement pure virtual methods
    virtual void                clear(void);
    virtual GCOSObservation*    clone(void) const;
    virtual std::string         classname(void) const;
    virtual void                response(const GResponse& rsp);
    virtual const GCOSResponse* response(void) const;
    virtual std::string         instrument(void) const;
    virtual double              ontime(void) const;
    virtual double              livetime(void) const;
    virtual double              deadc(const GTime& time = GTime()) const;
    virtual void                read(const GXmlElement& xml);
    virtual void                write(GXmlElement& xml) const;
    virtual std::string         print(const GChatter& chatter = NORMAL) const;
 
    // Other methods
    bool                  is_unbinned(void) const;
    bool                  is_binned(void) const;
    const GCOSSpaceCraft& spacecraft(void) const;
    void                  ontime(const double& ontime);
    void                  livetime(const double& livetime);
    void                  deadc(const double& deadc);
    void                  load(const GFilename& eventname,
                               const GFilename& spacename,
                               const GFilename& rspname);
    void                  load(const std::vector<GFilename>& eventnames,
                               const GFilename&              spacename,
                               const GFilename&              rspname);
 
protected:
    // Protected methods
    void init_members(void);
    void copy_members(const GCOSObservation& obs);
    void free_members(void);
 
    // Protected members
    std::string    m_instrument; //!< Instrument name
    GCOSResponse   m_response;   //!< Response functions
    GCOSSpaceCraft m_spacecraft; //!< Space craft information
    double         m_ontime;     //!< Ontime (sec)
    double         m_livetime;   //!< Livetime (sec)
    double         m_deadc;      //!< Deadtime correction
 
    // Protected members for binned observation
 
    // Protected members for unbinned observation
    std::vector<GFilename> m_eventnames; //!< Event list filenames
    GFilename              m_spacename;  //!< Space craft filename
    GFilename              m_rspname;    //!< Response filename
};
 
 
/***********************************************************************//**
 * @brief Return class name
 *
 * @return String containing the class name ("GCOSObservation").
 ***************************************************************************/
inline
std::string GCOSObservation::classname(void) const
{
    return ("GCOSObservation");
}
 
 
/***********************************************************************//**
 * @brief Return pointer to response function
 *
 * @return Response function pointer.
 ***************************************************************************/
inline
const GCOSResponse* GCOSObservation::response(void) const
{
    // Return response pointer
    return &m_response;
}
 
 
/***********************************************************************//**
 * @brief Return instrument
 *
 * @return Instrument name.
 ***************************************************************************/
inline
std::string GCOSObservation::instrument(void) const
{
    // Return instrument
    return (m_instrument);
}
 
 
/***********************************************************************//**
 * @brief Return ontime
 *
 * @return Ontime (seconds).
 ***************************************************************************/
inline
double GCOSObservation::ontime(void) const
{
    // Return ontime
    return (m_ontime);
}
 
 
/***********************************************************************//**
 * @brief Return livetime
 *
 * @return Livetime (seconds).
 ***************************************************************************/
inline
double GCOSObservation::livetime(void) const
{
    // Return livetime
    return (m_livetime);
}
 
 
/***********************************************************************//**
 * @brief Return deadtime correction factor
 *
 * @param[in] time Time.
 *
 * @return Deadtime correction factor.
 ***************************************************************************/
inline
double GCOSObservation::deadc(const GTime& time) const
{
    // Return livetime
    return (m_deadc);
}
 
 
/***********************************************************************//**
 * @brief Check whether observation is unbinned
 *
 * @return True if observation is unbinned.
 ***************************************************************************/
inline
bool GCOSObservation::is_unbinned(void) const
{
    return (dynamic_cast<const GCOSEventList*>(m_events) != NULL);
}
 
 
/***********************************************************************//**
 * @brief Check whether observation is binned
 *
 * @return True if observation is binned.
 ***************************************************************************/
inline
bool GCOSObservation::is_binned(void) const
{
    return (dynamic_cast<const GCOSEventCube*>(m_events) != NULL);
}
 
 
/***********************************************************************//**
 * @brief Return space craft information
 *
 * @return Space craft information.
 ***************************************************************************/
inline
const GCOSSpaceCraft& GCOSObservation::spacecraft(void) const
{
    return(m_spacecraft);
}
 
 
/***********************************************************************//**
 * @brief Set ontime
 *
 * @param[in] ontime Ontime.
 ***************************************************************************/
inline
void GCOSObservation::ontime(const double& ontime)
{
    m_ontime = ontime;
    return;
}
 
 
/***********************************************************************//**
 * @brief Set livetime
 *
 * @param[in] livetime Livetime.
 ***************************************************************************/
inline
void GCOSObservation::livetime(const double& livetime)
{
    m_livetime = livetime;
    return;
}
 
 
/***********************************************************************//**
 * @brief Set deadtime correction factor
 *
 * @param[in] deadc Deadtime correction factor.
 ***************************************************************************/
inline
void GCOSObservation::deadc(const double& deadc)
{
    m_deadc = deadc;
    return;
}
 
#endif /* GCOSOBSERVATION_HPP */