Changeset 19384 for trunk/psLib/src/fits/psFitsImage.h

Timestamp:

Sep 4, 2008, 10:08:33 PM (18 years ago)

Author:

Paul Price

Message:

Adding functions psFitsWriteImageCubeWithMask and psFitsUpdateImageCubeWithMask. psModules generally writes images as cubes, so need these to get the mask down into psFitsWriteImage.

File:

• trunk/psLib/src/fits/psFitsImage.h (modified) (2 diffs)

trunk/psLib/src/fits/psFitsImage.h

@@ -4 +4 @@
  * @author Robert DeSonia, MHPCC
  *
- * @version $Revision: 1.9 $ $Name: not supported by cvs2svn $
- * @date $Date: 2008-09-05 07:51:09 $
+ * @version $Revision: 1.10 $ $Name: not supported by cvs2svn $
+ * @date $Date: 2008-09-05 08:08:33 $
  * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
  */
@@ -134 +134 @@
 );
 
-psArray *psFitsReadImageCube(const psFits *fits, psRegion region);
+/// Read an image cube (3D image with each plane a separate image)
+///
+/// Images are returned in an array of psImage
+psArray *psFitsReadImageCube(
+    const psFits *fits,                 ///< FITS file to read
+    psRegion region                     ///< Region to read
+    );
 
-bool psFitsWriteImageCube(psFits *fits, psMetadata *header, const psArray *input, const char *extname);
+/// Write an image cube (3D image from an array of images)
+bool psFitsWriteImageCube(
+    psFits *fits,                       ///< FITS file to write
+    psMetadata *header,                 ///< Header to write
+    const psArray *input,               ///< Array of images
+    const char *extname                 ///< Name of extension
+    );
 
-bool psFitsUpdateImageCube(psFits *fits, const psArray *input, int x0, int y0);
+/// Write an image cube (3D image from an array of images), optionally using the supplied mask images to do
+/// statistics when compressing
+bool psFitsWriteImageCubeWithMask(
+    psFits *fits,                       ///< FITS file to write
+    psMetadata *header,                 ///< Header to write
+    const psArray *input,               ///< Array of images
+    const psArray *masks,               ///< Array of masks
+    psMaskType maskVal,                 ///< Value to mask
+    const char *extname                 ///< Name of extension
+    );
+
+/// Update an image cube (3D image from an array of images)
+bool psFitsUpdateImageCube(
+    psFits *fits,                       ///< FITS file to update
+    const psArray *input,               ///< Array of images
+    int x0,                             ///< x origin of images in FITS image coordinates
+    int y0                              ///< y origin of images in FITS image coordinates
+    );
+
+/// Update an image cube (3D image from an array of images), optionally using the supplied mask images to do
+/// statistics when compressing
+bool psFitsUpdateImageCubeWithMask(
+    psFits *fits,                       ///< FITS file to update
+    const psArray *input,               ///< Array of images
+    const psArray *masks,               ///< Array of masks
+    psMaskType maskVal,                 ///< Value to mask
+    int x0,                             ///< x origin of images in FITS image coordinates
+    int y0                              ///< y origin of images in FITS image coordinates
+    );
 
 /// @}