Project
Loading...
Searching...
No Matches
Public Member Functions | List of all members
o2::tof::CTFCoder Class Reference

#include <CTFCoder.h>

Inherits o2::ctf::CTFCoderBase.

Public Member Functions

 CTFCoder (o2::ctf::CTFCoderBase::OpType op)
 
 ~CTFCoder () final=default
 
template<typename VEC >
o2::ctf::CTFIOSize encode (VEC &buff, const gsl::span< const ReadoutWindowData > &rofRecVec, const gsl::span< const Digit > &cdigVec, const gsl::span< const uint8_t > &pattVec)
 entropy-encode clusters to buffer with CTF
 
template<typename VROF , typename VDIG , typename VPAT >
o2::ctf::CTFIOSize decode (const CTF::base &ec, VROF &rofRecVec, VDIG &cdigVec, VPAT &pattVec)
 entropy decode clusters from buffer with CTF
 
void createCoders (const std::vector< char > &bufVec, o2::ctf::CTFCoderBase::OpType op) final
 
- Public Member Functions inherited from o2::ctf::CTFCoderBase
 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 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)
 

Additional Inherited Members

- Public Types inherited from o2::ctf::CTFCoderBase
enum class  OpType : int { Encoder , Decoder }
 
- Static Public Member Functions inherited from o2::ctf::CTFCoderBase
template<typename T >
static bool readFromTree (TTree &tree, const std::string brname, T &dest, int ev=0)
 
- Protected Member Functions inherited from o2::ctf::CTFCoderBase
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 inherited from o2::ctf::CTFCoderBase
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 34 of file CTFCoder.h.

Constructor & Destructor Documentation

◆ CTFCoder()

o2::tof::CTFCoder::CTFCoder ( o2::ctf::CTFCoderBase::OpType  op)
inline

Definition at line 37 of file CTFCoder.h.

◆ ~CTFCoder()

o2::tof::CTFCoder::~CTFCoder ( )
finaldefault

Member Function Documentation

◆ createCoders()

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

Implements o2::ctf::CTFCoderBase.

Definition at line 150 of file CTFCoder.cxx.

◆ decode()

template<typename VROF , typename VDIG , typename VPAT >
o2::ctf::CTFIOSize o2::tof::CTFCoder::decode ( const CTF::base &  ec,
VROF &  rofRecVec,
VDIG &  cdigVec,
VPAT &  pattVec 
)

entropy decode clusters from buffer with CTF

decode entropy-encoded digits to standard compact digits

Definition at line 119 of file CTFCoder.h.

◆ encode()

template<typename VEC >
o2::ctf::CTFIOSize o2::tof::CTFCoder::encode ( VEC &  buff,
const gsl::span< const ReadoutWindowData > &  rofRecVec,
const gsl::span< const Digit > &  cdigVec,
const gsl::span< const uint8_t > &  pattVec 
)

entropy-encode clusters to buffer with CTF

entropy-encode digits to buffer with CTF

Definition at line 65 of file CTFCoder.h.

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