PrintCollections Class Reference

Inheritance diagram for PrintCollections:

Collaboration diagram for PrintCollections:

Public Member Functions
	__init__ (self, queue)
	initialize (self)
	store_content (self)
	event (self)
	terminate (self)

Public Attributes
	queue = queue
	The queue to handle.
list	store_content_list = []
	The contents of the store arrays for some events.
int	event_number = 0
	The current event number.
int	total_number_of_events = 0
	The total number of events.

Detailed Description

A small module to catch the content of the store array for some events and store them in the queue.

Definition at line 17 of file python_modules.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			queue )

Create the module with the given queue.

Definition at line 23 of file python_modules.py.

    def __init__(self, queue):
        """
        Create the module with the given queue.
        """
        super().__init__()
        
        self.queue = queue
        
        self.store_content_list = []
        
        self.event_number = 0
        
        self.total_number_of_events = 0
 

Member Function Documentation

event()

event

(

self

)

Write the store array content into a list for later.

Definition at line 62 of file python_modules.py.

    def event(self):
        """
        Write the store array content into a list for later.
        """
        if self.total_number_of_events == 0:
            if self.event_number % 1000 == 0:
                self.store_content()
 
        else:
            current_percentage = 1.0 * self.event_number / self.total_number_of_events
 
            if 100 * current_percentage % 10 == 0:
                self.store_content()
 
        self.event_number += 1
 

initialize()

initialize

(

self

)

Get the total number of events from C++

Definition at line 37 of file python_modules.py.

    def initialize(self):
        """
        Get the total number of events from C++
        """
        self.total_number_of_events = Belle2.Environment.Instance().getNumberOfEvents()
 

store_content()

store_content

(

self

)

Store the current content of the store array into the internal list.

Definition at line 43 of file python_modules.py.

    def store_content(self):
        """
        Store the current content of the store array into the internal list.
        """
        registered_store_arrays = Belle2.PyStoreArray.list()
        registered_store_objects = Belle2.PyStoreObj.list()
 
        event_store_content_list = []
 
        for store_array_name in registered_store_arrays:
            store_array = Belle2.PyStoreArray(store_array_name)
            event_store_content_list.append(StoreContent(store_array_name, len(store_array)))
 
        for store_array_name in registered_store_objects:
            event_store_content_list.append(StoreContent(store_array_name, 0))
 
        event_store_content = StoreContentList(content=event_store_content_list, event_number=self.event_number)
        self.store_content_list.append(event_store_content)
 

terminate()

terminate

(

self

)

Write the store array contents from the events to the queue.

Definition at line 78 of file python_modules.py.

    def terminate(self):
        """
        Write the store array contents from the events to the queue.
        """
        self.queue.put("ipython.store_content", self.store_content_list)
 
 

Member Data Documentation

event_number

int event_number = 0

The current event number.

Definition at line 33 of file python_modules.py.

queue

queue = queue

The queue to handle.

Definition at line 29 of file python_modules.py.

store_content_list

store_content_list = []

The contents of the store arrays for some events.

Definition at line 31 of file python_modules.py.

total_number_of_events

int total_number_of_events = 0

The total number of events.

Definition at line 35 of file python_modules.py.

---

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

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