calibrator class for the residual gain map extraction used on an aggregator node More...

#include <CalibratorPadGainTracks.h>

Inherits o2::calibration::TimeSlotCalibration< CalibPadGainTracksBase >.

Public Member Functions
	CalibratorPadGainTracks ()=default
	construcor

	~CalibratorPadGainTracks () final=default
	destructor

void	initOutput () final
	clearing the output

bool	hasEnoughData (const Slot &slot) const final
	Check if there are enough data to compute the calibration.

void	finalizeSlot (Slot &slot) final
	process time slot (create pad-by-pad gain map from tracks)

Slot &	emplaceNewSlot (bool front, TFType tstart, TFType tend) final
	Creates new time slot.

void	setMinEntries (const size_t minEntries)

void	setNormalizationType (const CalibPadGainTracksBase::NormType type)
	set how the extracted gain map is normalized

size_t	getMinEntries () const

void	setTruncationRange (const float low=0.05f, const float high=0.6f)

void	setRelGainRange (const float minRelgain=0.1f, const float maxRelgain=2.f)

void	setMinEntriesMean (const int minEntriesMean)
	minEntries minimum number of entries in pad-by-pad histogram to calculate the mean

void	setWriteDebug (const bool writeDebug)

void	setStoreNClCCDB (const bool storeNClCCDB)

void	setStoreRMSCCDB (const bool storeRMSCCDB)

bool	setLogTransformQ (const bool logTransformQ)
	set if the cluster charge is transformed using log(1+Q)

void	setUseLastExtractedMapAsReference (const bool useLastMap)

bool	getWriteDebug () const

float	getTruncationRangeLow () const

float	getTruncationRangeUp () const

const TFinterval &	getTFinterval () const

const TimeInterval &	getTimeIntervals () const

auto	getCalibs () &&

bool	hasCalibrationData () const
	check if calibration data is available

Public Member Functions inherited from o2::calibration::TimeSlotCalibration< CalibPadGainTracksBase >
	TimeSlotCalibration ()=default

virtual	~TimeSlotCalibration ()=default

float	getMaxSlotsDelay () const

void	setMaxSlotsDelay (float v)

TFType	getSlotLength () const

void	setSlotLength (TFType v)

TFType	getCheckIntervalInfiniteSlot () const

void	setCheckIntervalInfiniteSlot (TFType v)

TFType	getCheckDeltaIntervalInfiniteSlot () const

void	setCheckDeltaIntervalInfiniteSlot (TFType v)

TFType	getFirstTF () const

void	setFirstTF (TFType v)

void	setSlotLengthInSeconds (int s)

void	setSlotLengthInOrbits (int n)

void	checkSlotLength ()

void	setStartOffsetFrac (float f)

void	setFinalizeWhenReady ()

void	setUpdateAtTheEndOfRunOnly ()

int	getNSlots () const

Slot &	getSlotForTF (TFType tf)

Slot &	getSlot (int i)

const Slot &	getSlot (int i) const

const Slot &	getLastSlot () const

const Slot &	getFirstSlot () const

bool	process (const DATA &... data)

virtual void	checkSlotsToFinalize (TFType tf=INFINITE_TF, int maxDelay=0)

virtual void	finalizeOldestSlot ()

virtual void	reset ()

virtual void	print () const

const o2::dataformats::TFIDInfo &	getCurrentTFInfo () const

o2::dataformats::TFIDInfo &	getCurrentTFInfo ()

bool	getSavedSlotAllowed () const

void	setSavedSlotAllowed (bool v)

std::string	getSaveFilePath () const

const std::string &	getSaveFileName () const

void	setSaveFileName (const std::string &n)

void	setSaveDirectory (const std::string &n)

virtual bool	updateSaveMetaData ()

virtual bool	saveLastSlotData (TFile &fl)

virtual bool	adoptSavedData (const TimeSlotMetaData &metadata, TFile &fl)

virtual bool	loadSavedSlot ()

virtual bool	saveLastSlot ()

Additional Inherited Members
Public Types inherited from o2::calibration::TimeSlotCalibration< CalibPadGainTracksBase >
using	Slot = TimeSlot< CalibPadGainTracksBase >

using	TFType = o2::calibration::TFType

Static Public Attributes inherited from o2::calibration::TimeSlotCalibration< CalibPadGainTracksBase >
static constexpr TFType	INFINITE_TF

Protected Member Functions inherited from o2::calibration::TimeSlotCalibration< CalibPadGainTracksBase >
auto &	getSlots ()

uint32_t	getRunStartOrbit () const

TFType	tf2SlotMin (TFType tf) const

	ClassDef (TimeSlotCalibration, 1)

Protected Attributes inherited from o2::calibration::TimeSlotCalibration< CalibPadGainTracksBase >
std::deque< Slot >	mSlots

o2::dataformats::TFIDInfo	mCurrentTFInfo

int	mSlotLengthInSeconds

int	mSlotLengthInOrbits

TFType	mLastClosedTF

TFType	mFirstTF

TFType	mMaxSeenTF

TFType	mSlotLength

TFType	mStartOffsetTFs

float	mStartOffsetFrac

TFType	mCheckIntervalInfiniteSlot

TFType	mLastCheckedTFInfiniteSlot

TFType	mCheckDeltaIntervalInfiniteSlot

float	mMaxSlotsDelay

bool	mWasCheckedInfiniteSlot

bool	mUpdateAtTheEndOfRunOnly

bool	mFinalizeWhenReady

std::string	mSaveDirectory

std::string	mSaveFileName

TimeSlotMetaData	mSaveMetaData

bool	mSavedSlotAllowed

Detailed Description

calibrator class for the residual gain map extraction used on an aggregator node

Definition at line 27 of file CalibratorPadGainTracks.h.

Constructor & Destructor Documentation

◆ CalibratorPadGainTracks()

o2::tpc::CalibratorPadGainTracks::CalibratorPadGainTracks ( )

default

construcor

◆ ~CalibratorPadGainTracks()

o2::tpc::CalibratorPadGainTracks::~CalibratorPadGainTracks ( )

finaldefault

destructor

Member Function Documentation

◆ emplaceNewSlot()

CalibratorPadGainTracks::Slot & CalibratorPadGainTracks::emplaceNewSlot	(	bool	front,
		TFType	tstart,
		TFType	tend
	)

finalvirtual

Creates new time slot.

Implements o2::calibration::TimeSlotCalibration< CalibPadGainTracksBase >.

Definition at line 84 of file CalibratorPadGainTracks.cxx.

◆ finalizeSlot()

void CalibratorPadGainTracks::finalizeSlot ( Slot & slot )

finalvirtual

process time slot (create pad-by-pad gain map from tracks)

Implements o2::calibration::TimeSlotCalibration< CalibPadGainTracksBase >.

Definition at line 39 of file CalibratorPadGainTracks.cxx.

◆ getCalibs()

auto o2::tpc::CalibratorPadGainTracks::getCalibs ( ) &&

inline

Returns: returns calibration objects (pad-by-pad gain maps)

Definition at line 106 of file CalibratorPadGainTracks.h.

◆ getMinEntries()

size_t o2::tpc::CalibratorPadGainTracks::getMinEntries ( ) const

inline

Returns: returns minimum number of entries per pad-by-pad histogram

Definition at line 62 of file CalibratorPadGainTracks.h.

◆ getTFinterval()

const TFinterval & o2::tpc::CalibratorPadGainTracks::getTFinterval ( ) const

inline

Returns: CCDB output informations

Definition at line 100 of file CalibratorPadGainTracks.h.

◆ getTimeIntervals()

const TimeInterval & o2::tpc::CalibratorPadGainTracks::getTimeIntervals ( ) const

inline

Returns: Time frame time information

Definition at line 103 of file CalibratorPadGainTracks.h.

◆ getTruncationRangeLow()

float o2::tpc::CalibratorPadGainTracks::getTruncationRangeLow ( ) const

inline

Returns: returns lower truncation range

Definition at line 94 of file CalibratorPadGainTracks.h.

◆ getTruncationRangeUp()

float o2::tpc::CalibratorPadGainTracks::getTruncationRangeUp ( ) const

inline

Returns: returns upper truncation range

Definition at line 97 of file CalibratorPadGainTracks.h.

◆ getWriteDebug()

bool o2::tpc::CalibratorPadGainTracks::getWriteDebug ( ) const

inline

Returns: returns if debug fileswill be written

Definition at line 91 of file CalibratorPadGainTracks.h.

◆ hasCalibrationData()

bool o2::tpc::CalibratorPadGainTracks::hasCalibrationData ( ) const

inline

check if calibration data is available

Definition at line 109 of file CalibratorPadGainTracks.h.

◆ hasEnoughData()

bool o2::tpc::CalibratorPadGainTracks::hasEnoughData ( const Slot & slot ) const

inlinefinalvirtual

Check if there are enough data to compute the calibration.

Returns: false if any of the histograms has less entries than mMinEntries

Implements o2::calibration::TimeSlotCalibration< CalibPadGainTracksBase >.

Definition at line 47 of file CalibratorPadGainTracks.h.

◆ initOutput()

void CalibratorPadGainTracks::initOutput ( )

finalvirtual

clearing the output

Implements o2::calibration::TimeSlotCalibration< CalibPadGainTracksBase >.

Definition at line 19 of file CalibratorPadGainTracks.cxx.

◆ setLogTransformQ()

bool o2::tpc::CalibratorPadGainTracks::setLogTransformQ ( const bool logTransformQ )

inline

set if the cluster charge is transformed using log(1+Q)

Definition at line 85 of file CalibratorPadGainTracks.h.

◆ setMinEntries()

void o2::tpc::CalibratorPadGainTracks::setMinEntries ( const size_t minEntries )

inline

Parameters

minEntries minimum number of entries per pad-by-pad histogram

Definition at line 56 of file CalibratorPadGainTracks.h.

◆ setMinEntriesMean()

void o2::tpc::CalibratorPadGainTracks::setMinEntriesMean ( const int minEntriesMean )

inline

minEntries minimum number of entries in pad-by-pad histogram to calculate the mean

Definition at line 73 of file CalibratorPadGainTracks.h.

◆ setNormalizationType()

void o2::tpc::CalibratorPadGainTracks::setNormalizationType ( const CalibPadGainTracksBase::NormType type )

inline

set how the extracted gain map is normalized

Definition at line 59 of file CalibratorPadGainTracks.h.

◆ setRelGainRange()

void CalibratorPadGainTracks::setRelGainRange	(	const float	minRelgain = `0.1f`,
		const float	maxRelgain = `2.f`
	)

Parameters

minRelgain	minimum accpeted relative gain (if the gain is below this value it will be set to minRelgain)
maxRelgain	maximum accpeted relative gain (if the gain is above this value it will be set to maxRelgain)

Definition at line 33 of file CalibratorPadGainTracks.cxx.

◆ setStoreNClCCDB()

void o2::tpc::CalibratorPadGainTracks::setStoreNClCCDB ( const bool storeNClCCDB )

inline

Parameters

storeNClCCDB store number of cluster in the CCDB

Definition at line 79 of file CalibratorPadGainTracks.h.

◆ setStoreRMSCCDB()

void o2::tpc::CalibratorPadGainTracks::setStoreRMSCCDB ( const bool storeRMSCCDB )

inline

Parameters

storeNClCCDB store RMS of pad-by-pad histograms in the CCDB

Definition at line 82 of file CalibratorPadGainTracks.h.

◆ setTruncationRange()

void CalibratorPadGainTracks::setTruncationRange	(	const float	low = `0.05f`,
		const float	high = `0.6f`
	)

Parameters

low	lower truncation range for calculating the rel gain
high	upper truncation range

Definition at line 27 of file CalibratorPadGainTracks.cxx.

◆ setUseLastExtractedMapAsReference()

void o2::tpc::CalibratorPadGainTracks::setUseLastExtractedMapAsReference ( const bool useLastMap )

inline

Parameters

useLastMap buffer last extracted gain map

Definition at line 88 of file CalibratorPadGainTracks.h.

◆ setWriteDebug()

void o2::tpc::CalibratorPadGainTracks::setWriteDebug ( const bool writeDebug )

inline

Parameters

writeDebug writting debug output

Definition at line 76 of file CalibratorPadGainTracks.h.

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

/home/runner/work/AliceO2/AliceO2/Detectors/TPC/calibration/include/TPCCalibration/CalibratorPadGainTracks.h
/home/runner/work/AliceO2/AliceO2/Detectors/TPC/calibration/src/CalibratorPadGainTracks.cxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CalibratorPadGainTracks()

◆ ~CalibratorPadGainTracks()

Member Function Documentation

◆ emplaceNewSlot()

◆ finalizeSlot()

◆ getCalibs()

◆ getMinEntries()

◆ getTFinterval()

◆ getTimeIntervals()

◆ getTruncationRangeLow()

◆ getTruncationRangeUp()

◆ getWriteDebug()

◆ hasCalibrationData()

◆ hasEnoughData()

◆ initOutput()

◆ setLogTransformQ()

◆ setMinEntries()

◆ setMinEntriesMean()

◆ setNormalizationType()

◆ setRelGainRange()

◆ setStoreNClCCDB()

◆ setStoreRMSCCDB()

◆ setTruncationRange()

◆ setUseLastExtractedMapAsReference()

◆ setWriteDebug()