Coverage for colour/constants/cie.py: 100%

1""" 

2CIE Constants 

3============= 

4 

5Define *CIE* constants. 

6 

7References 

8---------- 

9- :cite:`Wyszecki2000s` : Wyszecki, Günther, & Stiles, W. S. (2000). 

10 Standard Photometric Observers. In Color Science: Concepts and Methods, 

11 Quantitative Data and Formulae (pp. 256-259,395). Wiley. 

12 ISBN:978-0-471-39918-6 

13""" 

14 

15from colour.utilities.documentation import DocstringFloat, is_documentation_building 

16 

17__author__ = "Colour Developers" 

18__copyright__ = "Copyright 2013 Colour Developers" 

19__license__ = "BSD-3-Clause - https://opensource.org/licenses/BSD-3-Clause" 

20__maintainer__ = "Colour Developers" 

21__email__ = "colour-developers@colour-science.org" 

22__status__ = "Production" 

23 

24__all__ = [ 

25 "CONSTANT_K_M", 

26 "CONSTANT_KP_M", 

27] 

28 

29CONSTANT_K_M: float = 683 

30if is_documentation_building(): # pragma: no cover 

31 CONSTANT_K_M = DocstringFloat(CONSTANT_K_M) 

32 CONSTANT_K_M.__doc__ = """ 

33Rounded maximum photopic luminous efficiency :math:`K_m` value in 

34:math:`lm\\cdot W^{-1}`. 

35 

36Notes 

37----- 

38- To be adequate for all practical applications the :math:`K_m` value has 

39 been rounded from the original 683.002 value. 

40 

41References 

42---------- 

43:cite:`Wyszecki2000s` 

44""" 

45 

46CONSTANT_KP_M: float = 1700 

47if is_documentation_building(): # pragma: no cover 

48 CONSTANT_KP_M = DocstringFloat(CONSTANT_KP_M) 

49 CONSTANT_KP_M.__doc__ = """ 

50Rounded maximum scotopic luminous efficiency :math:`K^{\\prime}_m` value in 

51:math:`lm\\cdot W^{-1}`. 

52 

53Notes 

54----- 

55- To be adequate for all practical applications the :math:`K^{\\prime}_m` 

56 value has been rounded from the original 1700.06 value. 

57 

58References 

59---------- 

60:cite:`Wyszecki2000s` 

61"""