Changeset 745 for trunk/psLib/src/image/psImage.h

Timestamp:

May 19, 2004, 3:27:01 PM (22 years ago)

Author:

desonia

Message:

added Image I/O function prototypes.

File:

• trunk/psLib/src/image/psImage.h (modified) (3 diffs)

trunk/psLib/src/image/psImage.h

@@ -5 +5 @@
  *  This file defines the basic type for an image struct and functions useful in manupulating images.
  *
+ *  @author Robert DeSonia, MHPCC
  *  @author Ross Harman, MHPCC
- *   
- *  @version $Revision: 1.11 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-05-19 01:20:02 $
+ *
+ *  @version $Revision: 1.12 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-05-20 01:27:01 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -82 +83 @@
 );
 
+/** Resize a given image to the given size/type.
+ *
+ *  return psImage* Resized psImage.
+ *
+ */
+psImage* psImageRealloc(
+    psImage* old,                   ///< the psImage to recycle by resizing image buffer
+    unsigned int numCols,           ///< the desired number of columns in image
+    unsigned int numRows,           ///< the desired number of rows in image
+    const psElemType type           ///< the desired datatype of the image
+);
+
 /** Create a subimage of the specified area.
  *
@@ -129 +142 @@
 );
 
-/** Resize a given image to the given size/type.
- *
- *  return psImage* Resized psImage.
- *
- */
-psImage* psImageRealloc(
-    psImage* old,                   ///< the psImage to recycle by resizing image buffer
-    unsigned int numCols,           ///< the desired number of columns in image
-    unsigned int numRows,           ///< the desired number of rows in image
-    const psElemType type           ///< the desired datatype of the image
+/** Read an image or subimage from a FITS file specified by a filename.
+ *
+ *  return psImage*         The image read from the specified file.  NULL signifies that a problem had
+ *                          occured.
+ */
+psImage* psImageReadSection(
+    psImage* output,                ///< the output psImage to recycle, or NULL if new psImage desired
+    int col0,                       ///< the column index of the origin to start reading
+    int row0,                       ///< the row index of the origin to start reading
+    int numCols,                    ///< the number of desired columns to read
+    int numRows,                    ///< the number of desired rows to read
+    int z,                          ///< the z index to read if file is organized as a 3D image cube.
+    char* extname,
+    ///< the image extension to read (this should match the EXTNAME keyword in the extension If NULL,
+    ///< the extnum parameter is to be used instead
+    int extnum,
+    ///< the image extension to read (0=PHU, 1=first extension, etc.)  This is only used if extname is
+    ///< NULL
+    char* filename                  ///< the filename of the FITS image file to read
+);
+
+/** Read an image or subimage from a FITS file from a file descriptor
+ *
+ *  return psImage*         The image read from the specified file descriptor.  NULL signifies that a problem
+ *                          had occured.
+ */
+psImage* psImageFReadSection(
+    psImage* output,                ///< the output psImage to recycle, or NULL if new psImage desired
+    int col0,                       ///< the column index of the origin to start reading
+    int row0,                       ///< the row index of the origin to start reading
+    int numCols,                    ///< the number of desired columns to read
+    int numRows,                    ///< the number of desired rows to read
+    int z,                          ///< the z index to read if file is organized as a 3D image cube.
+    char* extname,
+    ///< the image extension to read (this should match the EXTNAME keyword in the extension If NULL,
+    ///< the extnum parameter is to be used instead
+    int extnum,
+    ///< the image extension to read (0=PHU, 1=first extension, etc.)  This is only used if extname is
+    ///< NULL
+    FILE* f                         ///< the file descriptor of the FITS file
+);
+
+/** Read an image or subimage from a FITS file specified by a filename.
+ *
+ *  return psImage*         NULL if an error, otherwise same as input psImage
+ */
+psImage* psImageWriteSection(
+    psImage* input,                 ///< the psImage to write
+    int col0,                       ///< the column index of the origin to start writing
+    int row0,                       ///< the row index of the origin to start writing
+    int z,                          ///< the z index to start writing
+    char* extname,
+    ///< the image extension to write (this should match the EXTNAME keyword in the extension If NULL,
+    ///< the extnum parameter is to be used instead
+    int extnum,
+    ///< the image extension to write (0=PHU, 1=first extension, etc.)  This is only used if extname is
+    ///< NULL
+    char* filename                  ///< the filename of the FITS image file to write
+);
+
+/** Read an image or subimage from a FITS file from a file descriptor.
+ *
+ *  return psImage*         NULL if an error, otherwise same as input psImage
+ */
+psImage* psImageFWriteSection(
+    psImage* input,                 ///< the psImage to write
+    int col0,                       ///< the column index of the origin to start writing
+    int row0,                       ///< the row index of the origin to start writing
+    int z,                          ///< the z index to start writing
+    char* extname,
+    ///< the image extension to write (this should match the EXTNAME keyword in the extension If NULL,
+    ///< the extnum parameter is to be used instead
+    int extnum,
+    ///< the image extension to write (0=PHU, 1=first extension, etc.)  This is only used if extname is
+    ///< NULL
+    FILE* f                         ///< the file descriptor of the FITS file
 );