Changeset 3028 for trunk/psLib/src/dataIO/psFits.h

Timestamp:

Jan 17, 2005, 5:15:04 PM (22 years ago)

Author:

desonia

Message:

Added tests for psFitsReadImage & psFitsWriteImage. Also re-enabled
some 'not a requirement' code to support a superset of the required
datatype for various functions.

File:

• trunk/psLib/src/dataIO/psFits.h (modified) (3 diffs)

trunk/psLib/src/dataIO/psFits.h

@@ -7 +7 @@
  *  @author Robert DeSonia, MHPCC
  *
- *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-01-12 22:17:01 $
+ *  @version $Revision: 1.5 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-01-18 03:15:03 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -172 +172 @@
 bool psFitsWriteImage(
     psFits* fits,                      ///< the psFits object
-    const psMetadata* header,
+    const psMetadata* header,          ///< header items for the new HDU.  Can be NULL.
     const psImage* input,              ///< the image to output
-    int depth                          ///< the number of z-planes of the FITS image data cube
+    int depth,                         ///< the number of z-planes of the FITS image data cube
+    char* extname                      ///< extension name
+);
+
+/** Updates the FITS file image, given the desired region and z-plane.
+ *
+ *  @return bool        TRUE is the write was successful, otherwise FALSE.
+ */
+bool psFitsUpdateImage(
+    psFits* fits,                      ///< the psFits object
+    const psImage* input,              ///< the image to output
+    psRegion region,                   ///< the region in the FITS image to write
+    int z                              ///< the z-planes of the FITS image data cube to write
 );
 
@@ -231 +243 @@
 bool psFitsWriteTable(
     psFits* fits,                      ///< the psFits object
-    psMetadata* header,
+    psMetadata* header,                ///< header items for the new HDU.  Can be NULL.
     psArray* table,
     ///< Array of psMetadata items, which contains the output data items of each row.
-    char* extname
+    char* extname                      ///< extension name
+);
+
+/** Updates a FITS table.  The current HDU type must be either
+ *  PS_FITS_TYPE_BINARY_TABLE or PS_FITS_TYPE_ASCII_TABLE.
+ *
+ *  @return bool        TRUE if the write was successful, otherwise FALSE
+ *
+ *  @see psFitsWriteTable
+ */
+bool psFitsUpdateTable(
+    psFits* fits,                      ///< the psFits object
+    psArray* table
+    ///< Array of psMetadata items, which contains the output data items of each row.
 );