uproot.behaviors.TBranch.Report — Uproot documentation

# uproot.behaviors.TBranch.Report

Defined in uproot.behaviors.TBranch on line 442.

class uproot.behaviors.TBranch.Report(source, tree_entry_start, tree_entry_stop, global_offset=0)
  Parameters:

    - source (uproot.behaviors.TBranch.HasBranches) – The object (uproot.TBranch or uproot.TTree) that this batch of data came from.

    - tree_entry_start (int) – First entry in the batch, counting zero at the start of the current `TTree` (current file).

    - tree_entry_stop (int) – First entry after the batch (last entry plus one), counting zero at the start of the `TTree` (current file).

    - global_offset (int) – Number of entries between the start of iteration and the start of this `TTree`. The global_entry_start and global_entry_stop are equal to tree_entry_start and tree_entry_stop plus `global_offset`.

  Information about the current iteration of iterate (the method) or uproot.iterate (the function).

  Since the iterate method only iterates over data from one `TTree`, its `global_offset` is always zero; global_entry_start and global_entry_stop are equal to tree_entry_start and tree_entry_stop, respectively.

## source

Report.source

  The object (uproot.TBranch or uproot.TTree) that this batch of data came from.

## tree

Report.tree

  The uproot.TTree that this batch of data came from.

## file

Report.file

  The uproot.ReadOnlyFile that this batch of data came from.

## file_path

Report.file_path

  The path/name of the uproot.ReadOnlyFile that this batch of data came from.

## tree_entry_start

Report.tree_entry_start

  First entry in the batch, counting zero at the start of the current `TTree` (current file).

## tree_entry_stop

Report.tree_entry_stop

  First entry after the batch (last entry plus one), counting zero at the start of the `TTree` (current file).

## global_entry_start

Report.global_entry_start

  First entry in the batch, counting zero at the start of iteration (potentially over many files).

## global_entry_stop

Report.global_entry_stop

  First entry after the batch (last entry plust one), counting zero at the start of iteration (potentially over many files).

## start

Report.start

  A synonym for global_entry_start.

## stop

Report.stop

  A synonym for global_entry_stop.

## global_offset

Report.global_offset

  Number of entries between the start of iteration and the start of this `TTree`. The global_entry_start and global_entry_stop are equal to tree_entry_start and tree_entry_stop plus `global_offset`.

## to_global

Report.to_global(global_offset)

  Copies the data in this uproot.behaviors.TBranch.Report to another with a new global_offset.