"""
Corresponding Chromaticities Prediction Plotting
================================================
Define the corresponding chromaticities prediction plotting objects:
- :func:`colour.plotting.plot_corresponding_chromaticities_prediction`
"""
from __future__ import annotations
import typing
if typing.TYPE_CHECKING:
from matplotlib.figure import Figure
from matplotlib.axes import Axes
from colour.corresponding import (
CorrespondingColourDataset,
corresponding_chromaticities_prediction,
)
if typing.TYPE_CHECKING:
from colour.hints import Any, Dict, Literal, Tuple
from colour.hints import cast
from colour.plotting import (
CONSTANTS_COLOUR_STYLE,
artist,
override_style,
plot_chromaticity_diagram_CIE1976UCS,
render,
)
from colour.utilities import is_numeric
__author__ = "Colour Developers"
__copyright__ = "Copyright 2013 Colour Developers"
__license__ = "BSD-3-Clause - https://opensource.org/licenses/BSD-3-Clause"
__maintainer__ = "Colour Developers"
__email__ = "colour-developers@colour-science.org"
__status__ = "Production"
__all__ = [
"plot_corresponding_chromaticities_prediction",
]
[docs]
@override_style()
def plot_corresponding_chromaticities_prediction(
experiment: (Literal[1, 2, 3, 4, 6, 8, 9, 11, 12] | CorrespondingColourDataset) = 1,
model: (
Literal[
"CIE 1994",
"CMCCAT2000",
"Fairchild 1990",
"Von Kries",
"Zhai 2018",
]
| str
) = "Von Kries",
corresponding_chromaticities_prediction_kwargs: dict | None = None,
**kwargs: Any,
) -> Tuple[Figure, Axes]:
"""
Plot given chromatic adaptation model corresponding chromaticities
prediction.
Parameters
----------
experiment
*Breneman (1987)* experiment number or
:class:`colour.CorrespondingColourDataset` class instance.
model
Corresponding chromaticities prediction model name.
corresponding_chromaticities_prediction_kwargs
Keyword arguments for the :func:`colour.\
corresponding_chromaticities_prediction` definition.
Other Parameters
----------------
kwargs
{:func:`colour.plotting.artist`,
:func:`colour.plotting.diagrams.plot_chromaticity_diagram`,
:func:`colour.plotting.render`},
See the documentation of the previously listed definitions.
Returns
-------
:class:`tuple`
Current figure and axes.
Examples
--------
>>> plot_corresponding_chromaticities_prediction(1, "Von Kries")
... # doctest: +ELLIPSIS
(<Figure size ... with 1 Axes>, <...Axes...>)
.. image:: ../_static/Plotting_\
Plot_Corresponding_Chromaticities_Prediction.png
:align: center
:alt: plot_corresponding_chromaticities_prediction
"""
if corresponding_chromaticities_prediction_kwargs is None:
corresponding_chromaticities_prediction_kwargs = {}
settings: Dict[str, Any] = {"uniform": True}
settings.update(kwargs)
_figure, axes = artist(**settings)
name = (
f"Experiment {experiment}"
if is_numeric(experiment)
else cast(CorrespondingColourDataset, experiment).name
)
title = (
f"Corresponding Chromaticities Prediction - {model} - {name} - "
"CIE 1976 UCS Chromaticity Diagram"
)
settings = {"axes": axes, "title": title}
settings.update(kwargs)
settings["show"] = False
plot_chromaticity_diagram_CIE1976UCS(**settings)
results = corresponding_chromaticities_prediction(
experiment, model, **corresponding_chromaticities_prediction_kwargs
)
for result in results:
_name, uv_t, uv_m, uv_p = result.values
axes.arrow(
uv_t[0],
uv_t[1],
uv_p[0] - uv_t[0] - 0.1 * (uv_p[0] - uv_t[0]),
uv_p[1] - uv_t[1] - 0.1 * (uv_p[1] - uv_t[1]),
color=CONSTANTS_COLOUR_STYLE.colour.dark,
head_width=0.005,
head_length=0.005,
zorder=CONSTANTS_COLOUR_STYLE.zorder.midground_annotation,
)
axes.plot(
uv_t[0],
uv_t[1],
"o",
color=CONSTANTS_COLOUR_STYLE.colour.brightest,
markeredgecolor=CONSTANTS_COLOUR_STYLE.colour.dark,
markersize=(
CONSTANTS_COLOUR_STYLE.geometry.short * 6
+ CONSTANTS_COLOUR_STYLE.geometry.short * 0.75
),
markeredgewidth=CONSTANTS_COLOUR_STYLE.geometry.short * 0.75,
zorder=CONSTANTS_COLOUR_STYLE.zorder.foreground_line,
)
axes.plot(
uv_m[0],
uv_m[1],
"^",
color=CONSTANTS_COLOUR_STYLE.colour.brightest,
markeredgecolor=CONSTANTS_COLOUR_STYLE.colour.dark,
markersize=(
CONSTANTS_COLOUR_STYLE.geometry.short * 6
+ CONSTANTS_COLOUR_STYLE.geometry.short * 0.75
),
markeredgewidth=CONSTANTS_COLOUR_STYLE.geometry.short * 0.75,
zorder=CONSTANTS_COLOUR_STYLE.zorder.foreground_line,
)
axes.plot(
uv_p[0],
uv_p[1],
"^",
color=CONSTANTS_COLOUR_STYLE.colour.dark,
zorder=CONSTANTS_COLOUR_STYLE.zorder.foreground_line,
)
settings.update(
{
"show": True,
"bounding_box": (-0.1, 0.7, -0.1, 0.7),
}
)
settings.update(kwargs)
return render(**settings)
