Merge branch '1309-improveGCTAPsf2D-IO' into integration

Jürgen Knödlseder
2 parents ac8d88a4 2ed111ce
Showing 8 changed files with 244 additions and 29 deletions
inst/cta/include/GCTAPsf2D.hpp
inst/cta/include/GCTAPsfKing.hpp
inst/cta/pyext/GCTAPsf2D.i
inst/cta/pyext/GCTAPsfKing.i
inst/cta/pyext/GCTAResponseCube.i
inst/cta/src/GCTABackground3D.cpp
inst/cta/src/GCTAPsf2D.cpp
inst/cta/src/GCTAPsfKing.cpp
 /***************************************************************************
  *           GCTAPsf2D.hpp - CTA 2D point spread function class            *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2012-2013 by Juergen Knoedlseder                         *
+ *  copyright (C) 2012-2014 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -34,6 +34,9 @@
 #include "GCTAPsf.hpp"
 #include "GCTAResponseTable.hpp"
+/* __ Forward declarations _______________________________________________ */
+class GFits;
+class GFitsBinTable;
 /***********************************************************************//**
  * @class GCTAPsf2D
@@ -82,6 +85,15 @@ public:
                           const bool&   etrue = true) const;
     std::string print(const GChatter& chatter = NORMAL) const;
+    // Methods
+    const GCTAResponseTable&   table(void) const;
+    void                       table(const GCTAResponseTable& table);
+    void                       read(const GFits& file);
+    void                       write(GFitsBinTable& hdu) const;
+    void                       save(const std::string& filename,
+                                    const bool& clobber = false) const;
+    
+
 private:
     // Methods
     void init_members(void);
@@ -119,4 +131,27 @@ std::string GCTAPsf2D::filename(void) const
     return m_filename;
 }
+/***********************************************************************//**
+ * @brief Return response table
+ *
+ * @return Response table.
+ ***************************************************************************/
+inline
+const GCTAResponseTable& GCTAPsf2D::table(void) const
+{
+    return m_psf;
+}
+
+/***********************************************************************//**
+ * @brief Assign response table
+ *
+ * @param[in] table Response table.
+ ***************************************************************************/
+inline
+void GCTAPsf2D::table(const GCTAResponseTable& table)
+{
+     m_psf = table;
+}
+
+
 #endif /* GCTAPSF2D_HPP */
 /***************************************************************************
  *      GCTAPsfKing.hpp - King profile CTA point spread function class     *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2013 by Michael Mayer                                    *
+ *  copyright (C) 2013-2014 by Michael Mayer                               *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -82,6 +82,15 @@ public:
                            const bool&   etrue = true) const;
     std::string  print(const GChatter& chatter = NORMAL) const;
+    // Methods
+    const GCTAResponseTable&   table(void) const;
+    void                       table(const GCTAResponseTable& table);
+    void                       read(const GFits& file);
+    void                       write(GFitsBinTable& hdu) const;
+    void                       save(const std::string& filename,
+                                    const bool& clobber = false) const;
+  
+
 private:
     // Methods
@@ -117,4 +126,27 @@ std::string GCTAPsfKing::filename(void) const
     return m_filename;
 }
+/***********************************************************************//**
+ * @brief Return response table
+ *
+ * @return Response table.
+ ***************************************************************************/
+inline
+const GCTAResponseTable& GCTAPsfKing::table(void) const
+{
+    return m_psf;
+}
+
+/***********************************************************************//**
+ * @brief Assign response table
+ *
+ * @param[in] table Response table.
+ ***************************************************************************/
+inline
+void GCTAPsfKing::table(const GCTAResponseTable& table)
+{
+     m_psf = table;
+}
+
+
 #endif /* GCTAPsfKing_HPP */
 /***************************************************************************
  *            GCTAPsf2D.i - CTA 2D point spread function class             *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2012 by Juergen Knoedlseder                              *
+ *  copyright (C) 2012-2014 by Juergen Knoedlseder                         *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -71,6 +71,14 @@ public:
                           const double& zenith = 0.0,
                           const double& azimuth = 0.0,
                           const bool&   etrue = true) const;
+    // Methods
+    const GCTAResponseTable&   table(void) const;
+    void                       table(const GCTAResponseTable& table);
+    void                       read(const GFits& file);
+    void                       write(GFitsBinTable& hdu) const;
+    void                       save(const std::string& filename,
+                                    const bool& clobber = false) const;
+    
 };
 /***************************************************************************
  *       GCTAPsfKing.i - King profile CTA point spread function class      *
  * ----------------------------------------------------------------------- *
- *  copyright (C) 2013 by Michael Mayer                                    *
+ *  copyright (C) 2013-2014 by Michael Mayer                               *
  * ----------------------------------------------------------------------- *
  *                                                                         *
  *  This program is free software: you can redistribute it and/or modify   *
@@ -50,6 +50,9 @@ public:
     virtual double            irf(const GEvent&       event,
                                   const GPhoton&      photon,
                                   const GObservation& obs) const;
+    virtual double            irf(const GEvent&       event,
+                                  const GSource&      source,
+                                  const GObservation& obs) const;
     virtual double            npred(const GPhoton&      photon,
                                     const GObservation& obs) const;
     virtual void              read(const GXmlElement& xml);
@@ -305,7 +305,7 @@ GCTABackground3D* GCTABackground3D::clone(void) const
  *
  * @param[in] fits FITS file pointer.
  *
- * Reads the background form the FITS file extension "BACKGROUND". The data
+ * Reads the background from the FITS file extension "BACKGROUND". The data
  * are stored in m_background which is of type GCTAResponseTable. The DETX
  * and DETY axes will be set to radians, the energy axis will be set to
  * log10.
@@ -31,6 +31,8 @@
 #include <cmath>
 #include "GTools.hpp"
 #include "GMath.hpp"
+#include "GFits.hpp"
+#include "GFitsBinTable.hpp"
 #include "GCTAPsf2D.hpp"
 #include "GCTAException.hpp"
@@ -268,23 +270,22 @@ GCTAPsf2D* GCTAPsf2D::clone(void) const
 /***********************************************************************//**
- * @brief Load point spread function from performance table
+ * @brief Read PSF from FITS file
  *
- * @param[in] filename Performance table file name.
+ * @param[in] fits FITS file pointer.
  *
- * @exception GCTAExceptionHandler::file_open_error
- *            File could not be opened for read access.
- *
- * This method loads the point spread function information from a PSF
- * response table.
+ * Reads the PSF from the FITS file extension "POINT SPREAD FUNCTION". The data
+ * are stored in m_psf which is of type GCTAResponseTable. 
+ * The energy axis will be set to log10. The offset angle axis and 
+ * sigma parameter columns will be set to radians.
  ***************************************************************************/
-void GCTAPsf2D::load(const std::string& filename)
+void GCTAPsf2D::read(const GFits& fits)
 {
-    // Open PSF FITS file
-    GFits file(filename);
+    // Clear response table
+    m_psf.clear();
     // Get PSF table
-    const GFitsTable& table = *file.table("POINT SPREAD FUNCTION");
+    const GFitsTable& table = *fits.table("POINT SPREAD FUNCTION");
     // Read PSF table
     m_psf.read(table);
@@ -300,8 +301,49 @@ void GCTAPsf2D::load(const std::string&amp; filename)
     m_psf.scale(3, gammalib::deg2rad);
     m_psf.scale(5, gammalib::deg2rad);
+    // Return
+    return;
+}
+
+
+/***********************************************************************//**
+ * @brief Write CTA PSF table into FITS binary table object.
+ *
+ * @param[in] hdu FITS binary table.
+ *
+ * @todo Add necessary keywords.
+ ***************************************************************************/
+void GCTAPsf2D::write(GFitsBinTable& hdu) const
+{
+    // Write background table
+    m_psf.write(hdu);
+
+    // Return
+    return;
+}
+
+
+/***********************************************************************//**
+ * @brief Load point spread function from performance table
+ *
+ * @param[in] filename Performance table file name.
+ *
+ * @exception GCTAExceptionHandler::file_open_error
+ *            File could not be opened for read access.
+ *
+ * This method loads the point spread function information from a PSF
+ * response table.
+ ***************************************************************************/
+void GCTAPsf2D::load(const std::string& filename)
+{
+    // Open PSF FITS file
+    GFits fits(filename);
+
+    // Read fits file
+    read(fits);
+
     // Close PSF FITS file
-    file.close();
+    fits.close();
     // Store filename
     m_filename = filename;
@@ -312,6 +354,33 @@ void GCTAPsf2D::load(const std::string&amp; filename)
 /***********************************************************************//**
+ * @brief Save PSF table into FITS file
+ *
+ * @param[in] filename PSF table FITS file name.
+ * @param[in] clobber Overwrite existing file? (true=yes)
+ *
+ * Save the PSF table into a FITS file.
+ ***************************************************************************/
+void GCTAPsf2D::save(const std::string& filename, const bool& clobber) const
+{
+    // Create binary table
+    GFitsBinTable table;
+    table.extname("POINT SPREAD FUNCTION");
+
+    // Write the PSF table
+    write(table);
+
+    // Create FITS file, append table, and write into the file
+    GFits fits;
+    fits.append(table);
+    fits.saveto(filename, clobber);
+
+    // Return
+    return;
+}
+
+
+/***********************************************************************//**
  * @brief Simulate PSF offset (radians)
  *
  * @param[in] ran Random number generator.
@@ -31,6 +31,8 @@
 #include <cmath>
 #include "GTools.hpp"
 #include "GMath.hpp"
+#include "GFits.hpp"
+#include "GFitsBinTable.hpp"
 #include "GCTAPsfKing.hpp"
 #include "GCTAException.hpp"
@@ -269,23 +271,22 @@ GCTAPsfKing* GCTAPsfKing::clone(void) const
 /***********************************************************************//**
- * @brief Load point spread function from binary table
+ * @brief Read PSF from FITS file
  *
- * @param[in] filename Performance table file name.
+ * @param[in] fits FITS file pointer.
  *
- * @exception GCTAExceptionHandler::file_open_error
- *            File could not be opened for read access.
- *
- * This method loads the point spread function information from a PSF
- * response table.
+ * Reads the PSF from the FITS file extension "POINT SPREAD FUNCTION". The data
+ * are stored in m_psf which is of type GCTAResponseTable. 
+ * The energy axis will be set to log10. The offset angle axis and 
+ * sigma parameter columns will be set to radians.
  ***************************************************************************/
-void GCTAPsfKing::load(const std::string& filename)
+void GCTAPsfKing::read(const GFits& fits)
 {
-    // Open PSF FITS file
-    GFits file(filename);
+    // Clear response table
+    m_psf.clear();
     // Get PSF table
-    const GFitsTable& table = *file.table("POINT SPREAD FUNCTION");
+    const GFitsTable& table = *fits.table("POINT SPREAD FUNCTION");
     // Read PSF table
     m_psf.read(table);
@@ -296,8 +297,49 @@ void GCTAPsfKing::load(const std::string&amp; filename)
     // Set offset angle axis to radians
     m_psf.axis_radians(1);
-    // Convert sigma parameter to radians
+    // Convert sigma parameters to radians
     m_psf.scale(1, gammalib::deg2rad);
+   
+    // Return
+    return;
+}
+
+
+/***********************************************************************//**
+ * @brief Write CTA PSF table into FITS binary table object.
+ *
+ * @param[in] hdu FITS binary table.
+ *
+ * @todo Add necessary keywords.
+ ***************************************************************************/
+void GCTAPsfKing::write(GFitsBinTable& hdu) const
+{
+    // Write background table
+    m_psf.write(hdu);
+
+    // Return
+    return;
+}
+
+
+/***********************************************************************//**
+ * @brief Load point spread function from binary table
+ *
+ * @param[in] filename Performance table file name.
+ *
+ * @exception GCTAExceptionHandler::file_open_error
+ *            File could not be opened for read access.
+ *
+ * This method loads the point spread function information from a PSF
+ * response table.
+ ***************************************************************************/
+void GCTAPsfKing::load(const std::string& filename)
+{
+    // Open PSF FITS file
+    GFits file(filename);
+
+    // Read fits file
+    read(file);
     // Close PSF FITS file
     file.close();
@@ -309,6 +351,32 @@ void GCTAPsfKing::load(const std::string&amp; filename)
     return;
 }
+/***********************************************************************//**
+ * @brief Save PSF table into FITS file
+ *
+ * @param[in] filename PSF table FITS file name.
+ * @param[in] clobber Overwrite existing file? (true=yes)
+ *
+ * Save the PSF table into a FITS file.
+ ***************************************************************************/
+void GCTAPsfKing::save(const std::string& filename, const bool& clobber) const
+{
+    // Create binary table
+    GFitsBinTable table;
+    table.extname("POINT SPREAD FUNCTION");
+
+    // Write the PSF table
+    write(table);
+
+    // Create FITS file, append table, and write into the file
+    GFits fits;
+    fits.append(table);
+    fits.saveto(filename, clobber);
+
+    // Return
+    return;
+}
+
 /***********************************************************************//**
  * @brief Simulate PSF offset (radians)