gmmreg-python

KO | EN

gitlite — search

#hacktoberfest #react #ai #typescript #go #machine-learning #rust #deep-learning #macos #java #windows #cli #kubernetes #ios

(★ 64)

Python implementation of "Robust Point Set Registration Using Gaussian Mixture Models" by Jian & Vemuri, PAMI'11

gmmreg-python Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# gmmreg-python
[![Tests](https://github.com/bing-jian/gmmreg-python/actions/workflows/tests.yml/badge.svg)](https://github.com/bing-jian/gmmreg-python/actions/workflows/tests.yml)
[![coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)](https://github.com/bing-jian/gmmreg-python/blob/master/pytest.ini)

Python implementation of "Robust Point Set Registration Using Gaussian Mixture Models" by Jian &amp; Vemuri, PAMI'11.

Please note that we have another [github repo](https://github.com/bing-jian/gmmreg) that contains C++ implementation and 
more info about this work.

### Build and Test
Run the following steps to download, install and test the gmmreg python package:
  ```Shell
  git clone https://github.com/bing-jian/gmmreg-python.git
  cd gmmreg-python
  pip install -r requirements.txt
  cd src
  python setup.py install --user
  cd ../data
  gmmreg-demo ./fish_partial.ini
  ```
Installing the package also installs the `gmmreg-demo` command (backed by `gmmreg.demo:main`),
so no `cd`/relative-path gymnastics are needed to run it from anywhere once installed.

If the gmmreg package was successfully installed, the last command should give a point set matching result like the image below:
<p align="center"> 
<img src="images/fish_partial_matching.png" width=640> 
</p>

### Config files
Configs can be written as either a classic `.ini` file or a `.yaml`/`.yml` file with the
same `FILES`/`GMMREG_OPT` sections; the format is picked automatically from the file
extension. `data/fish_partial.yaml` is the YAML equivalent of `data/fish_partial.ini`:
  ```Shell
  gmmreg-demo ./fish_partial.yaml
  ```

### Running tests
The C extension has a pytest suite under `tests/`. It requires the `gmmreg` package to be
importable, so install it (an editable install avoids reinstalling after every change):
  ```Shell
  pip install -r requirements-dev.txt
  pip install -e ./src
  pytest
  ```
`pytest` runs with coverage enabled by default (see `pytest.ini`) and fails if coverage
of the `gmmreg` package drops below 100%.

### Linting
CI also runs [ruff](https://docs.astral.sh/ruff/) (config in `pyproject.toml`):
  ```Shell
  pip install -r requirements-dev.txt
  ruff check .
  ```

### Citing

When using this code in a scientific publication, please cite 
```
@article{Jian&Vemuri_pami11,
  author  = {Bing Jian and Baba C. Vemuri},
  title   = {Robust Point Set Registration Using {Gaussian} Mixture Models},
  journal = {IEEE Trans. Pattern Anal. Mach. Intell.},
  year = {2011},
  volume = {33},
  number = {8},
  pages = {1633-1645},
  url = {https://github.com/bing-jian/gmmreg/},
}
```

### Acknowledgement

We thank [Shen-Chi Chen](https://github.com/schen119) for helping the migration to Python 3.

gmmreg-python

gmmreg-python Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

gmmreg-python

gmmreg-python Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README