Project
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
o2::ctf::CTFCoderBase Class Referenceabstract

#include <CTFCoderBase.h>

Inherited by o2::cpv::CTFCoder, o2::ctp::CTFCoder, o2::emcal::CTFCoder, o2::fdd::CTFCoder, o2::ft0::CTFCoder, o2::fv0::CTFCoder, o2::hmpid::CTFCoder, o2::itsmft::CTFCoder, o2::mch::CTFCoder, o2::mid::CTFCoder, o2::phos::CTFCoder, o2::tof::CTFCoder, o2::tpc::CTFCoder, o2::trd::CTFCoder, and o2::zdc::CTFCoder.

Public Types

enum class  OpType : int { Encoder , Decoder }
 

Public Member Functions

 CTFCoderBase ()=delete
 
 CTFCoderBase (int n, DetID det, float memFactor=1.f)
 
 CTFCoderBase (OpType op, int n, DetID det, float memFactor=1.f)
 
virtual ~CTFCoderBase ()=default
 
virtual void createCoders (const std::vector< char > &bufVec, o2::ctf::CTFCoderBase::OpType op)=0
 
virtual void assignDictVersion (CTFDictHeader &h) const
 
template<typename SPAN >
void setSelectedIRFrames (const SPAN &sp)
 
template<typename CTF >
std::vector< char > readDictionaryFromFile (const std::string &dictPath, bool mayFail=false)
 
template<typename CTF >
void createCodersFromFile (const std::string &dictPath, o2::ctf::CTFCoderBase::OpType op, bool mayFail=false)
 
template<typename S >
void createCoder (OpType op, const o2::rans::RenormedDenseHistogram< S > &renormedHistogram, int slot)
 
void clear ()
 
void setMemMarginFactor (float v)
 
float getMemMarginFactor () const
 
void setVerbosity (int v)
 
int getVerbosity () const
 
const CTFDictHeader & getExtDictHeader () const
 
template<typename CTF >
void init (o2::framework::InitContext &ic)
 
template<typename CTF , typename BUF >
size_t finaliseCTFOutput (BUF &buffer)
 
template<typename CTF >
bool finaliseCCDB (o2::framework::ConcreteDataMatcher &matcher, void *obj)
 
void updateTimeDependentParams (o2::framework::ProcessingContext &pc, bool askTree=false)
 
o2::utils::IRFrameSelector & getIRFramesSelector ()
 
size_t getIRFrameSelMarginBwd () const
 
size_t getIRFrameSelMarginFwd () const
 
long getIRFrameSelShift () const
 
const ctf::ANSHeader & getANSVersion () const noexcept
 
ctf::ANSHeader & getANSVersion ()
 
void setANSVersion (const ctf::ANSHeader &ansVersion) noexcept
 
void setBCShift (int64_t n)
 
void setFirstTFOrbit (uint32_t n)
 
auto getBCShift () const
 
auto getFirstTFOrbit () const
 
void setSupportBCShifts (bool v=true)
 
bool getSupportBCShifts () const
 
void setDictBinding (const std::string &s)
 
const std::string & getDictBinding () const
 
void setTrigOffsBinding (const std::string &s)
 
const std::string & getTrigOffsBinding () const
 
const DetID getDet () const
 
template<typename IT >
size_t estimateBufferSize (size_t slot, IT samplesBegin, IT samplesEnd)
 

Static Public Member Functions

template<typename T >
static bool readFromTree (TTree &tree, const std::string brname, T &dest, int ev=0)
 

Protected Member Functions

void reportIRFrames ()
 
std::string getPrefix () const
 
void checkDictVersion (const CTFDictHeader &h) const
 
bool isTreeDictionary (const void *buff) const
 
bool canApplyBCShift (const o2::InteractionRecord &ir, long shift) const
 
bool canApplyBCShift (const o2::InteractionRecord &ir) const
 
template<typename source_IT >
size_t estimateBufferSize (size_t slot, source_IT samplesBegin, source_IT samplesEnd)
 
template<typename source_T >
size_t estimateBufferSize (size_t slot, size_t nSamples)
 
template<typename source_T >
size_t estimateBufferSize (size_t slot, const std::vector< source_T > &samples)
 
template<typename CTF >
std::vector< char > loadDictionaryFromTree (TTree *tree)
 

Protected Attributes

std::vector< std::any > mCoders
 
DetID mDet
 
std::string mDictBinding {"ctfdict"}
 
std::string mTrigOffsBinding {"trigoffset"}
 
CTFDictHeader mExtHeader
 
o2::utils::IRFrameSelector mIRFrameSelector
 
float mMemMarginFactor = 1.0f
 
bool mLoadDictFromCCDB {true}
 
bool mSupportBCShifts {false}
 
OpType mOpType
 
ctf::ANSHeader mANSVersion {ctf::ANSVersionCompat}
 
int64_t mBCShift = 0
 
uint32_t mFirstTFOrbit = 0
 
size_t mIRFrameSelMarginBwd = 0
 
size_t mIRFrameSelMarginFwd = 0
 
long mIRFrameSelShift = 0
 
int mVerbosity = 0
 

Detailed Description

Definition at line 53 of file CTFCoderBase.h.

Member Enumeration Documentation

◆ OpType

enum class o2::ctf::CTFCoderBase::OpType : int
strong
Enumerator
Encoder 
Decoder 

Definition at line 57 of file CTFCoderBase.h.

Constructor & Destructor Documentation

◆ CTFCoderBase() [1/3]

o2::ctf::CTFCoderBase::CTFCoderBase ( )
delete

◆ CTFCoderBase() [2/3]

o2::ctf::CTFCoderBase::CTFCoderBase ( int  n,
DetID  det,
float  memFactor = 1.f 
)
inline

Definition at line 61 of file CTFCoderBase.h.

◆ CTFCoderBase() [3/3]

o2::ctf::CTFCoderBase::CTFCoderBase ( OpType  op,
int  n,
DetID  det,
float  memFactor = 1.f 
)
inline

Definition at line 62 of file CTFCoderBase.h.

◆ ~CTFCoderBase()

virtual o2::ctf::CTFCoderBase::~CTFCoderBase ( )
virtualdefault

Member Function Documentation

◆ assignDictVersion()

void CTFCoderBase::assignDictVersion ( CTFDictHeader &  h) const
virtual

Definition at line 37 of file CTFCoderBase.cxx.

◆ canApplyBCShift() [1/2]

bool o2::ctf::CTFCoderBase::canApplyBCShift ( const o2::InteractionRecord &  ir) const
inlineprotected

Definition at line 174 of file CTFCoderBase.h.

◆ canApplyBCShift() [2/2]

bool o2::ctf::CTFCoderBase::canApplyBCShift ( const o2::InteractionRecord &  ir,
long  shift 
) const
inlineprotected

Definition at line 169 of file CTFCoderBase.h.

◆ checkDictVersion()

void CTFCoderBase::checkDictVersion ( const CTFDictHeader &  h) const
protected

Definition at line 25 of file CTFCoderBase.cxx.

◆ clear()

void o2::ctf::CTFCoderBase::clear ( )
inline

Definition at line 111 of file CTFCoderBase.h.

◆ createCoder()

template<typename S >
void o2::ctf::CTFCoderBase::createCoder ( OpType  op,
const o2::rans::RenormedDenseHistogram< S > &  renormedHistogram,
int  slot 
)
inline

Definition at line 84 of file CTFCoderBase.h.

◆ createCoders()

virtual void o2::ctf::CTFCoderBase::createCoders ( const std::vector< char > &  bufVec,
o2::ctf::CTFCoderBase::OpType  op 
)
pure virtual

Implemented in o2::cpv::CTFCoder, o2::ctp::CTFCoder, o2::emcal::CTFCoder, o2::fdd::CTFCoder, o2::ft0::CTFCoder, o2::fv0::CTFCoder, o2::hmpid::CTFCoder, o2::itsmft::CTFCoder, o2::mch::CTFCoder, o2::mid::CTFCoder, o2::phos::CTFCoder, o2::tof::CTFCoder, o2::tpc::CTFCoder, o2::trd::CTFCoder, and o2::zdc::CTFCoder.

◆ createCodersFromFile()

template<typename CTF >
void o2::ctf::CTFCoderBase::createCodersFromFile ( const std::string &  dictPath,
o2::ctf::CTFCoderBase::OpType  op,
bool  mayFail = false 
)

Definition at line 226 of file CTFCoderBase.h.

◆ estimateBufferSize() [1/4]

template<typename source_T >
size_t o2::ctf::CTFCoderBase::estimateBufferSize ( size_t  slot,
const std::vector< source_T > &  samples 
)
inlineprotected

Definition at line 183 of file CTFCoderBase.h.

◆ estimateBufferSize() [2/4]

template<typename IT >
size_t o2::ctf::CTFCoderBase::estimateBufferSize ( size_t  slot,
IT  samplesBegin,
IT  samplesEnd 
)
inline

Definition at line 390 of file CTFCoderBase.h.

◆ estimateBufferSize() [3/4]

template<typename source_T >
size_t o2::ctf::CTFCoderBase::estimateBufferSize ( size_t  slot,
size_t  nSamples 
)
inlineprotected

Definition at line 398 of file CTFCoderBase.h.

◆ estimateBufferSize() [4/4]

template<typename source_IT >
size_t o2::ctf::CTFCoderBase::estimateBufferSize ( size_t  slot,
source_IT  samplesBegin,
source_IT  samplesEnd 
)
protected

◆ finaliseCCDB()

template<typename CTF >
bool o2::ctf::CTFCoderBase::finaliseCCDB ( o2::framework::ConcreteDataMatcher &  matcher,
void *  obj 
)

Definition at line 355 of file CTFCoderBase.h.

◆ finaliseCTFOutput()

template<typename CTF , typename BUF >
size_t o2::ctf::CTFCoderBase::finaliseCTFOutput ( BUF &  buffer)

Definition at line 344 of file CTFCoderBase.h.

◆ getANSVersion() [1/2]

ctf::ANSHeader & o2::ctf::CTFCoderBase::getANSVersion ( )
inline

Definition at line 147 of file CTFCoderBase.h.

◆ getANSVersion() [2/2]

const ctf::ANSHeader & o2::ctf::CTFCoderBase::getANSVersion ( ) const
inlinenoexcept

Definition at line 146 of file CTFCoderBase.h.

◆ getBCShift()

auto o2::ctf::CTFCoderBase::getBCShift ( ) const
inline

Definition at line 151 of file CTFCoderBase.h.

◆ getDet()

const DetID o2::ctf::CTFCoderBase::getDet ( ) const
inline

Definition at line 162 of file CTFCoderBase.h.

◆ getDictBinding()

const std::string & o2::ctf::CTFCoderBase::getDictBinding ( ) const
inline

Definition at line 157 of file CTFCoderBase.h.

◆ getExtDictHeader()

const CTFDictHeader & o2::ctf::CTFCoderBase::getExtDictHeader ( ) const
inline

Definition at line 124 of file CTFCoderBase.h.

◆ getFirstTFOrbit()

auto o2::ctf::CTFCoderBase::getFirstTFOrbit ( ) const
inline

Definition at line 152 of file CTFCoderBase.h.

◆ getIRFrameSelMarginBwd()

size_t o2::ctf::CTFCoderBase::getIRFrameSelMarginBwd ( ) const
inline

Definition at line 142 of file CTFCoderBase.h.

◆ getIRFrameSelMarginFwd()

size_t o2::ctf::CTFCoderBase::getIRFrameSelMarginFwd ( ) const
inline

Definition at line 143 of file CTFCoderBase.h.

◆ getIRFrameSelShift()

long o2::ctf::CTFCoderBase::getIRFrameSelShift ( ) const
inline

Definition at line 144 of file CTFCoderBase.h.

◆ getIRFramesSelector()

o2::utils::IRFrameSelector & o2::ctf::CTFCoderBase::getIRFramesSelector ( )
inline

Definition at line 141 of file CTFCoderBase.h.

◆ getMemMarginFactor()

float o2::ctf::CTFCoderBase::getMemMarginFactor ( ) const
inline

Definition at line 119 of file CTFCoderBase.h.

◆ getPrefix()

std::string o2::ctf::CTFCoderBase::getPrefix ( ) const
inlineprotected

Definition at line 166 of file CTFCoderBase.h.

◆ getSupportBCShifts()

bool o2::ctf::CTFCoderBase::getSupportBCShifts ( ) const
inline

Definition at line 154 of file CTFCoderBase.h.

◆ getTrigOffsBinding()

const std::string & o2::ctf::CTFCoderBase::getTrigOffsBinding ( ) const
inline

Definition at line 160 of file CTFCoderBase.h.

◆ getVerbosity()

int o2::ctf::CTFCoderBase::getVerbosity ( ) const
inline

Definition at line 122 of file CTFCoderBase.h.

◆ init()

template<typename CTF >
void o2::ctf::CTFCoderBase::init ( o2::framework::InitContext &  ic)

Definition at line 302 of file CTFCoderBase.h.

◆ isTreeDictionary()

bool CTFCoderBase::isTreeDictionary ( const void *  buff) const
protected

Definition at line 66 of file CTFCoderBase.cxx.

◆ loadDictionaryFromTree()

template<typename CTF >
std::vector< char > o2::ctf::CTFCoderBase::loadDictionaryFromTree ( TTree *  tree)
protected

Definition at line 240 of file CTFCoderBase.h.

◆ readDictionaryFromFile()

template<typename CTF >
std::vector< char > o2::ctf::CTFCoderBase::readDictionaryFromFile ( const std::string &  dictPath,
bool  mayFail = false 
)

Definition at line 252 of file CTFCoderBase.h.

◆ readFromTree()

template<typename T >
bool o2::ctf::CTFCoderBase::readFromTree ( TTree &  tree,
const std::string  brname,
T &  dest,
int  ev = 0 
)
static

Definition at line 211 of file CTFCoderBase.h.

◆ reportIRFrames()

void CTFCoderBase::reportIRFrames ( )
protected

Definition at line 90 of file CTFCoderBase.cxx.

◆ setANSVersion()

void o2::ctf::CTFCoderBase::setANSVersion ( const ctf::ANSHeader &  ansVersion)
inlinenoexcept

Definition at line 148 of file CTFCoderBase.h.

◆ setBCShift()

void o2::ctf::CTFCoderBase::setBCShift ( int64_t  n)
inline

Definition at line 149 of file CTFCoderBase.h.

◆ setDictBinding()

void o2::ctf::CTFCoderBase::setDictBinding ( const std::string &  s)
inline

Definition at line 156 of file CTFCoderBase.h.

◆ setFirstTFOrbit()

void o2::ctf::CTFCoderBase::setFirstTFOrbit ( uint32_t  n)
inline

Definition at line 150 of file CTFCoderBase.h.

◆ setMemMarginFactor()

void o2::ctf::CTFCoderBase::setMemMarginFactor ( float  v)
inline

Definition at line 118 of file CTFCoderBase.h.

◆ setSelectedIRFrames()

template<typename SPAN >
void o2::ctf::CTFCoderBase::setSelectedIRFrames ( const SPAN &  sp)
inline

Definition at line 71 of file CTFCoderBase.h.

◆ setSupportBCShifts()

void o2::ctf::CTFCoderBase::setSupportBCShifts ( bool  v = true)
inline

Definition at line 153 of file CTFCoderBase.h.

◆ setTrigOffsBinding()

void o2::ctf::CTFCoderBase::setTrigOffsBinding ( const std::string &  s)
inline

Definition at line 159 of file CTFCoderBase.h.

◆ setVerbosity()

void o2::ctf::CTFCoderBase::setVerbosity ( int  v)
inline

Definition at line 121 of file CTFCoderBase.h.

◆ updateTimeDependentParams()

void CTFCoderBase::updateTimeDependentParams ( o2::framework::ProcessingContext &  pc,
bool  askTree = false 
)

Definition at line 49 of file CTFCoderBase.cxx.

Member Data Documentation

◆ mANSVersion

ctf::ANSHeader o2::ctf::CTFCoderBase::mANSVersion {ctf::ANSVersionCompat}
protected

Definition at line 200 of file CTFCoderBase.h.

◆ mBCShift

int64_t o2::ctf::CTFCoderBase::mBCShift = 0
protected

Definition at line 201 of file CTFCoderBase.h.

◆ mCoders

std::vector<std::any> o2::ctf::CTFCoderBase::mCoders
protected

Definition at line 190 of file CTFCoderBase.h.

◆ mDet

DetID o2::ctf::CTFCoderBase::mDet
protected

Definition at line 191 of file CTFCoderBase.h.

◆ mDictBinding

std::string o2::ctf::CTFCoderBase::mDictBinding {"ctfdict"}
protected

Definition at line 192 of file CTFCoderBase.h.

◆ mExtHeader

CTFDictHeader o2::ctf::CTFCoderBase::mExtHeader
protected

Definition at line 194 of file CTFCoderBase.h.

◆ mFirstTFOrbit

uint32_t o2::ctf::CTFCoderBase::mFirstTFOrbit = 0
protected

Definition at line 202 of file CTFCoderBase.h.

◆ mIRFrameSelector

o2::utils::IRFrameSelector o2::ctf::CTFCoderBase::mIRFrameSelector
protected

Definition at line 195 of file CTFCoderBase.h.

◆ mIRFrameSelMarginBwd

size_t o2::ctf::CTFCoderBase::mIRFrameSelMarginBwd = 0
protected

Definition at line 203 of file CTFCoderBase.h.

◆ mIRFrameSelMarginFwd

size_t o2::ctf::CTFCoderBase::mIRFrameSelMarginFwd = 0
protected

Definition at line 204 of file CTFCoderBase.h.

◆ mIRFrameSelShift

long o2::ctf::CTFCoderBase::mIRFrameSelShift = 0
protected

Definition at line 205 of file CTFCoderBase.h.

◆ mLoadDictFromCCDB

bool o2::ctf::CTFCoderBase::mLoadDictFromCCDB {true}
protected

Definition at line 197 of file CTFCoderBase.h.

◆ mMemMarginFactor

float o2::ctf::CTFCoderBase::mMemMarginFactor = 1.0f
protected

Definition at line 196 of file CTFCoderBase.h.

◆ mOpType

OpType o2::ctf::CTFCoderBase::mOpType
protected

Definition at line 199 of file CTFCoderBase.h.

◆ mSupportBCShifts

bool o2::ctf::CTFCoderBase::mSupportBCShifts {false}
protected

Definition at line 198 of file CTFCoderBase.h.

◆ mTrigOffsBinding

std::string o2::ctf::CTFCoderBase::mTrigOffsBinding {"trigoffset"}
protected

Definition at line 193 of file CTFCoderBase.h.

◆ mVerbosity

int o2::ctf::CTFCoderBase::mVerbosity = 0
protected

Definition at line 206 of file CTFCoderBase.h.

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