# tiff-inspector
**Tiff-Inspector** is a Python package that allows you to easily inspect the content and metadata of TIFF (Tagged Image File Format) files. The package provides an easy-to-use interface to view and analyze the hierarchical structure, series, levels, and tags of TIFF files.
## Features
* Inspect hierarchical structure of TIFF files.
* View metadata for series, levels, and individual pages.
* Extract and display image descriptions.
* Display metadata and tag values in a human-readable format.
* Supports XML and plain text descriptions.
## Installation
You can install Tiff-Inspector using pip:
```bash
pip install tiffinspector
```
## Dependencies
* tifffile
* xmltodict
* IPython
## Usage
To use the Tiff-Inspector package, simply import the TiffInspector class and create an instance with the path to the TIFF file.
```py
from tiffinspector import TiffInspector
# Instantiate the TiffInspector with the path to the TIFF file
tiff_inspector = TiffInspector("path/to/tiff/file.tif")
# Display the report
tiff_inspector.display_report(expanded=False, levels=None, max_text_length=None)
```
You can customize the display of the report by modifying the parameters:
* `expanded`: If set to True, it will expand the JSON structures in the report.
* `levels`: Set the number of tree levels to display. If set to None, it will display the entire tree.
* `max_text_length`: Set the maximum length of text values in the report. If set to None, it will display the entire text.
## Documentation
For more detailed information on the package and its functions, please refer to the source code and comments within the package.
## License
This package is released under the __MIT License__.
Raw data
{
"_id": null,
"home_page": "https://github.com/jason-weirather/tiff-inspector",
"name": "tiff-inspector",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Jason L Weirather",
"author_email": "jason.weirather@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c4/3b/629dec5527282c968bc8b9d715f299eb98206ad5f45bb16c9ad4fc1b16b1/tiff-inspector-0.1.1.tar.gz",
"platform": null,
"description": "# tiff-inspector\n\n**Tiff-Inspector** is a Python package that allows you to easily inspect the content and metadata of TIFF (Tagged Image File Format) files. The package provides an easy-to-use interface to view and analyze the hierarchical structure, series, levels, and tags of TIFF files.\n\n## Features\n\n* Inspect hierarchical structure of TIFF files.\n* View metadata for series, levels, and individual pages.\n* Extract and display image descriptions.\n* Display metadata and tag values in a human-readable format.\n* Supports XML and plain text descriptions.\n\n## Installation\n\nYou can install Tiff-Inspector using pip:\n\n```bash\npip install tiffinspector\n```\n\n## Dependencies\n\n* tifffile\n* xmltodict\n* IPython\n\n\n## Usage\n\nTo use the Tiff-Inspector package, simply import the TiffInspector class and create an instance with the path to the TIFF file.\n\n```py\nfrom tiffinspector import TiffInspector\n\n# Instantiate the TiffInspector with the path to the TIFF file\ntiff_inspector = TiffInspector(\"path/to/tiff/file.tif\")\n\n# Display the report\ntiff_inspector.display_report(expanded=False, levels=None, max_text_length=None)\n```\n\nYou can customize the display of the report by modifying the parameters:\n\n* `expanded`: If set to True, it will expand the JSON structures in the report.\n* `levels`: Set the number of tree levels to display. If set to None, it will display the entire tree.\n* `max_text_length`: Set the maximum length of text values in the report. If set to None, it will display the entire text.\n\n## Documentation\n\nFor more detailed information on the package and its functions, please refer to the source code and comments within the package.\n\n## License\n\nThis package is released under the __MIT License__.\n",
"bugtrack_url": null,
"license": "",
"summary": "A package for examining the structure and contents of the metadata contained within tiff files",
"version": "0.1.1",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e7b67fa800e35898097c96a3591de40d6ebcdac7572727bbe051458f7ef458aa",
"md5": "ce872fa5d98f90f33adc47f9ae7e6521",
"sha256": "172f25dca110ce03f210d45d8562821240d0e81186cf10f823bfb84bf401ecdf"
},
"downloads": -1,
"filename": "tiff_inspector-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ce872fa5d98f90f33adc47f9ae7e6521",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 10833,
"upload_time": "2023-04-18T22:09:11",
"upload_time_iso_8601": "2023-04-18T22:09:11.858223Z",
"url": "https://files.pythonhosted.org/packages/e7/b6/7fa800e35898097c96a3591de40d6ebcdac7572727bbe051458f7ef458aa/tiff_inspector-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c43b629dec5527282c968bc8b9d715f299eb98206ad5f45bb16c9ad4fc1b16b1",
"md5": "cd792bab3f81e141fcff364b8b0a7437",
"sha256": "d72e706cd4290aec2abf8462b82671eaa7a6dd5f91c5c37774d875a4b4274464"
},
"downloads": -1,
"filename": "tiff-inspector-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "cd792bab3f81e141fcff364b8b0a7437",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 9963,
"upload_time": "2023-04-18T22:09:13",
"upload_time_iso_8601": "2023-04-18T22:09:13.838050Z",
"url": "https://files.pythonhosted.org/packages/c4/3b/629dec5527282c968bc8b9d715f299eb98206ad5f45bb16c9ad4fc1b16b1/tiff-inspector-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-18 22:09:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "jason-weirather",
"github_project": "tiff-inspector",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "tiff-inspector"
}
JSON
