colour.utilities.as_namedtuple

colour.utilities.as_namedtuple(a, named_tuple)[source]

Converts given \(a\) variable to given namedtuple class instance.

\(a\) can be either a Numpy structured array, a namedtuple, a mapping, or an array_like object. The definition will attempt to convert it to given namedtuple.

Parameters
  • a (object) – Variable to convert.

  • named_tuple (namedtuple) – namedtuple class.

Returns

math:a variable converted to namedtuple.

Return type

namedtuple

Examples

>>> from collections import namedtuple
>>> a_a = 1
>>> a_b = 2
>>> a_c = 3
>>> NamedTuple = namedtuple('NamedTuple', 'a b c')
>>> as_namedtuple(NamedTuple(a=1, b=2, c=3), NamedTuple)
NamedTuple(a=1, b=2, c=3)
>>> as_namedtuple({'a': a_a, 'b': a_b, 'c': a_c}, NamedTuple)
NamedTuple(a=1, b=2, c=3)
>>> as_namedtuple([a_a, a_b, a_c], NamedTuple)
NamedTuple(a=1, b=2, c=3)