Changeset 746 for trunk/psLib/src/image/psImage.h
- Timestamp:
- May 19, 2004, 3:49:47 PM (22 years ago)
- File:
-
- 1 edited
-
trunk/psLib/src/image/psImage.h (modified) (8 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/psLib/src/image/psImage.h
r745 r746 3 3 * @brief Contains basic image definitions and operations 4 4 * 5 * This file defines the basic type for an image struct and functions useful in manupulating images. 5 * This file defines the basic type for an image struct and functions useful 6 * in manupulating images. 6 7 * 7 8 * @author Robert DeSonia, MHPCC 8 9 * @author Ross Harman, MHPCC 9 10 * 10 * @version $Revision: 1.1 2$ $Name: not supported by cvs2svn $11 * @date $Date: 2004-05-20 01: 27:01$11 * @version $Revision: 1.13 $ $Name: not supported by cvs2svn $ 12 * @date $Date: 2004-05-20 01:49:47 $ 12 13 * 13 14 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii … … 32 33 /** Basic image data structure. 33 34 * 34 * Struct for maintaining image data of varying types. It also contains information about image size, parent35 * i mages and children images.35 * Struct for maintaining image data of varying types. It also contains 36 * information about image size, parent images and children images. 36 37 * 37 38 */ … … 72 73 /** Create an image of the specified size and type. 73 74 * 74 * Uses psLib memory allocation functions to create an image struct of the specified size and type. 75 * Uses psLib memory allocation functions to create an image struct of the 76 * specified size and type. 75 77 * 76 78 * @return psImage*: Pointer to psImage. … … 89 91 */ 90 92 psImage* psImageRealloc( 91 psImage* old, ///< the psImage to recycle by resizing image buffer92 unsigned int numCols, ///< the desired number of columns in image93 unsigned int numRows, ///< the desired number of rows in image94 const psElemType type ///< the desired datatype of the image93 psImage* old, ///< the psImage to recycle by resizing image buffer 94 unsigned int numCols, ///< the desired number of columns in image 95 unsigned int numRows, ///< the desired number of rows in image 96 const psElemType type ///< the desired datatype of the image 95 97 ); 96 98 97 99 /** Create a subimage of the specified area. 98 100 * 99 * Uses psLib memory allocation functions to create an image based on a larger one. 101 * Uses psLib memory allocation functions to create an image based on a larger 102 * one. 100 103 * 101 104 * @return psImage*: Pointer to psImage. … … 113 116 /** Destroy the specified image. 114 117 * 115 * Uses psLib memory deallocation functions to free an image and any existing children. 118 * Uses psLib memory deallocation functions to free an image and any existing 119 * children. 116 120 * 117 121 */ … … 126 130 */ 127 131 int psImageFreeChildren( 128 psImage* image ///< psImage in which all children shall be deallocated 132 psImage* image 133 /**< psImage in which all children shall be deallocated */ 129 134 ); 130 135 131 136 /** Makes a copy of a psImage 132 137 * 133 * return psImage* Copy of the input psImage. This may not be equal to the output parameter 138 * return psImage* Copy of the input psImage. This may not be equal to the 139 * output parameter 134 140 * 135 141 */ 136 142 psImage *psImageCopy( 137 143 psImage* restrict output, 138 ///< if not NULL, a psImage that could be recycled. If it can not be used, it will be freed via 139 ///< psImageFree 140 const psImage *input, ///< the psImage to copy 141 psElemType type ///< the desired datatype of the returned copy 144 /**< if not NULL, a psImage that could be recycled. If it can not be used, 145 * it will be freed via psImageFree 146 */ 147 const psImage *input, 148 /**< the psImage to copy */ 149 psElemType type 150 /**< the desired datatype of the returned copy */ 142 151 ); 143 152 144 153 /** Read an image or subimage from a FITS file specified by a filename. 145 154 * 146 * return psImage* The image read from the specified file. NULL signifies that a problem had147 * occured.155 * return psImage* The image read from the specified file. NULL 156 * signifies that a problem had occured. 148 157 */ 149 158 psImage* psImageReadSection( 150 psImage* output, ///< the output psImage to recycle, or NULL if new psImage desired 151 int col0, ///< the column index of the origin to start reading 152 int row0, ///< the row index of the origin to start reading 153 int numCols, ///< the number of desired columns to read 154 int numRows, ///< the number of desired rows to read 155 int z, ///< the z index to read if file is organized as a 3D image cube. 156 char* extname, 157 ///< the image extension to read (this should match the EXTNAME keyword in the extension If NULL, 158 ///< the extnum parameter is to be used instead 159 int extnum, 160 ///< the image extension to read (0=PHU, 1=first extension, etc.) This is only used if extname is 161 ///< NULL 162 char* filename ///< the filename of the FITS image file to read 159 psImage* output, 160 /**< the output psImage to recycle, or NULL if new psImage desired */ 161 int col0, 162 /**< the column index of the origin to start reading */ 163 int row0, 164 /**< the row index of the origin to start reading */ 165 int numCols, 166 /**< the number of desired columns to read */ 167 int numRows, 168 /**< the number of desired rows to read */ 169 int z, 170 /**< the z index to read if file is organized as a 3D image cube. */ 171 char* extname, 172 /**< the image extension to read (this should match the EXTNAME keyword in 173 * the extension If NULL, the extnum parameter is to be used instead 174 */ 175 int extnum, 176 /**< the image extension to read (0=PHU, 1=first extension, etc.) This is 177 * only used if extname is NULL 178 */ 179 char* filename 180 /**< the filename of the FITS image file to read */ 163 181 ); 164 182 165 183 /** Read an image or subimage from a FITS file from a file descriptor 166 184 * 167 * return psImage* The image read from the specified file descriptor. NULL signifies that a problem168 * had occured.185 * return psImage* The image read from the specified file descriptor. 186 * NULL signifies that a problem had occured. 169 187 */ 170 188 psImage* psImageFReadSection( 171 psImage* output, ///< the output psImage to recycle, or NULL if new psImage desired 172 int col0, ///< the column index of the origin to start reading 173 int row0, ///< the row index of the origin to start reading 174 int numCols, ///< the number of desired columns to read 175 int numRows, ///< the number of desired rows to read 176 int z, ///< the z index to read if file is organized as a 3D image cube. 177 char* extname, 178 ///< the image extension to read (this should match the EXTNAME keyword in the extension If NULL, 179 ///< the extnum parameter is to be used instead 180 int extnum, 181 ///< the image extension to read (0=PHU, 1=first extension, etc.) This is only used if extname is 182 ///< NULL 183 FILE* f ///< the file descriptor of the FITS file 189 psImage* output, 190 /**< the output psImage to recycle, or NULL if new psImage desired */ 191 int col0, 192 /**< the column index of the origin to start reading */ 193 int row0, 194 /**< the row index of the origin to start reading */ 195 int numCols, 196 /**< the number of desired columns to read */ 197 int numRows, 198 /**< the number of desired rows to read */ 199 int z, 200 /**< the z index to read if file is organized as a 3D image cube. */ 201 char* extname, 202 /**< the image extension to read (this should match the EXTNAME keyword in 203 * the extension If NULL, the extnum parameter is to be used instead 204 */ 205 int extnum, 206 /**< the image extension to read (0=PHU, 1=first extension, etc.) This is 207 * only used if extname is NULL 208 */ 209 FILE* f 210 /**< the file descriptor of the FITS file */ 184 211 ); 185 212 … … 189 216 */ 190 217 psImage* psImageWriteSection( 191 psImage* input, ///< the psImage to write 192 int col0, ///< the column index of the origin to start writing 193 int row0, ///< the row index of the origin to start writing 194 int z, ///< the z index to start writing 195 char* extname, 196 ///< the image extension to write (this should match the EXTNAME keyword in the extension If NULL, 197 ///< the extnum parameter is to be used instead 198 int extnum, 199 ///< the image extension to write (0=PHU, 1=first extension, etc.) This is only used if extname is 200 ///< NULL 201 char* filename ///< the filename of the FITS image file to write 218 psImage* input, 219 /**< the psImage to write */ 220 int col0, 221 /**< the column index of the origin to start writing */ 222 int row0, 223 /**< the row index of the origin to start writing */ 224 int z, 225 /**< the z index to start writing */ 226 char* extname, 227 /**< the image extension to write (this should match the EXTNAME keyword in 228 * the extension If NULL, the extnum parameter is to be used instead 229 */ 230 int extnum, 231 /**< the image extension to write (0=PHU, 1=first extension, etc.) This is 232 * only used if extname is NULL. 233 */ 234 char* filename 235 /**< the filename of the FITS image file to write */ 202 236 ); 203 237 … … 207 241 */ 208 242 psImage* psImageFWriteSection( 209 psImage* input, ///< the psImage to write 210 int col0, ///< the column index of the origin to start writing 211 int row0, ///< the row index of the origin to start writing 212 int z, ///< the z index to start writing 213 char* extname, 214 ///< the image extension to write (this should match the EXTNAME keyword in the extension If NULL, 215 ///< the extnum parameter is to be used instead 216 int extnum, 217 ///< the image extension to write (0=PHU, 1=first extension, etc.) This is only used if extname is 218 ///< NULL 219 FILE* f ///< the file descriptor of the FITS file 243 psImage* input, 244 /**< the psImage to write */ 245 int col0, 246 /**< the column index of the origin to start writing */ 247 int row0, 248 /**< the row index of the origin to start writing */ 249 int z, 250 /**< the z index to start writing */ 251 char* extname, 252 /**< the image extension to write (this should match the EXTNAME keyword in 253 * the extension If NULL, the extnum parameter is to be used instead 254 */ 255 int extnum, 256 /**< the image extension to write (0=PHU, 1=first extension, etc.) This is 257 * only used if extname is NULL. 258 */ 259 FILE* f 260 /**< the file descriptor of the FITS file */ 220 261 ); 221 262
Note:
See TracChangeset
for help on using the changeset viewer.
