#include <CbmQaTask.h>

Inheritance diagram for CbmQaTask:

Collaboration diagram for CbmQaTask:

Classes
struct	CheckFlags
	Contains a check result and its activeness status of the check-list entry. More...

struct	ObjectComparisonConfig
	Contains configuration to compare two root objects (histograms) More...

Public Types
enum class	EStoringMode { kSAMEDIR , kSUBDIR }

using	ObjList_t = std::vector<std::pair<TObject*, TString>>

Public Member Functions
	CbmQaTask (const char *name, int verbose, bool isMCUsed, ECbmRecoMode recoMode=ECbmRecoMode::Timeslice)
	Constructor from parameters.

	CbmQaTask ()=delete
	Default constructor.

virtual	~CbmQaTask ()=default
	Destructor.

	CbmQaTask (const CbmQaTask &)=delete
	Copy constructor.

	CbmQaTask (CbmQaTask &&)=delete
	Move constructor.

CbmQaTask &	operator= (const CbmQaTask &)=delete
	Copy assignment operator.

CbmQaTask &	operator= (CbmQaTask &&)=delete
	Move assignment operator.

virtual void	Check ()=0
	Function to check, if the QA results are acceptable.

bool	CompareQaObjects ()
	Process ROOT objects comparison.

void	DisableEventMode ()
	Disables event-by-event execution.

const std::map< std::string, CheckFlags > &	GetCheckList () const
	Gets check-list.

const TString &	GetDefaultTag () const
	Gets default tag.

const std::string &	GetSetupName () const
	Gets name of the setup.

const TString &	GetVersionTag () const
	Gets version tag.

bool	IsMCUsed () const
	Returns flag, whether MC information is used or not in the task.

void	ReadCheckListFromConfig ()
	Reads check-list from the configuration file.

void	SetCheckFile (const std::shared_ptr< TFile > &pCheckFile)
	Sets check-file.

void	SetCompareOutput (const std::shared_ptr< TFile > &pCompareOutput)
	Sets compare output file.

void	SetVersionTag (const TString &tag)
	Sets version tag.

void	SetDefaultTag (const TString &tag)
	Sets default tag.

void	SetRecoMode (ECbmRecoMode recoMode)
	Sets data processing (reconstruction) mode.

void	SetSetupName (const char *setup)
	Sets name of the setup.

const char *	GetConfigName () const
	Gets config name.

template<typename T , typename... Args>
T *	MakeQaObject (TString sName, TString sTitle, Args... args)

void	MakeQaDirectory (TString sName)

void	SetConfigName (const char *path)
	Creates a ROOT object.

void	SetRootFolderName (const TString &path)
	Sets a common root path to the objects in the output file.

void	SetStoringMode (EStoringMode mode)
	Set storing mode.

Protected Member Functions
virtual void	DeInit ()
	De-initialize the task.

void	Exec (Option_t *) override final
	FairTask: Defines action of the task in the event/TS.

void	Finish () override final
	FairTask: Defines action of the task in the end of run.

InitStatus	Init () override final
	FairTask: Task initialization in the beginning of the run.

InitStatus	ReInit () override final
	FairTask: Task reinitialization.

virtual InitStatus	InitQa ()
	Initializes the task.

virtual void	CreateSummary ()
	Initializes QA-task summary: canvases, tables etc.

virtual void	ExecQa ()
	Method to fill histograms per event or time-slice.

int	GetEventNumber () const
	Get current event number.

template<typename T >
bool	CheckRange (std::string_view name, T var, T lo, T hi) const
	Checks range of variable.

template<typename T >
bool	CheckRange (std::string_view name, T var, T varErr, T lo, T hi) const
	Checks range of variable.

bool	CheckRange (TH1 *h, double meanMax, double rmsMin, double rmsMax)
	Checks ranges for mean and standard deviation.

void	PutSetupNameOnPad (double xMin, double yMin, double xMax, double yMax)
	Puts setup title on the canvas.

CbmEvent *	GetCurrentEvent ()
	Gets pointer to current event.

void	StoreCheckResult (const std::string &tag, bool result, const std::string &msg="")
	Stores check flag to the check-list.

template<typename T >
void	CheckProperty (T &&property, const char *name) const
	Function to check, if a property is defined.

template<class Config >
std::optional< Config >	ReadSpecificConfig () const
	Reads the specific configuration structure from the YAML node.

virtual void	SetTH1Properties (TH1 *pHist) const
	Applies properties on the histogram created with the MakeQaObject function.

virtual void	SetTH2Properties (TH2 *pHist) const
	Applies properties on the histogram created with the MakeQaObject function.

virtual void	SetTProfile2DProperties (TProfile2D *pHist) const
	Applies properties on the profile 2D created with the MakeQaObject function.

virtual void	SetCanvasProperties (TCanvas *pCanv) const
	Applies properties on the canvas created with the MakeQaObject funciton.

void	WriteToFile (TFile *pOutFile) const
	Writes objects into file.

Protected Attributes
TString	fsRootFolderName = ""
	Name of root folder.

TString	fsConfigName = ""
	Name of configuration file.

TString	fsPrefix = ""
	Unique prefix for all writeable root.

EStoringMode	fStoringMode = EStoringMode::kSUBDIR
	Objects storing mode.

std::shared_ptr< ObjList_t >	fpvObjList = nullptr
	List of registered ROOT objects.

YAML::Node	fConfigNode {}
	Configuration node.

Private Member Functions
void	DeInitBase ()
	De-initializes this task.

template<class Obj >
bool	CompareTwoObjects (const TObject pObjL, const TObject pObjR, const TString &objName, const ObjectComparisonConfig &cfg)
	Process object comparison.

	ClassDefOverride (CbmQaTask, 0)

template<typename T , typename... Args>
T *	ConstructAndRegisterQaObject (TString name, Args... args)
	Creates and registers a ROOT object.

Private Attributes
bool	fbUseMC = false
	Flag, if MC is used.

ECbmRecoMode	fRecoMode = ECbmRecoMode::Timeslice
	Reconstruction mode.

std::map< std::string, CheckFlags >	fmCheckList
	A QA check-list map.

TClonesArray *	fpBrEvents = nullptr
	Pointer to CbmEvent branch.

CbmEvent *	fpCurrentEvent = nullptr
	Pointer to the current event.

std::string	fsSetupName = ""
	Name of the setup (to draw on the canvases)

TParameter< int >	fNofEvents {"nEvents", 0}
	Number of processed events.

TString	fsVersionTag = ""
	Version tag (git SHA etc.)

TString	fsDefaultTag = ""
	Default tag (git SHA etc.)

std::shared_ptr< TFile >	fpBenchmarkInput = nullptr
	A file with default ROOT objects used for the cross-check.

std::shared_ptr< TFile >	fpBenchmarkOutput = nullptr
	An output file for histograms cross-check.

Detailed Description

Class CbmQaTask is to be inherited with a particular QA-task. It provides mechanisms for storage and management of QA canvases and histograms management

Definition at line 46 of file CbmQaTask.h.

Member Typedef Documentation

◆ ObjList_t

using CbmQaIO::ObjList_t = std::vector<std::pair<TObject*, TString>>

inherited

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 46 of file CbmQaIO.h.

Member Enumeration Documentation

◆ EStoringMode

enum class CbmQaIO::EStoringMode

stronginherited

Enumerator
kSAMEDIR	Objects of different type will be stored to root directory.
kSUBDIR	Objects of different type will be stored in different subdirectories like histograms/ canvases/.

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 48 of file CbmQaIO.h.

Constructor & Destructor Documentation

◆ CbmQaTask() [1/4]

CbmQaTask::CbmQaTask	(	const char *	name,
		int	verbose,
		bool	isMCUsed,
		ECbmRecoMode	recoMode = ECbmRecoMode::Timeslice )

Constructor from parameters.

Parameters

name	Name of the task
verbose	Verbose level
isMCUsed	Flag: true - MC information is used, false - only reconstructed data QA is processed
recoMode	Reconstruction mode (see documentation for the CbmQaTask::SetRecoMode function)

Definition at line 32 of file CbmQaTask.cxx.

References CbmQaIO::fStoringMode, CbmQaIO::kSUBDIR, and CbmQaIO::SetRootFolderName().

◆ CbmQaTask() [2/4]

CbmQaTask::CbmQaTask ( )

delete

Default constructor.

◆ ~CbmQaTask()

virtual CbmQaTask::~CbmQaTask ( )

virtualdefault

Destructor.

◆ CbmQaTask() [3/4]

CbmQaTask::CbmQaTask ( const CbmQaTask & )

delete

Copy constructor.

◆ CbmQaTask() [4/4]

CbmQaTask::CbmQaTask ( CbmQaTask && )

delete

Move constructor.

Member Function Documentation

◆ Check()

virtual void CbmQaTask::Check ( )

pure virtual

Function to check, if the QA results are acceptable.

In the function one should provide the check flags with the function StoreCheckResult.

Implemented in cbm::ca::InputQaSetup, cbm::ca::OutputQa, CbmCaInputQaBase< DetID >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kMuch >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kMvd >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kSts >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kTof >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kTrd >, CbmCaInputQaMuch, CbmCaInputQaMvd, CbmCaInputQaSts, CbmCaInputQaTof, and CbmCaInputQaTrd.

◆ CheckProperty()

template<typename T >

void CbmQaIO::CheckProperty	(	T &&	property,
		const char *	name ) const

protectedinherited

Function to check, if a property is defined.

Parameters

property	A property to be tested
name	A name of property (used for logging)

Note: Throws an exception, if property is undefined

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 178 of file CbmQaIO.h.

Referenced by CbmQaIO::MakeQaObject().

◆ CheckRange() [1/3]

template<typename T >

bool CbmQaTask::CheckRange	(	std::string_view	name,
		T	var,
		T	lo,
		T	hi ) const

protected

Checks range of variable.

Parameters

name	Name of the variable
var	Variable to check
lo	Lower limit of the variable
hi	Upper limit of the variable

Returns: False, if variable exits the range

Definition at line 275 of file CbmQaTask.h.

References CheckRange().

Referenced by CheckRange(), and CheckRange().

◆ CheckRange() [2/3]

template<typename T >

bool CbmQaTask::CheckRange	(	std::string_view	name,
		T	var,
		T	varErr,
		T	lo,
		T	hi ) const

protected

Checks range of variable.

Parameters

name	Name of the variable
var	Variable to check
varErr	Standard Error of the variable
lo	Lower limit of the variable
hi	Upper limit of the variable

Returns: False, if variable exits the range

Definition at line 283 of file CbmQaTask.h.

◆ CheckRange() [3/3]

bool CbmQaTask::CheckRange	(	TH1 *	h,
		double	meanMax,
		double	rmsMin,
		double	rmsMax )

protected

Checks ranges for mean and standard deviation.

Returns: False, if variable exits the range

Definition at line 141 of file CbmQaTask.cxx.

References CheckRange().

◆ ClassDefOverride()

CbmQaTask::ClassDefOverride	(	CbmQaTask	,
		0	)

private

◆ CompareQaObjects()

bool CbmQaTask::CompareQaObjects ( )

Process ROOT objects comparison.

Returns: true All the object are consistent; false Some of the objects are inconsistent

Definition at line 162 of file CbmQaTask.cxx.

References CompareTwoObjects(), CbmQaTask::ObjectComparisonConfig::fCanvOpt, CbmQaTask::ObjectComparisonConfig::fChi2NdfMax, CbmQaIO::fConfigNode, fpBenchmarkInput, CbmQaTask::ObjectComparisonConfig::fPoint, CbmQaIO::fpvObjList, CbmQaTask::ObjectComparisonConfig::fRatio, CbmQaTask::ObjectComparisonConfig::fRatioMax, CbmQaTask::ObjectComparisonConfig::fRatioMin, CbmQaIO::fsRootFolderName, and CbmQaTask::ObjectComparisonConfig::fStat.

◆ CompareTwoObjects()

template<class Obj >

bool CbmQaTask::CompareTwoObjects	(	const TObject *	pObjL,
		const TObject *	pObjR,
		const TString &	objName,
		const ObjectComparisonConfig &	cfg )

private

Process object comparison.

Template Parameters

Obj	Class of the ROOT object

Parameters

pObjL	First object (this)
pObjR	Second object (default)
objName	Name of the object (contains full path to the object)
cfg	Comparison configuration entry

Returns: true Histograms are equal within selected method; false Histograms differ within one of the comparison methods

Definition at line 306 of file CbmQaTask.h.

References CbmQaTask::ObjectComparisonConfig::fCanvOpt, CbmQaTask::ObjectComparisonConfig::fChi2NdfMax, fpBenchmarkOutput, CbmQaTask::ObjectComparisonConfig::fPoint, CbmQaTask::ObjectComparisonConfig::fRatio, CbmQaTask::ObjectComparisonConfig::fRatioMax, CbmQaTask::ObjectComparisonConfig::fRatioMin, fsDefaultTag, CbmQaTask::ObjectComparisonConfig::fStat, CbmQaTask::ObjectComparisonConfig::fStatOpt, and fsVersionTag.

Referenced by CompareQaObjects().

◆ ConstructAndRegisterQaObject()

template<typename T , typename... Args>

T * CbmQaIO::ConstructAndRegisterQaObject	(	TString	name,
		Args...	args )

privateinherited

Creates and registers a ROOT object.

Parameters

name	A name of the ROOT object, which can contain a sub-directory
args	Other arguments, passed to the ROOT object constructor

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 198 of file CbmQaIO.h.

References CbmQaIO::fpvObjList, CbmQaIO::fsRootFolderName, CbmQaIO::fStoringMode, CbmQaIO::kSUBDIR, CbmQaIO::SetCanvasProperties(), CbmQaIO::SetTH1Properties(), CbmQaIO::SetTH2Properties(), and CbmQaIO::SetTProfile2DProperties().

Referenced by CbmQaIO::MakeQaObject().

◆ CreateSummary()

virtual void CbmQaTask::CreateSummary ( )

inlineprotectedvirtual

Initializes QA-task summary: canvases, tables etc.

Reimplemented in cbm::ca::InputQaSetup, cbm::ca::OutputQa, CbmCaInputQaBase< DetID >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kMuch >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kMvd >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kSts >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kTof >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kTrd >, CbmCaInputQaMuch, CbmCaInputQaMvd, CbmCaInputQaSts, CbmCaInputQaTof, and CbmCaInputQaTrd.

Definition at line 177 of file CbmQaTask.h.

Referenced by Finish().

◆ DeInit()

virtual void CbmQaTask::DeInit ( )

inlineprotectedvirtual

De-initialize the task.

Reimplemented in cbm::ca::OutputQa, CbmCaInputQaBase< DetID >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kMuch >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kMvd >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kSts >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kTof >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kTrd >, CbmCaInputQaMuch, CbmCaInputQaMvd, CbmCaInputQaSts, CbmCaInputQaTof, and CbmCaInputQaTrd.

Definition at line 159 of file CbmQaTask.h.

Referenced by DeInitBase().

◆ DeInitBase()

void CbmQaTask::DeInitBase ( )

private

De-initializes this task.

Definition at line 129 of file CbmQaTask.cxx.

References DeInit().

Referenced by Init().

◆ DisableEventMode()

void CbmQaTask::DisableEventMode ( )

Disables event-by-event execution.

By default, if the branch

◆ Exec()

void CbmQaTask::Exec ( Option_t * )

finaloverrideprotected

FairTask: Defines action of the task in the event/TS.

Definition at line 44 of file CbmQaTask.cxx.

References ExecQa(), fNofEvents, fpBrEvents, and fpCurrentEvent.

◆ ExecQa()

virtual void CbmQaTask::ExecQa ( )

inlineprotectedvirtual

Method to fill histograms per event or time-slice.

Reimplemented in cbm::ca::InputQaSetup, cbm::ca::OutputQa, CbmCaInputQaBase< DetID >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kMuch >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kMvd >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kSts >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kTof >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kTrd >, CbmCaInputQaMuch, CbmCaInputQaMvd, CbmCaInputQaSts, CbmCaInputQaTof, and CbmCaInputQaTrd.

Definition at line 180 of file CbmQaTask.h.

Referenced by Exec().

◆ Finish()

void CbmQaTask::Finish ( )

finaloverrideprotected

FairTask: Defines action of the task in the end of run.

Definition at line 64 of file CbmQaTask.cxx.

References CreateSummary(), fNofEvents, and CbmQaIO::WriteToFile().

◆ GetCheckList()

const std::map< std::string, CheckFlags > & CbmQaTask::GetCheckList ( ) const

inline

Gets check-list.

Definition at line 113 of file CbmQaTask.h.

References fmCheckList.

◆ GetConfigName()

const char * CbmQaIO::GetConfigName ( ) const

inlineinherited

Gets config name.

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 76 of file CbmQaIO.h.

References CbmQaIO::fsConfigName.

◆ GetCurrentEvent()

CbmEvent * CbmQaTask::GetCurrentEvent ( )

inlineprotected

Gets pointer to current event.

Definition at line 216 of file CbmQaTask.h.

References fpCurrentEvent.

Referenced by cbm::ca::OutputQa::ExecQa().

◆ GetDefaultTag()

const TString & CbmQaTask::GetDefaultTag ( ) const

inline

Gets default tag.

Definition at line 116 of file CbmQaTask.h.

References fsDefaultTag.

◆ GetEventNumber()

int CbmQaTask::GetEventNumber ( ) const

inlineprotected

Get current event number.

Definition at line 183 of file CbmQaTask.h.

References fNofEvents.

Referenced by cbm::ca::OutputQa::Check(), and cbm::ca::OutputQa::DrawEvent().

◆ GetSetupName()

const std::string & CbmQaTask::GetSetupName ( ) const

inline

Gets name of the setup.

Definition at line 119 of file CbmQaTask.h.

References fsSetupName.

◆ GetVersionTag()

const TString & CbmQaTask::GetVersionTag ( ) const

inline

Gets version tag.

Definition at line 122 of file CbmQaTask.h.

References fsVersionTag.

◆ Init()

InitStatus CbmQaTask::Init ( )

finaloverrideprotected

FairTask: Task initialization in the beginning of the run.

Definition at line 88 of file CbmQaTask.cxx.

References DeInitBase(), EventByEvent, fNofEvents, fpBrEvents, fRecoMode, InitQa(), and Timeslice.

Referenced by ReInit().

◆ InitQa()

virtual InitStatus CbmQaTask::InitQa ( )

inlineprotectedvirtual

Initializes the task.

Reimplemented in cbm::ca::InputQaSetup, cbm::ca::OutputQa, CbmCaInputQaBase< DetID >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kMuch >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kMvd >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kSts >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kTof >, CbmCaInputQaBase< cbm::algo::ca::EDetectorID::kTrd >, CbmCaInputQaMuch, CbmCaInputQaMvd, CbmCaInputQaSts, CbmCaInputQaTof, and CbmCaInputQaTrd.

Definition at line 174 of file CbmQaTask.h.

Referenced by Init().

◆ IsMCUsed()

bool CbmQaTask::IsMCUsed ( ) const

inline

Returns flag, whether MC information is used or not in the task.

Definition at line 126 of file CbmQaTask.h.

References fbUseMC.

Referenced by cbm::ca::OutputQa::Check(), CbmCaInputQaSts::Check(), cbm::ca::InputQaSetup::CheckInit(), cbm::ca::OutputQa::CreateSummary(), CbmCaInputQaSts::CreateSummary(), cbm::ca::OutputQa::DrawEvent(), cbm::ca::OutputQa::DrawSetOf(), cbm::ca::OutputQa::ExecQa(), CbmCaInputQaTof::ExecQa(), cbm::ca::InputQaSetup::FillHistogramsDet(), CbmCaInputQaSts::FillHistogramsPerHit(), cbm::ca::InputQaSetup::InitQa(), cbm::ca::OutputQa::InitQa(), and CbmCaInputQaSts::InitQa().

◆ MakeQaDirectory()

void CbmQaIO::MakeQaDirectory ( TString sName )

inherited

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 132 of file CbmQaIO.cxx.

References CbmQaIO::fpvObjList, and CbmQaIO::fsRootFolderName.

Referenced by cbm::ca::InputQaSetup::InitQa(), and CbmCaInputQaTof::InitQa().

◆ MakeQaObject()

template<typename T , typename... Args>

T * CbmQaIO::MakeQaObject	(	TString	sName,
		TString	sTitle,
		Args...	args )

inherited

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 261 of file CbmQaIO.h.

References CbmQaIO::CheckProperty(), CbmQaIO::ConstructAndRegisterQaObject(), and CbmQaIO::fConfigNode.

Referenced by cbm::ca::OutputQa::Check(), cbm::ca::TrackFitQa::CreatePullPlot(), cbm::ca::TrackFitQa::CreateResidualPlot(), cbm::ca::InputQaSetup::CreateSummary(), cbm::ca::OutputQa::CreateSummary(), CbmCaInputQaSts::CreateSummary(), cbm::ca::OutputQa::DrawEvent(), cbm::ca::TrackFitQa::Init(), cbm::ca::TrackTypeQa::Init(), cbm::ca::InputQaSetup::InitQa(), CbmCaInputQaSts::InitQa(), and CbmCaInputQaTof::InitQa().

◆ operator=() [1/2]

CbmQaTask & CbmQaTask::operator= ( CbmQaTask && )

delete

Move assignment operator.

◆ operator=() [2/2]

CbmQaTask & CbmQaTask::operator= ( const CbmQaTask & )

delete

Copy assignment operator.

◆ PutSetupNameOnPad()

void CbmQaTask::PutSetupNameOnPad	(	double	xMin,
		double	yMin,
		double	xMax,
		double	yMax )

protected

Puts setup title on the canvas.

Definition at line 248 of file CbmQaTask.cxx.

References fsSetupName.

Referenced by cbm::ca::InputQaSetup::CreateSummary().

◆ ReadCheckListFromConfig()

void CbmQaTask::ReadCheckListFromConfig ( )

Reads check-list from the configuration file.

Definition at line 263 of file CbmQaTask.cxx.

References CbmQaIO::fConfigNode, and fmCheckList.

◆ ReadSpecificConfig()

template<class Config >

std::optional< Config > CbmQaIO::ReadSpecificConfig ( ) const

inlineprotectedinherited

Reads the specific configuration structure from the YAML node.

Template Parameters

Config Type of the configuration class

The function is to be called in the user-defined class method InitDataBranches

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 127 of file CbmQaIO.h.

References CbmQaIO::fConfigNode, and cbm::algo::yaml::Read().

◆ ReInit()

InitStatus CbmQaTask::ReInit ( )

finaloverrideprotected

FairTask: Task reinitialization.

Definition at line 122 of file CbmQaTask.cxx.

References Init().

◆ SetCanvasProperties()

void CbmQaIO::SetCanvasProperties ( TCanvas * pCanv ) const

protectedvirtualinherited

Applies properties on the canvas created with the MakeQaObject funciton.

Parameters

pCanv Pointer to the canvas

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 84 of file CbmQaIO.cxx.

Referenced by CbmQaIO::ConstructAndRegisterQaObject().

◆ SetCheckFile()

void CbmQaTask::SetCheckFile ( const std::shared_ptr< TFile > & pCheckFile )

inline

Sets check-file.

Parameters

pCheckFile Shared pointer to the cross-check file

Definition at line 134 of file CbmQaTask.h.

References fpBenchmarkInput.

◆ SetCompareOutput()

void CbmQaTask::SetCompareOutput ( const std::shared_ptr< TFile > & pCompareOutput )

inline

Sets compare output file.

Parameters

pCompareOutput Shared pointer to the comparison output file

Definition at line 138 of file CbmQaTask.h.

References fpBenchmarkOutput.

◆ SetConfigName()

void CbmQaIO::SetConfigName ( const char * path )

inherited

Creates a ROOT object.

Sets config name

Parameters

name	A path to the config

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 95 of file CbmQaIO.cxx.

References CbmQaIO::fConfigNode, CbmQaIO::fsConfigName, and CbmQaIO::fsPrefix.

◆ SetDefaultTag()

void CbmQaTask::SetDefaultTag ( const TString & tag )

inline

Sets default tag.

Definition at line 144 of file CbmQaTask.h.

References fsDefaultTag.

◆ SetRecoMode()

void CbmQaTask::SetRecoMode ( ECbmRecoMode recoMode )

inline

Sets data processing (reconstruction) mode.

The reconstruction mode can be either ECbmRecoMode::Timeslice or ECbmRecoMode::EventByEvent. The first variant implies, that the data are processed within entire time-slice (in the event-by-event simulation within the entire event). For the second variant the data are processed within a loop of CbmEvent objects, if the branch of latter is accessible. By default the ECbmRecoMode::Timeslice is used.

Definition at line 152 of file CbmQaTask.h.

References fRecoMode.

◆ SetRootFolderName()

void CbmQaIO::SetRootFolderName ( const TString & path )

inlineinherited

Sets a common root path to the objects in the output file.

Parameters

path	A path to the object

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 109 of file CbmQaIO.h.

References CbmQaIO::fsRootFolderName.

Referenced by CbmQaTask().

◆ SetSetupName()

void CbmQaTask::SetSetupName ( const char * setup )

inline

Sets name of the setup.

Definition at line 155 of file CbmQaTask.h.

References fsSetupName.

◆ SetStoringMode()

void CbmQaIO::SetStoringMode ( EStoringMode mode )

inlineinherited

Set storing mode.

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 112 of file CbmQaIO.h.

References CbmQaIO::fStoringMode.

Referenced by CbmCaInputQaBase< DetID >::CbmCaInputQaBase().

◆ SetTH1Properties()

void CbmQaIO::SetTH1Properties ( TH1 * pHist ) const

protectedvirtualinherited

Applies properties on the histogram created with the MakeQaObject function.

Parameters

pHist Pointer to the histogram

Reimplemented in cbm::ca::TrackTypeQa.

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 36 of file CbmQaIO.cxx.

References cbm::qa::util::GetHistStats().

Referenced by CbmQaIO::ConstructAndRegisterQaObject().

◆ SetTH2Properties()

void CbmQaIO::SetTH2Properties ( TH2 * pHist ) const

protectedvirtualinherited

Applies properties on the histogram created with the MakeQaObject function.

Parameters

pHist Pointer to the histogram

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 50 of file CbmQaIO.cxx.

Referenced by CbmQaIO::ConstructAndRegisterQaObject().

◆ SetTProfile2DProperties()

void CbmQaIO::SetTProfile2DProperties ( TProfile2D * pHist ) const

protectedvirtualinherited

Applies properties on the profile 2D created with the MakeQaObject function.

Parameters

pHist Pointer to the profile

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 67 of file CbmQaIO.cxx.

Referenced by CbmQaIO::ConstructAndRegisterQaObject().

◆ SetVersionTag()

void CbmQaTask::SetVersionTag ( const TString & tag )

inline

Sets version tag.

Definition at line 141 of file CbmQaTask.h.

References fsVersionTag.

◆ StoreCheckResult()

void CbmQaTask::StoreCheckResult	(	const std::string &	tag,
		bool	result,
		const std::string &	msg = "" )

protected

Stores check flag to the check-list.

Parameters

tag	The flag name
result	Check result
msg	Supporting message (optional)

Definition at line 311 of file CbmQaTask.cxx.

References fmCheckList.

Referenced by CbmCaInputQaSts::Check().

◆ WriteToFile()

void CbmQaIO::WriteToFile ( TFile * pOutFile ) const

protectedinherited

Writes objects into file.

Parameters

pOutFile Pointer to output ROOT file

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 116 of file CbmQaIO.cxx.

References CbmQaIO::fpvObjList.

Referenced by Finish().

Member Data Documentation

◆ fbUseMC

bool CbmQaTask::fbUseMC = false

private

Flag, if MC is used.

Definition at line 240 of file CbmQaTask.h.

Referenced by IsMCUsed().

◆ fConfigNode

YAML::Node CbmQaIO::fConfigNode {}

protectedinherited

Configuration node.

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 164 of file CbmQaIO.h.

Referenced by CompareQaObjects(), CbmQaIO::MakeQaObject(), ReadCheckListFromConfig(), CbmQaIO::ReadSpecificConfig(), and CbmQaIO::SetConfigName().

◆ fmCheckList

std::map<std::string, CheckFlags> CbmQaTask::fmCheckList

private

A QA check-list map.

The check list is updated with new entries with the StoreCheckResult(tag, result) function, which is to be called from the Check() function. The result is stored to CheckFlags::fResult field, while the CheckFlags::fStatus stays uninitialized. Than, when the ReadCheckListFromConfig() function is called, the fStatus is updated according to the check list entries in the qa_tasks_config_mcbm.yaml/qa_tasks_config_cbm.yaml. If the fStatus is false (default), the check is ignored in the final verdict making.

Definition at line 251 of file CbmQaTask.h.

Referenced by GetCheckList(), ReadCheckListFromConfig(), and StoreCheckResult().

◆ fNofEvents

TParameter<int> CbmQaTask::fNofEvents {"nEvents", 0}

private

Number of processed events.

Definition at line 256 of file CbmQaTask.h.

Referenced by Exec(), Finish(), GetEventNumber(), and Init().

◆ fpBenchmarkInput

std::shared_ptr<TFile> CbmQaTask::fpBenchmarkInput = nullptr

private

A file with default ROOT objects used for the cross-check.

Definition at line 261 of file CbmQaTask.h.

Referenced by CompareQaObjects(), and SetCheckFile().

◆ fpBenchmarkOutput

std::shared_ptr<TFile> CbmQaTask::fpBenchmarkOutput = nullptr

private

An output file for histograms cross-check.

Definition at line 262 of file CbmQaTask.h.

Referenced by CompareTwoObjects(), and SetCompareOutput().

◆ fpBrEvents

TClonesArray* CbmQaTask::fpBrEvents = nullptr

private

Pointer to CbmEvent branch.

Definition at line 253 of file CbmQaTask.h.

Referenced by Exec(), and Init().

◆ fpCurrentEvent

CbmEvent* CbmQaTask::fpCurrentEvent = nullptr

private

Pointer to the current event.

Definition at line 254 of file CbmQaTask.h.

Referenced by Exec(), and GetCurrentEvent().

◆ fpvObjList

std::shared_ptr<ObjList_t> CbmQaIO::fpvObjList = nullptr

protectedinherited

List of registered ROOT objects.

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 162 of file CbmQaIO.h.

Referenced by CbmQaIO::CbmQaIO(), CompareQaObjects(), CbmQaIO::ConstructAndRegisterQaObject(), cbm::ca::TrackTypeQa::Init(), cbm::ca::OutputQa::InitQa(), CbmQaIO::MakeQaDirectory(), and CbmQaIO::WriteToFile().

◆ fRecoMode

ECbmRecoMode CbmQaTask::fRecoMode = ECbmRecoMode::Timeslice

private

Reconstruction mode.

Definition at line 242 of file CbmQaTask.h.

Referenced by Init(), and SetRecoMode().

◆ fsConfigName

TString CbmQaIO::fsConfigName = ""

protectedinherited

Name of configuration file.

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 158 of file CbmQaIO.h.

Referenced by CbmQaIO::GetConfigName(), and CbmQaIO::SetConfigName().

◆ fsDefaultTag

TString CbmQaTask::fsDefaultTag = ""

private

Default tag (git SHA etc.)

Definition at line 259 of file CbmQaTask.h.

Referenced by CompareTwoObjects(), GetDefaultTag(), and SetDefaultTag().

◆ fsPrefix

TString CbmQaIO::fsPrefix = ""

protectedinherited

Unique prefix for all writeable root.

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 159 of file CbmQaIO.h.

Referenced by CbmQaIO::CbmQaIO(), cbm::ca::TrackFitQa::CreatePullPlot(), cbm::ca::TrackTypeQa::Init(), cbm::ca::OutputQa::InitQa(), and CbmQaIO::SetConfigName().

◆ fsRootFolderName

TString CbmQaIO::fsRootFolderName = ""

protectedinherited

Name of root folder.

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 157 of file CbmQaIO.h.

Referenced by CompareQaObjects(), CbmQaIO::ConstructAndRegisterQaObject(), cbm::ca::TrackTypeQa::Init(), cbm::ca::OutputQa::InitQa(), CbmQaIO::MakeQaDirectory(), and CbmQaIO::SetRootFolderName().

◆ fsSetupName

std::string CbmQaTask::fsSetupName = ""

private

Name of the setup (to draw on the canvases)

Definition at line 255 of file CbmQaTask.h.

Referenced by GetSetupName(), PutSetupNameOnPad(), and SetSetupName().

◆ fStoringMode

EStoringMode CbmQaIO::fStoringMode = EStoringMode::kSUBDIR

protectedinherited

Objects storing mode.

Examples: /tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 161 of file CbmQaIO.h.

Referenced by CbmQaTask(), CbmQaIO::ConstructAndRegisterQaObject(), CbmQaIO::SetStoringMode(), cbm::ca::TrackFitQa::TrackFitQa(), and cbm::ca::TrackTypeQa::TrackTypeQa().

◆ fsVersionTag

TString CbmQaTask::fsVersionTag = ""

private

Version tag (git SHA etc.)

Definition at line 258 of file CbmQaTask.h.

Referenced by CompareTwoObjects(), GetVersionTag(), and SetVersionTag().

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ObjList_t

Member Enumeration Documentation

◆ EStoringMode

Constructor & Destructor Documentation

◆ CbmQaTask() [1/4]

◆ CbmQaTask() [2/4]

◆ ~CbmQaTask()

◆ CbmQaTask() [3/4]

◆ CbmQaTask() [4/4]

Member Function Documentation

◆ Check()

◆ CheckProperty()

◆ CheckRange() [1/3]

◆ CheckRange() [2/3]

◆ CheckRange() [3/3]

◆ ClassDefOverride()

◆ CompareQaObjects()

◆ CompareTwoObjects()

◆ ConstructAndRegisterQaObject()

◆ CreateSummary()

◆ DeInit()

◆ DeInitBase()

◆ DisableEventMode()

◆ Exec()

◆ ExecQa()

◆ Finish()

◆ GetCheckList()

◆ GetConfigName()

◆ GetCurrentEvent()

◆ GetDefaultTag()

◆ GetEventNumber()

◆ GetSetupName()

◆ GetVersionTag()

◆ Init()

◆ InitQa()

◆ IsMCUsed()

◆ MakeQaDirectory()

◆ MakeQaObject()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ PutSetupNameOnPad()

◆ ReadCheckListFromConfig()

◆ ReadSpecificConfig()

◆ ReInit()

◆ SetCanvasProperties()

◆ SetCheckFile()

◆ SetCompareOutput()

◆ SetConfigName()

◆ SetDefaultTag()

◆ SetRecoMode()

◆ SetRootFolderName()

◆ SetSetupName()

◆ SetStoringMode()

◆ SetTH1Properties()

◆ SetTH2Properties()

◆ SetTProfile2DProperties()

◆ SetVersionTag()

◆ StoreCheckResult()

◆ WriteToFile()

Member Data Documentation

◆ fbUseMC

◆ fConfigNode

◆ fmCheckList

◆ fNofEvents

◆ fpBenchmarkInput

◆ fpBenchmarkOutput

◆ fpBrEvents

◆ fpCurrentEvent

◆ fpvObjList

◆ fRecoMode

◆ fsConfigName