colour.plotting.plot_planckian_locus_in_chromaticity_diagram_CIE1931#

colour.plotting.plot_planckian_locus_in_chromaticity_diagram_CIE1931(illuminants: str | collections.abc.Sequence[str], chromaticity_diagram_callable_CIE1931: Callable = plot_chromaticity_diagram_CIE1931, annotate_kwargs: Optional[Union[dict, List[dict]]] = None, plot_kwargs: Optional[Union[dict, List[dict]]] = None, **kwargs: Any) → Tuple[matplotlib.figure.Figure, matplotlib.axes._axes.Axes][source]#

Plot the Planckian Locus and given illuminants in CIE 1931 Chromaticity Diagram.

Parameters

illuminants (str | collections.abc.Sequence[str]) – Illuminants to plot. illuminants elements can be of any type or form supported by the colour.plotting.common.filter_passthrough() definition.
chromaticity_diagram_callable_CIE1931 (Callable) – Callable responsible for drawing the CIE 1931 Chromaticity Diagram.
annotate_kwargs (Optional[Union[dict, List[dict]]]) –
Keyword arguments for the matplotlib.pyplot.annotate() definition, used to annotate the resulting chromaticity coordinates with their respective spectral distribution names. annotate_kwargs can be either a single dictionary applied to all the arrows with same settings or a sequence of dictionaries with different settings for each spectral distribution. The following special keyword arguments can also be used:
- annotate : Whether to annotate the spectral distributions.
plot_kwargs (Optional[Union[dict, List[dict]]]) – Keyword arguments for the matplotlib.pyplot.plot() definition, used to control the style of the plotted illuminants. plot_kwargs can be either a single dictionary applied to all the plotted illuminants with the same settings or a sequence of dictionaries with different settings for eachplotted illuminant.
kwargs (Any) – {colour.plotting.artist(), colour.plotting.diagrams.plot_chromaticity_diagram(), colour.plotting.temperature.plot_planckian_locus(), colour.plotting.temperature.plot_planckian_locus_in_chromaticity_diagram(), colour.plotting.render()}, See the documentation of the previously listed definitions.

Returns

Current figure and axes.

Return type

tuple

Examples

>>> plot_planckian_locus_in_chromaticity_diagram_CIE1931(["A", "B", "C"])
... 
(<Figure size ... with 1 Axes>, <...Axes...>)

plot_planckian_locus_in_chromaticity_diagram_CIE1931