Merge pull request #169 from Computer-Aided-Validation-Laboratory/dev

QOL and bugfixes following 2D DIC workshop

Author: JoelPhys

.github/workflows/install_and_lint.yml

@@ -38,7 +38,7 @@ jobs:
       strategy:
         fail-fast: false
         matrix:
-          os: [ubuntu-latest, ubuntu-24.04-arm, windows-latest, macos-13, macos-14]
+          os: [ubuntu-latest, windows-latest, macos-13, macos-14]
 
       steps:
         - uses: actions/checkout@v3
@@ -66,6 +66,14 @@ jobs:
             echo "LDFLAGS=-L$(brew --prefix libomp)/lib" >> $GITHUB_ENV
             echo "CPPFLAGS=-I$(brew --prefix libomp)/include" >> $GITHUB_ENV
 
+        - name: Install dependencies for ubuntu-latest
+          if: matrix.os == 'ubuntu-latest'
+          run: |
+            sudo apt update
+            sudo apt install libegl1
+            sudo apt install libgl1 libxext6 libx11-6
+        
+
         - name: Test package installation
           run: |
             python -m pip install --upgrade pip

docs/source/conf.py

@@ -18,8 +18,8 @@
 project = 'Pyvale'
 copyright = '2025, The CAV Team'
 author = 'The CAV Team at United Kingdom Atomic Energy Authority (UKAEA)'
-release = '2025.5.3'
-version = '2025.5.3'
+release = '2025.7.2'
+version = '2025.7.2'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyvale"
-version = "2025.7.1"
+version = "2025.7.2"
 description = "An all-in-one package for sensor simulation, sensor uncertainty quantification, sensor placement optimisation and simulation calibration or validation."
 authors = [
   { name = "scepticalrabbit et al.", email = "thescepticalrabbit@gmail.com" },

src/pyvale/dataset.py

@@ -397,7 +397,7 @@ def dic_challenge_ref() -> Path:
             Path to the reference image (*.tiff).
         """
         return Path(files("pyvale.data")
-                    .joinpath("DIC_Challenge_Star_Noise_Ref.tif"))
+                    .joinpath("DIC_Challenge_Star_Noise_Ref.tiff"))
 
     @staticmethod
     def dic_challenge_def() -> Path:
@@ -409,7 +409,7 @@ def dic_challenge_def() -> Path:
             Path to the reference image (*.tiff).
         """
         return Path(files("pyvale.data")
-                    .joinpath("DIC_Challenge_Star_Noise_Def.tif"))
+                    .joinpath("DIC_Challenge_Star_Noise_Def.tiff"))
 
 
 

src/pyvale/dic/cpp/CMakeLists.txt

@@ -14,3 +14,5 @@ file(GLOB DIC_SRC_FILES dic*.cpp)
 pybind11_add_module(dic2dcpp MODULE ${DIC_SRC_FILES})
 target_link_libraries(dic2dcpp PRIVATE ${FFTW_LIBRARIES} OpenMP::OpenMP_CXX)
 
+# Add -O3 optimization
+target_compile_options(dic2dcpp PRIVATE -O3)

src/pyvale/dic/cpp/defines.hpp

@@ -1,6 +1,17 @@
+// ================================================================================
+// pyvale: the python validation engine
+// License: MIT
+// Copyright (C) 2025 The Computer Aided Validation Team
+// ================================================================================
+
+// defines.hpp
+#ifndef DEFINES_H
+#define DEFINES_H
+
 #define TITLE(a) std::cout << std::string(80, '-') << std::endl; std::cout << std::string(38 - std::strlen(a)/2, '-') << " " << a << " " << std::string(38 - std::strlen(a)/2, '-') << std::endl; std::cout << std::string(80, '-') << std::endl;
 #define INFO_OUT(a,b) std::cout << "  - " << std::left << std::setw(50) << a << b << std::endl;
 #define DEBUGGER std::cout << __FILE__ << " " << __LINE__ << std::endl;
+
 #ifdef CUDA
         #define CUDA_CALL(x) do { if((x) != cudaSuccess) {\
         printf("Error at %s:%d\n",__FILE__,__LINE__);\
@@ -10,3 +21,19 @@
         printf("Error at %s:%d\n",__FILE__,__LINE__);\
         exit(EXIT_FAILURE);}} while(0)
 #endif
+
+// Use static function approach instead of inline variable
+inline int& get_debug_level() {
+    static int level = 0;
+    return level;
+}
+
+inline int& g_debug_level = get_debug_level();
+#define DEBUG_PROGRESS_BAR(level) \
+    if (g_debug_level >= level)
+#define DEBUG(level) \
+    if (g_debug_level >= level)
+
+#endif // DEFINES_HPP
+
+

src/pyvale/dic/cpp/dicfourier.cpp

@@ -12,11 +12,13 @@
 #include <cmath>
 #include <algorithm>
 #include <omp.h>
+#include <csignal>
 
 // Program Header files
 #include "./defines.hpp"
 #include "./dicutil.hpp"
 #include "./dicfourier.hpp"
+#include "./dicsignalhandler.hpp"
 
 namespace fourier {
 
@@ -134,8 +136,10 @@ namespace fourier {
     }
 
     void mgwd(const std::vector<util::SubsetData> &ssdata, 
-              const double *img_ref, const double *img_def, 
-              const Interpolator &interp_def, const bool fft_mad, 
+              const double *img_ref,
+              const double *img_def,
+              const Interpolator &interp_def,
+              const bool fft_mad, 
               const double fft_mad_scale){
 
         const int px_hori = interp_def.px_hori;
@@ -150,11 +154,21 @@ namespace fourier {
             //util::Timer timer("FFT windowing for subset size: " + std::to_string(ssdata[i].size));
 
             const int ss_size = ssdata[i].size;
+            const int num_ss  = ssdata[i].num;
 
             std::fill(shifts[i].x.begin(), shifts[i].x.end(), 0.0);
             std::fill(shifts[i].y.begin(), shifts[i].y.end(), 0.0);
 
-            #pragma omp parallel
+            indicators::ProgressBar bar;
+            std::atomic<int> current_progress = 0;
+            int prev_pct = 0;
+
+            if (g_debug_level == 1){
+                std::string bar_title = "FFT windowing for size: " + std::to_string(ss_size);
+                util::create_progress_bar(bar, bar_title, ssdata[i].num);
+            }
+
+            #pragma omp parallel shared(stop_request)
             {
 
 
@@ -165,6 +179,11 @@ namespace fourier {
                 #pragma omp for
                 for (int ss = 0; ss < ssdata[i].num; ss++){
 
+                    // exit when ctrl+C
+                    if (stop_request){
+                        continue;
+                    }
+
                     int ss_x = ssdata[i].coords[2*ss];
                     int ss_y = ssdata[i].coords[2*ss+1];
 
@@ -213,6 +232,12 @@ namespace fourier {
                     //util::extract_ss_subpx(fft.ss_def, ss_x+shifts[i].x[ss], ss_y+shifts[i].y[ss], interp_def);
                     //shifts[i].cost[ss] = debugcost(fft.ss_ref,fft.ss_def);
                     shifts[i].max_val[ss] = max_val;
+
+
+                    if (g_debug_level == 1){
+                        int progress = current_progress.fetch_add(1);
+                        if (omp_get_thread_num()==0) util::update_progress_bar(bar, progress, num_ss, prev_pct);
+                    }
                 }
             }
 
@@ -222,7 +247,6 @@ namespace fourier {
                 remove_outliers(shifts[i].y, ssdata[i], fft_mad);
             }
 
-
             //smooth_field(shifts[i].x, ssdata[i], 7.0, 5);
             //smooth_field(shifts[i].y, ssdata[i], 7.0, 5);
 
@@ -233,9 +257,17 @@ namespace fourier {
             //    std::cout << shifts[i].cost[ss] << std::endl;
             //}
             //std::cout << std::endl;
+
+            if (g_debug_level == 1){
+                int progress = current_progress;
+                util::update_progress_bar(bar, progress-1, num_ss, prev_pct);
+                bar.mark_as_completed();
+                indicators::show_console_cursor(true);
+            }
         }
 
 
+
     }
 
 

src/pyvale/dic/cpp/dicinterpolator.cpp

@@ -11,7 +11,9 @@
 
 // Program Header files
 #include "./dicinterpolator.hpp"
-
+#include "./dicutil.hpp"
+#include "defines.hpp"
+#include "./dicsignalhandler.hpp"
 
 
 inline int idx_from_2d(const int x, const int y, const int length){
@@ -49,10 +51,27 @@ Interpolator::Interpolator(double*img, int px_hori, int px_vert){
 
     //interpolator data
     std::vector<double> data(px_hori,0);
+
+
+    indicators::ProgressBar bar;
+    std::atomic<int> current_progress = 0;
+    int prev_pct = 0;
+    int niters = px_vert+px_hori+px_hori;
+
+    if (g_debug_level == 1){
+        std::string bar_title = "Creating Interpolator: ";
+        util::create_progress_bar(bar, bar_title, niters);
+    }
+
 
     //#pragma omp parallel for
     for (int j = 0; j < px_vert; j++){
 
+        // exit if ctrl+C
+        if (stop_request){
+            continue;
+        }
+
         // get 1D data
         for (int i = 0; i < px_hori; i++) {
             data[i] = image[j*px_hori + i];
@@ -62,13 +81,24 @@ Interpolator::Interpolator(double*img, int px_hori, int px_vert){
         for (int i = 0; i < px_hori; i++){
             dx[j*px_hori + i] = cspline_eval_deriv(px_x, data, px_x[i], px_hori);
         }
+
+        // update progress bar if enabled
+        if (g_debug_level == 1){
+            int progress = current_progress.fetch_add(1);
+            util::update_progress_bar(bar, progress, niters, prev_pct);
+        }
     }
 
     data.resize(px_vert,0);
 
     //#pragma omp parallel for
     for (int i = 0; i < px_hori; ++i) {
 
+        // exit if ctrl+C
+        if (stop_request){
+            continue;
+        }
+
         // get 1D data
         for (int j = 0; j < px_vert; j++){
             data[j] = image[j*px_hori + i];
@@ -78,6 +108,12 @@ Interpolator::Interpolator(double*img, int px_hori, int px_vert){
         for (int j = 0; j < px_vert; j++){
             dy[j*px_hori + i] = cspline_eval_deriv(px_y, data, px_y[j], px_vert);
         }
+
+        // update progress bar if enabled
+        if (g_debug_level == 1){
+            int progress = current_progress.fetch_add(1);
+            util::update_progress_bar(bar, progress, niters, prev_pct);
+        }
     }
 
 
@@ -86,6 +122,11 @@ Interpolator::Interpolator(double*img, int px_hori, int px_vert){
     //#pragma omp parallel for
     for (int j = 0; j < px_vert; j++){
 
+        // exit if ctrl+C
+        if (stop_request){
+            continue;
+        }
+
         // get 1D data
         for (int i = 0; i < px_hori; i++) {
             data[i] = dy[j*px_hori + i];
@@ -95,6 +136,20 @@ Interpolator::Interpolator(double*img, int px_hori, int px_vert){
         for (int i = 0; i < px_hori; i++){
             dxy[j*px_hori + i] = cspline_eval_deriv(px_x, data, px_x[i], px_hori);
         }
+
+        // update progress bar if enabled
+        if (g_debug_level == 1){
+            int progress = current_progress.fetch_add(1);
+            util::update_progress_bar(bar, progress, niters, prev_pct);
+        }
+    }
+
+
+    if (g_debug_level == 1){
+        int progress = current_progress;
+        util::update_progress_bar(bar, progress-1, niters, prev_pct);
+        bar.mark_as_completed();
+        indicators::show_console_cursor(true);
     }
 }