IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Changeset 1621


Ignore:
Timestamp:
Aug 25, 2004, 10:21:41 AM (22 years ago)
Author:
harman
Message:

Removed FReadHeader function and added ReadHeader function

Location:
trunk/psLib/src
Files:
6 edited

Legend:

Unmodified
Added
Removed

  • trunk/psLib/src/astronomy/psMetadata.c

    r1546 r1621  
    1212*  @author Ross Harman, MHPCC
    1313*
    14 *  @version $Revision: 1.24 $ $Name: not supported by cvs2svn $
    15 *  @date $Date: 2004-08-14 02:55:46 $
     14*  @version $Revision: 1.25 $ $Name: not supported by cvs2svn $
     15*  @date $Date: 2004-08-25 20:21:25 $
    1616*
    1717*  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    3939/******************************************************************************/
    4040
    41 #define FITS_ERROR(STRING,PS_ERROR)                  \
    42 fits_get_errstatus(status, fitsErr);             \
    43 psError( __func__, STRING, PS_ERROR, fitsErr);   \
    44 status = 0;                                      \
     41#define FITS_ERROR(STRING,PS_ERROR)                                                                          \
     42fits_get_errstatus(status, fitsErr);                                                                     \
     43psError(__func__, STRING, PS_ERROR, fitsErr);                                                            \
     44status = 0;                                                                                              \
     45fits_close_file(fd, &status);                                                                            \
     46if(status){                                                                                              \
     47    fits_get_errstatus(status, fitsErr);                                                                  \
     48    psError(__func__, "Couldn't close FITS file. FITS error: %s", fitsErr);                               \
     49}                                                                                                        \
     50status = 0;                                                                                              \
    4551return output;
    4652
    … …  
    657663}
    658664
    659 psMetadata* psMetadataFReadHeader(psMetadata* output, char *extName, int extNum, fitsfile * fd)
     665psMetadata* psMetadataReadHeader(psMetadata* output, char *extName, int extNum, char *fileName)
    660666{
    661667    bool tempBool;
    … …  
    672678    int keyNum = 0;
    673679    psMetadataType metadataItemType;
    674 
    675     if (fd == NULL) {
    676         psError(__func__, "Null FITS file descriptor not allowed");
     680    fitsfile *fd = NULL;
     681
     682    if(fileName == NULL) {
     683        psError(__func__, "Null fileName not allowed");
     684        return NULL;
     685    }
     686
     687    fits_open_file(&fd, fileName, READONLY, &status);
     688    if(fd == NULL || status != 0) {
     689        FITS_ERROR("FITS error while opening file: %s %s", fileName);
    677690        return NULL;
    678691    }
    … …  
    685698        return NULL;
    686699    }
     700
    687701    // Allocate metadata if user didn't
    688702    if (output == NULL) {
    689703        output = psMetadataAlloc();
    690704    }
     705
    691706    // Move to user designated HDU number or HDU name in FITS file. HDU numbers starts at one.
    692707    if (extName != NULL) {
    … …  
    704719        FITS_ERROR("FITS error while reading key %d: %s", keyNum);
    705720    }
     721
    706722    // Get each key name. Keywords start at one.
    707723    for (i = 1; i <= numKeys; i++) {
    … …  
    714730                FITS_ERROR("FITS error while determining key %d type: %s", keyNum);
    715731            } else {
    716                 // Some keywords are still valid even though they don't have a type, like COMMENTS and
    717                 // HISTORY
     732                // Some keywords are still valid if they don't have a type (like COMMENTS and HISTORY)
    718733                keyType = 'C';
    719734                status = 0;

  • trunk/psLib/src/astronomy/psMetadata.h

    r1496 r1621  
    1111*  @author Ross Harman, MHPCC
    1212*
    13 *  @version $Revision: 1.20 $ $Name: not supported by cvs2svn $
    14 *  @date $Date: 2004-08-12 01:23:20 $
     13*  @version $Revision: 1.21 $ $Name: not supported by cvs2svn $
     14*  @date $Date: 2004-08-25 20:21:41 $
    1515*
    1616*  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    7272/** Metadata data structure.
    7373 *
    74  *  Struct for holding metadata items. Metadata items are held in two 
    75  *  containers. The first employs a doubly-linked list to preserve the order 
     74 *  Struct for holding metadata items. Metadata items are held in two
     75 *  containers. The first employs a doubly-linked list to preserve the order
    7676 *  of the metadata. The second container employs a hash table which
    7777 *  allows fast lookup when given a metadata keyword.
    … …  
    9292/** Create a metadata item.
    9393 *
    94  *  Returns a fill psMetadataItem ready for insertion into the psMetadata 
    95  *  struct. The name argument specifies the name to use for this item, and 
     94 *  Returns a fill psMetadataItem ready for insertion into the psMetadata
     95 *  struct. The name argument specifies the name to use for this item, and
    9696 *  may include sprintf formatting codes. The format entry specifies both
    97  *  the metadata type and optional flags and is created by bit-wise or of the 
    98  *  appropriate type and flag. The comment argument is a fixed string used to 
    99  *  comment the metadata item. The arguments to the name formatting codes and 
    100  *  the metadata itself are passed as arguments following the comment string. 
    101  *  The data must be a pointer for any of the elements stored in data.void. 
    102  *  The argument list must be interpreted appropriately by the va_list 
     97 *  the metadata type and optional flags and is created by bit-wise or of the
     98 *  appropriate type and flag. The comment argument is a fixed string used to
     99 *  comment the metadata item. The arguments to the name formatting codes and
     100 *  the metadata itself are passed as arguments following the comment string.
     101 *  The data must be a pointer for any of the elements stored in data.void.
     102 *  The argument list must be interpreted appropriately by the va_list
    103103 *  operators in the function specified size and type.
    104104 *
    … …  
    114114/** Create a metadata item with va_list.
    115115 *
    116  *  Returns a fill psMetadataItem ready for insertion into the psMetadata 
     116 *  Returns a fill psMetadataItem ready for insertion into the psMetadata
    117117 *  struct. The name argument specifies the name to use for this item, and
    118118 *  may include sprintf formatting codes. The format entry specifies both
    119  *  the metadata type and optional flags and is created by bit-wise or of the 
    120  *  appropriate type and flag. The comment argument is a fixed string used to 
    121  *  comment the metadata item. The arguments to the name formatting codes and 
    122  *  the metadata itself are passed as arguments following the comment string. 
    123  *  The data must be a pointer for any of the elements stored in data.void. 
    124  *  The argument list must be interpreted appropriately by the va_list 
     119 *  the metadata type and optional flags and is created by bit-wise or of the
     120 *  appropriate type and flag. The comment argument is a fixed string used to
     121 *  comment the metadata item. The arguments to the name formatting codes and
     122 *  the metadata itself are passed as arguments following the comment string.
     123 *  The data must be a pointer for any of the elements stored in data.void.
     124 *  The argument list must be interpreted appropriately by the va_list
    125125 *  operators in the function specified size and type.
    126126 *
    … …  
    136136/** Create a metadata collection.
    137137 *
    138  *  Returns an empty metadata container with fully allocated internal metadata 
     138 *  Returns an empty metadata container with fully allocated internal metadata
    139139 *  containers.
    140140 *
    … …  
    145145/** Add existing metadata item to metadata collection.
    146146 *
    147  *  Add a metadata item that has already been created to the metadata 
     147 *  Add a metadata item that has already been created to the metadata
    148148 *  collection.
    149149 *
    … …  
    173173/** Remove an item from metadata collection.
    174174 *
    175  *  Items may be removed from metadata by specifing a key or location. If the 
    176  *  name is null, the where argument is used instead. If name is not null, 
    177  *  where is set to PS_LIST_UNKNOWN. If the item is found, it is removed from 
    178  *  the metadata and true is returned.  If the key is not unique, then all 
     175 *  Items may be removed from metadata by specifing a key or location. If the
     176 *  name is null, the where argument is used instead. If name is not null,
     177 *  where is set to PS_LIST_UNKNOWN. If the item is found, it is removed from
     178 *  the metadata and true is returned.  If the key is not unique, then all
    179179 *  items corresponding to it are removed.
    180180 *
    … …  
    189189/** Find an item in the metadata collection based on key name.
    190190 *
    191  *  Items may be found in the metadata by providing a key. If the key is 
    192  *  non-unique, the first item is returned. If the item is not found, null is 
     191 *  Items may be found in the metadata by providing a key. If the key is
     192 *  non-unique, the first item is returned. If the item is not found, null is
    193193 *  returned.
    194194 *
    … …  
    202202/** Find an item in the metadata collection based on list index.
    203203 *
    204  *  Items may be found in the metadata by their entry position in the list 
     204 *  Items may be found in the metadata by their entry position in the list
    205205 *  container.
    206206 *
    … …  
    214214/** Set or reset metadata iterator.
    215215 *
    216  *  Metadata may be iterated by setting or resetting an iterator to a location 
     216 *  Metadata may be iterated by setting or resetting an iterator to a location
    217217 *  in the metadata list.
    218218 *
    … …  
    250250/** Print metadata item to file.
    251251 *
    252  *  Metadata items may be printed to an open file descriptor based on a 
    253  *  provided format. The format is a sprintf format statement with exactly 
    254  *  one % formatting command. If the metadata item type is a numeric type, 
    255  *  this formatting command must also be numeric, and the type conversion 
    256  *  performed to the value to match the format type. If the metadata type is 
     252 *  Metadata items may be printed to an open file descriptor based on a
     253 *  provided format. The format is a sprintf format statement with exactly
     254 *  one % formatting command. If the metadata item type is a numeric type,
     255 *  this formatting command must also be numeric, and the type conversion
     256 *  performed to the value to match the format type. If the metadata type is
    257257 *  a string, the fromatting command must also be for a string. If the
    258258 *  metadata type is any other data type, printing is not allowed.
    … …  
    268268/** Read metadata header.
    269269 *
    270  *  Read a metadata header from file. If the file is not found, an error is 
     270 *  Read a metadata header from file. If the file is not found, an error is
    271271 *  reported. This file is currently unimplemented.
    272272 *
    … …  
    275275psMetadata* psMetadataReadHeader(
    276276    psMetadata* output,                ///< Resulting metadata from read.
    277     char *extname,                     ///< File name extension string.
    278     int extnum,                        ///< File name extension number. Starts at 1.
    279     char *filename                     ///< Name of file to read.
    280 );
    281 
    282 /** Read metadata header.
    283  *
    284  *  Read a metadata header from file. If the file is not found, an error is
    285  *  reported.
    286  *
    287  *  @return psMetadata* : Pointer metadata.
    288  */
    289 psMetadata* psMetadataFReadHeader(
    290     psMetadata* output,                ///< Resulting metadata from read.
    291277    char *extName,                     ///< File name extension string.
    292     int extNum,                        ///< File name extension number.
    293     fitsfile * fd                      ///< Pointer to file to read.
     278    int extNum,                        ///< File name extension number. Starts at 1.
     279    char *fileName                     ///< Name of file to read.
    294280);
    295281

  • trunk/psLib/src/collections/psMetadata.c

    r1546 r1621  
    1212*  @author Ross Harman, MHPCC
    1313*
    14 *  @version $Revision: 1.24 $ $Name: not supported by cvs2svn $
    15 *  @date $Date: 2004-08-14 02:55:46 $
     14*  @version $Revision: 1.25 $ $Name: not supported by cvs2svn $
     15*  @date $Date: 2004-08-25 20:21:25 $
    1616*
    1717*  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    3939/******************************************************************************/
    4040
    41 #define FITS_ERROR(STRING,PS_ERROR)                  \
    42 fits_get_errstatus(status, fitsErr);             \
    43 psError( __func__, STRING, PS_ERROR, fitsErr);   \
    44 status = 0;                                      \
     41#define FITS_ERROR(STRING,PS_ERROR)                                                                          \
     42fits_get_errstatus(status, fitsErr);                                                                     \
     43psError(__func__, STRING, PS_ERROR, fitsErr);                                                            \
     44status = 0;                                                                                              \
     45fits_close_file(fd, &status);                                                                            \
     46if(status){                                                                                              \
     47    fits_get_errstatus(status, fitsErr);                                                                  \
     48    psError(__func__, "Couldn't close FITS file. FITS error: %s", fitsErr);                               \
     49}                                                                                                        \
     50status = 0;                                                                                              \
    4551return output;
    4652
    … …  
    657663}
    658664
    659 psMetadata* psMetadataFReadHeader(psMetadata* output, char *extName, int extNum, fitsfile * fd)
     665psMetadata* psMetadataReadHeader(psMetadata* output, char *extName, int extNum, char *fileName)
    660666{
    661667    bool tempBool;
    … …  
    672678    int keyNum = 0;
    673679    psMetadataType metadataItemType;
    674 
    675     if (fd == NULL) {
    676         psError(__func__, "Null FITS file descriptor not allowed");
     680    fitsfile *fd = NULL;
     681
     682    if(fileName == NULL) {
     683        psError(__func__, "Null fileName not allowed");
     684        return NULL;
     685    }
     686
     687    fits_open_file(&fd, fileName, READONLY, &status);
     688    if(fd == NULL || status != 0) {
     689        FITS_ERROR("FITS error while opening file: %s %s", fileName);
    677690        return NULL;
    678691    }
    … …  
    685698        return NULL;
    686699    }
     700
    687701    // Allocate metadata if user didn't
    688702    if (output == NULL) {
    689703        output = psMetadataAlloc();
    690704    }
     705
    691706    // Move to user designated HDU number or HDU name in FITS file. HDU numbers starts at one.
    692707    if (extName != NULL) {
    … …  
    704719        FITS_ERROR("FITS error while reading key %d: %s", keyNum);
    705720    }
     721
    706722    // Get each key name. Keywords start at one.
    707723    for (i = 1; i <= numKeys; i++) {
    … …  
    714730                FITS_ERROR("FITS error while determining key %d type: %s", keyNum);
    715731            } else {
    716                 // Some keywords are still valid even though they don't have a type, like COMMENTS and
    717                 // HISTORY
     732                // Some keywords are still valid if they don't have a type (like COMMENTS and HISTORY)
    718733                keyType = 'C';
    719734                status = 0;

  • trunk/psLib/src/collections/psMetadata.h

    r1496 r1621  
    1111*  @author Ross Harman, MHPCC
    1212*
    13 *  @version $Revision: 1.20 $ $Name: not supported by cvs2svn $
    14 *  @date $Date: 2004-08-12 01:23:20 $
     13*  @version $Revision: 1.21 $ $Name: not supported by cvs2svn $
     14*  @date $Date: 2004-08-25 20:21:41 $
    1515*
    1616*  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    7272/** Metadata data structure.
    7373 *
    74  *  Struct for holding metadata items. Metadata items are held in two 
    75  *  containers. The first employs a doubly-linked list to preserve the order 
     74 *  Struct for holding metadata items. Metadata items are held in two
     75 *  containers. The first employs a doubly-linked list to preserve the order
    7676 *  of the metadata. The second container employs a hash table which
    7777 *  allows fast lookup when given a metadata keyword.
    … …  
    9292/** Create a metadata item.
    9393 *
    94  *  Returns a fill psMetadataItem ready for insertion into the psMetadata 
    95  *  struct. The name argument specifies the name to use for this item, and 
     94 *  Returns a fill psMetadataItem ready for insertion into the psMetadata
     95 *  struct. The name argument specifies the name to use for this item, and
    9696 *  may include sprintf formatting codes. The format entry specifies both
    97  *  the metadata type and optional flags and is created by bit-wise or of the 
    98  *  appropriate type and flag. The comment argument is a fixed string used to 
    99  *  comment the metadata item. The arguments to the name formatting codes and 
    100  *  the metadata itself are passed as arguments following the comment string. 
    101  *  The data must be a pointer for any of the elements stored in data.void. 
    102  *  The argument list must be interpreted appropriately by the va_list 
     97 *  the metadata type and optional flags and is created by bit-wise or of the
     98 *  appropriate type and flag. The comment argument is a fixed string used to
     99 *  comment the metadata item. The arguments to the name formatting codes and
     100 *  the metadata itself are passed as arguments following the comment string.
     101 *  The data must be a pointer for any of the elements stored in data.void.
     102 *  The argument list must be interpreted appropriately by the va_list
    103103 *  operators in the function specified size and type.
    104104 *
    … …  
    114114/** Create a metadata item with va_list.
    115115 *
    116  *  Returns a fill psMetadataItem ready for insertion into the psMetadata 
     116 *  Returns a fill psMetadataItem ready for insertion into the psMetadata
    117117 *  struct. The name argument specifies the name to use for this item, and
    118118 *  may include sprintf formatting codes. The format entry specifies both
    119  *  the metadata type and optional flags and is created by bit-wise or of the 
    120  *  appropriate type and flag. The comment argument is a fixed string used to 
    121  *  comment the metadata item. The arguments to the name formatting codes and 
    122  *  the metadata itself are passed as arguments following the comment string. 
    123  *  The data must be a pointer for any of the elements stored in data.void. 
    124  *  The argument list must be interpreted appropriately by the va_list 
     119 *  the metadata type and optional flags and is created by bit-wise or of the
     120 *  appropriate type and flag. The comment argument is a fixed string used to
     121 *  comment the metadata item. The arguments to the name formatting codes and
     122 *  the metadata itself are passed as arguments following the comment string.
     123 *  The data must be a pointer for any of the elements stored in data.void.
     124 *  The argument list must be interpreted appropriately by the va_list
    125125 *  operators in the function specified size and type.
    126126 *
    … …  
    136136/** Create a metadata collection.
    137137 *
    138  *  Returns an empty metadata container with fully allocated internal metadata 
     138 *  Returns an empty metadata container with fully allocated internal metadata
    139139 *  containers.
    140140 *
    … …  
    145145/** Add existing metadata item to metadata collection.
    146146 *
    147  *  Add a metadata item that has already been created to the metadata 
     147 *  Add a metadata item that has already been created to the metadata
    148148 *  collection.
    149149 *
    … …  
    173173/** Remove an item from metadata collection.
    174174 *
    175  *  Items may be removed from metadata by specifing a key or location. If the 
    176  *  name is null, the where argument is used instead. If name is not null, 
    177  *  where is set to PS_LIST_UNKNOWN. If the item is found, it is removed from 
    178  *  the metadata and true is returned.  If the key is not unique, then all 
     175 *  Items may be removed from metadata by specifing a key or location. If the
     176 *  name is null, the where argument is used instead. If name is not null,
     177 *  where is set to PS_LIST_UNKNOWN. If the item is found, it is removed from
     178 *  the metadata and true is returned.  If the key is not unique, then all
    179179 *  items corresponding to it are removed.
    180180 *
    … …  
    189189/** Find an item in the metadata collection based on key name.
    190190 *
    191  *  Items may be found in the metadata by providing a key. If the key is 
    192  *  non-unique, the first item is returned. If the item is not found, null is 
     191 *  Items may be found in the metadata by providing a key. If the key is
     192 *  non-unique, the first item is returned. If the item is not found, null is
    193193 *  returned.
    194194 *
    … …  
    202202/** Find an item in the metadata collection based on list index.
    203203 *
    204  *  Items may be found in the metadata by their entry position in the list 
     204 *  Items may be found in the metadata by their entry position in the list
    205205 *  container.
    206206 *
    … …  
    214214/** Set or reset metadata iterator.
    215215 *
    216  *  Metadata may be iterated by setting or resetting an iterator to a location 
     216 *  Metadata may be iterated by setting or resetting an iterator to a location
    217217 *  in the metadata list.
    218218 *
    … …  
    250250/** Print metadata item to file.
    251251 *
    252  *  Metadata items may be printed to an open file descriptor based on a 
    253  *  provided format. The format is a sprintf format statement with exactly 
    254  *  one % formatting command. If the metadata item type is a numeric type, 
    255  *  this formatting command must also be numeric, and the type conversion 
    256  *  performed to the value to match the format type. If the metadata type is 
     252 *  Metadata items may be printed to an open file descriptor based on a
     253 *  provided format. The format is a sprintf format statement with exactly
     254 *  one % formatting command. If the metadata item type is a numeric type,
     255 *  this formatting command must also be numeric, and the type conversion
     256 *  performed to the value to match the format type. If the metadata type is
    257257 *  a string, the fromatting command must also be for a string. If the
    258258 *  metadata type is any other data type, printing is not allowed.
    … …  
    268268/** Read metadata header.
    269269 *
    270  *  Read a metadata header from file. If the file is not found, an error is 
     270 *  Read a metadata header from file. If the file is not found, an error is
    271271 *  reported. This file is currently unimplemented.
    272272 *
    … …  
    275275psMetadata* psMetadataReadHeader(
    276276    psMetadata* output,                ///< Resulting metadata from read.
    277     char *extname,                     ///< File name extension string.
    278     int extnum,                        ///< File name extension number. Starts at 1.
    279     char *filename                     ///< Name of file to read.
    280 );
    281 
    282 /** Read metadata header.
    283  *
    284  *  Read a metadata header from file. If the file is not found, an error is
    285  *  reported.
    286  *
    287  *  @return psMetadata* : Pointer metadata.
    288  */
    289 psMetadata* psMetadataFReadHeader(
    290     psMetadata* output,                ///< Resulting metadata from read.
    291277    char *extName,                     ///< File name extension string.
    292     int extNum,                        ///< File name extension number.
    293     fitsfile * fd                      ///< Pointer to file to read.
     278    int extNum,                        ///< File name extension number. Starts at 1.
     279    char *fileName                     ///< Name of file to read.
    294280);
    295281

  • trunk/psLib/src/types/psMetadata.c

    r1546 r1621  
    1212*  @author Ross Harman, MHPCC
    1313*
    14 *  @version $Revision: 1.24 $ $Name: not supported by cvs2svn $
    15 *  @date $Date: 2004-08-14 02:55:46 $
     14*  @version $Revision: 1.25 $ $Name: not supported by cvs2svn $
     15*  @date $Date: 2004-08-25 20:21:25 $
    1616*
    1717*  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    3939/******************************************************************************/
    4040
    41 #define FITS_ERROR(STRING,PS_ERROR)                  \
    42 fits_get_errstatus(status, fitsErr);             \
    43 psError( __func__, STRING, PS_ERROR, fitsErr);   \
    44 status = 0;                                      \
     41#define FITS_ERROR(STRING,PS_ERROR)                                                                          \
     42fits_get_errstatus(status, fitsErr);                                                                     \
     43psError(__func__, STRING, PS_ERROR, fitsErr);                                                            \
     44status = 0;                                                                                              \
     45fits_close_file(fd, &status);                                                                            \
     46if(status){                                                                                              \
     47    fits_get_errstatus(status, fitsErr);                                                                  \
     48    psError(__func__, "Couldn't close FITS file. FITS error: %s", fitsErr);                               \
     49}                                                                                                        \
     50status = 0;                                                                                              \
    4551return output;
    4652
    … …  
    657663}
    658664
    659 psMetadata* psMetadataFReadHeader(psMetadata* output, char *extName, int extNum, fitsfile * fd)
     665psMetadata* psMetadataReadHeader(psMetadata* output, char *extName, int extNum, char *fileName)
    660666{
    661667    bool tempBool;
    … …  
    672678    int keyNum = 0;
    673679    psMetadataType metadataItemType;
    674 
    675     if (fd == NULL) {
    676         psError(__func__, "Null FITS file descriptor not allowed");
     680    fitsfile *fd = NULL;
     681
     682    if(fileName == NULL) {
     683        psError(__func__, "Null fileName not allowed");
     684        return NULL;
     685    }
     686
     687    fits_open_file(&fd, fileName, READONLY, &status);
     688    if(fd == NULL || status != 0) {
     689        FITS_ERROR("FITS error while opening file: %s %s", fileName);
    677690        return NULL;
    678691    }
    … …  
    685698        return NULL;
    686699    }
     700
    687701    // Allocate metadata if user didn't
    688702    if (output == NULL) {
    689703        output = psMetadataAlloc();
    690704    }
     705
    691706    // Move to user designated HDU number or HDU name in FITS file. HDU numbers starts at one.
    692707    if (extName != NULL) {
    … …  
    704719        FITS_ERROR("FITS error while reading key %d: %s", keyNum);
    705720    }
     721
    706722    // Get each key name. Keywords start at one.
    707723    for (i = 1; i <= numKeys; i++) {
    … …  
    714730                FITS_ERROR("FITS error while determining key %d type: %s", keyNum);
    715731            } else {
    716                 // Some keywords are still valid even though they don't have a type, like COMMENTS and
    717                 // HISTORY
     732                // Some keywords are still valid if they don't have a type (like COMMENTS and HISTORY)
    718733                keyType = 'C';
    719734                status = 0;

  • trunk/psLib/src/types/psMetadata.h

    r1496 r1621  
    1111*  @author Ross Harman, MHPCC
    1212*
    13 *  @version $Revision: 1.20 $ $Name: not supported by cvs2svn $
    14 *  @date $Date: 2004-08-12 01:23:20 $
     13*  @version $Revision: 1.21 $ $Name: not supported by cvs2svn $
     14*  @date $Date: 2004-08-25 20:21:41 $
    1515*
    1616*  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
    … …  
    7272/** Metadata data structure.
    7373 *
    74  *  Struct for holding metadata items. Metadata items are held in two 
    75  *  containers. The first employs a doubly-linked list to preserve the order 
     74 *  Struct for holding metadata items. Metadata items are held in two
     75 *  containers. The first employs a doubly-linked list to preserve the order
    7676 *  of the metadata. The second container employs a hash table which
    7777 *  allows fast lookup when given a metadata keyword.
    … …  
    9292/** Create a metadata item.
    9393 *
    94  *  Returns a fill psMetadataItem ready for insertion into the psMetadata 
    95  *  struct. The name argument specifies the name to use for this item, and 
     94 *  Returns a fill psMetadataItem ready for insertion into the psMetadata
     95 *  struct. The name argument specifies the name to use for this item, and
    9696 *  may include sprintf formatting codes. The format entry specifies both
    97  *  the metadata type and optional flags and is created by bit-wise or of the 
    98  *  appropriate type and flag. The comment argument is a fixed string used to 
    99  *  comment the metadata item. The arguments to the name formatting codes and 
    100  *  the metadata itself are passed as arguments following the comment string. 
    101  *  The data must be a pointer for any of the elements stored in data.void. 
    102  *  The argument list must be interpreted appropriately by the va_list 
     97 *  the metadata type and optional flags and is created by bit-wise or of the
     98 *  appropriate type and flag. The comment argument is a fixed string used to
     99 *  comment the metadata item. The arguments to the name formatting codes and
     100 *  the metadata itself are passed as arguments following the comment string.
     101 *  The data must be a pointer for any of the elements stored in data.void.
     102 *  The argument list must be interpreted appropriately by the va_list
    103103 *  operators in the function specified size and type.
    104104 *
    … …  
    114114/** Create a metadata item with va_list.
    115115 *
    116  *  Returns a fill psMetadataItem ready for insertion into the psMetadata 
     116 *  Returns a fill psMetadataItem ready for insertion into the psMetadata
    117117 *  struct. The name argument specifies the name to use for this item, and
    118118 *  may include sprintf formatting codes. The format entry specifies both
    119  *  the metadata type and optional flags and is created by bit-wise or of the 
    120  *  appropriate type and flag. The comment argument is a fixed string used to 
    121  *  comment the metadata item. The arguments to the name formatting codes and 
    122  *  the metadata itself are passed as arguments following the comment string. 
    123  *  The data must be a pointer for any of the elements stored in data.void. 
    124  *  The argument list must be interpreted appropriately by the va_list 
     119 *  the metadata type and optional flags and is created by bit-wise or of the
     120 *  appropriate type and flag. The comment argument is a fixed string used to
     121 *  comment the metadata item. The arguments to the name formatting codes and
     122 *  the metadata itself are passed as arguments following the comment string.
     123 *  The data must be a pointer for any of the elements stored in data.void.
     124 *  The argument list must be interpreted appropriately by the va_list
    125125 *  operators in the function specified size and type.
    126126 *
    … …  
    136136/** Create a metadata collection.
    137137 *
    138  *  Returns an empty metadata container with fully allocated internal metadata 
     138 *  Returns an empty metadata container with fully allocated internal metadata
    139139 *  containers.
    140140 *
    … …  
    145145/** Add existing metadata item to metadata collection.
    146146 *
    147  *  Add a metadata item that has already been created to the metadata 
     147 *  Add a metadata item that has already been created to the metadata
    148148 *  collection.
    149149 *
    … …  
    173173/** Remove an item from metadata collection.
    174174 *
    175  *  Items may be removed from metadata by specifing a key or location. If the 
    176  *  name is null, the where argument is used instead. If name is not null, 
    177  *  where is set to PS_LIST_UNKNOWN. If the item is found, it is removed from 
    178  *  the metadata and true is returned.  If the key is not unique, then all 
     175 *  Items may be removed from metadata by specifing a key or location. If the
     176 *  name is null, the where argument is used instead. If name is not null,
     177 *  where is set to PS_LIST_UNKNOWN. If the item is found, it is removed from
     178 *  the metadata and true is returned.  If the key is not unique, then all
    179179 *  items corresponding to it are removed.
    180180 *
    … …  
    189189/** Find an item in the metadata collection based on key name.
    190190 *
    191  *  Items may be found in the metadata by providing a key. If the key is 
    192  *  non-unique, the first item is returned. If the item is not found, null is 
     191 *  Items may be found in the metadata by providing a key. If the key is
     192 *  non-unique, the first item is returned. If the item is not found, null is
    193193 *  returned.
    194194 *
    … …  
    202202/** Find an item in the metadata collection based on list index.
    203203 *
    204  *  Items may be found in the metadata by their entry position in the list 
     204 *  Items may be found in the metadata by their entry position in the list
    205205 *  container.
    206206 *
    … …  
    214214/** Set or reset metadata iterator.
    215215 *
    216  *  Metadata may be iterated by setting or resetting an iterator to a location 
     216 *  Metadata may be iterated by setting or resetting an iterator to a location
    217217 *  in the metadata list.
    218218 *
    … …  
    250250/** Print metadata item to file.
    251251 *
    252  *  Metadata items may be printed to an open file descriptor based on a 
    253  *  provided format. The format is a sprintf format statement with exactly 
    254  *  one % formatting command. If the metadata item type is a numeric type, 
    255  *  this formatting command must also be numeric, and the type conversion 
    256  *  performed to the value to match the format type. If the metadata type is 
     252 *  Metadata items may be printed to an open file descriptor based on a
     253 *  provided format. The format is a sprintf format statement with exactly
     254 *  one % formatting command. If the metadata item type is a numeric type,
     255 *  this formatting command must also be numeric, and the type conversion
     256 *  performed to the value to match the format type. If the metadata type is
    257257 *  a string, the fromatting command must also be for a string. If the
    258258 *  metadata type is any other data type, printing is not allowed.
    … …  
    268268/** Read metadata header.
    269269 *
    270  *  Read a metadata header from file. If the file is not found, an error is 
     270 *  Read a metadata header from file. If the file is not found, an error is
    271271 *  reported. This file is currently unimplemented.
    272272 *
    … …  
    275275psMetadata* psMetadataReadHeader(
    276276    psMetadata* output,                ///< Resulting metadata from read.
    277     char *extname,                     ///< File name extension string.
    278     int extnum,                        ///< File name extension number. Starts at 1.
    279     char *filename                     ///< Name of file to read.
    280 );
    281 
    282 /** Read metadata header.
    283  *
    284  *  Read a metadata header from file. If the file is not found, an error is
    285  *  reported.
    286  *
    287  *  @return psMetadata* : Pointer metadata.
    288  */
    289 psMetadata* psMetadataFReadHeader(
    290     psMetadata* output,                ///< Resulting metadata from read.
    291277    char *extName,                     ///< File name extension string.
    292     int extNum,                        ///< File name extension number.
    293     fitsfile * fd                      ///< Pointer to file to read.
     278    int extNum,                        ///< File name extension number. Starts at 1.
     279    char *fileName                     ///< Name of file to read.
    294280);
    295281
Note: See TracChangeset for help on using the changeset viewer.