Algorithm for pulse-height and threshold efficiency calibration. More...

#include <TOPPulseHeightAlgorithm.h>

Inheritance diagram for TOPPulseHeightAlgorithm:

Collaboration diagram for TOPPulseHeightAlgorithm:

[legend]

Public Types
enum	EResult { c_OK , c_Iterate , c_NotEnoughData , c_Failure , c_Undefined }
	The result of calibration. More...

Public Member Functions
	TOPPulseHeightAlgorithm ()
	Constructor.

virtual	~TOPPulseHeightAlgorithm ()
	Destructor.

void	setMinEntries (int minEntries)
	Sets minimal number of histogram entries to perform a fit.

void	setXmin (double xmin)
	Sets the lower bound of the fit range. More...

void	setMinFracCalibrated (double minFract)
	Sets minimal fraction of calibrated channels to declare this calibration as c_OK. More...

std::string	getPrefix () const
	Get the prefix used for getting calibration data.

bool	checkPyExpRun (PyObject *pyObj)
	Checks that a PyObject can be successfully converted to an ExpRun type. More...

Calibration::ExpRun	convertPyExpRun (PyObject *pyObj)
	Performs the conversion of PyObject to ExpRun. More...

std::string	getCollectorName () const
	Alias for prefix. More...

void	setPrefix (const std::string &prefix)
	Set the prefix used to identify datastore objects.

void	setInputFileNames (PyObject *inputFileNames)
	Set the input file names used for this algorithm from a Python list. More...

PyObject *	getInputFileNames ()
	Get the input file names used for this algorithm and pass them out as a Python list of unicode strings.

std::vector< Calibration::ExpRun >	getRunListFromAllData () const
	Get the complete list of runs from inspection of collected data.

RunRange	getRunRangeFromAllData () const
	Get the complete RunRange from inspection of collected data.

IntervalOfValidity	getIovFromAllData () const
	Get the complete IoV from inspection of collected data.

void	fillRunToInputFilesMap ()
	Fill the mapping of ExpRun -> Files.

std::string	getGranularity () const
	Get the granularity of collected data.

EResult	execute (std::vector< Calibration::ExpRun > runs={}, int iteration=0, IntervalOfValidity iov=IntervalOfValidity())
	Runs calibration over vector of runs for a given iteration. More...

EResult	execute (PyObject *runs, int iteration=0, IntervalOfValidity iov=IntervalOfValidity())
	Runs calibration over Python list of runs. Converts to C++ and then calls the other execute() function.

std::list< Database::DBImportQuery > &	getPayloads ()
	Get constants (in TObjects) for database update from last execution.

std::list< Database::DBImportQuery >	getPayloadValues ()
	Get constants (in TObjects) for database update from last execution but passed by VALUE.

bool	commit ()
	Submit constants from last calibration into database.

bool	commit (std::list< Database::DBImportQuery > payloads)
	Submit constants from a (potentially previous) set of payloads.

const std::string &	getDescription () const
	Get the description of the algoithm (set by developers in constructor)

bool	loadInputJson (const std::string &jsonString)
	Load the m_inputJson variable from a string (useful from Python interface). The rturn bool indicates success or failure.

const std::string	dumpOutputJson () const
	Dump the JSON string of the output JSON object.

const std::vector< Calibration::ExpRun >	findPayloadBoundaries (std::vector< Calibration::ExpRun > runs, int iteration=0)
	Used to discover the ExpRun boundaries that you want the Python CAF to execute on. This is optional and only used in some.

template<>
std::shared_ptr< TTree >	getObjectPtr (const std::string &name, const std::vector< Calibration::ExpRun > &requestedRuns)
	Specialization of getObjectPtr<TTree>.

Protected Member Functions
void	setInputFileNames (std::vector< std::string > inputFileNames)
	Set the input file names used for this algorithm. More...

virtual bool	isBoundaryRequired (const Calibration::ExpRun &)
	Given the current collector data, make a decision about whether or not this run should be the start of a payload boundary.

virtual void	boundaryFindingSetup (std::vector< Calibration::ExpRun >, int)
	If you need to make some changes to your algorithm class before 'findPayloadBoundaries' is run, make them in this function.

virtual void	boundaryFindingTearDown ()
	Put your algorithm back into a state ready for normal execution if you need to.

const std::vector< Calibration::ExpRun > &	getRunList () const
	Get the list of runs for which calibration is called.

int	getIteration () const
	Get current iteration.

std::vector< std::string >	getVecInputFileNames () const
	Get the input file names used for this algorithm as a STL vector.

template<class T >
std::shared_ptr< T >	getObjectPtr (const std::string &name, const std::vector< Calibration::ExpRun > &requestedRuns)
	Get calibration data object by name and list of runs, the Merge function will be called to generate the overall object.

template<class T >
std::shared_ptr< T >	getObjectPtr (std::string name)
	Get calibration data object (for all runs the calibration is requested for) This function will only work during or after execute() has been called once.

template<>
shared_ptr< TTree >	getObjectPtr (const string &name, const vector< ExpRun > &requestedRuns)
	We cheekily cast the TChain to TTree for the returned pointer so that the user never knows Hopefully this doesn't cause issues if people do low level stuff to the tree...

std::string	getGranularityFromData () const
	Get the granularity of collected data.

void	saveCalibration (TClonesArray *data, const std::string &name)
	Store DBArray payload with given name with default IOV.

void	saveCalibration (TClonesArray *data, const std::string &name, const IntervalOfValidity &iov)
	Store DBArray with given name and custom IOV.

void	saveCalibration (TObject *data)
	Store DB payload with default name and default IOV.

void	saveCalibration (TObject *data, const IntervalOfValidity &iov)
	Store DB payload with default name and custom IOV.

void	saveCalibration (TObject *data, const std::string &name)
	Store DB payload with given name with default IOV.

void	saveCalibration (TObject *data, const std::string &name, const IntervalOfValidity &iov)
	Store DB payload with given name and custom IOV.

void	updateDBObjPtrs (const unsigned int event, const int run, const int experiment)
	Updates any DBObjPtrs by calling update(event) for DBStore.

void	setDescription (const std::string &description)
	Set algorithm description (in constructor)

void	clearCalibrationData ()
	Clear calibration data.

Calibration::ExpRun	getAllGranularityExpRun () const
	Returns the Exp,Run pair that means 'Everything'. Currently unused.

void	resetInputJson ()
	Clears the m_inputJson member variable.

void	resetOutputJson ()
	Clears the m_outputJson member variable.

template<class T >
void	setOutputJsonValue (const std::string &key, const T &value)
	Set a key:value pair for the outputJson object, expected to used interally during calibrate()

template<class T >
const T	getOutputJsonValue (const std::string &key) const
	Get a value using a key from the JSON output object, not sure why you would want to do this.

template<class T >
const T	getInputJsonValue (const std::string &key) const
	Get an input JSON value using a key. The normal exceptions are raised when the key doesn't exist.

const nlohmann::json &	getInputJsonObject () const
	Get the entire top level JSON object. We explicitly say this must be of object type so that we might pick.

bool	inputJsonKeyExists (const std::string &key) const
	Test for a key in the input JSON object.

Protected Attributes
std::vector< Calibration::ExpRun >	m_boundaries
	When using the boundaries functionality from isBoundaryRequired, this is used to store the boundaries. It is cleared when.

Private Member Functions
virtual EResult	calibrate () final
	algorithm implementation

int	fitChannels (std::shared_ptr< TH2F > h)
	Fit pulse-height distributions of a single module. More...

int	fitPulseHeight (TH1D *h)
	Fit pulse-height distribution of a single channel with P(x) = (x/x0)^p1 * exp(-(x/x0)^p2) and p1 = 1. More...

double	getEfficiency (TH1D h, TF1 func)
	Calculate and return threshold efficiency. More...

std::string	getExpRunString (Calibration::ExpRun &expRun) const
	Gets the "exp.run" string repr. of (exp,run)

std::string	getFullObjectPath (const std::string &name, Calibration::ExpRun expRun) const
	constructs the full TDirectory + Key name of an object in a TFile based on its name and exprun

Private Attributes
int	m_minEntries = 100
	minimal number of histogram entries to perform fit

double	m_xmin = 100.0
	fit range lower limit [ADC counts]

double	m_minCalibrated = 0.90
	min. More...

int	m_slot = 0
	module ID

unsigned	m_channel = 0
	channel ID

int	m_numPhot = 0
	number of photons (histogram entries)

float	m_x0 = 0
	fitted distribution parameter x0 [ADC counts]

float	m_p1 = 0
	fitted distribution parameter p1

float	m_p2 = 0
	fitted distribution parameter p2

float	m_x0err = 0
	error on x0 [ADC counts]

float	m_p1err = 0
	error on p1

float	m_p2err = 0
	error on p2

float	m_effi = 0
	threshold efficiency

float	m_meanHist = 0
	histogram mean value

float	m_meanFunc = 0
	fitted distribution mean value

float	m_chi2 = 0
	chi^2

int	m_ndf = 0
	NDF.

int	m_fitStatus = -1
	fit status

bool	m_good = false
	on true fit is good

TFile *	m_file = 0
	root file

TTree *	m_tree = 0
	output ntuple

TOPCalChannelPulseHeight *	m_pulseHeight = 0
	parametrized PH distributions

TOPCalChannelThresholdEff *	m_thresholdEffi = 0
	threshold efficiencies

std::vector< std::string >	m_inputFileNames
	List of input files to the Algorithm, will initially be user defined but then gets the wildcards expanded during execute()

std::map< Calibration::ExpRun, std::vector< std::string > >	m_runsToInputFiles
	Map of Runs to input files. Gets filled when you call getRunRangeFromAllData, gets cleared when setting input files again.

std::string	m_granularityOfData
	Granularity of input data. This only changes when the input files change so it isn't specific to an execution.

ExecutionData	m_data
	Data specific to a SINGLE execution of the algorithm. Gets reset at the beginning of execution.

std::string	m_description {""}
	Description of the algorithm.

std::string	m_prefix {""}
	The name of the TDirectory the collector objects are contained within.

nlohmann::json	m_jsonExecutionInput = nlohmann::json::object()
	Optional input JSON object used to make decisions about how to execute the algorithm code.

nlohmann::json	m_jsonExecutionOutput = nlohmann::json::object()
	Optional output JSON object that can be set during the execution by the underlying algorithm code.

Static Private Attributes
static const Calibration::ExpRun	m_allExpRun = make_pair(-1, -1)
	allExpRun

Detailed Description

Algorithm for pulse-height and threshold efficiency calibration.

Definition at line 28 of file TOPPulseHeightAlgorithm.h.

Member Enumeration Documentation

◆ EResult

enum EResult

inherited

The result of calibration.

Enumerator
c_OK	Finished successfuly =0 in Python.
c_Iterate	Needs iteration =1 in Python.
c_NotEnoughData	Needs more data =2 in Python.
c_Failure	Failed =3 in Python.
c_Undefined	Not yet known (before execution) =4 in Python.

Definition at line 40 of file CalibrationAlgorithm.h.

Member Function Documentation

◆ checkPyExpRun()

bool checkPyExpRun ( PyObject * pyObj )

inherited

Checks that a PyObject can be successfully converted to an ExpRun type.

Checks if the PyObject can be converted to ExpRun.

Definition at line 28 of file CalibrationAlgorithm.cc.

◆ convertPyExpRun()

ExpRun convertPyExpRun ( PyObject * pyObj )

inherited

Performs the conversion of PyObject to ExpRun.

Converts the PyObject to an ExpRun. We've preoviously checked the object so this assumes a lot about the PyObject.

Definition at line 70 of file CalibrationAlgorithm.cc.

◆ execute()

CalibrationAlgorithm::EResult execute	(	std::vector< Calibration::ExpRun >	runs = `{}`,
		int	iteration = `0`,
		IntervalOfValidity	iov = `IntervalOfValidity()`
	)

inherited

Runs calibration over vector of runs for a given iteration.

You can also specify the IoV to save the database payload as. By default the Algorithm will create an IoV from your requested ExpRuns, or from the overall ExpRuns of the input data if you haven't specified ExpRuns in this function.

No checks are performed to make sure that a IoV you specify matches the data you ran over, it simply labels the IoV to commit to the database later.

Definition at line 114 of file CalibrationAlgorithm.cc.

◆ fitChannels()

int fitChannels ( std::shared_ptr< TH2F > h )

private

Fit pulse-height distributions of a single module.

Parameters

h	2D histogram of pulse-height vs channel

Returns: number of successfully fitted channels

Definition at line 121 of file TOPPulseHeightAlgorithm.cc.

     {
       int n = 0;
  
       for (int ch = 0; ch < h2d->GetNbinsX(); ch++) {
         m_channel =  ch;
         string chan = to_string(ch);
         while (chan.length() < 3) chan.insert(0, "0");
         string name = "chan_" + chan;
         auto* h = h2d->ProjectionY(name.c_str(), ch + 1, ch + 1);
         string title = "slot " + to_string(m_slot) + " channel " + to_string(ch);
         h->SetTitle(title.c_str());
  
         auto status = fitPulseHeight(h);
  
         if (status == 0 and m_good) {
           m_pulseHeight->setParameters(m_slot, m_channel, m_x0, m_p1, m_p2);
           m_thresholdEffi->setThrEff(m_slot, m_channel, std::min(m_effi, 1.0f), m_xmin);
           n++;
         }
       }
  
       return n;
     }

◆ fitPulseHeight()

int fitPulseHeight ( TH1D * h )

private

Fit pulse-height distribution of a single channel with P(x) = (x/x0)^p1 * exp(-(x/x0)^p2) and p1 = 1.

Fitting with p1 floating found to be unstabe.

Parameters

h histogram

Returns: fit status

Definition at line 147 of file TOPPulseHeightAlgorithm.cc.

◆ getCollectorName()

std::string getCollectorName ( ) const

inlineinherited

Alias for prefix.

For convenience and less writing, we say developers to set this to default collector module name in constructor of base class. One can however use the dublets of collector+algorithm multiple times with different settings. To bind these together correctly, the prefix has to be set the same for algo and collector. So we call the setter setPrefix rather than setModuleName or whatever. This getter will work out of the box for default cases -> return the name of module you have to add to your path to collect data for this algorihtm.

Definition at line 164 of file CalibrationAlgorithm.h.

◆ getEfficiency()

double getEfficiency	(	TH1D *	h,
		TF1 *	func
	)

private

Calculate and return threshold efficiency.

Parameters

h	histogram
func	fitted function

Returns: threshold efficiency

Definition at line 183 of file TOPPulseHeightAlgorithm.cc.

◆ setInputFileNames() [1/2]

void setInputFileNames ( PyObject * inputFileNames )

inherited

Set the input file names used for this algorithm from a Python list.

Set the input file names used for this algorithm and resolve the wildcards.

Definition at line 166 of file CalibrationAlgorithm.cc.

◆ setInputFileNames() [2/2]

void setInputFileNames ( std::vector< std::string > inputFileNames )

protectedinherited

Set the input file names used for this algorithm.

Set the input file names used for this algorithm and resolve the wildcards.

Definition at line 194 of file CalibrationAlgorithm.cc.

◆ setMinFracCalibrated()

void setMinFracCalibrated ( double minFract )

inline

Sets minimal fraction of calibrated channels to declare this calibration as c_OK.

Parameters

minFract minimal fraction of calibrated channels

Definition at line 52 of file TOPPulseHeightAlgorithm.h.

52 {m_minCalibrated = minFract;}

Belle2::TOP::TOPPulseHeightAlgorithm::m_minCalibrated

double m_minCalibrated

min.

Definition: TOPPulseHeightAlgorithm.h:88

◆ setXmin()

void setXmin ( double xmin )

inline

Sets the lower bound of the fit range.

Parameters

xmin	lower bound [ADC counts]

Definition at line 46 of file TOPPulseHeightAlgorithm.h.

Member Data Documentation

◆ m_minCalibrated

double m_minCalibrated = 0.90

private

min.

fracton of calibrated channels for c_OK

Definition at line 88 of file TOPPulseHeightAlgorithm.h.

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

top/calibration/include/TOPPulseHeightAlgorithm.h
top/calibration/src/TOPPulseHeightAlgorithm.cc

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ EResult

Member Function Documentation

◆ checkPyExpRun()

◆ convertPyExpRun()

◆ execute()

◆ fitChannels()

◆ fitPulseHeight()

◆ getCollectorName()

◆ getEfficiency()

◆ setInputFileNames() [1/2]

◆ setInputFileNames() [2/2]

◆ setMinFracCalibrated()

◆ setXmin()

Member Data Documentation

◆ m_minCalibrated