Fix GSkyMap::publish() bug for empty sky maps (#1835)

Jürgen Knödlseder
1 parent 28bd0159
Showing 5 changed files with 42 additions and 25 deletions
ChangeLog
NEWS
include/GSkyMap.hpp
pyext/GSkyMap.i
src/sky/GSkyMap.cpp
@@ -3,6 +3,7 @@
         * Version 1.2.0 released
         =========================
+        Fix GSkyMap::publish() bug for empty sky maps (#1835)
         Fix loss of application name and version (#1835)
         Add methods for logging in applications (#1828)
         Fix removal of Python wrappers after make clean (#1826)
@@ -38,7 +38,7 @@ The parameters for the following methods have been changed:
 - GApplication::log_parameters() now has a mandatory GChatter argument
 The return value of the following methods has been changed:
-- ...
+- GSkyMap::write() now returns a pointer to GFitsHDU instead of void
 3. Configuration
@@ -109,7 +109,10 @@ None
 12. Sky module
 --------------
-None
+The GSkyMap::write() method now returns a pointer to the written GFitsHDU
+object. In case that no sky map is written, for example because none has been
+defined so far, the method returns NONE. The GSkyMap::publish() method will
+detect the NONE value and will do nothing if no sky map exists (#1835).
 13. Support module
@@ -163,7 +163,7 @@ public:
     void                    save(const GFilename& filename,
                                  const bool&      clobber = false) const;
     void                    read(const GFitsHDU& hdu);
-    void                    write(GFits& file,
+    GFitsHDU*               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,7 @@ public:
     void                    save(const GFilename& filename,
                                  const bool&      clobber = false) const;
     void                    read(const GFitsHDU& hdu);
-    void                    write(GFits& file,
+    GFitsHDU*               write(GFits& file,
                                   const std::string& extname = "") const;
     void                    publish(const std::string& name = "") const;
 };
@@ -2072,16 +2072,22 @@ void GSkyMap::read(const GFitsHDU&amp; hdu)
  *
  * @param[in] file FITS file pointer.
  * @param[in] extname Sky map extension name.
+ * @return Pointer to written HDU.
  *
  * Write the sky map into a FITS file. Optionally, the extension name of
- * the FITS HDU can be specified using the @p extname parameter.
+ * the FITS HDU can be specified using the @p extname parameter. The method
+ * returns a pointer to the appended HDU. If no HDU has been appended, for
+ * example because the sky map is empty, the method will return NULL.
  ***************************************************************************/
-void GSkyMap::write(GFits& file, const std::string& extname) const
+GFitsHDU* GSkyMap::write(GFits& file, const std::string& extname) const
 {
+    // Initialise pointer to appended HDU
+    GFitsHDU* hdu_appended = NULL;
+
     // Continue only if we have data to save
     if (m_proj != NULL) {
-        // Initialise HDU pointer
+        // Initialise local HDU pointer
         GFitsHDU* hdu = NULL;
         // Case A: Skymap is Healpix
@@ -2102,8 +2108,8 @@ void GSkyMap::write(GFits&amp; file, const std::string&amp; extname) const
                 hdu->extname(extname);
             }
-            // Append HDU
-            file.append(*hdu);
+            // Append HDU and recover the pointer to the appended HDU
+            hdu_appended = file.append(*hdu);
             // Delete HDU
             if (hdu != NULL) delete hdu;
@@ -2112,8 +2118,8 @@ void GSkyMap::write(GFits&amp; file, const std::string&amp; extname) const
     } // endif: we had data to save
-    // Return
-    return;
+    // Return pointer to appended HDU
+    return hdu_appended;
 }
@@ -2123,27 +2129,34 @@ void GSkyMap::write(GFits&amp; file, const std::string&amp; extname) const
  * @param[in] name Name of sky map.
  *
  * Publishes the sky map on a Virtual Observatory Hub. If no Hub is currently
- * active, the method will start a new Hub.
+ * active, the method will start a new Hub. If on sky map has been allocated
+ * the method does nothing.
  ***************************************************************************/
-void  GSkyMap::publish(const std::string& name) const
+void GSkyMap::publish(const std::string& name) const
 {
     // Create FITS file containing the sky map
     GFits fits;
-    write(fits);
-    // Get last FITS HDU
-    GFitsHDU* hdu = fits[fits.size()-1];
+    // Write sky map into FITS file and return a pointer to the written HDU.
+    // This method returns a NULL pointer if no sky map projection exists,
+    // which typically is true for empty sky maps.
+    GFitsHDU* hdu = write(fits);
-    // Optionally set extension name
-    if (!name.empty()) {
-        hdu->extname(name);
-    }
+    // Continue only if HDU pointer is valid
+    if (hdu != NULL) {
+
+        // Optionally set extension name
+        if (!name.empty()) {
+            hdu->extname(name);
+        }
+
+        // Create VO Client
+        GVOClient client;
-    // Create VO Client
-    GVOClient client;
+        // Publish map using VO client
+        client.publish(*hdu);
-    // Publish map using VO client
-    client.publish(*hdu);
+    } // endif: HDU pointer was valid
     // Return
     return;
@@ -2153,7 +2166,7 @@ void  GSkyMap::publish(const std::string&amp; name) const
 /***********************************************************************//**
  * @brief Print sky map
  *
- * @param[in] chatter Chattiness (defaults to NORMAL).
+ * @param[in] chatter Chattiness.
  * @return String containing sky map information.
  ***************************************************************************/
 std::string GSkyMap::print(const GChatter& chatter) const