#include <PPMSimBSMonitorAlgorithm.h>

Inheritance diagram for PPMSimBSMonitorAlgorithm:

Collaboration diagram for PPMSimBSMonitorAlgorithm:

Classes
struct	MonitorTT
	Struct to contain PPM trigger tower info. More...

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

virtual	~PPMSimBSMonitorAlgorithm ()=default

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

Public Attributes
	flags

	MaxEvents

	GlobalTag

	Files

	HISTFileName

	acc

	PPMSimBSMonitorCfg

	withDetails

	True

	summariseProps

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
typedef std::vector< int >	ErrorVector

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

typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	makePPMTower (const xAOD::TriggerTower *tt, std::vector< MonitorTT > &vecMonTT) const
	Helper functions. More...

StatusCode	fillPPMEtaPhi (MonitorTT &monTT, const std::string &groupName, const std::string &weightName, double weight) const

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
StringProperty	m_packageName {this,"PackageName","PPMSimBSMonitor","group name for histogramming"}

SG::ReadHandleKey< xAOD::TriggerTowerContainer >	m_xAODTriggerTowerContainerName {this, "BS_xAODTriggerTowerContainer",LVL1::TrigT1CaloDefs::xAODTriggerTowerLocation,"Trigger Tower Container"}
	container keys including steering parameter and description More...

ToolHandle< LVL1::IL1TriggerTowerToolRun3 >	m_ttTool {this,"L1TriggerTowerToolRun3", "LVL1::L1TriggerTowerToolRun3/L1TriggerTowerToolRun3", "L1TriggerTowerToolRun3"}

Gaudi::Property< double >	m_phiScaleTT {this, "phiScaleTT", 32./M_PI, "Scale factor to convert trigger tower phi to integer binning"}
	Properties. More...

Gaudi::Property< int >	m_simulationADCCut {this, "SimulationADCCut", 36, "Minimum ADC cut to avoid unnecessary simulation"}

SG::WriteHandleKey< std::vector< int > >	m_errorLocation {this,"ErrorLocation","L1CaloPPMSimBSMismatchVector","ErrorVector"}

SG::ReadCondHandleKey< L1CaloRunParametersContainer >	m_runParametersContainer { this, "InputKeyRunParameters", "L1CaloRunParametersContainer"}

std::mutex	m_mutex {}

std::map< uint32_t, int > m_errorLB_tt_counter	ATLAS_THREAD_SAFE

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

Definition at line 21 of file PPMSimBSMonitorAlgorithm.h.

Member Typedef Documentation

◆ ErrorVector

typedef std::vector<int> PPMSimBSMonitorAlgorithm::ErrorVector

private

Definition at line 38 of file PPMSimBSMonitorAlgorithm.h.

◆ 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

◆ PPMSimBSMonitorAlgorithm()

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

Definition at line 9 of file PPMSimBSMonitorAlgorithm.cxx.

   : AthMonitorAlgorithm(name,pSvcLocator)
 {
 }

◆ ~PPMSimBSMonitorAlgorithm()

virtual PPMSimBSMonitorAlgorithm::~PPMSimBSMonitorAlgorithm ( )

virtualdefault

Member Function Documentation

◆ cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality

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 75 of file AthCommonReentrantAlgorithm.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 & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 94 of file AthCommonReentrantAlgorithm.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 BaseAlg::extraOutputDeps();
 }

◆ fillHistograms()

StatusCode PPMSimBSMonitorAlgorithm::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 33 of file PPMSimBSMonitorAlgorithm.cxx.

                                                                                    {
  
   ATH_MSG_DEBUG("PPMSimBSMonitorAlgorithm::fillHistograms");
   
  
   // Retrieve L1CaloRunParametersContainer
   SG::ReadCondHandle<L1CaloRunParametersContainer> runParameters( m_runParametersContainer, ctx);
   unsigned int readoutConfigID   = runParameters->runParameters(1)->readoutConfigID(); 
   ATH_MSG_DEBUG("RunParameters:: readoutConfigID " <<  readoutConfigID);
   
   // Retrieve Trigger Towers from SG
   SG::ReadHandle<xAOD::TriggerTowerContainer> triggerTowerTES(m_xAODTriggerTowerContainerName, ctx);
   if(!triggerTowerTES.isValid()){
     ATH_MSG_ERROR("No Trigger Tower container found in TES  "<< m_xAODTriggerTowerContainerName); 
     return StatusCode::FAILURE;
   }
  
   // Create a vector of trigger towers with quantities to be monitored
   std::vector<MonitorTT> vecMonTT;     // All towers
  
   const int nCrates = 8;
   ErrorVector crateError(nCrates);
   ErrorVector moduleError(nCrates);
  
   bool error_tt{false};
  
   // PPM sim vectors 
   std::vector<int> LutCp; 
   std::vector<int> LutJep; 
   std::vector<int> BcidR;
   std::vector<int> BcidD;
  
   // Loop over trigger tower container
   // Create the trigger tower objects and calculate scaled phi
   for (const xAOD::TriggerTower* tt : *triggerTowerTES) {
     ATH_CHECK( makePPMTower(tt, vecMonTT) );     
   }
  
   
   std::vector<std::string> mismatch_map= {"NonZeroMatches", "ZeroMatches", "DataNoSim", "SimNoData"};
   std::vector<std::string> lut_map= { "SimEqData", "SimNeData", "SimNoData", "DataNoSim"};
   std::vector<std::string> crate_map= { "cr0cr1", "cr2cr3", "cr4cr5", "cr6cr7"};
  
   // set maximum number of error events per lumiblock(per type) to avoid histograms with many x-bins
   const int maxErrorsPerLB=10;
   
   auto lb = GetEventInfo(ctx)->lumiBlock();
   ATH_MSG_DEBUG("Lumi Block" << lb); 
   const long long eventNumber =  ctx.eventID().event_number();
   ATH_MSG_DEBUG("Event Number" << eventNumber); 
  
   
   
   // Loop over the trigger tower objects and fill the histograms 
  
   for (auto& myTower : vecMonTT) {
     ATH_MSG_DEBUG("PPMSimBSMonitorAlgorithm looping over TTs"); 
     const L1CaloCoolChannelId coolId((myTower.tower)->coolId());
     const int datCp =   (myTower.tower)->cpET();
     const int datJep =  (myTower.tower)->lut_jep().empty() ? 0 :  (myTower.tower)->jepET();
     bool pedCorrOverflow = false;
     const std::size_t nPedCorr =  (myTower.tower)->correction().size();
     int simCp = 0;
     int simJep = 0;
     int simBcid = 0;
     uint8_t datBcid = 0;
     std::vector<uint8_t> datBcidVec = ( (myTower.tower)->bcidVec());
     if ( datBcidVec.size() > 0) {
       datBcid = datBcidVec[ (myTower.tower)->peak()];
     }
     
    
  
     //Retrieve RunParameters container from COOL database and check if run was taken with 80MHz readout. If yes, drop the 80MHz samples to emulate 40 MHz readout
     std::vector<uint16_t> digits40;
  
     if(readoutConfigID==5 or readoutConfigID==6){
  
       int nSlices = (myTower.tower)->adc().size();
  
       if((nSlices%4)==3){
     for (int i=0 ; i < (nSlices-1)/2 ; i++ ){
       digits40.push_back((myTower.tower)->adc().at(2*i+1));
     }
       }
       else if((nSlices%4)==1){
     for (int i=0 ; i <= (nSlices-1)/2 ; i++ ){
       digits40.push_back((myTower.tower)->adc().at(2*i));
     }
       }
  
     }else{
       digits40 = (myTower.tower)->adc();
     }
  
     const std::vector<uint_least16_t>& ADC = digits40;
     const int Slices = ADC.size();
     const int Peak = Slices/2.;
  
     //Check for over-/underflow of pedestalCorrection
     for(std::size_t i = 0; i < nPedCorr; ++i) {
     if((myTower.tower)->correction()[i]>=511 or (myTower.tower)->correction()[i]<=-512){
         pedCorrOverflow = true;
         break;
        }
     }
  
  
     // only run simulation for non-empty TTs
     if(datCp || datJep || *std::max_element(std::begin(ADC), std::end(ADC)) >= m_simulationADCCut) {
       BcidR.clear();
       BcidD.clear();
       m_ttTool->simulateChannel(*(myTower.tower), LutCp, LutJep, BcidR, BcidD);
       simBcid = BcidR[Peak];
       if (Slices < 7 || nPedCorr < 3) {
     simJep = LutJep[Peak];
     simCp = LutCp[Peak];
       }
     }
     
  
     
    // ---------------------Fill in error plots------------------------
     int mismatch = 0;
  
     std::string groupName = "group_Mismatch_peakf_"; 
     
     if (datCp || datJep || *std::max_element(std::begin(ADC), std::end(ADC)) >= m_simulationADCCut) {
       std::bitset<3> simBcidBits(simBcid);
       std::bitset<3> datBcidBits(datBcid);
       if ((Slices >= 7) && (nPedCorr >= 3)) { // compare simulation of peak finder to data (sim not possible in 5+1 readout mode)
         if (simBcidBits[2] && datBcidBits[2]) { //non-zero match
       ATH_CHECK( fillPPMEtaPhi(myTower, groupName + mismatch_map.at(0), "", 1) );
     } 
     else if (!simBcidBits[2] && !datBcidBits[2]) { // zero match
       ATH_CHECK( fillPPMEtaPhi(myTower, groupName + mismatch_map.at(1), "", 1) );
     } 
     else if (simBcidBits[2] != datBcidBits[2]) { // mismatch
           mismatch = 1;
           if (!simBcidBits[2]) { //data no sim
         ATH_CHECK( fillPPMEtaPhi(myTower, groupName + mismatch_map.at(2), "", 1) );
           }
       else if (!datBcidBits[2]) { //sim no data
         ATH_CHECK( fillPPMEtaPhi(myTower, groupName + mismatch_map.at(3), "", 1) );
           }
       if (mismatch>0) {
         ATH_MSG_DEBUG("PeakfinderBCID sim/data Mismatch coolId/sim/dat: "
               << std::hex <<coolId.id() << std::dec << "/" << simBcidBits[2] << "/" << datBcidBits[2]);
       }
         } 
       }
     
  
  
       groupName = "group_Mismatch_satBcid_"; 
  
       if (ADC[0] < 1020 && ADC[1] < 1020) { // compare simulation of saturated bcid algorithm to data
         if (simBcidBits[1] && datBcidBits[1]) { // non-zero match
       ATH_CHECK( fillPPMEtaPhi(myTower, groupName + mismatch_map.at(0), "", 1) );
     } 
     else if (!simBcidBits[1] && !datBcidBits[1]) { // zero match
       ATH_CHECK( fillPPMEtaPhi(myTower, groupName + mismatch_map.at(1), "", 1) );
         } 
     else if (simBcidBits[1] != datBcidBits[1]) { // mismatch
           mismatch = 1;
           if (!simBcidBits[1]) { // data no sim
         ATH_CHECK( fillPPMEtaPhi(myTower, groupName + mismatch_map.at(2), "", 1) );
         mismatch=0;
           } 
       else if (!datBcidBits[1]) { // sim no data
         ATH_CHECK( fillPPMEtaPhi(myTower, groupName + mismatch_map.at(3), "", 1) );
       }
       if (mismatch>0) {
         ATH_MSG_DEBUG("SaturatedBCID sim/data Mismatch coolId/sim/dat: "
               << std::hex <<coolId.id() << std::dec << "/" << simBcidBits[1] << "/" << datBcidBits[1]);
       }
     }
       }
     }
  
         
     // Compare LUT simulation to data
     // only fill histograms for non-empty towers (simulation or data)
     if (!simCp && !datCp && !simJep && !datJep) continue;
  
     
     groupName = "groupLUTCP_EM_"; 
     if ( (myTower.tower)->layer() == 0) { // For EM layer
       // For LUT-CP
       if (simCp && simCp == datCp) { // non-zero match
     ATH_CHECK( fillPPMEtaPhi(myTower, groupName + lut_map.at(0), "", 1) );
       } 
       else if (simCp != datCp && !pedCorrOverflow) {  // mis-match
         mismatch = 1;
         if (simCp && datCp) {       // non-zero mis-match
       ATH_CHECK( fillPPMEtaPhi(myTower, groupName + lut_map.at(1), "", 1) );
         } 
     else if (!datCp) {        // no data
           if ((Slices >= 7) && (nPedCorr >= 3)) {
         ATH_CHECK( fillPPMEtaPhi(myTower, groupName + lut_map.at(2), "", 1) );
           } 
       else mismatch = 0;
         } 
     else {                    // no sim
       ATH_CHECK( fillPPMEtaPhi(myTower, groupName + lut_map.at(3), "", 1) );
         }
     if (mismatch>0) {
       ATH_MSG_DEBUG("EMTowerMismatch coolId/simCp/datCp: "
             << std::hex <<coolId.id() << std::dec << "/" << simCp << "/" << datCp);
     }
       }
       
  
       groupName = "groupLUTJEP_EM_"; 
  
       if (simJep && simJep == datJep) { // non-zero match
     ATH_CHECK( fillPPMEtaPhi(myTower, groupName + lut_map.at(0), "", 1) );
       } 
       else if (simJep != datJep && !pedCorrOverflow) {  // mis-match
         mismatch = 1;
         if (simJep && datJep) {       // non-zero mis-match
       ATH_CHECK( fillPPMEtaPhi(myTower, groupName + lut_map.at(1), "", 1) );
         } 
     else if (!datJep) {        // no data
       if ((Slices >= 7) && (nPedCorr >= 3)) {
         ATH_CHECK( fillPPMEtaPhi(myTower, groupName + lut_map.at(2), "", 1) );
           } 
       else mismatch = 0;
         } 
     else { 
       // no sim
       ATH_CHECK( fillPPMEtaPhi(myTower, groupName + lut_map.at(3), "", 1) );
         }
     if (mismatch>0) {
       ATH_MSG_DEBUG("EMTowerMismatch coolId/simJep/datJep: "
             << std::hex <<coolId.id() << std::dec << "/" << simJep << "/" << datJep);
     }
       }
     }
  
  
     // For HAD layer
     groupName = "groupLUTCP_HAD_"; 
         
     if ((myTower.tower)->layer() == 1) { // For HAD layer
       // For LUT-CP
       if (simCp && simCp == datCp) { // non-zero match
     ATH_CHECK( fillPPMEtaPhi(myTower, groupName + lut_map.at(0), "", 1) );
       } 
       else if (simCp != datCp  && !pedCorrOverflow ) {  // mis-match
         mismatch = 1;
         if (simCp && datCp) {       // non-zero mis-match
       ATH_CHECK( fillPPMEtaPhi(myTower, groupName + lut_map.at(1), "", 1) );
     } 
     else if (!datCp) {        // no data
       if ((Slices >= 7) && (nPedCorr >= 3)) {
         ATH_CHECK( fillPPMEtaPhi(myTower, groupName + lut_map.at(2), "", 1) );
           } 
       else mismatch = 0;
         } 
     else {                    // no sim
       ATH_CHECK( fillPPMEtaPhi(myTower, groupName + lut_map.at(3), "", 1) );
         }
     if (mismatch>0) {
       ATH_MSG_DEBUG("HADTowerMismatch coolId/simCp/datCp: "
             << std::hex <<coolId.id() << std::dec << "/" << simCp << "/" << datCp);
     }
       }
             
       // For LUT-JEP
       groupName = "groupLUTJEP_HAD_"; 
  
       if (simJep && simJep == datJep) { // non-zero match
     ATH_CHECK( fillPPMEtaPhi(myTower, groupName + lut_map.at(0), "", 1) );
       } 
       else if (simJep != datJep  && !pedCorrOverflow ) {  // mis-match
         mismatch = 1;
         if (simJep && datJep) {       // non-zero mis-match
       ATH_CHECK( fillPPMEtaPhi(myTower, groupName + lut_map.at(1), "", 1) );
     } 
     else if (!datJep) {        // no data
           if ((Slices >= 7) && (nPedCorr >= 3)) {
         ATH_CHECK( fillPPMEtaPhi(myTower, groupName + lut_map.at(2), "", 1) );
           } 
       else mismatch = 0;
         } 
     else {                    // no sim
       ATH_CHECK( fillPPMEtaPhi(myTower, groupName + lut_map.at(3), "", 1) );
  
         }
     if (mismatch>0) {
       ATH_MSG_DEBUG("HADTowerMismatch coolId/simJep/datJep: "
             << std::hex <<coolId.id() << std::dec << "/" << simJep << "/" << datJep);
     }
       }
     }
     
  
  
  
    
     groupName = "group_Error_";    
  
     
     // scope for mutable error event per lumi block tt counter
         
    
     
     if (mismatch == 1) {
       std::lock_guard<std::mutex> lock(m_mutex);
       const int crate  = coolId.crate();
       const int module = coolId.module();
       crateError[crate] = 1;
       if (!error_tt) {
         m_errorLB_tt_counter[lb]+=1;
         error_tt = true;
       }
       if (!((moduleError[crate] >> module) & 0x1)) {
     const int y = module + 16 * (crate % 2);
     auto y_2D = Monitored::Scalar<int>("y_2D", y);
     if (m_errorLB_tt_counter[lb]<=maxErrorsPerLB) {
       auto  eventMonitor= Monitored::Scalar<std::string>("eventMonitor", std::to_string(eventNumber));
       if     (crate == 0 || crate == 1) fill(groupName +  crate_map.at(0), eventMonitor, y_2D );
       else if (crate == 2 || crate == 3) fill(groupName +  crate_map.at(1), eventMonitor, y_2D );
       else if (crate == 4 || crate == 5) fill(groupName +  crate_map.at(2), eventMonitor, y_2D ); 
       else if (crate == 6 || crate == 7) fill(groupName +  crate_map.at(3), eventMonitor, y_2D ); 
       moduleError[crate] |= (1 << module);
     }
       }
     }
     
     
  
   } // End loop over tower objects 
  
   
     // Save error vector for global summary
   {
     auto save = std::make_unique<ErrorVector>(crateError);
     auto* result = SG::makeHandle(m_errorLocation, ctx).put(std::move(save));
     if (!result) {
       ATH_MSG_ERROR("Error recording PPMSimBS mismatch vector in TES");
       return StatusCode::FAILURE;
     }
   }
  
  
   return StatusCode::SUCCESS;
 }

◆ fillPPMEtaPhi()

StatusCode PPMSimBSMonitorAlgorithm::fillPPMEtaPhi	(	MonitorTT &	monTT,
		const std::string &	groupName,
		const std::string &	weightName,
		double	weight
	)		const

private

Definition at line 410 of file PPMSimBSMonitorAlgorithm.cxx.

                                                                 {
   
   // Number of bins filled in phi depends on eta due to electronics coverage
  
   // KW to do: fill in shrinkEtaBins part
   double phiMod = monTT.phiScaled;  // Integer binning for 2D plots 
   double etaMod = monTT.tower->eta();
   const double absEta = std::abs(etaMod);
   
   const std::vector<double> offset32 = {1.5, 0.5, -0.5, -1.5};                                                                             
   const std::vector<double> offset25 = {0.5, -0.5}; 
   std::vector<double> offset = {}; 
     
   if (absEta > 3.2) {
     // Fill four bins in phi
     phiMod = std::floor(phiMod/4)*4. + 2.;
     offset = offset32;
   } 
   else if (absEta > 2.5) {
     // Fill two bins in phi
     phiMod = std::floor(phiMod/2)*2. + 1.;
     offset = offset25;
   }     
   else {
     offset = {0.};
   }
  
   // Fill the histograms 
   for (auto phiOffset : offset)  {
  
     auto etaTT_2D = Monitored::Scalar<double>("etaTT_2D", etaMod);
     auto phiTT_2D = Monitored::Scalar<double>("phiTT_2D", phiMod + phiOffset);
     
     auto weight_2D = Monitored::Scalar<double>(weightName, weight); // Weight for filling 2D profile histograms; name must be included in python histogram definition
     
     fill(groupName, etaTT_2D, phiTT_2D, weight_2D);
     
   }      
  
   return StatusCode::SUCCESS;
 } 

◆ filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.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 {
       // treat empty tool handle case as in Monitored::Group
       if (m_toolLookupMap.empty()) {
     return m_dummy;
       }
  
       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 194 of file AthMonitorAlgorithm.cxx.

                                                                                        {
     return m_trigDecTool;
 }

◆ initialize()

StatusCode PPMSimBSMonitorAlgorithm::initialize ( )

overridevirtual

initialize

Returns: StatusCode

Reimplemented from AthMonitorAlgorithm.

Definition at line 14 of file PPMSimBSMonitorAlgorithm.cxx.

                                                 {
  
   ATH_MSG_DEBUG("PPMSimBSMonitorAlgorithm::initialize");
   ATH_MSG_DEBUG("Package Name "<< m_packageName);
   ATH_MSG_DEBUG("m_xAODTriggerTowerContainerName "<< m_xAODTriggerTowerContainerName); 
  
   // we initialise all the containers that we need
   ATH_CHECK( AthMonitorAlgorithm::initialize() );
   ATH_CHECK( m_xAODTriggerTowerContainerName.initialize() );
  
   
   ATH_CHECK( m_ttTool.retrieve());
   ATH_CHECK( m_runParametersContainer.initialize() );
   
   ATH_CHECK(m_errorLocation.initialize());
  
   return StatusCode::SUCCESS;
 }

◆ 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 AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

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

◆ makePPMTower()

StatusCode PPMSimBSMonitorAlgorithm::makePPMTower	(	const xAOD::TriggerTower *	tt,
		std::vector< MonitorTT > &	vecMonTT
	)		const

private

Helper functions.

Definition at line 384 of file PPMSimBSMonitorAlgorithm.cxx.

 {
   // Geometry
   const double phi = tt->phi();
   double phiMod = phi * m_phiScaleTT;
   
   // LUT JEP
   int jepET = 0;
   const std::vector<uint_least8_t> jepETvec = tt->lut_jep();
   if (jepETvec.size() > 0) jepET = tt->jepET();
   
  
   // Fill TT quantities
   MonitorTT monTT;
   monTT.tower = tt;
   monTT.phiScaled = phiMod;
   monTT.jepET = jepET;
   monTT.phi1d = 0;
   monTT.maxADC = 0;
   vecMonTT.push_back(monTT);
    
   return StatusCode::SUCCESS; 
 }

◆ 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 341 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 AthCommonReentrantAlgorithm< Gaudi::Algorithm >::setFilterPassed	(	bool	state,
		const EventContext &	ctx
	)		const

inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

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

◆ sysExecute()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::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 85 of file AthCommonReentrantAlgorithm.cxx.

 {
   return BaseAlg::sysExecute (ctx);
 }

◆ sysInitialize()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::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 61 of file AthCommonReentrantAlgorithm.cxx.

                                                                {
   StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::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 199 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

◆ acc

PPMSimBSMonitorAlgorithm.acc

Definition at line 162 of file PPMSimBSMonitorAlgorithm.py.

◆ ATLAS_THREAD_SAFE

std::map<uint32_t, int> m_errorLB_tt_counter PPMSimBSMonitorAlgorithm::ATLAS_THREAD_SAFE

mutableprivate

Definition at line 72 of file PPMSimBSMonitorAlgorithm.h.

◆ Files

PPMSimBSMonitorAlgorithm.Files

Definition at line 153 of file PPMSimBSMonitorAlgorithm.py.

◆ flags

PPMSimBSMonitorAlgorithm.flags

Definition at line 150 of file PPMSimBSMonitorAlgorithm.py.

◆ GlobalTag

PPMSimBSMonitorAlgorithm.GlobalTag

Definition at line 152 of file PPMSimBSMonitorAlgorithm.py.

◆ HISTFileName

PPMSimBSMonitorAlgorithm.HISTFileName

Definition at line 155 of file PPMSimBSMonitorAlgorithm.py.

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

SG::WriteHandleKey<std::vector<int> > PPMSimBSMonitorAlgorithm::m_errorLocation {this,"ErrorLocation","L1CaloPPMSimBSMismatchVector","ErrorVector"}

private

Definition at line 54 of file PPMSimBSMonitorAlgorithm.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 AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

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

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.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_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_mutex

std::mutex PPMSimBSMonitorAlgorithm::m_mutex {}

mutableprivate

Definition at line 71 of file PPMSimBSMonitorAlgorithm.h.

◆ m_name

std::string AthMonitorAlgorithm::m_name

privateinherited

Definition at line 366 of file AthMonitorAlgorithm.h.

◆ m_packageName

StringProperty PPMSimBSMonitorAlgorithm::m_packageName {this,"PackageName","PPMSimBSMonitor","group name for histogramming"}

private

Definition at line 40 of file PPMSimBSMonitorAlgorithm.h.

◆ m_phiScaleTT

Gaudi::Property<double> PPMSimBSMonitorAlgorithm::m_phiScaleTT {this, "phiScaleTT", 32./M_PI, "Scale factor to convert trigger tower phi to integer binning"}

private

Properties.

Definition at line 48 of file PPMSimBSMonitorAlgorithm.h.

◆ m_runParametersContainer

SG::ReadCondHandleKey<L1CaloRunParametersContainer> PPMSimBSMonitorAlgorithm::m_runParametersContainer { this, "InputKeyRunParameters", "L1CaloRunParametersContainer"}

private

Definition at line 58 of file PPMSimBSMonitorAlgorithm.h.

◆ m_simulationADCCut

Gaudi::Property<int> PPMSimBSMonitorAlgorithm::m_simulationADCCut {this, "SimulationADCCut", 36, "Minimum ADC cut to avoid unnecessary simulation"}

private

Definition at line 49 of file PPMSimBSMonitorAlgorithm.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_ttTool

ToolHandle<LVL1::IL1TriggerTowerToolRun3> PPMSimBSMonitorAlgorithm::m_ttTool {this,"L1TriggerTowerToolRun3", "LVL1::L1TriggerTowerToolRun3/L1TriggerTowerToolRun3", "L1TriggerTowerToolRun3"}

private

Definition at line 45 of file PPMSimBSMonitorAlgorithm.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.

◆ m_xAODTriggerTowerContainerName

SG::ReadHandleKey<xAOD::TriggerTowerContainer> PPMSimBSMonitorAlgorithm::m_xAODTriggerTowerContainerName {this, "BS_xAODTriggerTowerContainer",LVL1::TrigT1CaloDefs::xAODTriggerTowerLocation,"Trigger Tower Container"}

private

container keys including steering parameter and description

Definition at line 43 of file PPMSimBSMonitorAlgorithm.h.

◆ MaxEvents

PPMSimBSMonitorAlgorithm.MaxEvents

Definition at line 151 of file PPMSimBSMonitorAlgorithm.py.

◆ PPMSimBSMonitorCfg

PPMSimBSMonitorAlgorithm.PPMSimBSMonitorCfg

Definition at line 166 of file PPMSimBSMonitorAlgorithm.py.

◆ summariseProps

PPMSimBSMonitorAlgorithm.summariseProps

Definition at line 170 of file PPMSimBSMonitorAlgorithm.py.

◆ True

PPMSimBSMonitorAlgorithm.True

Definition at line 170 of file PPMSimBSMonitorAlgorithm.py.

◆ withDetails

PPMSimBSMonitorAlgorithm.withDetails

Definition at line 170 of file PPMSimBSMonitorAlgorithm.py.

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

Classes

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ErrorVector

◆ MonVarVec_t

◆ StoreGateSvc_t

Member Enumeration Documentation

◆ DataType_t

◆ Environment_t

Constructor & Destructor Documentation

◆ PPMSimBSMonitorAlgorithm()

◆ ~PPMSimBSMonitorAlgorithm()

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

◆ fillPPMEtaPhi()

◆ filterPassed()

◆ GetEventInfo()

◆ getGroup()

◆ getTrigDecisionTool()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ makePPMTower()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ parseList()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ trigChainsArePassed()

◆ updateVHKA()

Member Data Documentation

◆ acc

◆ ATLAS_THREAD_SAFE

◆ Files

◆ flags

◆ GlobalTag

◆ HISTFileName

◆ m_dataType

◆ m_dataTypeStr

◆ m_defaultLBDuration

◆ m_detailLevel

◆ m_detStore

◆ m_DQFilterTools

◆ m_dummy

◆ m_enforceExpressTriggers