Changed "mse" to more generic "distortion"

Signed-off-by: Pierre-Anthony Lemieux <pal@sandflow.com>

Author: palemieux

src/bin/exrmetrics/CMakeLists.txt

@@ -1,4 +1,4 @@
 # SPDX-License-Identifier: BSD-3-Clause
 # Copyright (c) Contributors to the OpenEXR Project.
 
-add_openexr_bin_program(exrmetrics SOURCES main.cpp exrmetrics.cpp mseutils.cpp)
+add_openexr_bin_program(exrmetrics SOURCES main.cpp exrmetrics.cpp distortionUtils.cpp)

src/bin/exrmetrics/mseutils.cpp src/bin/exrmetrics/distortionUtils.cppsrc/bin/exrmetrics/mseutils.cpp renamed to src/bin/exrmetrics/distortionUtils.cpp

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: BSD-3-Clause
 // Copyright (c) Contributors to the OpenEXR Project.
 
-#include "mseutils.h"
+#include "distortionUtils.h"
 
 #include <cmath>
 #include <limits>
@@ -10,7 +10,7 @@ using IMATH_NAMESPACE::half;
 
 template <>
 void
-accumMSE<half> (
+accumLogMSE<half> (
     const half* orig,
     const half* reread,
     uint64_t    pixelsInChannel,
@@ -34,7 +34,7 @@ accumMSE<half> (
 
 template <>
 void
-accumMSE<float> (
+accumLogMSE<float> (
     const float* orig,
     const float* reread,
     uint64_t     pixelsInChannel,

src/bin/exrmetrics/mseutils.h src/bin/exrmetrics/distortionUtils.hsrc/bin/exrmetrics/mseutils.h renamed to src/bin/exrmetrics/distortionUtils.h

@@ -1,30 +1,30 @@
 // SPDX-License-Identifier: BSD-3-Clause
 // Copyright (c) Contributors to the OpenEXR Project.
 
-#ifndef INCLUDED_MSE_UTILS_H
-#define INCLUDED_MSE_UTILS_H
+#ifndef INCLUDED_DISTORTION_UTILS_H
+#define INCLUDED_DISTORTION_UTILS_H
 
 #include <half.h>
 #include <cstdint>
 
 template <typename T>
-void accumMSE (
+void accumLogMSE (
     const T*  orig,
     const T*  reread,
     uint64_t  pixelsInChannel,
     double&   sumSq,
     uint64_t& count);
 
 template <>
-void accumMSE<IMATH_NAMESPACE::half> (
+void accumLogMSE<IMATH_NAMESPACE::half> (
     const IMATH_NAMESPACE::half* orig,
     const IMATH_NAMESPACE::half* reread,
     uint64_t                     pixelsInChannel,
     double&                      sumSq,
     uint64_t&                    count);
 
 template <>
-void accumMSE<float> (
+void accumLogMSE<float> (
     const float* orig,
     const float* reread,
     uint64_t     pixelsInChannel,

src/bin/exrmetrics/exrmetrics.cpp

@@ -5,7 +5,7 @@
 //
 
 #include "exrmetrics.h"
-#include "mseutils.h"
+#include "distortionUtils.h"
 
 #include "ImfChannelList.h"
 #include "ImfDeepFrameBuffer.h"
@@ -995,7 +995,7 @@ exrmetrics (
     bool                               reread,
     PixelMode                          pixelMode,
     bool                               verbose,
-    bool                               computeMSE)
+    bool                               computeDistortion)
 {
 
     if (verbose)
@@ -1088,7 +1088,7 @@ exrmetrics (
     if (!isinf (level) && level >= -1 && !compressionSet)
     {
         throw runtime_error (
-            "-l option only works for DWAA/DWAB,ZIP/ZIPS or ZSTD compression");
+            "-l option only works for DWAA/DWAB, HTJ2KL256,ZIP/ZIPS or ZSTD compression");
     }
 
     vector<partData> parts (part == -1 ? in.parts () : 1);
@@ -1179,14 +1179,14 @@ exrmetrics (
     }
 
     //
-    // compute MSE vs. re-read data
+    // compute distortion vs. re-read data
     //
-    if (computeMSE && write && reread)
+    if (computeDistortion && write && reread)
     {
         for (size_t p = 0; p < parts.size (); ++p)
         {
-            metrics.stats[p].mseCount = 0;
-            metrics.stats[p].mse = std::numeric_limits<double>::quiet_NaN ();
+            metrics.stats[p].distortionCount = 0;
+            metrics.stats[p].distortion = std::numeric_limits<double>::quiet_NaN ();
             string partType = outHeaders[p].type ();
             if (partType != SCANLINEIMAGE && partType != TILEDIMAGE) continue;
 
@@ -1251,8 +1251,8 @@ exrmetrics (
 
                 if (i.channel ().type == HALF)
                 {
-                    metrics.stats[p].mseKind = MSE_LOG_HALF;
-                    accumMSE (
+                    metrics.stats[p].metricKind = LOG_MSE_HALF;
+                    accumLogMSE (
                         reinterpret_cast<const half*> (origData),
                         reinterpret_cast<const half*> (rereadData),
                         pixelsInChannel,
@@ -1261,8 +1261,8 @@ exrmetrics (
                 }
                 else if (i.channel ().type == FLOAT)
                 {
-                    metrics.stats[p].mseKind = MSE_LOG_FLOAT;
-                    accumMSE (
+                    metrics.stats[p].metricKind = LOG_MSE_FLOAT;
+                    accumLogMSE (
                         reinterpret_cast<const float*> (origData),
                         reinterpret_cast<const float*> (rereadData),
                         pixelsInChannel,
@@ -1271,8 +1271,8 @@ exrmetrics (
                 }
             }
 
-            metrics.stats[p].mseCount = count;
-            metrics.stats[p].mse =
+            metrics.stats[p].distortionCount = count;
+            metrics.stats[p].distortion =
                 count > 0 ? sumSq / count
                           : std::numeric_limits<double>::quiet_NaN ();
         }

src/bin/exrmetrics/exrmetrics.h

@@ -44,11 +44,11 @@ struct partSizeData
     std::string partType = "";
 };
 
-enum MSEKind
+enum DistortionMetric
 {
-    MSE_NONE,
-    MSE_LOG_HALF,
-    MSE_LOG_FLOAT,
+    DISTORTION_METRIC_NONE,
+    LOG_MSE_HALF,
+    LOG_MSE_FLOAT,
 };
 
 struct partStats
@@ -65,9 +65,9 @@ struct partStats
         rereadPerf; // for deep, times reading the sample count, otherwise times reading the entire data
     uint64_t sizeOnDisk = 0; // record compressed size of part on disk.
 
-    MSEKind  mseKind  = MSE_NONE;
-    double   mse      = std::numeric_limits<double>::quiet_NaN ();
-    uint64_t mseCount = 0;
+    DistortionMetric  metricKind  = DISTORTION_METRIC_NONE; // kind of distortion metric used
+    double   distortion      = std::numeric_limits<double>::quiet_NaN (); // distortion computed using the distortion metric
+    uint64_t distortionCount = 0; // number of samples used to compute the distortion
 
     partSizeData sizeData;
 };
@@ -91,6 +91,6 @@ fileMetrics exrmetrics (
     bool                               reread,
     PixelMode                          pixelMode,
     bool                               verbose,
-    bool                               computeMSE = false);
+    bool                               computeDistortion = false);
 
 #endif

src/bin/exrmetrics/main.cpp

@@ -65,7 +65,7 @@ usageMessage (ostream& stream, const char* program_name, bool verbose = false)
                "  -t n                        Use a pool of n worker threads for processing files.\n"
                "                              Default is single threaded (no thread pool)\n"
                "\n"
-               "  -l level                    set DWA or ZIP compression level\n"
+               "  -l level                    set compression level for DWA, ZIP and lossy HTJ2K\n"
                "\n"
                "  -z,--compression list       list of compression methods to test\n"
                "                              ("
@@ -92,7 +92,7 @@ usageMessage (ostream& stream, const char* program_name, bool verbose = false)
                " --csv                        print output in csv mode. If passes>1, show median timing\n"
                "                              default is JSON mode\n"
                " --passes num                 write and re-read file num times (default 1)\n"
-               " --mse                        compute LogMSE per part, comparing original vs. re-read after compression.\n"
+               " --distortion                        compute LogMSE per part, comparing original vs. re-read after compression.\n"
                "                              Parts must have uniform half or float channel types. Samples that are non-finite\n"
                "                              in the original are skipped. Samples that are finite in the original and not finite\n"
                "                              in the re-read result in Nan."
@@ -126,7 +126,7 @@ struct options
     bool                     outputPartSizeOnDisk = false;
     bool                     verbose        = false;
     bool                     csv            = false;
-    bool                     computeMSE     = false;
+    bool                     computeDistortion     = false;
     std::vector<PixelMode>   pixelModes;
     std::vector<OPENEXR_IMF_NAMESPACE::Compression> compressions;
 
@@ -266,7 +266,7 @@ jsonStats (
     bool           partSize,
     bool           raw,
     bool           stats,
-    bool           computeMSE)
+    bool           computeDistortion)
 {
 
     static const char* lastFileName = nullptr;
@@ -393,7 +393,7 @@ jsonStats (
             printPartStats (
                 out, run.metrics.totalStats, "      ", timing,false, raw, stats);
         }
-        if (timing && run.metrics.stats.size () > 1 || computeMSE)
+        if (timing && run.metrics.stats.size () > 1 || computeDistortion)
         {
             out << ",\n";
             out << "      \"parts\":\n";
@@ -402,11 +402,11 @@ jsonStats (
             {
                 out << "        {\n";
                 out << "          \"part\": " << part;
-                if (computeMSE)
+                if (computeDistortion)
                 {
                     out << ",\n";
                     out << "          \"" << "log_mse"
-                        << "\": " << run.metrics.stats[part].mse;
+                        << "\": " << run.metrics.stats[part].distortion;
                 }
                 if (timing)
                 {
@@ -440,7 +440,7 @@ jsonStats (
 }
 
 void
-csvStats (ostream& out, list<runData>& data, bool outputSizeData, int timing, bool computeMSE)
+csvStats (ostream& out, list<runData>& data, bool outputSizeData, int timing, bool computeDistortion)
 {
     out << "file name";
     if (outputSizeData)
@@ -449,7 +449,7 @@ csvStats (ostream& out, list<runData>& data, bool outputSizeData, int timing, bo
     }
     out << ",compression,pixel mode";
     if (outputSizeData) { out << ",output size"; }
-    if (computeMSE) { out << ",mse"; }
+    if (computeDistortion) { out << ",distortion"; }
     if (timing & options::TIME_READ)
     {
         out << ",count read time";
@@ -486,15 +486,15 @@ csvStats (ostream& out, list<runData>& data, bool outputSizeData, int timing, bo
         out << ',' << compName << ',' << modeName (run.mode);
 
         if (outputSizeData) { out << ',' << run.metrics.outputFileSize; }
-        if (computeMSE)
+        if (computeDistortion)
             out << ',';
             for (size_t p = 0; p < run.metrics.stats.size (); ++p)
             {
                 if (p > 0) { out << '|'; }
-                switch (run.metrics.stats[p].mseKind) {
-                    case MSE_LOG_HALF:
-                    case MSE_LOG_FLOAT:
-                        out << "log_mse:" << run.metrics.stats[p].mse;
+                switch (run.metrics.stats[p].metricKind) {
+                    case LOG_MSE_HALF:
+                    case LOG_MSE_FLOAT:
+                        out << "log_mse:" << run.metrics.stats[p].distortion;
                         break;
                     default:
                         out << "---";
@@ -576,12 +576,12 @@ main (int argc, char** argv)
                             opts.passes,
                             opts.outFile || opts.outputSizeData ||
                             opts.timing & options::TIME_WRITE ||
-                            opts.computeMSE,
+                            opts.computeDistortion,
                             opts.timing & options::TIME_REREAD ||
-                            opts.computeMSE,
+                            opts.computeDistortion,
                             mode,
                             opts.verbose,
-                            opts.computeMSE);
+                            opts.computeDistortion);
                         data.push_back (d);
                     }
                 }
@@ -604,12 +604,12 @@ main (int argc, char** argv)
 
         if (opts.csv)
         {
-            csvStats (cout, data, opts.outputSizeData, opts.timing, opts.computeMSE);
+            csvStats (cout, data, opts.outputSizeData, opts.timing, opts.computeDistortion);
         }
         else
         {
             jsonStats (
-                cout, data, opts.outputSizeData, opts.timing, showPartSizeOnDisk, true, true, opts.computeMSE);
+                cout, data, opts.outputSizeData, opts.timing, showPartSizeOnDisk, true, true, opts.computeDistortion);
         }
     }
 
@@ -940,9 +940,9 @@ options::parse (int argc, char* argv[])
             outputPartSizeOnDisk = true;
             i += 1;
         }
-        else if (!strcmp (argv[i], "--mse"))
+        else if (!strcmp (argv[i], "--distortion"))
         {
-            computeMSE = true;
+            computeDistortion = true;
             i += 1;
         }
         else if (!strcmp (argv[i], "-i"))