Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
franioli committed May 30, 2024
1 parent 0f10dc2 commit 681cbd3
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 24 deletions.
25 changes: 1 addition & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,37 +155,14 @@ The `--dir` parameter defines the processing directory, where all the results wi

The `--pipeline` parameter defines the combaination of local feature extractor and matcher.

For all the usage instructions and configurations, refer to the [documenation](https://3dom-fbk.github.io/deep-image-matching/getting_started) or check the example notebooks.
For all the usage instructions and configurations, refer to the [documenation](https://3dom-fbk.github.io/deep-image-matching/getting_started) or check the demo notebooks.

<!-- To run the GUI, you can use the following command:
```bash
python main.py --gui
``` -->

## Advanced usage

For advanced usage, please refer to the [documentation](https://3dom-fbk.github.io/deep-image-matching/) and/or check the `scripts` directory.

### Merging databases with different local features

To run the matching with different local features and/or matchers and marging together the results, you can use scripts in the `./scripts` directory for merging the COLMAP databases.

```
python ./join_databases.py --help
python ./join_databases.py --input path/to/dir/with/databases --output path/to/output/dir
```

### Exporting the solution to Metashape

To export the solution to Metashape, you can export the COLMAP database to Bundler format and then import it into Metashape.
This can be done from Metashape GUI, by first importing the images and then use the function `Import Cameras` (File -> Import -> Import Cameras) to select Bundler file (e.g., bundler.out) and the image list file (e.g., bundler_list.txt).

Alternatevely, you can use the `export_to_metashape.py` script to automatically create a Metashape project from a reconstruction saved in Bundler format.
The script `export_to_metashape.py` takes as input the solution in Bundler format and the images and it exports the solution to Metashape.
It requires to install Metashape as a Python module in your environment and to have a valid license.
Please, refer to the instructions at [https://github.com/franioli/metashape](https://github.com/franioli/metashape).

## How to contribute

Any contribution to this repo is really welcome!
Expand Down
9 changes: 9 additions & 0 deletions docs/scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ Please note that the following scripts are not part of the main pipeline and are

Documentation for the scripts is in progress. If you have any questions, please open an issue.

### Merging databases with different local features

To run the matching with different local features and/or matchers and marging together the results, you can use scripts in the `./scripts` directory for merging the COLMAP databases.

```
python ./join_databases.py --help
python ./join_databases.py --input path/to/dir/with/databases --output path/to/output/dir
```

## Check Matches

To visualize the geometrically verified matches, you have two options:
Expand Down
2 changes: 2 additions & 0 deletions tests/test_pipelines.py
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,8 @@ def test_keynet(data_dir):


def test_dedode_nn(data_dir):
if not torch.cuda.is_available():
pytest.skip("DeDoDe is not available without CUDA GPU.")
prm = {
"dir": data_dir,
"pipeline": "dedode+kornia_matcher",
Expand Down

0 comments on commit 681cbd3

Please sign in to comment.