IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Jan 12, 2005, 12:17:02 PM (22 years ago)
Author:
desonia
Message:

added tests for some psFits functions.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/psLib/src/fileUtils/psFits.h

    r2806 r2962  
    77 *  @author Robert DeSonia, MHPCC
    88 *
    9  *  @version $Revision: 1.3 $ $Name: not supported by cvs2svn $
    10  *  @date $Date: 2004-12-23 19:13:53 $
     9 *  @version $Revision: 1.4 $ $Name: not supported by cvs2svn $
     10 *  @date $Date: 2005-01-12 22:17:01 $
    1111 *
    1212 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    3737
    3838/** FITS file object.
    39  * 
     39 *
    4040 *  This object should be considered opaque to the user; no item in this
    4141 *  struct should be accessed directly.
    … …  
    5151/** Opens a FITS file and allocates the associated psFits object.
    5252 *
    53  *  @return psFits*    new psFits object for the FITS files specified or 
     53 *  @return psFits*    new psFits object for the FITS files specified or
    5454 *                     NULL if the open of the FITS file failed
    5555 */
    5656psFits* psFitsAlloc(
    57     const char* name,                  ///< the FITS file name
    58     bool readwrite                     ///< if TRUE, the file is open for read/write.
     57    const char* name                   ///< the FITS file name
    5958);
    6059
    … …  
    8988/** Get the current extension name.
    9089 *
    91  *  @return int        Current HDU name of the psFits file or NULL if an 
     90 *  @return int        Current HDU name of the psFits file or NULL if an
    9291 *                     error occurred.
    9392 */
    … …  
    9695);
    9796
     97/** Set the current extension's name
     98 *
     99 *  @return bool       TRUE if the extension was successfully set, otherwise FALSE.
     100 */
     101bool psFitsSetExtName(
     102    psFits* fits,                      ///< the psFits object
     103    const char* name                   ///< the extension name
     104);
     105
    98106/** Get the total number of HDUs in the FITS file.
    99107 *
    100  *  @return int        The total number of HDUs in the FITS file or < 0 if an 
     108 *  @return int        The total number of HDUs in the FITS file or < 0 if an
    101109 *                     error occurred.
    102110 */
    … …  
    107115/** Get the extension type of the current HDU.
    108116 *
    109  *  @return psFitsType The type of the current HDU.  If PS_FITS_TYPE_UNKNOWN, 
     117 *  @return psFitsType The type of the current HDU.  If PS_FITS_TYPE_UNKNOWN,
    110118 *                     the type could not be determined.
    111119 */
    … …  
    151159 *  @return psImage*     the read image or NULL if there was an error.
    152160 */
    153 psImage* psFitsReadImageSection(
     161psImage* psFitsReadImage(
    154162    psImage* out,                      ///< a psImage to recycle.
    155163    psFits* fits,                      ///< the psFits object
    … …  
    182190 *  PS_FITS_TYPE_BINARY_TABLE or PS_FITS_TYPE_ASCII_TABLE.
    183191 *
    184  *  @return psArray*    Array of data items for the specified column or NULL 
     192 *  @return psArray*    Array of data items for the specified column or NULL
    185193 *                      if an error occurred.
    186194 */
    … …  
    207215 *  @return psArray*     Array of psMetadata items, which contains the output
    208216 *                       data items of each row.
    209  * 
     217 *
    210218 *  @see psFitsReadTableRow
    211219 */
    … …  
    218226 *
    219227 *  @return bool        TRUE if the write was successful, otherwise FALSE
    220  * 
     228 *
    221229 *  @see psFitsReadTableRow
    222230 */
Note: See TracChangeset for help on using the changeset viewer.