1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
|
from __future__ import annotations
import numpy as np
import pytest
from numpy.testing import assert_array_equal
from pytest import approx
import boost_histogram as bh
def test_1D_get_bin():
h = bh.Histogram(bh.axis.Regular(10, 0, 0.99))
h.fill([0.25, 0.25, 0.25, 0.15])
assert h[0] == 0
assert h[1] == 1
assert h[2] == 3
assert h[bh.loc(0)] == 0
assert h[bh.loc(0.1)] == 1
assert h[bh.loc(0.1) + 1] == 3
assert h[bh.loc(0.2)] == 3
assert h.view()[2] == h[2]
with pytest.raises(IndexError):
h[1, 2]
def test_2D_get_bin():
h = bh.Histogram(bh.axis.Regular(10, 0, 0.99), bh.axis.Regular(10, 0, 0.99))
h.fill(0.15, [0.25, 0.25, 0.25, 0.15])
assert h[0, 0] == 0
assert h[0, 1] == 0
assert h[1, 1] == 1
assert h[1, 2] == 3
assert h[bh.loc(0.1), bh.loc(0.2)] == 3
assert h[bh.loc(0) + 1, bh.loc(0.3) - 1] == 3
assert h.view()[1, 2] == h[1, 2]
with pytest.raises(IndexError):
h[1]
def test_get_1D_histogram():
h = bh.Histogram(bh.axis.Regular(10, 0, 1))
h.fill([0.25, 0.25, 0.25, 0.15])
h2 = h[:]
assert h == h2
h.fill(0.75)
assert h != h2
def test_get_1D_slice():
h1 = bh.Histogram(bh.axis.Regular(10, 0, 1))
h2 = bh.Histogram(bh.axis.Regular(5, 0, 0.5))
h1.metadata = {"that": 3}
h1.fill([0.25, 0.25, 0.25, 0.15])
h2.fill([0.25, 0.25, 0.25, 0.15])
assert h1 != h2
assert h1[:5] == h2
assert h1[: bh.loc(0.5)] == h2
assert h1[2:4] == h2[2:4]
assert h1[bh.loc(0.2) : bh.loc(0.4)] == h2[bh.loc(0.2) : bh.loc(0.4)]
assert len(h1[2:4].view()) == 2
assert len(h1[2 : 4 : bh.rebin(2)].view()) == 1
assert len(h1[:: bh.rebin(2)].view()) == 5
# Shortcut
assert len(h1[bh.rebin(2)].view()) == 5
assert h1[2:4].metadata == {"that": 3}
def test_ellipsis():
h = bh.Histogram(bh.axis.Regular(10, 0, 1), bh.axis.Regular(10, 0, 1))
assert h == h[...]
assert h == h[:, ...]
assert h == h[..., :]
assert h == h[:, :, ...]
assert h == h[:, ..., :]
assert h == h[..., :, :]
with pytest.raises(IndexError):
h[:, :, :, ...]
with pytest.raises(IndexError):
h[:, :, ..., :]
with pytest.raises(IndexError):
h[..., :, :, :]
with pytest.raises(IndexError):
h[..., ...]
assert h[2:4, ...] == h[2:4, :]
def test_basic_projection():
h2 = bh.Histogram(
bh.axis.Regular(10, 0, 10),
bh.axis.Regular(10, 0, 10),
bh.axis.Regular(10, 0, 10),
)
h1 = bh.Histogram(bh.axis.Regular(10, 0, 10))
contents = [[2, 2, 2, 3, 4, 5, 6], [1, 2, 2, 3, 2, 1, 2], [-12, 33, 4, 9, 2, 4, 9]]
h1.fill(contents[0])
h2.fill(*contents)
assert h1 == h2[:, :: bh.sum, :: bh.sum]
assert h1 == h2[..., :: bh.sum, :: bh.sum]
assert h2.sum(flow=True) == h2[:: bh.sum, :: bh.sum, :: bh.sum]
# Python's builtin sum is identical to bh.sum
assert bh.sum is sum
assert h1 == h2[:, ::sum, ::sum]
assert h1 == h2[..., ::sum, ::sum]
assert h2.sum(flow=True) == h2[::sum, ::sum, ::sum]
# Shortcut
assert h1 == h2[:, sum, sum]
assert h1 == h2[..., sum, sum]
assert h2.sum(flow=True) == h2[sum, sum, sum]
def test_slicing_projection():
h1 = bh.Histogram(
bh.axis.Regular(10, 0, 10),
bh.axis.Regular(10, 0, 10),
bh.axis.Regular(10, 0, 10),
)
X, Y, Z = np.mgrid[-0.5:10.5:12j, -0.5:10.5:12j, -0.5:10.5:12j]
h1.fill(X.ravel(), Y.ravel(), Z.ravel())
assert h1[:: bh.sum, :: bh.sum, :: bh.sum] == 12**3
assert h1[0 : len : bh.sum, 0 : len : bh.sum, 0 : len : bh.sum] == 10**3
assert h1[0 : bh.overflow : bh.sum, 0 : len : bh.sum, :: bh.sum] == 10 * 10 * 12
assert h1[:: bh.sum, 0 : len : bh.sum, :: bh.sum] == 10 * 12 * 12
# make sure nothing was modified
assert h1.sum() == 10**3
assert h1.sum(flow=True) == 12**3
h2 = h1[0 : 3 : bh.sum, ...]
assert h2[1, 2] == 3
h3 = h2[:, 5 : 7 : bh.sum]
assert h3[1] == 6
# Select one bin
assert h1[2, :: bh.sum, :: bh.sum] == 12 * 12
# Select one bin
assert h1[2, 7, :: bh.sum] == 12
def test_mix_value_with_slice():
h = bh.Histogram(
bh.axis.Regular(10, 0, 10), bh.axis.Regular(10, 0, 10), bh.axis.Integer(0, 2)
)
vals = np.arange(100).reshape(10, 10, 1)
h[:, :, 1:2] = vals
print(h.view()[:3, :3, :])
assert h[0, 1, True] == 1
assert h[1, 0, True] == 10
assert h[1, 1, True] == 11
assert h[3, 4, False] == 0
assert_array_equal(h[:, :, True].view(), vals[:, :, 0])
assert_array_equal(h[:, :, False].view(), 0)
def test_mix_value_with_slice_2():
h = bh.Histogram(
bh.axis.Regular(10, 0, 10), bh.axis.Regular(10, 0, 10), bh.axis.Integer(0, 2)
)
vals = np.arange(100).reshape(10, 10)
h[:, :, True] = vals
assert h[0, 1, True] == 1
assert h[1, 0, True] == 10
assert h[1, 1, True] == 11
assert h[3, 4, False] == 0
assert_array_equal(h[:, :, True].view(), vals)
assert_array_equal(h[:, :, False].view(), 0)
h2 = h[bh.rebin(2), bh.rebin(5), :]
assert_array_equal(h2.shape, (5, 2, 2))
def test_one_sided_slice():
h = bh.Histogram(bh.axis.Regular(4, 1, 5))
h.view(True)[:] = 1
assert h[sum] == 6 # 4 (internal bins) + 2 (flow bins)
assert h[bh.tag.at(-1) : bh.tag.at(5) : sum] == 6 # keeps underflow, keeps overflow
# check that slicing without bh.sum adds removed counts to flow bins
assert_array_equal(h[1:3].view(True), [2, 1, 1, 2])
assert h[0::sum] == 5 # removes underflow, keeps overflow
assert h[:4:sum] == 5 # removes overflow, keeps underflow
assert h[0:4:sum] == 4 # removes underflow and overflow
assert h[bh.loc(1) :: sum] == 5 # remove underflow
assert h[: bh.loc(5) : sum] == 5 # remove overflow
assert h[bh.loc(1) : bh.loc(5) : sum] == 4 # removes underflow and overflow
assert h[bh.loc(0) :: sum] == 6 # keep underflow
assert h[: bh.loc(10) + 1 : sum] == 6 # keep overflow
assert h[bh.loc(0) : bh.loc(10) + 1 : sum] == 6
def test_repr():
assert repr(bh.loc(2)) == "loc(2)"
assert repr(bh.loc(3) + 1) == "loc(3) + 1"
assert repr(bh.loc(1) - 2) == "loc(1) - 2"
assert repr(bh.underflow) == "underflow"
assert repr(bh.underflow + 1) == "underflow + 1"
assert repr(bh.underflow - 1) == "underflow - 1"
assert repr(bh.overflow) == "overflow"
assert repr(bh.overflow + 1) == "overflow + 1"
assert repr(bh.overflow - 1) == "overflow - 1"
assert repr(bh.rebin(2)) == "rebin(factor=2)"
# Was broken in 0.6.1
def test_noflow_slicing():
noflow = {"underflow": False, "overflow": False}
h = bh.Histogram(
bh.axis.Regular(10, 0, 10),
bh.axis.Regular(10, 0, 10, **noflow),
bh.axis.Integer(0, 2, **noflow),
)
vals = np.arange(100).reshape(10, 10)
h[:, :, True] = vals
assert h[0, 1, True] == 1
assert h[1, 0, True] == 10
assert h[1, 1, True] == 11
assert h[3, 4, False] == 0
assert h[{0: 3, 1: 4, 2: False}] == 0
assert_array_equal(h[:, :, True].view(), vals)
assert_array_equal(h[:, :, False].view(), 0)
def test_singleflow_slicing():
h = bh.Histogram(
bh.axis.Integer(0, 4, underflow=False), bh.axis.Integer(0, 4, overflow=False)
)
vals = np.arange(4 * 4).reshape(4, 4)
h[:, :] = vals
assert h[0, 0] == 0
assert h[0, 1] == 1
assert h[1, 0] == 4
assert h[1, 1] == 5
assert_array_equal(h[:, 1 : 3 : bh.sum], vals[:, 1:3].sum(axis=1))
assert_array_equal(h[{1: slice(1, 3, bh.sum)}], vals[:, 1:3].sum(axis=1))
assert_array_equal(h[1 : 3 : bh.sum, :], vals[1:3, :].sum(axis=0))
def test_set_range_with_scalar():
h = bh.Histogram(bh.axis.Integer(0, 10))
h[2:5] = 42
assert h[1] == 0
assert h[2] == 42
assert h[3] == 42
assert h[4] == 42
assert h[5] == 0
def test_set_range_with_scalar_callable():
h = bh.Histogram(bh.axis.Integer(0, 10))
h[2:len] = 42
assert h[1] == 0
assert h[2] == 42
assert h[3] == 42
assert h[4] == 42
assert h[5] == 42
assert h[bh.overflow] == 0
def test_set_all_with_scalar():
h = bh.Histogram(bh.axis.Integer(0, 10))
h[:] = 42
assert h[0] == 42
assert h[9] == 42
assert h[::sum] == 42 * 10
def test_pick_str_category():
noflow = {"underflow": False, "overflow": False}
h = bh.Histogram(
bh.axis.Regular(10, 0, 10),
bh.axis.Regular(10, 0, 10, **noflow),
bh.axis.StrCategory(["on", "off", "maybe"]),
)
vals = np.arange(100).reshape(10, 10)
h[:, :, bh.loc("on")] = vals
assert h[0, 1, bh.loc("on")] == 1
assert h[1, 0, bh.loc("on")] == 10
assert h[1, 1, bh.loc("on")] == 11
assert h[3, 4, bh.loc("maybe")] == 0
assert_array_equal(h[:, :, bh.loc("on")].view(), vals)
assert_array_equal(h[{2: bh.loc("on")}].view(), vals)
assert_array_equal(h[:, :, bh.loc("off")].view(), 0)
def test_string_requirement():
h = bh.Histogram(
bh.axis.Integer(0, 10),
bh.axis.StrCategory(["1", "a", "hello"]),
storage=bh.storage.Int64(),
)
with pytest.raises(TypeError):
h[bh.loc("1"), bh.loc(1)]
with pytest.raises(TypeError):
h[bh.loc(1), bh.loc(1)]
with pytest.raises(TypeError):
h[bh.loc("1"), bh.loc("1")]
assert h[bh.loc(1), bh.loc("1")] == 0
def test_pick_int_category():
noflow = {"underflow": False, "overflow": False}
h = bh.Histogram(
bh.axis.Regular(10, 0, 10),
bh.axis.Regular(10, 0, 10, **noflow),
bh.axis.IntCategory([3, 5, 7, 12, 13]),
)
vals = np.arange(100).reshape(10, 10)
h[:, :, bh.loc(3)] = vals
h[:, :, bh.loc(5)] = vals + 1
h[:, :, 3] = vals + 100
assert h[0, 1, bh.loc(3)] == 1
assert h[1, 0, bh.loc(5)] == 10 + 1
assert h[1, 1, bh.loc(5)] == 11 + 1
assert h[3, 4, bh.loc(7)] == 0
assert h[3, 4, bh.loc(12)] == 134
assert_array_equal(h[:, :, bh.loc(3)].view(), vals)
assert_array_equal(h[{2: bh.loc(3)}].view(), vals)
assert_array_equal(h[:, :, bh.loc(5)].view(), vals + 1)
assert_array_equal(h[:, :, bh.loc(7)].view(), 0)
@pytest.mark.parametrize(
"ax",
[bh.axis.Regular(3, 0, 1), bh.axis.Variable([0, 0.3, 0.6, 1])],
ids=["regular", "variable"],
)
def test_pick_flowbin(ax):
w = 1e-2 # e.g. a cross section for a process
x = [-0.1, -0.1, 0.1, 0.1, 0.1]
y = [-0.1, 0.1, -0.1, -0.1, 0.1]
h = bh.Histogram(
ax,
ax,
storage=bh.storage.Weight(),
)
h.fill(x, y, weight=w)
uf_slice = h[bh.tag.underflow, ...]
assert uf_slice.values(flow=True) == approx(np.array([1, 1, 0, 0, 0]) * w)
uf_slice = h[..., bh.tag.underflow]
assert uf_slice.values(flow=True) == approx(np.array([1, 2, 0, 0, 0]) * w)
def test_axes_tuple():
h = bh.Histogram(bh.axis.Regular(10, 0, 1))
assert isinstance(h.axes[:1], bh.axis.AxesTuple)
assert isinstance(h.axes[0], bh.axis.Regular)
(before,) = h.axes.centers[:1]
(after,) = h.axes[:1].centers
assert_array_equal(before, after)
def test_axes_tuple_Nd():
h = bh.Histogram(
bh.axis.Integer(0, 5), bh.axis.Integer(0, 4), bh.axis.Integer(0, 6)
)
assert isinstance(h.axes[:2], bh.axis.AxesTuple)
assert isinstance(h.axes[1], bh.axis.Integer)
b1, b2 = h.axes.centers[1:3]
a1, a2 = h.axes[1:3].centers
assert_array_equal(b1.flatten(), a1.flatten())
assert_array_equal(b2.flatten(), a2.flatten())
assert b1.ndim == 3
assert a1.ndim == 2
# issue 556
def test_single_flow_bin():
# Flow is removed for category axes unless full sum is used
h = bh.Histogram(bh.axis.IntCategory([0, 1, 2]))
h.view(True)[:] = 1
assert h[::sum] == 4
assert h[0::sum] == 3
assert h[1::sum] == 2
assert h[2::sum] == 1
with pytest.raises(ValueError):
h[3::sum]
assert h[1:2][sum] == 4
h = bh.Histogram(bh.axis.Integer(0, 3))
h.view(True)[:] = 1
assert h[::sum] == 5
assert h[0::sum] == 4
assert h[1::sum] == 3
assert h[2::sum] == 2
assert h[3::sum] == 1
assert h[1:2][sum] == 5
# issue 579
def test_scale_flowbins():
w = 1e-1
x = np.random.normal(loc=0.4, scale=0.4, size=100)
h = bh.Histogram(bh.axis.Variable([0, 0.5, 1]), storage=bh.storage.Weight())
h.fill(x, weight=w)
ref_value = h.values(flow=True) * 5
scale_value = (h * 5).values(flow=True)
assert scale_value == approx(ref_value)
def test_add_flowbins():
h = bh.Histogram(bh.axis.Variable([0, 0.5, 1]), storage=bh.storage.Weight())
ref_value = h.values(flow=True) + 5
scale_value = (h + 5).values(flow=True)
assert scale_value == approx(ref_value)
# issue 737
def test_large_index():
h = bh.Histogram(
bh.axis.IntCategory([4, 8, 15, 16, 23, 42, 99_999_001, 1_000_010_020])
)
assert h.axes[0].value(6) == 99_999_001
assert h.axes[0].index(99_999_001) == 6
def test_scaling_slice():
h = bh.Histogram(bh.axis.Regular(3, 0, 3), bh.axis.StrCategory(["a", "b"]))
h.fill([1, 1, 2], "a")
h.fill([0], "b")
h[:, bh.loc("a")] *= 2
assert h[1, 0] == approx(4)
assert h[2, 0] == approx(2)
assert h[0, 1] == approx(1)
def test_scaling_slice_weight():
h = bh.Histogram(
bh.axis.Regular(3, 0, 3),
bh.axis.StrCategory(["a", "b"]),
storage=bh.storage.Weight(),
)
h.fill([1, 1, 2], "a")
h.fill([0], "b")
h[:, bh.loc("a")] *= 2
assert h[1, 0].value == approx(4)
assert h[2, 0].value == approx(2)
assert h[0, 1].value == approx(1)
def test_setting_histogram_mismatch():
h = bh.Histogram(bh.axis.Regular(10, 0, 10), bh.axis.Integer(0, 20))
h[:, 0] = bh.Histogram(bh.axis.Regular(10, 0, 10))
h[0:, 0] = bh.Histogram(bh.axis.Regular(10, 0, 10, underflow=False))
h[:len, 0] = bh.Histogram(bh.axis.Regular(10, 0, 10, overflow=False))
h[0:len, 0] = bh.Histogram(
bh.axis.Regular(10, 0, 10, underflow=False, overflow=False)
)
with pytest.raises(ValueError, match="Cannot set histogram with underflow"):
h[0:, 0] = bh.Histogram(bh.axis.Regular(10, 0, 10))
with pytest.raises(ValueError, match="Cannot set histogram with underflow"):
h[:len, 0] = bh.Histogram(bh.axis.Regular(10, 0, 10))
with pytest.raises(ValueError, match="Cannot set histogram with underflow"):
h[:, 0] = bh.Histogram(bh.axis.Regular(10, 0, 10, underflow=False))
with pytest.raises(ValueError, match="Cannot set histogram with underflow"):
h[:, 0] = bh.Histogram(bh.axis.Regular(10, 0, 10, overflow=False))
with pytest.raises(ValueError, match="Cannot set histogram with underflow"):
h[:, 0] = bh.Histogram(
bh.axis.Regular(10, 0, 10, underflow=False, overflow=False)
)
with pytest.raises(ValueError, match="Cannot set histogram with underflow"):
h[0:, 0] = bh.Histogram(
bh.axis.Regular(10, 0, 10, underflow=False, overflow=False)
)
with pytest.raises(ValueError, match="Cannot set histogram with underflow"):
h[:len, 0] = bh.Histogram(
bh.axis.Regular(10, 0, 10, underflow=False, overflow=False)
)
def test_rebin_groups_no_inplace_modification():
"""
Test that rebinning with a groups list does not mutate the input list in-place.
This ensures consecutive rebin operations with the same list do not fail.
"""
h1 = bh.Histogram(bh.axis.Regular(60, 0, 600))
h2 = bh.Histogram(bh.axis.Regular(60, 0, 600))
rebinner = [5] * 12
h3 = h1[bh.rebin(groups=rebinner)]
# The original list should remain unchanged
assert rebinner == [5] * 12, "rebinner list was mutated in-place"
# Second rebin should not raise
h4 = h2[bh.rebin(groups=rebinner)]
assert h3 == h4
|