Adding check for correct start_byte for Juno UVS PDS3 labels.

Author: bekahalbach

docs/version_history.md

@@ -20,6 +20,8 @@
   - Voyager
   - MRO
   - Venus Express
+  - Juno UVS
+  - Hayabusa
 - MSL Mastcam, MAHLI, and MARDI EDRs
 - MGS MOC compressed SDPs
 

pdr/formats/checkers.py

@@ -1180,6 +1180,16 @@ def check_special_fits_start_byte(
         identifiers["DATA_SET_ID"] == "LRO-L-LAMP-3-RDR-V1.0" 
     ):
         return formats.lro.lamp_rdr_hdu_start_byte(name, hdulist)
+    if (
+        identifiers['PRODUCT_TYPE'] == "RDR"
+        and "JNO-J-UVS-3-RDR-" in identifiers['DATA_SET_ID']
+    ):
+        return True, formats.juno.uvs_rdr_start_byte(name, hdulist)
+    if (
+        identifiers['PRODUCT_TYPE'] == "EDR"
+        and "JNO-J-UVS-2-EDR-" in identifiers['DATA_SET_ID']
+    ):
+        return True, formats.juno.uvs_edr_start_byte(name, hdulist)
     return False, None
 
 

pdr/formats/juno.py

@@ -55,3 +55,106 @@ def bit_start_find_and_fix(
         special_start_bit_list[-1] = 16
         return True, special_start_bit_list
     return False, None
+
+
+def uvs_rdr_start_byte(name, hdul):
+    """
+    Sometimes, the start byte is incorrectly recorded in the PDS3 labels (It
+    is always wrong in the PDS4 labels. We do not have a "check" for that yet,
+    so I recommend using the PDS3 labels). Here we use the FITS index
+    defined by the mission for each object to look up the correct start_byte in
+    the HDU fileinfo.
+
+    This won't work if HDUs are missing etc, but I have not encountered that.
+
+    HITS
+    * juno_uvs
+        * RDR
+    """
+    import warnings
+    # indices are in online PDS docs and comments in the labels
+    index_dict = {'CALIBRATED_SPECTRAL_HEADER': 0,
+                  'CALIBRATED_SPECTRAL_IMAGE': 0,
+                  'ACQUISITION_LIST_HEADER': 1,
+                  'ACQUISITION_LIST_TABLE': 1,
+                  'CALIBRATED_PHOTON_LIST_HEADER': 2,
+                  'CALIBRATED_PHOTON_LIST_TABLE': 2,
+                  'ANCILLARY_DATA_HEADER': 3,
+                  'ANCILLARY_DATA_TABLE': 3,
+                  'CALIBRATED_ANALOG_COUNT_RATE_HEADER': 4,
+                  'CALIBRATED_ANALOG_COUNT_RATE_TABLE': 4,
+                  'CALIBRATED_DIGITAL_COUNT_RATE_HEADER': 5,
+                  'CALIBRATED_DIGITAL_COUNT_RATE_TABLE': 5,
+                  'HOUSEKEEPING_HEADER': 6,
+                  'HOUSEKEEPING_TABLE': 6,
+                  'WAVELENGTH_LOOKUP_HEADER': 7,
+                  'WAVELENGTH_LOOKUP_IMAGE': 7,
+                  'MASK_INFORMATION_HEADER': 8,
+                  'MASK_INFORMATION_TABLE': 8,
+                  }
+    try:
+        correct_index = index_dict[name]
+        hdu = hdul[correct_index]
+        hinfo = hdu.fileinfo()
+        if 'HEADER' in name:
+            return hinfo['hdrLoc']
+        else:
+            return hinfo['datLoc']
+    except Exception as e:
+        warnings.warn("This key doesn't appear to be in the FITS file.")
+        return None
+
+
+def uvs_edr_start_byte(name, hdul):
+    """
+    Sometimes, the start byte is incorrectly recorded in the PDS3 labels (It
+    is always wrong in the PDS4 labels. We do not have a "check" for that yet,
+    so I recommend using the PDS3 labels). Here we use the FITS index
+    defined by the mission for each object to look up the correct start_byte in
+    the HDU fileinfo.
+
+    This won't work if HDUs are missing etc, but I have not encountered that.
+
+    HITS
+    * juno_uvs
+        * EDR
+    """
+    import warnings
+    # indices are in online PDS docs and comments in the labels
+    index_dict = {'SPECTRAL_VS_SPATIAL_HEADER': 0,
+                  'SPECTRAL_VS_SPATIAL_IMAGE': 0,
+                  'SPATIAL_VS_TIME_HEADER': 1,
+                  'SPATIAL_VS_TIME_QUBE': 1,
+                  'FRAME_LIST_HEADER': 2,
+                  'FRAME_LIST_TABLE': 2,
+                  'SCAN_MIRROR_POSITIONS_HEADER': 3,
+                  'SCAN_MIRROR_POSITIONS_TABLE': 3,
+                  'RAW_FRAME_HEADER': 4,
+                  'RAW_FRAME_TABLE': 4,
+                  'ANALOG_COUNT_RATE_HEADER': 5,
+                  'ANALOG_COUNT_RATE_TABLE': 5,
+                  'DIGITAL_COUNT_RATE_HEADER': 6,
+                  'DIGITAL_COUNT_RATE_TABLE': 6,
+                  'PULSE_HEIGHT_DISTRIBUTION_LA_HEADER': 7,
+                  'PULSE_HEIGHT_DISTRIBUTION_LA_QUBE': 7,
+                  'PULSE_HEIGHT_DISTRIBUTION_STELLAR_HEADER': 8,
+                  'PULSE_HEIGHT_DISTRIBUTION_STELLAR_QUBE': 8,
+                  'PULSE_HEIGHT_DISTRIBUTION_STIM_HEADER': 9,
+                  'PULSE_HEIGHT_DISTRIBUTION_STIM_QUBE': 9,
+                  'HOUSEKEEPING_HEADER': 10,
+                  'HOUSEKEEPING_TABLE': 10,
+                  'PARAMETER_LIST_HEADER': 11,
+                  'PARAMETER_LIST_TABLE': 11,
+                  }
+
+    try:
+        correct_index = index_dict[name]
+        hdu = hdul[correct_index]
+        hinfo = hdu.fileinfo()
+        if 'HEADER' in name:
+            return hinfo['hdrLoc']
+        else:
+            return hinfo['datLoc']
+    except Exception as e:
+        warnings.warn("This key doesn't appear to be in the FITS file.")
+        return None