# visual-clutter
[](https://pypi.org/project/visual-clutter/)
[](https://huggingface.co/spaces/kargaranamir/visual-clutter)
Python Implementation of two measures of visual clutter (Feature Congestion and Subband Entropy), [Matlab Version](https://dspace.mit.edu/handle/1721.1/37593), [+ library dependency](https://nl.mathworks.com/matlabcentral/fileexchange/52571-matlabpyrtools).
## Pre-requisites
* This utility is written in Python 3. You will need a Python 3 interpreter installed or you will have to package this into a self contained executable.
* This utility uses [Pyrtools](https://pyrtools.readthedocs.io/en/latest/). So you will need to run it on Linux or on OSX. Windows is NOT supported because of issues with the C compiler (gcc isn't necessarily installed).
## How to Install visual_clutter
```
pip install visual-clutter
```
```
# install from git
pip install git+https://github.com/kargaranamir/visual-clutter
```
## How to use (Examples)
```
from visual_clutter import Vlc
# make visual clutter object and load test map and set parameters
clt = Vlc('./tests/test.jpg', numlevels=3, contrast_filt_sigma=1, contrast_pool_sigma=3, color_pool_sigma=3)
# get Feature Congestion clutter of a test map:
clutter_scalar_fc, clutter_map_fc = clt.getClutter_FC(p=1, pix=1)
# get Subband Entropy clutter of the test map:
clutter_scalar_se = clt.getClutter_SE(wlevels=3, wght_chrom=0.0625)
print(f'clutter_scalar_fc: {clutter_scalar_fc}')
print(f'clutter_scalar_se: {clutter_scalar_se}')
# just compute and display color clutter map(s)
color_clutter = clt.colorClutter(color_pix=1)
# just compute and display contrast clutter map(s)
contrast_clutter = clt.contrastClutter(contrast_pix=1)
# just compute and display orientation clutter map(s)
orientation_clutter = clt.orientationClutter(orient_pix=1)
```
## Reference
```
Ruth Rosenholtz, Yuanzhen Li, and Lisa Nakano. "Measuring Visual Clutter".
Journal of Vision, 7(2), 2007. http://www.journalofvision.com/7/2/
Ruth Rosenholtz, Yuanzhen Li, and Lisa Nakano, May 2007.
```
## Citation
visual_clutter python package is now part of [AIM2](https://github.com/aalto-ui/aim). If you use any part of this library in your research, please cite it using the following BibTex entry. Bibtex entry for AIM2 will be added once it is released.
```
@misc{visual_clutter,
author = {Kargaran, Amir Hossein},
title = {Visual Clutter Python Library},
year = {2021},
publisher = {GitHub},
journal = {GitHub Repository},
howpublished = {\url{https://github.com/kargaranamir/visual-clutter}},
}
```
## Related Repositories
- [Piranhas](https://github.com/ArturoDeza/Piranhas)
- [Aalto Interface Metrics (AIM)](https://github.com/aalto-ui/aim)
- [pyrtools: tools for multi-scale image processing](https://github.com/LabForComputationalVision/pyrtools)
## Studies Referencing Our Package
- [Master Thesis](https://www.merlin.uzh.ch/contributionDocument/download/15217): Unveiling the Inner Structures of the Montreux Jazz Festival Concert
Raw data
{
"_id": null,
"home_page": "https://github.com/kargaranamir/visual-clutter",
"name": "visual-clutter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "visual clutter,feature congestion,subband entropy",
"author": "Amir Hossein Kargaran",
"author_email": "kargaranamir@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/81/77/250df3cd5d1077cb3ae2114602c198aa3ccb780ec67cddc8c77dbc804a4a/visual_clutter-1.0.7.tar.gz",
"platform": null,
"description": "# visual-clutter\n[](https://pypi.org/project/visual-clutter/)\n[](https://huggingface.co/spaces/kargaranamir/visual-clutter)\n\nPython Implementation of two measures of visual clutter (Feature Congestion and Subband Entropy), [Matlab Version](https://dspace.mit.edu/handle/1721.1/37593), [+ library dependency](https://nl.mathworks.com/matlabcentral/fileexchange/52571-matlabpyrtools).\n\n\n## Pre-requisites\n* This utility is written in Python 3. You will need a Python 3 interpreter installed or you will have to package this into a self contained executable. \n\n* This utility uses [Pyrtools](https://pyrtools.readthedocs.io/en/latest/). So you will need to run it on Linux or on OSX. Windows is NOT supported because of issues with the C compiler (gcc isn't necessarily installed).\n\n\n\n## How to Install visual_clutter\n\n```\npip install visual-clutter\n```\n\n```\n# install from git\npip install git+https://github.com/kargaranamir/visual-clutter\n```\n\n\n## How to use (Examples)\n```\nfrom visual_clutter import Vlc\n\n# make visual clutter object and load test map and set parameters\nclt = Vlc('./tests/test.jpg', numlevels=3, contrast_filt_sigma=1, contrast_pool_sigma=3, color_pool_sigma=3)\n\n# get Feature Congestion clutter of a test map:\nclutter_scalar_fc, clutter_map_fc = clt.getClutter_FC(p=1, pix=1)\n\n# get Subband Entropy clutter of the test map:\nclutter_scalar_se = clt.getClutter_SE(wlevels=3, wght_chrom=0.0625)\n\nprint(f'clutter_scalar_fc: {clutter_scalar_fc}')\nprint(f'clutter_scalar_se: {clutter_scalar_se}')\n\n# just compute and display color clutter map(s)\ncolor_clutter = clt.colorClutter(color_pix=1)\n\n# just compute and display contrast clutter map(s)\ncontrast_clutter = clt.contrastClutter(contrast_pix=1)\n\n# just compute and display orientation clutter map(s)\norientation_clutter = clt.orientationClutter(orient_pix=1)\n\n```\n\n## Reference\n```\nRuth Rosenholtz, Yuanzhen Li, and Lisa Nakano. \"Measuring Visual Clutter\". \nJournal of Vision, 7(2), 2007. http://www.journalofvision.com/7/2/\n\nRuth Rosenholtz, Yuanzhen Li, and Lisa Nakano, May 2007.\n```\n\n## Citation\nvisual_clutter python package is now part of [AIM2](https://github.com/aalto-ui/aim). If you use any part of this library in your research, please cite it using the following BibTex entry. Bibtex entry for AIM2 will be added once it is released.\n\n```\n@misc{visual_clutter,\n author = {Kargaran, Amir Hossein},\n title = {Visual Clutter Python Library},\n year = {2021},\n publisher = {GitHub},\n journal = {GitHub Repository},\n howpublished = {\\url{https://github.com/kargaranamir/visual-clutter}},\n}\n```\n\n## Related Repositories\n- [Piranhas](https://github.com/ArturoDeza/Piranhas)\n- [Aalto Interface Metrics (AIM)](https://github.com/aalto-ui/aim)\n- [pyrtools: tools for multi-scale image processing](https://github.com/LabForComputationalVision/pyrtools)\n\n\n## Studies Referencing Our Package\n- [Master Thesis](https://www.merlin.uzh.ch/contributionDocument/download/15217): Unveiling the Inner Structures of the Montreux Jazz Festival Concert\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Python implementation of two measures of visual clutter (Feature Congestion and Subband Entropy)",
"version": "1.0.7",
"project_urls": {
"Bug Tracker": "https://github.com/kargaranamir/visual-clutter/issues",
"Homepage": "https://github.com/kargaranamir/visual-clutter"
},
"split_keywords": [
"visual clutter",
"feature congestion",
"subband entropy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0496d154232c9929bbf175aeca52e9533adc6547d6cb7453faa99fcdd0b8c4d3",
"md5": "8e2aae3dfbaf3a5e26408edf901773f9",
"sha256": "dff1328043ade67d4a0094a8de09f655cd5a184942e3de7c53b8f966d909c9cb"
},
"downloads": -1,
"filename": "visual_clutter-1.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8e2aae3dfbaf3a5e26408edf901773f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 16497,
"upload_time": "2023-08-19T20:23:21",
"upload_time_iso_8601": "2023-08-19T20:23:21.743950Z",
"url": "https://files.pythonhosted.org/packages/04/96/d154232c9929bbf175aeca52e9533adc6547d6cb7453faa99fcdd0b8c4d3/visual_clutter-1.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8177250df3cd5d1077cb3ae2114602c198aa3ccb780ec67cddc8c77dbc804a4a",
"md5": "76d2adbbccdfd50cce344c3acc2d0cac",
"sha256": "f3ed9535d266a7c2f2cf32b2d2845296c9e21f8e652b1feb5b1ff1ef366fff05"
},
"downloads": -1,
"filename": "visual_clutter-1.0.7.tar.gz",
"has_sig": false,
"md5_digest": "76d2adbbccdfd50cce344c3acc2d0cac",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 17217,
"upload_time": "2023-08-19T20:23:23",
"upload_time_iso_8601": "2023-08-19T20:23:23.266106Z",
"url": "https://files.pythonhosted.org/packages/81/77/250df3cd5d1077cb3ae2114602c198aa3ccb780ec67cddc8c77dbc804a4a/visual_clutter-1.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-19 20:23:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kargaranamir",
"github_project": "visual-clutter",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "visual-clutter"
}
JSON
