Base class from which analyzers can define a derived class to do specific analysis. More...

#include <TrigMuonMonitorAlgorithm.h>

Inherited by EFMuonMon, L1MuonMon, L2muCombMon, L2MuonSAIOMon, L2MuonSAMon, L2OverlapRemoverMon, MuonTriggerCount, TrigMuonEfficiencyMon, and TrigMuonTruthMon.

Collaboration diagram for TrigMuonMonitorAlgorithm:

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
	TrigMuonMonitorAlgorithm (const std::string &name, ISvcLocator *pSvcLocator)

virtual StatusCode	initialize () override
	initialize More...

virtual StatusCode	fillHistograms (const EventContext &ctx) const override
	Function that steers anlayses. 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
virtual bool	selectEvents () const
	Function that defines the event selection for anlayses User should reimlement in a subclass if needed. More...

virtual StatusCode	selectMuons (SG::ReadHandle< xAOD::MuonContainer > &muons, std::vector< const xAOD::Muon * > &probes) const
	Function that defines the event selection for anlayses Users should reimlement in a subclass if needed. More...

virtual StatusCode	fillVariables (const EventContext &ctx) const
	Function that fills variables by just retrieving containers of trigger objects. More...

virtual StatusCode	fillVariablesPerOfflineMuon (const EventContext &ctx, const xAOD::Muon *mu) const
	Function that fills variables that are compared to offline muons but the trigger chains are not specified. More...

virtual StatusCode	fillVariablesPerChain (const EventContext &ctx, const std::string &chain) const
	Function that fills variables of trigger objects associated to specified trigger chains. More...

virtual StatusCode	fillVariablesPerOfflineMuonPerChain (const EventContext &ctx, const xAOD::Muon *mu, const std::string &chain) const
	Function that fills variables of trigger objects associated to specified trigger chains comparing offline muons. More...

template<class T , class FUNCT >
StatusCode	fillVariablesRatioPlots (const EventContext &ctx, const xAOD::Muon *mu, std::string &&trigstep, xAOD::Muon::TrackParticleType type, FUNCT matchFunc) const
	Function that fills variables of ratio plots. More...

template<class T >
StatusCode	fillVariableEtaPhi (const EventContext &ctx, SG::ReadHandleKey< DataVector< T > > ReadHandleKey, std::string &&trigstep, std::tuple< bool, double, double >(PosFunc)(const T )=&TrigMuonMonitorAlgorithm::defaultPosFunc< T >) const
	Function that fills variables of etaphi2D plots. More...

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

Static Protected Member Functions
template<class T >
static std::tuple< bool, double, double >	defaultPosFunc (const T *trig)

Protected Attributes
ToolHandle< MuonMatchingTool >	m_matchTool {this, "MuonMatchingTool", "MuonMatchingTool", "Tool for matching offline and online objects"}

ToolHandle< CP::IMuonSelectionTool >	m_muonSelectionTool {this,"MuonSelectionTool","CP::MuonSelectionTool/MuonSelectionTool","MuonSelectionTool"}

SG::ReadHandleKey< xAOD::MuonContainer >	m_MuonContainerKey {this, "MuonContainerName", "Muons", "Offline muon container"}

Gaudi::Property< std::vector< std::string > >	m_monitored_chains {this, "MonitoredChains", {}, "Trigger chains that are monitored"}
	List of trigger chains that are monitored in `fillVariablesPerChain` and `fillVariablesPerOfflineMuonPerChain`. More...

Gaudi::Property< int >	m_muontype {this, "MuonType", xAOD::Muon::MuonType::Combined, "MuonType used for monitoring"}
	Requirement for the offline muon type considered in analyses. More...

Gaudi::Property< std::string >	m_group {this, "Group", "", "Histogram group"}
	Name of monitored group. More...

const float	m_ratio_measurement_threshold = 4
	Threshold for ratio measurement. More...

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

Base class from which analyzers can define a derived class to do specific analysis.

e.g. L2MuonSAMon is such a class already defined. Analyzers should define fillVariablesXXX functions and these functions are automatically called in the fillHistograms function. Analyzers can change selectEvents and selectMuons in their specific classes by overriding them if needed.

Todo:: Support monitoring algorithms using truth muons

Definition at line 22 of file TrigMuonMonitorAlgorithm.h.

Member Typedef Documentation

◆ MonVarVec_t

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

privateinherited

Definition at line 365 of file AthMonitorAlgorithm.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

◆ TrigMuonMonitorAlgorithm()

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

Definition at line 8 of file TrigMuonMonitorAlgorithm.cxx.

9 : AthMonitorAlgorithm(name, pSvcLocator)

10 {}

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

◆ defaultPosFunc()

template<class T >

static std::tuple<bool, double, double> TrigMuonMonitorAlgorithm::defaultPosFunc ( const T * trig )

inlinestaticprotected

◆ 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 TrigMuonMonitorAlgorithm::fillHistograms ( const EventContext & ctx ) const

overridevirtual

Function that steers anlayses.

It currently calles four types of analyses, fillVariables, fillVariablesPerOfflineMuon, fillVariablesPerChain and fillVariablesPerOfflineMuonPerChain that can be overridden in subclasses to do specific analyses.

See also: fillVariables, fillVariablesPerOfflineMuon, fillVariablesPerChain and fillVariablesPerOfflineMuonPerChain

Parameters

ctx	`EventContext` provided by athenaMT

Implements AthMonitorAlgorithm.

Definition at line 22 of file TrigMuonMonitorAlgorithm.cxx.

                                                                                    {
  
  
   bool passToMonitor = selectEvents();
  
   if(passToMonitor){
  
     ATH_CHECK(fillVariables(ctx));
  
     for(const std::string& chain : m_monitored_chains){
       ATH_CHECK( fillVariablesPerChain(ctx, chain) );
     }
  
  
     SG::ReadHandle<xAOD::MuonContainer> muons(m_MuonContainerKey, ctx);
     if (! muons.isValid() ) {
       ATH_MSG_ERROR("evtStore() does not contain muon Collection with name "<< m_MuonContainerKey);
       return StatusCode::FAILURE;
     }
     std::vector<const xAOD::Muon*> probes;
     ATH_CHECK(selectMuons(muons, probes));
  
     for(const xAOD::Muon* mu : probes){
       ATH_CHECK( fillVariablesPerOfflineMuon(ctx, mu) );
  
       for(const std::string& chain : m_monitored_chains){
     ATH_CHECK( fillVariablesPerOfflineMuonPerChain(ctx, mu, chain) );
       }
     }
  
   }
  
  
  
   return StatusCode::SUCCESS;
 }

◆ fillVariableEtaPhi()

template<class T >

StatusCode TrigMuonMonitorAlgorithm::fillVariableEtaPhi	(	const EventContext &	ctx,
		SG::ReadHandleKey< DataVector< T > >	ReadHandleKey,
		std::string &&	trigstep,
		std::tuple< bool, double, double >()(const T )	PosFunc = `&TrigMuonMonitorAlgorithm::defaultPosFunc< T >`
	)		const

protected

Function that fills variables of etaphi2D plots.

See also: TrigMuonMonitorAlgorithm.icc for the implementation

Parameters

ctx	`EventContext` provided by athenaMT
ReadHandleKey	SG::ReadHandleKey of online muon.
trigstep	trigger step
PosFunc	Function pointer that implements cuts for the online muon candidates.

◆ fillVariables()

StatusCode TrigMuonMonitorAlgorithm::fillVariables ( const EventContext & ctx ) const

protectedvirtual

Function that fills variables by just retrieving containers of trigger objects.

Users should reimlement in a subclass if needed.

See also: fillHistograms

Parameters

ctx	`EventContext` provided by athenaMT

Reimplemented in EFMuonMon, L2muCombMon, L2MuonSAMon, L1MuonMon, and MuonTriggerCount.

Definition at line 82 of file TrigMuonMonitorAlgorithm.cxx.

                                                                                {
   return StatusCode::SUCCESS;
 }

◆ fillVariablesPerChain()

StatusCode TrigMuonMonitorAlgorithm::fillVariablesPerChain	(	const EventContext &	ctx,
		const std::string &	chain
	)		const

protectedvirtual

Function that fills variables of trigger objects associated to specified trigger chains.

This is called in the for loop of trigger chains in fillHistograms. Users should reimlement in a subclass if needed.

See also: fillHistograms

Parameters

ctx	`EventContext` provided by athenaMT
chain	Trigger chain provided in @cfillHistograms

Reimplemented in TrigMuonTruthMon, L2MuonSAIOMon, EFMuonMon, L2muCombMon, L2MuonSAMon, and L2OverlapRemoverMon.

Definition at line 91 of file TrigMuonMonitorAlgorithm.cxx.

                                                                                                         {
   return StatusCode::SUCCESS;
 }

◆ fillVariablesPerOfflineMuon()

StatusCode TrigMuonMonitorAlgorithm::fillVariablesPerOfflineMuon	(	const EventContext &	ctx,
		const xAOD::Muon *	mu
	)		const

protectedvirtual

Function that fills variables that are compared to offline muons but the trigger chains are not specified.

This is called in the for loop of offline muons in fillHistograms. Users should reimlement in a subclass if needed.

See also: fillHistograms

Parameters

ctx	`EventContext` provided by athenaMT
mu	Pointer to an offline muon provided in `fillHistograms`

Reimplemented in EFMuonMon, L2muCombMon, and L2MuonSAMon.

Definition at line 87 of file TrigMuonMonitorAlgorithm.cxx.

                                                                                                               {
   return StatusCode::SUCCESS;
 }

◆ fillVariablesPerOfflineMuonPerChain()

StatusCode TrigMuonMonitorAlgorithm::fillVariablesPerOfflineMuonPerChain	(	const EventContext &	ctx,
		const xAOD::Muon *	mu,
		const std::string &	chain
	)		const

protectedvirtual

Function that fills variables of trigger objects associated to specified trigger chains comparing offline muons.

This is called in the for loop of trigger chains and offline muons in fillHistograms. Users should reimlement in a subclass if needed.

See also: fillHistograms

Parameters

ctx	`EventContext` provided by athenaMT
mu	Pointer to an offline muon provided in `fillHistograms`
chain	Trigger chain provided in `fillHistograms`

Reimplemented in TrigMuonEfficiencyMon, L2MuonSAIOMon, EFMuonMon, L2MuonSAMon, and L2muCombMon.

Definition at line 95 of file TrigMuonMonitorAlgorithm.cxx.

                                                                                                                                         {
   return StatusCode::SUCCESS;
 }

◆ fillVariablesRatioPlots()

template<class T , class FUNCT >

StatusCode TrigMuonMonitorAlgorithm::fillVariablesRatioPlots	(	const EventContext &	ctx,
		const xAOD::Muon *	mu,
		std::string &&	trigstep,
		xAOD::Muon::TrackParticleType	type,
		FUNCT	matchFunc
	)		const

protected

Function that fills variables of ratio plots.

See also: TrigMuonMonitorAlgorithm.icc for the implementation

Parameters

ctx	`EventContext` provided by athenaMT
mu	Pointer to an offline muon provided in `fillHistograms`
trigstep	trigger step
type	xAOD::Muon::TrackParticleType of offline muon
matchFunc	Function pointer that implements cuts for the online muon candidates gotten by ReadHandle.

◆ 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 TrigMuonMonitorAlgorithm::initialize ( )

overridevirtual

initialize

Returns: StatusCode

Reimplemented from AthMonitorAlgorithm.

Reimplemented in TrigMuonTruthMon, TrigMuonEfficiencyMon, L1MuonMon, L2MuonSAIOMon, EFMuonMon, L2muCombMon, and L2MuonSAMon.

Definition at line 13 of file TrigMuonMonitorAlgorithm.cxx.

                                                  {
   StatusCode sc = AthMonitorAlgorithm::initialize();
   ATH_CHECK( m_matchTool.retrieve() );
   ATH_CHECK( m_muonSelectionTool.retrieve() );
   ATH_CHECK( m_MuonContainerKey.initialize() );
   return sc;
 }

◆ 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, ITkStripCablingAlg, 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();
   }

◆ selectEvents()

bool TrigMuonMonitorAlgorithm::selectEvents ( ) const

protectedvirtual

Function that defines the event selection for anlayses User should reimlement in a subclass if needed.

Returns: True if the event is used for an analysis.

Reimplemented in TrigMuonEfficiencyMon.

Definition at line 65 of file TrigMuonMonitorAlgorithm.cxx.

                                                     {
   return true;
 }

◆ selectMuons()

StatusCode TrigMuonMonitorAlgorithm::selectMuons	(	SG::ReadHandle< xAOD::MuonContainer > &	muons,
		std::vector< const xAOD::Muon * > &	probes
	)		const

protectedvirtual

Function that defines the event selection for anlayses Users should reimlement in a subclass if needed.

Parameters

muons	Offline muons in the MuonContainer
probes	List of offline muons that are used in analyses

Reimplemented in TrigMuonEfficiencyMon.

Definition at line 70 of file TrigMuonMonitorAlgorithm.cxx.

                                                                                                                                    {
   for (const xAOD::Muon* mu : *muons) {
     if(mu->muonType()<=m_muontype && 
        (mu->author()==xAOD::Muon::Author::MuidCo || mu->author()==xAOD::Muon::Author::STACO) && 
        m_muonSelectionTool->getQuality(*mu)<=xAOD::Muon::Medium ){
       probes.push_back(mu);
     }
   }
   return StatusCode::SUCCESS;
 }

◆ 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_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_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_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_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_group

Gaudi::Property<std::string> TrigMuonMonitorAlgorithm::m_group {this, "Group", "", "Histogram group"}

protected

Name of monitored group.

Definition at line 141 of file TrigMuonMonitorAlgorithm.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_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_matchTool

ToolHandle<MuonMatchingTool> TrigMuonMonitorAlgorithm::m_matchTool {this, "MuonMatchingTool", "MuonMatchingTool", "Tool for matching offline and online objects"}

protected

Definition at line 129 of file TrigMuonMonitorAlgorithm.h.

◆ m_monitored_chains

Gaudi::Property<std::vector<std::string> > TrigMuonMonitorAlgorithm::m_monitored_chains {this, "MonitoredChains", {}, "Trigger chains that are monitored"}

protected

List of trigger chains that are monitored in fillVariablesPerChain and fillVariablesPerOfflineMuonPerChain.

Definition at line 137 of file TrigMuonMonitorAlgorithm.h.

◆ m_MuonContainerKey

SG::ReadHandleKey<xAOD::MuonContainer> TrigMuonMonitorAlgorithm::m_MuonContainerKey {this, "MuonContainerName", "Muons", "Offline muon container"}

protected

Definition at line 133 of file TrigMuonMonitorAlgorithm.h.

◆ m_muonSelectionTool

ToolHandle<CP::IMuonSelectionTool> TrigMuonMonitorAlgorithm::m_muonSelectionTool {this,"MuonSelectionTool","CP::MuonSelectionTool/MuonSelectionTool","MuonSelectionTool"}

protected

Definition at line 130 of file TrigMuonMonitorAlgorithm.h.

◆ m_muontype

Gaudi::Property<int> TrigMuonMonitorAlgorithm::m_muontype {this, "MuonType", xAOD::Muon::MuonType::Combined, "MuonType used for monitoring"}

protected

Requirement for the offline muon type considered in analyses.

Definition at line 139 of file TrigMuonMonitorAlgorithm.h.

◆ m_name

std::string AthMonitorAlgorithm::m_name

privateinherited

Definition at line 366 of file AthMonitorAlgorithm.h.

◆ m_ratio_measurement_threshold

const float TrigMuonMonitorAlgorithm::m_ratio_measurement_threshold = 4

protected

Threshold for ratio measurement.

Definition at line 144 of file TrigMuonMonitorAlgorithm.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_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_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

Static Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ MonVarVec_t

◆ StoreGateSvc_t

Member Enumeration Documentation

◆ DataType_t

◆ Environment_t

Constructor & Destructor Documentation

◆ TrigMuonMonitorAlgorithm()

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]

◆ defaultPosFunc()

◆ detStore()

◆ environment()

◆ envStringToEnum()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ fillHistograms()

◆ fillVariableEtaPhi()

◆ fillVariables()

◆ fillVariablesPerChain()

◆ fillVariablesPerOfflineMuon()

◆ fillVariablesPerOfflineMuonPerChain()

◆ fillVariablesRatioPlots()

◆ filterPassed()

◆ GetEventInfo()

◆ getGroup()

◆ getTrigDecisionTool()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ parseList()

◆ renounce()

◆ renounceArray()

◆ selectEvents()

◆ selectMuons()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ trigChainsArePassed()

◆ updateVHKA()

Member Data Documentation

◆ m_dataType

◆ m_dataTypeStr

◆ m_defaultLBDuration

◆ m_detailLevel

◆ m_detStore

◆ m_DQFilterTools

◆ m_dummy

◆ m_enforceExpressTriggers

◆ m_environment

◆ m_environmentStr