Inheritance diagram for ConditionCheckerBase:

Public Member Functions
def	__init__ (self, name, objType, tfile, rundir="", use_hist=False)

def	objType (self)

def	run (self)

def	exp (self)

def	beginRun (self)

def	define_graphs (self, ytitle="")

def	define_hists (self, name=None, title=None, ztitle=None, **kwargs)

def	get_db_content (self)

def	get_graph_value (self, sensor_db_content)

def	get_graph_value_from_hist (self, h2=None)

def	set_hist_content (self, h2, sensor_db_content)

def	fill_plots (self)

def	draw_plots (self, canvas=None, cname="", ymin=0., ymax=None, logy=False)

def	save_canvas (self, canvas, cname, logy=False)

Public Attributes
	name
	DBObj name.

	dbObj
	DBObjPtr for the condition.

	eventMetaData
	pointer to the event metadata

	tfile
	TFile for saving plots.

	rundir
	Directory for writing histograms of each run.

	graphs
	Dictionary of plots (TGraph) summarizing variables vs run.

	hists
	Dictionary of plots (TH1) to be saved for each run.

	hist_title_suffix
	Hist title suffix.

	runstart
	The 1st run.

	runend
	The last run.

	expstart
	The 1st exp.

	use_hist
	Flag to get TGraph values from a histogram (TH2F)

Protected Attributes
	_objType
	DBObj type.

Detailed Description

Abstract base class describing interfaces to make plots from condition db.

Definition at line 49 of file condition_checker.py.

Constructor & Destructor Documentation

◆ init()

def __init__	(	self,
		name,
		objType,
		tfile,
		rundir = `""`,
		use_hist = `False`
	)

Reimplemented in PXDOccupancyInfoChecker, PXDMaskedPixelsChecker, PXDGainMapChecker, and PXDDeadPixelsChecker.

Definition at line 52 of file condition_checker.py.

    def __init__(self, name, objType, tfile, rundir="", use_hist=False):
        """
        """
        super().__init__()
        
        self.name = name
        
        self._objType = objType
        
        self.dbObj = Belle2.PyDBObj(self.name, self.objType.Class())
        
        self.eventMetaData = Belle2.PyStoreObj("EventMetaData")
        
        self.tfile = tfile
        
        self.rundir = rundir  # empty means skipping self.hists
        if self.rundir != "":
            self.tfile.cd()
            self.tfile.mkdir(self.rundir)
        
        self.graphs = {}
        
        self.hists = {}
        
        self.hist_title_suffix = ""
        
        self.runstart = 999999  # a big number that will never be used
        
        self.runend = -1
        
        self.expstart = 999999
        
        self.use_hist = use_hist
 
        self.define_graphs()

Member Function Documentation

◆ beginRun()

def beginRun ( self )

Call functions at beginning of a run

Definition at line 109 of file condition_checker.py.

    def beginRun(self):
        """
        Call functions at beginning of a run
        """
        self.define_hists()
        self.fill_plots()
 

◆ define_graphs()

def define_graphs	(	self,
		ytitle = `""`
	)

Method to define TGraph
Parameters:
  ytitle (str): Label for TGraph y-axis

Reimplemented in PXDOccupancyInfoChecker, PXDMaskedPixelsChecker, PXDDeadPixelsChecker, and PXDGainMapChecker.

Definition at line 116 of file condition_checker.py.

    def define_graphs(self, ytitle=""):
        """
        Method to define TGraph
        Parameters:
          ytitle (str): Label for TGraph y-axis
        """
        self.tfile.cd()
        self.graphs.update(get_sensor_graphs(ytitle))
 

◆ define_hists()

def define_hists	(		self,
			name = `None`,
			title = `None`,
			ztitle = `None`,
		**	kwargs
	)

Method to define TH2
Parameters:
  name (str): name for TH2, to which sensor name will be attached
  title (str): title for TH2
  ztitle (str): title for z-axis (color bar)
  kwargs: additional arguments

Reimplemented in PXDMaskedPixelsChecker, PXDDeadPixelsChecker, and PXDGainMapChecker.

Definition at line 125 of file condition_checker.py.

    def define_hists(self, name=None, title=None, ztitle=None, **kwargs):
        """
        Method to define TH2
        Parameters:
          name (str): name for TH2, to which sensor name will be attached
          title (str): title for TH2
          ztitle (str): title for z-axis (color bar)
          kwargs: additional arguments
        """
        if self.rundir:
            self.tfile.cd(self.rundir)
            self.hists.update(get_sensor_maps(name, title, ztitle, self.run, **kwargs))
 

◆ draw_plots()

def draw_plots	(	self,
		canvas = `None`,
		cname = `""`,
		ymin = `0.`,
		ymax = `None`,
		logy = `False`
	)

Method to draw plots on a TCanvas
Parameters:
  canvas (TCanvas): ROOT TCanvas for plotting
  canme (str): Name of the canvas
  ymin (float): Minimum value of y-axis for plotting
  ymax (float): Maximum of y-axis for plotting
  logy (bool): Flag to use log scale for y-axis

Reimplemented in PXDOccupancyInfoChecker, PXDDeadPixelsChecker, PXDGainMapChecker, and PXDMaskedPixelsChecker.

Definition at line 212 of file condition_checker.py.

    def draw_plots(self, canvas=None, cname="", ymin=0., ymax=None, logy=False):
        """
        Method to draw plots on a TCanvas
        Parameters:
          canvas (TCanvas): ROOT TCanvas for plotting
          canme (str): Name of the canvas
          ymin (float): Minimum value of y-axis for plotting
          ymax (float): Maximum of y-axis for plotting
          logy (bool): Flag to use log scale for y-axis
        """
        if not canvas:
            return
        else:
            canvas.Clear()
            canvas.SetWindowSize(1000, 400)
            canvas.SetLeftMargin(0.09)
            canvas.SetRightMargin(0.05)
        self.tfile.cd()
        for i, sensorID in enumerate(sensorID_list):
            sensor_id = sensorID.getID()
            if i == 0:
                if ymax is None:
                    ymax = np.array([np.array(gr.GetY()) for gr in list(self.graphs.values())
                                     if isinstance(gr, ROOT.TGraph)]).max()
                self.graphs[sensor_id].SetMaximum(ymax)
                self.graphs[sensor_id].SetMinimum(ymin)
                self.graphs[sensor_id].Draw("AP")
            else:
                self.graphs[sensor_id].Draw("P")
        if self.graphs["TLegends"]:
            for leg in self.graphs["TLegends"]:
                leg.Draw()
        self.save_canvas(canvas, cname, logy=logy)
 

◆ exp()

def exp ( self )

Experiment number

Definition at line 103 of file condition_checker.py.

    def exp(self):
        """
        Experiment number
        """
        return self.eventMetaData.getExperiment()
 

◆ fill_plots()

def fill_plots ( self )

Method to fill plot objects

Definition at line 170 of file condition_checker.py.

    def fill_plots(self):
        """
        Method to fill plot objects
        """
        if self.exp < self.expstart:
            self.expstart = self.exp
        if self.run < self.runstart:
            self.runstart = self.run
        if self.run > self.runend:
            self.runend = self.run
 
        db_content = self.get_db_content()
        values_dict = {}
        pre_values_dict = {}
        for sensorID in sensorID_list:
            sensor_db_content = db_content[sensorID.getID()]
            if self.graphs:
                if not self.use_hist:
                    values_dict[sensorID.getID()] = self.get_graph_value(sensor_db_content)
                gr = self.graphs[sensorID.getID()]
                pre_values_dict[sensorID.getID()] = gr.GetPointY(gr.GetN() - 1)
            # Saving graph points only for different values (sensor-wise)
                # value = self.get_graph_value(sensor_db_content)
                # pre_value = gr.GetPointY(gr.GetN()-1)
                # if value != pre_value:
                #     gr.SetPoint(gr.GetN(), self.run, value)
            # Saving masked map
            if self.rundir != "" and self.hists:
                h2 = self.hists[sensorID.getID()]
                self.set_hist_content(h2, sensor_db_content)
                # Update title with total count
                h2.SetTitle(h2.GetTitle() + self.hist_title_suffix)
                self.tfile.cd(self.rundir)
                h2.Write()
                if self.use_hist:
                    values_dict[sensorID.getID()] = self.get_graph_value_from_hist(h2)
        # Saving graph points only for different conditions
        if values_dict != pre_values_dict:
            for sensorID in sensorID_list:
                gr = self.graphs[sensorID.getID()]
                gr.SetPoint(gr.GetN(), self.run, values_dict[sensorID.getID()])
 

◆ get_db_content()

def get_db_content ( self )

Abstract method to get content of a payload
Should return a Dictionary with sensorID.getID() as key and relaated calibration results as value

Reimplemented in PXDOccupancyInfoChecker, PXDMaskedPixelsChecker, PXDDeadPixelsChecker, and PXDGainMapChecker.

Definition at line 139 of file condition_checker.py.

    def get_db_content(self):
        """
        Abstract method to get content of a payload
        Should return a Dictionary with sensorID.getID() as key and relaated calibration results as value
        """
 

◆ get_graph_value()

def get_graph_value	(	self,
		sensor_db_content
	)

Abstract method to get a value for each TGraph
Parameters:
  sensor_db_content (Any): Calibration results of a module

Reimplemented in PXDOccupancyInfoChecker, PXDMaskedPixelsChecker, PXDDeadPixelsChecker, and PXDGainMapChecker.

Definition at line 146 of file condition_checker.py.

    def get_graph_value(self, sensor_db_content):
        """
        Abstract method to get a value for each TGraph
        Parameters:
          sensor_db_content (Any): Calibration results of a module
        """
 

◆ get_graph_value_from_hist()

def get_graph_value_from_hist	(	self,
		h2 = `None`
	)

Method to get a value for each TGraph
Parameters:
  h2 (TH2): If not none, get value from h2

Reimplemented in PXDDeadPixelsChecker.

Definition at line 153 of file condition_checker.py.

    def get_graph_value_from_hist(self, h2=None):
        """
        Method to get a value for each TGraph
        Parameters:
          h2 (TH2): If not none, get value from h2
        """
        return None
 

◆ objType()

def objType ( self )

DBObj type (read only)

Definition at line 89 of file condition_checker.py.

    def objType(self):
        """
        DBObj type (read only)
        """
        return self._objType
 

◆ run()

def run ( self )

Run number

Definition at line 96 of file condition_checker.py.

    def run(self):
        """
        Run number
        """
        return self.eventMetaData.getRun()
 

◆ save_canvas()

def save_canvas	(	self,
		canvas,
		cname,
		logy = `False`
	)

Save TCanvas to png/pdf format and do not write it to the ROOT file by default
Parameters:
  canvas (TCanvas): ROOT TCanvas for plotting
  canme (str): Name of the canvas
  logy (bool): Flag to use log scale for y-axis

Definition at line 246 of file condition_checker.py.

    def save_canvas(self, canvas, cname, logy=False):
        """
        Save TCanvas to png/pdf format and do not write it to the ROOT file by default
        Parameters:
          canvas (TCanvas): ROOT TCanvas for plotting
          canme (str): Name of the canvas
          logy (bool): Flag to use log scale for y-axis
        """
        if cname:
            canvas.SetName(cname)
        exp_run = f"e{self.expstart:05}_r{self.runstart:04}-{self.runend:04}"
        # Draw Belle II label
        latex_r.DrawLatex(0.95, 0.92, "Belle II Experiment: " + exp_run.replace("_", " "))
        # Print and write TCanvas
        if logy:
            canvas.SetLogy(1)
            canvas.Update()
            canvas.Modified()
            canvas.Print(f"{exp_run}_{cname}_vs_run_logy.png")
            canvas.Print(f"{exp_run}_{cname}_vs_run_logy.pdf")
        else:
            canvas.SetLogy(0)
            canvas.Print(f"{exp_run}_{cname}_vs_run.png")
            canvas.Print(f"{exp_run}_{cname}_vs_run.pdf")
        self.tfile.cd()
 
 

◆ set_hist_content()

def set_hist_content	(	self,
		h2,
		sensor_db_content
	)

Method to set TH2 bins
Parameters:
  h2 (TH2): TH2F object for handling values of a pixel matrix
  sensor_db_content (Any): Calibration results of a module

Reimplemented in PXDMaskedPixelsChecker, PXDDeadPixelsChecker, and PXDGainMapChecker.

Definition at line 161 of file condition_checker.py.

    def set_hist_content(self, h2, sensor_db_content):
        """
        Method to set TH2 bins
        Parameters:
          h2 (TH2): TH2F object for handling values of a pixel matrix
          sensor_db_content (Any): Calibration results of a module
        """
        pass
 

Member Data Documentation

◆ _objType

_objType

protected

DBObj type.

Definition at line 59 of file condition_checker.py.

◆ dbObj

dbObj

DBObjPtr for the condition.

Definition at line 61 of file condition_checker.py.

◆ eventMetaData

eventMetaData

pointer to the event metadata

Definition at line 63 of file condition_checker.py.

◆ expstart

expstart

The 1st exp.

Definition at line 82 of file condition_checker.py.

◆ graphs

graphs

Dictionary of plots (TGraph) summarizing variables vs run.

Definition at line 72 of file condition_checker.py.

◆ hist_title_suffix

hist_title_suffix

Hist title suffix.

Definition at line 76 of file condition_checker.py.

◆ hists

hists

Dictionary of plots (TH1) to be saved for each run.

Definition at line 74 of file condition_checker.py.

◆ name

name

DBObj name.

Definition at line 57 of file condition_checker.py.

◆ rundir

rundir

Directory for writing histograms of each run.

Definition at line 67 of file condition_checker.py.

◆ runend

runend

The last run.

Definition at line 80 of file condition_checker.py.

◆ runstart

runstart

The 1st run.

Definition at line 78 of file condition_checker.py.

◆ tfile

tfile

TFile for saving plots.

Definition at line 65 of file condition_checker.py.

◆ use_hist

use_hist

Flag to get TGraph values from a histogram (TH2F)

Definition at line 84 of file condition_checker.py.

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

pxd/scripts/pxd/calibration/condition_checker.py

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ beginRun()

◆ define_graphs()

◆ define_hists()

◆ draw_plots()

◆ exp()

◆ fill_plots()

◆ get_db_content()

◆ get_graph_value()

◆ get_graph_value_from_hist()

◆ objType()

◆ run()

◆ save_canvas()

◆ set_hist_content()

Member Data Documentation

◆ _objType

◆ dbObj

◆ eventMetaData

◆ expstart

◆ graphs

◆ hist_title_suffix

◆ hists

◆ name

◆ rundir

◆ runend

◆ runstart

◆ tfile

◆ use_hist

◆ init()