GSkyMap::save() now overwrites existing files if clobber=true

Jürgen Knödlseder
1 parent 5f79af82
Showing 7 changed files with 45 additions and 30 deletions
ChangeLog
NEWS
README.md
include/GSkyMap.hpp
pyext/GSkyMap.i
src/sky/GSkyMap.cpp
test/test_GSky.cpp
-2016-06-08  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
+2016-06-09  Juergen Knoedlseder  <jurgen.knodlseder@irap.omp.eu>
         * Version 1.1.0 released
         =========================
+        GSkyMap::save() now overwrites files (#1787)
         Add GCTAPsfTable class (#1786)
         Use std::vector for naxes argument in GFitsImage (#1779)
         GCTACubePsf and GCTACubeEdisp now save 4D images
@@ -2,7 +2,7 @@ New Features and Important Changes in GammaLib 1.1.0
 Author(s) : Juergen Knoedlseder
-8 June 2016
+9 June 2016
 1. Introduction
@@ -121,6 +121,7 @@ The interface for the following methods has been changed:
 - GFitsImageShort naxes constructor
 - GFitsImageULong naxes constructor
 - GFitsImageUShort naxes constructor
+- GSkyMap::save()
 3. Configuration
@@ -252,6 +253,9 @@ the number of dimensions. Note that a longitude and latitude dimensions
 are not counted in the map dimensions, i.e. a 3D image cube with
 longitude, latitude and a number of maps has a dimension of 1 (#1733).
+An optional extname argument has been added to the GSkyMap::save() method
+so that the extension name can be set (#1787).
+
 13. Support module
 ------------------
 GammaLib information
 ====================
-* Version: 1.1.0.dev1 (8 June 2016)
+* Version: 1.1.0.dev1 (9 June 2016)
 * Author:  Juergen Knoedlseder (jurgen.knodlseder@irap.omp.eu)
 [![Build Status](https://cta-jenkins.irap.omp.eu/buildStatus/icon?job=gammalib-integrate-os)](https://cta-jenkins.irap.omp.eu/job/gammalib-integrate-os/)
@@ -163,7 +163,8 @@ public:
     void                    save(const GFilename& filename,
                                  const bool&      clobber = false) const;
     void                    read(const GFitsHDU& hdu);
-    void                    write(GFits& file) const;
+    void                    write(GFits& file,
+                                  const std::string& extname = "") const;
     void                    publish(const std::string& name = "") const;
     std::string             print(const GChatter& chatter = NORMAL) const;
@@ -178,7 +178,8 @@ public:
     void                    save(const GFilename& filename,
                                  const bool&      clobber = false) const;
     void                    read(const GFitsHDU& hdu);
-    void                    write(GFits& file) const;
+    void                    write(GFits& file,
+                                  const std::string& extname = "") const;
     void                    publish(const std::string& name = "") const;
 };
@@ -1979,9 +1979,9 @@ void GSkyMap::load(const GFilename&amp; filename)
  * @param[in] filename FITS file name.
  * @param[in] clobber Overwrite existing file?
  *
- * Saves the sky map into a FITS file. If the file exists already the method
- * will append the sky map to the FITS file in case that the @p clobber
- * parameter is set to true.
+ * Saves the sky map into a FITS file. If the file exists already and the
+ * @p clobber parameter is true, the method will overwrite the content of
+ * the existing file. Otherwise, an exception is thrown.
  ***************************************************************************/
 void GSkyMap::save(const GFilename& filename, const bool& clobber) const
 {
@@ -2009,21 +2009,15 @@ void GSkyMap::save(const GFilename&amp; filename, const bool&amp; clobber) const
                 hdu->extname(filename.extname());
             }
-            // Open or create FITS file (without extension name since the
-            // requested extension may not yet exist in the file)
-            GFits fits(filename.url(), true);
-
-            // If the FITS file contains already an extension with the same
-            // name then remove now this extension
-            if (fits.contains(filename.extname())) {
-                fits.remove(filename.extname());
-            }
+            // Initialise empty FITS file
+            GFits fits;
             // Append sky map to FITS file
             fits.append(*hdu);
-            // Save FITS file
-            fits.save(clobber);
+            // Save FITS file (without extension name which was extracted
+            // earlier and set in the HDU)
+            fits.saveto(filename.url(), clobber);
             // Delete HDU
             delete hdu;
@@ -2074,11 +2068,15 @@ void GSkyMap::read(const GFitsHDU&amp; hdu)
 /***********************************************************************//**
- * @brief Write skymap into FITS file
+ * @brief Write sky map into FITS file
  *
  * @param[in] file FITS file pointer.
+ * @param[in] extname Sky map extension name.
+ *
+ * Write the sky map into a FITS file. Optionally, the extension name of
+ * the FITS HDU can be specified using the @p extname parameter.
  ***************************************************************************/
-void GSkyMap::write(GFits& file) const
+void GSkyMap::write(GFits& file, const std::string& extname) const
 {
     // Continue only if we have data to save
     if (m_proj != NULL) {
@@ -2098,11 +2096,19 @@ void GSkyMap::write(GFits&amp; file) const
         // Append HDU to FITS file.
         if (hdu != NULL) {
+
+            // Optionally set extension name
+            if (extname.length() > 0) {
+                hdu->extname(extname);
+            }
+
+            // Append HDU
             file.append(*hdu);
-        }
-        // Delete HDU
-        if (hdu != NULL) delete hdu;
+            // Delete HDU
+            if (hdu != NULL) delete hdu;
+
+        } // endif: there was a valid HDU
     } // endif: we had data to save
@@ -1201,13 +1201,15 @@ void TestGSky::test_GSkyMap_io(void)
             wcs3(i,k) = 3.0*double(i+k+1);
         }
     }
-    healpix1.save(filename+"[HEALPIX1]", true);
-    wcs1.save(filename+"[WCS1]", true);
-    healpix2.save(filename+"[HEALPIX2]", true);
-    wcs2.save(filename+"[WCS2]", true);
+    GFits fits(filename, true);
+    healpix1.write(fits, "HEALPIX1");
+    wcs1.write(fits, "WCS1");
+    healpix2.write(fits, "HEALPIX2");
+    wcs2.write(fits, "WCS2");
     wcs3.shape(2,2,3);
-    wcs3.save(filename+"[WCS3]", true);
-
+    wcs3.write(fits, "WCS3");
+    fits.save(true);
+    
     // Load HEALPix map and check content
     GSkyMap map1(filename+"[HEALPIX1]");
 	test_value(map1.npix(), healpix1.npix(), "Check number of HEALPix pixels");