NumBestChecker Class Reference

Inheritance diagram for NumBestChecker:

Collaboration diagram for NumBestChecker:

Public Member Functions
	__init__ (self)
	param (self, kwargs)
	initialize (self)
	event (self)

Public Attributes
	num_best = None
	Number of candidates to keep (must be given as parameter, otherwise assert will fail).
bool	allow_multirank = False
	MultiRank option switch.
	plist = Belle2.PyStoreObj('e-:numBestMultiRank')
	particle list object

Detailed Description

Check if 'numBest' works correctly

Definition at line 106 of file best_candidate_selection.py.

Constructor & Destructor Documentation

__init__()

__init__

(

self

)

Initializing the parameters.

Definition at line 109 of file best_candidate_selection.py.

    def __init__(self):
        """Initializing the parameters."""
        super().__init__()
        
        self.num_best = None
        
        self.allow_multirank = False
 

Member Function Documentation

event()

event

(

self

)

Check if 'e-:numBest' and 'e-:numBestMultiRank' have the expected size

Definition at line 132 of file best_candidate_selection.py.

    def event(self):
        """Check if 'e-:numBest' and 'e-:numBestMultiRank' have the expected size"""
 
        size = self.plist.getListSize()
        if self.allow_multirank:
            px = [particle.getPx() for particle in self.plist]
            px_value_ranks = {v: i for i, v in enumerate(sorted(set(px), reverse=True,
                                                                key=lambda v: -math.inf if math.isnan(v) else v),
                                                         1)}
            remaining_particles = [v for v in px if px_value_ranks[v] <= self.num_best]
            assert size <= len(remaining_particles), "numBest test with multirank failed: " \
                f"there should be {len(remaining_particles)} Particles in the list " \
                f"instead of {size}!"
 
        else:
            # The test fails if size > numBest_value as this is passed as a parameter into the module
            assert size <= self.num_best, f"numBest test failed: there are too many Particles ({size}) in the list!"
 
 
# fixed random numbers

initialize()

initialize

(

self

)

Create particle list 'e-:numBest(MultiRank)' object, depending on parameter choice.

Definition at line 123 of file best_candidate_selection.py.

    def initialize(self):
        """Create particle list 'e-:numBest(MultiRank)' object, depending on parameter choice."""
        if self.allow_multirank:
            
            self.plist = Belle2.PyStoreObj('e-:numBestMultiRank')
        else:
            
            self.plist = Belle2.PyStoreObj('e-:numBest')
 

param()

param	(		self,
			kwargs )

Checking for module parameters to distinguish between the different test cases.

Definition at line 117 of file best_candidate_selection.py.

    def param(self, kwargs):
        """Checking for module parameters to distinguish between the different test cases."""
        self.num_best = kwargs.pop('numBest')
        self.allow_multirank = kwargs.pop('allowMultiRank', False)
        super().param(kwargs)
 

Member Data Documentation

allow_multirank

bool allow_multirank = False

MultiRank option switch.

Definition at line 115 of file best_candidate_selection.py.

num_best

num_best = None

Number of candidates to keep (must be given as parameter, otherwise assert will fail).

Definition at line 113 of file best_candidate_selection.py.

plist

plist = Belle2.PyStoreObj('e-:numBestMultiRank')

particle list object

Definition at line 127 of file best_candidate_selection.py.

---

The documentation for this class was generated from the following file:

• analysis/tests/best_candidate_selection.py