18370061804

Committed 09 Oct 2025 08:19AM UTC coverage: 76.753% (-22.6%) from 99.349%

Build # 18370061804

Build Type

push

github

Committed by

KelSolaar

Commit Message

Merge branch 'feature/v0.4.7' into develop

Run Details

32663 of 42556 relevant lines covered (76.75%)

0.77 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/colour/plotting/graph.py

"""
Automatic Colour Conversion Graph Plotting
==========================================

Define the automatic colour conversion graph plotting objects.

-   :func:`colour.plotting.plot_automatic_colour_conversion_graph`
"""

from __future__ import annotations

import os
import typing

import colour
from colour.graph import CONVERSION_GRAPH_NODE_LABELS, describe_conversion_path

if typing.TYPE_CHECKING:
    from colour.hints import Literal

from colour.hints import cast
from colour.utilities import required, validate_method

__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_automatic_colour_conversion_graph",
]


@required("Pydot")
@required("NetworkX")
def plot_automatic_colour_conversion_graph(
    filename: str,
    prog: Literal["circo", "dot", "fdp", "neato", "nop", "twopi"] | str = "fdp",
) -> Dot:  # pyright: ignore  # noqa: F821  # pragma: no cover
    """
    Plot *Colour* automatic colour conversion graph using
    `Graphviz <https://www.graphviz.org>`__ and
    `pyraphviz <https://pygraphviz.github.io>`__.

    Parameters
    ----------
    filename
        Filename to use to save the image.
    prog
        *Graphviz* layout method.

    Returns
    -------
    :class:`pydot.Dot`
        *Pydot* graph.

    Notes
    -----
    -   This definition does not directly plot the *Colour* automatic
        colour conversion graph but instead writes it to an image.

    Examples
    --------
    >>> import tempfile
    >>> import colour
    >>> from colour import read_image
    >>> from colour.plotting import plot_image
    >>> filename = "{0}.png".format(tempfile.mkstemp()[-1])
    >>> _ = plot_automatic_colour_conversion_graph(filename, "dot")
    ... # doctest: +SKIP
    >>> plot_image(read_image(filename))  # doctest: +SKIP

    .. image:: ../_static/Plotting_Plot_Colour_Automatic_Conversion_Graph.png
        :align: center
        :alt: plot_automatic_colour_conversion_graph
    """

    import networkx as nx  # noqa: PLC0415

    prog = validate_method(
        prog,
        ("circo", "dot", "fdp", "neato", "nop", "twopi"),
        '"{0}" program is invalid, it must be one of {1}!',
    )

    # TODO: Investigate API to trigger the conversion graph build.
    describe_conversion_path("RGB", "RGB", print_callable=lambda x: x)

    dot = nx.drawing.nx_pydot.to_pydot(
        cast("nx.DiGraph", colour.graph.CONVERSION_GRAPH)
    )

    for node in dot.get_nodes():
        label = CONVERSION_GRAPH_NODE_LABELS.get(node.get_name())

        if label is None:
            continue

        node.set_label(label)
        node.set_style("filled")
        node.set_shape("circle")
        node.set_color("#2196F3FF")
        node.set_fillcolor("#2196F370")
        node.set_fontname("Helvetica")
        node.set_fontcolor("#263238")

    for name in ("CIE XYZ", "RGB", "Spectral Distribution"):
        node = next(iter(dot.get_node(name.lower())))

        node.set_shape("doublecircle")
        node.set_color("#673AB7FF")
        node.set_fillcolor("#673AB770")
        node.set_fontsize(30)

    for name in (
        "ATD95",
        "CAM16",
        "CIECAM02",
        "Hellwig 2022",
        "Hunt",
        "Kim 2009",
        "LLAB",
        "Nayatani95",
        "RLAB",
        "ZCAM",
    ):
        node = next(iter(dot.get_node(name.lower())))

        node.set_color("#00BCD4FF")
        node.set_fillcolor("#00BCD470")

    for edge in dot.get_edges():
        edge.set_color("#26323870")

    file_format = os.path.splitext(filename)[-1][1:]
    write_method = getattr(dot, f"write_{file_format}")
    write_method(filename, prog=prog, f=file_format)

    return dot

1	"""
2	Automatic Colour Conversion Graph Plotting
3	==========================================
4
5	Define the automatic colour conversion graph plotting objects.
6
7	- :func:`colour.plotting.plot_automatic_colour_conversion_graph`
8	"""
9
10	from __future__ import annotations	×
11
12	import os	×
13	import typing	×
14
15	import colour	×
16	from colour.graph import CONVERSION_GRAPH_NODE_LABELS, describe_conversion_path	×
17
18	if typing.TYPE_CHECKING:
19	from colour.hints import Literal
20
21	from colour.hints import cast	×
22	from colour.utilities import required, validate_method	×
23
24	__author__ = "Colour Developers"	×
25	__copyright__ = "Copyright 2013 Colour Developers"	×
26	__license__ = "BSD-3-Clause - https://opensource.org/licenses/BSD-3-Clause"	×
27	__maintainer__ = "Colour Developers"	×
28	__email__ = "colour-developers@colour-science.org"	×
29	__status__ = "Production"	×
30
31	__all__ = [	×
32	"plot_automatic_colour_conversion_graph",
33	]
34
35
36	@required("Pydot")
37	@required("NetworkX")
38	def plot_automatic_colour_conversion_graph(
39	filename: str,
40	prog: Literal["circo", "dot", "fdp", "neato", "nop", "twopi"] \| str = "fdp",
41	) -> Dot: # pyright: ignore # noqa: F821 # pragma: no cover
42	"""
43	Plot Colour automatic colour conversion graph using
44	`Graphviz <https://www.graphviz.org>`__ and
45	`pyraphviz <https://pygraphviz.github.io>`__.
46
47	Parameters
48	----------
49	filename
50	Filename to use to save the image.
51	prog
52	Graphviz layout method.
53
54	Returns
55	-------
56	:class:`pydot.Dot`
57	Pydot graph.
58
59	Notes
60	-----
61	- This definition does not directly plot the Colour automatic
62	colour conversion graph but instead writes it to an image.
63
64	Examples
65	--------
66	>>> import tempfile
67	>>> import colour
68	>>> from colour import read_image
69	>>> from colour.plotting import plot_image
70	>>> filename = "{0}.png".format(tempfile.mkstemp()[-1])
71	>>> _ = plot_automatic_colour_conversion_graph(filename, "dot")
72	... # doctest: +SKIP
73	>>> plot_image(read_image(filename)) # doctest: +SKIP
74
75	.. image:: ../_static/Plotting_Plot_Colour_Automatic_Conversion_Graph.png
76	:align: center
77	:alt: plot_automatic_colour_conversion_graph
78	"""
79
80	import networkx as nx # noqa: PLC0415
81
82	prog = validate_method(
83	prog,
84	("circo", "dot", "fdp", "neato", "nop", "twopi"),
85	'"{0}" program is invalid, it must be one of {1}!',
86	)
87
88	# TODO: Investigate API to trigger the conversion graph build.
89	describe_conversion_path("RGB", "RGB", print_callable=lambda x: x)
90
91	dot = nx.drawing.nx_pydot.to_pydot(
92	cast("nx.DiGraph", colour.graph.CONVERSION_GRAPH)
93	)
94
95	for node in dot.get_nodes():
96	label = CONVERSION_GRAPH_NODE_LABELS.get(node.get_name())
97
98	if label is None:
99	continue
100
101	node.set_label(label)
102	node.set_style("filled")
103	node.set_shape("circle")
104	node.set_color("#2196F3FF")
105	node.set_fillcolor("#2196F370")
106	node.set_fontname("Helvetica")
107	node.set_fontcolor("#263238")
108
109	for name in ("CIE XYZ", "RGB", "Spectral Distribution"):
110	node = next(iter(dot.get_node(name.lower())))
111
112	node.set_shape("doublecircle")
113	node.set_color("#673AB7FF")
114	node.set_fillcolor("#673AB770")
115	node.set_fontsize(30)
116
117	for name in (
118	"ATD95",
119	"CAM16",
120	"CIECAM02",
121	"Hellwig 2022",
122	"Hunt",
123	"Kim 2009",
124	"LLAB",
125	"Nayatani95",
126	"RLAB",
127	"ZCAM",
128	):
129	node = next(iter(dot.get_node(name.lower())))
130
131	node.set_color("#00BCD4FF")
132	node.set_fillcolor("#00BCD470")
133
134	for edge in dot.get_edges():
135	edge.set_color("#26323870")
136
137	file_format = os.path.splitext(filename)[-1][1:]
138	write_method = getattr(dot, f"write_{file_format}")
139	write_method(filename, prog=prog, f=file_format)
140
141	return dot

colour-science / colour / 18370061804

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous