{ "info": { "author": "khrynczenko", "author_email": "jeniopy@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Scientific/Engineering" ], "description": "# compimg\n![PyPI](https://img.shields.io/pypi/v/compimg.svg)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/compimg.svg)\n![PyPI - Wheel](https://img.shields.io/pypi/wheel/compimg.svg)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![Documentation Status](https://readthedocs.org/projects/compimg/badge/?version=stable)](https://compimg.readthedocs.io/en/stable/?badge=stable)\n\nBranches: \nmaster: [![CircleCI](https://circleci.com/gh/khrynczenko/compimg/tree/master.svg?style=svg)](https://circleci.com/gh/khrynczenko/compimg/tree/master) \ndevelop: [![CircleCI](https://circleci.com/gh/khrynczenko/compimg/tree/develop.svg?style=svg)](https://circleci.com/gh/khrynczenko/compimg/tree/develop)\n\n\n## Introduction\n**_For full documentation visit [documentation site](https://compimg.readthedocs.io)._** \n\nImage similarity metrics are often used in image quality assessment for performance\nevaluation of image restoration and reconstruction algorithms. They require two images:\n- test image (image of interest)\n- reference image (image we compare against) \n\nSuch metrics produce numerical values.\n\nSuch methods are are widely called full/reduced-reference methods for \nassessing image quality.\n\n`compimg` package is all about calculating similarity between images. \nIt provides image similarity metrics (PSNR, SSIM etc.) that are widely used \nto asses image quality.\n\n```python\nimport numpy as np\nfrom compimg.similarity import SSIM\nsome_grayscale_image = np.ones((20,20), dtype=np.uint8)\nidentical_image = np.ones((20,20), dtype=np.uint8)\nresult = SSIM().compare(some_grayscale_image, identical_image)\nassert result == 1.0\n```\n\n## Features \n- common metrics for calculating similarity of one image to another \n- images are treated as `numpy` arrays which makes `compimg` compatible \nwith most image processing packages\n- only `scipy` (and inherently `numpy`) as a dependency\n\n## Installation\n`compimg` is available on *PyPI*. You can install it using pip: \n`pip install compimg`\n\n## Note \nKeep in mind that metrics are not aware of what kind of image you are passing. \nIf metric relies on intensity values and you have YCbCr image you should pass\nonly the first channel to the computing routine.\n\n## Help\nIf you have any problems or questions please post an issue.\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/khrynczenko/compimg", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "compimg", "package_url": "https://pypi.org/project/compimg/", "platform": "", "project_url": "https://pypi.org/project/compimg/", "project_urls": { "Homepage": "http://github.com/khrynczenko/compimg" }, "release_url": "https://pypi.org/project/compimg/0.2.1/", "requires_dist": [ "scipy (<2.0.0,>=1.1.0)", "numpy (<2.0.0,>=1.15.4)" ], "requires_python": "", "summary": "Image similarity metrics.", "version": "0.2.1" }, "last_serial": 5243927, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "1159cb5aaf5314bc8566c60fc9a57067", "sha256": "ef9099a6b7a1aaf63abe06981621287b58b520be136e7aa9c9bd8819fc272fd9" }, "downloads": -1, "filename": "compimg-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "1159cb5aaf5314bc8566c60fc9a57067", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8962, "upload_time": "2019-03-09T18:46:07", "url": "https://files.pythonhosted.org/packages/19/86/5240298842b2b2a275cf9507e100baf844caba0b6f2f3b41b6acb2463e23/compimg-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c627e84b758d41decb328f939a1386a4", "sha256": "07d431988f3bf80c8c77da64b1fafd489ac9fc27b4c9620ab4627d0489060140" }, "downloads": -1, "filename": "compimg-0.1.0.tar.gz", "has_sig": false, "md5_digest": "c627e84b758d41decb328f939a1386a4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3859, "upload_time": "2019-03-09T18:46:09", "url": "https://files.pythonhosted.org/packages/ce/33/41d4dc7a04663bc9e38afcc41f22d29207333ed53dcfab7592a311e7fd19/compimg-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "0fc92c908d2e6a9ed59c3be031383e4c", "sha256": "d0f7c849845bcad1ae8adc377e0957aba62107040a397faadead5148039b0370" }, "downloads": -1, "filename": "compimg-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "0fc92c908d2e6a9ed59c3be031383e4c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 9006, "upload_time": "2019-03-10T00:12:16", "url": "https://files.pythonhosted.org/packages/61/4c/216a01f21e4558840b334dd89a453980fc78c5d3b9ba6446ada40baee702/compimg-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8c969d3f58e45992bdb4337e36637d54", "sha256": "a2884142b0a3edadec133bb56236335cb6301de7092b9e59417f47f4e6b1abe1" }, "downloads": -1, "filename": "compimg-0.1.1.tar.gz", "has_sig": false, "md5_digest": "8c969d3f58e45992bdb4337e36637d54", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3912, "upload_time": "2019-03-10T00:12:18", "url": "https://files.pythonhosted.org/packages/a0/8c/66d7869c39eb2e02a9e36badbe636c24d44e4da2dd2b54bd234e68925efa/compimg-0.1.1.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "16c375dc8b690a3c5ef101318635ac77", "sha256": "267bdb7f571082149f3f995db36727904e55a751118408fa2b05448dc9837da9" }, "downloads": -1, "filename": "compimg-0.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "16c375dc8b690a3c5ef101318635ac77", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 13128, "upload_time": "2019-04-15T20:49:57", "url": "https://files.pythonhosted.org/packages/60/17/1fb6351720e620485743b83f5885932e858354b53d24cabab8d9333c9a94/compimg-0.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ab151ed339812031012ebb94217cbb92", "sha256": "897d9235afe43ef7109be1323b03535f623d660103f358ecdafb9388d677e76b" }, "downloads": -1, "filename": "compimg-0.2.0.tar.gz", "has_sig": false, "md5_digest": "ab151ed339812031012ebb94217cbb92", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7176, "upload_time": "2019-04-15T20:49:59", "url": "https://files.pythonhosted.org/packages/e7/c5/5db41d378e8f6ac6f32fccfe4533cdcce70c197bc7bc96ce08a9be00d7d8/compimg-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "738536116ed7177f547f76f3560346fc", "sha256": "5fe1bea864bfbe1d30681013662f46bbb62c02d75296b95d078be29b7ee90b5c" }, "downloads": -1, "filename": "compimg-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "738536116ed7177f547f76f3560346fc", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 14166, "upload_time": "2019-05-08T17:54:09", "url": "https://files.pythonhosted.org/packages/66/d4/99862b3646c2e0c6171b22e897103f91f37be2452a6908a0bb0df4437419/compimg-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "331dd4bc71a46c078c0ff68516d92cc6", "sha256": "73f7090020da90c8ea72f86710b3a42d0e2b667651f697fcf7294205b63de6ae" }, "downloads": -1, "filename": "compimg-0.2.1.tar.gz", "has_sig": false, "md5_digest": "331dd4bc71a46c078c0ff68516d92cc6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7632, "upload_time": "2019-05-08T17:54:10", "url": "https://files.pythonhosted.org/packages/0c/b1/54f3bcddf16f70ece312a62066194ace7913a56d3b85596f2272c15d2a04/compimg-0.2.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "738536116ed7177f547f76f3560346fc", "sha256": "5fe1bea864bfbe1d30681013662f46bbb62c02d75296b95d078be29b7ee90b5c" }, "downloads": -1, "filename": "compimg-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "738536116ed7177f547f76f3560346fc", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 14166, "upload_time": "2019-05-08T17:54:09", "url": "https://files.pythonhosted.org/packages/66/d4/99862b3646c2e0c6171b22e897103f91f37be2452a6908a0bb0df4437419/compimg-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "331dd4bc71a46c078c0ff68516d92cc6", "sha256": "73f7090020da90c8ea72f86710b3a42d0e2b667651f697fcf7294205b63de6ae" }, "downloads": -1, "filename": "compimg-0.2.1.tar.gz", "has_sig": false, "md5_digest": "331dd4bc71a46c078c0ff68516d92cc6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7632, "upload_time": "2019-05-08T17:54:10", "url": "https://files.pythonhosted.org/packages/0c/b1/54f3bcddf16f70ece312a62066194ace7913a56d3b85596f2272c15d2a04/compimg-0.2.1.tar.gz" } ] }