CaloClusterCellMonAlg Class Reference

#include <CaloClusterCellMonAlg.h>

Inheritance diagram for CaloClusterCellMonAlg:

Collaboration diagram for CaloClusterCellMonAlg:

Public Types
enum class	Environment_t {   user = 0 , online , tier0 , tier0Raw ,   tier0ESD , AOD , altprod }
	Specifies the processing environment. More...
enum class	DataType_t {   userDefined = 0 , monteCarlo , collisions , cosmics ,   heavyIonCollisions }
	Specifies what type of input data is being monitored. More...

Public Member Functions
	~CaloClusterCellMonAlg ()=default
virtual StatusCode	initialize () override final
	initialize
virtual StatusCode	fillHistograms (const EventContext &ctx) const override final
	adds event to the monitoring histograms
	CaloMonAlgBase (const std::string &name, ISvcLocator *pSvcLocator)
StatusCode	checkFilters (bool &ifPass, bool &passBeamBackgroundRemoval, const std::string &MonGroupName, const EventContext &ctx) const
virtual StatusCode	execute (const EventContext &ctx) const override
	Applies filters and trigger requirements.
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.
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.
template<typename... T>
void	fill (const ToolHandle< GenericMonitoringTool > &groupHandle, T &&... variables) const
	Fills a variadic list of variables to a group by reference.
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.
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.
template<typename... T>
void	fill (const std::string &groupName, T &&... variables) const
	Fills a variadic list of variables to a group by name.
Environment_t	environment () const
	Accessor functions for the environment.
Environment_t	envStringToEnum (const std::string &str) const
	Convert the environment string from the python configuration to an enum object.
DataType_t	dataType () const
	Accessor functions for the data type.
DataType_t	dataTypeStringToEnum (const std::string &str) const
	Convert the data type string from the python configuration to an enum object.
const ToolHandle< GenericMonitoringTool > &	getGroup (const std::string &name) const
	Get a specific monitoring tool from the tool handle array.
const ToolHandle< Trig::TrigDecisionTool > &	getTrigDecisionTool () const
	Get the trigger decision tool member.
bool	trigChainsArePassed (const std::vector< std::string > &vTrigNames) const
	Check whether triggers are passed.
SG::ReadHandle< xAOD::EventInfo >	GetEventInfo (const EventContext &) const
	Return a ReadHandle for an EventInfo object (get run/event numbers, etc.)
virtual float	lbAverageInteractionsPerCrossing (const EventContext &ctx=Gaudi::Hive::currentContext()) const
	Calculate the average mu, i.e.
virtual float	lbInteractionsPerCrossing (const EventContext &ctx=Gaudi::Hive::currentContext()) const
	Calculate instantaneous number of interactions, i.e.
virtual float	lbAverageLuminosity (const EventContext &ctx=Gaudi::Hive::currentContext()) const
	Calculate average luminosity (in ub-1 s-1 => 10^30 cm-2 s-1).
virtual float	lbLuminosityPerBCID (const EventContext &ctx=Gaudi::Hive::currentContext()) const
	Calculate the instantaneous luminosity per bunch crossing.
virtual double	lbDuration (const EventContext &ctx=Gaudi::Hive::currentContext()) const
	Calculate the duration of the luminosity block (in seconds)
virtual float	lbAverageLivefraction (const EventContext &ctx=Gaudi::Hive::currentContext()) const
	Calculate the average luminosity livefraction.
virtual float	livefractionPerBCID (const EventContext &ctx=Gaudi::Hive::currentContext()) const
	Calculate the live fraction per bunch crossing ID.
virtual double	lbLumiWeight (const EventContext &ctx=Gaudi::Hive::currentContext()) const
	Calculate the average integrated luminosity multiplied by the live fraction.
virtual StatusCode	parseList (const std::string &line, std::vector< std::string > &result) const
	Parse a string into a vector.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Public Attributes
	flags = initConfigFlags()
	Files
	GlobalTag
	AtlasVersion
	HISTFileName
	enableLumiAccess
	useTrigger
	Environment
	Run
	NumThreads
	cfg = MainServicesCfg(flags)
	tdm = CompFactory.getComp('TrigDec::TrigDecisionMakerMT')()
	doL1
	doHLT

Protected Types
enum	LayerEnum {   EMBPA =0 , EMBPC , EMB1A , EMB1C ,   EMB2A , EMB2C , EMB3A , EMB3C ,   HEC0A , HEC0C , HEC1A , HEC1C ,   HEC2A , HEC2C , HEC3A , HEC3C ,   EMECPA , EMECPC , EMEC1A , EMEC1C ,   EMEC2A , EMEC2C , EMEC3A , EMEC3C ,   FCAL1A , FCAL1C , FCAL2A , FCAL2C ,   FCAL3A , FCAL3C , MAXLAYER }
enum	LayerEnumNoSides {   EMBPNS =0 , EMB1NS , EMB2NS , EMB3NS ,   HEC0NS , HEC1NS , HEC2NS , HEC3NS ,   EMECPNS , EMEC1NS , EMEC2NS , EMEC3NS ,   FCAL1NS , FCAL2NS , FCAL3NS , MAXLYRNS }

Protected Member Functions
void	getHistoCoordinates (const CaloDetDescrElement *dde, float &celleta, float &cellphi, unsigned &iLyr, unsigned &iLyrNS) const
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.

Protected Attributes
const CaloCell_ID *	m_calo_id {nullptr}
const std::map< unsigned, LayerEnumNoSides >	m_caloSamplingToLyrNS
ToolHandleArray< GenericMonitoringTool >	m_tools {this,"GMTools",{}}
	Array of Generic Monitoring Tools.
PublicToolHandle< Trig::TrigDecisionTool >	m_trigDecTool
	Tool to tell whether a specific trigger is passed.
ToolHandleArray< IDQFilterTool >	m_DQFilterTools {this,"FilterTools",{}}
	Array of Data Quality filter tools.
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.
AthMonitorAlgorithm::DataType_t	m_dataType
	Instance of the DataType_t enum.
Gaudi::Property< std::string >	m_environmentStr {this,"Environment","user"}
	Environment string pulled from the job option and converted to enum.
Gaudi::Property< std::string >	m_dataTypeStr {this,"DataType","userDefined"}
	DataType string pulled from the job option and converted to enum.
Gaudi::Property< std::string >	m_triggerChainString {this,"TriggerChain",""}
	Trigger chain string pulled from the job option and parsed into a vector.
std::vector< std::string >	m_vTrigChainNames
	Vector of trigger chain names parsed from trigger chain string.
Gaudi::Property< std::string >	m_fileKey {this,"FileKey",""}
	Internal Athena name for file.
Gaudi::Property< bool >	m_useLumi {this,"EnableLumi",false}
	Allows use of various luminosity functions.
Gaudi::Property< float >	m_defaultLBDuration {this,"DefaultLBDuration",60.}
	Default duration of one lumi block.
Gaudi::Property< int >	m_detailLevel {this,"DetailLevel",0}
	Sets the level of detail used in the monitoring.
SG::ReadHandleKey< xAOD::EventInfo >	m_EventInfoKey {this,"EventInfoKey","EventInfo"}
	Key for retrieving EventInfo from StoreGate.

Private Types
enum	TriggerType {   RNDM , CALO , MINBIAS , MET ,   MISC , NOTA , MAXTRIGTYPE }
enum	PartitionEnum {   EMBA , EMBC , EMECA , EMECC ,   HECA , HECC , FCALA , FCALC ,   MAXPARTITIONS }
typedef std::vector< std::reference_wrapper< Monitored::IMonitoredVariable > >	MonVarVec_t
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

Private Attributes
SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_clusterContainerKey {this,"CaloClusterContainer","CaloTopoClusters","SG key of the input cluster container"}
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloMgrKey {this,"CaloDetDescrManager", "CaloDetDescrManager", "SG Key for CaloDetDescrManager in the Condition Store" }
SG::ReadCondHandleKey< LArOnOffIdMapping >	m_cablingKey {this,"CablingKey","LArOnOffIdMap","SG Key of LArOnOffIdMapping object"}
Gaudi::Property< std::string >	m_MonGroupName {this, "MonGroupName", "CaloClusterCellMonGroup"}
StringArrayProperty	m_layerNames
BooleanProperty	m_useTrigger {this, "useTrigger", true}
std::array< StringProperty, NOTA >	m_triggerNames
BooleanArrayProperty	m_doBeamBackgroundRemovalProp {this, "DoBeamBackgroundRemoval"}
Gaudi::Property< float >	m_clusterECut {this,"ClusterEnergyCut",std::numeric_limits<float>::lowest()}
Gaudi::Property< unsigned >	m_nCellsPerCluster {this,"nCellsPerCluster",1,"Monitor the N highest-energy-cells of each cluster (0: all cells)"}
const LArOnlineID *	m_onlineID {nullptr}
const std::array< std::string, 9 >	m_tileNames
SG::ReadHandleKey< LArCollisionTime >	m_LArCollisionTimeKey {this,"LArCollisionTimeKey","LArCollisionTime"}
SG::ReadHandleKey< BeamBackgroundData >	m_beamBackgroundKey {this,"BeamBackgroundKey","CSCBackgroundForCaloMon"}
bool	m_useBadLBTool
ToolHandle< IDQFilterTool >	m_BadLBTool {this, "DQBadLBFilterTool","DQBadLBFilterTool"}
bool	m_useReadyFilterTool
ToolHandle< IDQFilterTool >	m_ReadyFilterTool {this, "DQAtlasReadyFilterTool", "DQAtlasReadyFilterTool"}
bool	m_useLArNoisyAlg
bool	m_useCollisionFilterTool
bool	m_useBeamBackgroundRemoval
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.
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 23 of file CaloClusterCellMonAlg.h.

Member Typedef Documentation

MonVarVec_t

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

privateinherited

Definition at line 370 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 class 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 194 of file AthMonitorAlgorithm.h.

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

Environment_t

enum class 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 175 of file AthMonitorAlgorithm.h.

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

LayerEnum

enum CaloMonAlgBase::LayerEnum

protectedinherited

Enumerator
EMBPA
EMBPC
EMB1A
EMB1C
EMB2A
EMB2C
EMB3A
EMB3C
HEC0A
HEC0C
HEC1A
HEC1C
HEC2A
HEC2C
HEC3A
HEC3C
EMECPA
EMECPC
EMEC1A
EMEC1C
EMEC2A
EMEC2C
EMEC3A
EMEC3C
FCAL1A
FCAL1C
FCAL2A
FCAL2C
FCAL3A
FCAL3C
MAXLAYER

Definition at line 48 of file CaloMonAlgBase.h.

                {EMBPA=0, EMBPC, EMB1A, EMB1C, EMB2A, EMB2C, EMB3A, EMB3C,
         HEC0A, HEC0C, HEC1A, HEC1C, HEC2A, HEC2C, HEC3A, HEC3C,
         EMECPA,EMECPC,EMEC1A,EMEC1C,EMEC2A,EMEC2C,EMEC3A,EMEC3C,
         FCAL1A,FCAL1C,FCAL2A,FCAL2C,FCAL3A,FCAL3C,MAXLAYER};

LayerEnumNoSides

enum CaloMonAlgBase::LayerEnumNoSides

protectedinherited

Enumerator
EMBPNS
EMB1NS
EMB2NS
EMB3NS
HEC0NS
HEC1NS
HEC2NS
HEC3NS
EMECPNS
EMEC1NS
EMEC2NS
EMEC3NS
FCAL1NS
FCAL2NS
FCAL3NS
MAXLYRNS

Definition at line 54 of file CaloMonAlgBase.h.

                       {EMBPNS=0, EMB1NS, EMB2NS, EMB3NS, HEC0NS, HEC1NS, HEC2NS, HEC3NS,
            EMECPNS,EMEC1NS,EMEC2NS,EMEC3NS,FCAL1NS,FCAL2NS,FCAL3NS,MAXLYRNS};

PartitionEnum

enum CaloClusterCellMonAlg::PartitionEnum

private

Enumerator
EMBA
EMBC
EMECA
EMECC
HECA
HECC
FCALA
FCALC
MAXPARTITIONS

Definition at line 70 of file CaloClusterCellMonAlg.h.

{EMBA,EMBC,EMECA,EMECC,HECA,HECC,FCALA,FCALC,MAXPARTITIONS};

TriggerType

enum CaloClusterCellMonAlg::TriggerType

private

Enumerator
RNDM
CALO
MINBIAS
MET
MISC
NOTA
MAXTRIGTYPE

Definition at line 53 of file CaloClusterCellMonAlg.h.

{RNDM,CALO,MINBIAS,MET,MISC,NOTA,MAXTRIGTYPE};

Constructor & Destructor Documentation

~CaloClusterCellMonAlg()

CaloClusterCellMonAlg::~CaloClusterCellMonAlg ( )

default

Member Function Documentation

CaloMonAlgBase()

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

Definition at line 16 of file CaloMonAlgBase.cxx.

  :AthMonitorAlgorithm(name, pSvcLocator)
 {
  declareProperty("useBadLBTool", m_useBadLBTool=false);
  declareProperty("BadLBTool", m_BadLBTool);
 
  declareProperty("useReadyFilterTool",m_useReadyFilterTool=true);
  declareProperty("ReadyFilterTool",m_ReadyFilterTool);
 
  declareProperty("useLArCollisionFilterTool",m_useCollisionFilterTool=true);
 
  declareProperty("useLArNoisyAlg",m_useLArNoisyAlg=false);
 
  declareProperty("useBeamBackgroundRemoval",m_useBeamBackgroundRemoval=false);
}

cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::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 75 of file AthCommonReentrantAlgorithm.cxx.

{
  return 0;
}

checkFilters()

StatusCode CaloMonAlgBase::checkFilters ( bool & ifPass, bool & passBeamBackgroundRemoval, const std::string & MonGroupName, const EventContext & ctx ) const

inherited

Definition at line 59 of file CaloMonAlgBase.cxx.

                                                                                                                                                  {
 
  ATH_MSG_DEBUG("CaloMonAlgBase:checkFilters() starts "<<MonGroupName);
 
  auto evtbin = Monitored::Scalar<int>("EvtBin",1);
  fill(MonGroupName,evtbin);
 
  ifPass = 0;   
  if (m_useReadyFilterTool) {
    if (m_ReadyFilterTool->accept()) {
      ifPass = 1;
      evtbin = 2;
      fill(MonGroupName,evtbin); //All events with ATLAS Ready
    }
  }
  else{
    evtbin = 2;
    fill(MonGroupName,evtbin); //ATLAS ready not activated
    ifPass = 1;
  }
 
  ATH_MSG_DEBUG("CaloMonAlgBase::checkFilters()  ATLAS Ready done");
 
  SG::ReadHandle<xAOD::EventInfo> eventInfo{GetEventInfo(ctx)};
 
  if (m_useBadLBTool) {
    if (m_BadLBTool->accept()) { 
      ifPass = ifPass && 1;
      if(ifPass) {evtbin=3; fill(MonGroupName,evtbin);} //All events with ATLAS Ready and Good LB
    }
    else {
      ifPass = 0;
    }
  }
  else{
    if(ifPass) {evtbin=3; fill(MonGroupName,evtbin);} 
  }
 
  ATH_MSG_DEBUG("CaloMonAlgBase::checkFilters() BadLBTool  done");
 
  // Filter the events identfied as collision by the LAr system
  // Useful in CosmicCalo to reject collision candidates
  if (m_useCollisionFilterTool){
    SG::ReadHandle<LArCollisionTime> larTime{m_LArCollisionTimeKey,ctx};
    if(!larTime.isValid()){
      ATH_MSG_WARNING("Unable to retrieve LArCollisionTime event store");
      if(ifPass) {evtbin=4; fill(MonGroupName,evtbin);} 
    }
    else {
      if (larTime->timeC()!=0 && larTime->timeA()!=0 && std::fabs(larTime->timeC() - larTime->timeA())<10)  {
    ifPass = 0;
      }
      else { 
    ifPass = ifPass && 1;
    if(ifPass) {evtbin=4; fill(MonGroupName,evtbin);} //All events with ATLAS Ready and Good LB and Good LAr collision time
      }
    }
  }
  else{
    if(ifPass) {evtbin=4; fill(MonGroupName,evtbin);} 
  }
  ATH_MSG_DEBUG("CaloMonAlgBase::checkFilters() CollisionFilterTool  done");
 
 
  passBeamBackgroundRemoval=true;
  if(m_useBeamBackgroundRemoval){
    SG::ReadHandle<BeamBackgroundData> beamBackgroundData{m_beamBackgroundKey, ctx};
    if(!beamBackgroundData.isValid()){
      ATH_MSG_WARNING("Unable to retrieve BeamBackgroundData");
    }
    else {
      if( beamBackgroundData->GetNumSegment() > 0 ) {
        passBeamBackgroundRemoval = false;
    ifPass = 0;
        ATH_MSG_DEBUG("Identified background event");
      }
      else {
        passBeamBackgroundRemoval = true;
        ifPass = ifPass && 1;
        if(ifPass){evtbin=5; fill(MonGroupName,evtbin);}  //All events with ATLAS Ready and Good LB and Good LAr collision time and not Beam Background
      }
    }
  }
  else {  // Do not use BeamBackgroundRemoval
    ifPass = ifPass && 1;
    if(ifPass) {evtbin=5; fill(MonGroupName,evtbin);}  //All events with ATLAS Ready and Good LB and Good LAr collision time and not Beam Background
  
  }
  ATH_MSG_DEBUG("CaloMonAlgBase::checkFilters() m_useBeamBackgroundRemoval  done");
 
  std::string TheTrigger;
  if ( m_vTrigChainNames.empty()) {  
    TheTrigger="NoTrigSel";
    ifPass = ifPass && 1; // No Trigger Filter check
    if(ifPass) {evtbin=6; fill(MonGroupName,evtbin);} //All events with ATLAS Ready and Good LB and Good LAr collision time and not Beam Background and Trigger Filter pass
  }
  else {
    TheTrigger = m_triggerChainString; // Trigger Filter not implemented ++ FIXME ==
    if(ifPass) {evtbin=6; fill(MonGroupName,evtbin);}  
  }
 
  if(m_useLArNoisyAlg && (eventInfo->errorState(xAOD::EventInfo::LAr) == xAOD::EventInfo::Error)) {
    ifPass = 0;
  }
  else {
    ifPass = ifPass && 1;
    if(ifPass) {evtbin=7; fill(MonGroupName,evtbin);} //All events with ATLAS Ready and Good LB and Good LAr collision time and not Beam Background and Trigger Filter pass and no Lar Error
  }
 
  ATH_MSG_DEBUG("CaloMonAlgBase::checkFilters() is done");
  return StatusCode::SUCCESS;
}

checkTrigger()

void CaloClusterCellMonAlg::checkTrigger ( ) const

private

Definition at line 44 of file CaloClusterCellMonAlg.cxx.

                                               {
 
  auto mon_trig = Monitored::Scalar<float>("trigType",-1);
  mon_trig=0.5;
  fill(m_MonGroupName,mon_trig);
 
  const ToolHandle<Trig::TrigDecisionTool>& trigTool = getTrigDecisionTool();
  if (m_useTrigger && !trigTool.empty()) {
    for (unsigned i=0;i<m_triggerNames.size();++i) {
      const std::string& chainName=m_triggerNames[i];
      if(!chainName.empty()) {
        const Trig::ChainGroup* cg = trigTool->getChainGroup(chainName);
        if(cg->isPassed()) {
          mon_trig=0.5+i;
          fill(m_MonGroupName,mon_trig);
        }
      }
    }//end of loop over trigger types
 
  } //end if trigger used
  else {
    mon_trig=6.5;
    fill(m_MonGroupName,mon_trig);
  } 
}

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 224 of file AthMonitorAlgorithm.h.

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

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & 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());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & 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.

{ 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 208 of file AthMonitorAlgorithm.h.

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

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.

{ 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 77 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 ( ) const

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

finaloverridevirtual

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 74 of file CaloClusterCellMonAlg.cxx.

                                                                             {  
 
  ATH_MSG_DEBUG("CaloClusterCellMonAlg::fillHistograms() starts");
 
  SG::ReadCondHandle<CaloDetDescrManager> caloMgrHandle{m_caloMgrKey, ctx};
  ATH_CHECK(caloMgrHandle.isValid());
  const CaloDetDescrManager* caloDDMgr = *caloMgrHandle;
 
  SG::ReadCondHandle<LArOnOffIdMapping> cablingHdl{m_cablingKey, ctx};
  const LArOnOffIdMapping* cabling{*cablingHdl};
 
  SG::ReadHandle<xAOD::CaloClusterContainer> clusterHdl{m_clusterContainerKey, ctx};
 
  bool ifPass = true;
  bool passBeamBackgroundRemoval = true;
  ATH_CHECK(checkFilters(ifPass,passBeamBackgroundRemoval,m_MonGroupName,ctx)); //Check ATLAS-Ready, beam-background, etc from base class
  if(!ifPass) return StatusCode::SUCCESS;
 
  auto eventCounter = Monitored::Scalar<size_t>("eventCounter",0);
  fill(m_MonGroupName,eventCounter);
 
  checkTrigger();
 
  IdentifierHash larCellMin, larCellMax;
  m_calo_id->calo_cell_hash_range(CaloCell_ID::LARFCAL, larCellMin,larCellMax); // hash-end of FCAL is also the hash-end of LAr
  std::vector<unsigned> hitMap(m_calo_id->calo_cell_hash_max(), 0);
  std::vector<std::pair<IdentifierHash, float> > clusteredCells;
  for (const xAOD::CaloCluster* cluster : *clusterHdl) {
    if (cluster->e() < m_clusterECut)
      continue;
    // Loop over cells in cluster:
    auto cellIt = cluster->cell_begin();
    auto cellIt_e = cluster->cell_end();
    clusteredCells.clear();
    clusteredCells.reserve(cluster->size());
    for (; cellIt != cellIt_e; ++cellIt) {
      const IdentifierHash hash = cellIt->caloDDE()->calo_hash();
      if (hash < hitMap.size()) {
        const float cellE = cellIt->energy();
        clusteredCells.emplace_back(std::make_pair(hash, cellE));
      }
    }  // end loop over cells in cluster
    // Sort & filter list of cells in this cluster if needed:
    if (m_nCellsPerCluster > 0 && m_nCellsPerCluster < clusteredCells.size()) {
      auto middle = clusteredCells.begin() + m_nCellsPerCluster;
      // sort per cell energy
      std::partial_sort(clusteredCells.begin(), middle, clusteredCells.end(),
                        [](const std::pair<IdentifierHash, float>& p1,
                           const std::pair<IdentifierHash, float>& p2) {
                          return (p1.second > p2.second);
                        });
      // Shrink container to required cells
      clusteredCells.resize(m_nCellsPerCluster);
    }  // end if m_nClusteredCells>0
    for (const auto& cc : clusteredCells) {
      ++hitMap[cc.first];
    }  // end loop over clusteredCells
  }  // end loop over clusteres
 
  for (const CaloDetDescrElement* caloDDE : caloDDMgr->element_range()) {
    const IdentifierHash h=caloDDE->calo_hash();
    if (h<hitMap.size() && hitMap[h]) {
      float celleta, cellphi;
      unsigned iLyr, iLyrNS;
      std::string layerName;
      if (h<larCellMax) {
        //LAr Cells
        getHistoCoordinates(caloDDE, celleta, cellphi, iLyr, iLyrNS);
        layerName=m_layerNames[iLyr];
    const HWIdentifier chid=cabling->createSignalChannelID(caloDDE->identify());
    const IdentifierHash onlHash=m_onlineID->channel_Hash(chid);
    auto mon_id = Monitored::Scalar<unsigned>("larhash",onlHash);
    fill(m_MonGroupName,mon_id);
      }
      else {
        //Tile cells
        celleta=caloDDE->eta_raw();
        cellphi=caloDDE->phi_raw();
        iLyr=caloDDE->getSampling();
        if (iLyr<12 || iLyr>20 ) {
           ATH_MSG_ERROR("Unexpected tile sampling " << iLyr);
        }
        layerName=m_tileNames[iLyr-12];
        layerName += (celleta>0) ? "A" : "C";
        auto mon_tileOnl = Monitored::Scalar<unsigned>("tilehash",caloDDE->onl1());
        fill(m_MonGroupName,mon_tileOnl);
        //Fill also hash of second Tile PMT (if present):
        if (caloDDE->onl2() != 64000) {
          mon_tileOnl=caloDDE->onl2();
          fill(m_MonGroupName,mon_tileOnl);
        }
      }
      auto mon_eta = Monitored::Scalar<float>("celleta_"+layerName,celleta);
      auto mon_phi = Monitored::Scalar<float>("cellphi_"+layerName,cellphi);
      auto mon_hit = Monitored::Scalar<unsigned>("NClusteredCells_"+layerName,hitMap[h]);
      
 
 
      fill(m_MonGroupName,mon_eta,mon_phi,mon_hit);
    }//end if cell used in a cluster
  }
  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 111 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 168 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;
}

getHistoCoordinates()

void CaloMonAlgBase::getHistoCoordinates ( const CaloDetDescrElement * dde, float & celleta, float & cellphi, unsigned & iLyr, unsigned & iLyrNS ) const

protectedinherited

Definition at line 174 of file CaloMonAlgBase.cxx.

                                                                                                                                               {
  
  celleta=dde->eta_raw();
  cellphi=dde->phi_raw();
  
  int calosample=dde->getSampling();
  if (dde->is_lar_em_endcap_inner()) calosample-=1; //Here, we consider the two layers of the EMEC IW as EME1 and EME2 instad of layer 2 and 3
  iLyrNS=m_caloSamplingToLyrNS.at(calosample); //will throw if out of bounds
  if ((iLyrNS==EMB1NS || iLyrNS==EMB2NS) && m_calo_id->region(dde->identify())==1) {
    //We are in the awkward region 1 of the EM Barrel
    //Looking at the image at http://atlas.web.cern.ch/Atlas/GROUPS/LIQARGEXT/TDR/figures6/figure6-17.eps
    //may be useful to understand what's going on here. 
 
    //In brief: Region 1, layer 1 is closer related ot the middle compartment (aka layer 2)
    //          and region 1, layer 2 closer related to the back compartment (aka layer 3)
    iLyrNS+=1;
 
    //Layer 2: 0<eta<1.4 + 1.4<eta<1.475, deta = 0.025. 3 rows of cells from region 1
    //Layer 3: 0<eta<1.35 (deta=0.050) +  1.4<eta<1.475 (deta = 0.075).  1 row of cell from region 1 with different dEta
  }
  
  const unsigned side=(celleta>0) ? 0 : 1; //Value >0 means A-side
  iLyr=iLyrNS*2+side;  
  }

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 198 of file AthMonitorAlgorithm.cxx.

                                                                                       {
    return m_trigDecTool;
}

initialize()

StatusCode CaloClusterCellMonAlg::initialize ( )

finaloverridevirtual

initialize

Returns

StatusCode

Reimplemented from CaloMonAlgBase.

Definition at line 20 of file CaloClusterCellMonAlg.cxx.

                                             {
 
  ATH_MSG_DEBUG("CaloClusterCellMonAlg::initialize() start");
 
  // Initialize superclass
  ATH_CHECK( CaloMonAlgBase::initialize() );
 
  ATH_CHECK(detStore()->retrieve(m_onlineID, "LArOnlineID")); 
  ATH_CHECK( m_caloMgrKey.initialize() );
  ATH_CHECK( m_cablingKey.initialize() );
  ATH_CHECK( m_clusterContainerKey.initialize() );
 
  //JobO consistency check:
  if (m_useTrigger && std::all_of(m_triggerNames.begin(),m_triggerNames.end(),[](const std::string& trigName){return trigName.empty();})) {
      ATH_MSG_WARNING("UseTrigger set to true but no trigger names given! Forcing useTrigger to false");
      m_useTrigger=false;
  }
 
  ATH_MSG_DEBUG("CaloClusterCellMonAlg::initialize() is done!");
 
  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 ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

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

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

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

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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 345 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 HypoBase, and InputMakerBase.

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

AtlasVersion

CaloClusterCellMonAlg.AtlasVersion

Definition at line 178 of file CaloClusterCellMonAlg.py.

cfg

CaloClusterCellMonAlg.cfg = MainServicesCfg(flags)

Definition at line 193 of file CaloClusterCellMonAlg.py.

doHLT

CaloClusterCellMonAlg.doHLT

Definition at line 210 of file CaloClusterCellMonAlg.py.

doL1

CaloClusterCellMonAlg.doL1

Definition at line 209 of file CaloClusterCellMonAlg.py.

enableLumiAccess

CaloClusterCellMonAlg.enableLumiAccess

Definition at line 181 of file CaloClusterCellMonAlg.py.

Environment

CaloClusterCellMonAlg.Environment

Definition at line 183 of file CaloClusterCellMonAlg.py.

Files

CaloClusterCellMonAlg.Files

Definition at line 176 of file CaloClusterCellMonAlg.py.

flags

CaloClusterCellMonAlg.flags = initConfigFlags()

Definition at line 174 of file CaloClusterCellMonAlg.py.

GlobalTag

CaloClusterCellMonAlg.GlobalTag

Definition at line 177 of file CaloClusterCellMonAlg.py.

HISTFileName

CaloClusterCellMonAlg.HISTFileName

Definition at line 180 of file CaloClusterCellMonAlg.py.

m_BadLBTool

ToolHandle<IDQFilterTool> CaloMonAlgBase::m_BadLBTool {this, "DQBadLBFilterTool","DQBadLBFilterTool"}

privateinherited

Definition at line 31 of file CaloMonAlgBase.h.

{this, "DQBadLBFilterTool","DQBadLBFilterTool"};

m_beamBackgroundKey

SG::ReadHandleKey<BeamBackgroundData> CaloMonAlgBase::m_beamBackgroundKey {this,"BeamBackgroundKey","CSCBackgroundForCaloMon"}

privateinherited

Definition at line 27 of file CaloMonAlgBase.h.

{this,"BeamBackgroundKey","CSCBackgroundForCaloMon"};

m_cablingKey

SG::ReadCondHandleKey<LArOnOffIdMapping> CaloClusterCellMonAlg::m_cablingKey {this,"CablingKey","LArOnOffIdMap","SG Key of LArOnOffIdMapping object"}

private

Definition at line 39 of file CaloClusterCellMonAlg.h.

{this,"CablingKey","LArOnOffIdMap","SG Key of LArOnOffIdMapping object"};

m_calo_id

const CaloCell_ID* CaloMonAlgBase::m_calo_id {nullptr}

protectedinherited

Definition at line 43 of file CaloMonAlgBase.h.

{nullptr};

m_caloMgrKey

SG::ReadCondHandleKey<CaloDetDescrManager> CaloClusterCellMonAlg::m_caloMgrKey {this,"CaloDetDescrManager", "CaloDetDescrManager", "SG Key for CaloDetDescrManager in the Condition Store" }

private

Definition at line 38 of file CaloClusterCellMonAlg.h.

{this,"CaloDetDescrManager", "CaloDetDescrManager", "SG Key for CaloDetDescrManager in the Condition Store" };

m_caloSamplingToLyrNS

const std::map<unsigned,LayerEnumNoSides> CaloMonAlgBase::m_caloSamplingToLyrNS

protectedinherited

Initial value:

{ 
    {CaloSampling::PreSamplerB, EMBPNS},{CaloSampling::EMB1,EMB1NS},{CaloSampling::EMB2,EMB2NS},{CaloSampling::EMB3,EMB3NS},         
    {CaloSampling::PreSamplerE, EMECPNS},{CaloSampling::EME1,EMEC1NS}, {CaloSampling::EME2,EMEC2NS}, {CaloSampling::EME3,EMEC3NS},   
    {CaloSampling::HEC0,HEC0NS}, {CaloSampling::HEC1,HEC1NS}, {CaloSampling::HEC2,HEC2NS}, {CaloSampling::HEC3,HEC3NS},              
    {CaloSampling::FCAL0,FCAL1NS}, {CaloSampling::FCAL1,FCAL2NS}, {CaloSampling::FCAL2,FCAL3NS}                                      
  }

Definition at line 60 of file CaloMonAlgBase.h.

                                                               { 
    {CaloSampling::PreSamplerB, EMBPNS},{CaloSampling::EMB1,EMB1NS},{CaloSampling::EMB2,EMB2NS},{CaloSampling::EMB3,EMB3NS},         //LAr Barrel
    {CaloSampling::PreSamplerE, EMECPNS},{CaloSampling::EME1,EMEC1NS}, {CaloSampling::EME2,EMEC2NS}, {CaloSampling::EME3,EMEC3NS},   //LAr Endcap     
    {CaloSampling::HEC0,HEC0NS}, {CaloSampling::HEC1,HEC1NS}, {CaloSampling::HEC2,HEC2NS}, {CaloSampling::HEC3,HEC3NS},              //Hadronic endcap
    {CaloSampling::FCAL0,FCAL1NS}, {CaloSampling::FCAL1,FCAL2NS}, {CaloSampling::FCAL2,FCAL3NS}                                      //FCAL
  };

m_clusterContainerKey

SG::ReadHandleKey<xAOD::CaloClusterContainer> CaloClusterCellMonAlg::m_clusterContainerKey {this,"CaloClusterContainer","CaloTopoClusters","SG key of the input cluster container"}

private

Definition at line 36 of file CaloClusterCellMonAlg.h.

{this,"CaloClusterContainer","CaloTopoClusters","SG key of the input cluster container"};

m_clusterECut

Gaudi::Property<float> CaloClusterCellMonAlg::m_clusterECut {this,"ClusterEnergyCut",std::numeric_limits<float>::lowest()}

private

Definition at line 66 of file CaloClusterCellMonAlg.h.

{this,"ClusterEnergyCut",std::numeric_limits<float>::lowest()};

m_dataType

AthMonitorAlgorithm::DataType_t AthMonitorAlgorithm::m_dataType

protectedinherited

Instance of the DataType_t enum.

Definition at line 356 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 358 of file AthMonitorAlgorithm.h.

{this,"DataType","userDefined"}; 

m_defaultLBDuration

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

protectedinherited

Default duration of one lumi block.

Definition at line 365 of file AthMonitorAlgorithm.h.

{this,"DefaultLBDuration",60.}; 

m_detailLevel

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

protectedinherited

Sets the level of detail used in the monitoring.

Definition at line 366 of file AthMonitorAlgorithm.h.

{this,"DetailLevel",0}; 

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_doBeamBackgroundRemovalProp

BooleanArrayProperty CaloClusterCellMonAlg::m_doBeamBackgroundRemovalProp {this, "DoBeamBackgroundRemoval"}

private

Definition at line 64 of file CaloClusterCellMonAlg.h.

{this, "DoBeamBackgroundRemoval"}; 

m_DQFilterTools

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

protectedinherited

Array of Data Quality filter tools.

Definition at line 346 of file AthMonitorAlgorithm.h.

{this,"FilterTools",{}}; 

m_dummy

const ToolHandle<GenericMonitoringTool> AthMonitorAlgorithm::m_dummy

privateinherited

Definition at line 374 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 377 of file AthMonitorAlgorithm.h.

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

m_environment

AthMonitorAlgorithm::Environment_t AthMonitorAlgorithm::m_environment

protectedinherited

Instance of the Environment_t enum.

Definition at line 355 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 357 of file AthMonitorAlgorithm.h.

{this,"Environment","user"}; 

m_EventInfoKey

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

protectedinherited

Key for retrieving EventInfo from StoreGate.

Definition at line 367 of file AthMonitorAlgorithm.h.

{this,"EventInfoKey","EventInfo"}; 

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 363 of file AthMonitorAlgorithm.h.

{this,"FileKey",""}; 

m_LArCollisionTimeKey

SG::ReadHandleKey<LArCollisionTime> CaloMonAlgBase::m_LArCollisionTimeKey {this,"LArCollisionTimeKey","LArCollisionTime"}

privateinherited

Definition at line 26 of file CaloMonAlgBase.h.

{this,"LArCollisionTimeKey","LArCollisionTime"};

m_layerNames

StringArrayProperty CaloClusterCellMonAlg::m_layerNames

private

Initial value:

{this, "LayerNames", {"EMBPA", "EMBPC", "EMB1A", "EMB1C", "EMB2A", "EMB2C", "EMB3A", "EMB3C",
                        "HEC0A", "HEC0C", "HEC1A", "HEC1C", "HEC2A", "HEC2C", "HEC3A", "HEC3C",
                        "EMECPA", "EMECPC", "EMEC1A", "EMEC1C", "EMEC2A", "EMEC2C", "EMEC3A", "EMEC3C", 
                        "FCAL1A", "FCAL1C", "FCAL2A", "FCAL2C", "FCAL3A", "FCAL3C"},
                                                       "Names of individual layers to monitor"}

Definition at line 44 of file CaloClusterCellMonAlg.h.

                                  {this, "LayerNames", {"EMBPA", "EMBPC", "EMB1A", "EMB1C", "EMB2A", "EMB2C", "EMB3A", "EMB3C",
                        "HEC0A", "HEC0C", "HEC1A", "HEC1C", "HEC2A", "HEC2C", "HEC3A", "HEC3C",
                        "EMECPA", "EMECPC", "EMEC1A", "EMEC1C", "EMEC2A", "EMEC2C", "EMEC3A", "EMEC3C", 
                        "FCAL1A", "FCAL1C", "FCAL2A", "FCAL2C", "FCAL3A", "FCAL3C"},
                                                       "Names of individual layers to monitor"};

m_lbDurationDataKey

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

protectedinherited

Definition at line 350 of file AthMonitorAlgorithm.h.

{this,"LBDurationCondDataKey","LBDurationCondData","SG Key of LBDurationCondData object"};

m_lumiDataKey

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

protectedinherited

Definition at line 348 of file AthMonitorAlgorithm.h.

{this,"LuminosityCondDataKey","LuminosityCondData","SG Key of LuminosityCondData object"};

m_MonGroupName

Gaudi::Property<std::string> CaloClusterCellMonAlg::m_MonGroupName {this, "MonGroupName", "CaloClusterCellMonGroup"}

private

Definition at line 41 of file CaloClusterCellMonAlg.h.

{this, "MonGroupName", "CaloClusterCellMonGroup"};

m_name

std::string AthMonitorAlgorithm::m_name

privateinherited

Definition at line 371 of file AthMonitorAlgorithm.h.

m_nCellsPerCluster

Gaudi::Property<unsigned> CaloClusterCellMonAlg::m_nCellsPerCluster {this,"nCellsPerCluster",1,"Monitor the N highest-energy-cells of each cluster (0: all cells)"}

private

Definition at line 67 of file CaloClusterCellMonAlg.h.

{this,"nCellsPerCluster",1,"Monitor the N highest-energy-cells of each cluster (0: all cells)"};

m_onlineID

const LArOnlineID* CaloClusterCellMonAlg::m_onlineID {nullptr}

private

Definition at line 74 of file CaloClusterCellMonAlg.h.

{nullptr};  

m_ReadyFilterTool

ToolHandle<IDQFilterTool> CaloMonAlgBase::m_ReadyFilterTool {this, "DQAtlasReadyFilterTool", "DQAtlasReadyFilterTool"}

privateinherited

Definition at line 33 of file CaloMonAlgBase.h.

{this, "DQAtlasReadyFilterTool", "DQAtlasReadyFilterTool"};

m_tileNames

const std::array<std::string,9> CaloClusterCellMonAlg::m_tileNames

private

Initial value:

{
        "TileBar0","TileBar1","TileBar2",
        "TileGap0","TileGap1","TileGap2",
        "TileExt0","TileExt1","TileExt2"}

Definition at line 76 of file CaloClusterCellMonAlg.h.

                                         {
        "TileBar0","TileBar1","TileBar2",
        "TileGap0","TileGap1","TileGap2",
        "TileExt0","TileExt1","TileExt2"};

m_toolLookupMap

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

privateinherited

Definition at line 372 of file AthMonitorAlgorithm.h.

m_tools

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

protectedinherited

Array of Generic Monitoring Tools.

Definition at line 341 of file AthMonitorAlgorithm.h.

{this,"GMTools",{}}; 

m_trigDecTool

PublicToolHandle<Trig::TrigDecisionTool> AthMonitorAlgorithm::m_trigDecTool

protectedinherited

Tool to tell whether a specific trigger is passed.

Definition at line 345 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 360 of file AthMonitorAlgorithm.h.

{this,"TriggerChain",""}; 

m_triggerNames

std::array<StringProperty,NOTA> CaloClusterCellMonAlg::m_triggerNames

private

Initial value:

{{{this,"rndmTriggerNames",""},
                                                 {this,"caloTriggerNames",""},
                         {this,"minBiasTriggerNames",""},
                         {this,"metTriggerNames",""},
                         {this,"miscTriggerNames",""}
    }}

Definition at line 56 of file CaloClusterCellMonAlg.h.

                                              {{{this,"rndmTriggerNames",""},
                                                 {this,"caloTriggerNames",""},
                         {this,"minBiasTriggerNames",""},
                         {this,"metTriggerNames",""},
                         {this,"miscTriggerNames",""}
    }};

m_trigLiveFractionDataKey

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

protectedinherited

Definition at line 352 of file AthMonitorAlgorithm.h.

{this,"TrigLiveFractionCondDataKey","TrigLiveFractionCondData", "SG Key of TrigLiveFractionCondData object"};

m_useBadLBTool

bool CaloMonAlgBase::m_useBadLBTool

privateinherited

Definition at line 30 of file CaloMonAlgBase.h.

m_useBeamBackgroundRemoval

bool CaloMonAlgBase::m_useBeamBackgroundRemoval

privateinherited

Definition at line 38 of file CaloMonAlgBase.h.

m_useCollisionFilterTool

bool CaloMonAlgBase::m_useCollisionFilterTool

privateinherited

Definition at line 37 of file CaloMonAlgBase.h.

m_useLArNoisyAlg

bool CaloMonAlgBase::m_useLArNoisyAlg

privateinherited

Definition at line 35 of file CaloMonAlgBase.h.

m_useLumi

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

protectedinherited

Allows use of various luminosity functions.

Definition at line 364 of file AthMonitorAlgorithm.h.

{this,"EnableLumi",false}; 

m_useReadyFilterTool

bool CaloMonAlgBase::m_useReadyFilterTool

privateinherited

Definition at line 32 of file CaloMonAlgBase.h.

m_useTrigger

BooleanProperty CaloClusterCellMonAlg::m_useTrigger {this, "useTrigger", true}

private

Definition at line 55 of file CaloClusterCellMonAlg.h.

{this, "useTrigger", true};

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 361 of file AthMonitorAlgorithm.h.

NumThreads

CaloClusterCellMonAlg.NumThreads

Definition at line 186 of file CaloClusterCellMonAlg.py.

Run

CaloClusterCellMonAlg.Run

Definition at line 185 of file CaloClusterCellMonAlg.py.

tdm

CaloClusterCellMonAlg.tdm = CompFactory.getComp('TrigDec::TrigDecisionMakerMT')()

Definition at line 208 of file CaloClusterCellMonAlg.py.

useTrigger

CaloClusterCellMonAlg.useTrigger

Definition at line 182 of file CaloClusterCellMonAlg.py.

---

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

• CaloClusterCellMonAlg.h
• CaloClusterCellMonAlg.py
• CaloClusterCellMonAlg.cxx