colour.plotting.section.plot_hull_section_contour#

colour.plotting.section.plot_hull_section_contour(hull: trimesh.Trimesh, model: Union[Literal['CAM02LCD', 'CAM02SCD', 'CAM02UCS', 'CAM16LCD', 'CAM16SCD', 'CAM16UCS', 'CIE XYZ', 'CIE xyY', 'CIE Lab', 'CIE Luv', 'CIE UCS', 'CIE UVW', 'DIN99', 'Hunter Lab', 'Hunter Rdab', 'ICaCb', 'ICtCp', 'IPT', 'IgPgTg', 'Jzazbz', 'OSA UCS', 'Oklab', 'hdr-CIELAB', 'hdr-IPT'], str] = 'CIE xyY', axis: Union[Literal['+z', '+x', '+y'], str] = '+z', origin: Floating = 0.5, normalise: Boolean = True, contour_colours: Optional[Union[ArrayLike, str]] = None, contour_opacity: Floating = 1, convert_kwargs: Optional[Dict] = None, **kwargs: Any) Tuple[plt.Figure, plt.Axes][source]#

Plot the section contour of given trimesh hull along given axis and origin.

Parameters:
  • hull (trimesh.Trimesh) – Trimesh hull.

  • model (Union[Literal[('CAM02LCD', 'CAM02SCD', 'CAM02UCS', 'CAM16LCD', 'CAM16SCD', 'CAM16UCS', 'CIE XYZ', 'CIE xyY', 'CIE Lab', 'CIE Luv', 'CIE UCS', 'CIE UVW', 'DIN99', 'Hunter Lab', 'Hunter Rdab', 'ICaCb', 'ICtCp', 'IPT', 'IgPgTg', 'Jzazbz', 'OSA UCS', 'Oklab', 'hdr-CIELAB', 'hdr-IPT')], str]) – Colourspace model, see colour.COLOURSPACE_MODELS attribute for the list of supported colourspace models.

  • axis (Union[Literal[('+z', '+x', '+y')], str]) – Axis the hull section will be normal to.

  • origin (Floating) – Coordinate along axis at which to plot the hull section.

  • normalise (Boolean) – Whether to normalise axis to the extent of the hull along it.

  • contour_colours (Optional[Union[ArrayLike, str]]) – Colours of the hull section contour, if contour_colours is set to RGB, the colours will be computed according to the corresponding coordinates.

  • contour_opacity (Floating) – Opacity of the hull section contour.

  • convert_kwargs (Optional[Dict]) – Keyword arguments for the colour.convert() definition.

  • kwargs (Any) – {colour.plotting.artist(), colour.plotting.render()}, See the documentation of the previously listed definitions.

Returns:

Current figure and axes.

Return type:

tuple

Examples

>>> from colour.models import RGB_COLOURSPACE_sRGB
>>> from colour.utilities import is_trimesh_installed
>>> vertices, faces, _outline = primitive_cube(1, 1, 1, 64, 64, 64)
>>> XYZ_vertices = RGB_to_XYZ(
...     vertices['position'] + 0.5,
...     RGB_COLOURSPACE_sRGB.whitepoint,
...     RGB_COLOURSPACE_sRGB.whitepoint,
...     RGB_COLOURSPACE_sRGB.matrix_RGB_to_XYZ,
... )
>>> if is_trimesh_installed:
...     import trimesh
...     hull = trimesh.Trimesh(XYZ_vertices, faces, process=False)
...     plot_hull_section_contour(hull, contour_colours='RGB')
...     
(<Figure size ... with 1 Axes>, <...AxesSubplot...>)
plot_hull_section_contour