CalibrationCheckerBase Class Reference

Inheritance diagram for CalibrationCheckerBase:

Public Member Functions
	__init__ (self, objType_list=[])
	initialize (self, checker_list=[])
	valid (self)
	define_graphs (self)
	fill_graphs (self)
	draw_plots (self)
	beginRun (self)
	terminate (self)

Public Attributes
dict	condition_checkers = {}
	condition checkers which are associated to this calibration.

Detailed Description

Abstract base class for generating plots from calibrations which save multiple payloads.

Definition at line 34 of file calibration_checker.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			objType_list = [] )

Parameters:
  objType_list (list): a list of db objects used as keys to their checker.
    e.g., [Belle2.PXDMaskedPixelPar, Belle2.PXDDeadPixelPar]

Definition at line 39 of file calibration_checker.py.

    def __init__(self, objType_list=[]):
        """
        Parameters:
          objType_list (list): a list of db objects used as keys to their checker.
            e.g., [Belle2.PXDMaskedPixelPar, Belle2.PXDDeadPixelPar]
        """
        
        self.condition_checkers = {}
        for objType in objType_list:
            self.condition_checkers[objType] = None
 

Member Function Documentation

beginRun()

beginRun

(

self

)

function to be executed at the beginning of a run

Definition at line 97 of file calibration_checker.py.

    def beginRun(self):
        """
        function to be executed at the beginning of a run
        """
        # \cond false positive doxygen warning
        if self.valid:
            self.fill_graphs()
        # \endcond
 

define_graphs()

define_graphs

(

self

)

Define summary graphs

Reimplemented in PXDHotPixelMaskCalibrationChecker.

Definition at line 80 of file calibration_checker.py.

    def define_graphs(self):
        """
        Define summary graphs
        """
 

draw_plots()

draw_plots

(

self

)

Generate summary plots from TGraphs of all condition checkers

Reimplemented in PXDHotPixelMaskCalibrationChecker.

Definition at line 92 of file calibration_checker.py.

    def draw_plots(self):
        """
        Generate summary plots from TGraphs of all condition checkers
        """
 

fill_graphs()

fill_graphs

(

self

)

Method to fill TGraphs

Reimplemented in PXDHotPixelMaskCalibrationChecker.

Definition at line 86 of file calibration_checker.py.

    def fill_graphs(self):
        """
        Method to fill TGraphs
        """
 

initialize()

initialize	(		self,
			checker_list = [] )

Initialize condition_checker according to condition objType
Parameters:
  checker_list (list): list of objType checkers

Definition at line 50 of file calibration_checker.py.

    def initialize(self, checker_list=[]):
        """
        Initialize condition_checker according to condition objType
        Parameters:
          checker_list (list): list of objType checkers
        """
        checker = None
        for checker in checker_list:
            for objType in self.condition_checkers.keys():
                if objType == checker.objType:
                    self.condition_checkers[objType] = checker
        # \cond false positive doxygen warning
        if self.valid:
            checker.tfile.cd()
            print(f"root file path: {checker.tfile}")
            self.define_graphs()
        # \endcond
 

terminate()

terminate

(

self

)

Execute when terminating a basf2 module.
All required TGraphs should be ready at this stage.

Definition at line 106 of file calibration_checker.py.

    def terminate(self):
        """
        Execute when terminating a basf2 module.
        All required TGraphs should be ready at this stage.
        """
        # \cond false positive doxygen warning
        if self.valid:
            self.draw_plots()
        # \endcond
 
 

valid()

valid

(

self

)

valid flag

Definition at line 69 of file calibration_checker.py.

    def valid(self):
        """
        valid flag
        """
        if None in self.condition_checkers.values():
            # do nothing if any of the condition checkers is missing
            return False
        else:
            return True
 

Member Data Documentation

condition_checkers

dict condition_checkers = {}

condition checkers which are associated to this calibration.

Parameters:
  objType_list (list): a list of db objects used as keys to their checker.
    e.g., [Belle2.PXDMaskedPixelPar, Belle2.PXDDeadPixelPar]

Definition at line 46 of file calibration_checker.py.

---

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

• pxd/scripts/pxd/calibration/calibration_checker.py