Changeset 15630 for trunk/psLib/src/fits/psFitsFloat.h

Timestamp:

Nov 15, 2007, 3:04:56 PM (18 years ago)

Author:

Paul Price

Message:

Integrating the code to choose the output BITPIX (and quantising floating-point images if necessary) and custom floating-point schemes with the functions to read and write images. More detailed description, from my e-mail: psLib has always read any of the (legal) FITS types, and written a FITS image with the appropriate BITPIX for the image->type.type. Now the output BITPIX can be forced by setting psFits.bitpix to the desired BITPIX. Floating point images being quantised to integer types have BSCALE and BZERO set in such a fashion as to maintain the dynamic range of the image; quantisation after applying the scale and zero includes adding a random number [0,1) to preserve the expectation of the floating-point value. On reading, the BSCALE and BZERO are applied by cfitsio without any assistance by psLib. I've also added Gene's custom 16-bit floats (1S 5E 10M). In anticipation of further flavours down the road and to maintain compatibility, I've labelled this as FLOAT_16_0. An F32 image may be written out with this scheme by setting psFits.floatType = PS_FITS_FLOAT_16_0. The image is converted and written out with BITPIX=16, and the header keyword PSBITPIX added with the custom floating-point scheme name. Such images are automatically converted to F32 on reading (if psFits.conventions.psBitpix is true, which it is by default). One thing to keep in mind is that I'm not sure how NANs and INFs are handled in these processes. These additions are made on the top of the compression feature --- quantised or custom floating-point images may also be compressed (though the custom floating-point images don't gain much from it).

File:

• trunk/psLib/src/fits/psFitsFloat.h (modified) (1 diff)

trunk/psLib/src/fits/psFitsFloat.h

@@ -2 +2 @@
 #define PS_FITS_FLOAT_H
 
-
+#include <psFits.h>
+#include <psType.h>
 #include <psImage.h>
-#include <psMetadata.h>
 
 /// Type of custom floating point
 typedef enum {
+    PS_FITS_FLOAT_NONE,                 ///< No conversion to be performed
     PS_FITS_FLOAT_16_0,                 ///< Original F16 proposal: 1S 5E 10M
 } psFitsFloat;
 
 /// Convert an image to custom floating-point in preparation for writing as FITS
-psImage *psFitsConvertFloatImage(const psImage *image, ///< Image to convert
-                                 psMetadata *header, ///< Header to update
-                                 psFitsFloat type ///< Custom floating point type
+psImage *psFitsFloatImageWrite(const psImage *image, ///< Image to convert
+                               psFitsFloat type ///< Custom floating point type
     );
 
+/// Convert the custom floating-point image to a floating-point image
+psImage *psFitsFloatImageRead(psImage *out, ///< Output image, or NULL
+                              const psImage *in, ///< Image to convert
+                              psFitsFloat type ///< Custom floating point type
+    );
+
+/// Return the appropriate element type for a custom floating-point
+psElemType psFitsFloatImageType(psFitsFloat type ///< Custom floating-point type
+    );
+
+/// Return the custom floating-point type from a string description
+psFitsFloat psFitsFloatTypeFromString(const char *string ///< String with name of type
+    );
 
 #endif