Changeset 41474 for trunk/Ohana/src/libfits/matrix/F_compress_utils.c

Timestamp:

Jan 24, 2021, 3:37:52 PM (5 years ago)

Author:

eugene

Message:

clarify in comments the buffers and pixel sizes used in the different stages of compression/uncompression; catch unimplemented compression cases; fix error in pixel size for RICE1; cleanup verbose code; use correct sscanf format code in ASCII table reading code

File:

• trunk/Ohana/src/libfits/matrix/F_compress_utils.c (modified) (7 diffs)

trunk/Ohana/src/libfits/matrix/F_compress_utils.c

@@ -104 +104 @@
   // fprintf (stderr, "swapping %d bytes in pix of size %d bytes...\n", Nzdata, pixsize);
   switch (pixsize) {
+    case 0:
     case 1:
       break;
@@ -186 +187 @@
 }
 
-int gfits_uncompressed_data_pixsize (char *cmptype, int out_bitpix, char **optname, char **optvalue, int Noptions) {
+// the size of the compressed data pixels, needed to perform swaps
+int gfits_compressed_data_pixsize (char *cmptype, int out_bitpix, char **optname, char **optvalue, int Noptions) {
+
+  // NONE should be swapped to mimic swapping types
+  if (!strcasecmp(cmptype, "NONE") || !strcasecmp(cmptype, "NONE_1")) {
+    if (out_bitpix ==   8) return (1);
+    if (out_bitpix ==  16) return (2);
+    if (out_bitpix ==  32) return (4);
+    if (out_bitpix == -32) return (4);
+    if (out_bitpix == -64) return (8);
+    return (1);
+  }
+
+  // GZIP_1, GZIP_2 should not be swapped after compression / before decompression
+  if (!strcasecmp(cmptype, "GZIP_1") || 
+      !strcasecmp(cmptype, "GZIP_2") || 
+      !strcasecmp(cmptype, "NONE_2")) {
+    if (out_bitpix ==   8) return (1);
+    if (out_bitpix ==  16) return (1);
+    if (out_bitpix ==  32) return (1);
+    if (out_bitpix == -32) return (1);
+    if (out_bitpix == -64) return (1);
+    return (1);
+  }
+
+  // RICE_1 should not be swapped after compression / before decompression
+  if (!strcasecmp(cmptype, "RICE_1") ||
+      !strcasecmp(cmptype, "RICE_ONE")) {
+    return (1);
+  }
+
+  // PLIO_1 always results in 4-byte ints (not 2 byte ints?)
+  if (!strcasecmp(cmptype, "PLIO_1")) {
+    return (4);
+  }
+
+  if (!strcasecmp(cmptype, "HCOMPRESS_1")) {
+    if (out_bitpix == 8)  return (4);
+    if (out_bitpix == 16) return (4);
+    return (8);
+  }
+  return (0);
+}
+
+int gfits_uncompressed_data_pixsize (char *cmptype, int out_bitpix, char **optname, char **optvalue, int Noptions, int rice_use_bitpix) {
 
   int i, Nbyte;
@@ -207 +252 @@
   if (!strcasecmp(cmptype, "RICE_1") ||
       !strcasecmp(cmptype, "RICE_ONE")) {
+    // on compression, user may set BYTEPIX based on header.bitpix:
+    if (rice_use_bitpix) {
+      if (out_bitpix ==   8) return (1);
+      if (out_bitpix ==  16) return (2);
+      if (out_bitpix ==  32) return (4);
+    }
     // if BYTEPIX option is specified, use that for Nbyte
     for (i = 0; i < Noptions; i++) {
@@ -214 +265 @@
       }
     }
-    if (out_bitpix ==   8) return (1);
-    if (out_bitpix ==  16) return (2);
-    if (out_bitpix ==  32) return (4);
-    return (4);
+    return (4); // RICE_1 default is 4 byte int if BYTEPIX undefined (White et al 6.2)
   }
 
@@ -233 +281 @@
 }
 
-int gfits_compressed_data_pixsize (char *cmptype, int out_bitpix, char **optname, char **optvalue, int Noptions) {
-
-  int i, Nbyte;
-
-  // NONE should be swapped to mimic swapping types
-  if (!strcasecmp(cmptype, "NONE") || !strcasecmp(cmptype, "NONE_1")) {
-    if (out_bitpix ==   8) return (1);
-    if (out_bitpix ==  16) return (2);
-    if (out_bitpix ==  32) return (4);
-    if (out_bitpix == -32) return (4);
-    if (out_bitpix == -64) return (8);
-    return (1);
-  }
-
-  // GZIP_1, GZIP_2 should not be swapped after compression
-  if (!strcasecmp(cmptype, "GZIP_1") || 
-      !strcasecmp(cmptype, "GZIP_2") || 
-      !strcasecmp(cmptype, "NONE_2")) {
-    if (out_bitpix ==   8) return (1);
-    if (out_bitpix ==  16) return (1);
-    if (out_bitpix ==  32) return (1);
-    if (out_bitpix == -32) return (1);
-    if (out_bitpix == -64) return (1);
-    return (1);
-  }
-
-  // RICE_1 must operate on integer pixels
-  if (!strcasecmp(cmptype, "RICE_1") ||
-      !strcasecmp(cmptype, "RICE_ONE")) {
-    // if BYTEPIX option is specified, use that for Nbyte
-    for (i = 0; i < Noptions; i++) {
-      if (!strcmp(optname[i], "BYTEPIX")) {
-        Nbyte = atoi (optvalue[i]);
-        return (Nbyte);
-      }
-    }
-    if (out_bitpix ==   8) return (1);
-    if (out_bitpix ==  16) return (2);
-    if (out_bitpix ==  32) return (4);
-    return (4);
-  }
-
-  // PLIO_1 always results in 4-byte ints (not 2 byte ints?)
-  if (!strcasecmp(cmptype, "PLIO_1")) {
-    return (4);
-  }
-
-  if (!strcasecmp(cmptype, "HCOMPRESS_1")) {
-    if (out_bitpix == 8)  return (4);
-    if (out_bitpix == 16) return (4);
-    return (8);
-  }
-  return (0);
-}
-
-int gfits_uncompressed_data_bitpix (char *cmptype, int out_bitpix, char **optname, char **optvalue, int Noptions) {
+int gfits_uncompressed_data_bitpix (char *cmptype, int out_bitpix, char **optname, char **optvalue, int Noptions, int rice_use_bitpix) {
 
   int i, Nbyte;
@@ -304 +297 @@
   if (!strcasecmp(cmptype, "RICE_1") ||
       !strcasecmp(cmptype, "RICE_ONE")) {
+    if (rice_use_bitpix) {
+      if (out_bitpix ==   8) return (out_bitpix);
+      if (out_bitpix ==  16) return (out_bitpix);
+      if (out_bitpix ==  32) return (out_bitpix);
+    }
     // if BYTEPIX option is specified, use that for Nbyte
     for (i = 0; i < Noptions; i++) {
@@ -311 +309 @@
       }
     }
-    if (out_bitpix ==   8) return (out_bitpix);
-    if (out_bitpix ==  16) return (out_bitpix);
-    if (out_bitpix ==  32) return (out_bitpix);
     return (32);
   }