inst/cta/include/GCTAOnOffObservations.hpp

Go to the documentation of this file.

/***************************************************************************
 *    GCTAOnOffObservations.hpp - CTA on-off observation container class   *
 * ----------------------------------------------------------------------- *
 *  copyright (C) 2013-2016 by Pierrick Martin                             *
 * ----------------------------------------------------------------------- *
 *                                                                         *
 *  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 GCTAOnOffObservations.hpp
 * @brief CTA on-off observation container class definition
 * @author Pierrick Martin
 */

#ifndef GCTAONOFFOBSERVATIONS_HPP
#define GCTAONOFFOBSERVATIONS_HPP

/* __ Includes ___________________________________________________________ */
#include <string>
#include <vector>
#include "GContainer.hpp"
#include "GCTAOnOffObservation.hpp"
#include "GModels.hpp"

/* __ Forward declarations _______________________________________________ */
class GFilename;


/***********************************************************************//**
 * @class GCTAOnOffObservations
 *
 * @brief ON/OFF Observation container class
 *
 * This class in a container of GCTAOnOffObservation objects. Still some
 * work to do and things to be clarified...
 ***************************************************************************/
class GCTAOnOffObservations : public GContainer {

public:
    // Constructors and destructors
    GCTAOnOffObservations(void);
    GCTAOnOffObservations(const GCTAOnOffObservations& obs);
    explicit GCTAOnOffObservations(const GFilename& filename);
    virtual ~GCTAOnOffObservations(void);

    // Operators
    GCTAOnOffObservations&      operator=(const GCTAOnOffObservations& obs);
    GCTAOnOffObservation*       operator[](const int& index);
    const GCTAOnOffObservation* operator[](const int& index) const;

    // Methods
    void                        clear(void);
    GCTAOnOffObservations*      clone(void) const;
    std::string                 classname(void) const;
    GCTAOnOffObservation*       at(const int& index);
    const GCTAOnOffObservation* at(const int& index) const;
    int                         size(void) const;
    bool                        is_empty(void) const;
    GCTAOnOffObservation*       set(const int& index, const GCTAOnOffObservation& obs);
    GCTAOnOffObservation*       append(const GCTAOnOffObservation& obs);
    GCTAOnOffObservation*       insert(const int& index, const GCTAOnOffObservation& obs);
    void                        remove(const int& index);
    void                        reserve(const int& num);
    void                        extend(const GCTAOnOffObservations& obs);
    bool                        contains(const std::string& instrument,
                                         const std::string& id) const;
    void                        load(const GFilename& filename);
    void                        save(const GFilename& filename) const;
    void                        read(const GXml& xml);
    void                        write(GXml& xml) const;
    void                        models(const GModels& models);
    void                        models(const GFilename& filename);
    const GModels&              models(void) const; 
    std::string                 print(const GChatter& chatter = NORMAL) const;  
    
    /*
    // To do
    Implement fit functions for both cases summed over runs or not ? 
    Implement significance or have it at ctool level ?
    Implement flux points computation and fit of a spectral function ?  
    // Do we want that ? If yes, need to retrieve inline functions from GObservations...
    double              npred(void) const;  
    // Left aside at the moment
    void                          optimize(GOptimizer& opt);
     */
    
protected:
    // Protected methods
    void init_members(void);
    void copy_members(const GCTAOnOffObservations& obs);
    void free_members(void);
    int  get_index(const std::string& instrument,
                   const std::string& id) const;

    // Protected members
    std::vector<GCTAOnOffObservation*> m_obs;    //!< List of observations
    GModels                            m_models; //!< List of models
};


/***********************************************************************//**
 * @brief Return class name
 *
 * @return String containing the class name ("GCTAOnOffObservations").
 ***************************************************************************/
inline
std::string GCTAOnOffObservations::classname(void) const
{
    return ("GCTAOnOffObservations");
}


/***********************************************************************//**
 * @brief Return pointer to observation
 *
 * @param[in] index Observation index [0,...,size()-1].
 * @return Observation.
 *
 * Returns a pointer to the observation with specified @p index.
 ***************************************************************************/
inline
GCTAOnOffObservation* GCTAOnOffObservations::operator[](const int& index)
{
    return m_obs[index];
}


/***********************************************************************//**
 * @brief Return pointer to observation (const version)
 *
 * @param[in] index Observation index [0,...,size()-1].
 *
 * Returns a const pointer to the observation with specified @p index.
 ***************************************************************************/
inline
const GCTAOnOffObservation* GCTAOnOffObservations::operator[](const int& index) const
{
    return m_obs[index];
}


/***********************************************************************//**
 * @brief Return number of observations in container
 *
 * @return Number of observations in container.
 *
 * Returns the number of observations in the observation container.
 ***************************************************************************/
inline
int GCTAOnOffObservations::size(void) const
{
    return (int)m_obs.size();
}


/***********************************************************************//**
 * @brief Signals if there are no observations in container
 *
 * @return True if container is empty, false otherwise.
 *
 * Signals if the observation container does not contain any observation.
 ***************************************************************************/
inline
bool GCTAOnOffObservations::is_empty(void) const
{
    return (m_obs.empty());
}


/***********************************************************************//**
 * @brief Reserves space for observations in container
 *
 * @param[in] num Number of observations.
 *
 * Reserves space for @p num observations in the container.
 ***************************************************************************/
inline
void GCTAOnOffObservations::reserve(const int& num)
{
    m_obs.reserve(num);
    return;
}


/***********************************************************************//**
 * @brief Set model container
 *
 * @param[in] models Model container.
 *
 * Sets the model container for the observations.
 ***************************************************************************/
inline
void GCTAOnOffObservations::models(const GModels& models)
{
    m_models = models;
    return;
}


/***********************************************************************//**
 * @brief Return model container
 *
 * @return Model container.
 *
 * Returns the model container of the observations.
 ***************************************************************************/
inline
const GModels& GCTAOnOffObservations::models(void) const
{
    return m_models;
}

#endif /* GCTAONOFFOBSERVATIONS_HPP */

---