Monitor background processes in the detector. More...

#include <DQTBackgroundMon.h>

Inheritance diagram for DQTBackgroundMon:

Collaboration diagram for DQTBackgroundMon:

Public Types
enum	Environment_t { Environment_t::user = 0, Environment_t::online, Environment_t::tier0, Environment_t::tier0Raw, Environment_t::tier0ESD, Environment_t::AOD, Environment_t::altprod }
	Specifies the processing environment. More...

enum	DataType_t { DataType_t::userDefined = 0, DataType_t::monteCarlo, DataType_t::collisions, DataType_t::cosmics, DataType_t::heavyIonCollisions }
	Specifies what type of input data is being monitored. More...

Public Member Functions
	DQTBackgroundMon (const std::string &name, ISvcLocator *pSvcLocator)

virtual	~DQTBackgroundMon ()

virtual StatusCode	initialize () override
	initialize More...

virtual StatusCode	fillHistograms (const EventContext &ctx) const override
	adds event to the monitoring histograms More...

virtual StatusCode	execute (const EventContext &ctx) const override
	Applies filters and trigger requirements. More...

void	fill (const ToolHandle< GenericMonitoringTool > &groupHandle, std::vector< std::reference_wrapper< Monitored::IMonitoredVariable >> &&variables) const
	Fills a vector of variables to a group by reference. More...

void	fill (const ToolHandle< GenericMonitoringTool > &groupHandle, const std::vector< std::reference_wrapper< Monitored::IMonitoredVariable >> &variables) const
	Fills a vector of variables to a group by reference. More...

template<typename... T>
void	fill (const ToolHandle< GenericMonitoringTool > &groupHandle, T &&... variables) const
	Fills a variadic list of variables to a group by reference. More...

void	fill (const std::string &groupName, std::vector< std::reference_wrapper< Monitored::IMonitoredVariable >> &&variables) const
	Fills a vector of variables to a group by name. More...

void	fill (const std::string &groupName, const std::vector< std::reference_wrapper< Monitored::IMonitoredVariable >> &variables) const
	Fills a vector of variables to a group by name. More...

template<typename... T>
void	fill (const std::string &groupName, T &&... variables) const
	Fills a variadic list of variables to a group by name. More...

Environment_t	environment () const
	Accessor functions for the environment. More...

Environment_t	envStringToEnum (const std::string &str) const
	Convert the environment string from the python configuration to an enum object. More...

DataType_t	dataType () const
	Accessor functions for the data type. More...

DataType_t	dataTypeStringToEnum (const std::string &str) const
	Convert the data type string from the python configuration to an enum object. More...

const ToolHandle< GenericMonitoringTool > &	getGroup (const std::string &name) const
	Get a specific monitoring tool from the tool handle array. More...

const ToolHandle< Trig::TrigDecisionTool > &	getTrigDecisionTool () const
	Get the trigger decision tool member. More...

bool	trigChainsArePassed (const std::vector< std::string > &vTrigNames) const
	Check whether triggers are passed. More...

SG::ReadHandle< xAOD::EventInfo >	GetEventInfo (const EventContext &) const
	Return a ReadHandle for an EventInfo object (get run/event numbers, etc.) More...

virtual float	lbAverageInteractionsPerCrossing (const EventContext &ctx=Gaudi::Hive::currentContext()) const
	Calculate the average mu, i.e. More...

virtual float	lbInteractionsPerCrossing (const EventContext &ctx=Gaudi::Hive::currentContext()) const
	Calculate instantaneous number of interactions, i.e. More...

virtual float	lbAverageLuminosity (const EventContext &ctx=Gaudi::Hive::currentContext()) const
	Calculate average luminosity (in ub-1 s-1 => 10^30 cm-2 s-1). More...

virtual float	lbLuminosityPerBCID (const EventContext &ctx=Gaudi::Hive::currentContext()) const
	Calculate the instantaneous luminosity per bunch crossing. More...

virtual double	lbDuration (const EventContext &ctx=Gaudi::Hive::currentContext()) const
	Calculate the duration of the luminosity block (in seconds) More...

virtual float	lbAverageLivefraction (const EventContext &ctx=Gaudi::Hive::currentContext()) const
	Calculate the average luminosity livefraction. More...

virtual float	livefractionPerBCID (const EventContext &ctx=Gaudi::Hive::currentContext()) const
	Calculate the live fraction per bunch crossing ID. More...

virtual double	lbLumiWeight (const EventContext &ctx=Gaudi::Hive::currentContext()) const
	Calculate the average integrated luminosity multiplied by the live fraction. More...

virtual StatusCode	parseList (const std::string &line, std::vector< std::string > &result) const
	Parse a string into a vector. More...

virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...

virtual bool	isClonable () const override
	Specify if the algorithm is clonable. More...

virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...

virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm. More...

virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...

virtual bool	filterPassed (const EventContext &ctx) const

virtual void	setFilterPassed (bool state, const EventContext &ctx) const

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Protected Attributes
ToolHandleArray< GenericMonitoringTool >	m_tools {this,"GMTools",{}}
	Array of Generic Monitoring Tools. More...

PublicToolHandle< Trig::TrigDecisionTool >	m_trigDecTool {this, "TrigDecisionTool",""}
	Tool to tell whether a specific trigger is passed. More...

ToolHandleArray< IDQFilterTool >	m_DQFilterTools {this,"FilterTools",{}}
	Array of Data Quality filter tools. More...

SG::ReadCondHandleKey< LuminosityCondData >	m_lumiDataKey {this,"LuminosityCondDataKey","LuminosityCondData","SG Key of LuminosityCondData object"}

SG::ReadCondHandleKey< LBDurationCondData >	m_lbDurationDataKey {this,"LBDurationCondDataKey","LBDurationCondData","SG Key of LBDurationCondData object"}

SG::ReadCondHandleKey< TrigLiveFractionCondData >	m_trigLiveFractionDataKey {this,"TrigLiveFractionCondDataKey","TrigLiveFractionCondData", "SG Key of TrigLiveFractionCondData object"}

AthMonitorAlgorithm::Environment_t	m_environment
	Instance of the Environment_t enum. More...

AthMonitorAlgorithm::DataType_t	m_dataType
	Instance of the DataType_t enum. More...

Gaudi::Property< std::string >	m_environmentStr {this,"Environment","user"}
	Environment string pulled from the job option and converted to enum. More...

Gaudi::Property< std::string >	m_dataTypeStr {this,"DataType","userDefined"}
	DataType string pulled from the job option and converted to enum. More...

Gaudi::Property< std::string >	m_triggerChainString {this,"TriggerChain",""}
	Trigger chain string pulled from the job option and parsed into a vector. More...

std::vector< std::string >	m_vTrigChainNames
	Vector of trigger chain names parsed from trigger chain string. More...

Gaudi::Property< std::string >	m_fileKey {this,"FileKey",""}
	Internal Athena name for file. More...

Gaudi::Property< bool >	m_useLumi {this,"EnableLumi",false}
	Allows use of various luminosity functions. More...

Gaudi::Property< float >	m_defaultLBDuration {this,"DefaultLBDuration",60.}
	Default duration of one lumi block. More...

Gaudi::Property< int >	m_detailLevel {this,"DetailLevel",0}
	Sets the level of detail used in the monitoring. More...

SG::ReadHandleKey< xAOD::EventInfo >	m_EventInfoKey {this,"EventInfoKey","EventInfo"}
	Key for retrieving EventInfo from StoreGate. More...

Private Types
template<class T >
using	RH = SG::ReadHandle< T >

template<class T >
using	RHK = SG::ReadHandleKey< T >

template<class T >
using	GP = Gaudi::Property< T >

typedef std::vector< std::reference_wrapper< Monitored::IMonitoredVariable > >	MonVarVec_t

typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
GP< bool >	m_doMuons {this, "Muons", true}

RHK< LArCollisionTime >	m_LArCollisionTimeKey {this, "LArCollisionTimeKey", "LArCollisionTime", ""}

RHK< MBTSCollisionTime >	m_MBTSCollisionTimeKey {this, "MBTSCollisionTimeKey", "MBTSCollisionTime", ""}

RHK< TileCellContainer >	m_TileCellContainerKey {this, "MBTSContainerName", "MBTSContainer", ""}

RHK< LUCID_RawDataContainer >	m_LUCID_RawDataContainerKey {this, "Lucid_RawDataKey","Lucid_RawData", ""}

RHK< BeamBackgroundData >	m_BeamBackgroundDataKey {this, "BeamBackgroundDataKey", "BeamBackgroundData", ""}

RHK< xAOD::VertexContainer >	m_VertexContainerKey {this, "PrimaryVerticesKey", "PrimaryVertices", ""}

RHK< SpacePointContainer >	m_sctSpacePointKey {this,"SCT_SpacePointKey","SCT_SpacePoints",""}

RHK< SpacePointContainer >	m_pixSpacePointKey {this,"Pixel_SpacePointKey","PixelSpacePoints",""}

SG::ReadDecorHandleKey< xAOD::EventInfo >	m_eventInfoDecorKey

GP< int >	m_filledBG {this, "FilledBGIndex", 1}

GP< int >	m_emptyBG {this, "EmptyBGIndex", 3}

GP< int >	m_unpairIsoBG {this, "UnpairIsoBGIndex", 4}

GP< int >	m_unpairNonIsoBG {this, "UnpairNonIsoBGIndex", 5}

GP< int >	m_upPixSP {this, "UpPixSP", 5000}

GP< int >	m_upSctSP {this, "UpSctSP", 10000}

GP< int >	m_LArECSideCut {this, "LArECSideCut", 1}

GP< int >	m_MBTSSideCut {this, "MBTSSideCut", 2}

GP< float >	m_MBTSTimeCut {this, "MBTSTimeCut", 15}

GP< float >	m_MBTSThresholdCut {this, "MBTSThresholdCut", 40.0/222.0}

GP< int >	m_MBTSMask {this, "MBTSMask", TileCell::MASK_BADCH \| TileCell::MASK_OVER \| TileCell::MASK_TIME }

GP< int >	m_MBTSPattern {this, "MBTSPattern", TileCell::MASK_TIME }

GP< int >	m_nBkgWords {this, "NBkgWords", 32}

std::string	m_name

std::unordered_map< std::string, size_t >	m_toolLookupMap

const ToolHandle< GenericMonitoringTool >	m_dummy

Gaudi::Property< bool >	m_enforceExpressTriggers

DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks. More...

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Monitor background processes in the detector.

Author: C. D. Burton burto.nosp@m.n@ut.nosp@m.exas..nosp@m.edu

Date: 2019/07/31

Definition at line 24 of file DQTBackgroundMon.h.

Member Typedef Documentation

◆ GP

template<class T >

using DQTBackgroundMon::GP = Gaudi::Property<T>

private

Definition at line 33 of file DQTBackgroundMon.h.

◆ MonVarVec_t

typedef std::vector<std::reference_wrapper<Monitored::IMonitoredVariable> > AthMonitorAlgorithm::MonVarVec_t

privateinherited

Definition at line 365 of file AthMonitorAlgorithm.h.

◆ RH

template<class T >

using DQTBackgroundMon::RH = SG::ReadHandle<T>

private

Definition at line 31 of file DQTBackgroundMon.h.

◆ RHK

template<class T >

using DQTBackgroundMon::RHK = SG::ReadHandleKey<T>

private

Definition at line 32 of file DQTBackgroundMon.h.

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

◆ DataType_t

enum AthMonitorAlgorithm::DataType_t

stronginherited

Specifies what type of input data is being monitored.

An enumeration of the different types of data the monitoring application may be running over. This can be used to select which histograms to produce, e.g. to prevent the production of colliding-beam histograms when running on cosmic-ray data. Strings of the same names may be given as jobOptions.

Enumerator
userDefined
monteCarlo
collisions
cosmics
heavyIonCollisions

Definition at line 191 of file AthMonitorAlgorithm.h.

                           {
         userDefined = 0, 
         monteCarlo, 
         collisions, 
         cosmics, 
         heavyIonCollisions, 
     };

◆ Environment_t

enum AthMonitorAlgorithm::Environment_t

stronginherited

Specifies the processing environment.

The running environment may be used to select which histograms are produced, and where they are located in the output. For example, the output paths of the histograms are different for the "user", "online" and the various offline flags. Strings of the same names may be given as jobOptions.

Enumerator
user
online
tier0
tier0Raw
tier0ESD
AOD
altprod

Definition at line 172 of file AthMonitorAlgorithm.h.

                              {
         user = 0, 
         online, 
         tier0, 
         tier0Raw, 
         tier0ESD, 
         AOD, 
         altprod, 
     };

Constructor & Destructor Documentation

◆ DQTBackgroundMon()

DQTBackgroundMon::DQTBackgroundMon	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Definition at line 7 of file DQTBackgroundMon.cxx.

8 : AthMonitorAlgorithm(name,pSvcLocator)

9 {}

◆ ~DQTBackgroundMon()

DQTBackgroundMon::~DQTBackgroundMon ( )

virtual

Definition at line 11 of file DQTBackgroundMon.cxx.

11 {}

Member Function Documentation

◆ cardinality()

unsigned int AthReentrantAlgorithm::cardinality ( ) const

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 55 of file AthReentrantAlgorithm.cxx.

 {
   return 0;
 }

◆ dataType()

DataType_t AthMonitorAlgorithm::dataType ( ) const

inlineinherited

Accessor functions for the data type.

Returns: the current value of the class's DataType_t instance.

Definition at line 221 of file AthMonitorAlgorithm.h.

221 { return m_dataType; }

◆ dataTypeStringToEnum()

AthMonitorAlgorithm::DataType_t AthMonitorAlgorithm::dataTypeStringToEnum ( const std::string & str ) const

inherited

Convert the data type string from the python configuration to an enum object.

Returns: a value in the DataType_t enumeration which matches the input string.

Definition at line 140 of file AthMonitorAlgorithm.cxx.

                                                                                                     {
     // convert the string to all lowercase
     std::string lowerCaseStr = str;
     std::transform(lowerCaseStr.begin(), lowerCaseStr.end(), lowerCaseStr.begin(), ::tolower);
  
     // check if it matches one of the enum choices
     if( lowerCaseStr == "userdefined" ) {
         return DataType_t::userDefined;
     } else if( lowerCaseStr == "montecarlo" ) {
         return DataType_t::monteCarlo;
     } else if( lowerCaseStr == "collisions" ) {
         return DataType_t::collisions;
     } else if( lowerCaseStr == "cosmics" ) {
         return DataType_t::cosmics;
     } else if( lowerCaseStr == "heavyioncollisions" ) {
         return DataType_t::heavyIonCollisions;
     } else { // otherwise, warn the user and return "userDefined"
         ATH_MSG_WARNING("AthMonitorAlgorithm::dataTypeStringToEnum(): Unknown data type "
             <<str<<", returning userDefined.");
         return DataType_t::userDefined;
     }
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ environment()

Environment_t AthMonitorAlgorithm::environment ( ) const

inlineinherited

Accessor functions for the environment.

Returns: the current value of the class's Environment_t instance.

Definition at line 205 of file AthMonitorAlgorithm.h.

205 { return m_environment; }

◆ envStringToEnum()

AthMonitorAlgorithm::Environment_t AthMonitorAlgorithm::envStringToEnum ( const std::string & str ) const

inherited

Convert the environment string from the python configuration to an enum object.

Returns: a value in the Environment_t enumeration which matches the input string.

Definition at line 112 of file AthMonitorAlgorithm.cxx.

                                                                                                   {
     // convert the string to all lowercase
     std::string lowerCaseStr = str;
     std::transform(lowerCaseStr.begin(), lowerCaseStr.end(), lowerCaseStr.begin(), ::tolower);
  
     // check if it matches one of the enum choices
     if( lowerCaseStr == "user" ) {
         return Environment_t::user;
     } else if( lowerCaseStr == "online" ) {
         return Environment_t::online;
     } else if( lowerCaseStr == "tier0" ) {
         return Environment_t::tier0;
     } else if( lowerCaseStr == "tier0raw" ) {
         return Environment_t::tier0Raw;
     } else if( lowerCaseStr == "tier0esd" ) {
         return Environment_t::tier0ESD;
     } else if( lowerCaseStr == "aod" ) {
         return Environment_t::AOD;
     } else if( lowerCaseStr == "altprod" ) {
         return Environment_t::altprod;
     } else { // otherwise, warn the user and return "user"
         ATH_MSG_WARNING("AthMonitorAlgorithm::envStringToEnum(): Unknown environment "
             <<str<<", returning user.");
         return Environment_t::user;
     }
 }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ execute()

StatusCode AthMonitorAlgorithm::execute ( const EventContext & ctx ) const

overridevirtualinherited

Applies filters and trigger requirements.

Then, calls fillHistograms().

Parameters

ctx	event context for reentrant Athena call

Returns: StatusCode

Definition at line 73 of file AthMonitorAlgorithm.cxx.

                                                                        {
  
     // Checks that all of the  DQ filters are passed. If any one of the filters
     // fails, return SUCCESS code and do not fill the histograms with the event.
     for ( const auto& filterItr : m_DQFilterTools ) {
         if (!filterItr->accept()) {
             ATH_MSG_DEBUG("Event rejected due to filter tool.");
             return StatusCode::SUCCESS;
         }
     }
  
     // Trigger: If there is a decision tool and the chains fail, skip the event.
     if ( !m_trigDecTool.empty() && !trigChainsArePassed(m_vTrigChainNames) ) {
         ATH_MSG_DEBUG("Event rejected due to trigger filter.");
         return StatusCode::SUCCESS;
     }
  
     ATH_MSG_DEBUG("Event accepted!");
     return fillHistograms(ctx);
 }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ extraOutputDeps()

const DataObjIDColl & AthReentrantAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 79 of file AthReentrantAlgorithm.cxx.

 {
   // If we didn't find any symlinks to add, just return the collection
   // from the base class.  Otherwise, return the extended collection.
   if (!m_extendedExtraObjects.empty()) {
     return m_extendedExtraObjects;
   }
   return Algorithm::extraOutputDeps();
 }

◆ fillHistograms()

StatusCode DQTBackgroundMon::fillHistograms ( const EventContext & ctx ) const

overridevirtual

adds event to the monitoring histograms

User will overwrite this function. Histogram booking is no longer done in C++. This function is called in execute once the filters are all passed.

Parameters

ctx	forwarded from execute

Returns: StatusCode

Implements AthMonitorAlgorithm.

Definition at line 26 of file DQTBackgroundMon.cxx.

                                                                            {
     ATH_MSG_DEBUG("In DQTBackgroundMon::fillHistograms()");
     using namespace Monitored;
  
     auto group = getGroup("default");
  
     auto filled = Scalar<bool>("filled",false);
     auto empty = Scalar<bool>("empty",false);
     auto unpairIso = Scalar<bool>("unpairIso",false);
     auto unpairNonIso = Scalar<bool>("unpairNonIso",false);
  
     RH<xAOD::EventInfo> eventInfo{GetEventInfo(ctx)};
     RH<SpacePointContainer> sctSP{m_sctSpacePointKey,ctx};
     RH<SpacePointContainer> pixSP{m_pixSpacePointKey,ctx};
     RH<LArCollisionTime> tps(m_LArCollisionTimeKey,ctx);
     RH<MBTSCollisionTime> mbtsTime(m_MBTSCollisionTimeKey,ctx);
     RH<TileCellContainer> tileCellContainer(m_TileCellContainerKey,ctx);
     RH<LUCID_RawDataContainer> LUCID_RawDataContainer(m_LUCID_RawDataContainerKey,ctx);
     RH<BeamBackgroundData> beamBackgroundData(m_BeamBackgroundDataKey,ctx);
     RH<xAOD::VertexContainer> vertexContainer(m_VertexContainerKey,ctx);
  
     if ( eventInfo.isValid() ) {
         if (!getTrigDecisionTool().empty()) {
             unsigned int bgCode = getTrigDecisionTool()->getBGCode();
             filled = bgCode & (1<<m_filledBG);
             empty = bgCode & (1<<m_emptyBG);
             unpairIso = bgCode & (1<<m_unpairIsoBG);
             unpairNonIso = bgCode & (1<<m_unpairNonIsoBG);
         }
  
         std::vector<int> bitVec = {};
         std::vector<int> filledVec = {};
         std::vector<int> emptyVec = {};
         std::vector<int> unpairIsoVec = {};
         std::vector<int> unpairNonIsoVec = {};
  
         for ( int bkg=0; bkg<m_nBkgWords; bkg++ ) {
             unsigned int bgWord = eventInfo->eventFlags(xAOD::EventInfo::Background);
             ATH_MSG_DEBUG("Background word is "<<bgWord);
             if ( !(bgWord & 1<<bkg) ) {
                 continue;
             }
  
             bitVec.push_back(bkg);
             if (filled) {
                 filledVec.push_back(bkg);
             } else if (empty) {
                 emptyVec.push_back(bkg);
             } else if (unpairIso) {
                 unpairIsoVec.push_back(bkg);
             } else if (unpairNonIso) {
                 unpairNonIsoVec.push_back(bkg);
             }
         }
  
         auto bitSet = Collection("bitSet",bitVec);
         auto bitSetFilled = Collection("bitSetFilled",filledVec);
         auto bitSetEmpty = Collection("bitSetEmpty",emptyVec);
         auto bitSetUnpairIso = Collection("bitSetUnpairIso",unpairIsoVec);
         auto bitSetUnpairNonIso = Collection("bitSetUnpairNonIso",unpairNonIsoVec);
         fill(group,bitSet,bitSetFilled,bitSetEmpty,bitSetUnpairIso,bitSetUnpairNonIso);
     } else {
         ATH_MSG_WARNING("Event data invalid. Background word histograms are being skipped.");
     }
  
  
  
     if (sctSP.isValid() and pixSP.isValid()) {
       auto nSctSPs = Scalar<float>("nSctSPs",0.0);
       std::for_each(sctSP->begin(),sctSP->end(),[&nSctSPs](const auto coll){if (coll) nSctSPs+=coll->size();});
  
       auto nPixSPs = Scalar<float>("nPixSPs",0.0);
       std::for_each(pixSP->begin(),pixSP->end(),[&nPixSPs](const auto coll){if (coll) nPixSPs+=coll->size();});
  
       fill(group,nPixSPs,nSctSPs,unpairIso,unpairNonIso);
       if ( nPixSPs<m_upPixSP ){
     fill("lowMultiplicityPixGroup",nPixSPs,unpairIso,unpairNonIso);
       }
       if ( nSctSPs<m_upSctSP ) {
     fill("lowMultiplicitySctGroup",nSctSPs,unpairIso,unpairNonIso);
       }
     } else {
         ATH_MSG_WARNING("Pixe/SCT Spacepoint data invalid. nPix/nSct is being skipped.");
     }
  
     if ( tps.isValid() ) {
         if ( tps->ncellA()>m_LArECSideCut && tps->ncellC()>m_LArECSideCut ) {
             auto LArECTimeDiff = Scalar<float>("LArECTimeDiff", tps->timeA()-tps->timeC());
             fill(group,LArECTimeDiff);
         }
     } else {
         ATH_MSG_WARNING("TPS data invalid. LArECTimeDiff is being skipped.");
     }
  
     if ( mbtsTime.isValid() ) {
         if ( mbtsTime->ncellA()>m_MBTSSideCut && mbtsTime->ncellC()>m_MBTSSideCut ) {
             auto MBTStimeDiff = Scalar<float>("MBTStimeDiff", mbtsTime->time());
             fill(group,MBTStimeDiff);
         }
     } else {
         ATH_MSG_WARNING("MBTSCollisionTime data invalid. MBTStimeDiff is being skipped.");
     }
  
     if ( tileCellContainer.isValid() ) {
         auto MBTSCount = Scalar<int>("MBTSvetoHits",0);
         for ( auto tileCell : *tileCellContainer ) {
             if (tileCell->energy()>m_MBTSThresholdCut &&
                 (tileCell->qbit1() & m_MBTSMask)==m_MBTSPattern &&
                 fabs(tileCell->time())<m_MBTSTimeCut )
                 MBTSCount++;
         }
         fill(group,MBTSCount);
     } else {
         ATH_MSG_WARNING("TileCell data invalid. MBTSvetoHits is being skipped.");
     }
  
     if ( LUCID_RawDataContainer.isValid() ) {
         auto LUCIDCounter = Scalar<int>("LUCIDCounter",0);
         for ( auto LUCID_RawData : *LUCID_RawDataContainer ) {
             LUCIDCounter += LUCID_RawData->getNhitsPMTsideA() + LUCID_RawData->getNhitsPMTsideC();
         }
         fill(group,LUCIDCounter);
     } else {
         ATH_MSG_WARNING("LUCID data invalid. LUCID is being skipped.");
     }
  
     if ( m_doMuons ) {
         if (beamBackgroundData.isValid() ) {
             // Muon segments and clusters
             std::vector<double> muSegXVec = {};
             std::vector<double> muSegYVec = {};
             for (int iSeg=0; iSeg<beamBackgroundData->GetNumSegment(); iSeg++) {
                 const Trk::Segment* trkSeg = beamBackgroundData->GetIndexSeg(iSeg);
                 const xAOD::MuonSegment* muonSeg = dynamic_cast<const xAOD::MuonSegment*>(trkSeg);
                 if (muonSeg) {
                     muSegXVec.push_back(muonSeg->x()*1e-3);
                     muSegYVec.push_back(muonSeg->y()*1e-3);
                 }
             }
             auto muSegXCollection = Collection("muonSegmentX",muSegXVec);
             auto muSegYCollection = Collection("muonSegmentY",muSegYVec);
  
             std::vector<double> clusterEnergyVec = {};
             std::vector<double> clusterEtaVec = {};
             std::vector<double> clusterPhiVec = {};
             std::vector<double> clusterTimeVec = {};
             for (int i=0; i<beamBackgroundData->GetNumMatched(); i++) {
                 const xAOD::CaloCluster* cluster = beamBackgroundData->GetIndexClus(i);
                 clusterEnergyVec.push_back(cluster->e()*1e-3);
                 clusterEtaVec.push_back(cluster->eta());
                 clusterPhiVec.push_back(cluster->phi());
                 clusterTimeVec.push_back(cluster->time());
             }
             auto clusterEnergyCollection = Collection("clusterEnergy",clusterEnergyVec);
             auto clusterEtaCollection = Collection("clusterEta",clusterEtaVec);
             auto clusterPhiCollection = Collection("clusterPhi",clusterPhiVec);
             auto clusterTimeCollection = Collection("clusterTime",clusterTimeVec);
  
             fill(group,muSegXCollection,muSegYCollection,clusterEnergyCollection,
                  clusterEtaCollection,clusterPhiCollection,clusterTimeCollection);
  
             // fake jets
             if ( beamBackgroundData->GetNumNoTimeTight() ) {
                 std::vector<int> jetIndexVec = {};
                 for (int i=0; i<beamBackgroundData->GetNumJet(); i++) {
                     const xAOD::Jet* jet = beamBackgroundData->GetIndexJet(i);
                     int jetIndex = beamBackgroundData->GetIndexJet(jet);
                     jetIndexVec.push_back(jetIndex);
  
                     // Leading jet
                     if ( jetIndex==0 ) {
                         auto pt = Scalar<double>("leadingJetPt", jet->pt());
                         auto eta = Scalar<double>("leadingJetEta", jet->eta());
                         auto phi = Scalar<double>("leadingJetPhi", jet->phi());
                         double timeValue = jet->getAttribute<float>(xAOD::JetAttribute::Timing);
                         auto time = Scalar<double>("leadingJetTime", timeValue);
                         double emfValue = jet->getAttribute<float>(xAOD::JetAttribute::EMFrac);
                         auto emf = Scalar<double>("leadingJetEMFrac", emfValue);
  
                         std::vector<float> sumPt_v;
                         auto trkPtAttr = xAOD::JetAttribute::SumPtTrkPt1000;
                         bool hasSumPt = jet->getAttribute<std::vector<float>>(trkPtAttr, sumPt_v);
                         double sumPtTrk = hasSumPt ? sumPt_v[0] : 0.;
                         auto chf = Scalar<double>("leadingJetCHF", sumPtTrk / pt);
  
                         fill(group,pt,eta,phi,time,emf,chf);
                     }
                 }
                 auto jetIndexCollection = Collection("jetIndex",jetIndexVec);
  
                 auto bcid = Scalar<int>("bcid",2);
                 auto isAC = Scalar<bool>("isAC", beamBackgroundData->GetDirection()>0);
                 auto isCA = Scalar<bool>("isCA", beamBackgroundData->GetDirection()<0);
                 bool isOneSided = beamBackgroundData->GetNumOneSidedLoose();
                 auto isACOneSided = Scalar<bool>("isACOneSided", isAC && isOneSided );
                 auto isCAOneSided = Scalar<bool>("isCAOneSided", isCA && isOneSided );
                 fill(group,jetIndexCollection,bcid,isAC,isCA,isACOneSided,isCAOneSided);
             } // end fake jets
         } else {
             ATH_MSG_WARNING("BeamBackgroundData data invalid. Muons are being skipped.");
         }
     } // end muons
  
     if (vertexContainer.isValid()) {
         // count vertices, excluding the dummy vertex
         auto nVertex = Scalar<int>("nVertex", vertexContainer->size()-1);
         fill(group,nVertex,unpairIso,unpairNonIso);
     } else {
         ATH_MSG_DEBUG("Primary vertex data invalid. Primary vertex counts are being skipped.");
     }
     return StatusCode::SUCCESS;
 }

◆ filterPassed()

virtual bool AthReentrantAlgorithm::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 135 of file AthReentrantAlgorithm.h.

                                                            {
     return execState( ctx ).filterPassed();
   }

◆ GetEventInfo()

SG::ReadHandle< xAOD::EventInfo > AthMonitorAlgorithm::GetEventInfo ( const EventContext & ctx ) const

inherited

Return a ReadHandle for an EventInfo object (get run/event numbers, etc.)

Parameters

ctx	EventContext for the event

Returns: a SG::ReadHandle<xAOD::EventInfo>

Definition at line 107 of file AthMonitorAlgorithm.cxx.

                                                                                              {
     return SG::ReadHandle<xAOD::EventInfo>(m_EventInfoKey, ctx);
 }

◆ getGroup()

const ToolHandle< GenericMonitoringTool > & AthMonitorAlgorithm::getGroup ( const std::string & name ) const

inherited

Get a specific monitoring tool from the tool handle array.

Finds a specific GenericMonitoringTool instance from the list of monitoring tools (a ToolHandleArray). Throws a FATAL warning if the object found is empty.

Parameters

name	string name of the desired tool

Returns: reference to the desired monitoring tool

Definition at line 164 of file AthMonitorAlgorithm.cxx.

                                                                                                     {
     // get the pointer to the tool, and check that it exists
     auto idx = m_toolLookupMap.find(name);
     if (ATH_LIKELY(idx != m_toolLookupMap.end())) {
         return m_tools[idx->second];
     }
     else {
       if (!isInitialized()) {
         ATH_MSG_FATAL(
             "It seems that the AthMonitorAlgorithm::initialize was not called "
             "in derived class initialize method");
       } else {
         std::string available = std::accumulate(
             m_toolLookupMap.begin(), m_toolLookupMap.end(), std::string(""),
             [](const std::string& s, auto h) { return s + "," + h.first; });
         ATH_MSG_FATAL("The tool " << name << " could not be found in the tool array of the "
                       << "monitoring algorithm " << m_name << ". This probably reflects a discrepancy between "
                       << "your python configuration and c++ filling code. Note: your available groups are {"
                       << available << "}.");
         }
     }
     return m_dummy;
 }

◆ getTrigDecisionTool()

const ToolHandle< Trig::TrigDecisionTool > & AthMonitorAlgorithm::getTrigDecisionTool ( ) const

inherited

Get the trigger decision tool member.

The trigger decision tool is used to check whether a specific trigger is passed by an event.

Returns: m_trigDecTool

Definition at line 189 of file AthMonitorAlgorithm.cxx.

                                                                                        {
     return m_trigDecTool;
 }

◆ initialize()

StatusCode DQTBackgroundMon::initialize ( )

overridevirtual

initialize

Returns: StatusCode

Reimplemented from AthMonitorAlgorithm.

Definition at line 13 of file DQTBackgroundMon.cxx.

                                         {
     ATH_CHECK( m_LArCollisionTimeKey.initialize() );
     ATH_CHECK( m_MBTSCollisionTimeKey.initialize() );
     ATH_CHECK( m_TileCellContainerKey.initialize() );
     ATH_CHECK( m_LUCID_RawDataContainerKey.initialize() );
     ATH_CHECK( m_BeamBackgroundDataKey.initialize() );
     ATH_CHECK( m_VertexContainerKey.initialize() );
     ATH_CHECK( m_eventInfoDecorKey.initialize() );
     ATH_CHECK( m_sctSpacePointKey.initialize() );
     ATH_CHECK( m_pixSpacePointKey.initialize() );
     return AthMonitorAlgorithm::initialize();
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ isClonable()

bool AthReentrantAlgorithm::isClonable ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Reimplemented in Simulation::BeamEffectsAlg, InDet::SiTrackerSpacePointFinder, InDet::SCT_Clusterization, InDet::SiSPSeededTrackFinder, SCTRawDataProvider, InDet::GNNSeedingTrackMaker, SCT_PrepDataToxAOD, RoIBResultToxAOD, SCT_CablingCondAlgFromCoraCool, SCT_ReadCalibDataTestAlg, SCT_CablingCondAlgFromText, InDet::SiSPGNNTrackMaker, SCT_ReadCalibChipDataTestAlg, SCT_TestCablingAlg, SCT_ConfigurationConditionsTestAlg, ITkPixelCablingAlg, SCTEventFlagWriter, SCT_ConditionsSummaryTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_TdaqEnabledTestAlg, SCT_SiliconConditionsTestAlg, SCTSiLorentzAngleTestAlg, SCT_ByteStreamErrorsTestAlg, SCT_ConditionsParameterTestAlg, SCT_FlaggedConditionTestAlg, SCT_StripVetoTestAlg, SCT_RawDataToxAOD, and SCTSiPropertiesTestAlg.

Definition at line 44 of file AthReentrantAlgorithm.cxx.

 {
   // Reentrant algorithms are clonable.
   return true;
 }

◆ msg() [1/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< Gaudi::Algorithm >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ parseList()

StatusCode AthMonitorAlgorithm::parseList	(	const std::string &	line,
		std::vector< std::string > &	result
	)		const

virtualinherited

Parse a string into a vector.

The input string is a single long string of all of the trigger names. It parses this string and turns it into a vector, where each element is one trigger or trigger category.

Parameters

line	The input string.
result	The parsed output vector of strings.

Returns: StatusCode

Definition at line 336 of file AthMonitorAlgorithm.cxx.

                                                                                                    {
     std::string item;
     std::stringstream ss(line);
  
     ATH_MSG_DEBUG( "AthMonitorAlgorithm::parseList()" );
  
     while ( std::getline(ss, item, ',') ) {
         std::stringstream iss(item); // remove whitespace
         iss >> item;
         result.push_back(item);
     }
  
     return StatusCode::SUCCESS;
 }

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

   {
     h.renounce();
     PBASE::renounce (h);
   }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ setFilterPassed()

virtual void AthReentrantAlgorithm::setFilterPassed	(	bool	state,
		const EventContext &	ctx
	)		const

inlinevirtualinherited

Definition at line 139 of file AthReentrantAlgorithm.h.

                                                                             {
     execState( ctx ).setFilterPassed( state );
   }

◆ sysExecute()

StatusCode AthReentrantAlgorithm::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 67 of file AthReentrantAlgorithm.cxx.

 {
   return Gaudi::Algorithm::sysExecute (ctx);
 }

◆ sysInitialize()

StatusCode AthReentrantAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in InputMakerBase, and HypoBase.

Definition at line 96 of file AthReentrantAlgorithm.cxx.

                                                 {
   StatusCode sc=AthCommonDataStore<AthCommonMsg<Gaudi::Algorithm>>::sysInitialize();
  
   if (sc.isFailure()) {
     return sc;
   }
   
   ServiceHandle<ICondSvc> cs("CondSvc",name());
   for (auto h : outputHandles()) {
     if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
       // do this inside the loop so we don't create the CondSvc until needed
       if ( cs.retrieve().isFailure() ) {
         ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
         return StatusCode::SUCCESS;
       }      
       if (cs->regHandle(this,*h).isFailure()) {
         sc = StatusCode::FAILURE;
         ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                       << " with CondSvc");
       }
     }
   }
   return sc;  
 }

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ trigChainsArePassed()

bool AthMonitorAlgorithm::trigChainsArePassed ( const std::vector< std::string > & vTrigNames ) const

inherited

Check whether triggers are passed.

For the event, use the trigger decision tool to check that at least one of the triggers listed in the supplied vector is passed.

Parameters

vTrigNames List of trigger names.

Returns: If empty input, default to true. If at least one trigger is specified, returns whether at least one trigger was passed.

Definition at line 194 of file AthMonitorAlgorithm.cxx.

                                                                                             {
  
   
   // If no triggers were given, return true.
   if (vTrigNames.empty()) return true;
   
   
   // Trigger: Check if this Algorithm is being run as an Express Stream job.
   // Events are entering the express stream are chosen randomly, and by chain,
   // Hence an additional check should be aplied to see if the chain(s)
   // monitored here are responsible for the event being selected for
   // the express stream.
  
   const auto group =  m_trigDecTool->getChainGroup(vTrigNames);
   if (m_enforceExpressTriggers){  
     const auto passedBits = m_trigDecTool->isPassedBits(group);
     bool expressPass = passedBits & TrigDefs::Express_passed; //bitwise AND
     if(!expressPass) {
       return false;
     }
   }
   
   // monitor the event if any of the chains in the chain group passes the event.
   return group->isPassed();
   
 }

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_BeamBackgroundDataKey

RHK<BeamBackgroundData> DQTBackgroundMon::m_BeamBackgroundDataKey {this, "BeamBackgroundDataKey", "BeamBackgroundData", ""}

private

Definition at line 43 of file DQTBackgroundMon.h.

◆ m_dataType

AthMonitorAlgorithm::DataType_t AthMonitorAlgorithm::m_dataType

protectedinherited

Instance of the DataType_t enum.

Definition at line 351 of file AthMonitorAlgorithm.h.

◆ m_dataTypeStr

Gaudi::Property<std::string> AthMonitorAlgorithm::m_dataTypeStr {this,"DataType","userDefined"}

protectedinherited

DataType string pulled from the job option and converted to enum.

Definition at line 353 of file AthMonitorAlgorithm.h.

◆ m_defaultLBDuration

Gaudi::Property<float> AthMonitorAlgorithm::m_defaultLBDuration {this,"DefaultLBDuration",60.}

protectedinherited

Default duration of one lumi block.

Definition at line 360 of file AthMonitorAlgorithm.h.

◆ m_detailLevel

Gaudi::Property<int> AthMonitorAlgorithm::m_detailLevel {this,"DetailLevel",0}

protectedinherited

Sets the level of detail used in the monitoring.

Definition at line 361 of file AthMonitorAlgorithm.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_doMuons

GP<bool> DQTBackgroundMon::m_doMuons {this, "Muons", true}

private

Definition at line 36 of file DQTBackgroundMon.h.

◆ m_DQFilterTools

ToolHandleArray<IDQFilterTool> AthMonitorAlgorithm::m_DQFilterTools {this,"FilterTools",{}}

protectedinherited

Array of Data Quality filter tools.

Definition at line 341 of file AthMonitorAlgorithm.h.

◆ m_dummy

const ToolHandle<GenericMonitoringTool> AthMonitorAlgorithm::m_dummy

privateinherited

Definition at line 369 of file AthMonitorAlgorithm.h.

◆ m_emptyBG

GP<int> DQTBackgroundMon::m_emptyBG {this, "EmptyBGIndex", 3}

private

Definition at line 56 of file DQTBackgroundMon.h.

◆ m_enforceExpressTriggers

Gaudi::Property<bool> AthMonitorAlgorithm::m_enforceExpressTriggers

privateinherited

Initial value:

{this,
                          "EnforceExpressTriggers", false,
                          "Requires that matched triggers made the event enter the express stream"}

Definition at line 372 of file AthMonitorAlgorithm.h.

◆ m_environment

AthMonitorAlgorithm::Environment_t AthMonitorAlgorithm::m_environment

protectedinherited

Instance of the Environment_t enum.

Definition at line 350 of file AthMonitorAlgorithm.h.

◆ m_environmentStr

Gaudi::Property<std::string> AthMonitorAlgorithm::m_environmentStr {this,"Environment","user"}

protectedinherited

Environment string pulled from the job option and converted to enum.

Definition at line 352 of file AthMonitorAlgorithm.h.

◆ m_eventInfoDecorKey

SG::ReadDecorHandleKey<xAOD::EventInfo> DQTBackgroundMon::m_eventInfoDecorKey

private

Initial value:

{this,"eventInfoDecorKey",
                                                               "EventInfo.backgroundWord",
                                                               "Key to enforce scheduling"}

Definition at line 48 of file DQTBackgroundMon.h.

◆ m_EventInfoKey

SG::ReadHandleKey<xAOD::EventInfo> AthMonitorAlgorithm::m_EventInfoKey {this,"EventInfoKey","EventInfo"}

protectedinherited

Key for retrieving EventInfo from StoreGate.

Definition at line 362 of file AthMonitorAlgorithm.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthReentrantAlgorithm::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 153 of file AthReentrantAlgorithm.h.

◆ m_fileKey

Gaudi::Property<std::string> AthMonitorAlgorithm::m_fileKey {this,"FileKey",""}

protectedinherited

Internal Athena name for file.

Definition at line 358 of file AthMonitorAlgorithm.h.

◆ m_filledBG

GP<int> DQTBackgroundMon::m_filledBG {this, "FilledBGIndex", 1}

private

Definition at line 55 of file DQTBackgroundMon.h.

◆ m_LArCollisionTimeKey

RHK<LArCollisionTime> DQTBackgroundMon::m_LArCollisionTimeKey {this, "LArCollisionTimeKey", "LArCollisionTime", ""}

private

Definition at line 39 of file DQTBackgroundMon.h.

◆ m_LArECSideCut

GP<int> DQTBackgroundMon::m_LArECSideCut {this, "LArECSideCut", 1}

private

Definition at line 63 of file DQTBackgroundMon.h.

◆ m_lbDurationDataKey

SG::ReadCondHandleKey<LBDurationCondData> AthMonitorAlgorithm::m_lbDurationDataKey {this,"LBDurationCondDataKey","LBDurationCondData","SG Key of LBDurationCondData object"}

protectedinherited

Definition at line 345 of file AthMonitorAlgorithm.h.

◆ m_LUCID_RawDataContainerKey

RHK<LUCID_RawDataContainer> DQTBackgroundMon::m_LUCID_RawDataContainerKey {this, "Lucid_RawDataKey","Lucid_RawData", ""}

private

Definition at line 42 of file DQTBackgroundMon.h.

◆ m_lumiDataKey

SG::ReadCondHandleKey<LuminosityCondData> AthMonitorAlgorithm::m_lumiDataKey {this,"LuminosityCondDataKey","LuminosityCondData","SG Key of LuminosityCondData object"}

protectedinherited

Definition at line 343 of file AthMonitorAlgorithm.h.

◆ m_MBTSCollisionTimeKey

RHK<MBTSCollisionTime> DQTBackgroundMon::m_MBTSCollisionTimeKey {this, "MBTSCollisionTimeKey", "MBTSCollisionTime", ""}

private

Definition at line 40 of file DQTBackgroundMon.h.

◆ m_MBTSMask

GP<int> DQTBackgroundMon::m_MBTSMask {this, "MBTSMask", TileCell::MASK_BADCH | TileCell::MASK_OVER | TileCell::MASK_TIME }

private

Definition at line 67 of file DQTBackgroundMon.h.

◆ m_MBTSPattern

GP<int> DQTBackgroundMon::m_MBTSPattern {this, "MBTSPattern", TileCell::MASK_TIME }

private

Definition at line 68 of file DQTBackgroundMon.h.

◆ m_MBTSSideCut

GP<int> DQTBackgroundMon::m_MBTSSideCut {this, "MBTSSideCut", 2}

private

Definition at line 64 of file DQTBackgroundMon.h.

◆ m_MBTSThresholdCut

GP<float> DQTBackgroundMon::m_MBTSThresholdCut {this, "MBTSThresholdCut", 40.0/222.0}

private

Definition at line 66 of file DQTBackgroundMon.h.

◆ m_MBTSTimeCut

GP<float> DQTBackgroundMon::m_MBTSTimeCut {this, "MBTSTimeCut", 15}

private

Definition at line 65 of file DQTBackgroundMon.h.

◆ m_name

std::string AthMonitorAlgorithm::m_name

privateinherited

Definition at line 366 of file AthMonitorAlgorithm.h.

◆ m_nBkgWords

GP<int> DQTBackgroundMon::m_nBkgWords {this, "NBkgWords", 32}

private

Definition at line 69 of file DQTBackgroundMon.h.

◆ m_pixSpacePointKey

RHK<SpacePointContainer> DQTBackgroundMon::m_pixSpacePointKey {this,"Pixel_SpacePointKey","PixelSpacePoints",""}

private

Definition at line 46 of file DQTBackgroundMon.h.

◆ m_sctSpacePointKey

RHK<SpacePointContainer> DQTBackgroundMon::m_sctSpacePointKey {this,"SCT_SpacePointKey","SCT_SpacePoints",""}

private

Definition at line 45 of file DQTBackgroundMon.h.

◆ m_TileCellContainerKey

RHK<TileCellContainer> DQTBackgroundMon::m_TileCellContainerKey {this, "MBTSContainerName", "MBTSContainer", ""}

private

Definition at line 41 of file DQTBackgroundMon.h.

◆ m_toolLookupMap

std::unordered_map<std::string, size_t> AthMonitorAlgorithm::m_toolLookupMap

privateinherited

Definition at line 367 of file AthMonitorAlgorithm.h.

◆ m_tools

ToolHandleArray<GenericMonitoringTool> AthMonitorAlgorithm::m_tools {this,"GMTools",{}}

protectedinherited

Array of Generic Monitoring Tools.

Definition at line 338 of file AthMonitorAlgorithm.h.

◆ m_trigDecTool

PublicToolHandle<Trig::TrigDecisionTool> AthMonitorAlgorithm::m_trigDecTool {this, "TrigDecisionTool",""}

protectedinherited

Tool to tell whether a specific trigger is passed.

Definition at line 340 of file AthMonitorAlgorithm.h.

◆ m_triggerChainString

Gaudi::Property<std::string> AthMonitorAlgorithm::m_triggerChainString {this,"TriggerChain",""}

protectedinherited

Trigger chain string pulled from the job option and parsed into a vector.

Definition at line 355 of file AthMonitorAlgorithm.h.

◆ m_trigLiveFractionDataKey

SG::ReadCondHandleKey<TrigLiveFractionCondData> AthMonitorAlgorithm::m_trigLiveFractionDataKey {this,"TrigLiveFractionCondDataKey","TrigLiveFractionCondData", "SG Key of TrigLiveFractionCondData object"}

protectedinherited

Definition at line 347 of file AthMonitorAlgorithm.h.

◆ m_unpairIsoBG

GP<int> DQTBackgroundMon::m_unpairIsoBG {this, "UnpairIsoBGIndex", 4}

private

Definition at line 57 of file DQTBackgroundMon.h.

◆ m_unpairNonIsoBG

GP<int> DQTBackgroundMon::m_unpairNonIsoBG {this, "UnpairNonIsoBGIndex", 5}

private

Definition at line 58 of file DQTBackgroundMon.h.

◆ m_upPixSP

GP<int> DQTBackgroundMon::m_upPixSP {this, "UpPixSP", 5000}

private

Definition at line 61 of file DQTBackgroundMon.h.

◆ m_upSctSP

GP<int> DQTBackgroundMon::m_upSctSP {this, "UpSctSP", 10000}

private

Definition at line 62 of file DQTBackgroundMon.h.

◆ m_useLumi

Gaudi::Property<bool> AthMonitorAlgorithm::m_useLumi {this,"EnableLumi",false}

protectedinherited

Allows use of various luminosity functions.

Definition at line 359 of file AthMonitorAlgorithm.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_VertexContainerKey

RHK<xAOD::VertexContainer> DQTBackgroundMon::m_VertexContainerKey {this, "PrimaryVerticesKey", "PrimaryVertices", ""}

private

Definition at line 44 of file DQTBackgroundMon.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ m_vTrigChainNames

std::vector<std::string> AthMonitorAlgorithm::m_vTrigChainNames

protectedinherited

Vector of trigger chain names parsed from trigger chain string.

Definition at line 356 of file AthMonitorAlgorithm.h.

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ GP

◆ MonVarVec_t

◆ RH

◆ RHK

◆ StoreGateSvc_t

Member Enumeration Documentation

◆ DataType_t

◆ Environment_t

Constructor & Destructor Documentation

◆ DQTBackgroundMon()

◆ ~DQTBackgroundMon()

Member Function Documentation

◆ cardinality()

◆ dataType()

◆ dataTypeStringToEnum()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ environment()

◆ envStringToEnum()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ fillHistograms()

◆ filterPassed()

◆ GetEventInfo()

◆ getGroup()

◆ getTrigDecisionTool()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ parseList()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ trigChainsArePassed()

◆ updateVHKA()

Member Data Documentation

◆ m_BeamBackgroundDataKey

◆ m_dataType

◆ m_dataTypeStr

◆ m_defaultLBDuration

◆ m_detailLevel

◆ m_detStore

◆ m_doMuons

◆ m_DQFilterTools

◆ m_dummy

◆ m_emptyBG

◆ m_enforceExpressTriggers

◆ m_environment

◆ m_environmentStr

◆ m_eventInfoDecorKey

◆ m_EventInfoKey

◆ m_evtStore