Merge branch 'feature/v0.3.10' into develop

colour-science · Jul 12, 2017 · 124461c · 124461c
2 parents e789c8a + 5915325
commit 124461c
Show file tree

Hide file tree

Showing 225 changed files with 2,233 additions and 2,039 deletions.
diff --git a/BIBLIOGRAPHY.bib b/BIBLIOGRAPHY.bib
diff --git a/BIBLIOGRAPHY.rst b/BIBLIOGRAPHY.rst
diff --git a/README.rst b/README.rst
@@ -41,8 +41,8 @@ Colour Science for Python
 .. |version| image:: https://badge.fury.io/py/colour-science.svg
     :target: https://pypi.python.org/pypi/colour-science
     :alt: Package Version
-.. |zenodo| image:: https://zenodo.org/badge/doi/10.5281/zenodo.376790.png
-    :target: http://dx.doi.org/10.5281/zenodo.376790
+.. |zenodo| image:: https://zenodo.org/badge/doi/10.5281/zenodo.821825.png
+    :target: http://dx.doi.org/10.5281/zenodo.821825
     :alt: DOI
 
 .. end-badges

diff --git a/TODO.rst b/TODO.rst
@@ -4,82 +4,94 @@ Colour - TODO
 TODO
 ----
 
-- colour (20 items in 13 files)
+- colour (22 items in 15 files)
 
-    - appearance (8 items in 5 files)
+    - appearance (7 items in 5 files)
 
         - ciecam02.py
 
-            - (260, 7) # TODO: Compute hue composition.
-            - (702, 7) # TODO: Check for negative values and their handling.
+            - (257, 7) # TODO: Compute hue composition.
 
         - hunt.py
 
-            - (418, 7) # TODO: Implement hue quadrature & composition computation.
-            - (449, 7) # TODO: Implement whiteness-blackness :math:`Q_{wb}` computation.
+            - (384, 7) # TODO: Implement hue quadrature & composition computation.
+            - (415, 7) # TODO: Implement whiteness-blackness :math:`Q_{wb}` computation.
 
         - llab.py
 
-            - (309, 7) # TODO: Implement hue composition computation.
+            - (297, 7) # TODO: Implement hue composition computation.
 
         - nayatani95.py
 
-            - (271, 7) # TODO: Implement hue quadrature & composition computation.
-            - (289, 7) # TODO: Investigate components usage.
+            - (244, 7) # TODO: Implement hue quadrature & composition computation.
+            - (256, 7) # TODO: Investigate components usage.
 
         - rlab.py
 
-            - (246, 7) # TODO: Implement hue composition computation.
+            - (235, 7) # TODO: Implement hue composition computation.
 
-    - colorimetry (2 item in 2 files)
+    - colorimetry (4 items in 3 files)
+
+        - tests (2 items in 1 file)
+
+            - tests_spectrum.py
+
+                - (2352, 11) # TODO: Remove statement whenever we make "Scipy" 0.19.0 the minimum version.
+                - (2834, 11) # TODO: Remove statement whenever we make "Scipy" 0.19.0 the minimum version.
 
         - spectrum.py
 
-            - (1943, 11) # TODO: Provide support for fractional interval like 0.1, etc...
+            - (1920, 11) # TODO: Provide support for fractional interval like 0.1, etc...
 
         - tristimulus.py
 
-            - (686, 11) # TODO: Investigate code vectorisation.
+            - (672, 11) # TODO: Investigate code vectorisation.
 
-    - models (4 item in 3 file)
+    - models (4 items in 3 files)
 
-        - rgb
+        - rgb (4 items in 3 files)
 
             - tests (1 item in 1 file)
 
                 - tests_derivation.py
 
-                    - (302, 15) # TODO: Simplify that monster.
+                    - (275, 11) # TODO: Simplify that monster.
 
             - derivation.py
 
-                - (220, 7) # TODO: Investigate if we return an ndarray here with primaries and whitepoint stacked together.
+                - (215, 7) # TODO: Investigate if we return an ndarray here with primaries and
 
             - rgb_colourspace.py
 
-                - (518, 11) # TODO: Revisit for potential behaviour / type checking.
-                - (545, 11) # TODO: Revisit for potential behaviour / type checking.
+                - (515, 11) # TODO: Revisit for potential behaviour / type checking.
+                - (542, 11) # TODO: Revisit for potential behaviour / type checking.
 
     - notation (5 items in 2 files)
 
         - tests (3 items in 1 file)
 
             - tests_munsell.py
 
-                - (94, 3) # TODO: Investigate if tests can be simplified by using a common valid set of specifications.
-                - (4528, 11) # TODO: This test is covered by the previous class, do we need a dedicated one?
-                - (4574, 11) # TODO: This test is covered by the previous class, do we need a dedicated one?
+                - (67, 3) # TODO: Investigate if tests can be simplified by using a common valid set of specifications.
+                - (4399, 11) # TODO: This test is covered by the previous class, do we need a dedicated one?
+                - (4441, 11) # TODO: This test is covered by the previous class, do we need a dedicated one?
 
         - munsell.py
 
-            - (837, 11) # TODO: Consider refactoring implementation.
-            - (1176, 11) # TODO: Should raise KeyError, need to check the tests.
+            - (802, 11) # TODO: Consider refactoring implementation.
+            - (1129, 11) # TODO: Should raise KeyError, need to check the tests.
+
+    - plotting (1 item in 1 file)
+
+        - colorimetry.py
+
+            - (599, 11) # TODO: Handle condition statement with metadata capabilities.
 
     - volume (1 item in 1 file)
-        
-        -  rgb.py
-            
-            - (319, 7) # TODO: Investigate for generator yielding directly a ndarray.
+
+        - rgb.py
+
+            - (308, 7) # TODO: Investigate for generator yielding directly a ndarray.
 
 About
 -----

diff --git a/colour/__init__.py b/colour/__init__.py
@@ -102,7 +102,7 @@
 
 __major_version__ = '0'
 __minor_version__ = '3'
-__change_version__ = '9'
+__change_version__ = '10'
 __version__ = '.'.join(
     (__major_version__,
      __minor_version__,

diff --git a/colour/biochemistry/michaelis_menten.py b/colour/biochemistry/michaelis_menten.py
@@ -9,6 +9,12 @@
 -   :func:`reaction_rate_MichealisMenten`
 -   :func:`substrate_concentration_MichealisMenten`
 
+See Also
+--------
+`Michaelis-Menten Kinetics
+<http://nbviewer.jupyter.org/github/colour-science/colour-notebooks/\
+blob/master/notebooks/biochemistry/michaelis_menten.ipynb>`_
+
 References
 ----------
 .. [1]  Wikipedia. (n.d.). Michaelis–Menten kinetics. Retrieved April 29, 2017,

diff --git a/colour/colorimetry/tristimulus.py b/colour/colorimetry/tristimulus.py
@@ -65,7 +65,7 @@
 
 ASTME30815_PRACTISE_SHAPE = DEFAULT_SPECTRAL_SHAPE
 """
-*ASTM E308–15* practise shape: (360, 780, 1).
+*ASTM E308-15* practise shape: (360, 780, 1).
 
 ASTME30815_PRACTISE_SHAPE : SpectralShape
 """

diff --git a/colour/colorimetry/yellowness.py b/colour/colorimetry/yellowness.py
@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 """
 Yellowness Index :math:`Y`
-=========================
+==========================
 
 Defines *yellowness* index :math:`Y` computation objects:
 

diff --git a/colour/examples/appearance/examples_ciecam02.py b/colour/examples/appearance/examples_ciecam02.py
@@ -26,8 +26,9 @@
 J = 41.73109113
 C = 0.10470776
 h = 219.04843266
+specification = colour.CIECAM02_Specification(J, C, h)
 message_box(('Converting to "CIE XYZ" tristimulus values using given '
              'parameters:\n'
              '\n\tJ: {0}\n\tC: {1}\n\th: {2}\n\tXYZ_w: {3}\n\tL_A: {4}'
              '\n\tY_b: {5}').format(J, C, h, XYZ_w, L_A, Y_b))
-print(colour.CIECAM02_to_XYZ(J, C, h, XYZ_w, L_A, Y_b))
+print(colour.CIECAM02_to_XYZ(specification, XYZ_w, L_A, Y_b))
diff --git a/colour/plotting/colorimetry.py b/colour/plotting/colorimetry.py
@@ -596,9 +596,10 @@ def multi_lightness_function_plot(functions=None, **kwargs):
             raise KeyError(('"{0}" "Lightness" function not found in factory '
                             '"Lightness" functions: "{1}".').format(
                                 name, sorted(LIGHTNESS_METHODS.keys())))
-
+        # TODO: Handle condition statement with metadata capabilities.
         pylab.plot(
-            samples, [function(x) for x in samples],
+            samples, (function(samples / 100) if
+                      name.lower() == 'fairchild 2010' else function(samples)),
             label='{0}'.format(name),
             linewidth=2)
 

diff --git a/colour/utilities/array.py b/colour/utilities/array.py
@@ -676,4 +676,4 @@ def linear_conversion(a, old_range, new_range):
     in_min, in_max = tsplit(old_range)
     out_min, out_max = tsplit(new_range)
 
-    return (((a - in_min) / (in_max - in_min)) * (out_max - out_min) + out_min)
+    return ((a - in_min) / (in_max - in_min)) * (out_max - out_min) + out_min
diff --git a/docs/colour.adaptation.cie1994.rst b/docs/colour.adaptation.cie1994.rst
@@ -1,5 +1,5 @@
-colour.adaptation.cie1994 Module
-================================
+colour\.adaptation\.cie1994 Module
+==================================
 
 .. automodule:: colour.adaptation.cie1994
     :members:

diff --git a/docs/colour.adaptation.cmccat2000.rst b/docs/colour.adaptation.cmccat2000.rst
@@ -1,5 +1,5 @@
-colour.adaptation.cmccat2000 Module
-===================================
+colour\.adaptation\.cmccat2000 Module
+=====================================
 
 .. automodule:: colour.adaptation.cmccat2000
     :members:

diff --git a/docs/colour.adaptation.dataset.cat.rst b/docs/colour.adaptation.dataset.cat.rst
@@ -1,5 +1,5 @@
-colour.adaptation.dataset.cat Module
-====================================
+colour\.adaptation\.dataset\.cat Module
+=======================================
 
 .. automodule:: colour.adaptation.dataset.cat
     :members:

diff --git a/docs/colour.adaptation.dataset.rst b/docs/colour.adaptation.dataset.rst
@@ -1,5 +1,5 @@
-colour.adaptation.dataset Package
-=================================
+colour\.adaptation\.dataset Package
+===================================
 
 Sub-Modules
 -----------

diff --git a/docs/colour.adaptation.fairchild1990.rst b/docs/colour.adaptation.fairchild1990.rst
@@ -1,5 +1,5 @@
-colour.adaptation.fairchild1990 Module
-======================================
+colour\.adaptation\.fairchild1990 Module
+========================================
 
 .. automodule:: colour.adaptation.fairchild1990
     :members:

diff --git a/docs/colour.adaptation.rst b/docs/colour.adaptation.rst
@@ -1,5 +1,5 @@
-colour.adaptation Package
-=========================
+colour\.adaptation Package
+==========================
 
 Sub-Packages
 ------------

diff --git a/docs/colour.adaptation.vonkries.rst b/docs/colour.adaptation.vonkries.rst
@@ -1,5 +1,5 @@
-colour.adaptation.vonkries Module
-=================================
+colour\.adaptation\.vonkries Module
+===================================
 
 .. automodule:: colour.adaptation.vonkries
     :members:

diff --git a/docs/colour.algebra.coordinates.rst b/docs/colour.algebra.coordinates.rst
@@ -1,5 +1,5 @@
-colour.algebra.coordinates Package
-==================================
+colour\.algebra\.coordinates Package
+====================================
 
 Sub-Modules
 -----------

diff --git a/docs/colour.algebra.coordinates.transformations.rst b/docs/colour.algebra.coordinates.transformations.rst
@@ -1,5 +1,5 @@
-colour.algebra.coordinates.transformations Module
-=================================================
+colour\.algebra\.coordinates\.transformations Module
+====================================================
 
 .. automodule:: colour.algebra.coordinates.transformations
     :members:

diff --git a/docs/colour.algebra.extrapolation.rst b/docs/colour.algebra.extrapolation.rst
@@ -1,5 +1,5 @@
-colour.algebra.extrapolation Module
-===================================
+colour\.algebra\.extrapolation Module
+=====================================
 
 .. automodule:: colour.algebra.extrapolation
     :members:

diff --git a/docs/colour.algebra.geometry.rst b/docs/colour.algebra.geometry.rst
@@ -1,5 +1,5 @@
-colour.algebra.geometry Module
-==============================
+colour\.algebra\.geometry Module
+================================
 
 .. automodule:: colour.algebra.geometry
     :members:

diff --git a/docs/colour.algebra.interpolation.rst b/docs/colour.algebra.interpolation.rst
@@ -1,5 +1,5 @@
-colour.algebra.interpolation Module
-===================================
+colour\.algebra\.interpolation Module
+=====================================
 
 .. automodule:: colour.algebra.interpolation
     :members:

diff --git a/docs/colour.algebra.matrix.rst b/docs/colour.algebra.matrix.rst
@@ -1,5 +1,5 @@
-colour.algebra.matrix Module
-============================
+colour\.algebra\.matrix Module
+==============================
 
 .. automodule:: colour.algebra.matrix
     :members:

diff --git a/docs/colour.algebra.random.rst b/docs/colour.algebra.random.rst
@@ -1,5 +1,5 @@
-colour.algebra.random Module
-============================
+colour\.algebra\.random Module
+==============================
 
 .. automodule:: colour.algebra.random
     :members:

diff --git a/docs/colour.algebra.rst b/docs/colour.algebra.rst
@@ -1,5 +1,5 @@
-colour.algebra Package
-======================
+colour\.algebra Package
+=======================
 
 Sub-Packages
 ------------

diff --git a/docs/colour.appearance.atd95.rst b/docs/colour.appearance.atd95.rst
@@ -1,5 +1,5 @@
-colour.appearance.atd95 Module
-==============================
+colour\.appearance\.atd95 Module
+================================
 
 .. automodule:: colour.appearance.atd95
     :members:

diff --git a/docs/colour.appearance.ciecam02.rst b/docs/colour.appearance.ciecam02.rst
@@ -1,5 +1,5 @@
-colour.appearance.ciecam02 Module
-=================================
+colour\.appearance\.ciecam02 Module
+===================================
 
 .. automodule:: colour.appearance.ciecam02
     :members:

diff --git a/docs/colour.appearance.hunt.rst b/docs/colour.appearance.hunt.rst
@@ -1,5 +1,5 @@
-colour.appearance.hunt Module
-=============================
+colour\.appearance\.hunt Module
+===============================
 
 .. automodule:: colour.appearance.hunt
     :members:

diff --git a/docs/colour.appearance.llab.rst b/docs/colour.appearance.llab.rst
@@ -1,5 +1,5 @@
-colour.appearance.llab Module
-=============================
+colour\.appearance\.llab Module
+===============================
 
 .. automodule:: colour.appearance.llab
     :members:

diff --git a/docs/colour.appearance.nayatani95.rst b/docs/colour.appearance.nayatani95.rst
@@ -1,5 +1,5 @@
-colour.appearance.nayatani95 Module
-===================================
+colour\.appearance\.nayatani95 Module
+=====================================
 
 .. automodule:: colour.appearance.nayatani95
     :members:

diff --git a/docs/colour.appearance.rlab.rst b/docs/colour.appearance.rlab.rst
@@ -1,5 +1,5 @@
-colour.appearance.rlab Module
-=============================
+colour\.appearance\.rlab Module
+===============================
 
 .. automodule:: colour.appearance.rlab
     :members:

diff --git a/docs/colour.appearance.rst b/docs/colour.appearance.rst
@@ -1,5 +1,5 @@
-colour.appearance Package
-=========================
+colour\.appearance Package
+==========================
 
 Sub-Modules
 -----------

diff --git a/docs/colour.biochemistry.michaelis_menten.rst b/docs/colour.biochemistry.michaelis_menten.rst
@@ -0,0 +1,7 @@
+colour\.biochemistry\.michaelis\_menten Module
+==============================================
+
+.. automodule:: colour.biochemistry.michaelis_menten
+    :members:
+    :undoc-members:
+    :show-inheritance: