The main calibration data base class for CBM. More...

#include <CbmRunDatabase.h>

Inheritance diagram for RunDatabase:

Classes
struct	DbCalibration
	A helper structure, which defines "calibration" YAML node. More...

struct	DbCommon
	A helper structure, which defines a layout for "common" YAML node. More...

struct	DbContents
	A helper structure, which defines a layout of the YAML file. More...

struct	DbStartTimeMcbm
	A helper structure, which defines a layout of the "mCBM start time" YAML file. More...

Public Member Functions
const std::string &	GetBmonCalibrationTag () const
	Returns tag of BMON calibration for a provided run ID.

const std::string &	GetGeoSetupTag () const
	Returns tag of the geometry setup for a provided run ID.

const std::string &	GetTofCalibrationTag () const
	Returns tag of TOF calibration for a provided run ID.

const std::string &	GetAlignmentTag () const
	Returns tag of alignment matrices (geoSetup + ref. run ID)

const std::string &	GetRecoParTag () const
	Returns tag of reconstruction parameter.

std::string	GetRecoParDir () const
	Returns a path to the reconstruction parameter directory.

uint64_t	GetRunStartTime () const
	Returns the run start time in UTC seconds for the selected run ID.

const uint64_t &	GetRunStartTimeNs () const
	Returns the run start time in UTC nanoseconds for the selected run ID.

std::string	GetAlgoMainConfigPath () const
	Returns a path to the main configuration file of the online reconstruction.

uint32_t	GetRunId () const
	Returns the loaded run ID.

bool	LoadRun (uint32_t runId)
	Loads the information for the run from the file.

void	SetPathCommonDb (const std::string &pathCommonDb)
	Sets an alternative path to the common DB file.

void	SetPathRunStartTimeDb (const std::string &pathRunStartTimeDb)
	Sets an alternative path to run starttime DB file.

std::string	ToString () const
	String representation of the class contents.

Private Attributes
std::string	fPathCommonDb
	Path to the common data-base.

std::string	fPathRunStartTimeDb
	Path to the runtime data-base.

std::string	fBmonCalibrationTag
	BMON calibration tag for a given run ID.

std::string	fTofCalibrationTag
	TOF calibration tag for a given run ID.

std::string	fGeoSetupTag
	Geometry setup tag for a given run ID.

std::string	fAlignmentTag
	Tag for alignment matrices.

std::string	fRecoParTag
	Tag for reconstruction parameters for a given run ID.

uint64_t	fRunStartTimeNs
	Run start time since the epoch [ns].

uint32_t	fRunId {0}
	Current run ID.

Detailed Description

The main calibration data base class for CBM.

Definition at line 28 of file CbmRunDatabase.h.

Member Function Documentation

◆ GetAlgoMainConfigPath()

std::string cbm::RunDatabase::GetAlgoMainConfigPath ( ) const

inline

Returns a path to the main configuration file of the online reconstruction.

Note: The path is RELATIVE to ${VMCWORKDIR}

Definition at line 104 of file CbmRunDatabase.h.

◆ GetAlignmentTag()

const std::string & cbm::RunDatabase::GetAlignmentTag ( ) const

inline

Returns tag of alignment matrices (geoSetup + ref. run ID)

Definition at line 87 of file CbmRunDatabase.h.

◆ GetBmonCalibrationTag()

const std::string & cbm::RunDatabase::GetBmonCalibrationTag ( ) const

inline

Returns tag of BMON calibration for a provided run ID.

Definition at line 78 of file CbmRunDatabase.h.

◆ GetGeoSetupTag()

const std::string & cbm::RunDatabase::GetGeoSetupTag ( ) const

inline

Returns tag of the geometry setup for a provided run ID.

Definition at line 81 of file CbmRunDatabase.h.

◆ GetRecoParDir()

std::string cbm::RunDatabase::GetRecoParDir ( ) const

inline

Returns a path to the reconstruction parameter directory.

Note: The path is RELATIVE to ${VMCWORKDIR}

Definition at line 94 of file CbmRunDatabase.h.

◆ GetRecoParTag()

const std::string & cbm::RunDatabase::GetRecoParTag ( ) const

inline

Returns tag of reconstruction parameter.

Definition at line 90 of file CbmRunDatabase.h.

◆ GetRunId()

uint32_t cbm::RunDatabase::GetRunId ( ) const

inline

Returns the loaded run ID.

Definition at line 107 of file CbmRunDatabase.h.

◆ GetRunStartTime()

uint64_t cbm::RunDatabase::GetRunStartTime ( ) const

inline

Returns the run start time in UTC seconds for the selected run ID.

Definition at line 97 of file CbmRunDatabase.h.

◆ GetRunStartTimeNs()

const uint64_t & cbm::RunDatabase::GetRunStartTimeNs ( ) const

inline

Returns the run start time in UTC nanoseconds for the selected run ID.

Definition at line 100 of file CbmRunDatabase.h.

◆ GetTofCalibrationTag()

const std::string & cbm::RunDatabase::GetTofCalibrationTag ( ) const

inline

Returns tag of TOF calibration for a provided run ID.

Definition at line 84 of file CbmRunDatabase.h.

◆ LoadRun()

bool RunDatabase::LoadRun ( uint32_t runId )

Loads the information for the run from the file.

Parameters

runId Run identifier

Returns: true The database was read successfully; false The database contains undefined/inconsistent parameters

Definition at line 20 of file CbmRunDatabase.cxx.

◆ SetPathCommonDb()

void cbm::RunDatabase::SetPathCommonDb ( const std::string & pathCommonDb )

inline

Sets an alternative path to the common DB file.

Parameters

pathCommonDb the path

Definition at line 117 of file CbmRunDatabase.h.

◆ SetPathRunStartTimeDb()

void cbm::RunDatabase::SetPathRunStartTimeDb ( const std::string & pathRunStartTimeDb )

inline

Sets an alternative path to run starttime DB file.

Parameters

pathRunStartTimeDb the path

Definition at line 121 of file CbmRunDatabase.h.

◆ ToString()

std::string RunDatabase::ToString ( ) const

String representation of the class contents.

Definition at line 81 of file CbmRunDatabase.cxx.

Member Data Documentation

◆ fAlignmentTag

std::string cbm::RunDatabase::fAlignmentTag

private

Tag for alignment matrices.

Definition at line 135 of file CbmRunDatabase.h.

◆ fBmonCalibrationTag

std::string cbm::RunDatabase::fBmonCalibrationTag

private

BMON calibration tag for a given run ID.

Definition at line 132 of file CbmRunDatabase.h.

◆ fGeoSetupTag

std::string cbm::RunDatabase::fGeoSetupTag

private

Geometry setup tag for a given run ID.

Definition at line 134 of file CbmRunDatabase.h.

◆ fPathCommonDb

std::string cbm::RunDatabase::fPathCommonDb

private

Path to the common data-base.

Definition at line 128 of file CbmRunDatabase.h.

◆ fPathRunStartTimeDb

std::string cbm::RunDatabase::fPathRunStartTimeDb

private

Path to the runtime data-base.

Definition at line 129 of file CbmRunDatabase.h.

◆ fRecoParTag

std::string cbm::RunDatabase::fRecoParTag

private

Tag for reconstruction parameters for a given run ID.

Definition at line 136 of file CbmRunDatabase.h.

◆ fRunId

uint32_t cbm::RunDatabase::fRunId {0}

private

Current run ID.

Definition at line 138 of file CbmRunDatabase.h.

◆ fRunStartTimeNs

uint64_t cbm::RunDatabase::fRunStartTimeNs

private

Run start time since the epoch [ns].

Definition at line 137 of file CbmRunDatabase.h.

◆ fTofCalibrationTag

std::string cbm::RunDatabase::fTofCalibrationTag

private

TOF calibration tag for a given run ID.

Definition at line 133 of file CbmRunDatabase.h.

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

Classes

Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ GetAlgoMainConfigPath()

◆ GetAlignmentTag()

◆ GetBmonCalibrationTag()

◆ GetGeoSetupTag()

◆ GetRecoParDir()

◆ GetRecoParTag()

◆ GetRunId()

◆ GetRunStartTime()

◆ GetRunStartTimeNs()

◆ GetTofCalibrationTag()

◆ LoadRun()

◆ SetPathCommonDb()

◆ SetPathRunStartTimeDb()

◆ ToString()

Member Data Documentation

◆ fAlignmentTag

◆ fBmonCalibrationTag

◆ fGeoSetupTag

◆ fPathCommonDb

◆ fPathRunStartTimeDb

◆ fRecoParTag

◆ fRunId

◆ fRunStartTimeNs

◆ fTofCalibrationTag