Handler for EMCAL calibration objects in DPL workflows. More...

#include <CalibLoader.h>

Public Member Functions
	CalibLoader ()=default
	Constructor.

	~CalibLoader ()=default
	Destructor.

BadChannelMap *	getBadChannelMap () const
	Access to current bad channel map.

EMCALChannelScaleFactors *	getBCMScaleFactors () const
	Access to current BCM Scale factors.

FeeDCS *	getFEEDCS () const
	Access to current FEE DCS params.

TimeCalibrationParams *	getTimeCalibration () const
	Access to current time calibration params.

GainCalibrationFactors *	getGainCalibration () const
	Access to current gain calibration factors.

TempCalibrationParams *	getTemperatureCalibration () const
	Access to current temperature calibration params.

bool	hasBadChannelMap () const
	Check whether the bad channel map is handled.

bool	hasBCMScaleFactors () const
	Check whether the BCM scale factors are handled.

bool	hasFEEDCS () const
	Check whether the FEE DCS params are handled.

bool	hasTimeCalib () const
	Check whether the time calibration params are handled.

bool	hasGainCalib () const
	Check whether the gain calibration factors are handled.

bool	hasTemperatureCalib () const
	Check whether the temperature calibration params are handled.

bool	hasRecoParams () const
	Check whether the reconstruction params are handled.

bool	hasSimParams () const
	Check whether the reconstruction params are handled.

bool	hasUpdateBadChannelMap () const
	Check whether the bad channel map has been updated.

bool	hasUpdateBCMScaleFactors () const
	Check whether the BCM scale factors have been updated.

bool	hasUpdateFEEDCS () const
	Check whether the FEE DCS params have been updated.

bool	hasUpdateTimeCalib () const
	Check whether the time calibration params have been updated.

bool	hasUpdateGainCalib () const
	Check whether the gain calibration params have been updated.

bool	hasUpdateTemperatureCalib () const
	Check whether the temperature calibration params have been updated.

bool	hasUpdateRecoParam () const
	Check whether the reconstruction params have been updated.

bool	hasUpdateSimParam () const
	Check whether the simulation params have been updated.

void	enableBadChannelMap (bool doEnable)
	Enable loading of the bad channel map.

void	enableBCMScaleFactors (bool doEnable)
	Enable loading of the BCM scale factors.

void	enableFEEDCS (bool doEnable)
	Enable loading of the FEE DCS params.

void	enableTimeCalib (bool doEnable)
	Enable loading of the time calibration params.

void	enableGainCalib (bool doEnable)
	Enable loading of the gain calibration factors.

void	enableTemperatureCalib (bool doEnable)
	Enable loading of the temperature calibration params.

void	enableRecoParams (bool doEnable)
	Enable loading of the reconstruction params.

void	enableSimParams (bool doEnable)
	Enable loading of the simulation params.

void	setUpdateBadChannelMap ()
	Mark bad channel map as updated.

void	setUpdateBCMScaleFactors ()
	Mark BCM scale factors as updated.

void	setUpdateFEEDCS ()
	Mark FEE DCS params as updated.

void	setUpdateTimeCalib ()
	Mark time calibration params as updated.

void	setUpdateGainCalib ()
	Mark gain calibration params as updated.

void	setUpdateTemperatureCalib ()
	Mark temperature calibration params as updated.

void	setUpdateRecoParams ()
	Mark reconstruction params as updated.

void	setUpdateSimParams ()
	Mark simulation params as updated.

void	resetUpdateStatus ()
	Reset the update status (all objects marked as false)

void	defineInputSpecs (std::vector< framework::InputSpec > &ccdbInputs)
	Define input specs in workflow for calibration objects to be loaded from the CCDB.

void	checkUpdates (o2::framework::ProcessingContext &ctx)
	Check for updates of the calibration objects in the processing context.

bool	finalizeCCDB (framework::ConcreteDataMatcher &matcher, void *obj)
	Callback for objects loaded from CCDB.

Detailed Description

Handler for EMCAL calibration objects in DPL workflows.

Author: Markus Fasel marku.nosp@m.s.fa.nosp@m.sel@c.nosp@m.ern..nosp@m.ch, Oak Ridge National Laboratory

Since: Sept. 5, 2022

Loading the calibration object i based on the objects stored in the CCDB, which is fully delegated to the framework CCDB support. Alternativelty, particularly for testing purpose, local CCDB paths for files for the different calibration objects can be provided. In this case the CCDB is bypassed. The function static_load must always be called in the init function - it will take care of loading the calibration objects to be taken from file. Furthermore in finalizeCCDB the workflow must call finalizeCCDB from the CalibLoader in order to make load the calibration objects requested from CCDB.

Definition at line 49 of file CalibLoader.h.

Constructor & Destructor Documentation

◆ CalibLoader()

o2::emcal::CalibLoader::CalibLoader ( )

default

Constructor.

◆ ~CalibLoader()

o2::emcal::CalibLoader::~CalibLoader ( )

default

Destructor.

Member Function Documentation

◆ checkUpdates()

void CalibLoader::checkUpdates ( o2::framework::ProcessingContext & ctx )

Check for updates of the calibration objects in the processing context.

Parameters

ctx	ProcessingContext with InputSpecs

Triggers finalizeCCDB in case of updates.

Definition at line 58 of file CalibLoader.cxx.

◆ defineInputSpecs()

void CalibLoader::defineInputSpecs ( std::vector< framework::InputSpec > & ccdbInputs )

Define input specs in workflow for calibration objects to be loaded from the CCDB.

Parameters

ccdbInputs List of inputs where the CCDB input specs will be added to

Defining only objects which are enabled and for which no local path is specified.

Definition at line 30 of file CalibLoader.cxx.

◆ enableBadChannelMap()

void o2::emcal::CalibLoader::enableBadChannelMap ( bool doEnable )

inline

Enable loading of the bad channel map.

Parameters

doEnable If true the bad channel map is loaded (per default from CCDB)

Definition at line 148 of file CalibLoader.h.

◆ enableBCMScaleFactors()

void o2::emcal::CalibLoader::enableBCMScaleFactors ( bool doEnable )

inline

Enable loading of the BCM scale factors.

Parameters

doEnable If true the BCM scale factors are loaded (per default from CCDB)

Definition at line 152 of file CalibLoader.h.

◆ enableFEEDCS()

void o2::emcal::CalibLoader::enableFEEDCS ( bool doEnable )

inline

Enable loading of the FEE DCS params.

Parameters

doEnable If true the FEE DCS params are loaded (per default from CCDB)

Definition at line 156 of file CalibLoader.h.

◆ enableGainCalib()

void o2::emcal::CalibLoader::enableGainCalib ( bool doEnable )

inline

Enable loading of the gain calibration factors.

Parameters

doEnable If true the gain calibration factors are loaded (per default from CCDB)

Definition at line 164 of file CalibLoader.h.

◆ enableRecoParams()

void o2::emcal::CalibLoader::enableRecoParams ( bool doEnable )

inline

Enable loading of the reconstruction params.

Parameters

doEnable If true the reconstruction params are loaded (per default from CCDB)

Definition at line 172 of file CalibLoader.h.

◆ enableSimParams()

void o2::emcal::CalibLoader::enableSimParams ( bool doEnable )

inline

Enable loading of the simulation params.

Parameters

doEnable If true the simulation params are loaded (per default from CCDB)

Definition at line 176 of file CalibLoader.h.

◆ enableTemperatureCalib()

void o2::emcal::CalibLoader::enableTemperatureCalib ( bool doEnable )

inline

Enable loading of the temperature calibration params.

Parameters

doEnable If true the temperature calibration params are loaded (per default from CCDB)

Definition at line 168 of file CalibLoader.h.

◆ enableTimeCalib()

void o2::emcal::CalibLoader::enableTimeCalib ( bool doEnable )

inline

Enable loading of the time calibration params.

Parameters

doEnable If true the time calibration params are loaded (per default from CCDB)

Definition at line 160 of file CalibLoader.h.

◆ finalizeCCDB()

bool CalibLoader::finalizeCCDB	(	framework::ConcreteDataMatcher &	matcher,
		void *	obj
	)

Callback for objects loaded from CCDB.

Parameters

matcher	Type of the CCDB object
obj	CCDB object loaded by the framework

Only CCDB objects compatible with one of the types are handled. In case the object type is requested and not loaded from local source the object accepted locally and accessible via the corresponding getter function.

Definition at line 87 of file CalibLoader.cxx.

◆ getBadChannelMap()

BadChannelMap * o2::emcal::CalibLoader::getBadChannelMap ( ) const

inline

Access to current bad channel map.

Returns: Current bad channel map (nullptr if not loaded)

Definition at line 60 of file CalibLoader.h.

◆ getBCMScaleFactors()

EMCALChannelScaleFactors * o2::emcal::CalibLoader::getBCMScaleFactors ( ) const

inline

Access to current BCM Scale factors.

Returns: Current BCM scale factors (nullptr if not loaded)

Definition at line 64 of file CalibLoader.h.

◆ getFEEDCS()

FeeDCS * o2::emcal::CalibLoader::getFEEDCS ( ) const

inline

Access to current FEE DCS params.

Returns: Current FEE DCS params (nullptr if not loaded)

Definition at line 68 of file CalibLoader.h.

◆ getGainCalibration()

GainCalibrationFactors * o2::emcal::CalibLoader::getGainCalibration ( ) const

inline

Access to current gain calibration factors.

Returns: Current gain calibration factors

Definition at line 76 of file CalibLoader.h.

◆ getTemperatureCalibration()

TempCalibrationParams * o2::emcal::CalibLoader::getTemperatureCalibration ( ) const

inline

Access to current temperature calibration params.

Returns: Current temperature calibration factors

Definition at line 80 of file CalibLoader.h.

◆ getTimeCalibration()

TimeCalibrationParams * o2::emcal::CalibLoader::getTimeCalibration ( ) const

inline

Access to current time calibration params.

Returns: Current time calibration params

Definition at line 72 of file CalibLoader.h.

◆ hasBadChannelMap()

bool o2::emcal::CalibLoader::hasBadChannelMap ( ) const

inline

Check whether the bad channel map is handled.

Returns: True if the bad channel map is handled, false otherwise

Definition at line 84 of file CalibLoader.h.

◆ hasBCMScaleFactors()

bool o2::emcal::CalibLoader::hasBCMScaleFactors ( ) const

inline

Check whether the BCM scale factors are handled.

Returns: True if the BCM scale factors are handled, false otherwise

Definition at line 88 of file CalibLoader.h.

◆ hasFEEDCS()

bool o2::emcal::CalibLoader::hasFEEDCS ( ) const

inline

Check whether the FEE DCS params are handled.

Returns: True if the FEE DCS params are handled, false otherwise

Definition at line 92 of file CalibLoader.h.

◆ hasGainCalib()

bool o2::emcal::CalibLoader::hasGainCalib ( ) const

inline

Check whether the gain calibration factors are handled.

Returns: True if the gain calibration factors are handled, false otherwise

Definition at line 100 of file CalibLoader.h.

◆ hasRecoParams()

bool o2::emcal::CalibLoader::hasRecoParams ( ) const

inline

Check whether the reconstruction params are handled.

Returns: True if the reconstruction params are handled, false otherwise

Definition at line 108 of file CalibLoader.h.

◆ hasSimParams()

bool o2::emcal::CalibLoader::hasSimParams ( ) const

inline

Check whether the reconstruction params are handled.

Returns: True if the reconstruction params are handled, false otherwise

Definition at line 112 of file CalibLoader.h.

◆ hasTemperatureCalib()

bool o2::emcal::CalibLoader::hasTemperatureCalib ( ) const

inline

Check whether the temperature calibration params are handled.

Returns: True if the temperature calibration params are handled, false otherwise

Definition at line 104 of file CalibLoader.h.

◆ hasTimeCalib()

bool o2::emcal::CalibLoader::hasTimeCalib ( ) const

inline

Check whether the time calibration params are handled.

Returns: True if the time calibration params are handled, false otherwise

Definition at line 96 of file CalibLoader.h.

◆ hasUpdateBadChannelMap()

bool o2::emcal::CalibLoader::hasUpdateBadChannelMap ( ) const

inline

Check whether the bad channel map has been updated.

Returns: True if the bad channel map has been updated, false otherwise

Definition at line 116 of file CalibLoader.h.

◆ hasUpdateBCMScaleFactors()

bool o2::emcal::CalibLoader::hasUpdateBCMScaleFactors ( ) const

inline

Check whether the BCM scale factors have been updated.

Returns: True if the bad channel map has been updated, false otherwise

Definition at line 120 of file CalibLoader.h.

◆ hasUpdateFEEDCS()

bool o2::emcal::CalibLoader::hasUpdateFEEDCS ( ) const

inline

Check whether the FEE DCS params have been updated.

Returns: True if the FEE DCS params have been updated, false otherwise

Definition at line 124 of file CalibLoader.h.

◆ hasUpdateGainCalib()

bool o2::emcal::CalibLoader::hasUpdateGainCalib ( ) const

inline

Check whether the gain calibration params have been updated.

Returns: True if the gain calibration params have been updated, false otherwise

Definition at line 132 of file CalibLoader.h.

◆ hasUpdateRecoParam()

bool o2::emcal::CalibLoader::hasUpdateRecoParam ( ) const

inline

Check whether the reconstruction params have been updated.

Returns: True if the reconstruction params have been updated, false otherwise

Definition at line 140 of file CalibLoader.h.

◆ hasUpdateSimParam()

bool o2::emcal::CalibLoader::hasUpdateSimParam ( ) const

inline

Check whether the simulation params have been updated.

Returns: True if the simulation params have been updated, false otherwise

Definition at line 144 of file CalibLoader.h.

◆ hasUpdateTemperatureCalib()

bool o2::emcal::CalibLoader::hasUpdateTemperatureCalib ( ) const

inline

Check whether the temperature calibration params have been updated.

Returns: True if the temperature calibration params have been updated, false otherwise

Definition at line 136 of file CalibLoader.h.

◆ hasUpdateTimeCalib()

bool o2::emcal::CalibLoader::hasUpdateTimeCalib ( ) const

inline

Check whether the time calibration params have been updated.

Returns: True if the time calibration params have been updated, false otherwise

Definition at line 128 of file CalibLoader.h.

◆ resetUpdateStatus()

void o2::emcal::CalibLoader::resetUpdateStatus ( )

inline

Reset the update status (all objects marked as false)

Definition at line 203 of file CalibLoader.h.

◆ setUpdateBadChannelMap()

void o2::emcal::CalibLoader::setUpdateBadChannelMap ( )

inline

Mark bad channel map as updated.

Definition at line 179 of file CalibLoader.h.

◆ setUpdateBCMScaleFactors()

void o2::emcal::CalibLoader::setUpdateBCMScaleFactors ( )

inline

Mark BCM scale factors as updated.

Definition at line 182 of file CalibLoader.h.

◆ setUpdateFEEDCS()

void o2::emcal::CalibLoader::setUpdateFEEDCS ( )

inline

Mark FEE DCS params as updated.

Definition at line 185 of file CalibLoader.h.

◆ setUpdateGainCalib()

void o2::emcal::CalibLoader::setUpdateGainCalib ( )

inline

Mark gain calibration params as updated.

Definition at line 191 of file CalibLoader.h.

◆ setUpdateRecoParams()

void o2::emcal::CalibLoader::setUpdateRecoParams ( )

inline

Mark reconstruction params as updated.

Definition at line 197 of file CalibLoader.h.

◆ setUpdateSimParams()

void o2::emcal::CalibLoader::setUpdateSimParams ( )

inline

Mark simulation params as updated.

Definition at line 200 of file CalibLoader.h.

◆ setUpdateTemperatureCalib()

void o2::emcal::CalibLoader::setUpdateTemperatureCalib ( )

inline

Mark temperature calibration params as updated.

Definition at line 194 of file CalibLoader.h.

◆ setUpdateTimeCalib()

void o2::emcal::CalibLoader::setUpdateTimeCalib ( )

inline

Mark time calibration params as updated.

Definition at line 188 of file CalibLoader.h.

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

/home/runner/work/AliceO2/AliceO2/Detectors/EMCAL/workflow/include/EMCALWorkflow/CalibLoader.h
/home/runner/work/AliceO2/AliceO2/Detectors/EMCAL/workflow/src/CalibLoader.cxx

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CalibLoader()

◆ ~CalibLoader()

Member Function Documentation

◆ checkUpdates()

◆ defineInputSpecs()

◆ enableBadChannelMap()

◆ enableBCMScaleFactors()

◆ enableFEEDCS()

◆ enableGainCalib()

◆ enableRecoParams()

◆ enableSimParams()

◆ enableTemperatureCalib()

◆ enableTimeCalib()

◆ finalizeCCDB()

◆ getBadChannelMap()

◆ getBCMScaleFactors()

◆ getFEEDCS()

◆ getGainCalibration()

◆ getTemperatureCalibration()

◆ getTimeCalibration()

◆ hasBadChannelMap()

◆ hasBCMScaleFactors()

◆ hasFEEDCS()

◆ hasGainCalib()

◆ hasRecoParams()

◆ hasSimParams()

◆ hasTemperatureCalib()

◆ hasTimeCalib()

◆ hasUpdateBadChannelMap()

◆ hasUpdateBCMScaleFactors()

◆ hasUpdateFEEDCS()

◆ hasUpdateGainCalib()

◆ hasUpdateRecoParam()

◆ hasUpdateSimParam()

◆ hasUpdateTemperatureCalib()

◆ hasUpdateTimeCalib()

◆ resetUpdateStatus()

◆ setUpdateBadChannelMap()

◆ setUpdateBCMScaleFactors()

◆ setUpdateFEEDCS()

◆ setUpdateGainCalib()

◆ setUpdateRecoParams()

◆ setUpdateSimParams()

◆ setUpdateTemperatureCalib()

◆ setUpdateTimeCalib()