Eirik Hatlen / gammalib

/***************************************************************************
 *          GModelSpatial.cpp - Abstract spatial model base class          *
 * ----------------------------------------------------------------------- *
 *  copyright (C) 2009-2021 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 GModelSpatial.cpp
 * @brief Abstract spatial model base class implementation
 * @author Juergen Knoedlseder
 */

/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "GException.hpp"
#include "GModelSpatial.hpp"
#include "GModelSpatialPointSource.hpp"

/* __ Method name definitions ____________________________________________ */
#define G_ACCESS                    "GModelSpatial::operator[](std::string&)"
#define G_AT                             "GModelPar& GModelSpatial::at(int&)"
#define G_FLUX     "GModelSpatial::flux(GSkyRegionCircle&, GEnergy&, GTime&)"

/* __ Constants __________________________________________________________ */
const double g_kludge_radius = 1.0e-12;            //!< Tiny angle (radians)

/* __ Macros _____________________________________________________________ */

/* __ Coding definitions _________________________________________________ */

/* __ Debug definitions __________________________________________________ */


/*==========================================================================
 =                                                                         =
 =                        Constructors/destructors                         =
 =                                                                         =
 ==========================================================================*/

/***********************************************************************//**
 * @brief Void constructor
 ***************************************************************************/
GModelSpatial::GModelSpatial(void)
{
    // Initialise members
    init_members();

    // Return
    return;
}


/***********************************************************************//**
 * @brief Copy constructor
 *
 * @param[in] model Spatial model.
 ***************************************************************************/
GModelSpatial::GModelSpatial(const GModelSpatial& model)
{
    // Initialise members
    init_members();

    // Copy members
    copy_members(model);

    // Return
    return;
}


/***********************************************************************//**
 * @brief Destructor
 ***************************************************************************/
GModelSpatial::~GModelSpatial(void)
{
    // Free members
    free_members();

    // Return
    return;
}


/*==========================================================================
 =                                                                         =
 =                                Operators                                =
 =                                                                         =
 ==========================================================================*/

/***********************************************************************//**
 * @brief Assignment operator
 *
 * @param[in] model Spatial model.
 * @return Spatial model.
 ***************************************************************************/
GModelSpatial& GModelSpatial::operator=(const GModelSpatial& model)
{
    // Execute only if object is not identical
    if (this != &model) {

        // Free members
        free_members();

        // Initialise members
        init_members();

        // Copy members
        copy_members(model);

    } // endif: object was not identical

    // Return
    return *this;
}


/***********************************************************************//**
 * @brief Returns model parameter
 *
 * @param[in] name Parameter name.
 * @return Model parameter reference.
 *
 * @exception GException::par_not_found
 *            Parameter with specified name not found in container.
 *
 * Returns reference to the model parameter of specified @p name.
 ***************************************************************************/
GModelPar& GModelSpatial::operator[](const std::string& name)
{
    // Get parameter index
    int index = 0;
    for (; index < size(); ++index) {
        if (m_pars[index]->name() == name) {
            break;
        }
    }

    // Throw exception if parameter name was not found
    if (index >= size()) {
        throw GException::par_not_found(G_ACCESS, name);
    }

    // Return reference
    return *(m_pars[index]);
}


/***********************************************************************//**
 * @brief Returns model parameter (const version)
 *
 * @param[in] name Parameter name.
 * @return Model parameter reference.
 *
 * @exception GException::par_not_found
 *            Parameter with specified name not found in container.
 *
 * Returns reference to the model parameter of specified @p name.
 ***************************************************************************/
const GModelPar& GModelSpatial::operator[](const std::string& name) const
{
    // Get parameter index
    int index = 0;
    for (; index < size(); ++index) {
        if (m_pars[index]->name() == name) {
            break;
        }
    }

    // Throw exception if parameter name was not found
    if (index >= size()) {
        throw GException::par_not_found(G_ACCESS, name);
    }

    // Return reference
    return *(m_pars[index]);
}


/*==========================================================================
 =                                                                         =
 =                             Public methods                              =
 =                                                                         =
 ==========================================================================*/

/***********************************************************************//**
 * @brief Returns model parameter
 *
 * @param[in] index Parameter index [0,...,size()-1].
 * @return Model parameter.
 *
 * @exception GException::out_of_range
 *            Parameter index is out of range.
 *
 * Returns model parameter with @p index range checking.
 ***************************************************************************/
GModelPar& GModelSpatial::at(const int& index)
{
    // Compile option: raise exception if index is out of range
    if (index < 0 || index >= size()) {
        throw GException::out_of_range(G_AT, index, 0, size()-1);
    }

    // Return reference
    return *(m_pars[index]);
}


/***********************************************************************//**
 * @brief Returns model parameter (const version)
 *
 * @param[in] index Parameter index [0,...,size()-1].
 * @return Model parameter.
 *
 * @exception GException::out_of_range
 *            Parameter index is out of range.
 *
 * Returns model parameter with @p index range checking.
 ***************************************************************************/
const GModelPar& GModelSpatial::at(const int& index) const
{
    // Compile option: raise exception if index is out of range
    if (index < 0 || index >= size()) {
        throw GException::out_of_range(G_AT, index, 0, size()-1);
    }

    // Return reference
    return *(m_pars[index]);
}


/***********************************************************************//**
 * @brief Checks if parameter name exists
 *
 * @param[in] name Parameter name.
 * @return True if parameter with specified @p name exists.
 *
 * Searches all parameter names for a match with the specified @p name. If
 * the specified name has been found, true is returned.
 ***************************************************************************/
bool GModelSpatial::has_par(const std::string& name) const
{
    // Default found flag to false
    bool found = false;

    // Search for parameter name
    for (int i = 0; i < size(); ++i) {
        if (m_pars[i]->name() == name) {
            found = true;
            break;
        }
    }

    // Return
    return found;
}


/***********************************************************************//**
 * @brief Checks if the spatial model has free parameters
 *
 * @return True if spatial model has free parameters.
 ***************************************************************************/
bool GModelSpatial::has_free_pars(void) const
{
    // Initialise result flag
    bool has_free_pars = false;

    // Search for free parameters
    for (int i = 0; i < size(); ++i) {
        if (m_pars[i]->is_free()) {
            has_free_pars = true;
            break;
        }
    }

    // Return result
    return has_free_pars;
}


/***********************************************************************//**
 * @brief Autoscale parameters
 *
 * Sets the scale factors for all parameters so that the values are unity.
 ***************************************************************************/
void GModelSpatial::autoscale(void)
{
    // Loop over all parameters
    for (int i = 0; i < m_pars.size(); ++i) {
        if (m_pars[i] != NULL) {
            m_pars[i]->autoscale();
        }
    }

    // Return
    return;
}


/***********************************************************************//**
 * @brief Returns model flux integrated in circular sky region
 *
 * @param[in] region Sky region.
 * @param[in] srcEng Energy.
 * @param[in] srcTime Time.
 * @return Flux (adimensional or ph/cm2/s).
 *
 * @exception GException::feature_not_implemented
 *            Regions are not circular.
 *
 * Computes
 *
 * \f[
 *    \int_{\rho_{\rm min}}^{\rho_{\rm max}}  \sin \rho \times
 *                     \int_{\omega} M(\rho, \omega | E, t) d\omega d\rho
 * \f]
 *
 * where
 * \f$M(\rho, \omega | E, t)\f$ is the spatial model,
 * \f$\rho\f$ is the distance from the region centre, and
 * \f$\omega\f$ is the position angle with respect to the connecting line
 * between the region centre and the direction on the sky.
 ***************************************************************************/
double GModelSpatial::flux(const GSkyRegion& region,
                           const GEnergy&    srcEng,
                           const GTime&      srcTime) const
{
    // Initialise flux
    double flux = 0.0;

    // Continue only if region overlaps with model
    const GSkyRegion* model_reg = this->region();
    if (model_reg->overlaps(region)) {

        // Check if the model is a point source
        const GModelSpatialPointSource* ps_model =
              dynamic_cast<const GModelSpatialPointSource*>(this);

        // If the model is not a point source integrate over circular
        // regions overlap
        if (ps_model == NULL) {

            // Thrown an exception if region is not a sky circle
            const GSkyRegionCircle* reg_circle =
                  dynamic_cast<const GSkyRegionCircle*>(&region);
            if (reg_circle == NULL) {
                std::string msg = "Flux can only be computed for a circular "
                                  "region.";
                throw GException::feature_not_implemented(G_FLUX,msg);
            }

            // Thrown an exception if model region is not a sky circle
            const GSkyRegionCircle* model_circle =
                  dynamic_cast<const GSkyRegionCircle*>(model_reg);
            if (model_circle == NULL) {
                std::string msg = "Flux can only be computed for spatial model "
                                  "with region defined as circle.";
                throw GException::feature_not_implemented(G_FLUX,msg);
            }

            // Model centre and radius in radians
            GSkyDir model_centre = model_circle->centre();
            double  model_radius = model_circle->radius() * gammalib::deg2rad;

            // Distance between region and model centres in radians
            double distance = model_centre.dist(reg_circle->centre());

            // Take the distance between centers minus radius of model region as
            // the minimum radial integration boundary (in radians)
            double rho_min = distance - model_radius;

            // Make sure that rho_min does not become negative
            if (rho_min < 0.0) {
                rho_min = 0.0;
            }

            // Take the region radius as the maximum radial integration boundary
            // (in radians)
            double rho_max = reg_circle->radius() * gammalib::deg2rad;

            // Pre-compute some quantities for arclength
            double cosdist   = std::cos(distance);
            double sindist   = std::sin(distance);
            double cosmodrad = std::cos(model_radius);

            // Setup integration kernel
            GModelSpatial::circle_int_kern_rho integrand(this,
                                                         reg_circle,
                                                         srcEng,
                                                         srcTime,
                                                         distance,
                                                         cosdist,
                                                         sindist,
                                                         model_radius,
                                                         cosmodrad);
            GIntegral integral(&integrand);

            // Suppress integration warnings
            integral.silent(true);

            // Perform integration
            flux = integral.romberg(rho_min, rho_max);

        } // endif: source model was not a point source

        // ... otherwise the model is point source that overlaps with the
        // region, hence the flux is set flux to 1.0
        else {
            flux = 1.0;
        }

    } // endif: model overlaps with region

    // Return
    return flux;
}


/*==========================================================================
 =                                                                         =
 =                             Private methods                             =
 =                                                                         =
 ==========================================================================*/

/***********************************************************************//**
 * @brief Initialise class members
 ***************************************************************************/
void GModelSpatial::init_members(void)
{
    // Initialise members
    m_type.clear();
    m_region.clear();
    m_pars.clear();

    // Return
    return;
}


/***********************************************************************//**
 * @brief Copy class members
 *
 * @param[in] model Spatial model.
 ***************************************************************************/
void GModelSpatial::copy_members(const GModelSpatial& model)
{
    // Copy members
    m_type   = model.m_type;
    m_region = model.m_region;
    m_pars   = model.m_pars;

    // Return
    return;
}


/***********************************************************************//**
 * @brief Delete class members
 ***************************************************************************/
void GModelSpatial::free_members(void)
{
    // Return
    return;
}


/***********************************************************************//**
 * @brief Kernel for circular sky region radial integration
 *
 * @param[in] rho Radial distance from region centre (radians).
 * @return Integration kernel defined as
 *
 * \f[
 *    \int_{\rho_{\rm min}}^{\rho_{\rm max}} K(\rho | E, t) d\rho
 * \f]
 *
 * of a spatial model over a circular region. The eval() method computes
 *
 * \f[
 *    K(\rho | E, t) = \sin \rho \times
 *                     \int_{\omega} M(\rho, \omega | E, t) d\omega
 * \f]
 *
 * where
 * \f$M(\rho, \omega | E, t)\f$ is the spatial model,
 * \f$\rho\f$ is the distance from the region centre, and
 * \f$\omega\f$ is the position angle with respect to the connecting line
 * between the region centre and the direction on the sky.
 ***************************************************************************/
double GModelSpatial::circle_int_kern_rho::eval(const double& rho)
{
    // Initialise model value
    double flux = 0.0;

    // Continue only if rho is positive
    if (rho > 0.0) {

        // Compute half length of the arc (in radians) from a circle with
        // radius rho that intersects with model circle
        double domega = 0.5 * gammalib::roi_arclength(rho,
      						                          m_dist,
      						                          m_cosdist,
      						                          m_sindist,
      						                          m_modrad,
      						                          m_cosmodrad);

        // Continue only if arc length is positive
        if (domega > 0.0) {

            // Reduce rho by an infinite amount to avoid rounding errors
            // at the boundary of a sharp edged model
            double rho_kludge = rho - g_kludge_radius;
            if (rho_kludge < 0.0) {
                rho_kludge = 0.0;
            }

            // Compute omega integration range
            double omega_min = -domega;
            double omega_max = +domega;

            // Setup integration kernel for azimuth integration
            GModelSpatial::circle_int_kern_omega integrand(m_model,
                                                           m_reg,
                                                           rho_kludge,
                                                           m_srcEng,
                                                           m_srcTime);

            // Setup integrator
            GIntegral integral(&integrand);

            // Compute sine term for radial integration
            double sin_rho = std::sin(rho);

            // Integrate over omega
            flux = integral.romberg(omega_min, omega_max) * sin_rho;

        } //endif: domega was positive

    } // endif: rho was positive

    // Return
    return flux;
}


/***********************************************************************//**
 * @brief Kernel for circular sky region azimuth angle integration
 *
 * @param[in] omega Azimuth angle (radians).
 * @return Integration kernel defined as
 *
 * \f[
 *    K(\omega | \rho, E, t) = M(\omega | \rho)
 * \f]
 *
 * where
 * \f$M(\omega | \rho)\f$ is the spatial model,
 * \f$\rho\f$ is the distance from the region centre, and
 * \f$\omega\f$ is the position angle with respect to the connecting line
 * between the region centre and the direction on the sky.
 ***************************************************************************/
double GModelSpatial::circle_int_kern_omega::eval(const double& omega)
{
    // Compute sky direction corresponding to given rho, omega
    GSkyDir dir = GSkyDir(m_reg->centre());

    // Rotate to obtain requested sky direction
    dir.rotate(omega, m_rho);

    // Set photon for this sky direction
    GPhoton photon = GPhoton(dir, m_srcEng, m_srcTime);

    // Evaluate model for this sky direction
    double flux = m_model->eval(photon);

    // Return
    return flux;
}