TrainingDataInformation Class Reference

Public Member Functions
	__init__ (self, typing.Sequence[config.Particle] particles, str outputPath='')
bool	available (self)
pybasf2.Path	reconstruct (self)
	get_mc_counts (self)

Public Attributes
	particles = particles
	list of config.Particle objects
	filename = os.path.join(outputPath, 'mcParticlesCount.root')
	filename

Detailed Description

Contains the relevant information about the used training data.
Basically we write out the number of MC particles in the whole dataset.
This numbers we can use to calculate what fraction of candidates we have to write
out as TrainingData to get a reasonable amount of candidates to train on
(too few candidates will lead to heavy overtraining, too many won't fit into memory).
Secondly we can use this information for the generation of the monitoring pdfs,
where we calculate reconstruction efficiencies.

Definition at line 74 of file core.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
		typing.Sequence[config.Particle]	particles,
		str	outputPath = '' )

Create a new TrainingData object
@param particles list of config.Particle objects
@param outputPath path to the output directory

Definition at line 85 of file core.py.

    def __init__(self, particles: typing.Sequence[config.Particle], outputPath: str = ''):
        """
        Create a new TrainingData object
        @param particles list of config.Particle objects
        @param outputPath path to the output directory
        """
        
        self.particles = particles
        
        self.filename = os.path.join(outputPath, 'mcParticlesCount.root')
 

Member Function Documentation

available()

bool available

(

self

)

Check if the relevant information is already available

Definition at line 96 of file core.py.

    def available(self) -> bool:
        """
        Check if the relevant information is already available
        """
        return os.path.isfile(self.filename)
 

get_mc_counts()

get_mc_counts

(

self

)

Read out the number of MC particles from the file created by reconstruct

Definition at line 119 of file core.py.

    def get_mc_counts(self):
        """
        Read out the number of MC particles from the file created by reconstruct
        """
        # Unique absolute pdg-codes of all particles
        # Always avoid the top-level 'import ROOT'.
        import ROOT  # noqa
        root_file = ROOT.TFile.Open(self.filename, 'read')
        mc_counts = {}
 
        for key in root_file.GetListOfKeys():
            variable = ROOT.Belle2.MakeROOTCompatible.invertMakeROOTCompatible(key.GetName())
            pdg = abs(int(variable[len('NumberOfMCParticlesInEvent('):-len(")")]))
            hist = key.ReadObj()
            mc_counts[pdg] = {}
            mc_counts[pdg]['sum'] = sum(hist.GetXaxis().GetBinCenter(bin + 1) * hist.GetBinContent(bin + 1)
                                        for bin in range(hist.GetNbinsX()))
            mc_counts[pdg]['std'] = hist.GetStdDev()
            mc_counts[pdg]['avg'] = hist.GetMean()
            mc_counts[pdg]['max'] = hist.GetXaxis().GetBinCenter(hist.FindLastBinAbove(0.0))
            mc_counts[pdg]['min'] = hist.GetXaxis().GetBinCenter(hist.FindFirstBinAbove(0.0))
 
        mc_counts[0] = {}
        mc_counts[0]['sum'] = hist.GetEntries()  # this is the total number of ALL events, does not matter which hist we take
        root_file.Close()
        return mc_counts
 
 

reconstruct()

pybasf2.Path reconstruct

(

self

)

Returns pybasf2.Path which counts the number of MCParticles in each event.
@param particles list of config.Particle objects

Definition at line 102 of file core.py.

    def reconstruct(self) -> pybasf2.Path:
        """
        Returns pybasf2.Path which counts the number of MCParticles in each event.
        @param particles list of config.Particle objects
        """
        # Unique absolute pdg-codes of all particles
        pdgs = {abs(pdg.from_name(particle.name)) for particle in self.particles}
 
        path = basf2.create_path()
        module = basf2.register_module('VariablesToHistogram')
        module.set_name("VariablesToHistogram_MCCount")
        module.param('variables', [(f'NumberOfMCParticlesInEvent({pdg})', 100, -0.5, 99.5) for pdg in pdgs])
        module.param('fileName', self.filename)
        module.param('ignoreCommandLineOverride', True)
        path.add_module(module)
        return path
 

Member Data Documentation

filename

filename = os.path.join(outputPath, 'mcParticlesCount.root')

filename

Definition at line 94 of file core.py.

particles

particles = particles

list of config.Particle objects

Definition at line 92 of file core.py.

---

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

• analysis/scripts/fei/core.py