CbmRoot
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
CbmRichRingRecoQa Class Reference

QA-task for RICH ring reconstruction. More...

#include <CbmRichRingRecoQa.h>

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

Public Types

enum class  EStoringMode { kSAMEDIR , kSUBDIR }
 
using ObjList_t = std::vector<std::pair<TObject*, TString>>
 

Public Member Functions

 CbmRichRingRecoQa (int verbose, bool isMcUsed)
 
InitStatus InitQa () override
 Initializes the task.
 
void ExecQa () override
 Method to fill histograms per event or time-slice.
 
void Check () override
 Function to check, if the QA results are acceptable.
 
void CreateSummary () override
 Initializes QA-task summary: canvases, tables etc.
 
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.
 
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 Types

enum  ERecoRingType {
  Reco = -1 , TrueReco = 0 , PrimEl = 1 , SecEl = 2 ,
  Pion = 3 , Other = 4 , Fake = 5 , Clone = 6
}
 
enum  ERingFeature {
  Radius = 0 , NHits = 1 , CenterX = 2 , CenterY = 3 ,
  Aaxis = 4 , Baxis = 5 , BoA = 6 , Phi = 7 ,
  Chi2oNDF = 8 , Angle = 9 , RadialPosition = 10 , RadialAngle = 11
}
 

Private Member Functions

void InitHistograms ()
 
void FillHistsTrueRecoRing (const CbmRichRing *ring, const CbmMCTrack *mcTrack)
 
void FillHistsFakeRing (const CbmRichRing *ring)
 
void FillHistsRingFeatures (const CbmRichRing *ring, const CbmMCTrack *mcTrack, const ERecoRingType ringType)
 
bool IsMcPrimaryElectron (const CbmMCTrack *mcTrack)
 
bool IsMcSecondaryElectron (const CbmMCTrack *mcTrack)
 
bool IsMcPion (const CbmMCTrack *mcTrack)
 
 ClassDefOverride (CbmRichRingRecoQa, 1)
 
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.
 
template<typename T, typename... Args>
T * ConstructAndRegisterQaObject (TString name, Args... args)
 Creates and registers a ROOT object.
 

Private Attributes

CbmDigiManager * fDigiManager {nullptr}
 
TClonesArray * fCbmEvents {nullptr}
 
TClonesArray * fRichHits {nullptr}
 
TClonesArray * fRichRings {nullptr}
 
TClonesArray * fRichProjections {nullptr}
 
CbmMCDataArray * fMcTracks {nullptr}
 
CbmMCDataArray * fRichPoints {nullptr}
 
TClonesArray * fRichRingMatches {nullptr}
 
TH1D * fhRichRingsPerEvent {nullptr}
 
TH1D * fhRingTimeInEvent {nullptr}
 
TH1D * fhRingHitsTime {nullptr}
 
TH2D * fhRingCenterXY {nullptr}
 
std::array< TH1D *, 12 > fhRingFeatures {}
 
TH1D * fhRingTypeCounts {nullptr}
 
TProfile2D * fhRingRecoPurityXY {nullptr}
 
std::array< TProfile *, 5 > fhRingRecoEff {}
 
std::array< std::array< TH1D *, 12 >, 6 > fhRingTypeFeatures {}
 
std::array< std::array< TH2D *, 12 >, 5 > fhRingTypeFeaturesMomentum {}
 
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.
 

Static Private Attributes

static constexpr int fAccRingMinNumHits {7}
 
static constexpr double fQuotaRich {0.7}
 
static constexpr std::array< double, 4 > fRingRecoEffsMin
 
static constexpr double fRingPurityMin {0.7}
 

Detailed Description

QA-task for RICH ring reconstruction.

Checks:

  • Ring multiplicity in event
  • Ring times in event
  • Hit times in ring
  • Ring position occupancy in camera
  • Ring features (radius, number of hits, Chi2 / NDF, etc.)

Checks with Monte-Carlo [MC]:

  • Ring reconstruction purity in camera
  • Ring reconstruction efficiency for various particle types
  • Fake & clone ring rates
  • Multiplicity of rings for various particle types, fake & clone rings
  • Ring features for various particle types, fake & clone rings
  • Ring features vs MC momentum for various particle types

Definition at line 41 of file CbmRichRingRecoQa.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 45 of file CbmQaIO.h.

Member Enumeration Documentation

◆ ERecoRingType

enum CbmRichRingRecoQa::ERecoRingType
private
Enumerator
Reco 
TrueReco 
PrimEl 
SecEl 
Pion 
Other 
Fake 
Clone 

Definition at line 54 of file CbmRichRingRecoQa.h.

◆ ERingFeature

enum CbmRichRingRecoQa::ERingFeature
private
Enumerator
Radius 
NHits 
CenterX 
CenterY 
Aaxis 
Baxis 
BoA 
Phi 
Chi2oNDF 
Angle 
RadialPosition 
RadialAngle 

Definition at line 66 of file CbmRichRingRecoQa.h.

◆ 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 47 of file CbmQaIO.h.

Constructor & Destructor Documentation

◆ CbmRichRingRecoQa()

CbmRichRingRecoQa::CbmRichRingRecoQa ( int verbose,
bool isMcUsed )
inline

Definition at line 43 of file CbmRichRingRecoQa.h.

References CbmQaTask::CbmQaTask().

Referenced by ClassDefOverride().

Member Function Documentation

◆ Check()

void CbmRichRingRecoQa::Check ( )
overridevirtual

Function to check, if the QA results are acceptable.

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

Implements CbmQaTask.

Definition at line 434 of file CbmRichRingRecoQa.cxx.

References Clone, Fake, fhRingRecoEff, fhRingTypeCounts, fRingPurityMin, fRingRecoEffsMin, CbmQaTask::IsMCUsed(), CbmQaIO::MakeQaObject(), Other, Pion, PrimEl, Reco, SecEl, CbmQaTask::StoreCheckResult(), and TrueReco.

◆ CheckProperty()

template<typename T>
void CbmQaIO::CheckProperty ( T && property,
const char * name ) const
protectedinherited

Function to check, if a property is defined.

Parameters
propertyA property to be tested
nameA 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 177 of file CbmQaIO.h.

Referenced by MakeQaObject().

◆ CheckRange() [1/3]

template<typename T>
bool CbmQaTask::CheckRange ( std::string_view name,
T var,
T lo,
T hi ) const
protectedinherited

Checks range of variable.

Parameters
nameName of the variable
varVariable to check
loLower limit of the variable
hiUpper 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
protectedinherited

Checks range of variable.

Parameters
nameName of the variable
varVariable to check
varErrStandard Error of the variable
loLower limit of the variable
hiUpper 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 )
protectedinherited

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()

CbmRichRingRecoQa::ClassDefOverride ( CbmRichRingRecoQa ,
1  )
private

References CbmRichRingRecoQa().

◆ CompareQaObjects()

bool CbmQaTask::CompareQaObjects ( )
inherited

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 CbmQaIO::fConfigNode.

◆ CompareTwoObjects()

template<class Obj>
bool CbmQaTask::CompareTwoObjects ( const TObject * pObjL,
const TObject * pObjR,
const TString & objName,
const ObjectComparisonConfig & cfg )
privateinherited

Process object comparison.

Template Parameters
ObjClass of the ROOT object
Parameters
pObjLFirst object (this)
pObjRSecond object (default)
objNameName of the object (contains full path to the object)
cfgComparison 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.

◆ ConstructAndRegisterQaObject()

template<typename T, typename... Args>
T * CbmQaIO::ConstructAndRegisterQaObject ( TString name,
Args... args )
privateinherited

Creates and registers a ROOT object.

Parameters
nameA name of the ROOT object, which can contain a sub-directory
argsOther arguments, passed to the ROOT object constructor
Examples
/tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 197 of file CbmQaIO.h.

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

Referenced by MakeQaObject().

◆ CreateSummary()

void CbmRichRingRecoQa::CreateSummary ( )
inlineoverridevirtual

Initializes QA-task summary: canvases, tables etc.

Reimplemented from CbmQaTask.

Definition at line 51 of file CbmRichRingRecoQa.h.

◆ DeInit()

virtual void CbmQaTask::DeInit ( )
inlineprotectedvirtualinherited

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, CbmCaInputQaTrd, and OutputQa.

Definition at line 159 of file CbmQaTask.h.

Referenced by DeInitBase().

◆ DeInitBase()

void CbmQaTask::DeInitBase ( )
privateinherited

De-initializes this task.

Definition at line 129 of file CbmQaTask.cxx.

References DeInit().

Referenced by Init().

◆ DisableEventMode()

void CbmQaTask::DisableEventMode ( )
inherited

Disables event-by-event execution.

By default, if the branch

◆ Exec()

void CbmQaTask::Exec ( Option_t * )
finaloverrideprotectedinherited

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()

void CbmRichRingRecoQa::ExecQa ( )
overridevirtual

Method to fill histograms per event or time-slice.

Reimplemented from CbmQaTask.

Definition at line 277 of file CbmRichRingRecoQa.cxx.

References Aaxis, Baxis, BoA, CenterX, CenterY, Chi2oNDF, Clone, fAccRingMinNumHits, fDigiManager, fhRichRingsPerEvent, fhRingCenterXY, fhRingFeatures, fhRingHitsTime, fhRingRecoEff, fhRingTimeInEvent, fhRingTypeCounts, FillHistsFakeRing(), FillHistsTrueRecoRing(), fMcTracks, fQuotaRich, fRichHits, fRichPoints, fRichRingMatches, fRichRings, CbmQaTask::GetCurrentEvent(), CbmMatchRecoToMC::GetMcTrackMotherIdsForRichHit(), IsMcPion(), IsMcPrimaryElectron(), IsMcSecondaryElectron(), CbmQaTask::IsMCUsed(), kRichHit, kRichRing, NHits, Other, Phi, Pion, PrimEl, RadialAngle, RadialPosition, Radius, SecEl, and TrueReco.

◆ FillHistsFakeRing()

void CbmRichRingRecoQa::FillHistsFakeRing ( const CbmRichRing * ring)
private

Definition at line 529 of file CbmRichRingRecoQa.cxx.

References Fake, fhRingTypeCounts, and FillHistsRingFeatures().

Referenced by ExecQa().

◆ FillHistsRingFeatures()

void CbmRichRingRecoQa::FillHistsRingFeatures ( const CbmRichRing * ring,
const CbmMCTrack * mcTrack,
const ERecoRingType ringType )
private

Definition at line 535 of file CbmRichRingRecoQa.cxx.

References Aaxis, Baxis, BoA, CenterX, CenterY, Chi2oNDF, Fake, fhRingRecoPurityXY, fhRingTypeFeatures, fhRingTypeFeaturesMomentum, CbmRichRing::GetAaxis(), CbmRichRing::GetBaxis(), CbmRichRing::GetCenterX(), CbmRichRing::GetCenterY(), CbmRichRing::GetChi2(), CbmRichRing::GetNDF(), CbmRichRing::GetNofHits(), CbmMCTrack::GetP(), CbmRichRing::GetPhi(), CbmRichRing::GetRadialAngle(), CbmRichRing::GetRadialPosition(), CbmRichRing::GetRadius(), NHits, Phi, RadialAngle, RadialPosition, and Radius.

Referenced by FillHistsFakeRing(), and FillHistsTrueRecoRing().

◆ FillHistsTrueRecoRing()

void CbmRichRingRecoQa::FillHistsTrueRecoRing ( const CbmRichRing * ring,
const CbmMCTrack * mcTrack )
private

Definition at line 506 of file CbmRichRingRecoQa.cxx.

References fhRingTypeCounts, FillHistsRingFeatures(), IsMcPion(), IsMcPrimaryElectron(), IsMcSecondaryElectron(), Other, Pion, PrimEl, SecEl, and TrueReco.

Referenced by ExecQa().

◆ Finish()

void CbmQaTask::Finish ( )
finaloverrideprotectedinherited

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
inlineinherited

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 75 of file CbmQaIO.h.

References fsConfigName.

◆ GetCurrentEvent()

CbmEvent * CbmQaTask::GetCurrentEvent ( )
inlineprotectedinherited

Gets pointer to current event.

Definition at line 216 of file CbmQaTask.h.

References fpCurrentEvent.

Referenced by cbm::ca::OutputQa::ExecQa(), and CbmRichRingRecoQa::ExecQa().

◆ GetDefaultTag()

const TString & CbmQaTask::GetDefaultTag ( ) const
inlineinherited

Gets default tag.

Definition at line 116 of file CbmQaTask.h.

References fsDefaultTag.

◆ GetEventNumber()

int CbmQaTask::GetEventNumber ( ) const
inlineprotectedinherited

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
inlineinherited

Gets name of the setup.

Definition at line 119 of file CbmQaTask.h.

References fsSetupName.

◆ GetVersionTag()

const TString & CbmQaTask::GetVersionTag ( ) const
inlineinherited

Gets version tag.

Definition at line 122 of file CbmQaTask.h.

References fsVersionTag.

◆ Init()

InitStatus CbmQaTask::Init ( )
finaloverrideprotectedinherited

FairTask: Task initialization in the beginning of the run.

Definition at line 88 of file CbmQaTask.cxx.

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

Referenced by ReInit().

◆ InitHistograms()

void CbmRichRingRecoQa::InitHistograms ( )
private

Definition at line 78 of file CbmRichRingRecoQa.cxx.

References Aaxis, Baxis, BoA, CenterX, CenterY, Chi2oNDF, Fake, fhRichRingsPerEvent, fhRingCenterXY, fhRingFeatures, fhRingHitsTime, fhRingRecoEff, fhRingRecoPurityXY, fhRingTimeInEvent, fhRingTypeCounts, fhRingTypeFeatures, fhRingTypeFeaturesMomentum, CbmQaTask::IsMCUsed(), CbmQaIO::MakeQaObject(), NHits, Other, Phi, RadialAngle, RadialPosition, Radius, and TrueReco.

Referenced by InitQa().

◆ InitQa()

InitStatus CbmRichRingRecoQa::InitQa ( )
overridevirtual

Initializes the task.

Reimplemented from CbmQaTask.

Definition at line 35 of file CbmRichRingRecoQa.cxx.

References fCbmEvents, fDigiManager, fMcTracks, fRichHits, fRichPoints, fRichProjections, fRichRingMatches, fRichRings, InitHistograms(), CbmDigiManager::Instance(), CbmQaTask::IsMCUsed(), and kRich.

◆ IsMcPion()

bool CbmRichRingRecoQa::IsMcPion ( const CbmMCTrack * mcTrack)
private

Definition at line 587 of file CbmRichRingRecoQa.cxx.

References CbmMCTrack::GetPdgCode().

Referenced by ExecQa(), and FillHistsTrueRecoRing().

◆ IsMcPrimaryElectron()

bool CbmRichRingRecoQa::IsMcPrimaryElectron ( const CbmMCTrack * mcTrack)
private

Definition at line 574 of file CbmRichRingRecoQa.cxx.

References CbmMCTrack::GetGeantProcessId(), CbmMCTrack::GetMotherId(), and CbmMCTrack::GetPdgCode().

Referenced by ExecQa(), FillHistsTrueRecoRing(), and IsMcSecondaryElectron().

◆ IsMcSecondaryElectron()

bool CbmRichRingRecoQa::IsMcSecondaryElectron ( const CbmMCTrack * mcTrack)
private

Definition at line 581 of file CbmRichRingRecoQa.cxx.

References CbmMCTrack::GetPdgCode(), and IsMcPrimaryElectron().

Referenced by ExecQa(), and FillHistsTrueRecoRing().

◆ IsMCUsed()

bool CbmQaTask::IsMCUsed ( ) const
inlineinherited

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(), cbm::mvd::CbmMvdMcQaTask::Check(), CbmCaInputQaBase< DetID >::Check(), CbmRichRingRecoQa::Check(), cbm::ca::InputQaSetup::CheckInit(), cbm::ca::OutputQa::CreateFitQaPointSet(), cbm::ca::OutputQa::CreateSummary(), CbmCaInputQaBase< DetID >::CreateSummary(), cbm::ca::OutputQa::DrawEvent(), cbm::ca::OutputQa::DrawSetOf(), cbm::ca::OutputQa::ExecQa(), cbm::mvd::CbmMvdMcQaTask::ExecQa(), CbmCaInputQaBase< DetID >::ExecQa(), CbmRichRingRecoQa::ExecQa(), cbm::ca::InputQaSetup::FillHistogramsDet(), CbmRichRingRecoQa::InitHistograms(), cbm::ca::InputQaSetup::InitQa(), cbm::ca::OutputQa::InitQa(), cbm::mvd::CbmMvdMcQaTask::InitQa(), CbmCaInputQaBase< DetID >::InitQa(), and CbmRichRingRecoQa::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 fsRootFolderName.

Referenced by cbm::ca::InputQaSetup::InitQa(), and CbmCaInputQaBase< DetID >::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 260 of file CbmQaIO.h.

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

Referenced by cbm::mvd::CbmMvdMcQaTask::BookHists_(), cbm::ca::OutputQa::Check(), CbmRichRingRecoQa::Check(), cbm::ca::TrackFitQa::CreatePullPlot(), cbm::ca::TrackFitQa::CreateResidualPlot(), cbm::ca::InputQaSetup::CreateSummary(), cbm::ca::OutputQa::CreateSummary(), CbmCaInputQaBase< DetID >::CreateSummary(), cbm::ca::OutputQa::DrawEvent(), cbm::ca::TrackFitQa::Init(), cbm::ca::TrackTypeQa::Init(), cbm::kfp::V0FinderQa::InitHistograms(), CbmRichRingRecoQa::InitHistograms(), cbm::ca::InputQaSetup::InitQa(), and CbmCaInputQaBase< DetID >::InitQa().

◆ PutSetupNameOnPad()

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

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 ( )
inherited

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
ConfigType 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 126 of file CbmQaIO.h.

References fConfigNode, and cbm::util::yaml::Read().

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

◆ ReInit()

InitStatus CbmQaTask::ReInit ( )
finaloverrideprotectedinherited

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
pCanvPointer to the canvas
Examples
/tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 84 of file CbmQaIO.cxx.

Referenced by ConstructAndRegisterQaObject().

◆ SetCheckFile()

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

Sets check-file.

Parameters
pCheckFileShared 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)
inlineinherited

Sets compare output file.

Parameters
pCompareOutputShared 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
nameA path to the config
Examples
/tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 95 of file CbmQaIO.cxx.

References fsConfigName.

◆ SetDefaultTag()

void CbmQaTask::SetDefaultTag ( const TString & tag)
inlineinherited

Sets default tag.

Definition at line 144 of file CbmQaTask.h.

References fsDefaultTag.

◆ SetRecoMode()

void CbmQaTask::SetRecoMode ( ECbmRecoMode recoMode)
inlineinherited

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
pathA path to the object
Examples
/tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 108 of file CbmQaIO.h.

References fsRootFolderName.

Referenced by CbmQaTask::CbmQaTask().

◆ SetSetupName()

void CbmQaTask::SetSetupName ( const char * setup)
inlineinherited

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 111 of file CbmQaIO.h.

References 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
pHistPointer to the histogram

Reimplemented in cbm::ca::TrackTypeQa, and 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 ConstructAndRegisterQaObject().

◆ SetTH2Properties()

void CbmQaIO::SetTH2Properties ( TH2 * pHist) const
protectedvirtualinherited

Applies properties on the histogram created with the MakeQaObject function.

Parameters
pHistPointer to the histogram
Examples
/tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 50 of file CbmQaIO.cxx.

Referenced by ConstructAndRegisterQaObject().

◆ SetTProfile2DProperties()

void CbmQaIO::SetTProfile2DProperties ( TProfile2D * pHist) const
protectedvirtualinherited

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

Parameters
pHistPointer to the profile
Examples
/tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 67 of file CbmQaIO.cxx.

Referenced by ConstructAndRegisterQaObject().

◆ SetVersionTag()

void CbmQaTask::SetVersionTag ( const TString & tag)
inlineinherited

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 = "" )
protectedinherited

Stores check flag to the check-list.

Parameters
tagThe flag name
resultCheck result
msgSupporting message (optional)

Definition at line 311 of file CbmQaTask.cxx.

References fmCheckList.

Referenced by CbmRichRingRecoQa::Check().

◆ WriteToFile()

void CbmQaIO::WriteToFile ( TFile * pOutFile) const
protectedinherited

Writes objects into file.

Parameters
pOutFilePointer to output ROOT file
Examples
/tmp/builds/computing/cbmroot/core/qa/CbmQaIO.h.

Definition at line 116 of file CbmQaIO.cxx.

References fpvObjList.

Referenced by CbmQaTask::Finish().

Member Data Documentation

◆ fAccRingMinNumHits

int CbmRichRingRecoQa::fAccRingMinNumHits {7}
staticconstexprprivate

Definition at line 96 of file CbmRichRingRecoQa.h.

Referenced by ExecQa().

◆ fbUseMC

bool CbmQaTask::fbUseMC = false
privateinherited

Flag, if MC is used.

Definition at line 240 of file CbmQaTask.h.

Referenced by CbmQaTask(), and IsMCUsed().

◆ fCbmEvents

TClonesArray* CbmRichRingRecoQa::fCbmEvents {nullptr}
private

Definition at line 106 of file CbmRichRingRecoQa.h.

Referenced by InitQa().

◆ fConfigNode

YAML::Node CbmQaIO::fConfigNode {}
protectedinherited

Configuration node.

Definition at line 163 of file CbmQaIO.h.

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

◆ fDigiManager

CbmDigiManager* CbmRichRingRecoQa::fDigiManager {nullptr}
private

Definition at line 105 of file CbmRichRingRecoQa.h.

Referenced by ExecQa(), and InitQa().

◆ fhRichRingsPerEvent

TH1D* CbmRichRingRecoQa::fhRichRingsPerEvent {nullptr}
private

Definition at line 117 of file CbmRichRingRecoQa.h.

Referenced by ExecQa(), and InitHistograms().

◆ fhRingCenterXY

TH2D* CbmRichRingRecoQa::fhRingCenterXY {nullptr}
private

Definition at line 120 of file CbmRichRingRecoQa.h.

Referenced by ExecQa(), and InitHistograms().

◆ fhRingFeatures

std::array<TH1D*, 12> CbmRichRingRecoQa::fhRingFeatures {}
private

Definition at line 121 of file CbmRichRingRecoQa.h.

Referenced by ExecQa(), and InitHistograms().

◆ fhRingHitsTime

TH1D* CbmRichRingRecoQa::fhRingHitsTime {nullptr}
private

Definition at line 119 of file CbmRichRingRecoQa.h.

Referenced by ExecQa(), and InitHistograms().

◆ fhRingRecoEff

std::array<TProfile*, 5> CbmRichRingRecoQa::fhRingRecoEff {}
private

Definition at line 126 of file CbmRichRingRecoQa.h.

Referenced by Check(), ExecQa(), and InitHistograms().

◆ fhRingRecoPurityXY

TProfile2D* CbmRichRingRecoQa::fhRingRecoPurityXY {nullptr}
private

Definition at line 125 of file CbmRichRingRecoQa.h.

Referenced by FillHistsRingFeatures(), and InitHistograms().

◆ fhRingTimeInEvent

TH1D* CbmRichRingRecoQa::fhRingTimeInEvent {nullptr}
private

Definition at line 118 of file CbmRichRingRecoQa.h.

Referenced by ExecQa(), and InitHistograms().

◆ fhRingTypeCounts

TH1D* CbmRichRingRecoQa::fhRingTypeCounts {nullptr}
private

Definition at line 124 of file CbmRichRingRecoQa.h.

Referenced by Check(), ExecQa(), FillHistsFakeRing(), FillHistsTrueRecoRing(), and InitHistograms().

◆ fhRingTypeFeatures

std::array<std::array<TH1D*, 12>, 6> CbmRichRingRecoQa::fhRingTypeFeatures {}
private

Definition at line 127 of file CbmRichRingRecoQa.h.

Referenced by FillHistsRingFeatures(), and InitHistograms().

◆ fhRingTypeFeaturesMomentum

std::array<std::array<TH2D*, 12>, 5> CbmRichRingRecoQa::fhRingTypeFeaturesMomentum {}
private

Definition at line 128 of file CbmRichRingRecoQa.h.

Referenced by FillHistsRingFeatures(), and InitHistograms().

◆ fmCheckList

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

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().

◆ fMcTracks

CbmMCDataArray* CbmRichRingRecoQa::fMcTracks {nullptr}
private

Definition at line 112 of file CbmRichRingRecoQa.h.

Referenced by ExecQa(), and InitQa().

◆ fNofEvents

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

Number of processed events.

Definition at line 256 of file CbmQaTask.h.

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

◆ fpBenchmarkInput

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

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

Definition at line 261 of file CbmQaTask.h.

Referenced by SetCheckFile().

◆ fpBenchmarkOutput

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

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
privateinherited

Pointer to CbmEvent branch.

Definition at line 253 of file CbmQaTask.h.

Referenced by Exec(), and Init().

◆ fpCurrentEvent

CbmEvent* CbmQaTask::fpCurrentEvent = nullptr
privateinherited

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.

Definition at line 161 of file CbmQaIO.h.

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

◆ fQuotaRich

double CbmRichRingRecoQa::fQuotaRich {0.7}
staticconstexprprivate

Definition at line 97 of file CbmRichRingRecoQa.h.

Referenced by ExecQa().

◆ fRecoMode

ECbmRecoMode CbmQaTask::fRecoMode = ECbmRecoMode::Timeslice
privateinherited

Reconstruction mode.

Definition at line 242 of file CbmQaTask.h.

Referenced by CbmQaTask(), Init(), and SetRecoMode().

◆ fRichHits

TClonesArray* CbmRichRingRecoQa::fRichHits {nullptr}
private

Definition at line 107 of file CbmRichRingRecoQa.h.

Referenced by ExecQa(), and InitQa().

◆ fRichPoints

CbmMCDataArray* CbmRichRingRecoQa::fRichPoints {nullptr}
private

Definition at line 113 of file CbmRichRingRecoQa.h.

Referenced by ExecQa(), and InitQa().

◆ fRichProjections

TClonesArray* CbmRichRingRecoQa::fRichProjections {nullptr}
private

Definition at line 109 of file CbmRichRingRecoQa.h.

Referenced by InitQa().

◆ fRichRingMatches

TClonesArray* CbmRichRingRecoQa::fRichRingMatches {nullptr}
private

Definition at line 114 of file CbmRichRingRecoQa.h.

Referenced by ExecQa(), and InitQa().

◆ fRichRings

TClonesArray* CbmRichRingRecoQa::fRichRings {nullptr}
private

Definition at line 108 of file CbmRichRingRecoQa.h.

Referenced by ExecQa(), and InitQa().

◆ fRingPurityMin

double CbmRichRingRecoQa::fRingPurityMin {0.7}
staticconstexprprivate

Definition at line 102 of file CbmRichRingRecoQa.h.

Referenced by Check().

◆ fRingRecoEffsMin

std::array<double, 4> CbmRichRingRecoQa::fRingRecoEffsMin
staticconstexprprivate
Initial value:
{
0.5, 0.8, 0.5, 0.2}

Definition at line 100 of file CbmRichRingRecoQa.h.

Referenced by Check().

◆ fsConfigName

TString CbmQaIO::fsConfigName = ""
protectedinherited

Name of configuration file.

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

Definition at line 157 of file CbmQaIO.h.

Referenced by GetConfigName(), and SetConfigName().

◆ fsDefaultTag

TString CbmQaTask::fsDefaultTag = ""
privateinherited

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.

Definition at line 158 of file CbmQaIO.h.

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

◆ fsRootFolderName

TString CbmQaIO::fsRootFolderName = ""
protectedinherited

Name of root folder.

Definition at line 156 of file CbmQaIO.h.

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

◆ fsSetupName

std::string CbmQaTask::fsSetupName = ""
privateinherited

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.

Definition at line 160 of file CbmQaIO.h.

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

◆ fsVersionTag

TString CbmQaTask::fsVersionTag = ""
privateinherited

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: