CbmRoot
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
CbmRichUnpackAlgoBase Class Reference

#include <CbmRichUnpackAlgoBase.h>

Inheritance diagram for CbmRichUnpackAlgoBase:
[legend]
Collaboration diagram for CbmRichUnpackAlgoBase:
[legend]

Public Member Functions

 CbmRichUnpackAlgoBase (std::string name)
 Create the Cbm Trd Unpack AlgoBase object.
 
virtual ~CbmRichUnpackAlgoBase ()
 Destroy the Cbm Trd Unpack Task object.
 
 CbmRichUnpackAlgoBase (const CbmRichUnpackAlgoBase &)=delete
 Copy constructor - not implemented.
 
CbmRichUnpackAlgoBase & operator= (const CbmRichUnpackAlgoBase &)=delete
 Assignment operator - not implemented.
 
virtual std::vector< std::pair< std::string, std::shared_ptr< FairParGenericSet > > > * GetParContainerRequest (std::string geoTag, uint32_t runId)
 Get the requested parameter containers. To be defined in the derived classes! Return the required parameter containers together with the paths to the ascii files to.
 
void SetMonitor (std::shared_ptr< CbmRichUnpackMonitor > monitor)
 Set a predefined monitor.
 
void SetMaskedDiRICHes (std::vector< Int_t > *maskedDiRICHes)
 Set Addresses of DiRICH boards to be masked.
 
void DoTotOffsetCorrection (Bool_t activate=true)
 (De-) Activate Tot offset correction of digis
 

Protected Member Functions

double calculateTime (uint32_t epoch, uint32_t coarse, uint32_t fine)
 
void finish ()
 Finish function for this algorithm base clase.
 
virtual void finishDerived ()
 Function that allows special calls during Finish in the derived algos.
 
std::string getLogHeader (CbmRichUnpackAlgoMicrosliceReader &reader)
 
Int_t getPixelUID (Int_t fpgaID, Int_t ch) const
 
Bool_t init ()
 Intialisation at begin of run. Special inits of the derived algos.
 
Bool_t initParSet (FairParGenericSet *parset)
 Handles the distribution of the hidden derived classes to their explicit functions.
 
Bool_t initParSet (CbmMcbm2018RichPar *parset)
 Handles the distribution of the hidden derived classes to their explicit functions.
 
bool isLog ()
 
bool setDerivedTsParameters (size_t)
 Set the Derived Ts Parameters.
 
bool checkMaskedDiRICH (Int_t subSubEventId)
 Unpack a given microslice. To be implemented in the derived unpacker algos.
 

Protected Attributes

std::shared_ptr< CbmRichUnpackMonitor > fMonitor = nullptr
 Potential (online) monitor for the unpacking process.
 
CbmMcbm2018RichPar fUnpackPar
 Parameters for the unpacking.
 
std::vector< Int_t > * fMaskedDiRICHes = nullptr
 
size_t fMsRefTime = 0
 
double fToTMin = -20.
 
double fToTMax = 100.
 
Bool_t fbDoToTCorr = true
 

Detailed Description

Definition at line 199 of file CbmRichUnpackAlgoBase.h.

Constructor & Destructor Documentation

◆ CbmRichUnpackAlgoBase() [1/2]

CbmRichUnpackAlgoBase::CbmRichUnpackAlgoBase ( std::string name)

Create the Cbm Trd Unpack AlgoBase object.

Definition at line 17 of file CbmRichUnpackAlgoBase.cxx.

Referenced by CbmRichUnpackAlgo::CbmRichUnpackAlgo(), CbmRichUnpackAlgo2022::CbmRichUnpackAlgo2022(), CbmRichUnpackAlgoBase(), and operator=().

◆ ~CbmRichUnpackAlgoBase()

CbmRichUnpackAlgoBase::~CbmRichUnpackAlgoBase ( )
virtual

Destroy the Cbm Trd Unpack Task object.

Definition at line 19 of file CbmRichUnpackAlgoBase.cxx.

◆ CbmRichUnpackAlgoBase() [2/2]

CbmRichUnpackAlgoBase::CbmRichUnpackAlgoBase ( const CbmRichUnpackAlgoBase & )
delete

Copy constructor - not implemented.

References CbmRichUnpackAlgoBase().

Member Function Documentation

◆ calculateTime()

double CbmRichUnpackAlgoBase::calculateTime ( uint32_t epoch,
uint32_t coarse,
uint32_t fine )
protected

Definition at line 40 of file CbmRichUnpackAlgoBase.cxx.

Referenced by CbmRichUnpackAlgo::processMbs(), CbmRichUnpackAlgo2022::processTimeDataWord(), CbmRichUnpackAlgo::processTimeDataWord(), and CbmRichUnpackAlgo2022::processTrbPacket().

◆ checkMaskedDiRICH()

bool CbmRichUnpackAlgoBase::checkMaskedDiRICH ( Int_t subSubEventId)
protected

Unpack a given microslice. To be implemented in the derived unpacker algos.

Parameters
tstimeslice pointer
icompindex to the component to be unpacked
imsliceindex of the microslice to be unpacked
Returns
true
false
Remarks
The content of the micro-slice can only be accessed via the timeslice. Hence, we need to pass the pointer to the full timeslice

Definition at line 91 of file CbmRichUnpackAlgoBase.cxx.

References fMaskedDiRICHes.

Referenced by CbmRichUnpackAlgo2022::processSubSubEvent(), and CbmRichUnpackAlgo::processSubSubEvent().

◆ DoTotOffsetCorrection()

void CbmRichUnpackAlgoBase::DoTotOffsetCorrection ( Bool_t activate = true)
inline

(De-) Activate Tot offset correction of digis

Parameters
activatebool to activate the Tot offset correction

Definition at line 233 of file CbmRichUnpackAlgoBase.h.

References fbDoToTCorr.

◆ finish()

void CbmRichUnpackAlgoBase::finish ( )
inlineprotected

Finish function for this algorithm base clase.

Definition at line 239 of file CbmRichUnpackAlgoBase.h.

References finishDerived(), and fMonitor.

◆ finishDerived()

virtual void CbmRichUnpackAlgoBase::finishDerived ( )
inlineprotectedvirtual

Function that allows special calls during Finish in the derived algos.

Definition at line 254 of file CbmRichUnpackAlgoBase.h.

Referenced by finish().

◆ getLogHeader()

std::string CbmRichUnpackAlgoBase::getLogHeader ( CbmRichUnpackAlgoMicrosliceReader & reader)
protected

Definition at line 46 of file CbmRichUnpackAlgoBase.cxx.

References CbmRichUnpackAlgoMicrosliceReader::GetCurWord(), CbmRichUnpackAlgoMicrosliceReader::GetSize(), CbmRichUnpackAlgoMicrosliceReader::GetWordAsHexString(), and CbmRichUnpackAlgoMicrosliceReader::GetWordCounter().

Referenced by CbmRichUnpackAlgo2022::processCtsSubSubEvent(), CbmRichUnpackAlgo::processCtsSubSubEvent(), CbmRichUnpackAlgo2022::processHubBlock(), CbmRichUnpackAlgo::processHubBlock(), CbmRichUnpackAlgo::processMbs(), CbmRichUnpackAlgo2022::processSubSubEvent(), CbmRichUnpackAlgo::processSubSubEvent(), CbmRichUnpackAlgo2022::processTimeDataWord(), CbmRichUnpackAlgo::processTimeDataWord(), CbmRichUnpackAlgo2022::processTrbPacket(), CbmRichUnpackAlgo::processTrbPacket(), CbmRichUnpackAlgo2022::unpack(), and CbmRichUnpackAlgo::unpack().

◆ GetParContainerRequest()

std::vector< std::pair< std::string, std::shared_ptr< FairParGenericSet > > > * CbmRichUnpackAlgoBase::GetParContainerRequest ( std::string geoTag,
uint32_t runId )
virtual

Get the requested parameter containers. To be defined in the derived classes! Return the required parameter containers together with the paths to the ascii files to.

Parameters
[in]std::stringgeoTag as used in CbmSetup
[in]uint32_trunId for runwise defined parameters
Returns
fParContVec

Definition at line 23 of file CbmRichUnpackAlgoBase.cxx.

◆ getPixelUID()

Int_t CbmRichUnpackAlgoBase::getPixelUID ( Int_t fpgaID,
Int_t ch ) const
inlineprotected

Definition at line 258 of file CbmRichUnpackAlgoBase.h.

Referenced by CbmRichUnpackAlgo2022::writeOutputDigi(), and CbmRichUnpackAlgo::writeOutputDigi().

◆ init()

Bool_t CbmRichUnpackAlgoBase::init ( )
protected

Intialisation at begin of run. Special inits of the derived algos.

Return values
Bool_tinitOk

Definition at line 55 of file CbmRichUnpackAlgoBase.cxx.

◆ initParSet() [1/2]

Bool_t CbmRichUnpackAlgoBase::initParSet ( CbmMcbm2018RichPar * parset)
protected

Handles the distribution of the hidden derived classes to their explicit functions.

Parameters
parset
Returns
Bool_t initOk

Definition at line 70 of file CbmRichUnpackAlgoBase.cxx.

References fMonitor, and fUnpackPar.

◆ initParSet() [2/2]

Bool_t CbmRichUnpackAlgoBase::initParSet ( FairParGenericSet * parset)
protected

Handles the distribution of the hidden derived classes to their explicit functions.

Parameters
parset
Returns
Bool_t initOk

Definition at line 58 of file CbmRichUnpackAlgoBase.cxx.

References initParSet().

Referenced by initParSet().

◆ isLog()

bool CbmRichUnpackAlgoBase::isLog ( )
protected

Definition at line 84 of file CbmRichUnpackAlgoBase.cxx.

Referenced by CbmRichUnpackAlgo2022::processCtsSubSubEvent(), CbmRichUnpackAlgo::processCtsSubSubEvent(), CbmRichUnpackAlgo2022::processHubBlock(), CbmRichUnpackAlgo::processHubBlock(), CbmRichUnpackAlgo::processMbs(), CbmRichUnpackAlgo2022::processSubSubEvent(), CbmRichUnpackAlgo::processSubSubEvent(), CbmRichUnpackAlgo2022::processTimeDataWord(), CbmRichUnpackAlgo::processTimeDataWord(), CbmRichUnpackAlgo2022::processTrbPacket(), CbmRichUnpackAlgo::processTrbPacket(), CbmRichUnpackAlgo2022::unpack(), and CbmRichUnpackAlgo::unpack().

◆ operator=()

CbmRichUnpackAlgoBase & CbmRichUnpackAlgoBase::operator= ( const CbmRichUnpackAlgoBase & )
delete

Assignment operator - not implemented.

References CbmRichUnpackAlgoBase().

◆ setDerivedTsParameters()

bool CbmRichUnpackAlgoBase::setDerivedTsParameters ( size_t )
inlineprotected

Set the Derived Ts Parameters.

In this function parameters required by the explicit algo connected to the timeslice can be set.

Parameters
itimeslice
Returns
true
false

Definition at line 299 of file CbmRichUnpackAlgoBase.h.

◆ SetMaskedDiRICHes()

void CbmRichUnpackAlgoBase::SetMaskedDiRICHes ( std::vector< Int_t > * maskedDiRICHes)
inline

Set Addresses of DiRICH boards to be masked.

Parameters
maskedDiRICHesvector of Addresses

Definition at line 230 of file CbmRichUnpackAlgoBase.h.

References fMaskedDiRICHes.

◆ SetMonitor()

void CbmRichUnpackAlgoBase::SetMonitor ( std::shared_ptr< CbmRichUnpackMonitor > monitor)
inline

Set a predefined monitor.

Parameters
monitorpredefined unpacking monitor

Definition at line 227 of file CbmRichUnpackAlgoBase.h.

References fMonitor.

Member Data Documentation

◆ fbDoToTCorr

Bool_t CbmRichUnpackAlgoBase::fbDoToTCorr = true
protected

Definition at line 326 of file CbmRichUnpackAlgoBase.h.

Referenced by DoTotOffsetCorrection(), CbmRichUnpackAlgo2022::writeOutputDigi(), and CbmRichUnpackAlgo::writeOutputDigi().

◆ fMaskedDiRICHes

std::vector<Int_t>* CbmRichUnpackAlgoBase::fMaskedDiRICHes = nullptr
protected

Definition at line 319 of file CbmRichUnpackAlgoBase.h.

Referenced by checkMaskedDiRICH(), and SetMaskedDiRICHes().

◆ fMonitor

std::shared_ptr<CbmRichUnpackMonitor> CbmRichUnpackAlgoBase::fMonitor = nullptr
protected

Potential (online) monitor for the unpacking process.

Definition at line 251 of file CbmRichUnpackAlgoBase.h.

Referenced by finish(), initParSet(), SetMonitor(), and CbmRichUnpackAlgo2022::unpack().

◆ fMsRefTime

size_t CbmRichUnpackAlgoBase::fMsRefTime = 0
protected

Definition at line 321 of file CbmRichUnpackAlgoBase.h.

Referenced by CbmRichUnpackAlgo2022::unpack(), CbmRichUnpackAlgo::unpack(), CbmRichUnpackAlgo2022::writeOutputDigi(), and CbmRichUnpackAlgo::writeOutputDigi().

◆ fToTMax

double CbmRichUnpackAlgoBase::fToTMax = 100.
protected

Definition at line 324 of file CbmRichUnpackAlgoBase.h.

Referenced by CbmRichUnpackAlgo2022::processTimeDataWord(), and CbmRichUnpackAlgo::processTimeDataWord().

◆ fToTMin

double CbmRichUnpackAlgoBase::fToTMin = -20.
protected

Definition at line 323 of file CbmRichUnpackAlgoBase.h.

Referenced by CbmRichUnpackAlgo2022::processTimeDataWord(), and CbmRichUnpackAlgo::processTimeDataWord().

◆ fUnpackPar

CbmMcbm2018RichPar CbmRichUnpackAlgoBase::fUnpackPar
protected

Parameters for the unpacking.

Definition at line 317 of file CbmRichUnpackAlgoBase.h.

Referenced by initParSet(), CbmRichUnpackAlgo2022::processSubSubEvent(), CbmRichUnpackAlgo2022::writeOutputDigi(), and CbmRichUnpackAlgo::writeOutputDigi().

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