Colour - HDRI
=============
.. start-badges
|actions| |coveralls| |codacy| |version|
.. |actions| image:: https://img.shields.io/github/actions/workflow/status/colour-science/colour-hdri/.github/workflows/continuous-integration-quality-unit-tests.yml?branch=develop&style=flat-square
:target: https://github.com/colour-science/colour-hdri/actions
:alt: Develop Build Status
.. |coveralls| image:: http://img.shields.io/coveralls/colour-science/colour-hdri/develop.svg?style=flat-square
:target: https://coveralls.io/r/colour-science/colour-hdri
:alt: Coverage Status
.. |codacy| image:: https://img.shields.io/codacy/grade/f422dc0703dd4653b2b766217c745813/develop.svg?style=flat-square
:target: https://www.codacy.com/app/colour-science/colour-hdri
:alt: Code Grade
.. |version| image:: https://img.shields.io/pypi/v/colour-hdri.svg?style=flat-square
:target: https://pypi.org/project/colour-hdri
:alt: Package Version
.. end-badges
A `Python <https://www.python.org>`__ package implementing various
HDRI processing algorithms.
It is open source and freely available under the
`BSD-3-Clause <https://opensource.org/licenses/BSD-3-Clause>`__ terms.
.. image:: https://raw.githubusercontent.com/colour-science/colour-hdri/master/docs/_static/Radiance_001.png
.. contents:: **Table of Contents**
:backlinks: none
:depth: 2
.. sectnum::
Features
--------
The following features are available:
- HDRI 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
- Digital Still Camera (DSC) Exposure Model
- Raw Processing Helpers
- Vignette Characterisation & Correction
Examples
^^^^^^^^
Various usage examples are available from the
`examples directory <https://github.com/colour-science/colour-hdri/tree/master/colour_hdri/examples>`__.
User Guide
----------
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 <https://git-scm.com/book/en/v2/Git-Tools-Submodules>`__
when cloning the
`repository <https://github.com/colour-science/colour-hdri>`__.
Primary Dependencies
~~~~~~~~~~~~~~~~~~~~
**Colour - HDRI** requires various dependencies in order to run:
- `python >= 3.9, < 4 <https://www.python.org/download/releases>`__
- `colour-science >= 4.3 <https://pypi.org/project/colour-science>`__
- `imageio >= 2, < 3 <https://imageio.github.io>`__
- `numpy >= 1.22, < 2 <https://pypi.org/project/numpy>`__
- `scipy >= 1.8, < 2 <https://pypi.org/project/scipy>`__
Optional Features Dependencies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- `colour-demosaicing <https://pypi.org/project/colour-demosaicing>`__
- `Adobe DNG Converter <https://www.adobe.com/support/downloads/product.jsp?product=106&platform=Mac>`__
- `dcraw <https://www.cybercom.net/~dcoffin/dcraw>`__
- `ExifTool <http://www.sno.phy.queensu.ca/~phil/exiftool>`__
- `rawpy <https://pypi.org/project/rawpy>`__
Pypi
~~~~
Once the dependencies are satisfied, **Colour - HDRI** can be installed from
the `Python Package Index <http://pypi.python.org/pypi/colour-hdri>`__ by
issuing this command in a shell::
pip install --user colour-hdri
The optional features dependencies are installed as follows::
pip install --user 'colour-hdri[optional]'
The figures plotting dependencies are installed as follows::
pip install --user 'colour-hdri[plotting]'
The overall development dependencies are installed as follows::
pip install --user 'colour-hdri[development]'
Contributing
^^^^^^^^^^^^
If you would like to contribute to `Colour - HDRI <https://github.com/colour-science/colour-hdri>`__,
please refer to the following `Contributing <https://www.colour-science.org/contributing>`__
guide for `Colour <https://github.com/colour-science/colour>`__.
Bibliography
^^^^^^^^^^^^
The bibliography is available in the repository in
`BibTeX <https://github.com/colour-science/colour-hdri/blob/develop/BIBLIOGRAPHY.bib>`__
format.
API Reference
-------------
The main technical reference for `Colour - HDRI <https://github.com/colour-science/colour-hdri>`__
is the `API Reference <https://colour-hdri.readthedocs.io/en/latest/reference.html>`__.
See Also
--------
Publications
^^^^^^^^^^^^
- `Advanced High Dynamic Range Imaging: Theory and Practice <https://dl.acm.org/doi/book/10.5555/1996408>`__ by Banterle, F. et al.
*Advanced High Dynamic Range Imaging: Theory and Practice* was used as a
reference for some of the algorithms of **Colour - HDRI**.
Software
^^^^^^^^
**C/C++**
- `OpenCV <https://opencv.org>`__ by Bradski, G.
- `Piccante <https://github.com/cnr-isti-vclab/piccante>`__ by Banterle, F. and Benedetti, L.,
*Piccante* was used to verify the Grossberg (2003) Histogram Based Image Sampling.
**Matlab**
- `HDR Toolbox <https://github.com/banterle/HDR_Toolbox>`__ by Banterle, F. et al.
Code of Conduct
---------------
The *Code of Conduct*, adapted from the `Contributor Covenant 1.4 <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>`__,
is available on the `Code of Conduct <https://www.colour-science.org/code-of-conduct>`__ page.
Contact & Social
----------------
The *Colour Developers* can be reached via different means:
- `Email <mailto:colour-developers@colour-science.org>`__
- `Facebook <https://www.facebook.com/python.colour.science>`__
- `Github Discussions <https://github.com/colour-science/colour-hdri/discussions>`__
- `Gitter <https://gitter.im/colour-science/colour>`__
- `Twitter <https://twitter.com/colour_science>`__
About
-----
| **Colour - HDRI** by Colour Developers
| Copyright 2015 Colour Developers – `colour-developers@colour-science.org <colour-developers@colour-science.org>`__
| This software is released under terms of BSD-3-Clause: https://opensource.org/licenses/BSD-3-Clause
| `https://github.com/colour-science/colour-hdri <https://github.com/colour-science/colour-hdri>`__
Raw data
{
"_id": null,
"home_page": "https://www.colour-science.org/",
"name": "colour-hdri",
"maintainer": "Colour Developers",
"docs_url": null,
"requires_python": ">=3.9,<3.13",
"maintainer_email": "colour-developers@colour-science.org",
"keywords": "color,color-science,color-space,color-spaces,colorspace,colorspaces,colour,colour-science,colour-space,colour-spaces,colourspace,colourspaces,hdr,hdr-image,hdri,hdri-image,python,raw,tone-mapping,tonemapping",
"author": "Colour Developers",
"author_email": "colour-developers@colour-science.org",
"download_url": "https://files.pythonhosted.org/packages/04/bb/9639470d4be21a89ed7a563bdf0c9f514289a9ab32731add3775473caa2e/colour_hdri-0.2.3.tar.gz",
"platform": null,
"description": "Colour - HDRI\n=============\n\n.. start-badges\n\n|actions| |coveralls| |codacy| |version|\n\n.. |actions| image:: https://img.shields.io/github/actions/workflow/status/colour-science/colour-hdri/.github/workflows/continuous-integration-quality-unit-tests.yml?branch=develop&style=flat-square\n :target: https://github.com/colour-science/colour-hdri/actions\n :alt: Develop Build Status\n.. |coveralls| image:: http://img.shields.io/coveralls/colour-science/colour-hdri/develop.svg?style=flat-square\n :target: https://coveralls.io/r/colour-science/colour-hdri\n :alt: Coverage Status\n.. |codacy| image:: https://img.shields.io/codacy/grade/f422dc0703dd4653b2b766217c745813/develop.svg?style=flat-square\n :target: https://www.codacy.com/app/colour-science/colour-hdri\n :alt: Code Grade\n.. |version| image:: https://img.shields.io/pypi/v/colour-hdri.svg?style=flat-square\n :target: https://pypi.org/project/colour-hdri\n :alt: Package Version\n\n.. end-badges\n\nA `Python <https://www.python.org>`__ package implementing various\nHDRI processing algorithms.\n\nIt is open source and freely available under the\n`BSD-3-Clause <https://opensource.org/licenses/BSD-3-Clause>`__ terms.\n\n.. image:: https://raw.githubusercontent.com/colour-science/colour-hdri/master/docs/_static/Radiance_001.png\n\n.. contents:: **Table of Contents**\n :backlinks: none\n :depth: 2\n\n.. sectnum::\n\nFeatures\n--------\n\nThe following features are available:\n\n- HDRI Generation\n- Debevec (1997) Camera Response Function Computation\n- Grossberg (2003) Histogram Based Image Sampling\n- Variance Minimization Light Probe Sampling\n- Global Tonemapping Operators\n- Adobe DNG SDK Colour Processing\n- Absolute Luminance Calibration\n- Digital Still Camera (DSC) Exposure Model\n- Raw Processing Helpers\n- Vignette Characterisation & Correction\n\nExamples\n^^^^^^^^\n\nVarious usage examples are available from the\n`examples directory <https://github.com/colour-science/colour-hdri/tree/master/colour_hdri/examples>`__.\n\nUser Guide\n----------\n\nInstallation\n^^^^^^^^^^^^\n\nBecause of their size, the resources dependencies needed to run the various\nexamples and unit tests are not provided within the Pypi package. They are\nseparately available as\n`Git Submodules <https://git-scm.com/book/en/v2/Git-Tools-Submodules>`__\nwhen cloning the\n`repository <https://github.com/colour-science/colour-hdri>`__.\n\nPrimary Dependencies\n~~~~~~~~~~~~~~~~~~~~\n\n**Colour - HDRI** requires various dependencies in order to run:\n\n- `python >= 3.9, < 4 <https://www.python.org/download/releases>`__\n- `colour-science >= 4.3 <https://pypi.org/project/colour-science>`__\n- `imageio >= 2, < 3 <https://imageio.github.io>`__\n- `numpy >= 1.22, < 2 <https://pypi.org/project/numpy>`__\n- `scipy >= 1.8, < 2 <https://pypi.org/project/scipy>`__\n\nOptional Features Dependencies\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n- `colour-demosaicing <https://pypi.org/project/colour-demosaicing>`__\n- `Adobe DNG Converter <https://www.adobe.com/support/downloads/product.jsp?product=106&platform=Mac>`__\n- `dcraw <https://www.cybercom.net/~dcoffin/dcraw>`__\n- `ExifTool <http://www.sno.phy.queensu.ca/~phil/exiftool>`__\n- `rawpy <https://pypi.org/project/rawpy>`__\n\nPypi\n~~~~\n\nOnce the dependencies are satisfied, **Colour - HDRI** can be installed from\nthe `Python Package Index <http://pypi.python.org/pypi/colour-hdri>`__ by\nissuing this command in a shell::\n\n pip install --user colour-hdri\n\nThe optional features dependencies are installed as follows::\n\n pip install --user 'colour-hdri[optional]'\n\nThe figures plotting dependencies are installed as follows::\n\n pip install --user 'colour-hdri[plotting]'\n\nThe overall development dependencies are installed as follows::\n\n pip install --user 'colour-hdri[development]'\n\nContributing\n^^^^^^^^^^^^\n\nIf you would like to contribute to `Colour - HDRI <https://github.com/colour-science/colour-hdri>`__,\nplease refer to the following `Contributing <https://www.colour-science.org/contributing>`__\nguide for `Colour <https://github.com/colour-science/colour>`__.\n\nBibliography\n^^^^^^^^^^^^\n\nThe bibliography is available in the repository in\n`BibTeX <https://github.com/colour-science/colour-hdri/blob/develop/BIBLIOGRAPHY.bib>`__\nformat.\n\nAPI Reference\n-------------\n\nThe main technical reference for `Colour - HDRI <https://github.com/colour-science/colour-hdri>`__\nis the `API Reference <https://colour-hdri.readthedocs.io/en/latest/reference.html>`__.\n\nSee Also\n--------\n\nPublications\n^^^^^^^^^^^^\n\n- `Advanced High Dynamic Range Imaging: Theory and Practice <https://dl.acm.org/doi/book/10.5555/1996408>`__ by Banterle, F. et al.\n\n*Advanced High Dynamic Range Imaging: Theory and Practice* was used as a\nreference for some of the algorithms of **Colour - HDRI**.\n\nSoftware\n^^^^^^^^\n\n**C/C++**\n\n- `OpenCV <https://opencv.org>`__ by Bradski, G.\n- `Piccante <https://github.com/cnr-isti-vclab/piccante>`__ by Banterle, F. and Benedetti, L.,\n\n*Piccante* was used to verify the Grossberg (2003) Histogram Based Image Sampling.\n\n**Matlab**\n\n- `HDR Toolbox <https://github.com/banterle/HDR_Toolbox>`__ by Banterle, F. et al.\n\nCode of Conduct\n---------------\n\nThe *Code of Conduct*, adapted from the `Contributor Covenant 1.4 <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>`__,\nis available on the `Code of Conduct <https://www.colour-science.org/code-of-conduct>`__ page.\n\nContact & Social\n----------------\n\nThe *Colour Developers* can be reached via different means:\n\n- `Email <mailto:colour-developers@colour-science.org>`__\n- `Facebook <https://www.facebook.com/python.colour.science>`__\n- `Github Discussions <https://github.com/colour-science/colour-hdri/discussions>`__\n- `Gitter <https://gitter.im/colour-science/colour>`__\n- `Twitter <https://twitter.com/colour_science>`__\n\nAbout\n-----\n\n| **Colour - HDRI** by Colour Developers\n| Copyright 2015 Colour Developers \u2013 `colour-developers@colour-science.org <colour-developers@colour-science.org>`__\n| This software is released under terms of BSD-3-Clause: https://opensource.org/licenses/BSD-3-Clause\n| `https://github.com/colour-science/colour-hdri <https://github.com/colour-science/colour-hdri>`__\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "HDRI processing algorithms for Python",
"version": "0.2.3",
"project_urls": {
"Homepage": "https://www.colour-science.org/",
"Repository": "https://github.com/colour-science/colour-hdri"
},
"split_keywords": [
"color",
"color-science",
"color-space",
"color-spaces",
"colorspace",
"colorspaces",
"colour",
"colour-science",
"colour-space",
"colour-spaces",
"colourspace",
"colourspaces",
"hdr",
"hdr-image",
"hdri",
"hdri-image",
"python",
"raw",
"tone-mapping",
"tonemapping"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "95eb37ad98f4ecb461f7f37611dcc0a11886536a97e3e5f1a53bea421e3f0268",
"md5": "be583cb90dd86e9af4c701f30111cfd4",
"sha256": "523bda3582dcc1b787cd7852ffb90ed5e1dc9dbe8df5d00da112af53d5302add"
},
"downloads": -1,
"filename": "colour_hdri-0.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "be583cb90dd86e9af4c701f30111cfd4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<3.13",
"size": 9296916,
"upload_time": "2023-12-20T09:33:27",
"upload_time_iso_8601": "2023-12-20T09:33:27.807472Z",
"url": "https://files.pythonhosted.org/packages/95/eb/37ad98f4ecb461f7f37611dcc0a11886536a97e3e5f1a53bea421e3f0268/colour_hdri-0.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "04bb9639470d4be21a89ed7a563bdf0c9f514289a9ab32731add3775473caa2e",
"md5": "a68ffc133dc17556c386aa931f84da0c",
"sha256": "290fd707cc6a693384784d31530ade9f15e8542738edc73e9682e573b11a29db"
},
"downloads": -1,
"filename": "colour_hdri-0.2.3.tar.gz",
"has_sig": false,
"md5_digest": "a68ffc133dc17556c386aa931f84da0c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<3.13",
"size": 9272965,
"upload_time": "2023-12-20T09:33:08",
"upload_time_iso_8601": "2023-12-20T09:33:08.309200Z",
"url": "https://files.pythonhosted.org/packages/04/bb/9639470d4be21a89ed7a563bdf0c9f514289a9ab32731add3775473caa2e/colour_hdri-0.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-20 09:33:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "colour-science",
"github_project": "colour-hdri",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "colour-hdri"
}
JSON
