Metadata-Version: 2.1
Name: easy-local-features
Version: 0.3.0
Author: eucadar
Author-email: python@eucadar.com
Description-Content-Type: text/markdown
License-File: LICENSE_DISK.txt
License-File: LICENSE_R2D2.txt
License-File: LICENSE_SUPERGLUE.txt

# easy-local-features-baselines

Just some scripts to make things easier for the local features baselines.

# Installation


I suggest using a conda environment to install the requirements. You can create one using the following command.

```bash
conda create -n elf python=3.9 # the python version is not so critical, but I used 3.9.
conda activate elf
```

Now we can insall the requirements using pip.

```bash
pip install -r requirements.txt
pip install .
```

# How to use

```python
from easy_local_features.baseline_deal import DEAL_baseline
# from easy_local_features.baseline_dalf import DALF_baseline
# from easy_local_features.baseline_disk import DISK_baseline
# from easy_local_features.baseline_r2d2 import R2D2_baseline
# from easy_local_features.baseline_superglue import SuperGlue_baseline
# from easy_local_features.baseline_superpoint import SuperPoint_baseline

# Load an image
img = cv2.imread("assets/notredame.png")

# Initialize the extractor
extractor = DEAL_baseline()

# Return keypoints and descriptors just like OpenCV
keypoints, descriptors = extractor.detectAndCompute(img)

```
# TODO

- [x] Add a setup.py to make it a pip package
- [ ] Add a script to download some datasets
- [ ] Add a download script for the pretrained models
- [ ] Add more baselines :)
  - [ ] ASLFeat
  - [x] DELF
  - [ ] LoFTR
  - [ ] DKM
