CbmRoot
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup > Class Template Reference

QA module for STS raw digis. More...

#include <QaBase.h>

Inheritance diagram for cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >:
[legend]
Collaboration diagram for cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >:
[legend]

Public Member Functions

 QaBase (std::shared_ptr< HistogramSender > pSender, const std::string &dirname)
 Constructor.
 
 QaBase ()=delete
 Default constructor.
 
 QaBase (const QaBase &)=delete
 Copy constructor.
 
 QaBase (QaBase &&)=delete
 Move constructor.
 
QaBase & operator= (const QaBase &)=delete
 Copy assignment operator.
 
QaBase & operator= (QaBase &&)=delete
 Move assignment operator.
 
bool IsSenderDefined () const
 Checks, if the histogram sender is defined.
 
void RegisterDigiData (const PODVector< Digi > *pvDigis)
 Register digi-qa data.
 
void RegisterAuxDigiData (const AuxData *pAuxDigis)
 Register auxiliary digi data.
 
void RegisterReadoutSetup (const ReadoutSetup &setup)
 Register read-out setup config.
 
void SetUseAuxData (bool bAux=true)
 Sets usage of auxiliary data.
 
void SetTimesliceIndex (uint64_t tsIndex)
 Sets timeslice index.
 

Protected Attributes

qa::Data fQaData
 QA data.
 
std::shared_ptr< HistogramSender > fpSender = nullptr
 Histogram sender.
 
std::shared_ptr< ReadoutSetup > fpReadoutSetup = nullptr
 Readout config instance.
 
const PODVector< Digi > * fpvDigis = nullptr
 Digis input.
 
const AuxData * fpAuxDigis = nullptr
 Aux information on digis.
 
bool fbAux = false
 Extra distributions (if the auxiliary data should be used)
 

Detailed Description

template<class Digi, class AuxData, class ReadoutSetup>
class cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >

QA module for STS raw digis.

Template Parameters
DigiA digi class for a given detector subsystem
ReadoutSetupA read-out config for a given detector subsystem
AuxDataAuxilary information on digis, stored for each micro timeslice

Definition at line 26 of file QaBase.h.

Constructor & Destructor Documentation

◆ QaBase() [1/4]

template<class Digi, class AuxData, class ReadoutSetup>
cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >::QaBase ( std::shared_ptr< HistogramSender > pSender,
const std::string & dirname )
inline

Constructor.

Parameters
pSenderPointer to histogram sender
dirname

Definition at line 31 of file QaBase.h.

◆ QaBase() [2/4]

template<class Digi, class AuxData, class ReadoutSetup>
cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >::QaBase ( )
delete

Default constructor.

◆ QaBase() [3/4]

template<class Digi, class AuxData, class ReadoutSetup>
cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >::QaBase ( const QaBase< Digi, AuxData, ReadoutSetup > & )
delete

Copy constructor.

◆ QaBase() [4/4]

template<class Digi, class AuxData, class ReadoutSetup>
cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >::QaBase ( QaBase< Digi, AuxData, ReadoutSetup > && )
delete

Move constructor.

Member Function Documentation

◆ IsSenderDefined()

template<class Digi, class AuxData, class ReadoutSetup>
bool cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >::IsSenderDefined ( ) const
inline

Checks, if the histogram sender is defined.

Definition at line 51 of file QaBase.h.

◆ operator=() [1/2]

template<class Digi, class AuxData, class ReadoutSetup>
QaBase & cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >::operator= ( const QaBase< Digi, AuxData, ReadoutSetup > & )
delete

Copy assignment operator.

◆ operator=() [2/2]

template<class Digi, class AuxData, class ReadoutSetup>
QaBase & cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >::operator= ( QaBase< Digi, AuxData, ReadoutSetup > && )
delete

Move assignment operator.

◆ RegisterAuxDigiData()

template<class Digi, class AuxData, class ReadoutSetup>
void cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >::RegisterAuxDigiData ( const AuxData * pAuxDigis)
inline

Register auxiliary digi data.

Definition at line 57 of file QaBase.h.

◆ RegisterDigiData()

template<class Digi, class AuxData, class ReadoutSetup>
void cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >::RegisterDigiData ( const PODVector< Digi > * pvDigis)
inline

Register digi-qa data.

Definition at line 54 of file QaBase.h.

◆ RegisterReadoutSetup()

template<class Digi, class AuxData, class ReadoutSetup>
void cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >::RegisterReadoutSetup ( const ReadoutSetup & setup)
inline

Register read-out setup config.

Definition at line 68 of file QaBase.h.

◆ SetTimesliceIndex()

template<class Digi, class AuxData, class ReadoutSetup>
void cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >::SetTimesliceIndex ( uint64_t tsIndex)
inline

Sets timeslice index.

Definition at line 74 of file QaBase.h.

◆ SetUseAuxData()

template<class Digi, class AuxData, class ReadoutSetup>
void cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >::SetUseAuxData ( bool bAux = true)
inline

Sets usage of auxiliary data.

Definition at line 71 of file QaBase.h.

Member Data Documentation

◆ fbAux

template<class Digi, class AuxData, class ReadoutSetup>
bool cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >::fbAux = false
protected

Extra distributions (if the auxiliary data should be used)

Definition at line 82 of file QaBase.h.

◆ fpAuxDigis

template<class Digi, class AuxData, class ReadoutSetup>
const AuxData* cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >::fpAuxDigis = nullptr
protected

Aux information on digis.

Definition at line 81 of file QaBase.h.

◆ fpReadoutSetup

template<class Digi, class AuxData, class ReadoutSetup>
std::shared_ptr<ReadoutSetup> cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >::fpReadoutSetup = nullptr
protected

Readout config instance.

Definition at line 79 of file QaBase.h.

◆ fpSender

template<class Digi, class AuxData, class ReadoutSetup>
std::shared_ptr<HistogramSender> cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >::fpSender = nullptr
protected

Histogram sender.

Definition at line 78 of file QaBase.h.

◆ fpvDigis

template<class Digi, class AuxData, class ReadoutSetup>
const PODVector<Digi>* cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >::fpvDigis = nullptr
protected

Digis input.

Definition at line 80 of file QaBase.h.

◆ fQaData

template<class Digi, class AuxData, class ReadoutSetup>
qa::Data cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >::fQaData
protected

QA data.

Definition at line 77 of file QaBase.h.

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