Base class for raw data calibrations. More...

#include <CalibRawBase.h>

Inherited by o2::tpc::CalibPedestal, o2::tpc::CalibPulser, o2::tpc::DigitDump, and o2::tpc::SimpleEventDisplay.

Public Types
enum class	ProcessStatus : char { Ok , Truncated , NoMoreData , LastEvent , NoReaders , IncompleteEvent }

Public Member Functions
	CalibRawBase (PadSubset padSubset=PadSubset::ROC)

virtual	~CalibRawBase ()=default

virtual Int_t	updateROC (const Int_t roc, const Int_t row, const Int_t pad, const Int_t timeBin, const Float_t signal)=0

virtual Int_t	updateCRU (const CRU &cru, const Int_t row, const Int_t pad, const Int_t timeBin, const Float_t signal)=0

Int_t	update (const PadROCPos &padROCPos, const CRU &cru, const gsl::span< const uint32_t > data)

void	addGBTFrameContainer (GBTFrameContainer *cont)
	add GBT frame container to process

void	addRawReader (RawReader *reader)
	add RawReader

void	setTimeBinsPerCall (Int_t nTimeBins)
	set number of time bins to process in one call to processEvent

Int_t	getTimeBinsPerCall () const
	return the number of time bins processed in one call to processEvent

PadSubset	getPadSubset () const
	return pad subset type used

ProcessStatus	processEvent (int eventNumber=-1)

void	setupContainers (TString fileInfo, uint32_t verbosity=0, uint32_t debugLevel=0)

void	setDebugLevel (int debugLevel=1)

void	rewindEvents ()
	Rewind the events.

virtual void	dumpToFile (const std::string filename, uint32_t type=0)
	Dump the relevant data to file.

void	incrementNEvents ()
	increment number of events

size_t	getNumberOfProcessedEvents () const
	number of processed events

void	setPresentEventNumber (size_t eventNr)
	set present event number

size_t	getPresentEventNumber () const
	get present event number

bool	isPresentEventValie () const

int	getNumberOfEvents () const
	return number of events

bool	isPresentEventComplete () const
	check if present event is complete

void	setNumberOfProcessedTimeBins (size_t timeBins)
	number of processed time bins in last event

size_t	getNumberOfProcessedTimeBins () const
	number of processed time bins in last event

int	getDebugLevel () const
	Debug level.

void	setSkipIncompleteEvents (bool skip)
	set skipping of incomplete events

bool	getSkipIncompleteEvents () const
	get skipping of incomplete events

void	setDigits (std::array< std::vector< Digit >, Sector::MAXSECTOR > *digits)
	set external digits

virtual void	resetEvent ()=0

virtual void	endEvent ()=0

virtual void	endReader ()

Protected Attributes
const Mapper &	mMapper
	TPC mapper.

int	mDebugLevel
	debug level

Detailed Description

Base class for raw data calibrations.

This class is the base class for raw data calibrations It implements base raw reader functionality and calls an 'update' function for each digit

origin: TPC

Author: Jens Wiechula, Jens..nosp@m.Wiec.nosp@m.hula@.nosp@m.ikf..nosp@m.uni-f.nosp@m.rank.nosp@m.furt..nosp@m.de

Definition at line 51 of file CalibRawBase.h.

Member Enumeration Documentation

◆ ProcessStatus

enum class o2::tpc::CalibRawBase::ProcessStatus : char

strong

Enumerator
Ok	Processing ok.
Truncated	Read fewer time bins than mTimeBinsPerCall.
NoMoreData	No data read.
LastEvent	Last event.
NoReaders	No raw reader configures.
IncompleteEvent	Read data is incomplete.

Definition at line 54 of file CalibRawBase.h.

Constructor & Destructor Documentation

◆ CalibRawBase()

o2::tpc::CalibRawBase::CalibRawBase ( PadSubset padSubset = PadSubset::ROC )

inline

Definition at line 63 of file CalibRawBase.h.

◆ ~CalibRawBase()

virtual o2::tpc::CalibRawBase::~CalibRawBase ( )

virtualdefault

Member Function Documentation

◆ addGBTFrameContainer()

void o2::tpc::CalibRawBase::addGBTFrameContainer ( GBTFrameContainer * cont )

inline

add GBT frame container to process

Definition at line 90 of file CalibRawBase.h.

◆ addRawReader()

void o2::tpc::CalibRawBase::addRawReader ( RawReader * reader )

inline

add RawReader

Definition at line 93 of file CalibRawBase.h.

◆ dumpToFile()

virtual void o2::tpc::CalibRawBase::dumpToFile	(	const std::string	filename,
		uint32_t	type = `0`
	)

inlinevirtual

Dump the relevant data to file.

Reimplemented in o2::tpc::CalibPedestal, and o2::tpc::CalibPulser.

Definition at line 122 of file CalibRawBase.h.

◆ endEvent()

virtual void o2::tpc::CalibRawBase::endEvent ( )

pure virtual

Implemented in o2::tpc::CalibPedestal, o2::tpc::CalibPulser, o2::tpc::DigitDump, and o2::tpc::SimpleEventDisplay.

◆ endReader()

virtual void o2::tpc::CalibRawBase::endReader ( )

inlinevirtual

Reimplemented in o2::tpc::CalibPulser.

Definition at line 164 of file CalibRawBase.h.

◆ getDebugLevel()

int o2::tpc::CalibRawBase::getDebugLevel ( ) const

inline

Debug level.

Definition at line 151 of file CalibRawBase.h.

◆ getNumberOfEvents()

int o2::tpc::CalibRawBase::getNumberOfEvents ( ) const

inline

return number of events

Definition at line 208 of file CalibRawBase.h.

◆ getNumberOfProcessedEvents()

size_t o2::tpc::CalibRawBase::getNumberOfProcessedEvents ( ) const

inline

number of processed events

Definition at line 128 of file CalibRawBase.h.

◆ getNumberOfProcessedTimeBins()

size_t o2::tpc::CalibRawBase::getNumberOfProcessedTimeBins ( ) const

inline

number of processed time bins in last event

Definition at line 148 of file CalibRawBase.h.

◆ getPadSubset()

PadSubset o2::tpc::CalibRawBase::getPadSubset ( ) const

inline

return pad subset type used

Definition at line 102 of file CalibRawBase.h.

◆ getPresentEventNumber()

size_t o2::tpc::CalibRawBase::getPresentEventNumber ( ) const

inline

get present event number

Definition at line 134 of file CalibRawBase.h.

◆ getSkipIncompleteEvents()

bool o2::tpc::CalibRawBase::getSkipIncompleteEvents ( ) const

inline

get skipping of incomplete events

Definition at line 157 of file CalibRawBase.h.

◆ getTimeBinsPerCall()

Int_t o2::tpc::CalibRawBase::getTimeBinsPerCall ( ) const

inline

return the number of time bins processed in one call to processEvent

Definition at line 99 of file CalibRawBase.h.

◆ incrementNEvents()

void o2::tpc::CalibRawBase::incrementNEvents ( )

inline

increment number of events

Definition at line 125 of file CalibRawBase.h.

◆ isPresentEventComplete()

bool o2::tpc::CalibRawBase::isPresentEventComplete ( ) const

inline

check if present event is complete

Definition at line 142 of file CalibRawBase.h.

◆ isPresentEventValie()

bool o2::tpc::CalibRawBase::isPresentEventValie ( ) const

inline

Definition at line 136 of file CalibRawBase.h.

◆ processEvent()

CalibRawBase::ProcessStatus o2::tpc::CalibRawBase::processEvent ( int eventNumber = -1 )

inline

Process one event

Parameters

eventNumber Either number >=0 or -1 (next event) or -2 (previous event)

Definition at line 225 of file CalibRawBase.h.

◆ resetEvent()

virtual void o2::tpc::CalibRawBase::resetEvent ( )

pure virtual

◆ rewindEvents()

void CalibRawBase::rewindEvents ( )

Rewind the events.

Definition at line 160 of file CalibRawBase.cxx.

◆ setDebugLevel()

void o2::tpc::CalibRawBase::setDebugLevel ( int debugLevel = 1 )

inline

Set the debug level

Parameters

debugLevel debug level

Definition at line 116 of file CalibRawBase.h.

◆ setDigits()

void o2::tpc::CalibRawBase::setDigits ( std::array< std::vector< Digit >, Sector::MAXSECTOR > * digits )

inline

set external digits

Definition at line 160 of file CalibRawBase.h.

◆ setNumberOfProcessedTimeBins()

void o2::tpc::CalibRawBase::setNumberOfProcessedTimeBins ( size_t timeBins )

inline

number of processed time bins in last event

Definition at line 145 of file CalibRawBase.h.

◆ setPresentEventNumber()

void o2::tpc::CalibRawBase::setPresentEventNumber ( size_t eventNr )

inline

set present event number

Definition at line 131 of file CalibRawBase.h.

◆ setSkipIncompleteEvents()

void o2::tpc::CalibRawBase::setSkipIncompleteEvents ( bool skip )

inline

set skipping of incomplete events

Definition at line 154 of file CalibRawBase.h.

◆ setTimeBinsPerCall()

void o2::tpc::CalibRawBase::setTimeBinsPerCall ( Int_t nTimeBins )

inline

set number of time bins to process in one call to processEvent

Definition at line 96 of file CalibRawBase.h.

◆ setupContainers()

void CalibRawBase::setupContainers	(	TString	fileInfo,
		uint32_t	verbosity = `0`,
		uint32_t	debugLevel = `0`
	)

set up the raw readers

Parameters

fileInfo	file description information
verbosity	verbosity level of the raw readers
debugLevel	debug level of the raw readers

Definition at line 25 of file CalibRawBase.cxx.

◆ update()

Int_t o2::tpc::CalibRawBase::update	(	const PadROCPos &	padROCPos,
		const CRU &	cru,
		const gsl::span< const uint32_t >	data
	)

inline

Definition at line 591 of file CalibRawBase.h.

◆ updateCRU()

virtual Int_t o2::tpc::CalibRawBase::updateCRU	(	const CRU &	cru,
		const Int_t	row,
		const Int_t	pad,
		const Int_t	timeBin,
		const Float_t	signal
	)

pure virtual

update function called once per digit

Parameters

cru	CRU
row	row in CRU
pad	pad in row
timeBin	time bin
signal	ADC signal

Implemented in o2::tpc::CalibPedestal, o2::tpc::CalibPulser, o2::tpc::DigitDump, and o2::tpc::SimpleEventDisplay.

◆ updateROC()

virtual Int_t o2::tpc::CalibRawBase::updateROC	(	const Int_t	roc,
		const Int_t	row,
		const Int_t	pad,
		const Int_t	timeBin,
		const Float_t	signal
	)

pure virtual

update function called once per digit

Parameters

roc	readout chamber
row	row in roc
pad	pad in row
timeBin	time bin
signal	ADC signal

Implemented in o2::tpc::CalibPedestal, o2::tpc::CalibPulser, o2::tpc::DigitDump, and o2::tpc::SimpleEventDisplay.

Member Data Documentation

◆ mDebugLevel

int o2::tpc::CalibRawBase::mDebugLevel

protected

debug level

Definition at line 168 of file CalibRawBase.h.

◆ mMapper

const Mapper& o2::tpc::CalibRawBase::mMapper

protected

TPC mapper.

Definition at line 167 of file CalibRawBase.h.

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

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

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ ProcessStatus

Constructor & Destructor Documentation

◆ CalibRawBase()

◆ ~CalibRawBase()

Member Function Documentation

◆ addGBTFrameContainer()

◆ addRawReader()

◆ dumpToFile()

◆ endEvent()

◆ endReader()

◆ getDebugLevel()

◆ getNumberOfEvents()

◆ getNumberOfProcessedEvents()

◆ getNumberOfProcessedTimeBins()

◆ getPadSubset()

◆ getPresentEventNumber()

◆ getSkipIncompleteEvents()

◆ getTimeBinsPerCall()

◆ incrementNEvents()

◆ isPresentEventComplete()

◆ isPresentEventValie()

◆ processEvent()

◆ resetEvent()

◆ rewindEvents()

◆ setDebugLevel()

◆ setDigits()

◆ setNumberOfProcessedTimeBins()

◆ setPresentEventNumber()

◆ setSkipIncompleteEvents()

◆ setTimeBinsPerCall()

◆ setupContainers()

◆ update()

◆ updateCRU()

◆ updateROC()

Member Data Documentation

◆ mDebugLevel

◆ mMapper