IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Aug 9, 2004, 3:05:53 PM (22 years ago)
Author:
desonia
Message:

doxygen comments added.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/psLib/src/image/psImageIO.h

    r1441 r1442  
    1010 *  @author Robert DeSonia, MHPCC
    1111 *
    12  *  @version $Revision: 1.6 $ $Name: not supported by cvs2svn $
    13  *  @date $Date: 2004-08-09 23:40:55 $
     12 *  @version $Revision: 1.7 $ $Name: not supported by cvs2svn $
     13 *  @date $Date: 2004-08-10 01:05:53 $
    1414 *
    1515 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    3030 *                          signifies that a problem had occured.
    3131 */
    32 psImage* psImageReadSection(psImage* output,
     32psImage* psImageReadSection(
     33    psImage* output,
     34    /**< the output psImage to recycle, or NULL if new psImage desired */
    3335
    34                             /**< the output psImage to recycle, or NULL if new psImage desired */
    35                             int col0,
     36    int col0,
     37    /**< the column index of the origin to start reading */
    3638
    37                             /**< the column index of the origin to start reading */
    38                             int row0,
     39    int row0,
     40    /**< the row index of the origin to start reading */
    3941
    40                             /**< the row index of the origin to start reading */
    41                             int numCols,
     42    int numCols,
     43    /**< the number of desired columns to read */
    4244
    43                             /**< the number of desired columns to read */
    44                             int numRows,
     45    int numRows,
     46    /**< the number of desired rows to read */
    4547
    46                             /**< the number of desired rows to read */
    47                             int z,
     48    int z,
     49    /**< the z index to read if file is organized as a 3D image cube. */
    4850
    49                             /**< the z index to read if file is organized as a 3D image cube. */
    50                             char *extname,
     51    char *extname,
     52    /**< the image extension to read (this should match the EXTNAME keyword in
     53        *   the extension If NULL, the extnum parameter is to be used instead
     54        */
    5155
    52                             /**< the image extension to read (this should match the EXTNAME keyword in
    53                              *   the extension If NULL, the extnum parameter is to be used instead
    54                              */
    55                             int extnum,
     56    int extnum,
     57    /**< the image extension to read (0=PHU, 1=first extension, etc.)  This is
     58        *   only used if extname is NULL
     59        */
    5660
    57                             /**< the image extension to read (0=PHU, 1=first extension, etc.)  This is
    58                              *   only used if extname is NULL
    59                              */
    60                             char *filename
    61 
    62                             /**< the filename of the FITS image file to read */
    63                            );
     61    char *filename
     62    /**< the filename of the FITS image file to read */
     63);
    6464
    6565/** Read an image or subimage from a FITS file specified by a filename.
    … …  
    6767 *  return bool         TRUE is successful, otherwise FALSE.
    6868 */
    69 bool psImageWriteSection(psImage* input,
     69bool psImageWriteSection(
     70    psImage* input,
     71    /**< the psImage to write */
    7072
    71                          /**< the psImage to write */
    72                          int col0,
     73    int col0,
     74    /**< the column index of the origin to start writing */
    7375
    74                          /**< the column index of the origin to start writing */
    75                          int row0,
     76    int row0,
     77    /**< the row index of the origin to start writing */
    7678
    77                          /**< the row index of the origin to start writing */
    78                          int z,
     79    int z,
     80    /**< the z index to start writing */
    7981
    80                          /**< the z index to start writing */
    81                          char *extname,
     82    char *extname,
     83    /**< the image extension to write (this should match the EXTNAME keyword in
     84    *   the extension If NULL, the extnum parameter is to be used instead
     85    */
    8286
    83                          /**< the image extension to write (this should match the EXTNAME keyword in
    84                           *   the extension If NULL, the extnum parameter is to be used instead
    85                           */
    86                          int extnum,
     87    int extnum,
     88    /**< the image extension to write (0=PHU, 1=first extension, etc.)  This is
     89    *   only used if extname is NULL.
     90    */
    8791
    88                          /**< the image extension to write (0=PHU, 1=first extension, etc.)  This is
    89                           *   only used if extname is NULL.
    90                           */
    91                          char *filename
    92 
    93                          /**< the filename of the FITS image file to write */
    94                         );
     92    char *filename
     93    /**< the filename of the FITS image file to write */
     94);
    9595
    9696/// @}
Note: See TracChangeset for help on using the changeset viewer.