colour.utilities.from_range_1#

colour.utilities.from_range_1(a: ArrayLike, scale_factor: FloatingOrArrayLike = 100, dtype: Optional[Type[DTypeFloating]] = None) NDArray[source]#

Scale given array \(a\) from range ‘1’. The behaviour is as follows:

  • If Colour domain-range scale is ‘Reference’ or ‘1’, the definition is entirely by-passed.

  • If Colour domain-range scale is ‘100’ (currently unsupported private value only used for unit tests), array \(a\) is multiplied by scale_factor, typically 100.

Parameters
  • a (ArrayLike) – Array \(a\) to scale from range ‘1’.

  • scale_factor (FloatingOrArrayLike) – Scale factor, usually numeric but can be a numpy.ndarray if some axis need different scaling to be brought from range ‘1’.

  • dtype (Optional[Type[DTypeFloating]]) – Data type used for the conversion to np.ndarray.

Returns

Array \(a\) scaled from range ‘1’.

Return type

numpy.ndarray

Warning

The scale conversion of variable \(a\) happens in-place, i.e. \(a\) will be mutated!

Examples

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

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

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

>>> with domain_range_scale('1'):
...     from_range_1(1)
array(1.0)

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

>>> with domain_range_scale('100'):
...     from_range_1(1)
array(100.0)