Index: trunk/psLib/src/image/psImage.h =================================================================== --- trunk/psLib/src/image/psImage.h (revision 745) +++ trunk/psLib/src/image/psImage.h (revision 746) @@ -3,11 +3,12 @@ * @brief Contains basic image definitions and operations * - * This file defines the basic type for an image struct and functions useful in manupulating images. + * 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.12 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-05-20 01:27:01 $ + * @version $Revision: 1.13 $ $Name: not supported by cvs2svn $ + * @date $Date: 2004-05-20 01:49:47 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -32,6 +33,6 @@ /** Basic image data structure. * - * Struct for maintaining image data of varying types. It also contains information about image size, parent - * images and children images. + * Struct for maintaining image data of varying types. It also contains + * information about image size, parent images and children images. * */ @@ -72,5 +73,6 @@ /** Create an image of the specified size and type. * - * Uses psLib memory allocation functions to create an image struct of the specified size and type. + * Uses psLib memory allocation functions to create an image struct of the + * specified size and type. * * @return psImage*: Pointer to psImage. @@ -89,13 +91,14 @@ */ 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 + 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. * - * Uses psLib memory allocation functions to create an image based on a larger one. + * Uses psLib memory allocation functions to create an image based on a larger + * one. * * @return psImage*: Pointer to psImage. @@ -113,5 +116,6 @@ /** Destroy the specified image. * - * Uses psLib memory deallocation functions to free an image and any existing children. + * Uses psLib memory deallocation functions to free an image and any existing + * children. * */ @@ -126,60 +130,83 @@ */ int psImageFreeChildren( - psImage* image ///< psImage in which all children shall be deallocated + psImage* image + /**< psImage in which all children shall be deallocated */ ); /** Makes a copy of a psImage * - * return psImage* Copy of the input psImage. This may not be equal to the output parameter + * return psImage* Copy of the input psImage. This may not be equal to the + * output parameter * */ psImage *psImageCopy( psImage* restrict output, - ///< if not NULL, a psImage that could be recycled. If it can not be used, it will be freed via - ///< psImageFree - const psImage *input, ///< the psImage to copy - psElemType type ///< the desired datatype of the returned copy + /**< if not NULL, a psImage that could be recycled. If it can not be used, + * it will be freed via psImageFree + */ + const psImage *input, + /**< the psImage to copy */ + psElemType type + /**< the desired datatype of the returned copy */ ); /** 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. + * 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 + 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. + * 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 + 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 */ ); @@ -189,15 +216,22 @@ */ 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 + 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 */ ); @@ -207,15 +241,22 @@ */ 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 + 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 */ );