GModelSpatialComposite.hpp

Go to the documentation of this file.

/***************************************************************************
 *       GModelSpatialComposite.hpp - Spatial composite model class        *
 * ----------------------------------------------------------------------- *
 *  copyright (C) 2016-2024 by Domenico Tiziani                            *
 * ----------------------------------------------------------------------- *
 *                                                                         *
 *  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 GModelSpatialComposite.hpp
 * @brief Spatial composite model class interface definition
 * @author Domenico Tiziani
 */
 
#ifndef GMODELSPATIALCOMPOSITE_HPP
#define GMODELSPATIALCOMPOSITE_HPP
 
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GModelSpatial.hpp"
#include "GModelPar.hpp"
#include "GSkyDir.hpp"
#include "GSkyRegionCircle.hpp"
#include "GXmlElement.hpp"
 
 
/***********************************************************************//**
 * @class GModelSpatialComposite
 *
 * @brief Spatial composite model
 *
 * This class implements the spatial model for a composition of spatial
 * models.
 ***************************************************************************/
class GModelSpatialComposite : public GModelSpatial {
 
public:
    // Constructors and destructors
    GModelSpatialComposite(const bool& normalize = true);
    GModelSpatialComposite(const bool& dummy, const std::string& type);
    explicit GModelSpatialComposite(const GXmlElement& xml);
    GModelSpatialComposite(const GModelSpatialComposite& model);
    virtual ~GModelSpatialComposite(void);
 
    // Operators
    virtual GModelSpatialComposite& operator=(const GModelSpatialComposite& model);
 
    // Implemented pure virtual methods
    virtual void                    clear(void);
    virtual GModelSpatialComposite* clone(void) const;
    virtual std::string             classname(void) const;
    virtual GClassCode              code(void) const;
    virtual double                  eval(const GPhoton& photon,
                                         const bool& gradients = false) const;
    virtual GSkyDir                 mc(const GEnergy& energy,
                                       const GTime& time,
                                       GRan& ran) const;
    virtual double                  mc_norm(const GSkyDir& dir,
                                            const double&  radius) const;
    virtual bool                    contains(const GSkyDir& dir,
                                             const double&  margin = 0.0) const;
    virtual void                    read(const GXmlElement& xml);
    virtual void                    write(GXmlElement& xml) const;
    virtual std::string             print(const GChatter& chatter = NORMAL) const;
 
    // Overloaded base class methods
    virtual double flux(const GSkyRegion& region,
                        const GEnergy&    srcEng  = GEnergy(),
                        const GTime&      srcTime = GTime()) const;
 
    // Other methods
    int                  components(void) const;
    void                 append(const GModelSpatial& component,
                                const std::string&   name = "",
                                const GModelPar&     par = GModelPar("", 1.0));
    const GModelSpatial* component(const int& index) const;
    const GModelSpatial* component(const std::string& name) const;
    std::string          name(const int& index) const;
    const GModelPar*     scale(const int& index) const;
    double               sum_of_scales(void) const;
    const bool&          normalize(void) const;
 
protected:
    // Protected methods
    void    init_members(void);
    void    copy_members(const GModelSpatialComposite& model);
    void    free_members(void);
    virtual void set_region(void) const;
 
    // Protected members
    bool                        m_normalize;     //!< Normalize component
    bool                        m_has_normalize; //!< XML has normalize attribute
    std::vector<GModelSpatial*> m_components;    //!< Components
    std::vector<std::string>    m_names;         //!< Component names
    std::vector<GModelPar*>     m_scales;        //!< Component scales
};
 
 
/***********************************************************************//**
 * @brief Return class name
 *
 * @return String containing the class name ("GModelSpatialComposite").
 ***************************************************************************/
inline
std::string GModelSpatialComposite::classname(void) const
{
    return ("GModelSpatialComposite");
}
 
 
/***********************************************************************//**
 * @brief Return class code
 *
 * @return GModelSpatialComposite.
 *
 * Returns the code GModelSpatialComposite of the class.
 ***************************************************************************/
inline
GClassCode GModelSpatialComposite::code(void) const
{
    return GMODEL_SPATIAL_COMPOSITE;
}
 
 
/***********************************************************************//**
 * @brief Return normalization of composite source for Monte Carlo
 *        simulations
 *
 * @param[in] dir Centre of simulation cone.
 * @param[in] radius Radius of simulation cone (degrees).
 * @return Normalization.
 *
 * Returns unity.
 ***************************************************************************/
inline
double GModelSpatialComposite::mc_norm(const GSkyDir& dir,
                                       const double&  radius) const
{
    return 1.0;
}
 
 
/***********************************************************************//**
 * @brief Return number of model components
 *
 * @return Number of model components.
 ***************************************************************************/
inline
int GModelSpatialComposite::components(void) const
{
    return ((int)m_components.size());
}
 
 
/***********************************************************************//**
 * @brief Return normalisation flag
 *
 * @return True if composite model is normalised.
 ***************************************************************************/
inline
const bool& GModelSpatialComposite::normalize(void) const
{
    return (m_normalize);
}
 
#endif /* GMODELSPATIALCOMPOSITE_HPP */