Changeset 15111 for branches/pap_branch_070920/psLib/src/fits/psFits.h

Timestamp:

Sep 29, 2007, 11:55:41 AM (19 years ago)

Author:

Paul Price

Message:

Renaming psFitsOptions --> psFitsCompression

File:

• branches/pap_branch_070920/psLib/src/fits/psFits.h (modified) (6 diffs)

branches/pap_branch_070920/psLib/src/fits/psFits.h

@@ -4 +4 @@
  * @author Robert DeSonia, MHPCC
  *
- * @version $Revision: 1.31.2.1 $ $Name: not supported by cvs2svn $
- * @date $Date: 2007-09-22 03:06:16 $
+ * @version $Revision: 1.31.2.2 $ $Name: not supported by cvs2svn $
+ * @date $Date: 2007-09-29 21:55:41 $
  * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
  */
@@ -51 +51 @@
  *
  */
-typedef struct
-{
+typedef struct {
     fitsfile* fd;                       ///< the CFITSIO fits files handle.
     bool writable;                      ///< Is the file writable?
     char *extword;                      ///< user-specified word to name extensions (NULL implies EXTNAME)
-}
-psFits;
-
-/** FITS options object. */
-typedef struct
-{
+} psFits;
+
+/** FITS compression settings. */
+typedef struct {
     psFitsCompressionType type;         ///< type of compression
     psVector *tilesize;                 ///< vector defining compression tile size
@@ -67 +64 @@
     int scale;                          ///< hcompress scale
     int smooth;                         ///< hcompress smothing
-}
-psFitsOptions;
+} psFitsCompression;
 
 /** Opens a FITS file and allocates the associated psFits object.
@@ -116 +112 @@
  *  @return psFitsOptions or NULL on failure
  */
-psFitsOptions* psFitsOptionsAlloc(
+psFitsCompression* psFitsCompressionAlloc(
     psFitsCompressionType type,         ///< type of compression
     psVector *tilesize,                 ///< vector defining compression tile size
@@ -123 +119 @@
     int smooth                          ///< hcompress smothing
 );
+
+/// Return the FITS compression type specified by a string
+psFitsCompressionType psFitsCompressionTypeFromString(
+    const char *string                  ///< String with compression type
+    );
 
 /** Closes a FITS file.
@@ -151 +152 @@
  *  @return bool      TRUE if successfully configured, otherwise FALSE
  */
-bool psFitsSetOptions(
+bool psFitsCompressionApply(
     psFits* fits,                       ///< psFits object to close
-    psFitsOptions *opt                  ///< options object
+    psFitsCompression *compress         ///< options object
 );