Read functions for TREx ASI PGM raw files
Project description
TREx All-Sky Imager Raw PGM Data Readfile
Python library for reading Transition Region Explorer (TREx) All-Sky Imager (ASI) stream0 raw PGM-file data. The data can be found at https://data.phys.ucalgary.ca.
Supported Datasets
- Blueline: stream0 PGM files
- Near-infrared: stream0 PGM files
- RGB: stream0 single-channel PGM files, stream0.colour 3-channel PNG files, stream0.burst 3-channel PNG files
- Spectrograph: stream0 PGM files
Installation
The trex-imager-readfile library is available on PyPI:
$ python3 -m pip install trex-imager-readfile
Supported Python Versions
trex-imager-readfile officially supports Python 3.7+.
Examples
Example Python notebooks can be found in the "examples" directory. Further, some examples can be found in the "Usage" section below.
Usage
Import the library using import trex_imager_readfile
Read a single file
>>> import trex_imager_readfile
>>> filename = "path/to/rgb_data/2020/01/01/fsmi_rgb-01/ut06/20200101_0600_fsmi_rgb-01_full.pgm.gz"
>>> img, meta, problematic_files = trex_imager_readfile.read_rgb(filename)
Read multiple files
>>> import trex_imager_readfile, glob
>>> file_list = glob.glob("path/to/files/2020/01/01/fsmi_rgb-01/ut06/*full.pgm*")
>>> img, meta, problematic_files = trex_imager_readfile.read_rgb(file_list)
Read using multiple worker processes
>>> import trex_imager_readfile, glob
>>> file_list = glob.glob("path/to/files/2020/01/01/fsmi_rgb-01/ut06/*full.pgm*")
>>> img, meta, problematic_files = trex_imager_readfile.read_rgb(file_list, workers=4)
Development
Clone the repository and install dependencies using Poetry.
$ git clone https://github.com/ucalgary-aurora/trex-imager-readfile.git
$ cd trex-imager-readfile/python
$ make install
Testing
$ make test
[ or do each test separately ]
$ make test-flake8
$ make test-pylint
$ make test-pytest
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for trex_imager_readfile-1.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 05d35a466563ce40f853886540fb220ee958ef37e49cbf0ffd3bc458be425c13 |
|
MD5 | 175f7a23cfe4ac702b44e87b9c48b58c |
|
BLAKE2b-256 | d6bc616b19368640de3aeca1c96af346b284080afd7925f06115f4ba50dca2f0 |
Close
Hashes for trex_imager_readfile-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8920663b8f27d2cd4c73c460a16c54712ebe0a19af43bc27bea3cdb73ae7a04a |
|
MD5 | 28dba8e510000706578e8eea98b8d7da |
|
BLAKE2b-256 | ad24a7e006d2a0f2876e9a79769a0a32e1150d678838ed90542772d11a8abd97 |