Changeset 6515

Timestamp:

Mar 3, 2006, 4:40:14 PM (20 years ago)

Author:

Paul Price

Message:

Added psFitsReadImageCube, psFitsWriteImageCube, psFitsUpdateImageCube.
Modified psFitsWriteImage, psFitsReadImage to conform to SDRS.

File:

• branches/rel10_ifa/psLib/src/fits/psFitsImage.h (modified) (4 diffs)

branches/rel10_ifa/psLib/src/fits/psFitsImage.h

@@ -7 +7 @@
  *  @author Robert DeSonia, MHPCC
  *
- *  @version $Revision: 1.1 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-11-14 22:18:30 $
+ *  @version $Revision: 1.1.10.1 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2006-03-04 02:40:14 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -32 +32 @@
  */
 psImage* psFitsReadImage(
-    psImage* out,                      ///< a psImage to recycle.
     const psFits* fits,                ///< the psFits object
     psRegion region,                   ///< the region in the FITS image to read
@@ -46 +45 @@
     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
+    const char *extname                ///< the extension name
 );
 
@@ -56 +56 @@
     psFits* fits,                      ///< the psFits object
     const psImage* input,              ///< the image to output
-    psRegion region,                   ///< the region in the FITS image to write
+    int x0,                            ///< the x offset on the FITS image to write
+    int y0,                            ///< the y offset on the FITS image to write
     int z                              ///< the z-planes of the FITS image data cube to write
+);
+
+/** Reads an image cube into an array of images
+ *
+ * @return psArray*     Array of images, or NULL if an error.
+ */
+psArray *psFitsReadImageCube(
+    const psFits *fits,                 ///< The FITS file pointer
+    psRegion region                     ///< Region in the image to read
+);
+
+/** Writes an image cube from an array of images
+ *
+ * @return bool          TRUE if the operation was successful; otherwise FALSE.
+ */
+bool psFitsWriteImageCube(
+    psFits *fits,                       ///< The FITS file pointer
+    psMetadata *header,                 ///< The FITS header, or NULL
+    const psArray *input,               ///< The input array of images
+    const char *extname                 ///< The extension name
+);
+
+/** Updates an image cube from an array of images
+ *
+ * @return bool          TRUE if the operation was successful; otherwise FALSE.
+ */
+bool psFitsUpdateImageCube(
+    psFits *fits,                       ///< The FITS file pointer
+    const psArray *input,               ///< The input array of images
+    int x0,                             ///< The x offset on the FITS image
+    int y0                              ///< The y offset on the FITS image
 );