Basf2CalculationProcess Class Reference

Inheritance diagram for Basf2CalculationProcess:

Public Member Functions
def	__init__ (self, result_queue, log_file_name, parameters, path, random_seed=None, max_event=0)
def	prepare (self)
def	initialize_output (self)
def	start_process (self)

Public Attributes
	random_seed
	Random seed to set.
	path
	Path to process.
	max_event
	The maximum number of events to process.
	is_valid
	Set is_valid to false to not show this process in any listings.

Detailed Description

Overload implementation of the HEPProcess with the correct handling of the path calculation.

Definition at line 17 of file calculation_process.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			result_queue,
			log_file_name,
			parameters,
			path,
			random_seed = None,
			max_event = 0
	)

Create a new basf2 calculation process.

Reimplemented from CalculationProcess.

Definition at line 23 of file calculation_process.py.

    def __init__(self, result_queue, log_file_name, parameters, path, random_seed=None, max_event=0):
        """Create a new basf2 calculation process."""
        
        self.random_seed = random_seed
        
        self.path = path
        
        self.max_event = max_event
 
        super().__init__(result_queue=result_queue, log_file_name=log_file_name,
                         parameters=parameters)
 

Member Function Documentation

initialize_output()

def initialize_output

(

self

)

Make sure all output by python and or C is written to the same output file

Definition at line 50 of file calculation_process.py.

    def initialize_output(self):
        """
        Make sure all output by python and or C is written to the same output file
        """
        # reset stdout/stderr (notebooks forward them over zmq)
        sys.stdout = sys.__stdout__
        sys.stderr = sys.__stderr__
 
        # open filename
        logfile = open(self.log_file_name, "wb", 0)
 
        # redirect stdout/stderr to logfile
        os.dup2(logfile.fileno(), sys.stdout.fileno())
        os.dup2(logfile.fileno(), sys.stderr.fileno())
 
        # reset logging to use the new file descriptors
        _basf2.reset_log()
        _basf2.logging.zero_counters()
        _basf2.logging.add_json()
 

prepare()

def prepare

(

self

)

A function to prepare a path with the modules given in path.

Reimplemented from CalculationProcess.

Definition at line 35 of file calculation_process.py.

    def prepare(self):
        """
        A function to prepare a path with the modules given in path.
        """
        if self.path:
            # import late due to side effects with importing ROOT
            from hep_ipython_tools.ipython_handler_basf2 import python_modules
            # Add the progress python module
            self.path.add_module(python_modules.ProgressPython(self.progress_queue_remote))
            # Add the print collections python module
            self.path.add_module(python_modules.PrintCollections(self.result_queue))
        else:
            
            self.is_valid = False
 

start_process()

def start_process

(

self

)

The function given to the process to start the calculation.
Do not call by yourself.
Resets the logging system, logs onto console and a file and sets the queues
(the result queue and the process queue) correctly.

Reimplemented from CalculationProcess.

Definition at line 70 of file calculation_process.py.

    def start_process(self):
        """
        The function given to the process to start the calculation.
        Do not call by yourself.
        Resets the logging system, logs onto console and a file and sets the queues
        (the result queue and the process queue) correctly.
        """
 
        if not self.path:
            return
 
        try:
            if self.random_seed is not None:
                _basf2.set_random_seed(self.random_seed)
 
            # setup output capture
            self.initialize_output()
 
            # and start processing
            _basf2.process(self.path, self.max_event)
 
            self.result_queue.put("ipython.statistics", Basf2CalculationQueueStatistics(_basf2.statistics))
 
            # import ROOT late due to all the side effects
            from ROOT import Belle2  # noqa
            store_arrays = list(Belle2.PyStoreArray.list())
            all_arrays = list(dict(Belle2.DataStore.Instance().getStoreEntryMap(Belle2.DataStore.c_Event)).keys())
 
            nodes = dict(
                name="",
                children=[
                    dict(
                        index=i,
                        name=store_array,
                        key=store_array,
                        relation=[
                            other_store_array for other_store_array in store_arrays if Belle2.DataStore.relationName(
                                store_array,
                                other_store_array) in all_arrays]) for i,
                    store_array in enumerate(store_arrays)])
            nodes_json = json.dumps(nodes)
            self.result_queue.put("ipython.dependencies", nodes_json)
 
        finally:
            self.result_queue.queue.close()
 
            self.progress_queue_remote.send("end")
            self.progress_queue_remote.close()

Member Data Documentation

is_valid

is_valid

Set is_valid to false to not show this process in any listings.

Definition at line 48 of file calculation_process.py.

max_event

max_event

The maximum number of events to process.

Leave 0 to process al events

Definition at line 30 of file calculation_process.py.

path

path

Path to process.

Definition at line 28 of file calculation_process.py.

random_seed

random_seed

Random seed to set.

None will not set it.

Definition at line 26 of file calculation_process.py.

---

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

• framework/scripts/hep_ipython_tools/ipython_handler_basf2/calculation_process.py