start implementing table column saving

knodlseder
1 parent 4f8446be
Showing 11 changed files with 162 additions and 3 deletions
include/GException.hpp
include/GFitsCfitsio.hpp
include/GFitsTableCol.hpp
include/GFitsTableDblCol.hpp
include/GFitsTableFltCol.hpp
include/GFitsTableLngCol.hpp
include/GFitsTableShtCol.hpp
include/GFitsTableStrCol.hpp
src/GException.cpp
src/fits/GFitsTable.cpp
src/fits/GFitsTableDblCol.cpp
@@ -169,6 +169,7 @@ public:
     class fits_hdu_not_found : public GExceptionHandler {
     public:
         fits_hdu_not_found(string origin, string extname, int status = 0);
+        fits_hdu_not_found(string origin, int extno, int status = 0);
     };
  
     // FITS unknown HDU type
@@ -47,6 +47,7 @@
 #define __ffgncl(A, B, C) ffgncl(A, B, C)
 #define __ffgsv(A, B, C, D, E, F, G, H, I) ffgsv(A, B, C, D, E, F, G, H, I)
 #define __ffgtcl(A, B, C, D, E, F) ffgtcl(A, B, C, D, E, F)
+#define __fficol(A, B, C, D, E) fficol(A, B, C, D, E)
 #define __ffinit(A, B, C) ffinit(A, B, C)
 #define __ffopen(A, B, C, D) ffopen(A, B, C, D)
 #define __ffmahd(A, B, C, D) ffmahd(A, B, C, D)
@@ -97,6 +98,7 @@ typedef fitsfile __fitsfile;
 #define __ffgncl(A, B, C) __dummy()
 #define __ffgsv(A, B, C, D, E, F, G, H, I) __dummy()
 #define __ffgtcl(A, B, C, D, E, F) __dummy()
+#define __fficol(A, B, C, D, E) __dummy()
 #define __ffinit(A, B, C) __dummy()
 #define __ffmahd(A, B, C, D) __dummy()
 #define __ffopen(A, B, C, D) __dummy()
@@ -51,6 +51,7 @@ public:
     GFitsTableCol& operator= (const GFitsTableCol& column);
  
     // Virtual Methods
+    virtual void           save(void) = 0;
     virtual std::string    string(const int& row, const int& inx = 0) = 0;
     virtual double         real(const int& row, const int& inx = 0) = 0;
     virtual int            integer(const int& row, const int& inx = 0) = 0;
@@ -51,6 +51,7 @@ public:
     const double&     operator() (const int& row, const int& inx = 0) const;
  
     // Methods
+    void              save(void);
     std::string       string(const int& row, const int& inx = 0);
     double            real(const int& row, const int& inx = 0);
     int               integer(const int& row, const int& inx = 0);
@@ -48,6 +48,7 @@ public:
     GFitsTableFltCol& operator= (const GFitsTableFltCol& column);
  
     // Methods
+    void              save(void);
     std::string       string(const int& row, const int& col = 0);
     double            real(const int& row, const int& col = 0);
     int               integer(const int& row, const int& col = 0);
@@ -50,6 +50,7 @@ public:
     const long&       operator() (const int& row, const int& inx = 0) const;
  
     // Methods
+    void              save(void);
     std::string       string(const int& row, const int& col = 0);
     double            real(const int& row, const int& col = 0);
     int               integer(const int& row, const int& col = 0);
@@ -39,6 +39,7 @@ public:
     GFitsTableShtCol& operator= (const GFitsTableShtCol& column);
  
     // Methods
+    void              save(void);
     std::string       string(const int& row, const int& col = 0);
     double            real(const int& row, const int& col = 0);
     int               integer(const int& row, const int& col = 0);
@@ -39,6 +39,7 @@ public:
     GFitsTableStrCol& operator= (const GFitsTableStrCol& column);
  
     // Methods
+    void              save(void);
     std::string       string(const int& row, const int& col = 0);
     double            real(const int& row, const int& col = 0);
     int               integer(const int& row, const int& col = 0);
@@ -353,6 +353,24 @@ GException::fits_hdu_not_found::fits_hdu_not_found(string origin,
  
  
 /***********************************************************************//**
+ * @brief FITS error: HDU not found in FITS file
+ *
+ * @param[in] origin Method that throws the error.
+ * @param[in] extno Extension number (starting from 1).
+ * @param[in] status cfitsio status.
+ ***************************************************************************/
+GException::fits_hdu_not_found::fits_hdu_not_found(string origin,
+                                                   int    extno,
+                                                   int    status)
+{
+    m_origin  = origin;
+    m_message = "HDU number '" + str(extno) + "' not found in FITS file";
+    if (status != 0)
+        m_message += " (status=" + str(status) + ")";
+}
+
+
+/***********************************************************************//**
  * @brief FITS error: HDU of unknown type found
  *
  * @param[in] origin Method that throws the error.
@@ -166,6 +166,13 @@ GFitsTable&amp; GFitsTable::operator= (const GFitsTable&amp; table)
  *
  * @param[in] fptr FITS file pointer
  *
+ * @exception GException::fits_hdu_not_found
+ *            Specified HDU not found in FITS file.
+ * @exception GException::fits_error
+ *            A CFITSIO error occured during loading the table.
+ * @exception GException::fits_unknown_coltype
+ *            FITS column of unknown type has been found in the FITS file.
+ *
  * Builds a description of the table in memory.
  * Columns are not loaded but column descriptors are allocated.
  * The column data will only be loaded once it needs to be accessed.
@@ -176,7 +183,8 @@ void GFitsTable::open(__fitsfile* fptr)
     int status = 0;
     status     = __ffmahd(fptr, (fptr->HDUposition)+1, NULL, &status);
     if (status != 0)
-        throw GException::fits_error(G_OPEN, status);
+        throw GException::fits_hdu_not_found(G_OPEN, (fptr->HDUposition)+1,
+                                             status);
  
     // Save FITS file pointer
     m_fitsfile = *fptr;
@@ -259,6 +267,11 @@ void GFitsTable::open(__fitsfile* fptr)
  
 /***********************************************************************//**
  * @brief Save FITS table
+ *
+ * @exception GException::fits_error
+ *            A CFITSIO error occured in this method.
+ * @exception GException::fits_bad_col_length
+ *            Table columns have inconsistent lengths.
  ***************************************************************************/
 void GFitsTable::save(void)
 {
@@ -322,6 +335,89 @@ void GFitsTable::save(void)
     else if (status != 0)
         throw GException::fits_error(G_SAVE, status);
  
+    // Determine number of columns in table
+    int num_cols = 0;
+    status = __ffgncl(&m_fitsfile, &num_cols, &status);
+    if (status != 0)
+        throw GException::fits_error(G_SAVE, status);
+
+    // If we have no columns in the table then delete all columns from FITS table
+    if (m_columns == NULL) {
+        // TBD: Delete all columns from FITS table
+    }
+    
+    // ... else update the FITS table
+    else {
+    
+        // Make sure that all columns have the same length. Columns with zero
+        // length will not be considered
+        int length = 0;
+        for (int i = 0; i < m_cols; ++i) {
+            if (m_columns[i] != NULL && m_columns[i]->length() > 0) {
+                if (length == 0)
+                    length = m_columns[i]->length();
+                else if (m_columns[i]->length() != length) {
+                    throw GException::fits_bad_col_length(G_SAVE, 
+                                                          m_columns[i]->length(),
+                                                          length);
+                }
+            }
+        }
+
+        // If the table length differs from number of rows in the FITS file
+        // then ????
+        // TBD
+
+        // Update all columns. The 'm_colnum' field specifies where in the
+        // FITS file the column resides. If 'm_colnum=0' then we append
+        // another column
+        for (int i = 0; i < m_cols; ++i) {
+            if (m_columns[i] != NULL) {
+                if (m_columns[i]->m_colnum == 0) {
+                
+cout << "needs appending of column to FITS file " << num_cols << endl;
+                    // Append column to FITS file
+                    status = __fficol(&m_fitsfile, num_cols, get_ttype(i), 
+                                      get_tform(i), &status);
+                    if (status != 0)
+                        throw GException::fits_error(G_SAVE, status);
+                    
+                    // Update the 'm_colnum' field in table
+                    m_columns[i]->m_colnum = num_cols;
+                    
+                    // Increment number of columns in FITS file
+                    num_cols++;
+                }
+                else {
+                    cout << "write column into " << m_columns[i]->m_colnum << endl;
+                    //m_columns[i]->save();
+                }
+            }
+        }
+        
+        // Delete all unused columns of FITS file (from last to first!!!)
+        for (int colnum = num_cols; colnum > 0; --colnum) {
+
+            // Initialise column usage flag
+            int used = 0;
+
+            // Search column number in table
+            for (int i = 0; i < m_cols; ++i) {
+                if (m_columns[i] != NULL && m_columns[i]->m_colnum == colnum) {
+                    used = 1;
+                    break;
+                }
+            }
+            
+            // Delete unused column
+            if (!used) {
+                // delete FITS column 'colnum'
+            }
+            
+        } // endfor: Looped over all FITS columns
+        
+    } // endelse: FITS table has been updated
+
 //cout << "GFitsTable::save exit" << endl;
     // Return
     return;
@@ -469,8 +565,13 @@ void GFitsTable::insert_column(int colnum, GFitsTableCol&amp; column)
         break;
     }
  
-    // Set column attributes
-    //m_columns[colnum]->m_colnum = colnum + 1; // IS THIS REALLY NEEDED???
+    // Set column number (this is important to known from which column in the
+    // FITS file the data should be read
+    //// NO NO NO !!! Only for columns that exist in the FITS file !!! 
+    //// m_columns[colnum]->m_colnum = colnum + 1;
+    // Reset column number since column does not already exist in FITS
+    // file
+    m_columns[colnum]->m_colnum = 0;
  
     // Return
     return;
@@ -20,6 +20,7 @@
 /* __ Namespaces _________________________________________________________ */
  
 /* __ Method name definitions ____________________________________________ */
+#define G_SAVE       "GFitsTableDblCol::save(void)"
 #define G_STRING     "GFitsTableDblCol::string(const int&, const int&)"
 #define G_REAL       "GFitsTableDblCol::real(const int&, const int&)"
 #define G_INTEGER    "GFitsTableDblCol::integer(const int&, const int&)"
@@ -200,6 +201,36 @@ const double&amp; GFitsTableDblCol::operator() (const int&amp; row, const int&amp; inx)
  ==========================================================================*/
  
 /***********************************************************************//**
+ * @brief Save table column into FITS file
+ *
+ * @exception GException::fits_hdu_not_found
+ *            Specified HDU not found in FITS file.
+ ***************************************************************************/
+void GFitsTableDblCol::save(void)
+{
+    // Continue only if a FITS file is connected
+    if (m_fitsfile.Fptr != NULL) {
+
+        // Move to the HDU
+        int status = 0;
+        status     = __ffmahd(&m_fitsfile, (m_fitsfile.HDUposition)+1, NULL,
+                              &status);
+        if (status != 0)
+            throw GException::fits_hdu_not_found(G_SAVE, 
+                                                 (m_fitsfile.HDUposition)+1,
+                                                 status);
+    
+        // Save the column data
+        // TBD
+    
+    } // endif: FITS file was connected
+    
+    // Return
+    return;
+}
+
+
+/***********************************************************************//**
  * @brief Get string value
  *
  * @param[in] row Table row.