o2::tpc::IDCSim Class Reference

#include <IDCSim.h>

Public Member Functions
	IDCSim (const unsigned int sector=0, const unsigned int nOrbits=12)
void	integrateDigitsForOneTF (const gsl::span< const o2::tpc::Digit > &digits)
void	dumpIDCs (const char *outFileName, const char *outName="IDCSim") const
void	createDebugTree (const char *nameTree) const
const auto &	get () const
unsigned int	getSector () const
unsigned int	getNOrbitsPerIntegrationInterval () const
unsigned int	getNTimeStampsPerIntegrationInterval () const
bool	additionalInterval () const
unsigned int	getNIntegrationIntervalsPerTF () const
unsigned int	getNTimeStampsRemainder () const
int	getTimeBinsOff () const
void	drawIDCs (const unsigned int integrationInterval=0, const std::string filename="IDCs.pdf") const
unsigned int	getMaxIDCs (const unsigned int region) const

Static Public Member Functions
static void	setNOrbitsPerTF (const unsigned int nOrbitsPerTF)
static void	createDebugTreeForAllSectors (const char *nameTree, const char *filename)
static unsigned int	getNOrbitsPerTF ()

Detailed Description

This class is for the integration of IDCs for one sector. The input has to be provided for one TF. The IDCs are stored per CRU for all integration intervals.

Definition at line 43 of file IDCSim.h.

Constructor & Destructor Documentation

IDCSim()

o2::tpc::IDCSim::IDCSim ( const unsigned int  sector = 0, const unsigned int  nOrbits = 12  )

inline

constructor

Parameters

sector	sector for which the data is processed
nOrbits	length of integration intervals

Definition at line 49 of file IDCSim.h.

Member Function Documentation

additionalInterval()

bool o2::tpc::IDCSim::additionalInterval ( ) const

inline

Returns

returns the check if an additional interval is used (if the last integration interval can also be empty)

Definition at line 88 of file IDCSim.h.

createDebugTree()

void o2::tpc::IDCSim::createDebugTree

(

const char *

nameTree

)

const

for debugging: creating debug tree for integrated IDCs

Parameters

nameTree

name of the output file

Definition at line 95 of file IDCSim.cxx.

createDebugTreeForAllSectors()

void o2::tpc::IDCSim::createDebugTreeForAllSectors ( const char *  nameTree, const char *  filename  )

static

for debugging: creating debug tree for integrated IDCs for all objects which are in the same file

Parameters

nameTree	name of the output file
filename	name of the input file containing the objects

Definition at line 103 of file IDCSim.cxx.

drawIDCs()

void o2::tpc::IDCSim::drawIDCs	(	const unsigned int	integrationInterval = 0,
		const std::string	filename = "IDCs.pdf"
	)		const

draw ungrouped IDCs

Parameters

integrationInterval	integration interval for which the IDCs will be drawn
filename	name of the output file. If empty the canvas is drawn.

Definition at line 180 of file IDCSim.cxx.

dumpIDCs()

void o2::tpc::IDCSim::dumpIDCs	(	const char *	outFileName,
		const char *	outName = "IDCSim"
	)		const

for debugging: dumping IDCs to ROOT file

Parameters

filename

name of the output file

Definition at line 88 of file IDCSim.cxx.

get()

const auto & o2::tpc::IDCSim::get ( ) const

inline

Returns

returns the IDCs for all regions

Definition at line 73 of file IDCSim.h.

getMaxIDCs()

unsigned int o2::tpc::IDCSim::getMaxIDCs ( const unsigned int  region ) const

inline

Returns

returns maximum number of IDCs per region for all integration intervals

Definition at line 105 of file IDCSim.h.

getNIntegrationIntervalsPerTF()

unsigned int o2::tpc::IDCSim::getNIntegrationIntervalsPerTF ( ) const

inline

Returns

returns maximum number of integration intervals used for one TF

Definition at line 91 of file IDCSim.h.

getNOrbitsPerIntegrationInterval()

unsigned int o2::tpc::IDCSim::getNOrbitsPerIntegrationInterval ( ) const

inline

Returns

returns number of orbits used for each integration interval

Definition at line 82 of file IDCSim.h.

getNOrbitsPerTF()

static unsigned int o2::tpc::IDCSim::getNOrbitsPerTF ( )

inlinestatic

Returns

returns the number of orbits for one TF

Definition at line 79 of file IDCSim.h.

getNTimeStampsPerIntegrationInterval()

unsigned int o2::tpc::IDCSim::getNTimeStampsPerIntegrationInterval ( ) const

inline

Returns

returns number of time stamps per integration interval (should be 5346)

Definition at line 85 of file IDCSim.h.

getNTimeStampsRemainder()

unsigned int o2::tpc::IDCSim::getNTimeStampsRemainder ( ) const

inline

Returns

number time stamps which remain in one TF and will be buffered to the next TF

Definition at line 94 of file IDCSim.h.

getSector()

unsigned int o2::tpc::IDCSim::getSector ( ) const

inline

Returns

returns the sector for which the IDCs are integrated

Definition at line 76 of file IDCSim.h.

getTimeBinsOff()

int o2::tpc::IDCSim::getTimeBinsOff ( ) const

inline

Returns

offset from last time bin

Definition at line 97 of file IDCSim.h.

integrateDigitsForOneTF()

void o2::tpc::IDCSim::integrateDigitsForOneTF

(

const gsl::span< const o2::tpc::Digit > &

digits

)

Parameters

digits

digits for one sector for one Time Frame

Definition at line 25 of file IDCSim.cxx.

setNOrbitsPerTF()

static void o2::tpc::IDCSim::setNOrbitsPerTF ( const unsigned int  nOrbitsPerTF )

inlinestatic

set number of orbits per TF which is used to determine the size of the vectors etc.

Parameters

nOrbitsPerTF

number of orbits per TF

Definition at line 57 of file IDCSim.h.

---

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

• /home/runner/work/AliceO2/AliceO2/Detectors/TPC/simulation/include/TPCSimulation/IDCSim.h
• /home/runner/work/AliceO2/AliceO2/Detectors/TPC/simulation/src/IDCSim.cxx