Fixed open issues

eadf · eadf · commit d7051fdb253d · 2025-03-30T19:51:56.000+02:00
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -1,27 +1,101 @@
-name: Rust
+name: Rust test
 
 on:
   push:
     branches: [ main ]
   pull_request:
     branches: [ main ]
 
-env:
-  CARGO_TERM_COLOR: always
+permissions:
+  contents: read
 
 jobs:
   build:
     strategy:
       matrix:
-        os: [ ubuntu-latest ]
-        rust: [ stable, nightly ]
+        os: [ubuntu-latest]
+        linkage:
+          - dynamic
+        rust: [stable]
     runs-on: ${{ matrix.os }}
 
     steps:
-    - name: Download deps
-      run: sudo apt update && sudo apt install -y clang libclang-dev libopencv-dev
-    - uses: actions/checkout@v3
-    - name: Build
-      run: cargo build --verbose
-    - name: Run tests
-      run: cargo test --verbose
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          toolchain: ${{ matrix.rust }}
+          components: clippy
+
+      - name: Install OpenCV build dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            build-essential cmake git pkg-config \
+            libgtk-3-dev \
+            libavcodec-dev libavformat-dev libswscale-dev \
+            libtbb-dev \
+            clang libclang-dev
+
+      # Clone OpenCV repositories before checking cache
+      - name: Clone OpenCV repositories
+        run: |
+          OPENCV_VERSION=4.11.0
+          git clone --depth 1 --branch $OPENCV_VERSION https://github.com/opencv/opencv.git
+          git clone --depth 1 --branch $OPENCV_VERSION https://github.com/opencv/opencv_contrib.git
+          mkdir -p opencv/build
+
+      # Cache OpenCV build
+      - name: Cache OpenCV build
+        id: opencv-cache
+        uses: actions/cache@v3
+        with:
+          path: |
+            opencv/build
+            /usr/local/include/opencv4
+            /usr/local/lib/libopencv_*
+            /usr/local/lib/pkgconfig/opencv*
+          key: opencv-${{ runner.os }}-${{ hashFiles('opencv/CMakeLists.txt') }}-4.11.0
+
+      # Only build OpenCV if cache miss
+      - name: Build OpenCV from source
+        if: steps.opencv-cache.outputs.cache-hit != 'true'
+        run: |
+          cd opencv/build
+          cmake \
+            -DCMAKE_BUILD_TYPE=RELEASE \
+            -DCMAKE_INSTALL_PREFIX=/usr/local \
+            -DOPENCV_EXTRA_MODULES_PATH=../../opencv_contrib/modules \
+            -DBUILD_opencv_world=ON \
+            -DBUILD_TESTS=OFF \
+            -DBUILD_EXAMPLES=OFF ..
+          make -j$(nproc)
+          sudo make install
+          sudo ldconfig
+
+      # Install from cache if cache hit
+      - name: Install OpenCV from cache
+        if: steps.opencv-cache.outputs.cache-hit == 'true'
+        run: |
+          sudo cp -r /usr/local/include/opencv4 /usr/local/include/ || true
+          sudo cp -r /usr/local/lib/libopencv_* /usr/local/lib/ || true
+          sudo cp -r /usr/local/lib/pkgconfig/opencv* /usr/local/lib/pkgconfig/ || true
+          sudo ldconfig
+
+      - name: Set OpenCV env vars (required by opencv crate)
+        run: |
+          echo "PKG_CONFIG_PATH=/usr/local/lib/pkgconfig" >> $GITHUB_ENV
+          echo "OPENCV_INCLUDE_PATHS=/usr/local/include/opencv4" >> $GITHUB_ENV
+          echo "OPENCV_LINK_LIBS=opencv_world" >> $GITHUB_ENV
+          echo "OPENCV_LINK_PATHS=/usr/local/lib" >> $GITHUB_ENV
+
+      - name: Clippy
+        run: cargo clippy  --all --all-targets --features "clang-runtime"
+
+      - name: Build
+        run: cargo build --verbose --all --all-targets --features "clang-runtime"
+
+      - name: Run tests
+        run: cargo test --verbose --features "clang-runtime"
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ Read more about image alignment with OpenCV [here](https://learnopencv.com/image
 Opencv-rust can be little tricky to install. Follow the instructions from [rust opencv](https://crates.io/crates/opencv)
 
 You will need the "clang-runtime" feature if you <a href="https://github.com/twistedfall/opencv-rust#Troubleshooting">experience problems with your clang environment</a>
-.
+Disclaimer: the library is only built and tested against opencv 4.11.0.
 
 ```bash
 cargo build --release
@@ -50,8 +50,8 @@ The result should be two windows showing the stacked images using two different
 ## API
 ```rust
 let keypoint_match_img:opencv::core::Mat = keypoint_match(
-   // a Vec<PathBuf> containing paths to image files
-   collect_image_files(&PathBuf::from("image_stacking_py/images"))?,
+   // any IntoIter containing paths to image files
+   vec!["1.jpg","2.jpg","3.jpg","4.jpg","5.jpg"],
    KeyPointMatchParameters {
       method: opencv::calib3d::RANSAC,
       ransac_reproj_threshold: 5.0,
@@ -62,8 +62,8 @@ let keypoint_match_img:opencv::core::Mat = keypoint_match(
 Depending on the parameters the `ecc_match()` is much slower, but also more accurate. 
 ```rust
 let ecc_match_img:opencv::core::Mat = ecc_match(
-   // a Vec<PathBuf> containing paths to image files
-   collect_image_files(&PathBuf::from("image_stacking_py/images"))?,
+   // any IntoIter containing paths to image files
+   vec!["1.jpg","2.jpg","3.jpg","4.jpg","5.jpg"],
    EccMatchParameters {
       motion_type: MotionType::Homography,
       max_count: Some(5000),
@@ -75,11 +75,11 @@ let ecc_match_img:opencv::core::Mat = ecc_match(
 
 ## Todo
 
-* Figure out the docs.rs problem
-* Figure out what to do with `.reshape()` in `keypoint_match()`
+* ~~Figure out what to do with `.reshape()` in `keypoint_match()`~~ fixed?
 * ~~Figure out some opencv parameters~~ responsibility sneakily shifted to end user.
-* Complete the `sharpness_tenengrad()` function. Mat not square?
-* Command line options in the example
+* ~~Complete the `sharpness_tenengrad()` function. Mat not square?~~
+* (optionally) Reduce resolution before doing orb/ecc matching,
+* options in the example
 
 ## License
 
diff --git a/examples/main.rs b/examples/main.rs
@@ -2,52 +2,74 @@
 // Copyright (c) 2021,2025 lacklustr@protonmail.com https://github.com/eadf
 
 use libstacker::opencv::{highgui, imgcodecs};
+use libstacker::prelude::*;
 use rayon::prelude::*;
 use std::path;
 
+/// Returns paths to all jpg,jpeg,tif and png files in a single directory (non-recursive)
+pub fn collect_image_files(
+    path: &std::path::Path,
+) -> Result<Vec<std::path::PathBuf>, StackerError> {
+    Ok(std::fs::read_dir(path)?
+        .flatten()
+        .filter_map(|f| f.path().is_file().then(|| f.path()))
+        .filter(|p| p.extension().is_some() && p.extension().unwrap().to_str().is_some())
+        .filter(|p| {
+            let extension = p.extension().unwrap().to_str().unwrap().to_uppercase();
+            extension == "JPG"
+                || extension == "JPEG"
+                || extension == "TIF"
+                || extension == "PNG"
+        })
+        .collect())
+}
+
 /// Run an example aligning images found under "image_stacking_py/images"
 /// The example displays two images, one is aligned with the `keypoint_match()` method,
 /// the other with `ecc_match()`
-fn main() -> Result<(), libstacker::StackerError> {
+fn main() -> Result<(), StackerError> {
     use libstacker::opencv::core::Point;
 
     let v = vec![Point::new(1, 5), Point::new(2, 5), Point::new(3, 5)];
     let _ = v
         .into_iter()
         .collect::<libstacker::opencv::core::Vector<Point>>();
 
-    let files = libstacker::collect_image_files(&path::PathBuf::from("image_stacking_py/images"))?;
+    let files = collect_image_files(&path::PathBuf::from("image_stacking_py/images"))?;
     let now = std::time::Instant::now();
     let mut files = files
         .into_par_iter()
-        .map(move |f| -> Result<_, libstacker::StackerError> {
+        .map(move |f| -> Result<_, StackerError> {
             let img_gray = imgcodecs::imread(f.to_str().unwrap(), imgcodecs::IMREAD_GRAYSCALE)?;
             Ok((
                 f,
-                libstacker::sharpness_modified_laplacian(&img_gray)?,
-                libstacker::sharpness_variance_of_laplacian(&img_gray)?,
-                libstacker::sharpness_tenengrad(&img_gray, 3)?,
-                libstacker::sharpness_normalized_gray_level_variance(&img_gray)?,
+                libstacker::sharpness_modified_laplacian(&img_gray)?, // LAPM = 1
+                libstacker::sharpness_variance_of_laplacian(&img_gray)?, // LAPV = 2
+                libstacker::sharpness_tenengrad(&img_gray, 3)?, // TENG = 3
+                libstacker::sharpness_normalized_gray_level_variance(&img_gray)?,// GLVN = 4
             ))
         })
-        .collect::<Result<Vec<_>, libstacker::StackerError>>()?;
+        .collect::<Result<Vec<_>, StackerError>>()?;
     println!("Calculated sharpness() in {:?}", now.elapsed());
 
-    // sort images by sharpness using LAPM for now
-    files.sort_by_key(|f| ordered_float::OrderedFloat(f.1));
+    // sort images by sharpness using TENG for now
+    files.sort_by_key(|f| ordered_float::OrderedFloat(f.3));
 
+    println!("Files ordered by TENG (low quality first)");
     for f in files.iter() {
         println!(
             "{:?} LAPM:{: >8.5} LAPV:{: >9.5} TENG:{: >8.5} GLVN:{: >9.5}",
             f.0, f.1, f.2, f.3, f.4
         );
     }
-    // only keep the filename and skip the last file (the bad one)
-    let files: Vec<_> = files.into_iter().map(|f| f.0).rev().skip(1).rev().collect();
+    // only keep the filename and skip the first file (the bad one) and reverse the order
+    // keeping the best image first.
+    let files: Vec<_> = files.into_iter().map(|f| f.0).skip(1).rev().collect();
+    //println!("Using these files {:?}", files);
 
     let now = std::time::Instant::now();
-    let keypoint_match_img = libstacker::keypoint_match(
-        files.clone(),
+    let keypoint_match_img = keypoint_match(
+        &files,
         libstacker::KeyPointMatchParameters {
             method: opencv::calib3d::RANSAC,
             ransac_reproj_threshold: 5.0,
@@ -68,8 +90,8 @@ fn main() -> Result<(), libstacker::StackerError> {
     println!("Calculated ecc_match() in {:?}", now.elapsed());
 
     while highgui::wait_key(33)? != 27 {
-        let _ = highgui::imshow("KeyPoint match", &keypoint_match_img)?;
-        let _ = highgui::imshow("ECC match", &ecc_match_img)?;
+        highgui::imshow("KeyPoint match", &keypoint_match_img)?;
+        highgui::imshow("ECC match", &ecc_match_img)?;
     }
     Ok(())
-}
+}
diff --git a/src/lib.rs b/src/lib.rs
