CbmRoot
Loading...
Searching...
No Matches
cbm::algo::qa::Data Class Reference

Class to handle QA-objects in the online reconstruction. More...

#include <QaData.h>

Collaboration diagram for cbm::algo::qa::Data:
[legend]

Public Member Functions

 Data (std::string_view name)
 Constructor.
 
 Data (const Data &)=default
 Copy constructor.
 
 Data (Data &&)=default
 Move constructor.
 
Dataoperator= (const Data &)=default
 Copy assignment operator.
 
Dataoperator= (Data &&)=default
 Move assignment operator.
 
 ~Data ()=default
 Destructor.
 
void AddCanvasConfig (const CanvasConfig &canvas)
 Adds a canvas to the canvas config list.
 
std::string_view GetName () const
 Gets module name.
 
void Init (std::shared_ptr< HistogramSender > histoSender)
 Sends QA initialization information to the HistogramSender.
 
template<class Obj , typename... Args>
Obj * MakeObj (Args... args)
 Creates a QA-object and returns the pointer to it.
 
void Reset ()
 Resets the histograms.
 
void Send (std::shared_ptr< HistogramSender > histoSender)
 Sends QA data to the HistogramSender.
 
void SetTimesliceId (uint64_t timesliceId)
 Updates the timeslice index.
 

Private Attributes

std::string fsName
 Name of the QA module (used as a directory name)
 
qa::HistogramContainer fHistograms
 Histograms container.
 
std::vector< std::string > fvsCanvCfgs = {}
 Vector of canvas configs.
 

Detailed Description

Class to handle QA-objects in the online reconstruction.

Definition at line 28 of file QaData.h.

Constructor & Destructor Documentation

◆ Data() [1/3]

cbm::algo::qa::Data::Data ( std::string_view name)
inline

Constructor.

Parameters
nameName of the QA module (appears as the directory name in the output)

Definition at line 32 of file QaData.h.

◆ Data() [2/3]

cbm::algo::qa::Data::Data ( const Data & )
default

Copy constructor.

◆ Data() [3/3]

cbm::algo::qa::Data::Data ( Data && )
default

Move constructor.

◆ ~Data()

cbm::algo::qa::Data::~Data ( )
default

Destructor.

Member Function Documentation

◆ AddCanvasConfig()

void cbm::algo::qa::Data::AddCanvasConfig ( const CanvasConfig & canvas)
inline

Adds a canvas to the canvas config list.

Parameters
canvasA CanvasConfig object

Definition at line 51 of file QaData.h.

References fvsCanvCfgs, and cbm::algo::qa::CanvasConfig::ToString().

Referenced by cbm::algo::ca::Qa::Init(), cbm::algo::sts::DigiQa::Init(), and cbm::algo::qa::RecoGeneralQa::operator()().

◆ GetName()

std::string_view cbm::algo::qa::Data::GetName ( ) const
inline

Gets module name.

Definition at line 54 of file QaData.h.

References fsName.

◆ Init()

void Data::Init ( std::shared_ptr< HistogramSender > histoSender)

◆ MakeObj()

template<class Obj , typename... Args>
Obj * cbm::algo::qa::Data::MakeObj ( Args... args)

◆ operator=() [1/2]

Data & cbm::algo::qa::Data::operator= ( const Data & )
default

Copy assignment operator.

◆ operator=() [2/2]

Data & cbm::algo::qa::Data::operator= ( Data && )
default

Move assignment operator.

◆ Reset()

void cbm::algo::qa::Data::Reset ( )
inline

Resets the histograms.

Definition at line 65 of file QaData.h.

References fHistograms, and cbm::algo::qa::HistogramContainer::Reset().

Referenced by Send().

◆ Send()

void Data::Send ( std::shared_ptr< HistogramSender > histoSender)

Sends QA data to the HistogramSender.

Parameters
histoSenderA pointer to the histogram sender
Note
Calls this->Reset() after sending the message to the histogram server

Definition at line 72 of file QaData.cxx.

References fHistograms, fsName, cbm::algo::qa::HistogramContainer::fvH1, cbm::algo::qa::HistogramContainer::fvH2, cbm::algo::qa::HistogramContainer::fvP1, cbm::algo::qa::HistogramContainer::fvP2, L_, and Reset().

Referenced by cbm::algo::ca::Qa::Exec(), cbm::algo::sts::DigiQa::Exec(), and cbm::algo::qa::RecoGeneralQa::operator()().

◆ SetTimesliceId()

void cbm::algo::qa::Data::SetTimesliceId ( uint64_t timesliceId)
inline

Updates the timeslice index.

Parameters
timesliceIdTimeslice index

Definition at line 74 of file QaData.h.

References fHistograms, and cbm::algo::qa::HistogramContainer::fTimesliceId.

Referenced by cbm::algo::sts::QaBase< Digi, AuxData, ReadoutSetup >::SetTimesliceIndex().

Member Data Documentation

◆ fHistograms

qa::HistogramContainer cbm::algo::qa::Data::fHistograms
private

Histograms container.

Definition at line 78 of file QaData.h.

Referenced by Init(), MakeObj(), Reset(), Send(), and SetTimesliceId().

◆ fsName

std::string cbm::algo::qa::Data::fsName
private

Name of the QA module (used as a directory name)

Definition at line 77 of file QaData.h.

Referenced by GetName(), Init(), and Send().

◆ fvsCanvCfgs

std::vector<std::string> cbm::algo::qa::Data::fvsCanvCfgs = {}
private

Vector of canvas configs.

Definition at line 79 of file QaData.h.

Referenced by AddCanvasConfig(), and Init().


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