# Colour - HDRI

A Python package implementing various HDRI / Radiance image processing algorithms.

It is open source and freely available under the New BSD License terms.

## Features

The following features are available:

- HDRI / Radiance Image Generation
- Debevec (1997) Camera Response Function Computation
- Grossberg (2003) Histogram Based Image Sampling
- Variance Minimization Light Probe Sampling
- Global Tonemapping Operators
- Adobe DNG SDK Colour Processing
- Absolute Luminance Calibration
- Raw Processing Helpers

## Installation

Because of their size, the resources dependencies needed to run the various examples and unit tests are not provided within the Pypi package. They are separately available as Git Submodules when cloning the repository.

### Primary Dependencies

Colour - HDRI requires various dependencies in order to run:

- Python 2.7 or Python 3.5
- NumPy
- OpenImageIO

### Optional Features Dependencies

- colour-demosaicing
- Adobe DNG Converter
- dcraw
- ExifTool
- rawpy

### Pypi

Once the dependencies satisfied, Colour - HDRI can be installed from the Python Package Index by issuing this command in a shell:

    pip install colour-hdri

The optional features dependencies are installed as follows:

    pip install 'colour-hdri[optional]'

The figures plotting dependencies are installed as follows:

    pip install 'colour-hdri[plotting]'

The tests suite dependencies are installed as follows:

    pip install 'colour-hdri[tests]'

The documentation building dependencies are installed as follows:

    pip install 'colour-hdri[docs]'

## Usage

### API

The main reference for Colour - HDRI is the complete Sphinx API Reference:

- API Reference

### Examples

Various usage examples are available from the examples directory.

## Contributing

If you would like to contribute to Colour - HDRI, please refer to the following Contributing guide for Colour.

## Bibliography

The bibliography is available in the repository in either BibTeX format or reStructuredText.

## About

Colour - HDRI by Colour Developers
Copyright © 2015-2017 – Colour Developers – colour-science@googlegroups.com
This software is released under terms of New BSD License: http://opensource.org/licenses/BSD-3-Clause
http://github.com/colour-science/colour-hdri