From 817b1aa9a7456cf4c37e93adbf374b950d4cb0cf Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Thu, 23 Apr 2020 19:28:01 +1200 Subject: [PATCH] Update various docstrings. --- colour/plotting/characterisation.py | 8 +++- colour/plotting/colorimetry.py | 51 +++++++++++++++++------- colour/plotting/common.py | 28 +++++++++++--- colour/plotting/diagrams.py | 50 ++++++++++++++---------- colour/plotting/models.py | 60 ++++++++++++++++++++--------- colour/plotting/notation.py | 8 +++- colour/plotting/phenomena.py | 8 +++- colour/plotting/temperature.py | 12 ++++-- colour/plotting/volume.py | 16 ++++++-- 9 files changed, 170 insertions(+), 71 deletions(-) diff --git a/colour/plotting/characterisation.py b/colour/plotting/characterisation.py index a64349f54a..4a11e964d2 100644 --- a/colour/plotting/characterisation.py +++ b/colour/plotting/characterisation.py @@ -43,7 +43,9 @@ def plot_single_colour_checker(colour_checker='ColorChecker 2005', **kwargs): Parameters ---------- colour_checker : unicode, optional - Color checker name. + Color checker to plot. ``colour_checker`` can be of any type or form + supported by the + :func:`colour.plotting.filter_colour_checkers` definition. Other Parameters ---------------- @@ -87,7 +89,9 @@ def plot_multi_colour_checkers(colour_checkers=None, **kwargs): Parameters ---------- colour_checkers : array_like, optional - Color checker names, must be less than or equal to 2 names. + Color checker to plot, count must be less than or equal to 2. + ``colour_checkers`` elements can be of any type or form supported by + the :func:`colour.plotting.filter_colour_checkers` definition. Other Parameters ---------------- diff --git a/colour/plotting/colorimetry.py b/colour/plotting/colorimetry.py index 3d394a91cb..2beff5e0ef 100644 --- a/colour/plotting/colorimetry.py +++ b/colour/plotting/colorimetry.py @@ -75,6 +75,10 @@ def plot_single_sd(sd, ---------- sd : SpectralDistribution Spectral distribution to plot. + cmfs : unicode, optional + Standard observer colour matching functions used for computing the + spectrum domain and colours. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. out_of_gamut_clipping : bool, optional Whether to clip out of gamut colours otherwise, the colours will be offset by the absolute minimal colour leading to a rendering on @@ -88,8 +92,6 @@ def plot_single_sd(sd, arguments to *True* will generate a spectrum strip where each wavelength colour is modulated by the spectral distribution amplitude. The usual 5% margin above the spectral distribution is also omitted. - cmfs : unicode - Standard observer colour matching functions used for spectrum creation. Other Parameters ---------------- @@ -213,7 +215,9 @@ def plot_multi_sds(sds, of :class:`colour.MultiSpectralDistributions` class instances or a list of :class:`colour.SpectralDistribution` class instances. cmfs : unicode, optional - Standard observer colour matching functions used for spectrum creation. + Standard observer colour matching functions used for computing the + spectral distributions colours. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. use_sds_colours : bool, optional Whether to use spectral distributions colours. normalise_sds_colours : bool @@ -315,7 +319,8 @@ def plot_single_cmfs(cmfs='CIE 1931 2 Degree Standard Observer', **kwargs): Parameters ---------- cmfs : unicode, optional - Colour matching functions to plot. + Colour matching functions to plot. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. Other Parameters ---------------- @@ -359,7 +364,9 @@ def plot_multi_cmfs(cmfs=None, **kwargs): Parameters ---------- cmfs : array_like, optional - Colour matching functions to plot. + Colour matching functions to plot. ``cmfs`` elements can be of any + type or form supported by the :func:`colour.plotting.filter_cmfs` + definition. Other Parameters ---------------- @@ -443,9 +450,12 @@ def plot_single_illuminant_sd(illuminant='A', Parameters ---------- illuminant : unicode, optional - Factory illuminant to plot. + Illuminant to plot. ``illuminant`` can be of any type or form supported + by the :func:`colour.plotting.filter_illuminants` definition. cmfs : unicode, optional - Standard observer colour matching functions to plot. + Standard observer colour matching functions used for computing the + spectrum domain and colours. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. Other Parameters ---------------- @@ -499,7 +509,9 @@ def plot_multi_illuminant_sds(illuminants=None, **kwargs): Parameters ---------- illuminants : array_like, optional - Factory illuminants to plot. + Illuminants to plot. ``illuminants`` elements can be of any type or + form supported by the :func:`colour.plotting.filter_illuminants` + definition. Other Parameters ---------------- @@ -559,7 +571,9 @@ def plot_visible_spectrum(cmfs='CIE 1931 2 Degree Standard Observer', Parameters ---------- cmfs : unicode, optional - Standard observer colour matching functions used for spectrum creation. + Standard observer colour matching functions used for computing the + spectrum domain and colours. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. out_of_gamut_clipping : bool, optional Whether to clip out of gamut colours otherwise, the colours will be offset by the absolute minimal colour leading to a rendering on @@ -629,7 +643,8 @@ def plot_single_lightness_function(function='CIE 1976', **kwargs): Parameters ---------- function : unicode, optional - *Lightness* function to plot. + *Lightness* function to plot. ``function`` can be of any type or form + supported by the :func:`colour.plotting.filter_passthrough` definition. Other Parameters ---------------- @@ -669,7 +684,9 @@ def plot_multi_lightness_functions(functions=None, **kwargs): Parameters ---------- functions : array_like, optional - *Lightness* functions to plot. + *Lightness* functions to plot. ``functions`` elements can be of any + type or form supported by the + :func:`colour.plotting.filter_passthrough` definition. Other Parameters ---------------- @@ -762,7 +779,9 @@ def plot_multi_luminance_functions(functions=None, **kwargs): Parameters ---------- functions : array_like, optional - *Luminance* functions to plot. + *Luminance* functions to plot. ``functions`` elements can be of any + type or form supported by the + :func:`colour.plotting.filter_passthrough` definition. Other Parameters ---------------- @@ -821,7 +840,9 @@ def plot_blackbody_spectral_radiance( temperature : numeric, optional Blackbody temperature. cmfs : unicode, optional - Standard observer colour matching functions. + Standard observer colour matching functions used for computing the + spectrum domain and colours. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. blackbody : unicode, optional Blackbody name. @@ -913,7 +934,9 @@ def plot_blackbody_colours( shape : SpectralShape, optional Spectral shape to use as plot boundaries. cmfs : unicode, optional - Standard observer colour matching functions. + Standard observer colour matching functions used for computing the + blackbody colours. ``cmfs`` can be of any type or form supported by the + :func:`colour.plotting.filter_cmfs` definition. Other Parameters ---------------- diff --git a/colour/plotting/common.py b/colour/plotting/common.py index a6dee33ca4..3b1d2fe5fc 100644 --- a/colour/plotting/common.py +++ b/colour/plotting/common.py @@ -695,14 +695,22 @@ class instances whose type is one of the mapping element types. This definition allows passing custom but compatible objects to the various plotting definitions that by default expect the key from a dataset element. + For example, a typical call to :func:`colour.plotting.\ -plot_multi_illuminant_sds` definition is as follows: +plot_multi_illuminant_sds` definition with a regex pattern automatically + anchored at boundaries by default is as follows: >>> import colour >>> colour.plotting.plot_multi_illuminant_sds(['A']) ... # doctest: +SKIP - But it is also possible to pass a custom spectral distribution as follows: + Here, `'A'` is by default anchored at boundaries and transformed into + `'^A$'`. Note that because it is a regex pattern, special characters such + as parenthesis must be escaped: `'Adobe RGB (1998)'` must be written + `'Adobe RGB \\(1998\\)'` instead. + + With the previous example, t is also possible to pass a custom spectral + distribution as follows: >>> data = { ... 500: 0.0651, @@ -812,7 +820,9 @@ def filter_RGB_colourspaces(filterers, filterers : unicode or RGB_Colourspace or array_like Filterer or :class:`colour.RGB_Colourspace` class instance (which is passed through directly if its type is one of the mapping element - types) or list of filterers. + types) or list of filterers. ``filterers`` elements can also be of any + form supported by the :func:`colour.plotting.filter_passthrough` + definition. anchors : bool, optional Whether to use Regex line anchors, i.e. *^* and *$* are added, surrounding the filterers patterns. @@ -846,7 +856,9 @@ def filter_cmfs(filterers, :class:`colour.RGB_ColourMatchingFunctions` or :class:`colour.XYZ_ColourMatchingFunctions` class instance (which is passed through directly if its type is one of the mapping element - types) or list of filterers. + types) or list of filterers. ``filterers`` elements can also be of any + form supported by the :func:`colour.plotting.filter_passthrough` + definition. anchors : bool, optional Whether to use Regex line anchors, i.e. *^* and *$* are added, surrounding the filterers patterns. @@ -877,7 +889,9 @@ def filter_illuminants(filterers, filterers : unicode or SpectralDistribution or array_like Filterer or :class:`colour.SpectralDistribution` class instance (which is passed through directly if its type is one of the mapping - element types) or list of filterers. + element types) or list of filterers. ``filterers`` elements can also be + of any form supported by the :func:`colour.plotting.filter_passthrough` + definition. anchors : bool, optional Whether to use Regex line anchors, i.e. *^* and *$* are added, surrounding the filterers patterns. @@ -917,7 +931,9 @@ def filter_colour_checkers(filterers, filterers : unicode or ColourChecker or array_like Filterer or :class:`colour.characterisation.ColourChecker` class instance (which is passed through directly if its type is one of the - mapping element types) or list of filterers. + mapping element types) or list of filterers. ``filterers`` elements + can also be of any form supported by the + :func:`colour.plotting.filter_passthrough` definition. anchors : bool, optional Whether to use Regex line anchors, i.e. *^* and *$* are added, surrounding the filterers patterns. diff --git a/colour/plotting/diagrams.py b/colour/plotting/diagrams.py index 5429e03287..00529e82c8 100644 --- a/colour/plotting/diagrams.py +++ b/colour/plotting/diagrams.py @@ -61,8 +61,9 @@ def plot_spectral_locus(cmfs='CIE 1931 2 Degree Standard Observer', Parameters ---------- cmfs : unicode, optional - Standard observer colour matching functions defining the - *Spectral Locus*. + Standard observer colour matching functions used for computing the + spectral locus boundaries. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. spectral_locus_colours : array_like or unicode, optional *Spectral Locus* colours, if ``spectral_locus_colours`` is set to *RGB*, the colours will be computed according to the corresponding @@ -232,8 +233,9 @@ def plot_chromaticity_diagram_colours( diagram_clipping_path : array_like, optional Path of points used to clip the *Chromaticity Diagram* colours. cmfs : unicode, optional - Standard observer colour matching functions used for - *Chromaticity Diagram* bounds. + Standard observer colour matching functions used for computing the + spectral locus boundaries. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. method : unicode, optional **{'CIE 1931', 'CIE 1960 UCS', 'CIE 1976 UCS'}**, *Chromaticity Diagram* method. @@ -332,8 +334,9 @@ def plot_chromaticity_diagram(cmfs='CIE 1931 2 Degree Standard Observer', Parameters ---------- cmfs : unicode, optional - Standard observer colour matching functions used for - *Chromaticity Diagram* bounds. + Standard observer colour matching functions used for computing the + spectral locus boundaries. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. show_diagram_colours : bool, optional Whether to display the *Chromaticity Diagram* background colours. show_spectral_locus : bool, optional @@ -429,8 +432,9 @@ def plot_chromaticity_diagram_CIE1931( Parameters ---------- cmfs : unicode, optional - Standard observer colour matching functions used for - *Chromaticity Diagram* bounds. + Standard observer colour matching functions used for computing the + spectral locus boundaries. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. show_diagram_colours : bool, optional Whether to display the *Chromaticity Diagram* background colours. show_spectral_locus : bool, optional @@ -479,8 +483,9 @@ def plot_chromaticity_diagram_CIE1960UCS( Parameters ---------- cmfs : unicode, optional - Standard observer colour matching functions used for - *Chromaticity Diagram* bounds. + Standard observer colour matching functions used for computing the + spectral locus boundaries. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. show_diagram_colours : bool, optional Whether to display the *Chromaticity Diagram* background colours. show_spectral_locus : bool, optional @@ -529,8 +534,9 @@ def plot_chromaticity_diagram_CIE1976UCS( Parameters ---------- cmfs : unicode, optional - Standard observer colour matching functions used for - *Chromaticity Diagram* bounds. + Standard observer colour matching functions used for computing the + spectral locus boundaries. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. show_diagram_colours : bool, optional Whether to display the *Chromaticity Diagram* background colours. show_spectral_locus : bool, optional @@ -588,8 +594,9 @@ def plot_sds_in_chromaticity_diagram( of :class:`colour.MultiSpectralDistributions` class instances or a list of :class:`colour.SpectralDistribution` class instances. cmfs : unicode, optional - Standard observer colour matching functions used for - *Chromaticity Diagram* bounds. + Standard observer colour matching functions used for computing the + spectral locus boundaries. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. annotate_kwargs : dict or array_like, optional Parameters for the :func:`plt.annotate` definition, used to annotate the resulting chromaticity coordinates with their respective spectral @@ -763,8 +770,9 @@ class instance, a list of :class:`colour.MultiSpectralDistributions` class instances or a list of :class:`colour.SpectralDistribution` class instances. cmfs : unicode, optional - Standard observer colour matching functions used for - *Chromaticity Diagram* bounds. + Standard observer colour matching functions used for computing the + spectral locus boundaries. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. annotate_kwargs : dict or array_like, optional Parameters for the :func:`plt.annotate` definition, used to annotate the resulting chromaticity coordinates with their respective spectral @@ -838,8 +846,9 @@ class instance, a list of :class:`colour.MultiSpectralDistributions` class instances or a list of :class:`colour.SpectralDistribution` class instances. cmfs : unicode, optional - Standard observer colour matching functions used for - *Chromaticity Diagram* bounds. + Standard observer colour matching functions used for computing the + spectral locus boundaries. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. annotate_kwargs : dict or array_like, optional Parameters for the :func:`plt.annotate` definition, used to annotate the resulting chromaticity coordinates with their respective spectral @@ -914,8 +923,9 @@ class instance, a list of :class:`colour.MultiSpectralDistributions` class instances or a list of :class:`colour.SpectralDistribution` class instances. cmfs : unicode, optional - Standard observer colour matching functions used for - *Chromaticity Diagram* bounds. + Standard observer colour matching functions used for computing the + spectral locus boundaries. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. annotate_kwargs : dict or array_like, optional Parameters for the :func:`plt.annotate` definition, used to annotate the resulting chromaticity coordinates with their respective spectral diff --git a/colour/plotting/models.py b/colour/plotting/models.py index 46bbf4a73a..37e115edf2 100644 --- a/colour/plotting/models.py +++ b/colour/plotting/models.py @@ -303,10 +303,13 @@ def plot_RGB_colourspaces_in_chromaticity_diagram( Parameters ---------- colourspaces : array_like, optional - *RGB* colourspaces to plot. + *RGB* colourspaces to plot. ``colourspaces`` elements + can be of any type or form supported by the + :func:`colour.plotting.filter_RGB_colourspaces` definition. cmfs : unicode, optional - Standard observer colour matching functions used for - *Chromaticity Diagram* bounds. + Standard observer colour matching functions used for computing the + spectral locus boundaries. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. chromaticity_diagram_callable : callable, optional Callable responsible for drawing the *Chromaticity Diagram*. method : unicode, optional @@ -488,10 +491,13 @@ def plot_RGB_colourspaces_in_chromaticity_diagram_CIE1931( Parameters ---------- colourspaces : array_like, optional - *RGB* colourspaces to plot. + *RGB* colourspaces to plot. ``colourspaces`` elements + can be of any type or form supported by the + :func:`colour.plotting.filter_RGB_colourspaces` definition. cmfs : unicode, optional - Standard observer colour matching functions used for - *Chromaticity Diagram* bounds. + Standard observer colour matching functions used for computing the + spectral locus boundaries. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. chromaticity_diagram_callable_CIE1931 : callable, optional Callable responsible for drawing the *CIE 1931 Chromaticity Diagram*. @@ -542,10 +548,13 @@ def plot_RGB_colourspaces_in_chromaticity_diagram_CIE1960UCS( Parameters ---------- colourspaces : array_like, optional - *RGB* colourspaces to plot. + *RGB* colourspaces to plot. ``colourspaces`` elements + can be of any type or form supported by the + :func:`colour.plotting.filter_RGB_colourspaces` definition. cmfs : unicode, optional - Standard observer colour matching functions used for - *Chromaticity Diagram* bounds. + Standard observer colour matching functions used for computing the + spectral locus boundaries. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. chromaticity_diagram_callable_CIE1960UCS : callable, optional Callable responsible for drawing the *CIE 1960 UCS Chromaticity Diagram*. @@ -598,10 +607,13 @@ def plot_RGB_colourspaces_in_chromaticity_diagram_CIE1976UCS( Parameters ---------- colourspaces : array_like, optional - *RGB* colourspaces to plot. + *RGB* colourspaces to plot. ``colourspaces`` elements + can be of any type or form supported by the + :func:`colour.plotting.filter_RGB_colourspaces` definition. cmfs : unicode, optional - Standard observer colour matching functions used for - *Chromaticity Diagram* bounds. + Standard observer colour matching functions used for computing the + spectral locus boundaries. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. chromaticity_diagram_callable_CIE1976UCS : callable, optional Callable responsible for drawing the *CIE 1976 UCS Chromaticity Diagram*. @@ -659,7 +671,9 @@ def plot_RGB_chromaticities_in_chromaticity_diagram( RGB : array_like *RGB* colourspace array. colourspace : optional, unicode - *RGB* colourspace of the *RGB* array. + *RGB* colourspace of the *RGB* array. ``colourspace`` can be of any + type or form supported by the + :func:`colour.plotting.filter_RGB_colourspaces` definition. chromaticity_diagram_callable : callable, optional Callable responsible for drawing the *Chromaticity Diagram*. method : unicode, optional @@ -777,7 +791,9 @@ def plot_RGB_chromaticities_in_chromaticity_diagram_CIE1931( RGB : array_like *RGB* colourspace array. colourspace : optional, unicode - *RGB* colourspace of the *RGB* array. + *RGB* colourspace of the *RGB* array. ``colourspace`` can be of any + type or form supported by the + :func:`colour.plotting.filter_RGB_colourspaces` definition. chromaticity_diagram_callable_CIE1931 : callable, optional Callable responsible for drawing the *CIE 1931 Chromaticity Diagram*. scatter_kwargs : dict, optional @@ -847,7 +863,9 @@ def plot_RGB_chromaticities_in_chromaticity_diagram_CIE1960UCS( RGB : array_like *RGB* colourspace array. colourspace : optional, unicode - *RGB* colourspace of the *RGB* array. + *RGB* colourspace of the *RGB* array. ``colourspace`` can be of any + type or form supported by the + :func:`colour.plotting.filter_RGB_colourspaces` definition. chromaticity_diagram_callable_CIE1960UCS : callable, optional Callable responsible for drawing the *CIE 1960 UCS Chromaticity Diagram*. @@ -918,7 +936,9 @@ def plot_RGB_chromaticities_in_chromaticity_diagram_CIE1976UCS( RGB : array_like *RGB* colourspace array. colourspace : optional, unicode - *RGB* colourspace of the *RGB* array. + *RGB* colourspace of the *RGB* array. ``colourspace`` can be of any + type or form supported by the + :func:`colour.plotting.filter_RGB_colourspaces` definition. chromaticity_diagram_callable_CIE1976UCS : callable, optional Callable responsible for drawing the *CIE 1976 UCS Chromaticity Diagram*. @@ -1382,7 +1402,9 @@ def plot_single_cctf(cctf='ITU-R BT.709', cctf_decoding=False, **kwargs): Parameters ---------- cctf : unicode, optional - Colour component transfer function to plot. + Colour component transfer function to plot. ``function`` can be of any + type or form supported by the + :func:`colour.plotting.filter_passthrough` definition. cctf_decoding : bool Plot the decoding colour component transfer function instead. @@ -1428,7 +1450,9 @@ def plot_multi_cctfs(cctfs=None, cctf_decoding=False, **kwargs): Parameters ---------- cctfs : array_like, optional - Colour component transfer function to plot. + Colour component transfer function to plot. ``cctfs`` elements can be + of any type or form supported by the + :func:`colour.plotting.filter_passthrough` definition. cctf_decoding : bool Plot the decoding colour component transfer function instead. diff --git a/colour/plotting/notation.py b/colour/plotting/notation.py index 4b0026800b..ce96f3a3fc 100644 --- a/colour/plotting/notation.py +++ b/colour/plotting/notation.py @@ -37,7 +37,9 @@ def plot_single_munsell_value_function(function='ASTM D1535', **kwargs): Parameters ---------- function : unicode, optional - *Munsell* value function to plot. + *Munsell* value function to plot. ``function`` can be of any type or + form supported by the :func:`colour.plotting.filter_passthrough` + definition. Other Parameters ---------------- @@ -77,7 +79,9 @@ def plot_multi_munsell_value_functions(functions=None, **kwargs): Parameters ---------- functions : array_like, optional - *Munsell* value functions to plot. + *Munsell* value functions to plot. ``functions`` elements can be of any + type or form supported by the + :func:`colour.plotting.filter_passthrough` definition. Other Parameters ---------------- diff --git a/colour/plotting/phenomena.py b/colour/plotting/phenomena.py index 846c3c83dc..35a39d7f0b 100644 --- a/colour/plotting/phenomena.py +++ b/colour/plotting/phenomena.py @@ -59,7 +59,9 @@ def plot_single_sd_rayleigh_scattering( altitude : numeric, optional Altitude of the site in meters. cmfs : unicode, optional - Standard observer colour matching functions. + Standard observer colour matching functions used for computing the + spectrum domain and colours. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. Other Parameters ---------------- @@ -111,7 +113,9 @@ def plot_the_blue_sky(cmfs='CIE 1931 2 Degree Standard Observer', **kwargs): Parameters ---------- cmfs : unicode, optional - Standard observer colour matching functions. + Standard observer colour matching functions used for computing the + spectrum domain and colours. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. Other Parameters ---------------- diff --git a/colour/plotting/temperature.py b/colour/plotting/temperature.py index 55493e578b..d39fe234c2 100644 --- a/colour/plotting/temperature.py +++ b/colour/plotting/temperature.py @@ -229,7 +229,9 @@ def plot_planckian_locus_in_chromaticity_diagram( Parameters ---------- illuminants : array_like, optional - Factory illuminants to plot. + Illuminants to plot. ``illuminants`` elements can be of any + type or form supported by the + :func:`colour.plotting.filter_passthrough` definition. annotate_kwargs : dict or array_like, optional Parameters for the :func:`plt.annotate` definition, used to annotate the resulting chromaticity coordinates with their respective illuminant @@ -397,7 +399,9 @@ def plot_planckian_locus_in_chromaticity_diagram_CIE1931( Parameters ---------- illuminants : array_like, optional - Factory illuminants to plot. + Illuminants to plot. ``illuminants`` elements can be of any + type or form supported by the + :func:`colour.plotting.filter_passthrough` definition. annotate_kwargs : dict or array_like, optional Parameters for the :func:`plt.annotate` definition, used to annotate the resulting chromaticity coordinates with their respective illuminant @@ -468,7 +472,9 @@ def plot_planckian_locus_in_chromaticity_diagram_CIE1960UCS( Parameters ---------- illuminants : array_like, optional - Factory illuminants to plot. + Illuminants to plot. ``illuminants`` elements can be of any + type or form supported by the + :func:`colour.plotting.filter_passthrough` definition. annotate_kwargs : dict or array_like, optional Parameters for the :func:`plt.annotate` definition, used to annotate the resulting chromaticity coordinates with their respective illuminant diff --git a/colour/plotting/volume.py b/colour/plotting/volume.py index af2323b9c0..0170e05977 100644 --- a/colour/plotting/volume.py +++ b/colour/plotting/volume.py @@ -381,7 +381,9 @@ def plot_RGB_colourspaces_gamuts(colourspaces=None, Parameters ---------- colourspaces : array_like, optional - *RGB* colourspaces to plot the gamuts. + *RGB* colourspaces to plot the gamuts. ``colourspaces`` elements + can be of any type or form supported by the + :func:`colour.plotting.filter_RGB_colourspaces` definition. reference_colourspace : unicode, optional **{'CIE XYZ', 'CIE xyY', 'CIE xy', 'CIE Lab', 'CIE LCHab', 'CIE Luv', 'CIE Luv uv', 'CIE LCHuv', 'CIE UCS', 'CIE UCS uv', 'CIE UVW', @@ -399,7 +401,9 @@ def plot_RGB_colourspaces_gamuts(colourspaces=None, spectral_locus_colour : array_like, optional Spectral locus colour. cmfs : unicode, optional - Standard observer colour matching functions used for spectral locus. + Standard observer colour matching functions used for computing the + spectral locus boundaries. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. Other Parameters ---------------- @@ -586,7 +590,9 @@ def plot_RGB_scatter(RGB, RGB : array_like *RGB* colourspace array. colourspace : RGB_Colourspace - *RGB* colourspace of the *RGB* array. + *RGB* colourspace of the *RGB* array. ``colourspace`` can be of any + type or form supported by the + :func:`colour.plotting.filter_RGB_colourspaces` definition. reference_colourspace : unicode, optional **{'CIE XYZ', 'CIE xyY', 'CIE xy', 'CIE Lab', 'CIE LCHab', 'CIE Luv', 'CIE Luv uv', 'CIE LCHuv', 'CIE UCS', 'CIE UCS uv', 'CIE UVW', @@ -608,7 +614,9 @@ def plot_RGB_scatter(RGB, points_size : numeric, optional Scatter points size. cmfs : unicode, optional - Standard observer colour matching functions used for spectral locus. + Standard observer colour matching functions used for computing the + spectral locus boundaries. ``cmfs`` can be of any type or form + supported by the :func:`colour.plotting.filter_cmfs` definition. Other Parameters ----------------