cleanup public interfaces (#173)

* cleanup public interfaces

Signed-off-by: Anton Dukhovnikov <[email protected]>

Author: antond-weta

.github/workflows/ci.yml

@@ -172,7 +172,7 @@ jobs:
         run: >
           cmake
           -B build_config_test
-          -S ./unittest/config_tests
+          -S ./tests/config_tests
           -D RAWTOACES_DIR=${{ github.workspace }}/install/lib/cmake/RAWTOACES
           -D CMAKE_CXX_STANDARD=${{matrix.cxx_std}}
 
@@ -262,7 +262,7 @@ jobs:
         run: >
           cmake
           -B build_config_test
-          -S ${{ github.workspace }}/unittest/config_tests
+          -S ${{ github.workspace }}/tests/config_tests
           -D RAWTOACES_DIR=${{ github.workspace }}/install/lib/cmake/RAWTOACES
           -D CMAKE_TOOLCHAIN_FILE="${{ matrix.toolchain_file }}"
           -D CMAKE_CXX_STANDARD=17

CMakeLists.txt

@@ -82,7 +82,7 @@ add_subdirectory("src/${RAWTOACES_UTIL_LIB}")
 add_subdirectory("src/rawtoaces")
 
 enable_testing()
-add_subdirectory(unittest)
+add_subdirectory(tests)
 
 #################################################
 ##

include/rawtoaces/acesrender.h renamed to include/rawtoaces/image_converter.h

@@ -11,8 +11,6 @@ namespace rta
 namespace util
 {
 
-void create_key( std::unordered_map<std::string, char> &keys );
-
 /// Collect all files from a given`path` into batchs. If the `path` is a
 /// directory, create an entry in `batches` and fill it with the file names
 /// from that directory. If the `path` is a file, add its name to the first
@@ -27,18 +25,6 @@ bool collect_image_files(
 class ImageConverter
 {
 public:
-    // TODO:
-    // Removed options comparing to v1.1:
-    // -P - bad pixels
-    // -K - dark frame
-    // -j - fuji-rotate
-    // -m - median filter
-    // -f - four-colour RGB
-    // -T - print Libraw-supported cameras
-    // -F - use big file
-    // -E - mmap-ed IO
-    // -s - image index in the file
-    // -G - green_matching() filter
     struct Settings
     {
         /// The  white balancing method to use for conversion can be specified
@@ -92,7 +78,7 @@ class ImageConverter
             Soft,
             /// Write out only the crop area.
             Hard
-        } crop_mode = CropMode::Soft;
+        } crop_mode = CropMode::Hard;
 
         /// An illuminant to use for white balancing and/or colour matrix
         /// calculation. Only used when `wbMethod` ==
@@ -137,8 +123,6 @@ class ImageConverter
 
     } settings;
 
-    static void usage( const char *prog );
-
     /// Initialise the parser object with all the command line parameters
     /// used by this tool. The method also sets the help and usage strings.
     /// The parser object can be amended by the calling code afterwards if

include/rawtoaces/rawtoaces_core.h

@@ -10,6 +10,23 @@ namespace rta
 namespace core
 {
 
+// clang-format off
+
+static const std::vector<std::vector<double>> XYZ_to_ACES = {
+    {  1.0498110175, 0.0000000000, -0.0000974845 },
+    { -0.4959030231, 1.3733130458,  0.0982400361 },
+    {  0.0000000000, 0.0000000000,  0.9912520182 }
+};
+
+/// Colour adaptation from D65 to the ACES white point
+static const std::vector<std::vector<double> > CAT_D65_to_ACES = {
+    {  1.0097583639200136,      0.0050178093846550455, -0.015058389092388141  },
+    {  0.0036602813378778347,   1.0030138169214682,    -0.0059802329456399824 },
+    { -0.00029980928869024906, -0.0010516909063249997,  0.92820279627476576   }
+};
+
+// clang-format on
+
 /// Calculate spectral power distribution of a daylight illuminant of given CCT
 /// - parameter cct: correlated colour temperature of the requested illuminant.
 /// - parameter spectrum: a reference to a `Spectrum` object to full with the

src/rawtoaces/main.cpp

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 // Copyright Contributors to the rawtoaces Project.
 
-#include <rawtoaces/acesrender.h>
+#include <rawtoaces/image_converter.h>
 
 #include <set>
 

src/rawtoaces_core/CMakeLists.txt

@@ -2,8 +2,6 @@ cmake_minimum_required(VERSION 3.12)
 include_directories( "${CMAKE_CURRENT_SOURCE_DIR}" )
 
 set( CORE_PUBLIC_HEADER
-    ../../include/rawtoaces/define.h
-    ../../include/rawtoaces/mathOps.h
     ../../include/rawtoaces/rawtoaces_core.h
     ../../include/rawtoaces/spectral_data.h
 )
@@ -15,6 +13,8 @@ add_library( ${RAWTOACES_CORE_LIB} ${DO_SHARED}
     # Make the headers visible in IDEs. This should not affect the builds.
     ${CORE_PUBLIC_HEADER}
     rawtoaces_core_priv.h
+    define.h
+    mathOps.h
 )
 
 target_link_libraries(

include/rawtoaces/define.h renamed to src/rawtoaces_core/define.h

@@ -72,14 +72,6 @@ static const double d50  [3] = {0.9642,            1.0000, 0.8250};
 static const double d60  [3] = {0.952646074569846, 1.0000, 1.00882518435159};
 static const double d65  [3] = {0.9547,            1.0000, 1.0883};
 
-static const std::vector<double> ACES_white_XYZ = {
-    0.952646074569846, 1.0,    1.00882518435159
-};
-
-static const std::vector<double> D65_white_XYZ = {
-    0.9547, 1.0000, 1.0883
-};
-
 static const double neutral3[3][3] = {
     {1.0, 0.0, 0.0},
     {0.0, 1.0, 0.0},
@@ -166,13 +158,6 @@ static const double XYZ_acesrgb_3[3][3] = {
     {  0.0000000000, 0.0000000000,  0.9912520182 }
 };
 
-
-static const std::vector<std::vector<double>> XYZ_to_ACES = {
-    {  1.0498110175, 0.0000000000, -0.0000974845 },
-    { -0.4959030231, 1.3733130458,  0.0982400361 },
-    {  0.0000000000, 0.0000000000,  0.9912520182 }
-};
-
 static const double XYZ_acesrgb_4[4][4] = {
     {  1.0498110175, 0.0000000000, -0.0000974845, 0.0 },
     { -0.4959030231, 1.3733130458,  0.0982400361, 0.0 },
@@ -243,13 +228,19 @@ static const double bradford[3][3] = {
     { 0.0389, -0.0685,  1.0296}
 };
 
-//  Color Adaptation Matrices - Cat02 (default)
-static const double cat02[3][3] = {
+//  Color Adaptation Matrices - CAT02 (default)
+static const std::vector<std::vector<double>> CAT02 = {
     {  0.7328, 0.4296, -0.1624 },
     { -0.7036, 1.6975,  0.0061 },
     {  0.0030, 0.0136,  0.9834 }
 };
 
+static const std::vector<std::vector<double>> CAT02_inv = {
+    {  1.0961238208355142,    -0.27886900021828726,   0.18274517938277304 },
+    {  0.45436904197535921,    0.47353315430741177,   0.072097803717229125 },
+    { -0.0096276087384293551, -0.0056980312161134198, 1.0153256399545427 }
+};
+
 // clang-format on
 
 // Function to Open Directories

include/rawtoaces/mathOps.h renamed to src/rawtoaces_core/mathOps.h

@@ -4,7 +4,7 @@
 #ifndef _MATHOPS_h__
 #define _MATHOPS_h__
 
-#include <rawtoaces/define.h>
+#include "define.h"
 
 #include <cfloat>
 
@@ -520,24 +520,22 @@ template <typename T> vector<T> XYZTouv( const vector<T> &XYZ )
 };
 
 template <typename T>
-vector<vector<T>> getCAT( const vector<T> &src, const vector<T> &des )
+std::vector<std::vector<T>> calculate_CAT(
+    const std::vector<T> &src_white_XYZ, const std::vector<T> &dst_white_XYZ )
 {
-    assert( src.size() == des.size() );
+    assert( src_white_XYZ.size() == 3 );
+    assert( dst_white_XYZ.size() == 3 );
 
-    vector<vector<T>> vcat( 3, vector<T>( 3 ) );
-    // cat02 or bradford
-    FORIJ( 3, 3 ) vcat[i][j] = cat02[i][j];
+    std::vector<double> src_white_LMS = mulVector( src_white_XYZ, CAT02 );
+    std::vector<double> dst_white_LMS = mulVector( dst_white_XYZ, CAT02 );
 
-    vector<T>         wSRC = mulVector( src, vcat );
-    vector<T>         wDES = mulVector( des, vcat );
-    vector<vector<T>> vkm =
-        solveVM( vcat, diagVM( divVectorElement( wDES, wSRC ) ) );
-    vkm = mulVector( vkm, transposeVec( vcat ) );
+    std::vector<std::vector<double>> mat( 3, std::vector<double>( 3, 0 ) );
+    for ( size_t i = 0; i < 3; i++ )
+        mat[i][i] = dst_white_LMS[i] / src_white_LMS[i];
 
-    clearVM( wSRC );
-    clearVM( wDES );
-
-    return vkm;
+    mat = mulVector( mat, transposeVec( CAT02 ) );
+    mat = mulVector( CAT02_inv, transposeVec( mat ) );
+    return mat;
 }
 
 template <typename T> vector<vector<T>> XYZtoLAB( const vector<vector<T>> &XYZ )

src/rawtoaces_core/rawtoaces_core.cpp

@@ -3,8 +3,8 @@
 
 #include <rawtoaces/rawtoaces_core.h>
 #include "rawtoaces_core_priv.h"
-#include <rawtoaces/mathOps.h>
-#include <rawtoaces/define.h> // for cmp_str
+#include "mathOps.h"
+#include "define.h"
 
 using namespace ceres;
 
@@ -575,7 +575,7 @@ std::vector<std::vector<double>> calXYZ(
     ww[1]                 = 1.0;
     ww[2]                 = ( cmf_z * illum ).integrate() / y;
 
-    XYZ = mulVector( XYZ, getCAT( ww, w ) );
+    XYZ = mulVector( XYZ, calculate_CAT( ww, w ) );
 
     return XYZ;
 }
@@ -1061,7 +1061,7 @@ vector<vector<double>> MetadataSolver::calculate_CAT_matrix()
     vector<double> outputXYZWhitePoint =
         mulVector( outputRGBtoXYZMtx, deviceWhiteV );
     vector<vector<double>> chadMtx =
-        getCAT( camera_XYZ_white_point, outputXYZWhitePoint );
+        calculate_CAT( camera_XYZ_white_point, outputXYZWhitePoint );
 
     return chadMtx;
 }

src/rawtoaces_util/CMakeLists.txt

@@ -2,12 +2,12 @@ cmake_minimum_required(VERSION 3.12)
 include_directories( "${CMAKE_CURRENT_SOURCE_DIR}" )
 
 set( UTIL_PUBLIC_HEADER
-    ../../include/rawtoaces/acesrender.h
+    ../../include/rawtoaces/image_converter.h
     ../../include/rawtoaces/usage_timer.h
 )
 
 add_library ( ${RAWTOACES_UTIL_LIB} ${DO_SHARED}
-    acesrender.cpp
+    image_converter.cpp
     usage_timer.cpp
 
     # Make the headers visible in IDEs. This should not affect the builds.
@@ -18,10 +18,6 @@ target_link_libraries ( ${RAWTOACES_UTIL_LIB}
     PUBLIC
         ${RAWTOACES_CORE_LIB}
         OpenImageIO::OpenImageIO
-#    INTERFACE
-#        Eigen3::Eigen
-#        Imath::Imath
-#        Imath::ImathConfig
 )
 
 target_compile_definitions( rawtoaces_util PRIVATE RAWTOACES_VERSION="${RAWTOACES_VERSION}" )