GMWLSpectrum.hpp

Go to the documentation of this file.

/***************************************************************************
 *          GMWLSpectrum.hpp  -  Multi-wavelength spectrum class           *
 * ----------------------------------------------------------------------- *
 *  copyright (C) 2010-2016 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 GMWLSpectrum.hpp
 * @brief Multi-wavelength spectrum class interface definition
 * @author Juergen Knoedlseder
 */

#ifndef GMWLSPECTRUM_HPP
#define GMWLSPECTRUM_HPP

/* __ Includes ___________________________________________________________ */
#include <string>
#include "GEventCube.hpp"
#include "GMWLDatum.hpp"
#include "GFitsTable.hpp"
#include "GEnergy.hpp"

/* __ Forward declarations _______________________________________________ */
class GFilename;


/***********************************************************************//**
 * @class GMWLSpectrum
 *
 * @brief Multi-wavelength spectrum class interface
 *
 * This class defines a multi-wavelength spectrum and is a container for
 * spectral points of type GMWLDatum. It derives from the abstract
 * GEventCube base class.
 ***************************************************************************/
class GMWLSpectrum : public GEventCube {

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

    // Operators
    virtual GMWLSpectrum&    operator=(const GMWLSpectrum& spec);
    virtual GMWLDatum*       operator[](const int& index);
    virtual const GMWLDatum* operator[](const int& index) const;

    // Implemented pure virtual methods
    virtual void          clear(void);
    virtual GMWLSpectrum* clone(void) const;
    virtual std::string   classname(void) const;
    virtual int           size(void) const;
    virtual int           dim(void) const;
    virtual int           naxis(const int& axis) const;
    virtual void          load(const GFilename& filename);
    virtual void          save(const GFilename& filename,
                               const bool&      clobber = false) const;
    virtual void          read(const GFits& file);
    virtual void          write(GFits& file) const;
    virtual int           number(void) const;
    virtual std::string   print(const GChatter& chatter = NORMAL) const;

    // Other methods
    void               read(const GFits& file, const std::string& extname);
    void               read(const GFits& file, const int& extno);
    const std::string& telescope(void) const;
    const std::string& instrument(void) const;

protected:
    // Protected methods
    void    init_members(void);
    void    copy_members(const GMWLSpectrum& spec);
    void    free_members(void);
    void    set_ebounds(void);
    void    read_fits(const GFitsTable& table);
    GEnergy conv_energy(const double& energy, const std::string& unit);
    double  conv_flux(const GEnergy& energy, const double& flux,
                      const std::string& unit);

    // Protected members
    std::string            m_telescope;   //!< Telescope name
    std::string            m_instrument;  //!< Instrument name
    std::vector<GMWLDatum> m_data;        //!< Spectral data
};


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


/***********************************************************************//**
 * @brief Return number of spectral bins
 *
 * @return Number of bins in spectrum.
 ***************************************************************************/
inline
int GMWLSpectrum::size(void) const
{
    return (int)m_data.size();
}


/***********************************************************************//**
 * @brief Return dimension of spectrum
 *
 * @return Dimension of spectrum (always 1).
 ***************************************************************************/
inline
int GMWLSpectrum::dim(void) const
{
    return 1;
}


/***********************************************************************//**
 * @brief Return number of spectral bins per dimension
 *
 * @param[in] axis Axis (ignored).
 * @return Number of bins in spectrum.
 ***************************************************************************/
inline
int GMWLSpectrum::naxis(const int& axis) const
{
    return (int)m_data.size();
}


/***********************************************************************//**
 * @brief Return telescope name
 *
 * @return Telescope name.
 ***************************************************************************/
inline
const std::string& GMWLSpectrum::telescope(void) const
{
    return m_telescope;
}


/***********************************************************************//**
 * @brief Return instrument name
 *
 * @return Instrument name.
 ***************************************************************************/
inline
const std::string& GMWLSpectrum::instrument(void) const
{
    return m_instrument;
}

#endif /* GMWLSPECTRUM_HPP */