GCTAPsfVector.hpp

Go to the documentation of this file.

/***************************************************************************
 *       GCTAPsfVector.hpp - CTA point spread function vector class        *
 * ----------------------------------------------------------------------- *
 *  copyright (C) 2012-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 GCTAPsfVector.hpp
 * @brief CTA point spread function vector class definition
 * @author Juergen Knoedlseder
 */

#ifndef GCTAPSFVECTOR_HPP
#define GCTAPSFVECTOR_HPP

/* __ Includes ___________________________________________________________ */
#include <string>
#include <vector>
#include "GFilename.hpp"
#include "GNodeArray.hpp"
#include "GCTAPsf.hpp"

/* __ Forward declarations _______________________________________________ */
class GRan;
class GFitsTable;


/***********************************************************************//**
 * @class GCTAPsfVector
 *
 * @brief CTA vector point spread function class
 *
 * This class implements the CTA point spread function response as function
 * of energy as determined from a FITS table.
 ***************************************************************************/
class GCTAPsfVector : public GCTAPsf {

public:
    // Constructors and destructors
    GCTAPsfVector(void);
    GCTAPsfVector(const GFilename& filename);
    GCTAPsfVector(const GCTAPsfVector& psf);
    virtual ~GCTAPsfVector(void);

    // Operators
    GCTAPsfVector& operator=(const GCTAPsfVector& psf);
    double operator()(const double& delta,
                      const double& logE, 
                      const double& theta = 0.0, 
                      const double& phi = 0.0,
                      const double& zenith = 0.0,
                      const double& azimuth = 0.0,
                      const bool&   etrue = true) const;

    // Implemented pure virtual methods
    void           clear(void);
    GCTAPsfVector* clone(void) const;
    std::string    classname(void) const;
    void           load(const GFilename& filename);
    GFilename      filename(void) const;
    double         mc(GRan&         ran,
                      const double& logE, 
                      const double& theta = 0.0, 
                      const double& phi = 0.0,
                      const double& zenith = 0.0,
                      const double& azimuth = 0.0,
                      const bool&   etrue = true) const;
    double         delta_max(const double& logE, 
                             const double& theta = 0.0, 
                             const double& phi = 0.0,
                             const double& zenith = 0.0,
                             const double& azimuth = 0.0,
                             const bool&   etrue = true) const;
    double         containment_radius(const double& fraction,
                                      const double& logE,
                                      const double& theta = 0.0,
                                      const double& phi = 0.0,
                                      const double& zenith = 0.0,
                                      const double& azimuth = 0.0,
                                      const bool&   etrue = true) const;
    std::string    print(const GChatter& chatter = NORMAL) const;

    // Other methods
    void read(const GFitsTable& table);

private:
    // Methods
    void init_members(void);
    void copy_members(const GCTAPsfVector& psf);
    void free_members(void);
    void update(const double& logE) const;

    // Members
    GFilename           m_filename;  //!< Name of Aeff response file
    GNodeArray          m_logE;      //!< log(E) nodes for Aeff interpolation
    std::vector<double> m_r68;       //!< 68% containment radius of PSF in degrees
    std::vector<double> m_sigma;     //!< Sigma value of PSF in radians

    // Precomputation cache
    mutable double      m_par_logE;  //!< Energy for which precomputation is done
    mutable double      m_par_scale; //!< Gaussian normalization
    mutable double      m_par_sigma; //!< Gaussian sigma (radians)
    mutable double      m_par_width; //!< Gaussian width parameter
};


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


/***********************************************************************//**
 * @brief Return filename
 *
 * @return Filename.
 *
 * Returns filename from which point spread function was loaded.
 ***************************************************************************/
inline
GFilename GCTAPsfVector::filename(void) const
{
    return (m_filename);
}

#endif /* GCTAPSFVECTOR_HPP */