hist.axestuple module#

class hist.axestuple.ArrayTuple(iterable=(), /)#

Bases: tuple

broadcast() boost_histogram._internal.axestuple.A#

The arrays in this tuple will be compressed if possible to save memory. Use this method to broadcast them out into their full memory representation.

class hist.axestuple.AxesTuple(_AxesTuple__iterable: Iterable[boost_histogram.axis.Axis])#

Bases: tuple

bin(*indexes: float) Tuple[float, ...]#

Return the edges of the bins as a tuple for a continuous axis or the bin value for a non-continuous axis, when given an index.

property centers: boost_histogram.axis.ArrayTuple#
property edges: boost_histogram.axis.ArrayTuple#
property extent: Tuple[int, ...]#
index(*values: float) Tuple[float, ...]#

Return the fractional index(es) given a value (or values) on the axis.

property size: Tuple[int, ...]#
value(*indexes: float) Tuple[float, ...]#

Return the value(s) given an (fractional) index (or indices).

property widths: boost_histogram.axis.ArrayTuple#
class hist.axestuple.NamedAxesTuple(_AxesTuple__iterable: Iterable[boost_histogram.axis.Axis])#

Bases: boost_histogram.axis.AxesTuple

property label: tuple[str]#

The labels of the axes. Defaults to name if label not given, or Axis N if neither was given.

property name: tuple[str]#

The names of the axes. May be empty strings.