hist.axis package#
- class hist.axis.ArrayTuple(iterable=(), /)#
Bases:
tuple
- broadcast() 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.axis.AxesMixin#
Bases:
object
- property label: str#
Get or set the label for the Regular axis
- property name: str#
Get the name for the Regular axis
- class hist.axis.AxisProtocol(*args, **kwargs)#
Bases:
Protocol
- label: str#
- metadata: Any#
- property name: str#
- class hist.axis.Boolean(*, name: str = '', label: str = '', metadata: Any | None = None, __dict__: dict[str, Any] | None = None)#
Bases:
AxesMixin
,Boolean
- class hist.axis.IntCategory(categories: Iterable[int], *, name: str = '', label: str = '', metadata: Any | None = None, growth: bool = False, __dict__: dict[str, Any] | None = None)#
Bases:
AxesMixin
,IntCategory
- class hist.axis.Integer(start: int, stop: int, *, name: str = '', label: str = '', metadata: Any | None = None, flow: bool = True, underflow: bool | None = None, overflow: bool | None = None, growth: bool = False, circular: bool = False, __dict__: dict[str, Any] | None = None)#
Bases:
AxesMixin
,Integer
- class hist.axis.NamedAxesTuple(_AxesTuple__iterable: Iterable[Axis])#
Bases:
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.
- class hist.axis.Regular(bins: int, start: float, stop: float, *, name: str = '', label: str = '', metadata: Any | None = None, flow: bool = True, underflow: bool | None = None, overflow: bool | None = None, growth: bool = False, circular: bool = False, transform: AxisTransform | None = None, __dict__: dict[str, Any] | None = None)#
Bases:
AxesMixin
,Regular
- class hist.axis.StrCategory(categories: Iterable[str], *, name: str = '', label: str = '', metadata: Any | None = None, growth: bool = False, __dict__: dict[str, Any] | None = None)#
Bases:
AxesMixin
,StrCategory
- class hist.axis.Variable(edges: Iterable[float], *, name: str = '', label: str = '', metadata: Any | None = None, flow: bool = True, underflow: bool | None = None, overflow: bool | None = None, growth: bool = False, circular: bool = False, __dict__: dict[str, Any] | None = None)#
Bases:
AxesMixin
,Variable