Commit e94a960e authored by Jeffrey Covington's avatar Jeffrey Covington
Browse files

Updated documentation and fixed running gui multiple times Fixes #2203,2212 

git-svn-id: http://subversion.wr.usgs.gov/repos/prog/isis3/trunk@6031 41f8697f-d340-4b68-9986-7bafba869bb8
parent 1f7ae496

isis/src/base/apps/cubediff/assets/images/compareLog.jpg

+6.71 KiB (32.5 KiB)
Loading image diff...

isis/src/base/apps/cubediff/assets/thumbs/compareLog.jpg

+2.74 KiB (12.2 KiB)
Loading image diff...

isis/src/base/apps/cubediff/cubediff.cpp

+4 −3
Original line number Diff line number Diff line
@@ -72,6 +72,7 @@ void IsisMain() { 


  // Compare the cubes

  filesEqual = true;

  firstDifferenceFound = false;

  spCount = 0;

  stats.Reset();

  colWidth = 0;
@@ -182,8 +183,8 @@ void compare(vector<Buffer *> &in, vector<Buffer *> &out) { 
      unsigned int accuracy = 0;



      // Check positive/negative and ensure both positive

      if((input1[index] < 0 && input2[index] > 0) ||

          (input1[index] > 0 && input2[index] < 0)) {

      if((input1[index] < 0.0 && input2[index] > 0.0) ||

          (input1[index] > 0.0 && input2[index] < 0.0)) {

        accuracy = 1;

      }

      else {
@@ -193,7 +194,7 @@ void compare(vector<Buffer *> &in, vector<Buffer *> &out) { 
        int in2log = (int)floor(log10(in2));



        // Check for zeros

        if(input1[index] == 0 || input2[index] == 0) {

        if(input1[index] == 0.0 || input2[index] == 0.0) {

          accuracy = 0;

        }

        // Check for different decimal places

isis/src/base/apps/cubediff/cubediff.xml

+94 −2
Original line number Diff line number Diff line
@@ -5,8 +5,94 @@ 
  </brief>



  <description>

    <p>

      This program compares two cube files pixel by pixel,  with results written

      to the log and/or user specified output file.

    </p>



    <h4>

      Output:

    </h4> 



    <table border = "1">

      <tr>

        <th>Label</th>

        <th>Description</th>

      </tr>

      <tr>

        <td>Compare</td>

        <td>The files are <b>different</b> if any pair of pixels is different, otherwise the files are <b>identical</b>.</td>

      </tr>

      <tr>

        <td>Sample</td>

        <td>The sample of the first pair of pixels that is different</td>

      </tr>

      <tr>

        <td>Line</td>

        <td>The line of the first pair of pixels that is different</td>

      </tr>

      <tr>

        <td>Band</td>

        <td>The band of the first pair of pixels that is different</td>

      </tr>

      <tr>

        <td>AverageDifference</td>

        <td>The average absolute value of the differences of all pairs of pixels</td>

      </tr>

      <tr>

        <td>StandardDeviation</td>

        <td>The standard deviation of the absolute value of the differences of all pairs of pixels</td>

      </tr>

      <tr>

        <td>Variance</td>

        <td>The variance of the absolute value of the differences of all pairs of pixels</td>

      </tr>

      <tr>

        <td>MinimumDifference</td>

        <td>The smallest absolute value of the differences of all pairs of pixels</td>

      </tr>

      <tr>

        <td>MaximumDifference</td>

        <td>The largest absolute value of the differences of all pairs of pixels</td>

      </tr>

      <tr>

        <td>MaxDifferenceSample</td>

        <td>The sample of the pair of pixels with the largest difference</td>

      </tr>

       <tr>

        <td>MaxDifferenceLine</td>

        <td>The line of the pair of pixels with the largest difference</td>

      </tr>

      <tr>

        <td>MaxDifferenceBand</td>

        <td>The band of the pair of pixels with the largest difference</td>

      </tr>

      <tr>

        <td>ValidPixelDifferences</td>

        <td>The number of pairs of nonspecial pixels that are different</td>

      </tr>

      <tr>

        <td>SpecialPixelDifferences</td>

        <td>The number of pairs of pixels that are different where at least one pixel is special</td>

      </tr>

      <tr>

        <td>SigFigAccuracy</td>

        <td>The minimum value of the approximate number of significant figures of the differences of all pairs of pixels. The approximation is given by floor(log10(in1)) - floor(log10(abs(in1 - in2)) where in1 and in2 are the pair of pixels.</td>

      </tr>

      <tr>

        <td>SigFigMaxDifferenceSample</td>

        <td>The sample of the first pair of pixels where SigFigAccuracy in minimized</td>

      </tr>

      <tr>

        <td>SigFigMaxDifferenceLine</td>

        <td>The line of the first pair of pixels where SigFigAccuracy in minimized</td>

      </tr>

      <tr>

        <td>SigFigMaxDifferenceBand</td>

        <td>The band of the first pair of pixels where SigFigAccuracy in minimized</td>

      </tr>

    </table>



  </description>



  <category>
@@ -99,6 +185,12 @@ 
        Incuded keywords MaxDifference Line, Sample and Band in the output to 

        indicate the line, sample, band where the max cube difference occured

    </change>

    <change name="Jeffrey Covington" date="2015-01-09">

	Added descriptions for each label of the output

    </change>

    <change name="Jeffrey Covington" date="2015-01-13">

	Fixed output when run multiple times in the GUI

    </change>

  </history>



  <groups>
@@ -241,11 +333,11 @@ 
      </inputImages>



      <outputImages>

        <image src="assets/images/compareLog.jpg" width="448" height="550">

        <image src="assets/images/compareLog.jpg" width="370" height="350">

          <brief>The output log</brief>

          <description> This is the default output compare log.  Use the TO parameter for a text file output.

          </description>

          <thumbnail caption="Display of Output compare log showing results of the compare application." src="assets/thumbs/compareLog.jpg" width="200" height="170"/>

          <thumbnail caption="Display of Output compare log showing results of the compare application." src="assets/thumbs/compareLog.jpg" width="200" height="189"/>

        </image>

      </outputImages>