# Display Image
Display image is a Python project which provides a command `display-image` to visualize the image and metadata by QtPy6.
## Installation
~~~~~~~~~~~~~~~{.shell}
pip install display-image
~~~~~~~~~~~~~~~
## Usage
~~~~~~~~~~~~~~~{.shell}
display-image -i <path_to_image>
~~~~~~~~~~~~~~~
The following format extensions can be displayed by command `display-image`
| Image format | Read | EXIF | Pixel precision | Pixel type | File extension | Sidecar needed |
|---------------|------|------|------------------------|----------------------|----------------------------------|------------------|
| BMP | x | | 8 bits | Grayscale, RGB, RGBA | .bmp | |
| CFA | x | | 16 bits | Bayer | .cfa | |
| DNG | x | x | 16 bits | Bayer | .dng | |
| JPEG | x | x | 8 bits | Grayscale, RGB | .jpg, .jpeg | |
| MIPI RAW | x | | 10 bits, 12 bits | Bayer | .RAWMIPI, .RAWMIPI10, .RAWMIPI12 | x |
| PLAIN RAW | x | | * | * | .raw .plain16, * | x |
| PNG | x | | 8 bits | Grayscale, RGB, RGBA | .png | |
| TIFF | x | x | 8 bits, 16 bits | Bayer, RGB | .tif, .tiff | |
### Image display with sidecar JSON
Some file formats need to know in advance some informations about the image. For example, the PLAIN RAW format is just a simple dump of a buffer into a file, thus it needs to know how to interpret the data.
In this case, user need to have an image sidecar JSON located next to the image file as the same name and path `path_to_image.json`
~~~~~~~~~~~~~~~{.json}
{
"fileInfo": {
"format": "plain",
"height": 3072,
"width": 4080
"pixelPrecision": 16,
"pixelType": "bayer_gbrg",
}
}
~~~~~~~~~~~~~~~
After image reading, the information in JSON sidecar will be shown in tab Widegt of `ImageMetadata`
### Other image reading with sidecar examples
<details>
<summary>
Click to unfold other image format sidecar examples
</summary>
#### Packed RAW MIPI 12 bits:
sidecar json
~~~~~~~~~~~~~~~{.json}
{
"fileInfo": {
"fileFormat": "raw12",
"height": 3000,
"width": 4000,
"pixelPrecision": 12,
"pixelType": "bayer_gbrg"
}
}
~~~~~~~~~~~~~~~
#### Packed RAW MIPI 10 bits:
sidecar json
~~~~~~~~~~~~~~~{.json}
{
"fileInfo": {
"height": 3000,
"width": 4000,
"format": "raw10",
"pixelPrecision": 10,
"pixelType": "bayer_grbg"
}
}
~~~~~~~~~~~~~~~
</details>
## License
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/sygslhy/display-image/blob/master/LICENSE.md) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "display-image",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Yuan SUN <sunyuan860510@gmail.com>",
"keywords": "display, image, view, display image, image viewer, raw viewer, display raw image",
"author": null,
"author_email": "Yuan SUN <sunyuan860510@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/34/62/1e45f66aaa349c42b2f82419f2d35bc04d5382c073cf8f7a74d6250c56e4/display_image-0.1.2.tar.gz",
"platform": null,
"description": "# Display Image\n\nDisplay image is a Python project which provides a command `display-image` to visualize the image and metadata by QtPy6.\n\n## Installation\n\n~~~~~~~~~~~~~~~{.shell}\npip install display-image\n~~~~~~~~~~~~~~~\n\n## Usage\n\n~~~~~~~~~~~~~~~{.shell}\ndisplay-image -i <path_to_image>\n~~~~~~~~~~~~~~~\n\n\nThe following format extensions can be displayed by command `display-image`\n\n| Image format | Read | EXIF | Pixel precision | Pixel type | File extension | Sidecar needed |\n|---------------|------|------|------------------------|----------------------|----------------------------------|------------------|\n| BMP | x | | 8 bits | Grayscale, RGB, RGBA | .bmp | |\n| CFA | x | | 16 bits | Bayer | .cfa | |\n| DNG | x | x | 16 bits | Bayer | .dng | |\n| JPEG | x | x | 8 bits | Grayscale, RGB | .jpg, .jpeg | |\n| MIPI RAW | x | | 10 bits, 12 bits | Bayer | .RAWMIPI, .RAWMIPI10, .RAWMIPI12 | x |\n| PLAIN RAW | x | | * | * | .raw .plain16, * | x |\n| PNG | x | | 8 bits | Grayscale, RGB, RGBA | .png | |\n| TIFF | x | x | 8 bits, 16 bits | Bayer, RGB | .tif, .tiff | |\n\n\n\n\n\n### Image display with sidecar JSON\n\nSome file formats need to know in advance some informations about the image. For example, the PLAIN RAW format is just a simple dump of a buffer into a file, thus it needs to know how to interpret the data.\nIn this case, user need to have an image sidecar JSON located next to the image file as the same name and path `path_to_image.json`\n\n~~~~~~~~~~~~~~~{.json}\n{\n \"fileInfo\": {\n \"format\": \"plain\",\n \"height\": 3072,\n \"width\": 4080\n \"pixelPrecision\": 16,\n \"pixelType\": \"bayer_gbrg\",\n }\n}\n~~~~~~~~~~~~~~~\n\nAfter image reading, the information in JSON sidecar will be shown in tab Widegt of `ImageMetadata`\n\n### Other image reading with sidecar examples\n\n<details>\n <summary>\n Click to unfold other image format sidecar examples\n </summary>\n\n#### Packed RAW MIPI 12 bits:\n\nsidecar json\n~~~~~~~~~~~~~~~{.json}\n{\n \"fileInfo\": {\n \"fileFormat\": \"raw12\",\n \"height\": 3000,\n \"width\": 4000,\n \"pixelPrecision\": 12,\n \"pixelType\": \"bayer_gbrg\"\n }\n}\n~~~~~~~~~~~~~~~\n\n#### Packed RAW MIPI 10 bits:\n\nsidecar json\n~~~~~~~~~~~~~~~{.json}\n{\n \"fileInfo\": {\n \"height\": 3000,\n \"width\": 4000,\n\t\t\"format\": \"raw10\",\n\t\t\"pixelPrecision\": 10,\n\t\t\"pixelType\": \"bayer_grbg\"\n }\n}\n~~~~~~~~~~~~~~~\n\n</details>\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](https://github.com/sygslhy/display-image/blob/master/LICENSE.md) file for details.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "PyQt6 Gui App to display the wide range image formats (jpg, png, tif, dng, bmp, and RAWs), with image metadata and histogram.",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/sygslhy/display-image",
"Issues": "https://github.com/sygslhy/display-image/issues",
"Releases": "https://github.com/sygslhy/display-image/releases",
"Repository": "https://github.com/sygslhy/display-image"
},
"split_keywords": [
"display",
" image",
" view",
" display image",
" image viewer",
" raw viewer",
" display raw image"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "35de4f8b8f45c5440f47b5402aa3f3431ef6f461682d02b516f55820144225ba",
"md5": "49615d97d54ed57cfa68396446cb8015",
"sha256": "8baeab6648c94db4f9047cb28b28202138d37b0380cb4078f68979014cd3d0d7"
},
"downloads": -1,
"filename": "display_image-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "49615d97d54ed57cfa68396446cb8015",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 7234,
"upload_time": "2025-01-25T21:33:25",
"upload_time_iso_8601": "2025-01-25T21:33:25.982759Z",
"url": "https://files.pythonhosted.org/packages/35/de/4f8b8f45c5440f47b5402aa3f3431ef6f461682d02b516f55820144225ba/display_image-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "34621e45f66aaa349c42b2f82419f2d35bc04d5382c073cf8f7a74d6250c56e4",
"md5": "b1bbb21a37a5f97756c397344e7990d5",
"sha256": "ba5026084ccd6bb6003c4982b9a4083c7fc7d4908bdd199ca563e39c7aee9652"
},
"downloads": -1,
"filename": "display_image-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "b1bbb21a37a5f97756c397344e7990d5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 8113,
"upload_time": "2025-01-25T21:33:27",
"upload_time_iso_8601": "2025-01-25T21:33:27.362796Z",
"url": "https://files.pythonhosted.org/packages/34/62/1e45f66aaa349c42b2f82419f2d35bc04d5382c073cf8f7a74d6250c56e4/display_image-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-25 21:33:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sygslhy",
"github_project": "display-image",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "display-image"
}
JSON
