SaveFlag Class Reference

Inheritance diagram for SaveFlag:

Collaboration diagram for SaveFlag:

Public Member Functions
def	__init__ (self, out_file=None)
def	initialize (self)
def	event (self)
def	terminate (self)

Public Attributes
	out_file
	Output file path for saving the event numbers.
	eventInfo
	Initialise event metadata from data store.
	pass_list
	List to save event numbers of pass events.

Detailed Description

Save event numbers to a Parquet file.

Arguments:
    out_file (str): Output file path for saving the event numbers.

Returns:
    None

Note:
    This module should be added after the skimming process.

Definition at line 22 of file NN_trainer_module.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			out_file = None
	)

Initialize the SaveFlag module.

:param out_file: Output file path for saving the event numbers.

Definition at line 36 of file NN_trainer_module.py.

    def __init__(self, out_file=None):
        """
        Initialize the SaveFlag module.
 
        :param out_file: Output file path for saving the event numbers.
        """
        super().__init__()
        
        self.out_file = out_file
 

Member Function Documentation

event()

def event

(

self

)

Process each event and append event numbers to the pass list.

Definition at line 55 of file NN_trainer_module.py.

    def event(self):
        """
        Process each event and append event numbers to the pass list.
        """
        self.pass_list.append(self.eventInfo.getEvent())
 

initialize()

def initialize

(

self

)

Initialize the data store and the list to save event numbers before processing events.

Definition at line 46 of file NN_trainer_module.py.

    def initialize(self):
        """
        Initialize the data store and the list to save event numbers before processing events.
        """
        
        self.eventInfo = Belle2.PyStoreObj('EventMetaData')
        
        self.pass_list = []
 

terminate()

def terminate

(

self

)

Finalize the module and save the pass list to a Parquet file.

Definition at line 61 of file NN_trainer_module.py.

    def terminate(self):
        """
        Finalize the module and save the pass list to a Parquet file.
        """
        ak.to_parquet(self.pass_list, self.out_file)
 
 

Member Data Documentation

eventInfo

eventInfo

Initialise event metadata from data store.

Definition at line 51 of file NN_trainer_module.py.

out_file

out_file

Output file path for saving the event numbers.

Definition at line 44 of file NN_trainer_module.py.

pass_list

pass_list

List to save event numbers of pass events.

Definition at line 53 of file NN_trainer_module.py.

---

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

• generators/scripts/smartBKG/b2modules/NN_trainer_module.py