From 3a812861f52174c98654e2bfff7fb43175dbe3b9 Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Sat, 13 May 2023 03:03:32 +1200 Subject: [PATCH] Update various docstrings. --- colour/characterisation/aces_it.py | 2 +- colour/models/osa_ucs.py | 2 +- colour/quality/ssi.py | 2 +- colour/recovery/jakob2019.py | 2 +- colour/recovery/meng2015.py | 2 +- colour/temperature/cie_d.py | 2 +- colour/temperature/hernandez1999.py | 2 +- colour/temperature/kang2002.py | 2 +- colour/temperature/krystek1985.py | 2 +- colour/temperature/mccamy1992.py | 2 +- colour/temperature/planck1900.py | 2 +- 11 files changed, 11 insertions(+), 11 deletions(-) diff --git a/colour/characterisation/aces_it.py b/colour/characterisation/aces_it.py index ec7917b34d..157a7f8ddc 100644 --- a/colour/characterisation/aces_it.py +++ b/colour/characterisation/aces_it.py @@ -1054,7 +1054,7 @@ def matrix_idt( """ Compute an *Input Device Transform* (IDT) matrix for given camera *RGB* spectral sensitivities, illuminant, training data, standard observer colour - matching functions and optimization settings according to *RAW to ACES* v1 + matching functions and optimisation settings according to *RAW to ACES* v1 and *P-2013-001* procedures. Parameters diff --git a/colour/models/osa_ucs.py b/colour/models/osa_ucs.py index 4bbeee3fb5..fb3bfd44ad 100644 --- a/colour/models/osa_ucs.py +++ b/colour/models/osa_ucs.py @@ -170,7 +170,7 @@ def OSA_UCS_to_XYZ( -------- There is no analytical inverse transformation from *OSA UCS* to :math:`Ljg` lightness, jaune (yellowness), and greenness to *CIE XYZ* tristimulus - values, the current implementation relies on optimization using + values, the current implementation relies on optimisation using :func:`scipy.optimize.fmin` definition and thus has reduced precision and poor performance. diff --git a/colour/quality/ssi.py b/colour/quality/ssi.py index 22b17f9369..5f5981305c 100644 --- a/colour/quality/ssi.py +++ b/colour/quality/ssi.py @@ -60,7 +60,7 @@ def spectral_similarity_index( Reference spectral distribution. round_result Whether to round the result/output. This is particularly useful when - using SSI in an optimization routine. Default is *True*. + using SSI in an optimisation routine. Default is *True*. Returns ------- diff --git a/colour/recovery/jakob2019.py b/colour/recovery/jakob2019.py index c22d9adacc..f6c0929cc9 100644 --- a/colour/recovery/jakob2019.py +++ b/colour/recovery/jakob2019.py @@ -626,7 +626,7 @@ class LUT3D_Jakob2019: """ Define a class for working with pre-computed lookup tables for the *Jakob and Hanika (2019)* spectral upsampling method. It allows significant - time savings by performing the expensive numerical optimization ahead of + time savings by performing the expensive numerical optimisation ahead of time and storing the results in a file. The file format is compatible with the code and *\\*.coeff* files in the diff --git a/colour/recovery/meng2015.py b/colour/recovery/meng2015.py index 9d323d957f..4520bd5ad4 100644 --- a/colour/recovery/meng2015.py +++ b/colour/recovery/meng2015.py @@ -203,7 +203,7 @@ def constraint_function(a: ArrayLike) -> NDArrayFloat: if not result.success: raise RuntimeError( - f"Optimization failed for {XYZ} after {result.nit} iterations: " + f"Optimisation failed for {XYZ} after {result.nit} iterations: " f'"{result.message}".' ) diff --git a/colour/temperature/cie_d.py b/colour/temperature/cie_d.py index 37cd1cda9a..7bddaedb04 100644 --- a/colour/temperature/cie_d.py +++ b/colour/temperature/cie_d.py @@ -66,7 +66,7 @@ def xy_to_CCT_CIE_D( The *CIE Illuminant D Series* method does not give an analytical inverse transformation to compute the correlated colour temperature :math:`T_{cp}` from given *CIE xy* chromaticity coordinates, the current implementation - relies on optimization using :func:`scipy.optimize.minimize` definition and + relies on optimisation using :func:`scipy.optimize.minimize` definition and thus has reduced precision and poor performance. References diff --git a/colour/temperature/hernandez1999.py b/colour/temperature/hernandez1999.py index b0f766abac..7c6a69f2bb 100644 --- a/colour/temperature/hernandez1999.py +++ b/colour/temperature/hernandez1999.py @@ -121,7 +121,7 @@ def CCT_to_xy_Hernandez1999( function and might produce unexpected results. It is given for consistency with other correlated colour temperature computation methods but should be avoided for practical applications. The current implementation relies on - optimization using :func:`scipy.optimize.minimize` definition and thus has + optimisation using :func:`scipy.optimize.minimize` definition and thus has reduced precision and poor performance. References diff --git a/colour/temperature/kang2002.py b/colour/temperature/kang2002.py index ac4a4475b5..7840e4ef30 100644 --- a/colour/temperature/kang2002.py +++ b/colour/temperature/kang2002.py @@ -64,7 +64,7 @@ def xy_to_CCT_Kang2002( *Kang et al. (2002)* does not give an analytical inverse transformation to compute the correlated colour temperature :math:`T_{cp}` from given *CIE xy* chromaticity coordinates, the current implementation relies on - optimization using :func:`scipy.optimize.minimize` definition and thus has + optimisation using :func:`scipy.optimize.minimize` definition and thus has reduced precision and poor performance. References diff --git a/colour/temperature/krystek1985.py b/colour/temperature/krystek1985.py index 5ff019a844..e7a0097cc3 100644 --- a/colour/temperature/krystek1985.py +++ b/colour/temperature/krystek1985.py @@ -65,7 +65,7 @@ def uv_to_CCT_Krystek1985( *Krystek (1985)* does not give an analytical inverse transformation to compute the correlated colour temperature :math:`T_{cp}` from given *CIE UCS* colourspace *uv* chromaticity coordinates, the current - implementation relies on optimization using :func:`scipy.optimize.minimize` + implementation relies on optimisation using :func:`scipy.optimize.minimize` definition and thus has reduced precision and poor performance. Notes diff --git a/colour/temperature/mccamy1992.py b/colour/temperature/mccamy1992.py index 3cf5d1bcff..3e2a38d6d5 100644 --- a/colour/temperature/mccamy1992.py +++ b/colour/temperature/mccamy1992.py @@ -104,7 +104,7 @@ def CCT_to_xy_McCamy1992( might produce unexpected results. It is given for consistency with other correlated colour temperature computation methods but should be avoided for practical applications. The current implementation relies on - optimization using :func:`scipy.optimize.minimize` definition and thus has + optimisation using :func:`scipy.optimize.minimize` definition and thus has reduced precision and poor performance. References diff --git a/colour/temperature/planck1900.py b/colour/temperature/planck1900.py index 581fe7ddde..15db918339 100644 --- a/colour/temperature/planck1900.py +++ b/colour/temperature/planck1900.py @@ -70,7 +70,7 @@ def uv_to_CCT_Planck1900( Warnings -------- - The current implementation relies on optimization using + The current implementation relies on optimisation using :func:`scipy.optimize.minimize` definition and thus has reduced precision and poor performance.