Set White Point

Description

A white point definition is used to adjust the colors. This method allows to set custom values. If not explicitly set a default specification is used. The get_whitepoint method can be used to extract the currently used definition.

Usage

HSV.set_whitepoint(**kwargs)

Arguments

**kwargs
Named arguments. Allowed are X, Y, and Z, each of which must be float: White specification for dimension X/Y/Z.

Examples

from colorspace import hexcols
c = hexcols("#ff0000")
c.set_whitepoint(X = 100., Y = 100., Z = 101.)
c.get_whitepoint()
{'X': 100.0, 'Y': 100.0, 'Z': 101.0}

Raises

  • ValueError: If named argument is not one of X, Y, Z.