Source code for colour.colorimetry.cmfs

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""
Colour Matching Functions
=========================

Defines colour matching functions classes for the dataset from
:mod:`colour.colorimetry.dataset.cmfs`:

-   :class:`LMS_ConeFundamentals`: Implements support for the
    Stockman and Sharpe *LMS* cone fundamentals colour matching functions.
-   :class:`RGB_ColourMatchingFunctions`: Implements support for the *CIE RGB*
    colour matching functions.
-   :class:`XYZ_ColourMatchingFunctions`: Implements support for the *CIE*
    Standard Observers *XYZ* colour matching functions.

See Also
--------
`Colour Matching Functions IPython Notebook
<http://nbviewer.ipython.org/github/colour-science/colour-ipython/blob/master/notebooks/colorimetry/cmfs.ipynb>`_  # noqa
colour.colorimetry.dataset.cmfs,
colour.colorimetry.spectrum.TriSpectralPowerDistribution
"""

from __future__ import division, unicode_literals

from colour.colorimetry import TriSpectralPowerDistribution

__author__ = 'Colour Developers'
__copyright__ = 'Copyright (C) 2013 - 2014 - Colour Developers'
__license__ = 'New BSD License - http://opensource.org/licenses/BSD-3-Clause'
__maintainer__ = 'Colour Developers'
__email__ = 'colour-science@googlegroups.com'
__status__ = 'Production'

__all__ = ['LMS_ConeFundamentals',
           'RGB_ColourMatchingFunctions',
           'XYZ_ColourMatchingFunctions']


[docs]class LMS_ConeFundamentals(TriSpectralPowerDistribution): """ Implements support for the Stockman and Sharpe *LMS* cone fundamentals colour matching functions. Parameters ---------- name : unicode *LMS* colour matching functions name. data : dict *LMS* colour matching functions. title : unicode, optional *LMS* colour matching functions title for figures. Attributes ---------- l_bar m_bar s_bar """ def __init__(self, name, data, title=None): TriSpectralPowerDistribution.__init__(self, name, data, mapping={'x': 'l_bar', 'y': 'm_bar', 'z': 's_bar'}, labels={'x': '$\\bar{l}$', 'y': '$\\bar{m}$', 'z': '$\\bar{s}$'}, title=title) @property def l_bar(self): """ Property for **self.x** attribute. Returns ------- SpectralPowerDistribution self.x Warning ------- :attr:`LMS_ConeFundamentals.l_bar` is read only. """ return self.x @l_bar.setter
[docs] def l_bar(self, value): """ Setter for **self.x** attribute. Parameters ---------- value : object Attribute value. """ raise AttributeError('"{0}" attribute is read only!'.format('l_bar'))
@property def m_bar(self): """ Property for **self.y** attribute. Returns ------- SpectralPowerDistribution self.y Warning ------- :attr:`LMS_ConeFundamentals.m_bar` is read only. """ return self.y @m_bar.setter
[docs] def m_bar(self, value): """ Setter for **self.y** attribute. Parameters ---------- value : object Attribute value. """ raise AttributeError('"{0}" attribute is read only!'.format('m_bar'))
@property def s_bar(self): """ Property for **self.z** attribute. Returns ------- SpectralPowerDistribution self.z Warning ------- :attr:`LMS_ConeFundamentals.s_bar` is read only. """ return self.z @s_bar.setter
[docs] def s_bar(self, value): """ Setter for **self.z** attribute. Parameters ---------- value : object Attribute value. """ raise AttributeError('"{0}" attribute is read only!'.format('s_bar'))
[docs]class RGB_ColourMatchingFunctions(TriSpectralPowerDistribution): """ Implements support for the *CIE RGB* colour matching functions. Parameters ---------- name : unicode *CIE RGB* colour matching functions name. data : dict *CIE RGB* colour matching functions. title : unicode, optional *CIE RGB* colour matching functions title for figures. Attributes ---------- r_bar g_bar b_bar """ def __init__(self, name, data, title=None): TriSpectralPowerDistribution.__init__(self, name, data, mapping={'x': 'r_bar', 'y': 'g_bar', 'z': 'b_bar'}, labels={'x': '$\\bar{r}$', 'y': '$\\bar{g}$', 'z': '$\\bar{b}$'}, title=title) @property def r_bar(self): """ Property for **self.x** attribute. Returns ------- SpectralPowerDistribution self.x Warning ------- :attr:`RGB_ColourMatchingFunctions.r_bar` is read only. """ return self.x @r_bar.setter
[docs] def r_bar(self, value): """ Setter for **self.x** attribute. Parameters ---------- value : object Attribute value. """ raise AttributeError('"{0}" attribute is read only!'.format('r_bar'))
@property def g_bar(self): """ Property for **self.y** attribute. Returns ------- SpectralPowerDistribution self.y Warning ------- :attr:`RGB_ColourMatchingFunctions.g_bar` is read only. """ return self.y @g_bar.setter
[docs] def g_bar(self, value): """ Setter for **self.y** attribute. Parameters ---------- value : object Attribute value. """ raise AttributeError('"{0}" attribute is read only!'.format('g_bar'))
@property def b_bar(self): """ Property for **self.z** attribute. Returns ------- SpectralPowerDistribution self.z Warning ------- :attr:`RGB_ColourMatchingFunctions.b_bar` is read only. """ return self.z @b_bar.setter
[docs] def b_bar(self, value): """ Setter for **self.z** attribute. Parameters ---------- value : object Attribute value. """ raise AttributeError('"{0}" attribute is read only!'.format('b_bar'))
[docs]class XYZ_ColourMatchingFunctions(TriSpectralPowerDistribution): """ Implements support for the *CIE* Standard Observers *XYZ* colour matching functions. Parameters ---------- name : unicode *CIE* Standard Observer *XYZ* colour matching functions name. data : dict *CIE* Standard Observer *XYZ* colour matching functions. title : unicode, optional *CIE* Standard Observer *XYZ* colour matching functions title for figures. Attributes ---------- x_bar y_bar z_bar """ def __init__(self, name, data, title=None): TriSpectralPowerDistribution.__init__(self, name, data, mapping={'x': 'x_bar', 'y': 'y_bar', 'z': 'z_bar'}, labels={'x': '$\\bar{x}$', 'y': '$\\bar{y}$', 'z': '$\\bar{z}$'}, title=title) @property def x_bar(self): """ Property for **self.x** attribute. Returns ------- SpectralPowerDistribution self.x Warning ------- :attr:`XYZ_ColourMatchingFunctions.x_bar` is read only. """ return self.x @x_bar.setter
[docs] def x_bar(self, value): """ Setter for **self.x** attribute. Parameters ---------- value : object Attribute value. """ raise AttributeError('"{0}" attribute is read only!'.format('x_bar'))
@property def y_bar(self): """ Property for **self.y** attribute. Returns ------- SpectralPowerDistribution self.y Warning ------- :attr:`XYZ_ColourMatchingFunctions.y_bar` is read only. """ return self.y @y_bar.setter
[docs] def y_bar(self, value): """ Setter for **self.y** attribute. Parameters ---------- value : object Attribute value. """ raise AttributeError('"{0}" attribute is read only!'.format('y_bar'))
@property def z_bar(self): """ Property for **self.z** attribute. Returns ------- SpectralPowerDistribution self.z Warning ------- :attr:`XYZ_ColourMatchingFunctions.z_bar` is read only. """ return self.z @z_bar.setter
[docs] def z_bar(self, value): """ Setter for **self.z** attribute. Parameters ---------- value : object Attribute value. """ raise AttributeError('"{0}" attribute is read only!'.format('z_bar'))