uproot.behaviors.TH1.TH1

Defined in uproot.behaviors.TH1 on line 214.

Inheritance order:

  1. uproot.behaviors.TH1.Histogram

class uproot.behaviors.TH1.TH1

Behaviors for one-dimensional histograms: descendants of ROOT’s TH1, not including TProfile, TH2, TH3, or their descendants.

to_numpy

TH1.to_numpy(flow=False, dd=False)
Parameters
  • flow (bool) – If True, include underflow and overflow bins; otherwise, only normal (finite-width) bins are included.

  • dd (bool) – If True, the return type follows numpy.histogramdd; otherwise, it follows numpy.histogram and numpy.histogram2d.

Converts the histogram into a form like the ones produced by the NumPy histogram functions.

name

Inherited from uproot.behaviors.TH1.Histogram.

TH1.name

The name of the histogram.

title

Inherited from uproot.behaviors.TH1.Histogram.

TH1.title

The title of the histogram.

axes

Inherited from uproot.behaviors.TH1.Histogram.

TH1.axes

axis

Inherited from uproot.behaviors.TH1.Histogram.

TH1.axis(axis=0)

Returns a specified uproot.behaviors.TAxis.TAxis object.

The axis can be specified as

  • a non-negative integer: 0 is the first axis, 1 is the second, and 2 is the third.

  • a negative integer: -1 is the last axis, -2 is the second-to-last, and -3 is the third-to-last.

  • a string: "x" is the first axis, "y" is the second, and "z" is the third

(assuming that the histogram dimension supports a given axis).

weighted

Inherited from uproot.behaviors.TH1.Histogram.

TH1.weighted

kind

Inherited from uproot.behaviors.TH1.Histogram.

TH1.kind

values

Inherited from uproot.behaviors.TH1.Histogram.

TH1.values(flow=False)
Parameters

flow (bool) – If True, include underflow and overflow bins before and after the normal (finite-width) bins.

Bin contents as a 1, 2, or 3 dimensional numpy.ndarray. The numpy.dtype of this array depends on the histogram type.

Setting flow=True increases the length of each dimension by two.

errors

Inherited from uproot.behaviors.TH1.Histogram.

TH1.errors(flow=False)
Parameters

flow (bool) – If True, include underflow and overflow bins before and after the normal (finite-width) bins.

Errors (uncertainties) in the values as a 1, 2, or 3 dimensional numpy.ndarray of numpy.float64.

If fSumw2 (weights) are available, they will be used in the calculation of the errors. If not, errors are assumed to be the square root of the values.

Setting flow=True increases the length of each dimension by two.

variances

Inherited from uproot.behaviors.TH1.Histogram.

TH1.variances(flow=False)
Parameters

flow (bool) – If True, include underflow and overflow bins before and after the normal (finite-width) bins.

Variances (uncertainties squared) in the values as a 1, 2, or 3 dimensional numpy.ndarray of numpy.float64.

If fSumw2 (weights) are available, they will be used in the calculation of the variances. If not, variances are assumed to be equal to the values.

Setting flow=True increases the length of each dimension by two.

counts

Inherited from uproot.behaviors.TH1.Histogram.

TH1.counts(flow=False)
Parameters

flow (bool) – If True, include underflow and overflow bins before and after the normal (finite-width) bins.

Returns the (possibly weighted) number of entries in each bin. For histograms, this is equal to values.

to_boost

Inherited from uproot.behaviors.TH1.Histogram.

TH1.to_boost(metadata={'label': 'fTitle', 'name': 'fName'}, axis_metadata={'label': 'fTitle', 'name': 'fName'})
Parameters
  • metadata (dict of str → str) – Metadata to collect (keys) and their C++ class member names (values).

  • axis_metadata (dict of str → str) – Metadata to collect from each axis.

Converts the histogram into a boost-histogram object.

to_hist

Inherited from uproot.behaviors.TH1.Histogram.

TH1.to_hist(metadata={'label': 'fTitle', 'name': 'fName'}, axis_metadata={'label': 'fTitle', 'name': 'fName'})
Parameters
  • metadata (dict of str → str) – Metadata to collect (keys) and their C++ class member names (values).

  • axis_metadata (dict of str → str) – Metadata to collect from each axis.

Converts the histogram into a hist object.