Metadata-Version: 2.1
Name: openhsi
Version: 0.1.0
Summary: Library to calibrate, trigger and capture data cubes for the open source hyperspectral camera.
Home-page: https://github.com/openhsi/openhsi/tree/master/
Author: Yiwei Mao, et al.
Author-email: yiwei.mao@sydney.edu.au
License: Apache Software License 2.0
Keywords: Open Hyperspectral Imager
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: pip
Requires-Dist: packaging
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: nbdev
Requires-Dist: fastcore
Requires-Dist: fastprogress
Requires-Dist: h5py
Requires-Dist: xarray
Requires-Dist: pillow
Requires-Dist: pandas
Requires-Dist: tqdm
Requires-Dist: bokeh
Requires-Dist: holoviews
Requires-Dist: panel
Requires-Dist: param
Requires-Dist: Py6S
Requires-Dist: pyserial
Requires-Dist: opencv-python
Requires-Dist: netcdf4
Requires-Dist: streamz
Requires-Dist: requests (<=2.24.0)
Provides-Extra: dev

# Open Source DIY Hyperspectral Imager Library
> Library to calibrate, trigger and capture data cubes for the open source DIY hyperspectral camera. 


![](https://github.com/openhsi/openhsi/actions/workflows/main.yml/badge.svg)

This Python library is licensed under the [Apache v2 License](https://www.apache.org/licenses/LICENSE-2.0). The documentation is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/3.0/au/">Creative Commons Attribution 3.0 Australia License</a>.

Documentation can be found here: [https://openhsi.github.io/openhsi/](https://openhsi.github.io/openhsi/).

## Install

`pip install openhsi`

## Requirements

- Python 3.6+
- Ximea SDK (See https://www.ximea.com/support/wiki/apis/Python)

## Development and Contributions

This whole software library, testing suite, documentation website, and PyPI package was developed in Jupyter Notebooks using [nbdev](https://nbdev.fast.ai/). 
{% include important.html content='This library is under active development and new features are still being added. ' %}

## How to use

### Taking a single hyperspectral datacube

The example shown here uses a simulated camera for testing purposes. Replace `SimulatedCamera` with the appropriate Python class for your own camera to work with real hardware. 

```python
from openhsi.capture import *

with SimulatedCamera(img_path="assets/rocky_beach.png", n_lines=1024, processing_lvl = 3) as cam:
    cam.collect()
    fig = cam.show(plot_lib="matplotlib",robust=True)


```

    100%|██████████| 1024/1024 [00:18<00:00, 55.21it/s]













    Text(0, 0.5, 'cross-track')




![png](https://raw.githubusercontent.com/openhsi/openhsi/master/docs/images/output_9_1.png)



