hist.quick_construct module

class hist.quick_construct.ConstructProxy(hist_class: type[BaseHist[Any]], *axes: AxisProtocol)

Bases: QuickConstruct

AtomicInt64(*, metadata: Any = None, data: np.typing.NDArray[Any] | None = None, label: str | None = None, name: str | None = None) → BaseHist[bh.storage.AtomicInt64]

Double(*, metadata: Any = None, data: np.typing.NDArray[Any] | None = None, label: str | None = None, name: str | None = None) → BaseHist[bh.storage.Double]

Int64(*, metadata: Any = None, data: np.typing.NDArray[Any] | None = None, label: str | None = None, name: str | None = None) → BaseHist[bh.storage.Int64]

Mean(*, metadata: Any = None, data: np.typing.NDArray[Any] | None = None, label: str | None = None, name: str | None = None) → BaseHist[bh.storage.Mean]

MultiCell(nelem: int, *, metadata: Any = None, data: np.typing.NDArray[Any] | None = None, label: str | None = None, name: str | None = None) → BaseHist[bh.storage.MultiCell]

Unlimited(*, metadata: Any = None, data: np.typing.NDArray[Any] | None = None, label: str | None = None, name: str | None = None) → BaseHist[bh.storage.Unlimited]

Weight(*, metadata: Any = None, data: np.typing.NDArray[Any] | None = None, label: str | None = None, name: str | None = None) → BaseHist[bh.storage.Weight]

WeightedMean(*, metadata: Any = None, data: np.typing.NDArray[Any] | None = None, label: str | None = None, name: str | None = None) → BaseHist[bh.storage.WeightedMean]

class hist.quick_construct.MetaConstructor

Bases: type

property new: QuickConstruct

class hist.quick_construct.QuickConstruct(hist_class: type[BaseHist[Any]], *axes: AxisProtocol)

Bases: object

Create a quick construct instance. This is the “base” quick constructor; it will always require at least one axes to be added before allowing a storage or fill to be performed.

Bool(name: str = '', label: str = '', metadata: Any = None, __dict__: dict[str, Any] | None = None) → ConstructProxy

Boolean(name: str = '', label: str = '', metadata: Any = None, __dict__: dict[str, Any] | None = None) → ConstructProxy

Func(bins: int, start: float, stop: float, *, name: str = '', label: str = '', forward: Callable[[float], float], inverse: Callable[[float], float], metadata: Any = None, __dict__: dict[str, Any] | None = None) → ConstructProxy

Int(start: int, stop: int, *, name: str = '', label: str = '', metadata: Any = None, flow: bool = True, underflow: bool | None = None, overflow: bool | None = None, growth: bool = False, circular: bool = False, __dict__: dict[str, Any] | None = None) → ConstructProxy

IntCat(categories: Iterable[int], *, name: str = '', label: str = '', metadata: Any = None, growth: bool = False, __dict__: dict[str, Any] | None = None) → ConstructProxy

IntCategory(categories: Iterable[int], *, name: str = '', label: str = '', metadata: Any = None, growth: bool = False, __dict__: dict[str, Any] | None = None) → ConstructProxy

Integer(start: int, stop: int, *, name: str = '', label: str = '', metadata: Any = None, flow: bool = True, underflow: bool | None = None, overflow: bool | None = None, growth: bool = False, circular: bool = False, __dict__: dict[str, Any] | None = None) → ConstructProxy

Log(bins: int, start: float, stop: float, *, name: str = '', label: str = '', metadata: Any = None, __dict__: dict[str, Any] | None = None) → ConstructProxy

Pow(bins: int, start: float, stop: float, *, name: str = '', label: str = '', power: float, metadata: Any = None, __dict__: dict[str, Any] | None = None) → ConstructProxy

Reg(bins: int, start: float, stop: float, *, name: str = '', label: str = '', metadata: Any = 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) → ConstructProxy

Regular(bins: int, start: float, stop: float, *, name: str = '', label: str = '', metadata: Any = 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) → ConstructProxy

Sqrt(bins: int, start: float, stop: float, *, name: str = '', label: str = '', metadata: Any = None, __dict__: dict[str, Any] | None = None) → ConstructProxy

StrCat(categories: Iterable[str], *, name: str = '', label: str = '', metadata: Any = None, growth: bool = False, __dict__: dict[str, Any] | None = None) → ConstructProxy

StrCategory(categories: Iterable[str], *, name: str = '', label: str = '', metadata: Any = None, growth: bool = False, __dict__: dict[str, Any] | None = None) → ConstructProxy

Var(edges: Iterable[float], *, name: str = '', label: str = '', metadata: Any = None, flow: bool = True, underflow: bool | None = None, overflow: bool | None = None, growth: bool = False, circular: bool = False, __dict__: dict[str, Any] | None = None) → ConstructProxy

Variable(edges: Iterable[float], *, name: str = '', label: str = '', metadata: Any = None, flow: bool = True, underflow: bool | None = None, overflow: bool | None = None, growth: bool = False, circular: bool = False, __dict__: dict[str, Any] | None = None) → ConstructProxy

axes

hist_class