MUIPF is a minimalistic software package to perform image processing based on mutual information, written in Python. Currently, only the functionality for sliding two images on top of each other is implemented.
Please note, that this package has been tested for Python 3.X support. It additionally needs Numerical Python (the numpy module).
You can install the script package via the standard 'python setup' mechanism. If you want to install it system-wide into your normal python installation, you simply issue:
python setup.py installwith an appropriate level of permission.
Alternatively, you can install it locally in your home space, e.g.:
python setup.py install --userIf the local python install directory is not in your path, you should add this. For the bash shell you should include in .bashrc:
export PATH=$PATH:/home/user/.local/binIn the root directory, running:
pushd test
python -m unittest -v -b
popdwill validate the source of the package by executing regression tests.
To perform pylint static checking from the top level directory of the project, use:
pylint --rcfile utils/srccheck/pylint/pylintrc-3.ini src/*Consult following resources for the (currently very limited) documentation:
- automatically generated Argparse help page of the corresponding script
MUIPF is licensed under the BSD 2-clause license. See the included LICENSE file for the detailed licensing conditions.