Image Similarity Measures
Python package and commandline tool to evaluate the similarity between two images with eight evaluation metrics:
- Root mean square error (RMSE)
- Peak signal-to-noise ratio (PSNR)
- Structural Similarity Index (SSIM)
- Feature-based similarity index (FSIM)
- Information theoretic-based Statistic Similarity Measure (ISSM)
- Signal to reconstruction error ratio (SRE)
- Spectral angle mapper (SAM)
- Universal image quality index (UIQ)
Installation
Supports Python >=3.8.
pip install image-similarity-measures
Optional: For faster evaluation of the FSIM metric, the pyfftw package is required, install via:
pip install image-similarity-measures[speedups]
Optional: For reading TIFF images with rasterio instead of OpenCV, install:
pip install image-similarity-measures[rasterio]
Usage on commandline
To evaluate the similarity beteween two images, run on the commandline:
image-similarity-measures --org_img_path=a.tif --pred_img_path=b.tif
Note that images that are used for evaluation should be channel last. The results are printed in machine-readable JSON, so you can redirect the output of the command into a file.
Parameters
--org_img_path FILE Path to original input image
--pred_img_path FILE Path to predicted image
--metric METRIC select an evaluation metric (fsim, issm, psnr, rmse,
sam, sre, ssim, uiq, all) (can be repeated)
Usage in Python
from image_similarity_measures.evaluate import evaluation
evaluation(org_img_path="example/lafayette_org.tif",
pred_img_path="example/lafayette_pred.tif",
metrics=["rmse", "psnr"])
from image_similarity_measures.quality_metrics import rmse
rmse(org_img=np.random.rand(3,2,1), pred_img=np.random.rand(3,2,1))
Contribute
Contributions are welcome! Please see README-dev.md for instructions.
Citation
Please use the following for citation purposes of this codebase:
Müller, M. U., Ekhtiari, N., Almeida, R. M., and Rieke, C.: SUPER-RESOLUTION OF MULTISPECTRAL SATELLITE IMAGES USING CONVOLUTIONAL NEURAL NETWORKS, ISPRS Ann. Photogramm. Remote Sens. Spatial Inf. Sci., V-1-2020, 33–40, https://doi.org/10.5194/isprs-annals-V-1-2020-33-2020, 2020.
Metadata
Release files for image-similarity-measures 0.3.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| image_similarity_measures-0.3.6.tar.gz | 8.1 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| image_similarity_measures-0.3.6-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 16.8 kB
Release files / image_similarity_measures-0.3.6.tar.gz
| Download URL | image_similarity_measures-0.3.6.tar.gz |
|---|---|
| Size | 8.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
786e28fdf46c2772b74de06094eff7471fd10e545e06e92e2b1ad43bf9702705
|
|
BLAKE2b-256 checksum How to use checksums |
599e3a0f1469f258b75d7743cd344aee1d7f48426720fb654e03cc1c6778ec0b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.3.2 CPython/3.8.13 Darwin/21.4.0
|
Release files / image_similarity_measures-0.3.6-py3-none-any.whl
| Download URL | image_similarity_measures-0.3.6-py3-none-any.whl |
|---|---|
| Size | 8.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
411665f6db9bc3fb1901fc0ac9911095f507926ef065a82ac7f0e181b775e7c6
|
|
BLAKE2b-256 checksum How to use checksums |
348164e6660bc37f27de2dae606dac5fb126614cc18e5299b0151832f2e5b64b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.3.2 CPython/3.8.13 Darwin/21.4.0
|
Security for image-similarity-measures 0.3.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.