# Flir Image Extractor CLI
The email address attached to this on PyPi may not be monitored, open issues on the [GitHub repo](https://github.com/nationaldronesau/FlirImageExtractor) to ensure a response
Feel free to submit any pull requests or issues, this is in active development. Also let me know if you are successful in using this on cameras not listed below.
FLIR® thermal cameras like the FLIR ONE® include both a thermal and a visual light camera.
The latter is used to enhance the thermal image using an edge detector. The resulting image is saved as a
jpg image but both the original visual image and the raw thermal sensor data are embedded in the jpg metadata.
This Python CLI that allows you to extract the original photo and thermal sensor values converted to temperatures, normalize the temperature range and output the photos to different color maps.
## Requirements and Install
This tool relies on `exiftool`. It should be available in most Linux distributions (e.g. as `perl-image-exiftool` in Arch Linux or `libimage-exiftool-perl` in Debian and Ubuntu). Links for downloading the Mac version and more information is available on the [ExifTool site](https://sno.phy.queensu.ca/~phil/exiftool/index.html).
To install on Linux:
```bash
sudo apt update
sudo apt install exiftool
```
To install `exiftool` on Windows for use in this CLI, download the `exiftool` windows executable from [here](https://exiftool.org/exiftool-11.93.zip). Extract `exiftool(-k).exe` and rename to `exiftool.exe`. Copy this executable to `C:\Windows` on your computer. You will need admin permissions to do this. Doing this will make `exiftool` available to the CLI.
It also requires other python packages, *matplotlib*, *numpy* and *pillow*, which are installed when the CLI is installed through pip.
Once you have install exiftool, you can install the CLI using pip:
```bash
pip install flirimageextractor
```
On windows you may need to use:
```bash
python -m pip install flirimageextractor
```
To update to the latest version of the CLI use this command. The first time you install the latest version will be automatically downloaded.
```bash
pip install --upgrade flirimageextractor
```
## Usage
You can start the CLI using the terminal.
```bash
flirimageextractor
````
#### Resulting Plot and Saved Images
The CLI is able to output 3 folders of images with the `bwr`, `gnuplot`, and `gist_ncar` colormaps from matplotlib. You can define the pallete(s) that you would rather use.
## Supported/Tested Cameras
- Flir One (thermal + RGB)
- Xenmuse XTR (thermal + thumbnail, set the subject distance to 1 meter)
- AX8 (thermal + RGB)
- DJI Zenmuse H20T Camera (ZH20T)
Other cameras might need some small tweaks (the embedded raw data can be in multiple image formats). Let me know if you succesfully use other cameras so they can be added to this list.
## Development
Install the required packages using [Pipenv](https://pipenv.kennethreitz.org/en/latest/). Then run `pre-commit install` to install the pre-commit hooks. Note that this tool is intended to work on Windows as well as Unix operating systems so use os.path functions to manipulate file paths instead of string manipulation.
## Build Command for Dev (uses poetry or twine)
- python -m build --sdist --wheel
- poetry build
- poetry add "packagename" --group=extras --optional
- sphinx-build -b html docs/source docs/build (To Generate Docs)
## Credits
This CLi was developed using this repos:
- https://github.com/Nervengift/read_thermal.py
- https://github.com/detecttechnologies/thermal_base/
Raw data
{
"_id": null,
"home_page": "https://github.com/nationaldronesau/FlirImageExtractor",
"name": "flirimageextractor",
"maintainer": "olawale williams",
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": "olawalewilliams9438@gmail.com",
"keywords": "extract-images, flir, thermal, flirtools",
"author": "National Drones",
"author_email": "development@nationaldrones.com",
"download_url": "https://files.pythonhosted.org/packages/09/45/3527d1480b24e948067aa8f44aa71ec2d7b171742af88dfbfab00c22904d/flirimageextractor-1.5.6.tar.gz",
"platform": null,
"description": "# Flir Image Extractor CLI\n\nThe email address attached to this on PyPi may not be monitored, open issues on the [GitHub repo](https://github.com/nationaldronesau/FlirImageExtractor) to ensure a response\n\nFeel free to submit any pull requests or issues, this is in active development. Also let me know if you are successful in using this on cameras not listed below.\n\nFLIR\u00ae thermal cameras like the FLIR ONE\u00ae include both a thermal and a visual light camera.\nThe latter is used to enhance the thermal image using an edge detector. The resulting image is saved as a\njpg image but both the original visual image and the raw thermal sensor data are embedded in the jpg metadata.\n\nThis Python CLI that allows you to extract the original photo and thermal sensor values converted to temperatures, normalize the temperature range and output the photos to different color maps.\n\n## Requirements and Install\n\nThis tool relies on `exiftool`. It should be available in most Linux distributions (e.g. as `perl-image-exiftool` in Arch Linux or `libimage-exiftool-perl` in Debian and Ubuntu). Links for downloading the Mac version and more information is available on the [ExifTool site](https://sno.phy.queensu.ca/~phil/exiftool/index.html).\nTo install on Linux:\n\n```bash\nsudo apt update\nsudo apt install exiftool\n```\n\nTo install `exiftool` on Windows for use in this CLI, download the `exiftool` windows executable from [here](https://exiftool.org/exiftool-11.93.zip). Extract `exiftool(-k).exe` and rename to `exiftool.exe`. Copy this executable to `C:\\Windows` on your computer. You will need admin permissions to do this. Doing this will make `exiftool` available to the CLI.\n\nIt also requires other python packages, *matplotlib*, *numpy* and *pillow*, which are installed when the CLI is installed through pip.\n\nOnce you have install exiftool, you can install the CLI using pip:\n```bash\npip install flirimageextractor\n```\nOn windows you may need to use:\n```bash\npython -m pip install flirimageextractor\n```\n\nTo update to the latest version of the CLI use this command. The first time you install the latest version will be automatically downloaded.\n```bash\npip install --upgrade flirimageextractor\n```\n\n## Usage\n\nYou can start the CLI using the terminal.\n```bash\nflirimageextractor\n````\n\n\n#### Resulting Plot and Saved Images\nThe CLI is able to output 3 folders of images with the `bwr`, `gnuplot`, and `gist_ncar` colormaps from matplotlib. You can define the pallete(s) that you would rather use.\n\n## Supported/Tested Cameras\n\n- Flir One (thermal + RGB)\n- Xenmuse XTR (thermal + thumbnail, set the subject distance to 1 meter)\n- AX8 (thermal + RGB)\n- DJI Zenmuse H20T Camera (ZH20T)\n\nOther cameras might need some small tweaks (the embedded raw data can be in multiple image formats). Let me know if you succesfully use other cameras so they can be added to this list.\n\n## Development\nInstall the required packages using [Pipenv](https://pipenv.kennethreitz.org/en/latest/). Then run `pre-commit install` to install the pre-commit hooks. Note that this tool is intended to work on Windows as well as Unix operating systems so use os.path functions to manipulate file paths instead of string manipulation.\n\n## Build Command for Dev (uses poetry or twine)\n- python -m build --sdist --wheel\n- poetry build\n- poetry add \"packagename\" --group=extras --optional\n- sphinx-build -b html docs/source docs/build (To Generate Docs)\n\n## Credits\n\nThis CLi was developed using this repos:\n- https://github.com/Nervengift/read_thermal.py\n- https://github.com/detecttechnologies/thermal_base/\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A small tool/lib to read temperatures and original photos from FLIR\u00ae thermal camera images.",
"version": "1.5.6",
"project_urls": {
"Documentation": "https://github.com/nationaldronesau/FlirImageExtractor",
"Homepage": "https://github.com/nationaldronesau/FlirImageExtractor",
"Repository": "https://github.com/nationaldronesau/FlirImageExtractor"
},
"split_keywords": [
"extract-images",
" flir",
" thermal",
" flirtools"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3145af75c2a0e6780d968faf5038ba52c9d9796c14552f238a041d9eb773c454",
"md5": "46f37eb8128ce912f6193799041fb59e",
"sha256": "2bb0db7bd3b4119c7ceeb2a5d77e812e5a9a64aadb6eb2460a4a1e56a7acedec"
},
"downloads": -1,
"filename": "flirimageextractor-1.5.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "46f37eb8128ce912f6193799041fb59e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 29332,
"upload_time": "2024-06-27T17:21:53",
"upload_time_iso_8601": "2024-06-27T17:21:53.133085Z",
"url": "https://files.pythonhosted.org/packages/31/45/af75c2a0e6780d968faf5038ba52c9d9796c14552f238a041d9eb773c454/flirimageextractor-1.5.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "09453527d1480b24e948067aa8f44aa71ec2d7b171742af88dfbfab00c22904d",
"md5": "dcc1f1eba8c6037b051962c513afb4c5",
"sha256": "6219034716f2a896c78cd261fe523a2e9f3504dd926eda907c89d0b7dc725ffb"
},
"downloads": -1,
"filename": "flirimageextractor-1.5.6.tar.gz",
"has_sig": false,
"md5_digest": "dcc1f1eba8c6037b051962c513afb4c5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 27480,
"upload_time": "2024-06-27T17:21:54",
"upload_time_iso_8601": "2024-06-27T17:21:54.450215Z",
"url": "https://files.pythonhosted.org/packages/09/45/3527d1480b24e948067aa8f44aa71ec2d7b171742af88dfbfab00c22904d/flirimageextractor-1.5.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-27 17:21:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nationaldronesau",
"github_project": "FlirImageExtractor",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "flirimageextractor"
}
JSON
