hideal2pds #3978 fix

AUTHORS.rst

@@ -55,6 +55,7 @@ ISIS3 Contributors
 - Steven Lambright 
 - Stuart Sides 
 - Summer Stapleton 
+- Timothy Giroux
 - Tracie Sucharski 
 - Travis Addair 
 - Tyler Wilson 

CHANGELOG.md

@@ -38,6 +38,7 @@ update the Unreleased link so that it compares against the latest release tag.
 
  - Equalizer now reports the correct equation and values used to perform the adjustment. [#3987](https://github.com/USGS-Astrogeology/ISIS3/issues/3987)
  - Map2cam now works correctly when specifying bands for input cubes. [#3856](https://github.com/USGS-Astrogeology/ISIS3/issues/3856)
+ - mro/hideal2pds app now writes the correct SAMPLE_BIT_MASK values to the output label. [#3978](https://github.com/USGS-Astrogeology/ISIS3/issues/3978)
 
  ### Added
 

isis/src/mro/apps/hideal2pds/hiriseIdealPds.typ → isis/src/mro/apps/hideal2pds/MroHiriseIdealPds_8bit.typ

@@ -25,15 +25,15 @@ INSTRUMENT_HOST_NAME                     = String
 TARGET_NAME                              = String
 MISSION_PHASE_NAME                       = String
 ORBIT_NUMBER                             = Integer
-SOURCE_PRODUCT_ID                        = String
+#SOURCE_PRODUCT_ID                        = String
 RATIONALE_DESC                           = String
 SOFTWARE_NAME                            = String
 SAMPLE_DETECTORS                         = Integer 
 LINE_DETECTORS                           = Integer 
 INSTRUMENT_TYPE                          = Enum
 EPHEMERIS_TIME                           = Real
 FOCAL_PLANE_X_DEPENDENCY                 = Integer
-EXPOSURE_DURATION                        = (Real, 4)
+EXPOSURE_DURATION                        = (Real, 6)
 IMAGE_JITTER_CORRECTED                   = Integer
 SHAPE_MODEL                              = String
 A_AXIS_RADIUS                            = (Real, 2)
@@ -68,7 +68,7 @@ BANDS                                    = Integer
 OFFSET                                   = Real
 SCALING_FACTOR                           = Real
 SAMPLE_BITS                              = Integer
-SAMPLE_BIT_MASK                          = ("Binary",16)
+SAMPLE_BIT_MASK                          = ("Binary",8)
 SAMPLE_TYPE                              = Enum
 FILTER_NAME                              = String
 CENTER_FILTER_WAVELENGTH                 = Real

isis/src/mro/apps/hideal2pds/hideal2pds.xml

@@ -59,6 +59,9 @@
     <change name="Tyler Wilson" date="2019-02-08">
       Added an option to control the output bits.  min = 8, max =16, default = 10.  Fixes #5527.
     </change>
+    <change name="Timothy Giroux" date="2020-09-08">
+      Output label now has the correct SAMPLE_BIT_MASK value according to bits input. Fixes #3978. 
+    </change>
   </history>
 
   <groups>

isis/src/mro/apps/hideal2pds/main.cpp

@@ -184,6 +184,12 @@ void IsisMain() {
 
   updatePdsLabelTimeParametersGroup(pdsLabel);
   updatePdsLabelImageObject(isisCubeLab, pdsLabel);
+
+  // change SAMPLE_BIT_MASK value according to BITS input
+  PvlObject &image = pdsLabel.findObject("IMAGE");
+  image.addKeyword(PvlKeyword("SAMPLE_BIT_MASK", toString((int)pow(2.0, (double)nbits) - 1)),
+                   Pvl::Replace);
+
   Camera *cam = inputCube->camera();
   updatePdsLabelRootObject(isisCubeLab, pdsLabel, ui, cam);
 
@@ -287,7 +293,12 @@ void IsisMain() {
   // Read in the proper keyword types (Real, Enum, String, Integer, etc) for 
   // each PvlKeyword so that the PDS labels have proper format
   PvlFormat *formatter = pdsLabel.format();
-  formatter->add("$ISISROOT/appdata/translations/MroHiriseIdealPds.typ");
+
+  if( nbits != 8 ) {
+    formatter->add("$ISISROOT/appdata/translations/MroHiriseIdealPds_16bit.typ");
+  } else {
+    formatter->add("$ISISROOT/appdata/translations/MroHiriseIdealPds_8bit.typ");
+  }
 
   // Format ordering of keywords/objects/groups/comments in the PDS labels
   pdsLabel.setFormatTemplate("$ISISROOT/appdata/translations/MroHiriseIdealPds.pft");