Changeset 16122 for branches/pap_branch_080117/psLib/src/fits/psFits.h

Timestamp:

Jan 17, 2008, 3:04:21 PM (19 years ago)

Author:

Paul Price

Message:

Updating FITS scaling capability (quantising floating-point images). See bug 1032. Moving scaling functions into their own file, and providing more flexibility.

File:

• branches/pap_branch_080117/psLib/src/fits/psFits.h (modified) (4 diffs)

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

@@ -4 +4 @@
  * @author Robert DeSonia, MHPCC
  *
- * @version $Revision: 1.35 $ $Name: not supported by cvs2svn $
- * @date $Date: 2007-11-16 01:04:56 $
+ * @version $Revision: 1.35.2.1 $ $Name: not supported by cvs2svn $
+ * @date $Date: 2008-01-18 01:04:21 $
  * Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
  */
@@ -25 +25 @@
 #include "psErrorCodes.h"
 
-/** FITS HDU type.
- *
- *  Enumeration for FITS HDU type.
- *
- */
+/// FITS HDU type.
 typedef enum {
     PS_FITS_TYPE_NONE = -1,            ///< Unknown HDU type
@@ -38 +34 @@
 } psFitsType;
 
+/// FITS compression type
 typedef enum {
-    PS_FITS_COMPRESS_NONE = 0,
-    PS_FITS_COMPRESS_GZIP,
-    PS_FITS_COMPRESS_RICE,
-    PS_FITS_COMPRESS_HCOMPRESS,
-    PS_FITS_COMPRESS_PLIO
+    PS_FITS_COMPRESS_NONE = 0,          ///< No compression
+    PS_FITS_COMPRESS_GZIP,              ///< GZIP compression (of the pixels only)
+    PS_FITS_COMPRESS_RICE,              ///< RICE compression (of the pixels only)
+    PS_FITS_COMPRESS_HCOMPRESS,         ///< HCOMPRESS compression (of the pixels only)
+    PS_FITS_COMPRESS_PLIO               ///< PLIO compression (of the pixels only; appropriate for masks)
 } psFitsCompressionType;
+
+/// FITS scaling: how to set BSCALE and BZERO
+typedef enum {
+    PS_FITS_SCALE_NONE,                 ///< No auto-scaling to be applied (BSCALE = 1, BZERO = 0)
+    PS_FITS_SCALE_RANGE,                ///< Auto-scale to preserve dynamic range
+    PS_FITS_SCALE_STDEV_LOWER,          ///< Auto-scale to sample stdev, place mean at lower limit
+    PS_FITS_SCALE_STDEV_UPPER,          ///< Auto-scale to sample stdev, place mean at upper limit
+    PS_FITS_SCALE_STDEV_MIDDLE,         ///< Auto-scale to sample stdev, place mean at middle
+    PS_FITS_SCALE_MANUAL                ///< Manual scaling (use specified BSCALE and BZERO)
+} psFitsScaling;
 
 /** FITS file object.
@@ -60 +67 @@
         bool psBitpix;                  ///< Custom floating-point image
     } conventions;                      ///< Conventions to honour
+    // The following options are particular to writing images; they needn't be set for anything else.
+    psFitsFloat floatType;              ///< Desired custom floating-point for output images
     int bitpix;                         ///< Desired BITPIX for output images; 0 to use as provided
-    psFitsFloat floatType;              ///< Desired custom floating-point for output images
+    psFitsScaling scaling;              ///< Scaling scheme to use when quantising floating-point values
+    bool fuzz;                          ///< Fuzz the values when quantising floating-point values?
+    double bscale, bzero;               ///< Manually specified BSCALE and BZERO (SCALE_MANUAL)
+    double mean, stdev;                 ///< Mean and standard deviation of image
+    int stdevBits;                      ///< Number of bits to sample a standard deviation (SCALE_STDEV)
+    float stdevNum;                     ///< Number of standard deviations to pad off the edge
 } psFits;