ak.from_regular#

Defined in awkward.operations.ak_from_regular on line 18.

ak.from_regular(array, axis=1, *, highlevel=True, behavior=None, attrs=None)#

Parameters:

array – Array-like data (anything ak.to_layout recognizes).
axis (int or None) – The dimension at which this operation is applied. The outermost dimension is 0, followed by 1, etc., and negative values count backward from the innermost: -1 is the innermost dimension, -2 is the next level up, etc. If None, convert all regular dimensions into variable ones.
highlevel (bool) – If True, return an ak.Array; otherwise, return a low-level ak.contents.Content subclass.
behavior (None or dict) – Custom ak.behavior for the output array, if high-level.
attrs (None or dict) – Custom attributes for the output array, if high-level.

Converts a regular axis into an irregular one.

>>> regular = ak.Array(np.arange(2*3*5).reshape(2, 3, 5))
>>> regular.type.show()
2 * 3 * 5 * int64
>>> ak.from_regular(regular).type.show()
2 * var * 5 * int64
>>> ak.from_regular(regular, axis=2).type.show()
2 * 3 * var * int64
>>> ak.from_regular(regular, axis=-1).type.show()
2 * 3 * var * int64