colour.utilities.to_domain_1¶
-
colour.utilities.
to_domain_1
(a, scale_factor=100, dtype=<class 'numpy.float64'>)[source]¶ Scales given array \(a\) to domain ‘1’. The behaviour is as follows:
If Colour domain-range scale is ‘Reference’ or ‘1’, the definition is almost entirely by-passed and will just conveniently convert array \(a\) to
np.ndarray
.If Colour domain-range scale is ‘100’ (currently unsupported private value only used for unit tests), array \(a\) is divided by
scale_factor
, typically 100.
- Parameters
a (array_like) – \(a\) to scale to domain ‘1’.
scale_factor (numeric or array_like, optional) – Scale factor, usually numeric but can be an array_like if some axis need different scaling to be brought to domain ‘1’.
dtype (object, optional) – Data type used for the conversion to
np.ndarray
.
- Returns
\(a\) scaled to domain ‘1’.
- Return type
ndarray
Examples
With Colour domain-range scale set to ‘Reference’:
>>> with domain_range_scale('Reference'): ... to_domain_1(1) array(1.0)
With Colour domain-range scale set to ‘1’:
>>> with domain_range_scale('1'): ... to_domain_1(1) array(1.0)
With Colour domain-range scale set to ‘100’ (unsupported):
>>> with domain_range_scale('100'): ... to_domain_1(1) array(0.01)