import boost_histogram as bh

# Compose axis however you like; this is a 2D histogram
hist = bh.Histogram(
    bh.axis.Regular(2, 0, 1),
    bh.axis.Regular(4, 0.0, 1.0),
)

# Filling can be done with arrays, one per dimension
hist.fill(
    [0.3, 0.5, 0.2],
    [0.1, 0.4, 0.9],
)

# NumPy array view into histogram counts, no overflow bins
values = hist.values()

# Make a new histogram with just the second axis, summing over the first, and
# rebinning the second into larger bins:
h2 = hist[::sum, :: bh.rebin(2)]

• 许多轴类型（全部支持metadata=...）
  • bh.axis.Regular(n, start, stop, ...)：创建一个规则轴。以下列出了选项。
    • overflow=False：关闭溢出bin
    • underflow=False：关闭下溢bin
    • growth=True：开启增长轴，当添加超出范围的项时添加bin
    • circular=True：开启环绕，超出范围的值环绕到轴上
    • transform=bh.axis.transform.Log：对数间距
    • transform=bh.axis.transform.Sqrt：平方根间距
    • transform=bh.axis.transform.Pow(v)：幂间距
    • 另请参阅灵活的函数转换
  • bh.axis.Integer(start, stop, *, underflow=True, overflow=True, growth=False, circular=False)：特殊的高速版本，用于宽度为1的等距bin的regular
  • bh.axis.Variable([start, edge1, edge2, ..., stop], *, underflow=True, overflow=True, circular=False)：不等距bin间距
  • bh.axis.IntCategory([...], *, growth=False)：整数分类
  • bh.axis.StrCategory([...], *, growth=False)：字符串分类
  • bh.axis.Boolean()：True/False轴
• 轴功能
  • .index(value)：轴上（或多个点）的索引
  • .value(index)：轴上分数bin（或多个bin）的值
  • .bin(i)：bin边缘（连续轴）或bin值（离散轴）
  • .centers：N个bin中心（如果是连续的）
  • .edges：N+1个bin边缘（如果是连续的）
  • .extent：bin数量（包括下/溢出）
  • .metadata：用户想要存储的任何内容
  • .traits：设置在轴上的选项
  • .size：bin数量（不包括下/溢出）
  • .widths: N 个箱宽度
• 多种存储类型
  • bh.storage.Double(): 用于加权值的双精度浮点数（默认）
  • bh.storage.Int64(): 64位无符号整数
  • bh.storage.Unlimited(): 开始时较小，但可以扩展到无限精度的整数或双精度浮点数。
  • bh.storage.AtomicInt64(): 线程安全的填充，实验性。不支持在线程中扩展轴。
  • bh.storage.Weight(): 存储权重和权重平方和。
  • bh.storage.Mean(): 接受一个样本并计算样本的均值（配置文件）。
  • bh.storage.WeightedMean(): 接受一个样本和一个权重。计算样本的加权均值。
• 累加器
  • bh.accumulator.Sum: 高精度求和（Neumaier）- 在对数值直方图求和时使用
  • bh.accumulator.WeightedSum: 跟踪加权总和和方差
  • bh.accumulator.Mean: 运行计数、均值和方差（Welford增量算法）
  • bh.accumulator.WeightedMean: 跟踪加权总和、均值和方差（West增量算法）
• 直方图操作
  • h.ndim: 维数数量
  • h.size or len(h): 箱的数量
  • +: 将两个直方图相加（存储类型必须匹配当前类型）
  • *=: 乘以一个标量（不是所有存储类型）(hist * scalar 和 scalar * hist 也支持)
  • /=: 除以一个标量（不是所有存储类型）(hist / scalar 也支持)
  • .kind: 根据存储类型，可以是 bh.Kind.COUNT 或 bh.Kind.MEAN
  • .storage_type: 获取直方图存储类型
  • .sum(flow=False): 所有箱的总计数
  • .project(ax1, ax2, ...): 投影到列出的轴（数字）。也可以重新排序轴。
  • .to_numpy(flow=False, view=False): 转换为NumPy风格的元组（带有或没有下溢/上溢箱）
  • .view(flow=False): 获取对箱内容的视图（带有或没有下溢/上溢箱）
  • .values(flow=False): 获取对值的视图（计数或均值，取决于存储类型）
  • .variances(flow=False): 如果可用，获取方差
  • .counts(flow=False): 获取所有存储类型的有效计数
  • .reset(): 将计数器设置为0（增长轴保持相同大小）
  • .empty(flow=False): 检查直方图是否为空（如果需要，也可以检查流箱）
  • .copy(deep=False): 创建直方图的副本
  • .axes: 获取轴作为元组（也提供所有轴的属性）
    • .axes[0]: 获取第0个轴
    • .axes.edges: 下限值作为广播准备好的数组
    • .axes.centers: 箱中心作为广播准备好的数组
    • .axes.widths: 箱宽度作为广播准备好的数组
    • .axes.metadata: 轴元数据的元组
    • .axes.size: 轴大小的元组（无流的大小）
    • .axes.extent: 轴范围（包含流的范围）的元组
    • .axes.bin(*args): 返回箱边缘作为元组的元组（连续轴）或值（描述）
    • .axes.index(*args): 返回每个轴的值在箱中的索引
    • .axes.value(*args): 返回每个轴的索引在箱中的值
• 索引 - 支持以下链接的索引UHI Indexing
  • 箱内容访问/设置
    • v = h[b]: 通过索引数字访问箱内容
    • v = h[{0:b}]: 所有操作都可以通过 axis:item 字典来表示，而不是通过位置（主要用于切片）
  • 切片以获取直方图或设置值数组
    • h2 = h[a:b]: 访问直方图的切片，如果有必要，切割部分将进入流箱
    • h2 = h[:, ...]: 支持与NumPy相同的 : 和 ...
    • h2 = h[::sum]：切片中的第三个元素是“操作”
    • h[...] = array：设置桶内容，包括或省略流量桶
  • 特殊访问器
    • bh.loc(v)：在坐标轴上提供值而不是桶号
    • bh.underflow：下溢桶（在切片上使用空开始进行切片代替）
    • bh.overflow：溢出桶（在切片上使用空结束进行切片代替）
  • 特殊操作（切片中的第三个元素）
    • sum：通过投影移除轴；如果给出了限制，则使用这些限制
    • bh.rebin(n)：重新对轴进行分箱
• NumPy 兼容性
  • bh.numpy 提供了比 NumPy 历史函数更快的 即插即用替换
  • 直方图遵循缓冲区接口，并提供 .view()
  • 直方图可以使用 .to_numpy() 转换为 NumPy 风格的输出元组
• 详细信息
  • 所有对象都支持复制/深复制/pickle
  • 完全静态类型，使用 MyPy 进行测试。