Merge branch 'dev' into dev

Author: lukasbehammer

.github/ISSUE_TEMPLATE/bug_report.md

@@ -37,6 +37,5 @@ Please search on the [issue tracker](https://github.com/3dct/vIQA/issues) before
 ## Your Environment
 <!--- Include as many relevant details about the environment you experienced the bug in -->
 * Version used:
-* Browser Name and version:
-* Operating System and version (desktop or mobile):
+* Operating System and version:
 * Link to your project:

.github/workflows/release.yaml

@@ -8,6 +8,12 @@ on:
     branches:
       - main
       - dev
+  pull_request:
+    branches:
+      - main
+      - dev
+    paths-ignore:
+      - .github/*
 
 jobs:
   changes:
@@ -93,7 +99,12 @@ jobs:
     name: Semantic Release
     runs-on: ubuntu-latest
     needs: [lint]
-    if: github.ref == 'refs/heads/main' && github.repository == '3dct/viqa' && always()
+    if: >-
+      ${{
+        github.ref == 'refs/heads/main' &&
+        github.repository == '3dct/viqa' &&
+        github.event_name != 'pull_request' && !cancelled()
+      }}
     permissions:
       id-token: write
       contents: write
@@ -113,7 +124,7 @@ jobs:
 
       - name: Python Semantic Release
         id: release
-        uses: python-semantic-release/python-semantic-release@v9.12.0
+        uses: python-semantic-release/python-semantic-release@v9.21.0
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           git_committer_name: "github-actions"
@@ -123,10 +134,12 @@ jobs:
     name: Build wheels on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     needs: [changes, semantic_release]
-    if: |
-      (needs.changes.outputs.build-changes == 'true' ||
-      needs.changes.outputs.src-changes == 'true' ||
-      needs.changes.outputs.ci-changes == 'true') && always()
+    if: >-
+      ${{
+        (needs.changes.outputs.build-changes == 'true' ||
+        needs.changes.outputs.src-changes == 'true' ||
+        needs.changes.outputs.ci-changes == 'true') && !cancelled()
+      }}
     strategy:
       fail-fast: false
       matrix:
@@ -154,8 +167,6 @@ jobs:
 
       - name: Build wheels
         uses: pypa/cibuildwheel@v2.19.2
-        env:
-          CIBW_PRERELEASE_PYTHONS: true
         with:
           package-dir: .
           output-dir: wheelhouse
@@ -171,10 +182,12 @@ jobs:
     name: Build source distribution
     runs-on: ubuntu-24.04
     needs: [changes, semantic_release]
-    if: |
-      (needs.changes.outputs.build-changes == 'true' ||
-      needs.changes.outputs.src-changes == 'true' ||
-      needs.changes.outputs.ci-changes == 'true') && always()
+    if: >-
+      ${{
+        (needs.changes.outputs.build-changes == 'true' ||
+        needs.changes.outputs.src-changes == 'true' ||
+        needs.changes.outputs.ci-changes == 'true') && !cancelled()
+      }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -194,9 +207,11 @@ jobs:
   upload_testpypi:
     name: Upload to Test PyPI
     needs: [semantic_release, build_wheels, build_sdist]
-    if: |
-      (github.ref == 'refs/heads/dev' && startsWith(github.ref, 'refs/tags/v')) ||
-      (github.ref == 'refs/heads/main' && needs.semantic_release.outputs.released == 'true')
+    if: >-
+      ${{
+        (github.ref == 'refs/heads/dev' && startsWith(github.ref, 'refs/tags/v')) ||
+        (github.ref == 'refs/heads/main' && needs.semantic_release.outputs.released == 'true')
+      }}
     runs-on: ubuntu-latest
     environment:
       name: testpypi
@@ -238,8 +253,8 @@ jobs:
         with:
           python-version: ${{ vars.MINIMAL_PYTHON_VERSION }}
 
-      - name: Pause for 60 seconds
-        run: sleep 60
+      - name: Pause for 120 seconds
+        run: sleep 120
 
       - name: Test install from Test PyPI
         if: ${{ matrix.os == 'macos-14' || matrix.os == 'ubuntu-24.04' }}
@@ -269,11 +284,14 @@ jobs:
     name: Upload to PyPI
     needs: [semantic_release, build_wheels, build_sdist, upload_testpypi, test_install]
     runs-on: ubuntu-latest
-    if: |
-      needs.semantic_release.outputs.released == 'true' &&
-      needs.semantic_release.outputs.is_prerelease == 'false' &&
-      needs.test_install.outputs.tested == 'true' &&
-      needs.test_install.outputs.tested_windows == 'true'
+    if: >-
+      ${{
+        (github.ref == 'refs/heads/main' && needs.semantic_release.outputs.released == 'true') &&
+        needs.semantic_release.outputs.released == 'true' &&
+        needs.semantic_release.outputs.is_prerelease == 'false' &&
+        needs.test_install.outputs.tested == 'true' &&
+        needs.test_install.outputs.tested_windows == 'true'
+      }}
     environment:
       name: pypi
       url: https://pypi.org/project/vIQA/
@@ -296,11 +314,14 @@ jobs:
     name: Upload to GitHub Releases
     needs: [semantic_release, build_wheels, build_sdist, test_install]
     runs-on: ubuntu-latest
-    if: |
-      needs.semantic_release.outputs.released == 'true' &&
-      needs.semantic_release.outputs.is_prerelease == 'false' &&
-      needs.test_install.outputs.tested == 'true' &&
-      needs.test_install.outputs.tested_windows == 'true'
+    if: >-
+      ${{
+        (github.ref == 'refs/heads/main' && needs.semantic_release.outputs.released == 'true') &&
+        needs.semantic_release.outputs.released == 'true' &&
+        needs.semantic_release.outputs.is_prerelease == 'false' &&
+        needs.test_install.outputs.tested == 'true' &&
+        needs.test_install.outputs.tested_windows == 'true'
+      }}
     permissions:
       id-token: write
       contents: write
@@ -328,24 +349,22 @@ jobs:
             ./dist/*.whl
 
       - name: Publish package distributions to GitHub Releases
-        uses: python-semantic-release/publish-action@v9.12.0
+        uses: python-semantic-release/publish-action@v9.21.0
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
 
   prepare_publish_input:
     name: Check if published
     runs-on: ubuntu-latest
-    if: |
-      (needs.changes.outputs.doc-changes == 'true' ||
-      needs.changes.outputs.docker-changes == 'true') && always()
+    if: ${{ !cancelled() }}
     outputs:
       docs_publish: ${{ steps.check_docs_publish.outputs.publish }}
       image_publish: ${{ steps.check_image_publish.outputs.publish }}
     needs: [changes, upload_github, upload_pypi]
     steps:
       - name: Check if documentation should be published
         id: check_docs_publish
-        if: needs.changes.outputs.doc-changes == 'true'
+        if: ${{ needs.changes.outputs.doc-changes == 'true' }}
         run: |
           # If either the PyPI or GitHub release was successful, publish the docs
           if ${{ needs.upload_github.result == 'success' }} || ${{ needs.upload_pypi.result == 'success' }}; then
@@ -360,10 +379,10 @@ jobs:
           fi
       - name: Check if Docker images should be published
         id: check_image_publish
-        if: needs.changes.outputs.docker-changes == 'true'
+        if: ${{ needs.changes.outputs.docker-changes == 'true' }}
         run: |
           # If either the PyPI or GitHub release was successful, publish the Docker images
-          if ${{ needs.upload_github.result == 'success' }} || ${{ needs.upload_pypi.result == 'success' }}; then
+          if ${{ needs.upload_github.result }} == 'success' || ${{ needs.upload_pypi.result }} == 'success'; then
             echo "publish=true" >> $GITHUB_OUTPUT
           else
             echo "publish=false" >> $GITHUB_OUTPUT
@@ -373,15 +392,15 @@ jobs:
     name: Build and deploy documentation
     uses: ./.github/workflows/documentation.yaml
     needs: [changes, prepare_publish_input]
-    if: github.repository == '3dct/viqa' && needs.changes.outputs.doc-changes == 'true'
+    if: ${{ github.repository == '3dct/viqa' && needs.changes.outputs.doc-changes == 'true' }}
     with:
       publish: ${{ needs.prepare_publish_input.outputs.docs_publish }}
 
   build_and_push_docker_images:
     name: Build and push Docker Images
     uses: ./.github/workflows/build_and_push_docker_images.yaml
     needs: [changes, semantic_release, prepare_publish_input]
-    if: github.repository == '3dct/viqa' && needs.changes.outputs.docker-changes == 'true'
+    if: ${{ github.repository == '3dct/viqa' && needs.changes.outputs.docker-changes == 'true' }}
     with:
       version: ${{ needs.semantic_release.outputs.version }}
       publish: ${{ needs.prepare_publish_input.outputs.image_publish }}

.pre-commit-config.yaml

@@ -2,9 +2,9 @@
 # Install pre-commit hooks via
 # pre-commit install
 ci:
-  autofix_prs: false
+  autofix_prs: true
   autoupdate_schedule: 'quarterly'
-  autoupdate_commit_msg: 'chore: pre-commit autoupdate\n\nAutomatically generated by pre-commit.ci'
+  autoupdate_commit_msg: 'chore: pre-commit autoupdate\\n\\nAutomatically generated by pre-commit.ci'
   skip: ['build-docs', 'mypy']
   submodules: true
 repos:

CHANGELOG.md

@@ -2,6 +2,50 @@
 
 
 
+## v2.2.3 (2025-04-10)
+
+### Bug fixes
+
+* fix: fix using Class attribute rois when not using the same roi for all images in BatchMetrics ([`e98b15a`](https://github.com/3dct/vIQA/commit/e98b15a1de544022061c4643a95a84f8c9d5dc3e))
+
+
+## v2.2.2 (2025-04-09)
+
+### Bug fixes
+
+* fix: fix semantic release exclude commit pattern ([`b24070e`](https://github.com/3dct/vIQA/commit/b24070ec67f74d68d0915524d77bfa11a828bcc3))
+
+* fix: fix rois in BatchMetrics.report when exporting images ([`88c8931`](https://github.com/3dct/vIQA/commit/88c89317ae9735685f16953a5b2338e72fe2a74c))
+
+* fix: enable rois in BatchMetrics
+
+closes #11 ([`c2b0ce5`](https://github.com/3dct/vIQA/commit/c2b0ce5102aec6ee9ce9434bfc9d3ea8eabdbc12))
+
+* fix: add check for image dimensions during loading (#15)
+
+* fix: add check for image dimensions during loading
+
+closes #14
+
+* [pre-commit.ci] auto fixes from pre-commit.com hooks
+
+for more information, see https://pre-commit.ci
+
+* refactor: refactor to comply with ruff
+
+* docs(load_data): add Exception to function docstring
+
+---------
+
+Co-authored-by: Lukas Nepelius <p42940@fhooe.at>
+Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
+Co-authored-by: lukasbehammer <lukas.behammer@fh-wels.at> ([`a120ade`](https://github.com/3dct/vIQA/commit/a120adea9a19fa1e19b4f82cbf95232482fa7be4))
+
+### Documentation
+
+* docs: refactor user guide ([`c423f57`](https://github.com/3dct/vIQA/commit/c423f573db92326e4e96f815690ce50866a59a01))
+
+
 ## v2.2.1 (2025-04-02)
 
 ### Bug fixes
@@ -109,12 +153,6 @@ fix csv delimiter sniffing, add support for tsv and txt files during loading of
 
 ## v2.0.0 (2024-10-22)
 
-### Breaking
-
-* refactor!: move utility modules to utils subpackage
-
-BREAKING CHANGE: major refactoring of utility functions ([`d3945b4`](https://github.com/3dct/vIQA/commit/d3945b47b710c471973296c70c93c272cc0f9552))
-
 ### Bug fixes
 
 * fix: convert rgb images to grayscale before binarization ([`f258f96`](https://github.com/3dct/vIQA/commit/f258f96d38efd6acc56fca9f1dcd823987703058))
@@ -169,6 +207,12 @@ update documentation, refactor definition of variable truncate ([`851521b`](http
 
 make sure that an ImageArray is returned via numpy ufunc ([`31524fb`](https://github.com/3dct/vIQA/commit/31524fbff81ff0cf52c9be7dc2e22b116c7dd286))
 
+### Refactoring
+
+* refactor!: move utility modules to utils subpackage
+
+BREAKING CHANGE: major refactoring of utility functions ([`d3945b4`](https://github.com/3dct/vIQA/commit/d3945b47b710c471973296c70c93c272cc0f9552))
+
 
 ## v1.13.0 (2024-09-24)
 
@@ -509,9 +553,8 @@ function writes custom parameters and package version to a .txt file ([`5b8e607`
 
 ## v1.0.0 (2024-08-05)
 
-### Breaking
+### Features
 
 * feat(ImageArray)!: add class for images
 
 subclass of np.ndarray, calculates image statistics ([`40f0d02`](https://github.com/3dct/vIQA/commit/40f0d029ad416747135f79e8716de040335da592))
-

pyproject.toml

@@ -68,7 +68,7 @@ docs = [
     "viqa[tests]",
 ]
 cd = [
-    "python-semantic-release ==9.12.0",
+    "python-semantic-release ==9.21.0",
     "cibuildwheel ==2.19.2",
 ]
 build = [
@@ -254,6 +254,8 @@ changelog_file = "CHANGELOG.md"
 exclude_commit_patterns = [
     ".*\\n\\nAutomatically generated by python-semantic-release",
     "chore: pre-commit autoupdate\n\nAutomatically generated by pre-commit.ci",
+    "chore: pre-commit autoupdate\\n\\nAutomatically generated by pre-commit.ci",
+    "\\[pre-commit\\.ci\\].*",
     "chore(?:\\([^)]*?\\))?: .+",
     "ci(?:\\([^)]*?\\))?: .+",
     "refactor(?:\\([^)]*?\\))?: .+",

requirements/cd.txt

@@ -1,4 +1,4 @@
 # Generated via tools/generate_requirements.py and pre-commit hook.
 # Do not edit this file; modify pyproject.toml instead.
-python-semantic-release ==9.12.0
+python-semantic-release ==9.21.0
 cibuildwheel ==2.19.2

src/viqa/__init__.py

@@ -5,7 +5,7 @@
 It can be used for 2D and 3D images.
 """
 
-__version__ = "2.2.1"
+__version__ = "2.2.3"
 __author__ = "Lukas Behammer"
 __all__ = [
     "FSIM",