o2::emcal::DigitsWriteoutBuffer Class Reference

Container class for time sampled digits. More...

#include <DigitsWriteoutBuffer.h>

Public Member Functions
	DigitsWriteoutBuffer (unsigned int nTimeBins=15)
	Default constructor.
	~DigitsWriteoutBuffer ()=default
	Destructor.
void	clear ()
	clear the container
void	flush ()
	clear DigitsVectorStream
void	init ()
void	reserve ()
	Reserve space for the future container.
void	finish ()
	This is for the readout window that was interrupted by the end of the run.
double	getTriggerTime () const
double	getEventTime () const
bool	isLive (double t) const
bool	isLive () const
bool	isCurrentEventTriggered () const
bool	preTriggerCollision () const
void	addDigits (unsigned int towerID, std::vector< LabeledDigit > &digList)
void	setSampledDigitsTime ()
	This function sets the right time for all digits in the buffer.
void	setBufferSize (unsigned int nsamples)
	Setting the buffer size.
unsigned int	getBufferSize () const
void	forwardMarker (o2::InteractionTimeRecord record, bool trigger)
	forward the marker for every 100 ns
void	setLiveTime (unsigned int liveTime)
	Setters for the live time, busy time, pre-trigger time.
void	setBusyTime (unsigned int busyTime)
void	setPreTriggerTime (unsigned int pretriggerTime)
unsigned int	getPhase () const
const std::vector< o2::emcal::Digit > &	getDigits () const
const std::vector< o2::emcal::TriggerRecord > &	getTriggerRecords () const
const o2::dataformats::MCTruthContainer< o2::emcal::MCLabel > &	getMCLabels () const

Detailed Description

Container class for time sampled digits.

Author

Hadi Hassan, ORNL

Markus Fasel, ORNL

Date

08/03/2021

Definition at line 38 of file DigitsWriteoutBuffer.h.

Constructor & Destructor Documentation

DigitsWriteoutBuffer()

DigitsWriteoutBuffer::DigitsWriteoutBuffer

(

unsigned int

nTimeBins = 15

)

Default constructor.

Definition at line 26 of file DigitsWriteoutBuffer.cxx.

~DigitsWriteoutBuffer()

o2::emcal::DigitsWriteoutBuffer::~DigitsWriteoutBuffer ( )

default

Destructor.

Member Function Documentation

addDigits()

void DigitsWriteoutBuffer::addDigits	(	unsigned int	towerID,
		std::vector< LabeledDigit > &	digList
	)

Add digit to the container

Parameters

towerID	Cell ID
dig	Labaled digit to add
eventTime	The time of the event (w.r.t Tigger time)

Definition at line 65 of file DigitsWriteoutBuffer.cxx.

clear()

void DigitsWriteoutBuffer::clear

(

)

clear the container

Definition at line 44 of file DigitsWriteoutBuffer.cxx.

finish()

void DigitsWriteoutBuffer::finish

(

)

This is for the readout window that was interrupted by the end of the run.

For the end of the run only write all the remaining digits into the streamer.

Definition at line 170 of file DigitsWriteoutBuffer.cxx.

flush()

void o2::emcal::DigitsWriteoutBuffer::flush ( )

inline

clear DigitsVectorStream

Definition at line 51 of file DigitsWriteoutBuffer.h.

forwardMarker()

void DigitsWriteoutBuffer::forwardMarker	(	o2::InteractionTimeRecord	record,
		bool	trigger
	)

forward the marker for every 100 ns

This is to make the event time multiple of 100s

This is to make the event time multiple of 100s

Definition at line 84 of file DigitsWriteoutBuffer.cxx.

getBufferSize()

unsigned int o2::emcal::DigitsWriteoutBuffer::getBufferSize ( ) const

inline

Definition at line 94 of file DigitsWriteoutBuffer.h.

getDigits()

const std::vector< o2::emcal::Digit > & o2::emcal::DigitsWriteoutBuffer::getDigits ( ) const

inline

Definition at line 106 of file DigitsWriteoutBuffer.h.

getEventTime()

double o2::emcal::DigitsWriteoutBuffer::getEventTime ( ) const

inline

Definition at line 62 of file DigitsWriteoutBuffer.h.

getMCLabels()

const o2::dataformats::MCTruthContainer< o2::emcal::MCLabel > & o2::emcal::DigitsWriteoutBuffer::getMCLabels ( ) const

inline

Definition at line 108 of file DigitsWriteoutBuffer.h.

getPhase()

unsigned int o2::emcal::DigitsWriteoutBuffer::getPhase ( ) const

inline

Definition at line 104 of file DigitsWriteoutBuffer.h.

getTriggerRecords()

const std::vector< o2::emcal::TriggerRecord > & o2::emcal::DigitsWriteoutBuffer::getTriggerRecords ( ) const

inline

Definition at line 107 of file DigitsWriteoutBuffer.h.

getTriggerTime()

double o2::emcal::DigitsWriteoutBuffer::getTriggerTime ( ) const

inline

Definition at line 61 of file DigitsWriteoutBuffer.h.

init()

void DigitsWriteoutBuffer::init

(

)

Definition at line 33 of file DigitsWriteoutBuffer.cxx.

isCurrentEventTriggered()

bool o2::emcal::DigitsWriteoutBuffer::isCurrentEventTriggered ( ) const

inline

Check if current collision was triggered

Returns

true if event was triggered

Definition at line 74 of file DigitsWriteoutBuffer.h.

isLive() [1/2]

bool o2::emcal::DigitsWriteoutBuffer::isLive ( ) const

inline

Definition at line 67 of file DigitsWriteoutBuffer.h.

isLive() [2/2]

bool o2::emcal::DigitsWriteoutBuffer::isLive ( double  t ) const

inline

Definition at line 63 of file DigitsWriteoutBuffer.h.

preTriggerCollision()

bool o2::emcal::DigitsWriteoutBuffer::preTriggerCollision ( ) const

inline

Definition at line 81 of file DigitsWriteoutBuffer.h.

reserve()

void DigitsWriteoutBuffer::reserve

(

)

Reserve space for the future container.

Definition at line 54 of file DigitsWriteoutBuffer.cxx.

setBufferSize()

void o2::emcal::DigitsWriteoutBuffer::setBufferSize ( unsigned int  nsamples )

inline

Setting the buffer size.

Definition at line 93 of file DigitsWriteoutBuffer.h.

setBusyTime()

void o2::emcal::DigitsWriteoutBuffer::setBusyTime ( unsigned int  busyTime )

inline

Definition at line 101 of file DigitsWriteoutBuffer.h.

setLiveTime()

void o2::emcal::DigitsWriteoutBuffer::setLiveTime ( unsigned int  liveTime )

inline

Setters for the live time, busy time, pre-trigger time.

Definition at line 100 of file DigitsWriteoutBuffer.h.

setPreTriggerTime()

void o2::emcal::DigitsWriteoutBuffer::setPreTriggerTime ( unsigned int  pretriggerTime )

inline

Definition at line 102 of file DigitsWriteoutBuffer.h.

setSampledDigitsTime()

void DigitsWriteoutBuffer::setSampledDigitsTime

(

)

This function sets the right time for all digits in the buffer.

Definition at line 203 of file DigitsWriteoutBuffer.cxx.

---

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

• /home/runner/work/AliceO2/AliceO2/Detectors/EMCAL/simulation/include/EMCALSimulation/DigitsWriteoutBuffer.h
• /home/runner/work/AliceO2/AliceO2/Detectors/EMCAL/simulation/src/DigitsWriteoutBuffer.cxx