ROC
puma.roc.Roc
#
Bases: puma.plot_base.PlotLineObject
Represent a single ROC curve and allows to calculate ratio w.r.t other ROCs.
Initialise properties of roc curve object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
sig_eff
|
numpy.array
|
Array of signal efficiencies |
required |
bkg_rej
|
numpy.array
|
Array of background rejection |
required |
n_test
|
int
|
Number of events used to calculate the background efficiencies, by default None |
None
|
signal_class
|
str
|
Signal class, e.g. for b-tagging "bjets", by default None |
None
|
rej_class
|
str or ftag.Label
|
Rejection class, e.g. for b-tagging anc charm rejection "cjets", by default None |
None
|
key
|
str
|
Identifier for roc curve e.g. tagger, by default None |
None
|
ratio_group
|
str
|
Identifies the reference ROC group for ratio calculation, by default None |
None
|
**kwargs
|
puma.roc.Roc(kwargs)
|
Keyword arguments passed to |
{}
|
Raises:
Type | Description |
---|---|
ValueError
|
If |
Source code in puma/roc.py
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 |
|
args_to_store
property
#
Returns the arguments that need to be stored/loaded.
Returns:
Type | Description |
---|---|
dict[str, typing.Any]
|
Dict with the arguments |
non_zero
property
#
Abstraction of non_zero_mask
.
Returns:
Type | Description |
---|---|
numpy.array
|
Masked signal efficiency |
numpy.array
|
Masked background rejection |
non_zero_mask
property
#
Masking points where rejection is 0 and no signal efficiency change present.
Returns:
Type | Description |
---|---|
numpy.array
|
Masked indices |
binomial_error
#
Calculate binomial error of roc curve.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
norm
|
bool
|
If True calulate relative error, by default False |
False
|
n_test
|
int
|
Number of events used to calculate the background efficiencies, by default None |
None
|
Returns:
Type | Description |
---|---|
numpy.array
|
Binomial error |
Raises:
Type | Description |
---|---|
ValueError
|
If no |
Source code in puma/roc.py
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 |
|
divide
#
Calculate ratio between the roc curve and another roc.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
roc_comp
|
roc class
|
Second roc curve to calculate ratio with |
required |
inverse
|
bool
|
If False the ratio is calculated |
False
|
Returns:
Type | Description |
---|---|
numpy.array
|
Signal efficiency used for the ratio calculation which is the overlapping interval of the two roc curves |
numpy.array
|
Ratio |
numpy.array or None
|
Ratio_err if |
Source code in puma/roc.py
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 |
|
puma.roc.RocPlot
#
Bases: puma.plot_base.PlotBase
ROC plot class.
ROC plot properties.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
grid
|
bool
|
Set the grid for the plots. |
True
|
**kwargs
|
puma.roc.RocPlot(kwargs)
|
Keyword arguments from |
{}
|
Source code in puma/roc.py
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 |
|
add_ratios
#
Calculating ratios.
Raises:
Type | Description |
---|---|
ValueError
|
If number of reference rocs and ratio panels don't match |
ValueError
|
If no ratio classes are set |
Source code in puma/roc.py
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 |
|
add_roc
#
Adding puma.Roc object to figure.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
roc_curve
|
puma.Roc
|
ROC curve |
required |
key
|
str
|
Unique identifier for roc_curve, by default None |
None
|
reference
|
bool
|
If roc is used as reference for ratio calculation, by default False |
False
|
Raises:
Type | Description |
---|---|
KeyError
|
If unique identifier key is used twice |
Source code in puma/roc.py
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 |
|
draw
#
Draw plotting.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
labelpad
|
int
|
Spacing in points from the axes bounding box including ticks and tick labels, by default None |
None
|
Source code in puma/roc.py
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 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 |
|
get_xlim_auto
#
Returns min and max efficiency values.
Returns:
Type | Description |
---|---|
float
|
Min and max efficiency values |
Source code in puma/roc.py
412 413 414 415 416 417 418 419 420 421 422 423 424 |
|
make_split_legend
#
Draw legend for the case of 2 ratios, splitting up legend into models and rejection class.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
handles
|
list
|
List of Line2D objects to extract info for legend |
required |
Raises:
Type | Description |
---|---|
ValueError
|
If not 2 ratios requested |
Source code in puma/roc.py
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 |
|
plot_ratios
#
Plotting ratio curves.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
axis
|
matplotlib.pyplot.axis
|
matplotlib axis object |
required |
rej_class
|
str
|
Rejection class |
required |
Source code in puma/roc.py
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 |
|
plot_roc
#
Plotting roc curves.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
**kwargs
|
Keyword arguments passed to plt.axis.plot |
{}
|
Returns:
Type | Description |
---|---|
puma.line_plot_2d.Line2D
|
matplotlib Line2D object |
Source code in puma/roc.py
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 |
|
set_ratio_class
#
Associate the rejection class to a ratio panel adn set the legend label.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
ratio_panel
|
int
|
Ratio panel either 1 or 2 |
required |
rej_class
|
Labels
|
Rejeciton class associated to that panel |
required |
Raises:
Type | Description |
---|---|
ValueError
|
if requested ratio panels and given ratio_panel do not match. |
Source code in puma/roc.py
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 |
|
set_roc_reference
#
Setting the reference roc curves used in the ratios.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key
|
str
|
Unique identifier of roc object |
required |
rej_class
|
str
|
Rejection class encoded in roc curve |
required |
ratio_group
|
str
|
Ratio group this roc is reference for, by default None |
None
|
Raises:
Type | Description |
---|---|
ValueError
|
If more rejection classes are set than actual ratio panels available. |
Source code in puma/roc.py
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 |
|