ctexpcube.hpp

Go to the documentation of this file.

/***************************************************************************
 *                 ctexpcube - Exposure cube generation tool               *
 * ----------------------------------------------------------------------- *
 *  copyright (C) 2014-2022 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 ctexpcube.hpp
 * @brief Exposure cube generation tool definition
 * @author Juergen Knoedlseder
 */

#ifndef CTEXPCUBE_HPP
#define CTEXPCUBE_HPP

/* __ Includes ___________________________________________________________ */
#include "GammaLib.hpp"
#include "GCTALib.hpp"
#include "ctobservation.hpp"

/* __Definitions _________________________________________________________ */
#define CTEXPCUBE_NAME "ctexpcube"


/***********************************************************************//**
 * @class ctexpcube
 *
 * @brief Exposure cube generation tool
 ***************************************************************************/
class ctexpcube : public ctobservation {

public:
    // Constructors and destructors
    ctexpcube(void);
    explicit ctexpcube(const GObservations& obs);
    ctexpcube(int argc, char *argv[]);
    ctexpcube(const ctexpcube& app);
    virtual ~ctexpcube(void);

    // Operators
    ctexpcube& operator=(const ctexpcube& app);

    // Methods
    void                    clear(void);
    void                    process(void);
    void                    save(void);
    void                    publish(const std::string& name = "");
    const GCTACubeExposure& expcube(void) const;

protected:
    // Protected methods
    void init_members(void);
    void copy_members(const ctexpcube& app);
    void free_members(void);
    void get_parameters(void);
    void init_cube(void);

    // User parameters
    GFilename m_outcube;            //!< Output exposure cube file
    bool      m_addbounds;          //!< Add energies at boundaries?
    bool      m_publish;            //!< Publish exposure cube?
    GChatter  m_chatter;            //!< Chattiness

    // Protected members
    GCTACubeExposure m_expcube;     //!< Exposure cube
};


/***********************************************************************//**
 * @brief Return exposure cube
 *
 * @return Exposure cube
 ***************************************************************************/
inline
const GCTACubeExposure& ctexpcube::expcube(void) const
{
    return (m_expcube);
}

#endif /* CTEXPCUBE_HPP */