Stereo & Incremental DIC

.github/workflows/lint.yml

@@ -24,6 +24,7 @@ jobs:
           sudo apt update
           sudo apt install libegl1
           sudo apt install libgl1 libxext6 libx11-6
+          sudo apt install libtiff-dev libtiff-tools
           python -m pip install --upgrade pip
           pip install pylint
           pip install -e .

.github/workflows/tests.yml

@@ -12,13 +12,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-14, macos-15-intel, macos-26]
+        os: [ubuntu-latest, windows-latest, macos-14, macos-26]
         env-type: [pip]
         include:
           - os: macos-14
             llvm: llvm@15
-          - os: macos-15-intel
-            llvm: llvm@18
           - os: macos-26
             llvm: llvm@20
     steps:
@@ -54,8 +52,10 @@ jobs:
 
       - name: Install libtiff (Windows)
         if: startsWith(matrix.os, 'windows')
+        shell: pwsh
         run: |
-          vcpkg install tiff
+          vcpkg install tiff:x64-windows-static
+          echo "CMAKE_ARGS=-DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows-static" >> $env:GITHUB_ENV
 
       - name: Install libtiff (Ubuntu)
         if: startsWith(matrix.os, 'ubuntu')

.github/workflows/wheels.yml

@@ -15,14 +15,11 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, ubuntu-24.04-arm, windows-latest, macos-14, macos-15-intel, macos-26]
+        os: [ubuntu-latest, ubuntu-24.04-arm, windows-latest, macos-14, macos-26]
         include:
           - os: macos-14
             llvm: llvm@15
             macos_deployment_target: "14.0"
-          - os: macos-15-intel
-            llvm: llvm@18
-            macos_deployment_target: "15.0"
           - os: macos-26
             llvm: llvm@20
             macos_deployment_target: "26.0"

.github/workflows/wheels_testpypi.yml

@@ -9,14 +9,12 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, ubuntu-24.04-arm, windows-latest, macos-14, macos-15-intel, macos-latest]
+        os: [ubuntu-latest, ubuntu-24.04-arm, windows-latest, macos-14, macos-26]
         include:
         - os: macos-14
           llvm: llvm@15
-        - os: macos-15-intel
-          llvm: llvm@18
-        - os: macos-15-latest
-          llvm: llvm@18
+        - os: macos-26
+          llvm: llvm@20
     steps:
       - uses: actions/checkout@v4
 

CMakeLists.txt

@@ -5,8 +5,9 @@ project(${SKBUILD_PROJECT_NAME} LANGUAGES CXX)
 # ----------------------------
 # C++ standard
 # ----------------------------
-set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 # ----------------------------
 # Ensure CMAKE_BUILD_TYPE and install config
@@ -24,7 +25,11 @@ message(STATUS "CMake install config name: ${CMAKE_INSTALL_CONFIG_NAME}")
 # ----------------------------
 find_package(pybind11 REQUIRED)
 find_package(OpenMP REQUIRED)
-
+#find_package(OpenCV REQUIRED)
+find_package(TIFF REQUIRED)
+message(STATUS "TIFF_FOUND = ${TIFF_FOUND}")
+message(STATUS "TIFF_INCLUDE_DIR = ${TIFF_INCLUDE_DIR}")
+message(STATUS "TIFF_LIBRARIES = ${TIFF_LIBRARIES}")
 # ----------------------------
 # Eigen3
 # ----------------------------
@@ -61,7 +66,7 @@ endif()
 function(apply_compile_flags target_name)
     if(MSVC)
         # Windows (MSVC)
-        target_compile_options(${target_name} PRIVATE /std:c++17 /openmp)
+        target_compile_options(${target_name} PRIVATE /openmp)
         if(CMAKE_BUILD_TYPE STREQUAL "Debug")
             message(STATUS "Applying MSVC debug flags for ${target_name}")
             target_compile_options(${target_name} PRIVATE /Od /Zi)
@@ -71,7 +76,7 @@ function(apply_compile_flags target_name)
         endif()
     else()
         # Linux / macOS
-        target_compile_options(${target_name} PRIVATE -std=c++17 -fopenmp)
+        target_compile_options(${target_name} PRIVATE -fopenmp)
         if(CMAKE_BUILD_TYPE STREQUAL "Debug")
             message(STATUS "Applying debug flags for ${target_name}")
             target_compile_options(${target_name} PRIVATE -O0 -g)
@@ -90,8 +95,8 @@ endfunction()
 file(GLOB COMMON_SRC_FILES src/pyvale/common_cpp/*.cpp)
 
 pybind11_add_module(common_cpp MODULE ${COMMON_SRC_FILES})
-target_include_directories(common_cpp PRIVATE src/pyvale/common_cpp)
-target_link_libraries(common_cpp PRIVATE OpenMP::OpenMP_CXX Eigen3::Eigen)
+target_include_directories(common_cpp PRIVATE src/pyvale/common_cpp ${TIFF_INCLUDE_DIR})
+target_link_libraries(common_cpp PRIVATE OpenMP::OpenMP_CXX Eigen3::Eigen ${TIFF_LIBRARIES})
 apply_compile_flags(common_cpp)
 install(TARGETS common_cpp LIBRARY DESTINATION pyvale/common_cpp)
 
@@ -100,20 +105,20 @@ install(TARGETS common_cpp LIBRARY DESTINATION pyvale/common_cpp)
 # ----------------------------
 file(GLOB DIC_SRC_FILES src/pyvale/dic/cpp/*.cpp)
 
-pybind11_add_module(dic2dcpp MODULE ${DIC_SRC_FILES} ${COMMON_SRC_FILES})
-target_include_directories(dic2dcpp PRIVATE src/pyvale/common_cpp src/pyvale/dic)
-target_link_libraries(dic2dcpp PRIVATE OpenMP::OpenMP_CXX Eigen3::Eigen)
-apply_compile_flags(dic2dcpp)
-install(TARGETS dic2dcpp LIBRARY DESTINATION pyvale/dic)
+pybind11_add_module(diccpp MODULE ${DIC_SRC_FILES} ${COMMON_SRC_FILES})
+target_include_directories(diccpp PRIVATE src/pyvale/common_cpp src/pyvale/dic ${TIFF_INCLUDE_DIR})
+target_link_libraries(diccpp PRIVATE OpenMP::OpenMP_CXX Eigen3::Eigen ${TIFF_LIBRARIES})
+apply_compile_flags(diccpp)
+install(TARGETS diccpp LIBRARY DESTINATION pyvale/dic)
 
 # ----------------------------
 # DIC Calibration
 # ----------------------------
 file(GLOB CALIB_SRC_FILES src/pyvale/calib/cpp/*.cpp)
 
 pybind11_add_module(calibcpp MODULE ${CALIB_SRC_FILES} ${COMMON_SRC_FILES})
-target_include_directories(calibcpp PRIVATE src/pyvale/common_cpp src/pyvale/calib)
-target_link_libraries(calibcpp PRIVATE OpenMP::OpenMP_CXX Eigen3::Eigen)
+target_include_directories(calibcpp PRIVATE src/pyvale/common_cpp src/pyvale/calib ${TIFF_INCLUDE_DIR})
+target_link_libraries(calibcpp PRIVATE OpenMP::OpenMP_CXX Eigen3::Eigen ${TIFF_LIBRARIES})
 apply_compile_flags(calibcpp)
 install(TARGETS calibcpp LIBRARY DESTINATION pyvale/calib)
 
@@ -123,8 +128,8 @@ install(TARGETS calibcpp LIBRARY DESTINATION pyvale/calib)
 file(GLOB STRAIN_SRC_FILES src/pyvale/strain/cpp/*.cpp)
 
 pybind11_add_module(strain_cpp MODULE ${STRAIN_SRC_FILES} ${COMMON_SRC_FILES})
-target_include_directories(strain_cpp PRIVATE src/pyvale/common_cpp src/pyvale/strain)
-target_link_libraries(strain_cpp PRIVATE OpenMP::OpenMP_CXX Eigen3::Eigen)
+target_include_directories(strain_cpp PRIVATE src/pyvale/common_cpp src/pyvale/strain ${TIFF_INCLUDE_DIR})
+target_link_libraries(strain_cpp PRIVATE OpenMP::OpenMP_CXX Eigen3::Eigen ${TIFF_LIBRARIES}) 
 apply_compile_flags(strain_cpp)
 install(TARGETS strain_cpp LIBRARY DESTINATION pyvale/strain)
 

README.md

@@ -5,8 +5,57 @@ The python validation engine (`pyvale`) is your virtual engineering laboratory:
 
 We are actively developing dedicated tools for simulation and uncertainty quantification of imaging sensors including digital image correlation (DIC) and infra-red thermography (IRT). Check out the [documentation](https://computer-aided-validation-laboratory.github.io/pyvale/index.html) to get started with some of our examples.
 
+## Quick Install
+We recommend installing `pyvale` into a virtual environment of your choice as `pyvale` requires python 3.13. If you need help setting up your virtual environment and installing `pyvale` head over to the [installation guide](https://computer-aided-validation-laboratory.github.io/pyvale/install/install.html) in our docs.
+
+`pyvale` can be installed from pypi:
+```shell
+pip install pyvale
+```
+
+## Quick Demo: Digital Image Correlation
+Below is a really quick example for setting up a DIC calculation. It's highly likely that your case will require a more tailored calculation configuration.  
+
+**For further details please see the DIC [examples](https://computer-aided-validation-laboratory.github.io/pyvale/examples/examples_dic.html), [theory guide](https://computer-aided-validation-laboratory.github.io/pyvale/guide_theory/guide_theory_dic.html),  [user guide](https://computer-aided-validation-laboratory.github.io/pyvale/guide_user/guide_dic.html)  and [API](https://computer-aided-validation-laboratory.github.io/pyvale/pyvale.dic.html).**
+
+Define the Region of Interest (ROI):
+
+```python
+import pyvale.dic as dic
+
+roi = dic.RegionOfInterest(ref_image="image0000.tiff")
+roi.interactive_selection()
+```
+run the DIC:
+
+```python
+# use dic.calculate_3d for stereo
+dic.calculate_2d(reference="image0000.tiff",
+                 deformed="image*.tiff",
+                 roi_mask=roi.mask, # built using ROI tool
+                 seed=roi.seed, # built using ROI tool
+                 subset_size=21,
+                 subset_step=10)
+```
+Import the results for any analysis/plotting:
+
+```python
+dicdata = dic.import_2d(data="dic_results*.csv", # default result files prefix
+                        delimiter=",")
+
+
+import matplotlib.pyplot as plt
+plt.pcolor(dicdata.ss_x, 
+           dicdata.ss_y, 
+           dicdata.u_px[0]) # horizontal displacement for 0th image
+plt.show()
+```
+
+
+
+
 ## Quick Demo: Simulating Point Sensors
-Here we demonstrate how `pyvale` can be used to simulate thermocouples and strain gauges applied to a [MOOSE](https://mooseframework.inl.gov/index.html) thermo-mechanical simulation of a fusion divertor armour heatsink. The figures below show visualisations of the virtual thermocouple and strain gauge locations on the simualtion mesh as well as time traces for each sensor over a series of simulated experiments.
+`/pyvale` can be used to simulate thermocouples and strain gauges applied to a [MOOSE](https://mooseframework.inl.gov/index.html) thermo-mechanical simulation of a fusion divertor armour heatsink. The figures below show visualisations of the virtual thermocouple and strain gauge locations on the simualtion mesh as well as time traces for each sensor over a series of simulated experiments.
 
 The code to run the simulated experiments and produce the output shown here comes from [this example](https://computer-aided-validation-laboratory.github.io/pyvale/examples/basicsensorsim/ex0_quickstart.html). You can find more examples and details of `pyvale` python API in the `pyvale` [documentation](https://computer-aided-validation-laboratory.github.io/pyvale/index.html).
 
@@ -18,15 +67,6 @@ The code to run the simulated experiments and produce the output shown here come
 |--|--|
 |*Thermocouple time traces over a series of simulated experiments.*|*Strain gauge time traces over a series of simulated experiments.*|
 
-
-## Quick Install
-`pyvale` can be installed from pypi:
-```shell
-pip install pyvale
-```
-
-We recommend installing `pyvale` into a virtual environment of your choice as `pyvale` requires python 3.13. If you need help setting up your virtual environment and installing `pyvale` head over to the [installation guide](https://computer-aided-validation-laboratory.github.io/pyvale/install/install.html) in our docs.
-
 ## Contributors
 The Computer Aided Validation Team at UKAEA:
 - Lloyd Fletcher ([ScepticalRabbit](https://github.com/ScepticalRabbit)), UK Atomic Energy Authority

docs/source/_static/cal_target_flipped.png

@@ -0,0 +1 @@
+../../../images/cal_target_flipped.png

docs/source/_static/dic_ex10_3d.png

@@ -0,0 +1 @@
+../../../images/dic_ex10_3d.png

docs/source/_static/dic_ex11_3d.png

@@ -0,0 +1 @@
+../../../images/dic_ex11_3d.png

docs/source/_static/dic_ex11_roi.png

@@ -0,0 +1 @@
+../../../images/dic_ex11_roi.png

docs/source/_static/incremental_dark.png

@@ -0,0 +1 @@
+../../../images/incremental_dark.png

docs/source/_static/incremental_light.png

@@ -0,0 +1 @@
+../../../images/incremental_light.png

docs/source/api_py.rst

@@ -9,6 +9,7 @@ Detailed Python API
 
    pyvale.sensorsim
    pyvale.blender
+   pyvale.calib
    pyvale.dic
    pyvale.strain
    pyvale.mooseherder

docs/source/examples/examples_dic.rst

@@ -6,10 +6,15 @@ DIC & Strain Calculations
 .. toctree::
    :maxdepth: 1
 
-   dic/ex1_region_of_interest.rst
-   dic/ex2_plate_with_hole.rst
-   dic/ex3_plate_with_hole_strain.rst
-   dic/ex4_dic_blender.rst
-   dic/ex5_dic_challenge.rst
-   dic/ex6_hrdic.rst
+   dic/ex01_region_of_interest.rst
+   dic/ex02_plate_with_hole.rst
+   dic/ex03_plate_with_hole_strain.rst
+   dic/ex04_dic_blender.rst
+   dic/ex05_dic_challenge.rst
+   dic/ex06_hrdic.rst
+   dic/ex07_incremental.rst
+   dic/ex08_calibration.rst
+   dic/ex09_stereo.rst
+   dic/ex10_stereo_platehole.rst
+   dic/ex11_dic_chal.rst
 

docs/source/guide_theory/guide_theory.rst

@@ -10,5 +10,6 @@ Module user guides
    :maxdepth: 1
 
    guide_theory_dic.rst
+   guide_theory_dic_stereo.rst
 
 

docs/source/guide_theory/guide_theory_dic.rst

@@ -1,6 +1,6 @@
 .. _guide_theory_dic:
 
-DIC Theory Overview
+DIC
 ======================================
 
 Digital Image Correlation (DIC) is a technique for measuring
@@ -147,15 +147,17 @@ further updates would produce only negligible changes in the parameters and the
 cost function.
 
 
-Sub-pixel Accuracy With Interpolation
---------------------------------------
+Interpolation Methods for Sub-pixel Accuracy
+---------------------------------------------
 
 DIC aims for precision beyond the integer values defined by the image's pixel grid. Integer-pixel
 matching is a good start, but physical displacements do not perfectly map to pixel
 boundaries. To capture this, we refine the measurement to *sub-pixel*
-accuracy using interpolation. Instead of treating the image as a discrete
-array, we approximate it as a smooth surface. This is done using **cubic B-spline
-interpolation**.
+accuracy using interpolation. Pyvale supports two interpolation methods selectable via the
+:code:`interpolation_routine` parameter in :code:`calculate_2d()` and :code:`calculate_3d()`:
+
+- **BSPLINE** (default): Cubic B-spline interpolation (described below).
+- **HERMITE**: Hermite cubic interpolation, an alternative method that can be faster for some use cases.
 
 Cubic B-spline Interpolation
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^