Merge pull request #58 from 3DOM-FBK/egu

Egu

Author: franioli

.flake8

@@ -3,5 +3,6 @@ select = E9,F63,F7,F82
 ignore = E501, E121, E123
 exclude = .git,__pycache__,.ipynb_checkpoints
 per-file-ignores =
+    */__init__.py: F401
     src/deep_image_matching/thirdparty/RoMa/roma/losses/robust_loss.py:E9,F63,F7,F82
-    src/deep_image_matching/thirdparty/DeDoDe/DeDoDe/utils.py:E9,F63,F7,F82
+    src/deep_image_matching/thirdparty/DeDoDe/DeDoDe/utils.py:E9,F63,F7,F82

.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,49 @@
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+on: push
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+      - name: Install pypa/build
+        run: >-
+          python3 -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: python3 -m build
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v3
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/deep-image-matching
+    permissions:
+      id-token: write # IMPORTANT: mandatory for trusted publishing
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v3
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/run_test.yml

@@ -29,6 +29,7 @@ jobs:
           python -m pip install --upgrade pip
           pip install -e .
           pip install pycolmap
+          pip install pytest
       - name: Test with pytest
         run: |
           pytest

.github/workflows/run_test_win.yml

@@ -28,6 +28,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -e .
+          pip install pytest
       - name: Test with pytest
         run: |
           pytest

.gitignore

@@ -11,6 +11,10 @@ sb_*
 config.yaml
 run_casalbagliano.sh
 config/cameras_test.yaml
+sandbox*
+requirements.txt
+belv_*
+egu/
 
 # VScode
 .vscode/
@@ -43,6 +47,7 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
+.pypirc
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

LICENSE.txt LICENSELICENSE.txt renamed to LICENSE

@@ -1,3 +1,5 @@
+# LICENSE
+
 BSD 3-Clause License
 
 Copyright (c) 2018, the respective contributors, as shown by the AUTHORS file.

README.md

@@ -2,7 +2,7 @@
 
  [![Static Badge](https://img.shields.io/badge/Matches_for-COLMAP-red)](https://github.com/colmap/colmap) [![Static Badge](https://img.shields.io/badge/Matches_for-OpenMVG-red)](https://github.com/openMVG/openMVG) [![Static Badge](https://img.shields.io/badge/Matches_for-MICMAC-red)](https://github.com/micmacIGN/micmac) ![Static Badge](https://img.shields.io/badge/Matches_for-Metashape-red) 
 
- [![Static Badge](https://img.shields.io/badge/Powered_by-Kornia-green)](https://github.com/kornia/kornia) [![Static Badge](https://img.shields.io/badge/Powered_by-hloc-green)](https://github.com/kornia/kornia) [![GitHub Release](https://img.shields.io/github/v/release/3DOM-FBK/deep-image-matching)](https://github.com/3DOM-FBK/deep-image-matching/releases) [![Static Badge](https://img.shields.io/badge/docs-DeepImageMatching-blue
+ [![Static Badge](https://img.shields.io/badge/Powered_by-Kornia-green)](https://github.com/kornia/kornia) [![Static Badge](https://img.shields.io/badge/Powered_by-hloc-green)](https://github.com/kornia/kornia) [![GitHub Release](https://img.shields.io/github/v/release/3DOM-FBK/deep-image-matching)](https://github.com/3DOM-FBK/deep-image-matching/releases) [![Static Badge](https://img.shields.io/badge/docs-DeepImageMatcher-blue
  )](https://3dom-fbk.github.io/deep-image-matching/)
 
 </div>
@@ -68,27 +68,40 @@ DIM can also be utilized as a library instead of being executed through the Comm
 
 For installing deep-image-matching, first create a conda environment:
 
-```
+```bash
 conda create -n deep-image-matching python=3.9
 conda activate deep-image-matching
 pip install --upgrade pip
 ```
 
-Clone the repository and install deep-image-matching in editable mode:
+Then, you can install deep-image-matching using pip with the following command:
 
+```bash
+pip install deep-image-matching
 ```
+
+If there is any issue with the installation, you can also install the package from the source code.
+Clone the repository and install deep-image-matching in editable mode:
+
+```bash
 git clone https://github.com/3DOM-FBK/deep-image-matching.git
 cd deep-image-matching
 pip install -e .
 ```
 
-Install pycolmap (optional):
+Install pycolmap (optional, but recommended):
 
-```
+```bash
 pip install pycolmap==0.6.1
 ```
 Pycolmap is optional to run reconstruction directly in DIM. If pycolmap is not available, matches will be written both in a h5 and colmap database for later processing with COLMAP GUI or API, or other processing.
 
+Try to run the tests to check if deep-image-matching is correctly installed, try to import the package in a Python shell:
+
+```python
+import deep_image_matching as dim
+```
+
 For more information, check the [documentation](https://3dom-fbk.github.io/deep-image-matching/installation/).
 
 ## Docker Installation

assets/example_cyprus/cameras.yaml

@@ -0,0 +1,12 @@
+general:
+  camera_model: "pinhole" # ["simple-pinhole", "pinhole", "simple-radial", "opencv"]
+  openmvg_camera_model: "pinhole_radial_k3" # ["pinhole", "pinhole_radial_k3", "pinhole_brown_t2"]
+  single_camera: True
+
+cam0:
+  camera_model: "pinhole"
+  images : ""
+
+cam1:
+  camera_model: "pinhole"
+  images : "DSC_6468.jpg,DSC_6468.jpg"

assets/example_cyprus/config_roma.yaml

@@ -0,0 +1,22 @@
+# User configuration file
+
+general:
+  # tile_size: (3000, 2000) # This setting is overwriten by the the upsample_res setting
+  tile_overlap: 50
+  geom_verification: none
+  gv_threshold: 3
+  gv_confidence: 0.9999
+  min_matches_per_tile: 3
+  min_inliers_per_pair: 5
+  min_inlier_ratio_per_pair: 0.2
+  refine_intrinsics: False
+  preselection_pipeline: roma
+
+extractor:
+  name: no_extractor
+
+matcher:
+  name: roma
+  coarse_res: 560
+  upsample_res: 860
+  num_sampled_points: 10000

assets/example_cyprus/config_superpoint+lightglue.yaml

@@ -0,0 +1,24 @@
+# User configuration file
+
+general:
+  tile_size: (2400, 2000)
+  geom_verification: PYDEGENSAC # NONE, PYDEGENSAC, MAGSAC, RANSAC, LMEDS, RHO, USAC_DEFAULT, USAC_PARALLEL, USAC_FM_8PTS, USAC_FAST, USAC_ACCURATE, USAC_PROSAC, USAC_MAGSAC
+  gv_threshold: 4
+  min_inliers_per_pair: 10
+  min_inlier_ratio_per_pair: 0.25
+
+extractor:
+  name: "superpoint"
+  max_keypoints: 8000 # -1 no limits
+  nms_radius: 4
+  keypoint_threshold: 0.005
+  remove_borders: 4
+  fix_sampling: False
+
+matcher:
+  name: "lightglue"
+  flash: True # enable FlashAttention if available
+  mp: False # enable mixed precision
+  depth_confidence: 0.95 # early stopping, disable with -1
+  width_confidence: 0.99 # point pruning, disable with -1
+  filter_threshold: 0.10 # match threshold