Add new parameters OFFBODY and OFFBODYTRIM to cam2cam (#5704)

* Updated cam2cam to incorporate new parameters OFFBODY and OFFBODYTRIM.

* Updated examples and documentation addressing OFFBODY and OFFBODYTRIM parameters. Addresses #3602.

* Minor corrections to cam2cam documentation. Addresses #3602.

* Updated links in cam2cam documentation. Addresses #3602.

* Updated FunctionalTestsCam2cam.cpp to incorporate OFFBODY and OFFBODYTRIM parameters.

* Tests OFFBODY and OFFBODY trim. Addresses #3602.

* Added OFFBODY and OFFBODYTRIM parameters to cam2cam. Added tests and updated documentation. Addresses issue #3602.

* Changes made per feedback in PR. Moved xform from .cpp to .h.

* Moved Cam2CamMapper class from cam2cam.h to FunctionalTestsCam2cam.cpp.

---------

Co-authored-by: kledmundson <[email protected]>
Co-authored-by: kledmundson <[email protected]>

CHANGELOG.md

@@ -36,6 +36,7 @@ release.
 ## [Unreleased]
 
 ### Added
+- Added OFFBODY and OFFBODYTRIM parameters to cam2cam. Added tests and updated documentation. [#3602] (https://github.com/DOI-USGS/ISIS3/issues/3602)
 
 ### Changed
 

isis/src/base/apps/cam2cam/assets/files/BulletEngineSelect.pref

@@ -0,0 +1,5 @@
+Group = ShapeModel
+  RayTraceEngine = Bullet
+  OnError = Continue
+EndGroup
+End

isis/src/base/apps/cam2cam/assets/files/cam2camExample3.sh

@@ -0,0 +1,26 @@
+#!/bin/sh
+
+# Get example image acquired by OREX OCAMS during "Detailed Survey" phase\
+dtype="map_iofL2b"\
+fbase="20190509T180552S020"\
+
+# Download the OSIRIS-REx image. Note wget can be installed using the command\
+# "conda install wget"\
+wget -P . "https://sbnarchive.psi.edu/pds4/orex/orex.ocams/data_calibrated/detailed_survey/$\{fbase\}_$\{dtype\}.fits"\
+
+# Import into ISIS\
+ocams2isis from="$\{fbase\}_$\{dtype\}.fits" to="$\{fbase\}_pck.cub"\
+ocams2isis from="$\{fbase\}_$\{dtype\}.fits" to="$\{fbase\}_dtm.cub"\
+
+spiceinit from="$\{fbase\}_pck.cub" shape=ellipsoid\
+spiceinit from="$\{fbase\}_dtm.cub" shape=user model='$osirisrex/kernels/dsk/g_00880mm_alt_ptm_0000n00000_v020.bds' -pref=$ISISROOT/BulletEngineSelect.pref\
+
+# Run cam2cam for each set\
+cam2cam from="$\{fbase\}_pck.cub" match="$\{fbase\}_dtm.cub" to="$\{fbase\}_pck_to_dtm_def.cub"\
+cam2cam from="$\{fbase\}_pck.cub" match="$\{fbase\}_dtm.cub" to="$\{fbase\}_pck_to_dtm_off.cub" offbody=true offbodytrim=false\
+cam2cam from="$\{fbase\}_pck.cub" match="$\{fbase\}_dtm.cub" to="$\{fbase\}_pck_to_dtm_offtrim.cub" offbody=true offbodytrim=true\
+
+cam2cam from="$\{fbase\}_dtm.cub" match="$\{fbase\}_pck.cub" to="$\{fbase\}_dtm_to_pck_def.cub"\
+cam2cam from="$\{fbase\}_dtm.cub" match="$\{fbase\}_pck.cub" to="$\{fbase\}_dtm_to_pck_off.cub" offbody=true offbodytrim=false\
+cam2cam from="$\{fbase\}_dtm.cub" match="$\{fbase\}_pck.cub" to="$\{fbase\}_dtm_to_pck_offtrim.cub" offbody=true offbodytrim=true\
+

isis/src/base/apps/cam2cam/cam2cam.cpp

@@ -1,11 +1,17 @@
+/** This is free and unencumbered software released into the public domain.
+The authors of ISIS do not claim copyright on the contents of this file.
+For more details about the LICENSE terms and the AUTHORS, you will
+find files of those names at the top level of this repository. **/
+
+/* SPDX-License-Identifier: CC0-1.0 */
+
 #include <cmath>
 
 #include "cam2cam.h"
 
 #include "Application.h"
 #include "Camera.h"
 #include "CameraFactory.h"
-#include "Distance.h"
 #include "ProcessRubberSheet.h"
 
 using namespace std;
@@ -56,10 +62,15 @@ namespace Isis {
     referenceBand += (referenceBand % 2);
     referenceBand /= 2;
 
-   // See if the user wants to override the reference band
+    // See if the user wants to override the reference band
     if (ui.WasEntered("REFBAND")) {
       referenceBand = ui.GetInteger("REFBAND");
     }
+
+    // Check for propagation of off-body (based upon RA/Dec) pixels as well
+    // but allow for trimming of off target intersections in FROM file.
+    bool offbody = ui.GetBoolean("OFFBODY");
+    bool trim = ui.GetBoolean("OFFBODYTRIM");
 
     // Using the Camera method out of the object opack will not work, because the
     // filename required by the Camera is not passed by the process class in this
@@ -95,7 +106,9 @@ namespace Isis {
                                             cam2camGlobal::incam,
                                             ocube->sampleCount(),
                                             ocube->lineCount(),
-                                            outcam);
+                                            outcam,
+                                            offbody,
+                                            trim);
 
     // Add the reference band to the output if necessary
     ocube->putGroup(instgrp);
@@ -127,56 +140,4 @@ namespace Isis {
   }
 
 
-  // Transform object constructor
-  cam2camXform::cam2camXform(const int inputSamples, const int inputLines,
-                             Camera *incam, const int outputSamples,
-                             const int outputLines, Camera *outcam) {
-    p_inputSamples = inputSamples;
-    p_inputLines = inputLines;
-    p_incam = incam;
-
-    p_outputSamples = outputSamples;
-    p_outputLines = outputLines;
-    p_outcam = outcam;
-  }
-
-  // Transform method mapping output line/samps to lat/lons to input line/samps
-  bool cam2camXform::Xform(double &inSample, double &inLine,
-                           const double outSample, const double outLine) {
-    // See if the output image coordinate converts to lat/lon
-    if (!p_outcam->SetImage(outSample, outLine)) return false;
-
-    // Get the universal lat/lon and see if it can be converted to input line/samp
-    double lat = p_outcam->UniversalLatitude();
-    double lon = p_outcam->UniversalLongitude();
-    Distance rad = p_outcam->LocalRadius();
-    if (rad.isValid()) {
-      if (!p_incam->SetUniversalGround(lat, lon, rad.meters())) return false;
-    }
-    else {
-      if (!p_incam->SetUniversalGround(lat, lon)) return false;
-    }
-
-    // Make sure the point is inside the input image
-    if (p_incam->Sample() < 0.5) return false;
-    if (p_incam->Line() < 0.5) return false;
-    if (p_incam->Sample() > p_inputSamples + 0.5) return false;
-    if (p_incam->Line() > p_inputLines + 0.5) return false;
-
-    // Everything is good
-    inSample = p_incam->Sample();
-    inLine = p_incam->Line();
-    return true;
-  }
-
-
-  int cam2camXform::OutputSamples() const {
-    return p_outputSamples;
-  }
-
-
-  int cam2camXform::OutputLines() const {
-    return p_outputLines;
-  }
-
 }

isis/src/base/apps/cam2cam/cam2cam.h

@@ -1,11 +1,21 @@
+/** This is free and unencumbered software released into the public domain.
+The authors of ISIS do not claim copyright on the contents of this file.
+For more details about the LICENSE terms and the AUTHORS, you will
+find files of those names at the top level of this repository. **/
+
+/* SPDX-License-Identifier: CC0-1.0 */
+
 #ifndef cam2cam_h
 #define cam2cam_h
 
+#include <memory>
+
 #include "Transform.h"
 
 #include "Application.h"
 #include "Camera.h"
 #include "Cube.h"
+#include "Distance.h"
 #include "UserInterface.h"
 
 namespace Isis {
@@ -26,21 +36,86 @@ namespace Isis {
       int p_inputLines;
       int p_outputSamples;
       int p_outputLines;
+      bool p_offbody;
+      bool p_trim;
 
     public:
       // constructor
       cam2camXform(const int inputSamples, const int inputLines, Isis::Camera *incam,
-                   const int outputSamples, const int outputLines, Isis::Camera *outcam);
+                   const int outputSamples, const int outputLines, Isis::Camera *outcam,
+                   const bool offbody = false, const bool trim = true) {
 
+        p_inputSamples = inputSamples;
+        p_inputLines = inputLines;
+        p_incam = incam;
+
+        p_outputSamples = outputSamples;
+        p_outputLines = outputLines;
+        p_outcam = outcam;
+        p_offbody = offbody;
+        p_trim = trim;
+      }
+
       // destructor
-      ~cam2camXform() {};
+      virtual ~cam2camXform() {};
 
-      // Override parent's pure virtual members
-      bool Xform(double &inSample, double &inLine,
-                 const double outSample, const double outLine);
-      int OutputSamples() const;
-      int OutputLines() const;
+      /** Transform method mapping output line/samps to lat/lons to input line/samps */
+      inline bool Xform(double &inSample, double &inLine,
+                        const double outSample, const double outLine) {
+
+       // See if the output image coordinate converts to lat/lon
+       if ( p_outcam->SetImage(outSample, outLine) )  {
+         // Get the universal lat/lon and see if it can be converted to input line/samp
+         double lat = p_outcam->UniversalLatitude();
+         double lon = p_outcam->UniversalLongitude();
+         Distance rad = p_outcam->LocalRadius();
+         if (rad.isValid()) {
+           if(!p_incam->SetUniversalGround(lat, lon, rad.meters())) return false;
+         }
+         else {
+           if(!p_incam->SetUniversalGround(lat, lon)) return false;
+         }
+       }
+       else if ( p_offbody ) {
+         double ra = p_outcam->RightAscension();
+         double dec = p_outcam->Declination();
+         if ( !p_incam->SetRightAscensionDeclination(ra,dec) ) return false;
+         if ( p_trim ) {
+           if ( p_incam->SetImage(p_incam->Sample(), p_incam->Line()) ) return (false);
+         }
+       }
+       else {
+         return false;
+       }
+
+       // Make sure the point is inside the input image
+       if (p_incam->Sample() < 0.5) return false;
+       if (p_incam->Line() < 0.5) return false;
+       if (p_incam->Sample() > p_inputSamples + 0.5) return false;
+       if (p_incam->Line() > p_inputLines + 0.5) return false;
+
+       // Everything is good
+       inSample = p_incam->Sample();
+       inLine = p_incam->Line();
+       return true;
+       }
+
+
+       inline int OutputSamples() const {
+         return p_outputSamples;
+       }
+
+
+       inline int OutputLines() const {
+         return p_outputLines;
+       }
+
   };
+
+
+
+
+
 }
 
 #endif