Utilities

Common

colour

domain_range_scale(scale)	A context manager and decorator temporarily setting Colour domain-range scale.
get_domain_range_scale()	Returns the current Colour domain-range scale.
set_domain_range_scale([scale])	Sets the current Colour domain-range scale.

colour.utilities

CacheRegistry()

A registry for mapping-based caches.

CACHE_REGISTRY	A registry for mapping-based caches.
handle_numpy_errors(**kwargs)	Decorator for handling Numpy errors.
ignore_numpy_errors(function)	Wrapper for given function.
raise_numpy_errors(function)	Wrapper for given function.
print_numpy_errors(function)	Wrapper for given function.
warn_numpy_errors(function)	Wrapper for given function.
ignore_python_warnings(function)	Decorator for ignoring Python warnings.
attest(condition[, message])	A replacement for assert that is not removed by optimised Python execution.
batch(iterable[, k])	Returns a batch generator from given iterable.
disable_multiprocessing()	A context manager and decorator temporarily disabling Colour multiprocessing.
multiprocessing_pool(*args, **kwargs)	A context manager providing a multiprocessing pool.
is_matplotlib_installed([raise_exception])	Returns if Matplotlib is installed and available.
is_networkx_installed([raise_exception])	Returns if NetworkX is installed and available.
is_opencolorio_installed([raise_exception])	Returns if OpenColorIO is installed and available.
is_openimageio_installed([raise_exception])	Returns if OpenImageIO is installed and available.
is_pandas_installed([raise_exception])	Returns if Pandas is installed and available.
is_sklearn_installed([raise_exception])	Returns if Scikit-Learn (sklearn) is installed and available.
is_tqdm_installed([raise_exception])	Returns if tqdm is installed and available.
is_trimesh_installed([raise_exception])	Returns if Trimesh is installed and available.
required(*requirements)	A decorator checking if various requirements are satisfied.
is_iterable(a)	Returns if given \(a\) variable is iterable.
is_string(a)	Returns if given \(a\) variable is a string like variable.
is_numeric(a)	Returns if given \(a\) variable is a number.
is_integer(a)	Returns if given \(a\) variable is an integer under given threshold.
is_sibling(element, mapping)	Returns whether given element type is present in given mapping types.
filter_kwargs(function, **kwargs)	Filters keyword arguments incompatible with the given function signature.
filter_mapping(mapping, filterers[, ...])	Filters given mapping with given filterers.
first_item(a)	Return the first item of an iterable.
to_domain_1(a[, scale_factor, dtype])	Scales given array \(a\) to domain '1'.
to_domain_10(a[, scale_factor, dtype])	Scales given array \(a\) to domain '10', used by Munsell Renotation System.
to_domain_100(a[, scale_factor, dtype])	Scales given array \(a\) to domain '100'.
to_domain_degrees(a[, scale_factor, dtype])	Scales given array \(a\) to degrees domain.
to_domain_int(a[, bit_depth, dtype])	Scales given array \(a\) to int domain.
from_range_1(a[, scale_factor])	Scales given array \(a\) from range '1'.
from_range_10(a[, scale_factor])	Scales given array \(a\) from range '10', used by Munsell Renotation System.
from_range_100(a[, scale_factor])	Scales given array \(a\) from range '100'.
from_range_degrees(a[, scale_factor])	Scales given array \(a\) from degrees range.
from_range_int(a[, bit_depth, dtype])	Scales given array \(a\) from int range.
copy_definition(definition[, name])	Copies a definition with same code, globals, defaults, closure, and name.
validate_method(method, valid_methods[, message])	Validates whether given method exists in the given valid methods and returns the method lower cased.

Array

colour.utilities

MixinDataclassArray()	A mixin providing conversion methods for dataclass conversion to ndarray class and mathematical operations.
as_array(a[, dtype])	Converts given \(a\) variable to ndarray using given type.
as_int_array(a[, dtype])	Converts given \(a\) variable to ndarray using given type.
as_float_array(a[, dtype])	Converts given \(a\) variable to ndarray using given type.
as_numeric(a[, dtype])	Converts given \(a\) variable to numeric.
as_int(a[, dtype])	Attempts to converts given \(a\) variable to int using given type.
as_float(a[, dtype])	Converts given \(a\) variable to numeric using given type.
set_float_precision([dtype])	Sets Colour float precision by setting colour.constant.DEFAULT_FLOAT_DTYPE attribute with given type wherever the attribute is imported.
set_int_precision([dtype])	Sets Colour integer precision by setting colour.constant.DEFAULT_INT_DTYPE attribute with given type wherever the attribute is imported.
closest_indexes(a, b)	Returns the \(a\) variable closest element indexes to reference \(b\) variable elements.
closest(a, b)	Returns the \(a\) variable closest elements to reference \(b\) variable elements.
interval(distribution[, unique])	Returns the interval size of given distribution.
is_uniform(distribution)	Returns if given distribution is uniform.
has_only_nan(a)	Returns whether given array \(a\) contains only nan values.
in_array(a, b[, tolerance])	Tests whether each element of an array is also present in a second array within given tolerance.
tstack(a[, dtype])	Stacks arrays in sequence along the last axis (tail).
tsplit(a[, dtype])	Splits arrays in sequence along the last axis (tail).
row_as_diagonal(a)	Returns the per row diagonal matrices of the given array.
orient(a, orientation)	Orient given array according to given orientation value.
centroid(a)	Computes the centroid indexes of given \(a\) array.
fill_nan(a[, method, default])	Fills given array NaNs according to given method.
ndarray_write(a)	A context manager setting given array writeable to perform an operation and then read-only.
zeros(shape[, dtype, order])	Simple wrapper around np.zeros() definition to create arrays with the active type defined by the:attr:colour.constant.DEFAULT_FLOAT_DTYPE attribute.
ones(shape[, dtype, order])	Simple wrapper around np.ones() definition to create arrays with the active type defined by the:attr:colour.constant.DEFAULT_FLOAT_DTYPE attribute.
full(shape, fill_value[, dtype, order])	Simple wrapper around np.full() definition to create arrays with the active type defined by the:attr:colour.constant.DEFAULT_FLOAT_DTYPE attribute.

Metrics

colour.utilities

metric_mse(a, b[, axis])	Computes the mean squared error (MSE) or mean squared deviation (MSD) between given array_like \(a\) and \(b\) variables.
metric_psnr(a, b[, max_a, axis])	Computes the peak signal-to-noise ratio (PSNR) between given array_like \(a\) and \(b\) variables.

Data Structures

colour.utilities

CaseInsensitiveMapping([data])	Implements a case-insensitive mutable mapping / dict object.
LazyCaseInsensitiveMapping([data])	Implements a lazy case-insensitive mutable mapping / dict object by inheriting from colour.utilities.CaseInsensitiveMapping class.
Lookup	Extends dict type to provide a lookup by value(s).
Node(*args, **kwargs)	Represents a basic node supporting the creation of basic node trees.
Structure(*args, **kwargs)	Defines a dict-like object allowing to access key values using dot syntax.

Verbose

colour.utilities

message_box(message[, width, padding, ...])	Prints a message inside a box.
warning(*args, **kwargs)	Issues a warning.
filter_warnings([colour_runtime_warnings, ...])	Filters Colour and also optionally overall Python warnings.
suppress_warnings([colour_runtime_warnings, ...])	A context manager filtering Colour and also optionally overall Python warnings.
numpy_print_options(*args, **kwargs)	A context manager implementing context changes to Numpy print behaviour.
describe_environment([runtime_packages, ...])	Describes Colour running environment, i.e. interpreter, runtime and development packages.

Ancillary Objects

colour.utilities

ColourWarning	This is the base class of Colour warnings.
ColourUsageWarning	This is the base class of Colour usage warnings.
ColourRuntimeWarning	This is the base class of Colour runtime warnings.