ak.from_rdataframe — Awkward Array 2.8.2 documentation (original) (raw)

Defined in awkward.operations.ak_from_rdataframe on line 15.

ak.from_rdataframe(rdf, columns, *, keep_order=False, offsets_type='int64', with_name=None, highlevel=True, behavior=None, attrs=None)#

Parameters:

rdf (ROOT.RDataFrame) – ROOT RDataFrame to convert into an Awkward Array.
columns (str or iterable of str) – A column or multiple columns to be converted to Awkward Array.
keep_order (bool) – If set to True the columns with Awkward type will keep order after filtering.
offsets_type (str) – A NumpyType.primitive type of the ListOffsetArray offsets: "int32", "uint32" or "int64".
with_name (None or str) – Gives tuples and records a name that can be used to override their behavior (see ak.Array).
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 ROOT RDataFrame columns into an Awkward Array.

If columns is a string, the return value represents a single RDataFrame column.

If columns is any other iterable, the return value is a record array, in which each field corresponds to an RDataFrame column. In particular, if the columnsiterable contains only one string, it is still a record array, which has only one field.