update: rename common -> ui

.github/workflows/format.yml

@@ -19,6 +19,6 @@ jobs:
           cache: 'pip'
       - run: python -m pip install --upgrade pip
       - run: python -m pip install .[dev]
-      - run: python -m flake8 common/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py 
-      - run: python -m isort common/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py --check-only --diff
-      - run: python -m black common/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py --check --diff
+      - run: python -m flake8 ui/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py 
+      - run: python -m isort ui/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py --check-only --diff
+      - run: python -m black ui/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py --check --diff

.gitignore

@@ -24,3 +24,4 @@ experiments*
 gen_example.py
 datasets/lines/terrace0.JPG
 datasets/lines/terrace1.JPG
+datasets/South-Building*

README.md

@@ -112,7 +112,7 @@ then open http://localhost:7860 in your browser.
 
 ### Add your own feature / matcher
 
-I provide an example to add local feature in [hloc/extractors/example.py](hloc/extractors/example.py). Then add feature settings in `confs` in file [hloc/extract_features.py](hloc/extract_features.py). Last step is adding some settings to `model_zoo` in file [common/config.yaml](common/config.yaml).
+I provide an example to add local feature in [hloc/extractors/example.py](hloc/extractors/example.py). Then add feature settings in `confs` in file [hloc/extract_features.py](hloc/extract_features.py). Last step is adding some settings to `model_zoo` in file [ui/config.yaml](ui/config.yaml).
 
 ## Contributions welcome!
 

app.py

@@ -1,6 +1,6 @@
 import argparse
 from pathlib import Path
-from common.app_class import ImageMatchingApp
+from ui.app_class import ImageMatchingApp
 
 if __name__ == "__main__":
     parser = argparse.ArgumentParser()
@@ -19,7 +19,7 @@ if __name__ == "__main__":
     parser.add_argument(
         "--config",
         type=str,
-        default=Path(__file__).parent / "common/config.yaml",
+        default=Path(__file__).parent / "ui/config.yaml",
         help="config file",
     )
     args = parser.parse_args()

format.sh

@@ -1,3 +1,3 @@
-python -m flake8 common/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py 
-python -m isort common/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py
-python -m black common/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py
+python -m flake8 ui/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py 
+python -m isort ui/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py
+python -m black ui/*.py hloc/*.py hloc/matchers/*.py hloc/extractors/*.py

pyproject.toml

@@ -20,10 +20,10 @@ dynamic = ["dependencies"]
 dev = ["black", "flake8", "isort"]
 
 [tool.setuptools.packages.find]
-include = ["hloc*",  "common",]
+include = ["hloc*",  "ui",]
 
 [tool.setuptools.package-data]
-common = ["*.yaml"]
+ui = ["*.yaml"]
 
 [tool.setuptools.dynamic]
 dependencies = {file = ["requirements.txt"]}

test_app_cli.py

@@ -3,13 +3,13 @@ import warnings
 import numpy as np
 from pathlib import Path
 from hloc import logger
-from common.utils import (
+from ui.utils import (
     get_matcher_zoo,
     load_config,
     DEVICE,
     ROOT,
 )
-from common.api import ImageMatchingAPI
+from ui.api import ImageMatchingAPI
 
 
 def test_all(config: dict = None):
@@ -109,6 +109,6 @@ def test_one():
 
 
 if __name__ == "__main__":
-    config = load_config(ROOT / "common/config.yaml")
+    config = load_config(ROOT / "ui/config.yaml")
     test_one()
     test_all(config)

{common → ui}/api.py

@@ -289,5 +289,5 @@ class ImageMatchingAPI(torch.nn.Module):
 
 
 if __name__ == "__main__":
-    config = load_config(ROOT / "common/config.yaml")
+    config = load_config(ROOT / "ui/config.yaml")
     api = ImageMatchingAPI(config)

{common → ui}/app_class.py

@@ -6,8 +6,8 @@ import numpy as np
 from easydict import EasyDict as edict
 from omegaconf import OmegaConf
 
-from common.sfm import SfmEngine
-from common.utils import (
+from ui.sfm import SfmEngine
+from ui.utils import (
     GRADIO_VERSION,
     gen_examples,
     generate_warp_images,
@@ -388,7 +388,7 @@ class ImageMatchingApp:
                         "outputs": "experiments/sfm",
                     }
                 )
-                # sfm_ui.call()
+                sfm_ui.call_empty()
 
     def run(self):
         self.app.queue().launch(
@@ -552,12 +552,17 @@ class AppBaseUI:
     def __init__(self, cfg: Dict[str, Any] = {}):
         self.cfg = OmegaConf.create(cfg)
         self.inputs = edict({})
+        self.outputs = edict({})
+        self.ui = edict({})
 
     def _init_ui(self):
         NotImplemented
 
     def call(self, **kwargs):
-        self._init_ui()
+        NotImplemented
+
+    def info(self):
+        gr.Info("SFM is under construction.")
 
 
 class AppSfmUI(AppBaseUI):
@@ -566,6 +571,7 @@ class AppSfmUI(AppBaseUI):
         assert "matcher_zoo" in self.cfg
         self.matcher_zoo = self.cfg["matcher_zoo"]
         self.sfm_engine = SfmEngine(cfg)
+        self._init_ui()
 
     def init_retrieval_dropdown(self):
         algos = []
@@ -756,36 +762,40 @@ class AppSfmUI(AppBaseUI):
                         gr.Textbox(
                             label="Retriangluation Details",
                         )
-                    button_sfm = gr.Button("Run SFM", variant="primary")
-                model_3d = gr.Model3D(
+                    self.ui.button_sfm = gr.Button("Run SFM", variant="primary")
+                self.outputs.model_3d = gr.Model3D(
                     interactive=True,
                 )
-                output_image = gr.Image(
+                self.outputs.output_image = gr.Image(
                     label="SFM Visualize",
                     type="numpy",
                     image_mode="RGB",
                     interactive=False,
                 )
 
-                button_sfm.click(
-                    fn=self.sfm_engine.call,
-                    inputs=[
-                        self.inputs.matcher_key,
-                        self.inputs.input_images,  # images
-                        self.inputs.camera_model,
-                        self.inputs.camera_params,
-                        self.inputs.max_keypoints,
-                        self.inputs.keypoint_threshold,
-                        self.inputs.match_threshold,
-                        self.inputs.ransac_threshold,
-                        self.inputs.ransac_confidence,
-                        self.inputs.ransac_max_iter,
-                        self.inputs.scene_graph,
-                        self.inputs.global_feature,
-                        self.inputs.top_k,
-                        self.inputs.mapper_refine_focal_length,
-                        self.inputs.mapper_refine_principle_points,
-                        self.inputs.mapper_refine_extra_params,
-                    ],
-                    outputs=[model_3d, output_image],
-                )
+    def call_empty(self):
+        self.ui.button_sfm.click(fn=self.info, inputs=[], outputs=[])
+
+    def call(self):
+        self.ui.button_sfm.click(
+            fn=self.sfm_engine.call,
+            inputs=[
+                self.inputs.matcher_key,
+                self.inputs.input_images,  # images
+                self.inputs.camera_model,
+                self.inputs.camera_params,
+                self.inputs.max_keypoints,
+                self.inputs.keypoint_threshold,
+                self.inputs.match_threshold,
+                self.inputs.ransac_threshold,
+                self.inputs.ransac_confidence,
+                self.inputs.ransac_max_iter,
+                self.inputs.scene_graph,
+                self.inputs.global_feature,
+                self.inputs.top_k,
+                self.inputs.mapper_refine_focal_length,
+                self.inputs.mapper_refine_principle_points,
+                self.inputs.mapper_refine_extra_params,
+            ],
+            outputs=[self.outputs.model_3d, self.outputs.output_image],
+        )