colour.utilities.to_domain_int

colour.utilities.to_domain_int(a, bit_depth=8, dtype=<class 'numpy.float64'>)[source]

Scales given array \(a\) to int domain. The behaviour is as follows:

  • If Colour domain-range scale is ‘Reference’, the definition is almost entirely by-passed and will just conveniently convert array \(a\) to np.ndarray.

  • If Colour domain-range scale is ‘1’, array \(a\) is multiplied by \(2^{bit\_depth} - 1\).

  • If Colour domain-range scale is ‘100’ (currently unsupported private value only used for unit tests), array \(a\) is multiplied by \(2^{bit\_depth} - 1\).

Parameters
  • a (array_like) – \(a\) to scale to int domain.

  • bit_depth (numeric or array_like, optional) – Bit depth, usually int but can be an array_like if some axis need different scaling to be brought to int domain.

  • dtype (object, optional) – Data type used for the conversion to np.ndarray.

Returns

\(a\) scaled to int domain.

Return type

ndarray

Notes

  • To avoid precision issues and rounding, the scaling is performed on floating-point numbers.

Examples

With Colour domain-range scale set to ‘Reference’:

>>> with domain_range_scale('Reference'):
...     to_domain_int(1)
array(1.0)

With Colour domain-range scale set to ‘1’:

>>> with domain_range_scale('1'):
...     to_domain_int(1)
array(255.0)

With Colour domain-range scale set to ‘100’ (unsupported):

>>> with domain_range_scale('100'):
...     to_domain_int(1)
array(2.55)