Handler for 1D-histograms. More...

#include <CbmQaCheckerHist1DHandler.h>

Inheritance diagram for cbm::qa::checker::Hist1DHandler:

Collaboration diagram for cbm::qa::checker::Hist1DHandler:

Public Member Functions
	Hist1DHandler (int iObject, int iFile, int iDataset)
	Constructor.

	~Hist1DHandler ()=default
	Destructor.

Result	Compare (int iVersion) const override
	Compares objects to default.

void	CreateCanvases (Option_t *opt="") override
	Creates object comparison canvas.

void	AddObjects (const std::vector< TNamed * > &vpObj)
	Adds vector of pointer to objects.

std::vector< Result >	CompareWithDefault ()
	Compares different versions with default.

void	SetOutputDirectory (TDirectory *pDir)
	Sets folder to store output.

void	SetObjectDB (std::shared_ptr< ObjectDB > &pObjDB)
	Sets objects database.

void	SetComparisonMethod (ECmpMethod method)
	Sets bit flag to control handler behaviour.

void	Write ()
	Writes objects to file.

Protected Attributes
std::string	fsObjType {""}
	Base type of the object to be handled.

std::string	fsBaseName {""}
	Base names of the object.

std::vector< TNamed * >	fvpObjects
	Vector of objects.

std::shared_ptr< ObjectDB >	fpObjDB {nullptr}
	Pointer to object database.

std::shared_ptr< TCanvas >	fpCanvasCmp {nullptr}
	Comparison canvas: plots together.

std::shared_ptr< TCanvas >	fpCanvasRat {nullptr}
	Comparison canvas: ratios to default.

std::shared_ptr< TCanvas >	fpCanvasDiff {nullptr}
	Comparison canvas: difference with default.

TDirectory *	fpOutDir {nullptr}
	Pointer to directory.

int	fObjectID {-1}
	Index of object.

int	fFileID {-1}
	Index of file.

int	fDatasetID {-1}
	Index of dataset.

std::bitset< static_cast< size_t >(ECmpMethod::END)>	fCmpBits
	Bitset for comparison methods.

Detailed Description

Handler for 1D-histograms.

The handler keeps one-dimensional histogram objects of the same quantity within different code versions and provides several comparison methods including point-by-point comparison, test of ratio deviation and statistical hypothesis tests (Chi2 test).

Definition at line 29 of file CbmQaCheckerHist1DHandler.h.

Constructor & Destructor Documentation

◆ Hist1DHandler()

Hist1DHandler::Hist1DHandler	(	int	iObject,
		int	iFile,
		int	iDataset )

Constructor.

Parameters

iObject	Index of object
iFile	Index of file
iDataset	Index of dataset

Definition at line 35 of file CbmQaCheckerHist1DHandler.cxx.

References cbm::qa::checker::ObjectHandler::ObjectHandler().

Referenced by cbm::qa::checker::Hist2DHandler::Hist2DHandler(), and cbm::qa::checker::Profile1DHandler::Profile1DHandler().

◆ ~Hist1DHandler()

cbm::qa::checker::Hist1DHandler::~Hist1DHandler ( )

default

Destructor.

Member Function Documentation

◆ AddObjects()

void ObjectHandler::AddObjects ( const std::vector< TNamed * > & vpObj )

inherited

Adds vector of pointer to objects.

Parameters

vpObj Vector of pointers to TNamed objects

Definition at line 46 of file CbmQaCheckerObjectHandler.cxx.

References fpObjDB, fpOutDir, fsBaseName, and fvpObjects.

◆ Compare()

Result Hist1DHandler::Compare ( int iVersion ) const

overridevirtual

Compares objects to default.

Parameters

iVersion Version index

Returns: Comparison inference

Implements cbm::qa::checker::ObjectHandler.

Definition at line 43 of file CbmQaCheckerHist1DHandler.cxx.

References cbm::qa::checker::Chi2, cbm::qa::checker::Different, cbm::qa::checker::Exact, cbm::qa::checker::ObjectHandler::fCmpBits, cbm::qa::checker::ObjectHandler::fDatasetID, cbm::qa::checker::ObjectHandler::fFileID, cbm::qa::checker::ObjectHandler::fObjectID, cbm::qa::checker::ObjectHandler::fpObjDB, cbm::qa::checker::ObjectHandler::fvpObjects, cbm::qa::checker::Ratio, cbm::qa::checker::StronglyEqual, cbm::qa::checker::ToString(), and cbm::qa::checker::WeaklyEqual.

◆ CompareWithDefault()

std::vector< Result > ObjectHandler::CompareWithDefault ( )

inherited

Compares different versions with default.

Returns: Vector of comparison inferences for different versions

Definition at line 72 of file CbmQaCheckerObjectHandler.cxx.

References Compare(), fpObjDB, fvpObjects, and cbm::qa::checker::StronglyEqual.

◆ CreateCanvases()

void Hist1DHandler::CreateCanvases ( Option_t * opt = "" )

overridevirtual

Creates object comparison canvas.

Parameters

opt	Canvas options

Reimplemented from cbm::qa::checker::ObjectHandler.

Reimplemented in cbm::qa::checker::Hist2DHandler, cbm::qa::checker::Profile1DHandler, Hist2DHandler, and Profile1DHandler.

Definition at line 181 of file CbmQaCheckerHist1DHandler.cxx.

References cbm::qa::checker::ObjectHandler::fpCanvasCmp, cbm::qa::checker::ObjectHandler::fpCanvasDiff, cbm::qa::checker::ObjectHandler::fpCanvasRat, cbm::qa::checker::ObjectHandler::fpObjDB, cbm::qa::checker::ObjectHandler::fpOutDir, cbm::qa::checker::ObjectHandler::fsBaseName, and cbm::qa::checker::ObjectHandler::fvpObjects.

◆ SetComparisonMethod()

void cbm::qa::checker::ObjectHandler::SetComparisonMethod ( ECmpMethod method )

inlineinherited

Sets bit flag to control handler behaviour.

Parameters

bit Bit index

The bit flags should be defined in an enumeration of the default class

Definition at line 74 of file CbmQaCheckerObjectHandler.h.

References fCmpBits.

◆ SetObjectDB()

void cbm::qa::checker::ObjectHandler::SetObjectDB ( std::shared_ptr< ObjectDB > & pObjDB )

inlineinherited

Sets objects database.

Parameters

pObjDB Shared pointer to object database

Definition at line 68 of file CbmQaCheckerObjectHandler.h.

References fpObjDB.

◆ SetOutputDirectory()

void ObjectHandler::SetOutputDirectory ( TDirectory * pDir )

inherited

Sets folder to store output.

Parameters

pDir	Pointer to folder instance

Definition at line 88 of file CbmQaCheckerObjectHandler.cxx.

References fpOutDir.

◆ Write()

void ObjectHandler::Write ( )

inherited

Writes objects to file.

Definition at line 96 of file CbmQaCheckerObjectHandler.cxx.

References fpCanvasCmp, fpCanvasDiff, fpCanvasRat, fpOutDir, and fvpObjects.

Member Data Documentation

◆ fCmpBits

std::bitset<static_cast<size_t>(ECmpMethod::END)> cbm::qa::checker::ObjectHandler::fCmpBits

protectedinherited

Bitset for comparison methods.

Definition at line 92 of file CbmQaCheckerObjectHandler.h.

Referenced by cbm::qa::checker::Hist1DHandler::Compare(), and SetComparisonMethod().

◆ fDatasetID

int cbm::qa::checker::ObjectHandler::fDatasetID {-1}

protectedinherited

Index of dataset.

Definition at line 90 of file CbmQaCheckerObjectHandler.h.

Referenced by cbm::qa::checker::Hist1DHandler::Compare(), and ObjectHandler().

◆ fFileID

int cbm::qa::checker::ObjectHandler::fFileID {-1}

protectedinherited

Index of file.

Definition at line 89 of file CbmQaCheckerObjectHandler.h.

Referenced by cbm::qa::checker::Hist1DHandler::Compare(), and ObjectHandler().

◆ fObjectID

int cbm::qa::checker::ObjectHandler::fObjectID {-1}

protectedinherited

Index of object.

Definition at line 88 of file CbmQaCheckerObjectHandler.h.

Referenced by cbm::qa::checker::Hist1DHandler::Compare(), and ObjectHandler().

◆ fpCanvasCmp

std::shared_ptr<TCanvas> cbm::qa::checker::ObjectHandler::fpCanvasCmp {nullptr}

protectedinherited

Comparison canvas: plots together.

Definition at line 84 of file CbmQaCheckerObjectHandler.h.

Referenced by cbm::qa::checker::Hist1DHandler::CreateCanvases(), cbm::qa::checker::Hist2DHandler::CreateCanvases(), cbm::qa::checker::Profile1DHandler::CreateCanvases(), and Write().

◆ fpCanvasDiff

std::shared_ptr<TCanvas> cbm::qa::checker::ObjectHandler::fpCanvasDiff {nullptr}

protectedinherited

Comparison canvas: difference with default.

Definition at line 86 of file CbmQaCheckerObjectHandler.h.

Referenced by cbm::qa::checker::Hist1DHandler::CreateCanvases(), cbm::qa::checker::Profile1DHandler::CreateCanvases(), and Write().

◆ fpCanvasRat

std::shared_ptr<TCanvas> cbm::qa::checker::ObjectHandler::fpCanvasRat {nullptr}

protectedinherited

Comparison canvas: ratios to default.

Definition at line 85 of file CbmQaCheckerObjectHandler.h.

Referenced by cbm::qa::checker::Hist1DHandler::CreateCanvases(), cbm::qa::checker::Profile1DHandler::CreateCanvases(), and Write().

◆ fpObjDB

std::shared_ptr<ObjectDB> cbm::qa::checker::ObjectHandler::fpObjDB {nullptr}

protectedinherited

Pointer to object database.

Definition at line 83 of file CbmQaCheckerObjectHandler.h.

Referenced by AddObjects(), cbm::qa::checker::Hist1DHandler::Compare(), CompareWithDefault(), cbm::qa::checker::Hist1DHandler::CreateCanvases(), cbm::qa::checker::Hist2DHandler::CreateCanvases(), cbm::qa::checker::Profile1DHandler::CreateCanvases(), and SetObjectDB().

◆ fpOutDir

TDirectory* cbm::qa::checker::ObjectHandler::fpOutDir {nullptr}

protectedinherited

Pointer to directory.

Definition at line 87 of file CbmQaCheckerObjectHandler.h.

Referenced by AddObjects(), cbm::qa::checker::Hist1DHandler::CreateCanvases(), SetOutputDirectory(), and Write().

◆ fsBaseName

std::string cbm::qa::checker::ObjectHandler::fsBaseName {""}

protectedinherited

Base names of the object.

Definition at line 81 of file CbmQaCheckerObjectHandler.h.

Referenced by AddObjects(), cbm::qa::checker::Hist1DHandler::CreateCanvases(), cbm::qa::checker::Hist2DHandler::CreateCanvases(), and cbm::qa::checker::Profile1DHandler::CreateCanvases().

◆ fsObjType

std::string cbm::qa::checker::ObjectHandler::fsObjType {""}

protectedinherited

Base type of the object to be handled.

Definition at line 80 of file CbmQaCheckerObjectHandler.h.

Referenced by ObjectHandler().

◆ fvpObjects

std::vector<TNamed*> cbm::qa::checker::ObjectHandler::fvpObjects

protectedinherited

Vector of objects.

Definition at line 82 of file CbmQaCheckerObjectHandler.h.

Referenced by AddObjects(), cbm::qa::checker::Hist1DHandler::Compare(), CompareWithDefault(), cbm::qa::checker::Hist1DHandler::CreateCanvases(), cbm::qa::checker::Hist2DHandler::CreateCanvases(), cbm::qa::checker::Profile1DHandler::CreateCanvases(), Write(), and ~ObjectHandler().

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Hist1DHandler()

◆ ~Hist1DHandler()

Member Function Documentation

◆ AddObjects()

◆ Compare()

◆ CompareWithDefault()

◆ CreateCanvases()

◆ SetComparisonMethod()

◆ SetObjectDB()

◆ SetOutputDirectory()

◆ Write()

Member Data Documentation

◆ fCmpBits

◆ fDatasetID

◆ fFileID

◆ fObjectID

◆ fpCanvasCmp

◆ fpCanvasDiff

◆ fpCanvasRat

◆ fpObjDB

◆ fpOutDir

◆ fsBaseName

◆ fsObjType

◆ fvpObjects