RatesAnalysisAlg Class Reference

virtual analysis class for performing rates studies on AOD Pure virtual base class for trigger rate studies on EnhancedBias or MC AOD files. More...

#include <RatesAnalysisAlg.h>

Inheritance diagram for RatesAnalysisAlg:

Public Types
enum	Method_t { kMANUAL , kAUTO , kEXISTING }
	Method by which the trigger pass/fail decision is calculated. More...

Public Member Functions
	RatesAnalysisAlg (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~RatesAnalysisAlg ()
virtual StatusCode	ratesInitialize ()=0
	To be implemented by the user.
virtual StatusCode	ratesExecute ()=0
	To be implemented by the user.
virtual StatusCode	ratesFinalize ()=0
	To be implemented by the user.
StatusCode	newTrigger (const std::string &name, const double prescale=1., const double expressPrescale=-1., const std::string &seedName="", const double seedPrecale=1., const std::string &groups="", const Method_t method=kMANUAL, const ExtrapStrat_t extrapolation=kLINEAR)
	Version of newTrigger which accepts a set of group names rather than a comma separated string.
StatusCode	newTrigger (const std::string &name, const double prescale=1., const double expressPrescale=-1., const std::string &seedName="", const double seedPrecale=1., const std::set< std::string > &groups=std::set< std::string >(), const Method_t method=kMANUAL, const ExtrapStrat_t extrapolation=kLINEAR)
	Register a new trigger for emulation.
StatusCode	newScanTrigger (const std::string &name, const double thresholdMin, const double thresholdMax, const uint32_t thresholdBins=100, const RatesScanTrigger::TriggerBehaviour_t behaviour=RatesScanTrigger::TriggerBehaviour_t::kTriggerBelowThreshold, const double prescale=1., const std::string &seedName="", const double seedPrecale=1., const Method_t method=kMANUAL, const ExtrapStrat_t extrapolation=kLINEAR)
	Register a new threshold scan trigger which plots rate as a function of some dependent variable.
StatusCode	newScanTrigger (const std::string &name, const std::vector< double > &thresholdBinEdges, const RatesScanTrigger::TriggerBehaviour_t behaviour=RatesScanTrigger::TriggerBehaviour_t::kTriggerAboveThreshold, const double prescale=1., const std::string &seedName="", const double seedPrecale=1., const Method_t method=kMANUAL, const ExtrapStrat_t extrapolation=kLINEAR)
	Version of newScanTrigger which takes a vector of bin edges.
StatusCode	addAllExisting ()
	Register all existing triggers in the AOD into the rates algorithm.
StatusCode	addExisting (const std::string &pattern)
	Register some existing triggers based on wild-card match, e.g.
StatusCode	setTriggerDesicison (const std::string &name, const bool triggerIsPassed=true, const bool triggerIsActive=true)
	Set the pass/fail decision for an item.
StatusCode	setTriggerDesicison (const std::string &name, const double threshold)
	Set the pass threshold for a Scan Trigger item.
void	setTargetLumiMu (const double lumi, const double mu)
	Set the target instantaneous luminosity and mu.
void	setTargetLumiBunches (const double lumi, const int32_t bunches)
	Set the target instantaneous luminosity and number of bunches.
void	setTargetMuBunches (const double mu, const int32_t bunches)
	Set the target mu and number of bunches.
void	setTargetLumi (const double lumi)
	Set the target instantaneous luminosity.
void	setTargetMu (const double mu)
	Set the target pileup.
void	setExponentialMuScalingFactor (const double f)
	Set the exponential scaling factor for relevant chains.
virtual StatusCode	sysInitialize () override
	Function initialising the tool in the correct way in Athena.
virtual StatusCode	sysExecute (const EventContext &) override
	override to do firstEvent method
template<typename T>
StatusCode	retrieveMetadata (const std::string &folder, const std::string &key, T &out)
	Helper function to access IOVMetaDataContainer information helped in the MetaDataStore.
template<typename T>
StatusCode	retrieveMetadata (const std::string &folder, const std::string &key, T &out, const IOVTime &time, int channel=-1)
	Helper function to access IOVMetaDataContainer information held in InputMetaDataStore, but will check IOVTime.
const ServiceHandle< ITHistSvc > &	histSvc () const
	The standard THistSvc (for writing histograms and TTrees and more to a root file) Returns (kind of) a pointer to the THistSvc.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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
Functions providing access to the input/output metadata
const ServiceHandle< StoreGateSvc > &	inputMetaStore () const
	Const accessor for the input metadata store.
ServiceHandle< StoreGateSvc > &	inputMetaStore ()
	Accessor for the input metadata store.
const ServiceHandle< StoreGateSvc > &	outputMetaStore () const
	Const accessor for the output metadata store.
ServiceHandle< StoreGateSvc > &	outputMetaStore ()
	Accessor for the output metadata store.

Protected Member Functions
virtual StatusCode	initialize ()
	Get the trigger decision tool and set up global groups.
StatusCode	pass_HstpFilter (bool &pass)
	Boolean indicating if the event passes the HS-softer-than-PU (HSTP) filter.
virtual StatusCode	initialize_extra_content ()
	Initialization of additional payload for inherited classes.
const std::unordered_map< std::string, std::unique_ptr< RatesTrigger > > &	getTriggerMap () const
void	updateEvtStore (Gaudi::Details::PropertyBase &prop)
virtual void	handle (const Incident &inc) override
	Function receiving incidents from IncidentSvc/TEvent Experts can override but they should ensure they add AthAnalysisAlgorithm::handle(); to the end of their own implementation.
virtual StatusCode	beginInputFile ()
	Function called when a new input file is opened user can read input metadata from inputMetaStore()
virtual StatusCode	endInputFile ()
	Function called as an input file is being closed.
virtual StatusCode	metaDataStop ()
	Function called before finalize user can read output metadata from outputMetaStore()
virtual StatusCode	firstExecute ()
	Function called when first execute is encountered user can read event information with evtStore()
virtual TFile *	currentFile (const char *evtSelName="EventSelector") final
	Function returning the TFile pointer of the currently open file of the given EventSelector (in athena jobs this defaults to "EventSelector")
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.
StatusCode	configAthHistogramming (const ServiceHandle< ITHistSvc > &histSvc, const std::string &prefix, const std::string &rootDir, const std::string &histNamePrefix, const std::string &histNamePostfix, const std::string &histTitlePrefix, const std::string &histTitlePostfix)
	To be called by the derived classes to fill the internal configuration.
TH1 *	bookGetPointer (const TH1 &hist, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
TH1 *	bookGetPointer (TH1 *hist, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
TH1 *	bookGetPointer (TH1 &histRef, std::string tDir="", std::string stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
TTree *	bookGetPointer (const TTree &treeRef, std::string tDir="", std::string stream="")
	Simplify the booking and registering (into THistSvc) of TTrees.
TGraph *	bookGetPointer (const TGraph &graphRef, std::string tDir="", std::string stream="")
	Simplify the booking and registering (into THistSvc) of TGraphs.
TEfficiency *	bookGetPointer (const TEfficiency &eff, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
TEfficiency *	bookGetPointer (TEfficiency *eff, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
TEfficiency *	bookGetPointer (TEfficiency &effRef, std::string tDir="", std::string stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
StatusCode	book (const TH1 &hist, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
StatusCode	book (TH1 *hist, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
StatusCode	book (TH1 &histRef, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of histograms.
StatusCode	book (const TTree &treeRef, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TTrees.
StatusCode	book (const TGraph &graphRef, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TGraphs.
StatusCode	book (const TEfficiency &eff, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
StatusCode	book (TEfficiency *eff, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
StatusCode	book (TEfficiency &effRef, const std::string &tDir="", const std::string &stream="")
	Simplify the booking and registering (into THistSvc) of TEfficiency.
TH1 *	hist (const std::string &histName, const std::string &tDir="", const std::string &stream="")
	Simplify the retrieval of registered histograms of any type.
TH2 *	hist2d (const std::string &histName, const std::string &tDir="", const std::string &stream="")
	Simplify the retrieval of registered 2-d histograms.
TH3 *	hist3d (const std::string &histName, const std::string &tDir="", const std::string &stream="")
	Simplify the retrieval of registered 3-d histograms.
TTree *	tree (const std::string &treeName, const std::string &tDir="", const std::string &stream="")
	Simplify the retrieval of registered TTrees.
TGraph *	graph (const std::string &graphName, const std::string &tDir="", const std::string &stream="")
	Simplify the retrieval of registered TGraphs.
TEfficiency *	efficiency (const std::string &effName, const std::string &tDir="", const std::string &stream="")
	Simplify the retrieval of registered TEfficiency.

Protected Attributes
double	m_linearLumiFactor
WeightingValuesSummary_t	m_weightingValues
	Possible weighting & lumi extrapolation values for the current event.
double	m_ratesDenominator
	How much walltime is seen by the algorithm.
Gaudi::Property< bool >	m_doHistograms {this, "DoHistograms", true, "Switch on histogram output of rate vs. mu and position in train."}
Gaudi::Property< bool >	m_doMultiSliceDiJet {this, "DoMultiSliceDiJet", false, "Enable the HS-softer-than-PU (HSTP) filter; reweight the Slices according to Jet/ETMiss procedure; recommended by PMG for di-jet slices."}
std::unordered_map< std::string, std::unique_ptr< RatesTrigger > >	m_triggers
	All individual triggers (L1 or HLT)

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t
typedef uint32_t	hash_t
	typedef for the internal hash
typedef std::map< const hash_t, TH1 * >	HistMap_t
	Typedef for convenience.
typedef std::map< const hash_t, TEfficiency * >	EffMap_t
	Typedef for convenience.
typedef std::map< const hash_t, TTree * >	TreeMap_t
	Typedef for convenience.
typedef std::map< const hash_t, TGraph * >	GraphMap_t
	Typedef for convenience.

Private Member Functions
virtual StatusCode	execute ()
	In first call - register all triggers.
virtual StatusCode	finalize ()
	Print rates.
StatusCode	populateTriggers ()
	Register all triggers to emulate.
StatusCode	executeTrigDecisionToolTriggers ()
	Internal call to get the pass/fail for all TDT triggers.
StatusCode	executeTriggerEmulation ()
	Internal call to get the pass/fail for all automatically emulated triggers.
StatusCode	checkExistingTrigger (const std::string &name, const std::string &seedName)
	Internal function to check if a supplied HLT trigger and L1 seed match what is stored in the AOD config.
StatusCode	checkGotTDT ()
	Internal check that the TDT is fetched.
void	printInputSummary () const
	Print the input data instantaneous luminosity, mu and number of bunches.
void	printStatistics () const
	Print some extra statistics on events processed.
void	printTarget () const
	Print the target instantaneous luminosity, mu and number of bunches.
void	writeMetadata ()
	Write to outpute tree (if any) the metadata needed downstream.
bool	isCPS (const std::string &group) const
	String match coherent prescale groups.
bool	isRandomSeed (const std::string &me, const std::string &seed) const
	String match random L1 items.
uint32_t	getLevel (const std::string &name) const
	String match to a trigger level.
bool	isZero (double v) const
	Helper function for floating point subtraction.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>
void	buildBookingString (std::string &bookingString, std::string &histName, std::string &tDir, std::string &stream, bool usePrefixPostfix=false)
	Method to build individual booking string.
void	myReplace (std::string &str, const std::string &oldStr, const std::string &newStr)
	Helper method to replace sub-string.
hash_t	hash (const std::string &histName) const
	Method to calculate a 32-bit hash from a string.

Private Attributes
std::unordered_map< std::string, std::unique_ptr< RatesScanTrigger > >	m_scanTriggers
	All individual rates-scan triggers (L1 or HLT)
std::unordered_map< std::string, std::unique_ptr< RatesGroup > >	m_groups
	All regular and CPS groups.
std::unordered_map< std::string, std::unique_ptr< RatesGroup > >	m_globalGroups
	Big (master) groups which do the OR of the whole menu.
std::unordered_map< std::string, std::unique_ptr< RatesGroup > >	m_uniqueGroups
	Groups used to obtain unique rates for chains.
std::unordered_set< RatesTrigger * >	m_activatedTriggers
	Triggers which were changed & hence need to be reset at the event end.
std::unordered_set< RatesTrigger * >	m_expressTriggers
	Triggers with non-zero express PS, used to print them at the end.
std::unordered_set< RatesGroup * >	m_activeGroups
	All groups which are enabled (PS >= 1)
std::unordered_map< size_t, double >	m_lowestPrescale
	Lowest prescale within a CPS group, key is the hash of the CPS group name.
std::vector< std::string >	m_autoTriggers
	List of triggers which it is up to us to the algorithm to work out the pass/fail for.
std::unordered_map< std::string, const Trig::ChainGroup * >	m_existingTriggers
	Map of triggers which we ask the TDT ChainGroup for the pass/fail.
std::unordered_map< std::string, std::string >	m_lowerTrigger
	Map of triggers lower chain, to tell if a HLT trigger ran or not.
std::vector< std::vector< std::string > >	m_hltChainIDGroup
std::vector< std::vector< std::string > >	m_l1ItemID
const std::string	m_l1GroupName = "L1"
const std::string	m_l2GroupName = "HLT"
const std::string	m_expressGroupName = "Express"
ToolHandle< IEnhancedBiasWeighter >	m_enhancedBiasRatesTool {this, "EnhancedBiasRatesTool", "EnhancedBiasWeighter/EnhancedBiasRatesTool"}
ToolHandle< Trig::TrigDecisionTool >	m_tdt {this, "TrigDecisionTool", "Trig::TrigDecisionTool/TrigDecisionTool"}
ServiceHandle< TrigConf::ITrigConfigSvc >	m_configSvc {this, "TrigConfigSvc", "TrigConf::xAODConfigSvc"}
SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfoKey {this, "EventInfo", "EventInfo", "EventInfo name"}
SG::ReadHandleKey< xAOD::JetContainer >	m_truthHS_jets_RHKey {this, "TruthHSJetsKey", "AntiKt4TruthJets", "Key for the hard scatter truth jet collection"}
SG::ReadHandleKey< xAOD::JetContainer >	m_truthPU_jets_RHKey {this, "truthPUJetsKey", "InTimeAntiKt4TruthJets", "Key for the pileup jet collection"}
Gaudi::Property< double >	m_expoScalingFactor {this, "ExpoScalingFactor", 0.1, "Optional. Exponential factor if using exponential-mu rates scaling."}
Gaudi::Property< double >	m_inelasticCrossSection {this, "InelasticCrossSection", 8e-26, "Inelastic cross section in units cm^2. Default 80 mb at 13 TeV."}
Gaudi::Property< bool >	m_doUniqueRates {this, "DoUniqueRates", false, "Calculate unique rates for all chains (slow). Requires DoGlobalGroups=True too."}
Gaudi::Property< bool >	m_doGlobalGroups {this, "DoGlobalGroups", false, "Calculate total rates for each trigger level."}
Gaudi::Property< bool >	m_doTriggerGroups {this, "DoTriggerGroups", false, "Calculate total rates for each group of triggers."}
Gaudi::Property< bool >	m_doExpressRates {this, "DoExpressRates", false, "Calculate total rates for the express stream."}
Gaudi::Property< bool >	m_useBunchCrossingData {this, "UseBunchCrossingData", true, "BunchCrossing data requires CONDBR2 access. Can be disabled here if this is a problem."}
Gaudi::Property< bool >	m_currentEventIsUnbiased
	If the current event was triggered online by RDx or not.
Gaudi::Property< bool >	m_enableLumiExtrapolation {this, "EnableLumiExtrapolation", true, "If false then no extrapolation in L, N_bunch or <mu> will be performed.."}
Gaudi::Property< uint32_t >	m_vetoStartOfTrain {this, "VetoStartOfTrain", 0, "How many BCID to veto at the start of a bunch train."}
Gaudi::Property< std::map< std::string, std::map< std::string, double > > >	m_prescalesJSON {this, "PrescalesJSON", {}, "Optional JSON of prescales from the TrigMenuRuleBook to apply."}
Gaudi::Property< std::string >	m_histogramSuffix {this, "histogramSuffix", "", "Optional suffix to add to the name of the rate denominator histogram."}
double	m_targetMu
	What pileup level the prediction is targeting.
double	m_targetBunches
	How many bunches the prediction is targeting.
double	m_targetLumi
	What instantaneous luminosity the prediction is targeting.
uint32_t	m_runNumber
	What is the RunNumber.
uint32_t	m_eventCounter
	Count how many events processed.
double	m_weightedEventCounter
	Count how many weighted events were processed.
TH1D *	m_scalingHist
	One-bin histogram to store the normalisation of the sample, for use in later combinations.
TH1D *	m_bcidHist
	Histogram of the BCIDs distribution of the processing.
TTree *	m_metadataTree
	Used to write out some metadata needed by post-processing (e.g.
ServiceHandle< StoreGateSvc >	m_inputMetaStore
	Object accessing the input metadata store.
ServiceHandle< StoreGateSvc >	m_outputMetaStore
	Object accessing the output metadata store.
TFile *	m_currentFile {nullptr}
bool	m_doneFirstEvent {false}
ServiceHandle< ITHistSvc >	m_histSvc
	Default constructor: AthHistogramAlgorithm();.
std::string	m_prefix
	Name of the ROOT output stream (file)
std::string	m_rootDir
	Name of the ROOT directory.
std::string	m_histNamePrefix
	The prefix for the histogram THx name.
std::string	m_histNamePostfix
	The postfix for the histogram THx name.
std::string	m_histTitlePrefix
	The prefix for the histogram THx title.
std::string	m_histTitlePostfix
	The postfix for the histogram THx title.
DataObjIDColl	m_extendedExtraObjects
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
HistMap_t	m_histMap
	The map of histogram names to their pointers.
EffMap_t	m_effMap
	The map of histogram names to their pointers.
TreeMap_t	m_treeMap
	The map of TTree names to their pointers.
GraphMap_t	m_graphMap
	The map of TGraph names to their pointers.
std::string	m_streamName
	Name of the ROOT output stream (file)
std::string	m_name
	Instance name.
MsgStream	m_msg
	Cached Message Stream.

Detailed Description

virtual analysis class for performing rates studies on AOD Pure virtual base class for trigger rate studies on EnhancedBias or MC AOD files.

This class should be inherited and the user should implement ratesInitialize, ratesExecute and ratesFinalize. Triggers to emulate should be added in ratesInitialize with newTrigger or other members such as addExisting. Manually emulated triggers should have their decision supplied during ratesExecute using setTriggerDesicison. Rates will be reported at the end.

Definition at line 37 of file RatesAnalysisAlg.h.

Member Typedef Documentation

EffMap_t

typedef std::map< const hash_t, TEfficiency* > AthHistogramming::EffMap_t

privateinherited

Typedef for convenience.

Definition at line 205 of file AthHistogramming.h.

GraphMap_t

typedef std::map< const hash_t, TGraph* > AthHistogramming::GraphMap_t

privateinherited

Typedef for convenience.

Definition at line 219 of file AthHistogramming.h.

hash_t

typedef uint32_t AthHistogramming::hash_t

privateinherited

typedef for the internal hash

Definition at line 169 of file AthHistogramming.h.

HistMap_t

typedef std::map< const hash_t, TH1* > AthHistogramming::HistMap_t

privateinherited

Typedef for convenience.

Definition at line 198 of file AthHistogramming.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

TreeMap_t

typedef std::map< const hash_t, TTree* > AthHistogramming::TreeMap_t

privateinherited

Typedef for convenience.

Definition at line 212 of file AthHistogramming.h.

Member Enumeration Documentation

Method_t

enum RatesAnalysisAlg::Method_t

Method by which the trigger pass/fail decision is calculated.

Via manual or automated emulator or using the Trigger Decision Tool for a pre-existing item.

Enumerator
kMANUAL	The pass/fail decision is evaluated by the user and supplied per event using setTriggerDesicison.
kAUTO	The pass/fail decision is automatically emulated per event based on decoding the trigger name.
kEXISTING	The pass/fail decision is taken from the Trigger Decision Tool for an existing trigger.

Definition at line 43 of file RatesAnalysisAlg.h.

               {
    kMANUAL, 
    kAUTO, 
    kEXISTING 
  };

Constructor & Destructor Documentation

RatesAnalysisAlg()

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

Definition at line 22 of file RatesAnalysisAlg.cxx.

                                                                                    : 
  AthAnalysisAlgorithm( name, pSvcLocator ),
  m_linearLumiFactor(0),
  m_weightingValues(),
  m_ratesDenominator(0),
  m_targetMu(0.),
  m_targetBunches(0.),
  m_targetLumi(0.),
  m_runNumber(0.),
  m_eventCounter(0),
  m_weightedEventCounter(0),
  m_scalingHist(nullptr),
  m_bcidHist(nullptr),
  m_metadataTree(nullptr)
{}

~RatesAnalysisAlg()

RatesAnalysisAlg::~RatesAnalysisAlg ( )

virtual

Definition at line 38 of file RatesAnalysisAlg.cxx.

{}

Member Function Documentation

addAllExisting()

StatusCode RatesAnalysisAlg::addAllExisting

(

)

Register all existing triggers in the AOD into the rates algorithm.

Definition at line 189 of file RatesAnalysisAlg.cxx.

                                            {
  ATH_CHECK(checkGotTDT());
  return addExisting(".*");
}

addExisting()

StatusCode RatesAnalysisAlg::addExisting

(

const std::string &

pattern

)

Register some existing triggers based on wild-card match, e.g.

"L1_.*" for all L1.

Parameters

pattern

Wild-card string to match in trigger name

Definition at line 198 of file RatesAnalysisAlg.cxx.

                                                                 {
  // Check we have the TDT
  ATH_CHECK(checkGotTDT());
 
  const auto& triggers = m_tdt->getListOfTriggers(pattern);
  ATH_MSG_INFO("Read " << triggers.size() << " triggers from AOD.");
 
  // Check if chain was disabled in athena job
  const bool runWithPrescaleJSON = !m_prescalesJSON.value().empty();
  const TrigConf::HLTPrescalesSet& hltPrescalesSet = m_configSvc->hltPrescalesSet(Gaudi::Hive::currentContext());
  for( auto & p : hltPrescalesSet.data().get_child("prescales") ) {
    if ((!m_prescalesJSON.value().count(p.first) && !runWithPrescaleJSON) || hltPrescalesSet.prescale(p.first).prescale < 0){
      m_prescalesJSON[p.first]["prescale"] = (hltPrescalesSet.prescale(p.first).enabled ? hltPrescalesSet.prescale(p.first).prescale : -1);
      m_prescalesJSON[p.first]["prescale_express"] = (hltPrescalesSet.prescale_express(p.first).enabled ? hltPrescalesSet.prescale_express(p.first).prescale : -1);
      if (hltPrescalesSet.prescale(p.first).prescale < 0){
        ATH_MSG_WARNING("Trigger " << p.first << " disabled in supplied AOD file. DISABLING");
      }
    }
  }
 
  const TrigConf::L1PrescalesSet& l1PrescalesSet = m_configSvc->l1PrescalesSet(Gaudi::Hive::currentContext());
  for( auto & p : l1PrescalesSet.prescales() ) {
    if ((!m_prescalesJSON.value().count(p.first) && !runWithPrescaleJSON) || p.second.prescale < 0){
      m_prescalesJSON[p.first]["prescale"] = p.second.prescale;
 
      if (p.second.prescale < 0){
        ATH_MSG_WARNING("Trigger " << p.first << " disabled in supplied AOD file. DISABLING");
      }
    }
  }
 
  // Iterate over the triggers and add them
  for (const auto& trigger : triggers) {
    ATH_MSG_DEBUG("Considering " << trigger );
    const bool isHLT = (getLevel(trigger) == 2); 
    const auto trigConf = (isHLT ? m_tdt->ExperimentalAndExpertMethods().getChainConfigurationDetails(trigger) : nullptr);
    if (isHLT && !trigConf) {
      ATH_MSG_ERROR("Problem with TDT trig conf - cannot get details for " << trigger << ", will be ignored.");
      continue;
    }
    const std::string lowerName = (isHLT ? trigConf->lower_chain_name() : "");
    std::set<std::string> groups = std::set<std::string>(); // To be filled later from the HLTMenu
 
    if (isHLT) {
      // If this is a HLT item, we require it to be seeded by at most one item. This allows us to use a factorising rates algorithm
      if (lowerName.find(",") != std::string::npos) {
        ATH_MSG_WARNING("Can not add " << trigger << " due to multiple L1 seeds." );
        continue;
      }
 
      if (lowerName.empty()) {
        ATH_MSG_WARNING("Can not add " << trigger << " due to multiple L1 seeds: L1All" );
        continue;
      }
      
      // Check it also wasn't disabled in the reprocessing (e.g. auto prescaled out in a perf or tightperf menu)
      if (trigConf->prescale() < 1.) { // Note this prescale is from ATHENA
        ATH_MSG_DEBUG("Will not add " << trigger << ", it was disabled in the reprocessing.");
        continue;
      }
 
      ATH_CHECK(m_configSvc.isValid());
      const TrigConf::HLTMenu& hltMenu = m_configSvc->hltMenu(Gaudi::Hive::currentContext());
 
      TrigConf::HLTMenu::const_iterator chain = std::find_if(hltMenu.begin(), hltMenu.end(), [&] (const TrigConf::Chain& c) {return c.name() == trigger;});
      if (chain == hltMenu.end()){
        ATH_MSG_WARNING("Chain " << trigger << " not found in the menu!");
        continue;
      }
 
      std::vector<std::string> chainGroups = (*chain).groups();
      std::vector<std::string> chainStreams = (*chain).streams();
 
      ATH_MSG_DEBUG(" chain " << trigger << " has "  << chainGroups.size() << " groups and " << chainStreams.size() << " streams");
 
      groups.insert(chainGroups.begin(), chainGroups.end());
      for (const std::string& stream : chainStreams){
        groups.insert("STREAM:" + stream );
      }
    }
 
    // Get the prescale, express prescale and lower prescale. Note these prescales are from SUPPLIED JSON. 
    double prescale = 1., expressPrescale = -1., lowerPrescale = 1.;
    if (m_prescalesJSON.size() != 0) {
      if (m_prescalesJSON.value().count(trigger) == 0) {
        ATH_MSG_WARNING("Unable to find " << trigger << " in supplied JSON. DISABLING." );
        prescale = 0.;
      } else {
        prescale        = m_prescalesJSON[trigger]["prescale"];
          expressPrescale = m_prescalesJSON[trigger]["prescale_express"];
      }
      if (isHLT) {
        if (m_prescalesJSON.value().count(lowerName) == 0) {
          ATH_MSG_WARNING("Unable to find " << trigger << "'s seed, " << lowerName << ", in supplied JSON. DISABLING." );
          lowerPrescale = 0.;
        } else {
          lowerPrescale = m_prescalesJSON[lowerName]["prescale"];
        }
      }
    }
 
 
    // We now have all the info needed to add this trigger
    ATH_MSG_DEBUG("Registering existing trigger " << trigger << " for automatic TDT based rates prediction." );
    ATH_CHECK( newTrigger(trigger, prescale, expressPrescale, lowerName, lowerPrescale, groups, kEXISTING) );
  }
 
  for (const auto& trigger : m_prescalesJSON) {
    if (trigger.second.at("prescale") > 0 &&  std::find(triggers.begin(), triggers.end(), trigger.first) == triggers.end()) {
       ATH_MSG_WARNING( "Trigger " << trigger.first << " in supplied JSON is NOT AVAILABLE in the supplied AOD file.");
    }
  }
 
  return StatusCode::SUCCESS;
}

beginInputFile()

StatusCode AthAnalysisAlgorithm::beginInputFile ( )

protectedvirtualinherited

Function called when a new input file is opened user can read input metadata from inputMetaStore()

Dummy implementation that can be overridden by the derived tool.

Reimplemented in MuonVal::MetaDataAlg.

Definition at line 114 of file AthAnalysisAlgorithm.cxx.

                                                {
 
   // Return gracefully:
   return StatusCode::SUCCESS;
}

book() [1/8]

StatusCode AthHistogramming::book ( const TEfficiency & eff, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 335 of file AthHistogramming.h.

{
  // We need to create a non-const clone
  TEfficiency* effClone = dynamic_cast< TEfficiency* >( eff.Clone() );
  if ( !effClone ) {
    m_msg << MSG::ERROR << "Couldn't create a TEfficiency clone" << endmsg;
    return StatusCode::FAILURE;
  }
  return this->book( *effClone, tDir, stream );
}

book() [2/8]

StatusCode AthHistogramming::book ( const TGraph & graphRef, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TGraphs.

book() [3/8]

StatusCode AthHistogramming::book ( const TH1 & hist, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 303 of file AthHistogramming.h.

{
  // We need to create a non-const clone
  TH1* histClone = dynamic_cast< TH1* >( hist.Clone() );
  if ( !histClone ) {
    m_msg << MSG::ERROR << "Couldn't create a TH1 clone" << endmsg;
    return StatusCode::FAILURE;
  }
  return this->book( *histClone, tDir, stream );
}

book() [4/8]

StatusCode AthHistogramming::book ( const TTree & treeRef, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TTrees.

Definition at line 403 of file AthHistogramming.h.

{
  // Call the other Book method and see if it returns a valid pointer
  TTree* treePointer = this->bookGetPointer( treeRef, tDir, stream );
  if ( treePointer )
    {
      return StatusCode::SUCCESS;
    }
  else
    {
      return StatusCode::FAILURE;
    }
}

book() [5/8]

StatusCode AthHistogramming::book ( TEfficiency & effRef, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 356 of file AthHistogramming.h.

{
  // Call the other Book method and see if it returns a valid pointer
  TEfficiency* effPointer = this->bookGetPointer( effRef, tDir, stream );
  if ( !effPointer ) {
    m_msg << MSG::ERROR << "Couldn't book a TEfficiency" << endmsg;
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

book() [6/8]

StatusCode AthHistogramming::book ( TEfficiency * eff, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 346 of file AthHistogramming.h.

{
  if ( !eff ) {
    m_msg << MSG::ERROR << "Got a zero pointer to a TEfficiency" << endmsg;
    return StatusCode::FAILURE;
  }
  return this->book( *eff, tDir, stream );
}

book() [7/8]

StatusCode AthHistogramming::book ( TH1 & histRef, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 324 of file AthHistogramming.h.

{
  // Call the other Book method and see if it returns a valid pointer
  TH1* histPointer = this->bookGetPointer( histRef, tDir, stream );
  if ( !histPointer ) {
    m_msg << MSG::ERROR << "Couldn't book a TH1" << endmsg;
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

book() [8/8]

StatusCode AthHistogramming::book ( TH1 * hist, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 314 of file AthHistogramming.h.

{
  if ( !hist ) {
    m_msg << MSG::ERROR << "Got a zero pointer to a TH1" << endmsg;
    return StatusCode::FAILURE;
  }
  return this->book( *hist, tDir, stream );
}

bookGetPointer() [1/8]

TEfficiency * AthHistogramming::bookGetPointer ( const TEfficiency & eff, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 281 of file AthHistogramming.h.

{
  // We need to create a non-const clone
  TEfficiency* histClone = dynamic_cast< TEfficiency* >( hist.Clone() );
  if ( !histClone ) {
    m_msg << MSG::ERROR << "Couldn't create a TEfficiency clone in bookGetPointer" << endmsg;
    return 0;
  }
  return this->bookGetPointer( *histClone, tDir, stream );
 
}

bookGetPointer() [2/8]

TGraph * AthHistogramming::bookGetPointer ( const TGraph & graphRef, std::string tDir = "", std::string stream = "" )

protectedinherited

Simplify the booking and registering (into THistSvc) of TGraphs.

Definition at line 427 of file AthHistogramming.cxx.

{
  // Get a pointer
  const TGraph* graphPointer = &graphRef;
 
  // Check that we got a valid pointer
  if ( !graphPointer )
    {
      m_msg << MSG::WARNING
            << "We got an invalid TGraph pointer in the BookGetPointer(TGraph*) method of the class" << m_name
            << "!" << endmsg;
      return NULL;
    }
 
  // Modify the name and title according to the prefixes of this classes instance
  std::string graphName  = graphPointer->GetName();
  const std::string graphTitle = graphPointer->GetTitle();
 
  // Check if the hash for this graphName already exists, i.e., if we have a hash collision
  const hash_t graphHash = this->hash(graphName);
  GraphMap_t::const_iterator it = m_graphMap.find( graphHash );
  if ( it != m_graphMap.end() ) // It does exist!
    {
      m_msg << MSG::WARNING
            << "Detected a hash collision. The hash for the TGraph with name=" << graphName
            << " already exists and points to a TGraph with name=" << it->second->GetName()
            << " NOT going to book the new histogram and returning a NULL pointer!" << endmsg;
      return NULL;
    }
 
  // Create a clone that has the new name
  TGraph* graphClone = dynamic_cast< TGraph* >( graphPointer->Clone((m_histNamePrefix+graphName+m_histNamePostfix).c_str()) );
  if( !graphClone )
    {
      m_msg << MSG::WARNING
            << "We couldn't clone the TGraph in the BookGetPointer(TGraph&) method of the class" << m_name
            << "!" << endmsg;
      return NULL;
    }
  graphClone->SetTitle ((m_histTitlePrefix+graphTitle+m_histTitlePostfix).c_str());
 
  // Massage the final string to book things
  std::string bookingString("");
  this->buildBookingString( bookingString, graphName, tDir, stream );
 
  // Register the TGraph into the THistSvc
  if ( !((histSvc()->regGraph(bookingString, graphClone)).isSuccess()) )
    {
      m_msg << MSG::WARNING
            << "Problem registering TGraph with name " << graphName
            << ", title " << graphTitle
            << " in " << m_name << "!" << endmsg;
      return NULL;
    }
 
  // Also register it in the local map of string to pointer
  m_graphMap.insert( m_graphMap.end(), std::pair< const hash_t, TGraph* >( graphHash, graphClone ) );
 
  return graphClone;
}

bookGetPointer() [3/8]

TH1 * AthHistogramming::bookGetPointer ( const TH1 & hist, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 260 of file AthHistogramming.h.

{
  // We need to create a non-const clone
  TH1* histClone = dynamic_cast< TH1* >( hist.Clone() );
  if ( !histClone ) {
    m_msg << MSG::ERROR << "Couldn't create a TH1 clone in bookGetPointer" << endmsg;
    return 0;
  }
  return this->bookGetPointer( *histClone, tDir, stream );
 
}

bookGetPointer() [4/8]

TTree * AthHistogramming::bookGetPointer ( const TTree & treeRef, std::string tDir = "", std::string stream = "" )

protectedinherited

Simplify the booking and registering (into THistSvc) of TTrees.

Definition at line 312 of file AthHistogramming.cxx.

{
  // Get a pointer
  const TTree* treePointer = &treeRef;
 
  // Check that we got a valid pointer
  if ( !treePointer )
    {
      m_msg << MSG::WARNING
            << "We got an invalid TTree pointer in the BookGetPointer(TTree*) method of the class" << m_name
            << "!" << endmsg;
      return NULL;
    }
 
  // Modify the name and title according to the prefixes of this classes instance
  std::string treeName  = treePointer->GetName();
  const std::string treeTitle = treePointer->GetTitle();
 
  // Check if the hash for this treeName already exists, i.e., if we have a hash collision
  const hash_t treeHash = this->hash(treeName);
  TreeMap_t::const_iterator it = m_treeMap.find( treeHash );
  if ( it != m_treeMap.end() ) // It does exist!
    {
      m_msg << MSG::WARNING
            << "Detected a hash collision. The hash for the TTree with name=" << treeName
            << " already exists and points to a TTree with name=" << it->second->GetName()
            << " NOT going to book the new histogram and returning a NULL pointer!" << endmsg;
      return NULL;
    }
 
  // Create a clone that has the new name
  TTree* treeClone = dynamic_cast< TTree* >( treePointer->Clone(treeName.c_str()) );
  if( !treeClone )
    {
      m_msg << MSG::WARNING
            << "We couldn't clone the TTree in the BookGetPointer(TTree&) method of the class" << m_name
            << "!" << endmsg;
      return NULL;
    }
  treeClone->SetTitle (treeTitle.c_str());
 
  // Massage the final string to book things
  std::string bookingString("");
  this->buildBookingString( bookingString, treeName, tDir, stream );
 
  // Register the TTree into the THistSvc
  if ( !((histSvc()->regTree(bookingString, treeClone)).isSuccess()) )
    {
      m_msg << MSG::WARNING
            << "Problem registering TTree with name " << treeName
            << ", title " << treeTitle
            << " in " << m_name << "!" << endmsg;
      return NULL;
    }
 
  // Also register it in the local map of string to pointer
  m_treeMap.insert( m_treeMap.end(), std::pair< const hash_t, TTree* >( treeHash, treeClone ) );
 
  return treeClone;
}

bookGetPointer() [5/8]

TEfficiency * AthHistogramming::bookGetPointer ( TEfficiency & effRef, std::string tDir = "", std::string stream = "" )

protectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 146 of file AthHistogramming.cxx.

{
  // Modify the name and title according to the prefixes of this classes instance
  std::string effName(effRef.GetName());
  const std::string effTitle(effRef.GetTitle());
  std::string bookingString("");
 
  this->buildBookingString( bookingString, effName, tDir, stream );
  effRef.SetTitle((m_histTitlePrefix+effTitle+m_histTitlePostfix).c_str() );
  effRef.SetName(effName.c_str());
 
  // Check if the hash for this effName already exists, i.e., if we have a hash collision
  const hash_t effHash = this->hash(effName);
  EffMap_t::const_iterator it = m_effMap.find( effHash );
  if ( it != m_effMap.end() ) // It does exist!
    {
      m_msg << MSG::WARNING
            << "Detected a hash collision. The hash for the TEfficiency with name=" << effName
            << " already exists and points to a TEfficiency with name=" << it->second->GetName()
            << " NOT going to book the new TEfficiency and returning a NULL pointer!" << endmsg;
      return NULL;
    }
 
  // Set the new name and title for the TEfficiency, based on the prefixes that the user set for this class instance
  // Create a clone that has the new name
 
  // Massage the final string to book things
 
  // Register the TEfficiency into the THistSvc
  if ( !((histSvc()->regEfficiency(bookingString, &effRef)).isSuccess()) )
    {
      m_msg << MSG::WARNING
            << "Problem registering TEfficiency with name " << effName
            << ", name prefix " << m_histNamePrefix
            << ", title " << effTitle
            << ", tile prefix " << m_histTitlePrefix
            << ", and tile postfix " << m_histTitlePostfix
            << " in " << m_name << "!" << endmsg;
      return NULL;
    }
 
  // Also register it in the local map of string to pointer
  m_effMap.insert( m_effMap.end(), std::pair< const hash_t, TEfficiency* >( effHash, &effRef ) );
 
  return &effRef;
}

bookGetPointer() [6/8]

TEfficiency * AthHistogramming::bookGetPointer ( TEfficiency * eff, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of TEfficiency.

Definition at line 293 of file AthHistogramming.h.

{
  if ( !hist ) {
    m_msg << MSG::ERROR << "Got a zero pointer to a TEfficiency in bookGetPointer" << endmsg;
    return 0;
  }
  return this->bookGetPointer( *hist, tDir, stream );
}

bookGetPointer() [7/8]

TH1 * AthHistogramming::bookGetPointer ( TH1 & histRef, std::string tDir = "", std::string stream = "" )

protectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 98 of file AthHistogramming.cxx.

{
  // Modify the name and title according to the prefixes of this classes instance
  std::string histName(histRef.GetName());
  const std::string histTitle(histRef.GetTitle());
  std::string bookingString("");
 
  this->buildBookingString( bookingString, histName, tDir, stream );
  histRef.SetTitle((m_histTitlePrefix+histTitle+m_histTitlePostfix).c_str() );
  histRef.SetName(histName.c_str());
 
  // Check if the hash for this histName already exists, i.e., if we have a hash collision
  const hash_t histHash = this->hash(histName);
  HistMap_t::const_iterator it = m_histMap.find( histHash );
  if ( it != m_histMap.end() ) // It does exist!
    {
      m_msg << MSG::WARNING
            << "Detected a hash collision. The hash for the histogram with name=" << histName
            << " already exists and points to a histogram with name=" << it->second->GetName()
            << " NOT going to book the new histogram and returning a NULL pointer!" << endmsg;
      return NULL;
    }
 
  // Set the new name and title for the histogram, based on the prefixes that the user set for this class instance
  // Create a clone that has the new name
 
  // Massage the final string to book things
 
  // Register the histogram into the THistSvc
  if ( !((histSvc()->regHist(bookingString, &histRef)).isSuccess()) )
    {
      m_msg << MSG::WARNING
            << "Problem registering histogram with name " << histName
            << ", name prefix " << m_histNamePrefix
            << ", title " << histTitle
            << ", tile prefix " << m_histTitlePrefix
            << ", and tile postfix " << m_histTitlePostfix
            << " in " << m_name << "!" << endmsg;
      return NULL;
    }
 
  // Also register it in the local map of string to pointer
  m_histMap.insert( m_histMap.end(), std::pair< const hash_t, TH1* >( histHash, &histRef ) );
 
  return &histRef;
}

bookGetPointer() [8/8]

TH1 * AthHistogramming::bookGetPointer ( TH1 * hist, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the booking and registering (into THistSvc) of histograms.

Definition at line 272 of file AthHistogramming.h.

{
  if ( !hist ) {
    m_msg << MSG::ERROR << "Got a zero pointer to a TH1 in bookGetPointer" << endmsg;
    return 0;
  }
  return this->bookGetPointer( *hist, tDir, stream );
}

buildBookingString()

void AthHistogramming::buildBookingString ( std::string & bookingString, std::string & histName, std::string & tDir, std::string & stream, bool usePrefixPostfix = false )

privateinherited

Method to build individual booking string.

Definition at line 560 of file AthHistogramming.cxx.

{
  // Massage the final string to book things
  if(tDir.empty()) tDir = m_rootDir;
  size_t pos = histName.rfind('/');
  if(pos != std::string::npos){
    tDir+='/';
    tDir.append(histName, 0,pos);
    histName.erase(0,pos+1);
  };
  if(stream.empty()) stream = m_streamName;
 
  if(usePrefixPostfix){
    bookingString = "/"+stream+"/"+tDir+"/"+m_histNamePrefix+histName+m_histNamePostfix;
  } else {
    bookingString = "/"+stream+"/"+tDir+"/"+histName;
  }
  while(bookingString.find("//") != std::string::npos){
    this->myReplace(bookingString,"//","/");
  }
 
  return;
}

checkExistingTrigger()

StatusCode RatesAnalysisAlg::checkExistingTrigger ( const std::string & name, const std::string & seedName )

private

Internal function to check if a supplied HLT trigger and L1 seed match what is stored in the AOD config.

Parameters

name	Name of the L1 or HLT trigger.
seedName	For HLT triggers, name of the L1 seed item.

Returns

StatusCode::FAILURE if the trigger does not match the AOD.

Definition at line 329 of file RatesAnalysisAlg.cxx.

                                                                                                  {
  ATH_CHECK(checkGotTDT());
  const auto& triggers = m_tdt->getListOfTriggers(name);
  if (triggers.size() != 1) {
    ATH_MSG_FATAL("Unable to find existing trigger " << name << " in this AOD.");
    return StatusCode::FAILURE;
  }
  if (getLevel(name) == 1) return StatusCode::SUCCESS;
  // L1 items will crash if we call this on them.
  const auto trigConf = m_tdt->ExperimentalAndExpertMethods().getChainConfigurationDetails(triggers.at(0));
  if (trigConf->lower_chain_name() != seedName) {
    ATH_MSG_FATAL("Tried to register an existing trigger '" << name << "' seeding from '" << seedName << "' but in this AOD it seeds from '" << trigConf->lower_chain_name() << "'");
    return StatusCode::FAILURE;
  }
  return StatusCode::SUCCESS;
}

checkGotTDT()

StatusCode RatesAnalysisAlg::checkGotTDT ( )

private

Internal check that the TDT is fetched.

Definition at line 314 of file RatesAnalysisAlg.cxx.

                                         {
  if (m_tdt.empty()){
    ATH_MSG_ERROR("TriggerDecisionTool is not available!");
    return StatusCode::FAILURE;
  }
  [[maybe_unused]] static std::atomic<bool> printed = [&]() {
    ATH_MSG_INFO("TDT contains: " << m_tdt->getListOfTriggers().size() << " triggers, "
                 << m_tdt->getListOfStreams().size() << " streams and "
                 << m_tdt->getListOfGroups().size() << " groups.");
    return true;
  }();
  return StatusCode::SUCCESS;
}

configAthHistogramming()

StatusCode AthHistogramming::configAthHistogramming ( const ServiceHandle< ITHistSvc > & histSvc, const std::string & prefix, const std::string & rootDir, const std::string & histNamePrefix, const std::string & histNamePostfix, const std::string & histTitlePrefix, const std::string & histTitlePostfix )

protectedinherited

To be called by the derived classes to fill the internal configuration.

Definition at line 66 of file AthHistogramming.cxx.

{
  m_histSvc          = histSvc;
  m_streamName       = prefix;
  m_rootDir          = rootDir;
  m_histNamePrefix   = histNamePrefix;
  m_histNamePostfix  = histNamePostfix;
  m_histTitlePrefix  = histTitlePrefix;
  m_histTitlePostfix = histTitlePostfix;
 
  return StatusCode::SUCCESS;
}

currentFile()

TFile * AthAnalysisAlgorithm::currentFile ( const char * evtSelName = "EventSelector" )

finalprotectedvirtualinherited

Function returning the TFile pointer of the currently open file of the given EventSelector (in athena jobs this defaults to "EventSelector")

Definition at line 147 of file AthAnalysisAlgorithm.cxx.

                                                               {
   if(m_currentFile) return m_currentFile;
 
   //get the EventSelector so we can get it's list of input files
   //dont get it with a ServiceHandle, because that invokes initialize, can get into init loop
 
   SmartIF<IProperty> evtSelector{service(evtSelName, false)};
   if(!evtSelector) {
     ATH_MSG_ERROR("currentFile(): Couldn't find the service: " << evtSelName);return 0;
   }
 
   try {
      //get the list of input files - use this to determine which open file is the current input file
      const StringArrayProperty& inputCollectionsName = dynamic_cast<const StringArrayProperty&>(evtSelector->getProperty("InputCollections"));
 
      ATH_MSG_VERBOSE("nOpenFile=" << gROOT->GetListOfFiles()->GetSize() << ". nFilesInInputCollection=" << inputCollectionsName.value().size());
      if(msgLvl(MSG::VERBOSE)) {
          for(int i=0;i<gROOT->GetListOfFiles()->GetSize();i++) {
            ATH_MSG_VERBOSE("Open file: " << gROOT->GetListOfFiles()->At(i)->GetName());
          }
      }
 
      //look through list of files and find the one from the input collection that is currently open
 
      for(int i=0;i<gROOT->GetListOfFiles()->GetSize();i++) {
            TFile *g = (TFile*)gROOT->GetListOfFiles()->At(i);
            //see if this file is in the input file list
            //strip everything except stuff either side of last /
            TString s(g->GetName());
            TObjArray* tokens = s.Tokenize("/");
            TObjString* lastToken = static_cast<TObjString*>(tokens->Last());
            TString sToCompare("");
            bool shortComparison(false);
            if(tokens->GetEntries()>1) {
                TString beforeSlash((static_cast<TObjString*>(tokens->At(tokens->GetEntries()-2)))->GetString());
                if(beforeSlash.Length()>0) sToCompare += beforeSlash;
                sToCompare += "/";
            } else {
                shortComparison=true;
            }
            sToCompare += lastToken->GetString();
            TString sToCompare_short(lastToken->GetString()); //short versions search
            delete tokens;
 
            for(unsigned int j=0;j<inputCollectionsName.value().size();j++) {
                TString t(inputCollectionsName.value()[j].c_str());
                //try perfect match first
                if(s.EqualTo(t)) {
                  ATH_MSG_VERBOSE("Current File is: " << inputCollectionsName.value()[j]);
                  m_currentFile = g;
                  return g;
                }
                TObjArray* tokens = t.Tokenize("/");
                TObjString* lastToken = dynamic_cast<TObjString*>(tokens->Last());
                if (!lastToken) {
                  ATH_MSG_ERROR("Cannot cast token string to TObjString");
                  return nullptr;
                }
                TString tToCompare = "";
                bool shortComparison2(false);
                if(tokens->GetEntries()>1) {
                  TObjString* beforeSlashStr = dynamic_cast<TObjString*>(tokens->At(tokens->GetEntries()-2));
                  if (!beforeSlashStr) {
                    ATH_MSG_ERROR("Cannot cast token string to TObjString");
                    return nullptr;
                  }
                  TString beforeSlash(beforeSlashStr->GetString());
                  if(beforeSlash.Length()>0) tToCompare += beforeSlash;
                  tToCompare += "/";
                } else {
                  shortComparison2=true;
                }
                tToCompare += lastToken->GetString();
                TString tToCompare_short(lastToken->GetString());
                delete tokens;
 
                if(shortComparison || shortComparison2) { //doing short version search, no directories to distinguish files!
                  if(sToCompare_short.EqualTo(tToCompare_short)) {
                      ATH_MSG_VERBOSE("Current File is: " << inputCollectionsName.value()[j]);
                      m_currentFile = g;
                      return g;
                  }
                } else
                if(sToCompare.EqualTo(tToCompare)) {
                  ATH_MSG_VERBOSE("Current File is: " << inputCollectionsName.value()[j]);
                  m_currentFile=g;
                  return g;
                }
            }
      }
 
   } catch(...) {
     ATH_MSG_ERROR("currentFile(): Couldn't load InputCollections property of " << evtSelName); return 0;
   }
 
   ATH_MSG_ERROR("currentFile(): Could not find the current file!");
   return 0; //something went wrong :-(
 
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< 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< 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< 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; }

efficiency()

TEfficiency * AthHistogramming::efficiency ( const std::string & effName, const std::string & tDir = "", const std::string & stream = "" )

protectedinherited

Simplify the retrieval of registered TEfficiency.

Definition at line 250 of file AthHistogramming.cxx.

{
  // Build a 32 bit hash out of the name
  const hash_t effHash = this->hash(effName);
 
  // See if this entry exists in the map
  EffMap_t::const_iterator it = m_effMap.find( effHash );
  if ( it == m_effMap.end() ) // It doesn't exist!
    { // Let's see into the THistSvc if somebody else has registered the TEfficiency...
 
      // Need to copy the strings as we will massage them from here on
      std::string effNameCopy = effName;
      std::string tDirCopy     = tDir;
      std::string streamCopy   = stream;
 
      // Massage the final string to book things
      std::string bookingString("");
      this->buildBookingString( bookingString, effNameCopy, tDirCopy, streamCopy ,false);
 
      TEfficiency* effPointer(NULL);
      if ( !((histSvc()->getEfficiency(bookingString, effPointer)).isSuccess()) )
        {
          // Massage the final string to book things
          std::string bookingString("");
          this->buildBookingString( bookingString, effNameCopy, tDirCopy, streamCopy, true );
 
          if ( !((histSvc()->getEfficiency(bookingString, effPointer)).isSuccess()) )
            {
              m_msg << MSG::WARNING
                    << "Problem retrieving the TEfficiency with name (including pre- and post-fixes) "
                    << m_histNamePrefix + effNameCopy + m_histNamePostfix
                    << " or with name " << effNameCopy
                    << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
                    << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
              return NULL;
            }
          // If we get to here, we actually found the TEfficiency in the THistSvc.
          // So let's add it to the local cache map and return its pointer
          m_effMap.insert( m_effMap.end(), std::pair< const hash_t, TEfficiency* >( effHash, effPointer ) );
          return effPointer;
        }
      // If we get to here, we actually found the TEfficiency in the THistSvc.
      // So let's add it to the local cache map and return its pointer
      m_effMap.insert( m_effMap.end(), std::pair< const hash_t, TEfficiency* >( effHash, effPointer ) );
      return effPointer;
    }
 
  // Return the pointer to the TEfficiency that we got from the local cache map
  return it->second;
}

endInputFile()

StatusCode AthAnalysisAlgorithm::endInputFile ( )

protectedvirtualinherited

Function called as an input file is being closed.

Dummy implementation that can be overridden by the derived tool.

Definition at line 122 of file AthAnalysisAlgorithm.cxx.

                                              {
 
   // Return gracefully:
   return StatusCode::SUCCESS;
}

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< 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 RatesAnalysisAlg::execute ( )

privatevirtual

In first call - register all triggers.

Then load event weighting parameters, fill trigger decisions, compute group rates.

Definition at line 634 of file RatesAnalysisAlg.cxx.

                                     {  
  ATH_MSG_VERBOSE("Executing " << name() << " on event " << m_eventCounter << "...");
  if (m_eventCounter++ == 0) { // First time in execute loop - cannot access TDT before this.
    ATH_CHECK( populateTriggers() );
  }
  const EventContext& ctx = Gaudi::Hive::currentContext();
  // Get event characteristics
  SG::ReadHandle<xAOD::EventInfo> eventInfo(m_eventInfoKey, ctx);
  ATH_CHECK( eventInfo.isValid() );
  uint32_t distance = 0;
  ATH_CHECK( m_enhancedBiasRatesTool->getDistanceIntoTrain(eventInfo.get(), distance, ctx) );
  const bool isMC = m_enhancedBiasRatesTool->isMC();
 
  // Get the weighting & scaling characteristics
  m_weightingValues.m_enhancedBiasWeight = m_enhancedBiasRatesTool->getEBWeight(eventInfo.get());
  m_weightingValues.m_eventMu = std::ceil(eventInfo->actualInteractionsPerCrossing()); // This always seems to be a half integer
  m_weightingValues.m_eventLumi = m_enhancedBiasRatesTool->getLBLumi(eventInfo.get());
  m_weightingValues.m_isUnbiased = m_enhancedBiasRatesTool->isUnbiasedEvent(eventInfo.get());
  m_weightingValues.m_distanceInTrain = distance;
  m_weightingValues.m_eventLiveTime = m_enhancedBiasRatesTool->getEBLiveTime(eventInfo.get()); 
  if (m_useBunchCrossingData && m_vetoStartOfTrain > 0 && m_weightingValues.m_distanceInTrain < m_vetoStartOfTrain) return StatusCode::SUCCESS;
 
  // Bunch factor doesn't change as a fn. of the run. Reminder: m_bunchFactor = m_targetBunches / (double)ebPairedBunches;
  m_weightingValues.m_muFactor = (m_weightingValues.m_eventMu ? m_targetMu / m_weightingValues.m_eventMu : 0.0);
  m_weightingValues.m_linearLumiFactor = m_targetLumi / m_weightingValues.m_eventLumi;
  m_weightingValues.m_expoMuFactor = m_weightingValues.m_bunchFactor * exp( m_expoScalingFactor * (m_targetMu - m_weightingValues.m_eventMu) );
 
  // Ignore zero weighted events. Typically these come from bad LB
  if (RatesHistoBase::isZero(m_weightingValues.m_enhancedBiasWeight)) {
    return StatusCode::SUCCESS;
  }
 
  const double weightedEvents = (isMC ? eventInfo->mcEventWeight() : m_weightingValues.m_enhancedBiasWeight);
  m_weightedEventCounter += weightedEvents;
 
  double ratesDenominator = 0.0;
  if (m_doMultiSliceDiJet) {
    ratesDenominator = eventInfo->mcEventWeight(); // In multi-slice mode we only normalize to the weighted number of events
  } else {
    ratesDenominator = m_weightingValues.m_eventLiveTime * (isMC ? eventInfo->mcEventWeight() : 1.0); // Otherwise, we need to keep track of elapsed walltime as well
  }
  m_ratesDenominator += ratesDenominator;
 
  if (m_doHistograms) {
    m_bcidHist->Fill(eventInfo->bcid(), m_weightingValues.m_enhancedBiasWeight);
    m_scalingHist->Fill(0.5, ratesDenominator); // Walltime
    m_scalingHist->Fill(1.5, 1.); // Total events
    m_scalingHist->Fill(2.5, weightedEvents ); // Total weighted events
  }
 
  // HSTP filter check
  if (isMC) {
    bool filterPass = true;
    ATH_CHECK( pass_HstpFilter(filterPass) );
    if (!filterPass) {return StatusCode::SUCCESS;}
  }
 
  // Do automated triggers 
  ATH_CHECK( executeTriggerEmulation() );
 
  // Do TDT-controlled triggers
  ATH_CHECK( executeTrigDecisionToolTriggers() );
 
  // Run user's code. Do manual triggers
  ATH_CHECK( ratesExecute() );
 
  // Execute groups
  for (const auto& group : m_globalGroups) group.second->execute(m_weightingValues); // Physics, L1, express: Must execute before m_uniqueGroups (which are in active groups). Map.
  for (const auto& group : m_activeGroups) group->execute(m_weightingValues); // Individual groups, CPS groups and active unique groups. Set.
 
  // Reset triggers
  for (const auto& trigger : m_activatedTriggers) trigger->reset();
  m_activatedTriggers.clear();
 
  // Some debug info
  if (m_eventCounter % 1000 == 0) {
    ATH_MSG_INFO( "Event " << m_eventCounter << " " << m_weightingValues.print() << " currentWallTime:" << m_ratesDenominator );
  }
 
  setFilterPassed(true); //if got here, assume that means algorithm passed
  return StatusCode::SUCCESS;
}

executeTrigDecisionToolTriggers()

StatusCode RatesAnalysisAlg::executeTrigDecisionToolTriggers ( )

private

Internal call to get the pass/fail for all TDT triggers.

Definition at line 717 of file RatesAnalysisAlg.cxx.

                                                             {
  for (const auto& trigger : m_existingTriggers) {
    const bool passed = trigger.second->isPassed();
    // L1 chains are always active, HLT chains are active if their L1 passed.
    const std::string& lower = m_lowerTrigger[trigger.first];
    // Expect this find operation to fail for L1 chains (lower = "")
    const std::unordered_map<std::string, const Trig::ChainGroup*>::const_iterator it = m_existingTriggers.find(lower);
    const bool active = (it == m_existingTriggers.end() ? true : it->second->isPassed());
    ATH_CHECK( setTriggerDesicison(trigger.first, passed, active) );
  }
  return StatusCode::SUCCESS;
}

executeTriggerEmulation()

StatusCode RatesAnalysisAlg::executeTriggerEmulation ( )

private

Internal call to get the pass/fail for all automatically emulated triggers.

Definition at line 730 of file RatesAnalysisAlg.cxx.

                                                     {
  // TODO emulation code here
  for (const auto& trigger : m_autoTriggers) {
    ATH_MSG_WARNING("Cannot do rates for " << trigger << ". Automatic trigger emulation is not yet included, sorry :(");
  }
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< 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 & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 50 of file AthAlgorithm.cxx.

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

finalize()

StatusCode RatesAnalysisAlg::finalize ( )

privatevirtual

Print rates.

Definition at line 738 of file RatesAnalysisAlg.cxx.

                                      {
  ATH_MSG_INFO ("Finalizing " << name() << "...");
 
  ATH_CHECK( ratesFinalize() );
  if (!m_doMultiSliceDiJet) { // Cannot estimate multi-slice rates before the merging stage
    if (m_scanTriggers.size()) {
      ATH_MSG_INFO("################## Computed Rate Scans for Threshold-Scan Items:");
      for (const auto& trigger : m_scanTriggers) ATH_MSG_INFO(trigger.second->printRate(m_ratesDenominator));
    }
    if (m_triggers.size()) {
      ATH_MSG_INFO("################## Computed Rate Estimations for Single Items:");
      std::set<std::string> keys; // Used an unordered map for speed, but now we'd like the items in order
      for (const auto& trigger : m_triggers) keys.insert(trigger.first);
      for (const std::string& key : keys) ATH_MSG_INFO(m_triggers.at(key)->printRate(m_ratesDenominator));
    }
    if (m_expressTriggers.size()) {
      ATH_MSG_INFO("################## Computed Express Rate Estimations for Single Items:");
      for (const auto& trigger : m_expressTriggers) ATH_MSG_INFO(trigger->printExpressRate(m_ratesDenominator));
    }
    if (m_groups.size()) {
      ATH_MSG_INFO("################## Computed Rate Estimations for Groups:");
      for (const auto& group : m_groups) ATH_MSG_INFO(group.second->printRate(m_ratesDenominator));
    }
    if (m_globalGroups.size()) {
      ATH_MSG_INFO("################## Computed Rate Estimations for Global Groups:");
      for (const auto& group : m_globalGroups) ATH_MSG_INFO(group.second->printRate(m_ratesDenominator));
    }
  }
  ATH_MSG_INFO("################## LHC Conditions and weighting information:");
  printInputSummary();
  printTarget();
  printStatistics();
  ATH_MSG_INFO("##################");
  writeMetadata();
 
  return StatusCode::SUCCESS;
}

firstExecute()

StatusCode AthAnalysisAlgorithm::firstExecute ( )

protectedvirtualinherited

Function called when first execute is encountered user can read event information with evtStore()

Dummy implementation that can be overridden by the derived tool.

Reimplemented in CP::JetTileCorrectionAlg.

Definition at line 139 of file AthAnalysisAlgorithm.cxx.

                                              {
 
   // Return gracefully:
   return StatusCode::SUCCESS;
}

getLevel()

uint32_t RatesAnalysisAlg::getLevel ( const std::string & name ) const

private

String match to a trigger level.

If unknown, we assume HLT.

Returns

trigger level (1 or 2)

Definition at line 867 of file RatesAnalysisAlg.cxx.

                                                               {
  if (name.find("HLT_") != std::string::npos) return 2;
  if (name.find("L1_") != std::string::npos) return 1;
  return 2;
}

getTriggerMap()

const std::unordered_map< std::string, std::unique_ptr< RatesTrigger > > & RatesAnalysisAlg::getTriggerMap ( ) const

protected

Definition at line 194 of file RatesAnalysisAlg.cxx.

                                                                                                      {
    return m_triggers;
}

graph()

TGraph * AthHistogramming::graph ( const std::string & graphName, const std::string & tDir = "", const std::string & stream = "" )

protectedinherited

Simplify the retrieval of registered TGraphs.

Definition at line 492 of file AthHistogramming.cxx.

{
  // Build a 32 bit hash out of the name
  const hash_t graphHash = this->hash(graphName);
 
  // See if this entry exists in the map
  GraphMap_t::const_iterator it = m_graphMap.find( graphHash );
  if ( it == m_graphMap.end() ) // It doesn't exist!
    { // Let's see into the THistSvc if somebody else has registered the TGraph...
 
      // Need to copy the strings as we will massage them from here on
      std::string graphNameCopy = graphName;
      std::string tDirCopy      = tDir;
      std::string streamCopy    = stream;
 
      // Massage the final string to book things
      std::string bookingString("");
      this->buildBookingString( bookingString, graphNameCopy, tDirCopy, streamCopy, true);
 
      TGraph* graphPointer(NULL);
      if ( !((histSvc()->getGraph(bookingString, graphPointer)).isSuccess()) )
        {
          // Massage the final string to book things
          std::string bookingString("");
          this->buildBookingString( bookingString, graphNameCopy, tDirCopy, streamCopy, false );
 
          if ( !((histSvc()->getGraph(bookingString, graphPointer)).isSuccess()) )
            {
              m_msg << MSG::WARNING
                    << "Problem retrieving the TGraph with name (including pre- and post-fixes) "
                    << m_histNamePrefix + graphNameCopy + m_histNamePostfix
                    << " or with name " << graphNameCopy
                    << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
                    << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
              return NULL;
            }
          // If we get to here, we actually found the TGraph in the THistSvc.
          // So let's add it to the local cache map and return its pointer
          m_graphMap.insert( m_graphMap.end(), std::pair< const hash_t, TGraph* >( graphHash, graphPointer ) );
          return graphPointer;
        }
      // If we get to here, we actually found the TGraph in the THistSvc.
      // So let's add it to the local cache map and return its pointer
      m_graphMap.insert( m_graphMap.end(), std::pair< const hash_t, TGraph* >( graphHash, graphPointer ) );
      return graphPointer;
    }
 
 
  // Return the pointer to the TGraph that we got from the local cache map
  return it->second;
}

handle()

void AthAnalysisAlgorithm::handle ( const Incident & inc )

overrideprotectedvirtualinherited

Function receiving incidents from IncidentSvc/TEvent Experts can override but they should ensure they add AthAnalysisAlgorithm::handle(); to the end of their own implementation.

Definition at line 83 of file AthAnalysisAlgorithm.cxx.

                                                       {
 
   // Tell the user what's happening:
   ATH_MSG_VERBOSE( "Callback received with incident: " << inc.type() );
 
   // Call the appropriate member function:
   if( inc.type() == IncidentType::BeginInputFile ) {
      m_currentFile=0;
      if( beginInputFile().isFailure() ) {
         ATH_MSG_FATAL( "Failed to call beginInputFile()" );
         throw std::runtime_error( "Couldn't call beginInputFile()" );
      }
   } else if(inc.type() == IncidentType::EndInputFile ) {
     if( endInputFile().isFailure() ) {
         ATH_MSG_FATAL( "Failed to call endInputFile()" );
         throw std::runtime_error( "Couldn't call endInputFile()" );
      }
   } else if(inc.type() == "MetaDataStop" ) {
     if( metaDataStop().isFailure() ) {
         ATH_MSG_FATAL( "Failed to call metaDataStop()" );
         throw std::runtime_error( "Couldn't call metaDataStop()" );
      }
   } else {
      ATH_MSG_WARNING( "Unknown incident type received: " << inc.type() );
   }
 
   return;
}

hash()

AthHistogramming::hash_t AthHistogramming::hash ( const std::string & histName ) const

inlineprivateinherited

Method to calculate a 32-bit hash from a string.

Definition at line 428 of file AthHistogramming.h.

{
  const uint64_t hash64 = CxxUtils::crc64( histName );
  return (hash_t)(hash64 & 0xFFFFFFFF);
}

hist()

TH1 * AthHistogramming::hist ( const std::string & histName, const std::string & tDir = "", const std::string & stream = "" )

protectedinherited

Simplify the retrieval of registered histograms of any type.

Definition at line 198 of file AthHistogramming.cxx.

{
  // Build a 32 bit hash out of the name
  const hash_t histHash = this->hash(histName);
 
  // See if this entry exists in the map
  HistMap_t::const_iterator it = m_histMap.find( histHash );
  if ( it == m_histMap.end() ) // It doesn't exist!
    { // Let's see into the THistSvc if somebody else has registered the histogram...
 
      // Need to copy the strings as we will massage them from here on
      std::string histNameCopy = histName;
      std::string tDirCopy     = tDir;
      std::string streamCopy   = stream;
 
      // Massage the final string to book things
      std::string bookingString("");
      this->buildBookingString( bookingString, histNameCopy, tDirCopy, streamCopy ,false);
 
      TH1* histPointer(NULL);
      if ( !((histSvc()->getHist(bookingString, histPointer)).isSuccess()) )
        {
          // Massage the final string to book things
          std::string bookingString("");
          this->buildBookingString( bookingString, histNameCopy, tDirCopy, streamCopy, true );
 
          if ( !((histSvc()->getHist(bookingString, histPointer)).isSuccess()) )
            {
              m_msg << MSG::WARNING
                    << "Problem retrieving the histogram with name (including pre- and post-fixes) "
                    << m_histNamePrefix + histNameCopy + m_histNamePostfix
                    << " or with name " << histNameCopy
                    << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
                    << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
              return NULL;
            }
          // If we get to here, we actually found the histogram in the THistSvc.
          // So let's add it to the local cache map and return its pointer
          m_histMap.insert( m_histMap.end(), std::pair< const hash_t, TH1* >( histHash, histPointer ) );
          return histPointer;
        }
      // If we get to here, we actually found the histogram in the THistSvc.
      // So let's add it to the local cache map and return its pointer
      m_histMap.insert( m_histMap.end(), std::pair< const hash_t, TH1* >( histHash, histPointer ) );
      return histPointer;
    }
 
 
  // Return the pointer to the histogram that we got from the local cache map
  return it->second;
}

hist2d()

TH2 * AthHistogramming::hist2d ( const std::string & histName, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the retrieval of registered 2-d histograms.

Definition at line 369 of file AthHistogramming.h.

{
  // Get the TH1 pointer
  TH1* th1Pointer = this->hist(histName, tDir, stream);
  if ( !th1Pointer )
    {
      m_msg << MSG::ERROR
            << "Cannot get a 2-d histogram with name " << histName
            << "... will probably seg-fault!" << endmsg;
      return NULL;
    }
  // If the TH1 pointer is valid, simply return the dynamic_cast
  return dynamic_cast<TH2*>( th1Pointer );
}

hist3d()

TH3 * AthHistogramming::hist3d ( const std::string & histName, const std::string & tDir = "", const std::string & stream = "" )

inlineprotectedinherited

Simplify the retrieval of registered 3-d histograms.

Definition at line 386 of file AthHistogramming.h.

{
  // Get the TH1 pointer
  TH1* th1Pointer = this->hist(histName, tDir, stream);
  if ( !th1Pointer )
    {
      m_msg << MSG::ERROR
            << "Cannot get a 3-d histogram with name " << histName
            << "... will probably seg-fault!" << endmsg;
      return NULL;
    }
  // If the TH1 pointer is valid, simply return the dynamic_cast
  return dynamic_cast<TH3*>( th1Pointer );
}

histSvc()

const ServiceHandle< ITHistSvc > & AthHistogramAlgorithm::histSvc ( ) const

inlineinherited

The standard THistSvc (for writing histograms and TTrees and more to a root file) Returns (kind of) a pointer to the THistSvc.

Definition at line 113 of file AthHistogramAlgorithm.h.

{
  return m_histSvc;
}

initialize()

StatusCode RatesAnalysisAlg::initialize ( )

protectedvirtual

Get the trigger decision tool and set up global groups.

Reimplemented in L1TopoRatesCalculator.

Definition at line 377 of file RatesAnalysisAlg.cxx.

                                        {
  ATH_MSG_INFO ("Initializing " << name() << "...");
 
  if (!m_tdt.empty()){
    ATH_CHECK( m_tdt.retrieve() );
  }
 
  if(!m_configSvc.empty()) {
    ATH_CHECK( m_configSvc.retrieve() );
  }
 
  ATH_CHECK( m_enhancedBiasRatesTool.retrieve() ); 
 
  ATH_CHECK( m_eventInfoKey.initialize());
  ATH_CHECK( m_truthHS_jets_RHKey.initialize( m_enhancedBiasRatesTool->isMC() && m_doMultiSliceDiJet));
  ATH_CHECK( m_truthPU_jets_RHKey.initialize( m_enhancedBiasRatesTool->isMC() && m_doMultiSliceDiJet));
 
  if (m_doUniqueRates && !m_doGlobalGroups) {
    ATH_MSG_ERROR("DoUniqueRates=True requires DoGlobalGroups=True");
    return StatusCode::FAILURE;
  }
 
  ATH_CHECK( initialize_extra_content() ); 
  return StatusCode::SUCCESS;
}

initialize_extra_content()

StatusCode RatesAnalysisAlg::initialize_extra_content ( )

protectedvirtual

Initialization of additional payload for inherited classes.

Reimplemented in RatesEmulationExample.

Definition at line 373 of file RatesAnalysisAlg.cxx.

                                                      {
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< 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.

inputMetaStore() [1/2]

ServiceHandle< StoreGateSvc > & AthAnalysisAlgorithm::inputMetaStore ( )

inlineinherited

Accessor for the input metadata store.

Definition at line 51 of file AthAnalysisAlgorithm.h.

{ return m_inputMetaStore; }

inputMetaStore() [2/2]

const ServiceHandle< StoreGateSvc > & AthAnalysisAlgorithm::inputMetaStore ( ) const

inlineinherited

Const accessor for the input metadata store.

Definition at line 49 of file AthAnalysisAlgorithm.h.

{ return m_inputMetaStore; }

isCPS()

bool RatesAnalysisAlg::isCPS ( const std::string & group ) const

private

String match coherent prescale groups.

Parameters

group

Name of a trigger group

Returns

If name-parsing thinks that the group is a coherent prescale group

Definition at line 856 of file RatesAnalysisAlg.cxx.

                                                         {
  return (group.find("CPS") != std::string::npos);
}

isRandomSeed()

bool RatesAnalysisAlg::isRandomSeed ( const std::string & me, const std::string & seed ) const

private

String match random L1 items.

Parameters

me	Name of the trigger
seed	Name of the trigger's seed

Returns

if name-parsing thinks that the trigger seeds from a random L1 trgigger

Definition at line 860 of file RatesAnalysisAlg.cxx.

                                                                                    {
  if (me.find("L1_RD") != std::string::npos) return true;
  if (me.find("L1RD") != std::string::npos) return true;
  if (seed.find("L1_RD") != std::string::npos) return true;
  return false;
}

isZero()

bool RatesAnalysisAlg::isZero ( double v ) const

inlineprivate

Helper function for floating point subtraction.

Definition at line 248 of file RatesAnalysisAlg.h.

metaDataStop()

StatusCode AthAnalysisAlgorithm::metaDataStop ( )

protectedvirtualinherited

Function called before finalize user can read output metadata from outputMetaStore()

Dummy implementation that can be overridden by the derived tool.

Definition at line 130 of file AthAnalysisAlgorithm.cxx.

                                              {
 
   // Return gracefully:
   return StatusCode::SUCCESS;
}

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

myReplace()

void AthHistogramming::myReplace ( std::string & str, const std::string & oldStr, const std::string & newStr )

privateinherited

Helper method to replace sub-string.

Definition at line 590 of file AthHistogramming.cxx.

{
  size_t pos = 0;
  while((pos = str.find(oldStr, pos)) != std::string::npos)
    {
      str.replace(pos, oldStr.length(), newStr);
      pos += newStr.length();
    }
}

newScanTrigger() [1/2]

StatusCode RatesAnalysisAlg::newScanTrigger	(	const std::string &	name,
		const double	thresholdMin,
		const double	thresholdMax,
		const uint32_t	thresholdBins = 100,
		const RatesScanTrigger::TriggerBehaviour_t	behaviour = RatesScanTrigger::TriggerBehaviour_t::kTriggerBelowThreshold,
		const double	prescale = 1.,
		const std::string &	seedName = "",
		const double	seedPrecale = 1.,
		const Method_t	method = kMANUAL,
		const ExtrapStrat_t	extrapolation = kLINEAR )

Register a new threshold scan trigger which plots rate as a function of some dependent variable.

Parameters

name	The name of the emulated scan trigger. Recommend either a "L1_" or "HLT_" prefix.
thresholdMin	The lower threshold of this trigger, rates will not be available below this threshold
thresholdMax	The upper threshold of this trigger, rates will not be available above this threshold
thresholdBins	Granularity
behaviour	If the trigger should activate above (kTriggerAboveThreshold) or below (kTriggerBelowThreshold) the threshold
prescale	The prescale value to simulate applying. Default 1
seedName	The name of any lower seeding e.g. L1 item. This info is required to get group rates correct
seedPrescale	The prescale of any L1 seed item. Default 1.
method	Determines who is responsible for evaluating the emulated trigger decision, you (kMANUAL) or the algorithm (kAUTO or kEXISTING).
extrapolation	Determines the triggers luminosity extrapolation behaviour.

Definition at line 40 of file RatesAnalysisAlg.cxx.

                                     {
 
  if (method != kMANUAL) {
    ATH_MSG_ERROR("Sorry - ScanTriggers have to be implemented with the kMANUAL method for now.");
    return StatusCode::FAILURE;
  }
 
  const ExtrapStrat_t e = (m_enableLumiExtrapolation ? extrapolation : ExtrapStrat_t::kNONE); 
  m_scanTriggers.emplace(name, std::make_unique<RatesScanTrigger>(name, msgSvc(), thresholdMin, thresholdMax, thresholdBins, behaviour, prescale, seedName, seedPrecale, e));
  RatesScanTrigger* newScanTrigger = m_scanTriggers.at(name).get();
  if (isRandomSeed(name, seedName)) newScanTrigger->setSeedsFromRandom(true);
  ATH_MSG_DEBUG("newScanTrigger " <<  name << " added");
  return StatusCode::SUCCESS;
}

newScanTrigger() [2/2]

StatusCode RatesAnalysisAlg::newScanTrigger	(	const std::string &	name,
		const std::vector< double > &	thresholdBinEdges,
		const RatesScanTrigger::TriggerBehaviour_t	behaviour = RatesScanTrigger::TriggerBehaviour_t::kTriggerAboveThreshold,
		const double	prescale = 1.,
		const std::string &	seedName = "",
		const double	seedPrecale = 1.,
		const Method_t	method = kMANUAL,
		const ExtrapStrat_t	extrapolation = kLINEAR )

Version of newScanTrigger which takes a vector of bin edges.

Parameters

thresholdBinEdged

Vector of bin edges to use for quantifying rate as a function of threshold

Definition at line 65 of file RatesAnalysisAlg.cxx.

                                     {
 
  if (method != kMANUAL) {
    ATH_MSG_ERROR("Sorry - ScanTriggers have to be implemented with the kMANUAL method for now.");
    return StatusCode::FAILURE;
  }
 
  const ExtrapStrat_t e = (m_enableLumiExtrapolation ? extrapolation : ExtrapStrat_t::kNONE); 
 
  m_scanTriggers.emplace(name, std::make_unique<RatesScanTrigger>(name, msgSvc(), thresholdBinEdges, behaviour, prescale, seedName, seedPrecale, e));
  RatesScanTrigger* newScanTrigger = m_scanTriggers.at(name).get();
  if (isRandomSeed(name, seedName)) newScanTrigger->setSeedsFromRandom(true);
  ATH_MSG_DEBUG("newScanTrigger " <<  name << " added");
  return StatusCode::SUCCESS;
}

newTrigger() [1/2]

StatusCode RatesAnalysisAlg::newTrigger	(	const std::string &	name,
		const double	prescale = 1.,
		const double	expressPrescale = -1.,
		const std::string &	seedName = "",
		const double	seedPrecale = 1.,
		const std::set< std::string > &	groups = std::set<std::string>(),
		const Method_t	method = kMANUAL,
		const ExtrapStrat_t	extrapolation = kLINEAR )

Register a new trigger for emulation.

Parameters

name	The name of the emulated trigger. Recommend either a "L1_" or "HLT_" prefix.
prescale	The prescale value to simulate applying. Default 1
expressPrescale	The prescale value to simulate applying to the express stream. Default -1
seedName	The name of any lower seeding e.g. L1 item. This info is required to get group rates correct when multiple chains seed of the same prescaled L1 item.
seedPrescale	The prescale of any L1 seed item. Default 1.
Comma	separated list of groups to include this trigger in. Any group containing "CPS" will be simulated as a coherent prescale group and implies that all members of that group share a common L1 seed.
method	Determines who is responsible for evaluating the emulated trigger decision, you (kMANUAL) or the algorithm (kAUTO or kEXISTING).
extrapolation	Determines the triggers luminosity extrapolation behaviour.

Definition at line 109 of file RatesAnalysisAlg.cxx.

                                     {
 
  if (m_eventCounter > 1) { // All triggers must be defined before we start looping over the sample
    ATH_MSG_FATAL("Too late to call newTrigger. All emulated triggers must be registered during ratesInitialize().");
    return StatusCode::FAILURE;
  }
  if (method == kEXISTING) ATH_CHECK( checkExistingTrigger(name, seedName) ); // Check this agrees with what is in the AOD
 
  // Check if it already exists
  if (m_triggers.count(name) == 1) {
    ATH_MSG_WARNING("Trigger " <<  name << " is already registered.");
    return StatusCode::SUCCESS;
  }
 
  const ExtrapStrat_t e = (m_enableLumiExtrapolation ? extrapolation : ExtrapStrat_t::kNONE); 
  m_triggers.emplace(name, std::make_unique<RatesTrigger>(name, msgSvc(), prescale, expressPrescale, seedName, seedPrecale, m_doHistograms, e));
  RatesTrigger* newTriggerPtr = m_triggers.at(name).get();
 
  if (isRandomSeed(name, seedName)) newTriggerPtr->setSeedsFromRandom(true);
 
  // Only worthwhile doing the remainder if the trigger is not disabled. Otherwise will slow everything down
  if (newTriggerPtr->getDisabled()) {
    ATH_MSG_DEBUG("newTrigger " <<  name << " added (disabled)");
    return StatusCode::SUCCESS;
  }  
 
  if (method == kAUTO) {
    m_autoTriggers.push_back(name);
  } else if (method == kEXISTING) {
    m_existingTriggers[name] = m_tdt->getChainGroup(name);
    m_lowerTrigger[name] = seedName;
  }
 
  // Add this trigger to its groups
  if (m_doTriggerGroups) {
    for (const std::string& group : groups) {
      // Ignore BW and PS groups
      if (group.starts_with("BW") || group.starts_with("PS") || group.starts_with("STREAM:express")) continue;
 
      const auto [it, inserted] = m_groups.try_emplace(group, std::make_unique<RatesGroup>(group, msgSvc(), m_doHistograms, m_enableLumiExtrapolation));
      if (inserted) {
        // As the group is formed from at least one active trigger - it must be active itself (counter example - CPS group of a PS=-1 trigger)
        m_activeGroups.insert( it->second.get() );
      }
      it->second->addToGroup( newTriggerPtr );
      // For CPS, we let the trigger know that it is special
      if (isCPS(group)) {
        if (newTriggerPtr->getCPSID() != 0) ATH_MSG_WARNING("Trigger " << name << " can only be in one coherent prescale group.");
        newTriggerPtr->setCPS(group); // This changes the CPSID
        const size_t CPSID = newTriggerPtr->getCPSID();
        // Find the lowest prescale of any member in this CPS group
        m_lowestPrescale.try_emplace(CPSID, FLT_MAX);
        if (prescale < m_lowestPrescale[CPSID]) m_lowestPrescale[CPSID] = prescale;
      }
    }
  }
 
  // Add to total rates
  const uint32_t level = getLevel(name);
  if (m_doGlobalGroups) {
    if      (level == 2) m_globalGroups.at(m_l2GroupName)->addToGroup( newTriggerPtr );
    else if (level == 1) m_globalGroups.at(m_l1GroupName)->addToGroup( newTriggerPtr );
  }
  // Add to express group - if express prescale is enabled
  if (level == 2 && expressPrescale >= 1) {
    if (m_doGlobalGroups) m_globalGroups.at(m_expressGroupName)->addToGroup( newTriggerPtr );
    if (m_doExpressRates) m_expressTriggers.insert( newTriggerPtr );
  }
 
  ATH_MSG_DEBUG("newTrigger " <<  name << " added");
  return StatusCode::SUCCESS;
}

newTrigger() [2/2]

StatusCode RatesAnalysisAlg::newTrigger	(	const std::string &	name,
		const double	prescale = 1.,
		const double	expressPrescale = -1.,
		const std::string &	seedName = "",
		const double	seedPrecale = 1.,
		const std::string &	groups = "",
		const Method_t	method = kMANUAL,
		const ExtrapStrat_t	extrapolation = kLINEAR )

Version of newTrigger which accepts a set of group names rather than a comma separated string.

Definition at line 89 of file RatesAnalysisAlg.cxx.

                                     {
 
  std::set<std::string> groupSet;
  std::istringstream ss(groups);
  while (ss) {
    std::string group;
    if (!std::getline(ss, group, ',')) break;
    groupSet.insert(group);
  }
 
  return newTrigger(name, prescale, expressPrescale, seedName, seedPrecale, groupSet, method, extrapolation);
}

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< 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.

outputMetaStore() [1/2]

ServiceHandle< StoreGateSvc > & AthAnalysisAlgorithm::outputMetaStore ( )

inlineinherited

Accessor for the output metadata store.

Definition at line 55 of file AthAnalysisAlgorithm.h.

{ return m_outputMetaStore; }

outputMetaStore() [2/2]

const ServiceHandle< StoreGateSvc > & AthAnalysisAlgorithm::outputMetaStore ( ) const

inlineinherited

Const accessor for the output metadata store.

Definition at line 53 of file AthAnalysisAlgorithm.h.

{ return m_outputMetaStore; }

pass_HstpFilter()

StatusCode RatesAnalysisAlg::pass_HstpFilter ( bool & pass )

protected

Boolean indicating if the event passes the HS-softer-than-PU (HSTP) filter.

Definition at line 613 of file RatesAnalysisAlg.cxx.

                                                      {
 
  if (!m_doMultiSliceDiJet) {
    return StatusCode::SUCCESS;
  };
 
  SG::ReadHandle<xAOD::JetContainer> truthHS_jets(m_truthHS_jets_RHKey);
  ATH_CHECK( truthHS_jets.isValid() );
  SG::ReadHandle<xAOD::JetContainer> truthPU_jets(m_truthPU_jets_RHKey);
  ATH_CHECK( truthPU_jets.isValid() );  
 
  // Extract the pT of the leading jet that defines the hardness. The jet containers should always be pT sorted
  const double pT_j1_truthPU = truthPU_jets->size() ? truthPU_jets->front()->pt() : 0; // Hardest PU truth jet
  const double pT_j1_truthHS = truthHS_jets->size() ? truthHS_jets->front()->pt() : 5000; // In the rare case of no HS truth jets in the event, assume it is close to the 5 GeV threshold
  
  // Now see if we pass the filter.
  pass = pT_j1_truthHS > pT_j1_truthPU;
  ATH_MSG_DEBUG("Hard Scatter (" << pT_j1_truthHS/1000. << " GeV) Harder Than Pileup (" << pT_j1_truthPU/1000. << " GeV) filter " << (pass ? "PASSES" : "FAILS"));
  return StatusCode::SUCCESS;
}

populateTriggers()

StatusCode RatesAnalysisAlg::populateTriggers ( )

private

Register all triggers to emulate.

This is actually done at the start of the event loop such that the TDT has access to the configuration.

Definition at line 403 of file RatesAnalysisAlg.cxx.

                                              {  
  // Let user add their triggers
  ATH_MSG_INFO("Initializing User's Triggers (note: we are actually now in the event loop)");
 
  if (m_doGlobalGroups) {
    m_globalGroups.emplace(m_l1GroupName,      std::make_unique<RatesGroup>(m_l1GroupName, msgSvc(),      m_doHistograms, m_enableLumiExtrapolation));
    m_globalGroups.emplace(m_l2GroupName,      std::make_unique<RatesGroup>(m_l2GroupName, msgSvc(),      m_doHistograms, m_enableLumiExtrapolation));
    m_globalGroups.at(m_l2GroupName)->setDoCachedWeights( m_doUniqueRates ); // This extra sub-weight caching is only utilised by unique-rate groups
    if (m_doExpressRates) {
      m_globalGroups.emplace(m_expressGroupName, std::make_unique<RatesGroup>(m_expressGroupName, msgSvc(), m_doHistograms, m_enableLumiExtrapolation));
      m_globalGroups.at(m_expressGroupName)->setExpressGroup( true );
    }
  }
 
  // This runs the derived class's code to add whatever triggers are desired.
  // Should be calling newTrigger(...), newScanTrigger(...) or addExisting(...), addAllExisting().
  ATH_CHECK( ratesInitialize() ); 
 
  ATH_MSG_INFO("Computing coherent factors for coherent prescale groups.");
  // Now we are not going to get any more chains - we can fill in the coherent prescale factors
  for (const auto& trigger : m_triggers) {
    const size_t CPSID = trigger.second->getCPSID();
    if (CPSID != 0) trigger.second->setCoherentFactor( m_lowestPrescale.at(CPSID) );
  }
 
  if (m_doUniqueRates && m_doGlobalGroups) {
    ATH_MSG_INFO("Creating extra groups to calculate unique rates.");
    const RatesGroup* l2GroupPtr = m_globalGroups.at(m_l2GroupName).get(); // The finalised list of all HLT chains
    const RatesGroup* l1GroupPtr = m_globalGroups.at(m_l1GroupName).get(); // The finalised list of all L1 chains
    for (const auto& trigger : m_triggers) {
      const uint32_t level = getLevel(trigger.first);
      m_uniqueGroups.emplace(trigger.first, std::make_unique<RatesGroup>(trigger.first, msgSvc(), false, m_enableLumiExtrapolation)); // Each trigger gets its own unique group. No hist needed
      RatesTrigger* triggerPtr = m_triggers.at(trigger.first).get();
      RatesGroup* uniqueGroupPtr = m_uniqueGroups.at(trigger.first).get();
      triggerPtr->setUniqueGroup( uniqueGroupPtr ); // Create two-way links
      uniqueGroupPtr->setUniqueTrigger( triggerPtr ); // Create two-way links
      // Copy in the global rates topology and make note of the unique rates master group
      if      (level == 2) uniqueGroupPtr->duplicateChildren( l2GroupPtr );
      else if (level == 1) uniqueGroupPtr->duplicateChildren( l1GroupPtr );
      else continue;
      // Remove this one chain from the group (a unique rate is the rate of the entire menu minus one chain)
      uniqueGroupPtr->removeFromGroup( triggerPtr );
      if (getLevel(trigger.first) == 2) {
        // For HLT, we can be more computationally efficient by utilising cached info from the hlt group
        // We remove from the group all other L1 seeds except for the one seeding our chain.
        // This sub-weight is the only one which can change. The combined weight of all other L1 seeds
        // can be cached by the master group and fetched from there.
        uniqueGroupPtr->removeOtherL1( triggerPtr ); 
        uniqueGroupPtr->setUseCachedWeights(true);
      }
      // Efficiency - if the trigger is disabled, no need to actually calculate anything for it.
      if (trigger.second->getDisabled() == false) {
        m_activeGroups.insert( uniqueGroupPtr ); // Add this to the event loop
      }
    }
  }
 
  ATH_MSG_INFO("Retrieving HLT chain's ID and Group from HLT menu.");
 
  if(!m_configSvc.empty() && m_configSvc.isValid()) {
    const TrigConf::HLTMenu& hltmenu = m_configSvc->hltMenu( Gaudi::Hive::currentContext() );
    
    TrigConf::HLTMenu::const_iterator chain_itr = hltmenu.begin();
    TrigConf::HLTMenu::const_iterator chain_end = hltmenu.end();
 
    m_hltChainIDGroup.resize(hltmenu.size());
    for (size_t i = 0; i < hltmenu.size(); i++) m_hltChainIDGroup.at(i).resize(3);
 
    size_t c = 0;
    for( ; chain_itr != chain_end; ++chain_itr ) {
      std::string chainName = ( *chain_itr ).name() ;
      unsigned int chainID = ( *chain_itr ).counter();
      std::vector<std::string> chainGroups = ( *chain_itr ).groups();
      for (std::string& stream : (*chain_itr).streams()){
        chainGroups.push_back("STREAM:" + stream);
      }
      std::string singlechainGroups = "";
      for (unsigned int j=0; j < chainGroups.size(); ++j){
        if (j==0) singlechainGroups += chainGroups[j];
        else singlechainGroups += ", "+chainGroups[j];
      }
            
      m_hltChainIDGroup.at(c).at(0) = chainName;
      m_hltChainIDGroup.at(c).at(1) = std::to_string(chainID);
      m_hltChainIDGroup.at(c).at(2) = singlechainGroups;
      ++c;
    }
  }
 
  ATH_MSG_INFO("Retrieving L1 item's ID from L1 menu.");
 
  if(!m_configSvc.empty() && m_configSvc.isValid()) {
    const TrigConf::L1Menu& l1menu = m_configSvc->l1Menu( Gaudi::Hive::currentContext() );
 
    m_l1ItemID.resize(l1menu.size());
    for (size_t i = 0; i < l1menu.size(); i++) {
      // No groups for items
      m_l1ItemID.at(i).resize(2);
    }
    
    TrigConf::L1Menu::const_iterator item_itr = l1menu.begin();
    TrigConf::L1Menu::const_iterator item_end = l1menu.end();
 
    size_t c = 0;
    for( ; item_itr != item_end; ++item_itr ) {
      m_l1ItemID.at(c).at(0) =  (*item_itr).name();
      m_l1ItemID.at(c).at(1) = std::to_string((*item_itr).ctpId());
      ++c;
    }
  }
 
  // Print all triggers
  if (msgLevel(MSG::DEBUG)) {
    if (m_triggers.size()) {
      ATH_MSG_DEBUG("################## Configured to estimate rates for the following triggers:");
      for (const auto& trigger : m_triggers) ATH_MSG_DEBUG(trigger.second->printConfig());
    }
    if (m_scanTriggers.size()) {
      ATH_MSG_DEBUG("################## Configured to estimate rates for the following scan triggers:");
      for (const auto& trigger : m_scanTriggers) ATH_MSG_DEBUG(trigger.second->printConfig());
    }
    if (m_groups.size()) {
      ATH_MSG_DEBUG("################## Configured to estimate rates for the following groups of triggers:");
      for (const auto& group : m_groups) ATH_MSG_DEBUG(group.second->printConfig());
    }
    if (m_globalGroups.size()) {
      ATH_MSG_DEBUG("################## Configured to estimate rates for the following global groups of triggers:");
      for (const auto& group : m_globalGroups) ATH_MSG_DEBUG(group.second->printConfig());
    }
  }
  if (m_doHistograms) {
    ATH_MSG_DEBUG("################## Registering normalisation histogram:");
    m_scalingHist = new TH1D(std::format("normalisation{}",m_histogramSuffix.value()).c_str(),";;",3,0.,3.);
    ATH_CHECK( histSvc()->regHist("/RATESTREAM/normalisation" + m_histogramSuffix, m_scalingHist) );
    m_bcidHist = new TH1D("bcid",";BCID;Events",3565,-.5,3564.5);
    ATH_CHECK( histSvc()->regHist("/RATESTREAM/bcid", m_bcidHist) );
    ATH_MSG_DEBUG("################## Registering metadata tree histogram:");
    ATH_CHECK( histSvc()->regTree("/RATESTREAM/metadata", std::make_unique<TTree>("metadata", "metadata")) );
    ATH_CHECK( histSvc()->getTree("/RATESTREAM/metadata", m_metadataTree) );
    if (m_triggers.size()) {
    ATH_MSG_DEBUG("################## Registering trigger histograms:");
      for (const auto& trigger : m_triggers) {
        if (!trigger.second->doHistograms()) continue; // Not all may be doing histograming
    std::string lvlSubdir = "";
        if (trigger.second->getName().find("L1") == 0){
          lvlSubdir = "Rate_ChainL1_HLT/";
        } else if (trigger.second->getName().find("HLT") == 0) {
          lvlSubdir = "Rate_ChainHLT_HLT/";
        }
        trigger.second->setDataName("data"+m_histogramSuffix);
        ATH_CHECK( trigger.second->giveDataHist(histSvc(), std::string("/RATESTREAM/All/" + lvlSubdir + trigger.first + "/data")) );
        trigger.second->setRateVsMuName("rateVsMu"+m_histogramSuffix);
        ATH_CHECK( trigger.second->giveMuHist(histSvc(), std::string("/RATESTREAM/All/" + lvlSubdir + trigger.first + "/rateVsMu")) );
        if (m_useBunchCrossingData) {
          trigger.second->setRateVsTrainName("rateVsTrain"+m_histogramSuffix);
          ATH_CHECK( trigger.second->giveTrainHist(histSvc(), std::string("/RATESTREAM/All/" + lvlSubdir + trigger.first + "/rateVsTrain")) );
        } else trigger.second->clearTrainHist();
      }
    }
    if (m_scanTriggers.size()) {
    ATH_MSG_DEBUG("################## Registering scan trigger histograms:");
      for (const auto& trigger : m_scanTriggers) {
        trigger.second->setHistoName("rateVsThreshold"+m_histogramSuffix);
        ATH_CHECK( trigger.second->giveThresholdHist(histSvc(), std::string("/RATESTREAM/ScanTriggers/" + trigger.first + "/rateVsThreshold" + m_histogramSuffix)) );
      }
    }
    if (m_groups.size()) {
      ATH_MSG_DEBUG("################## Registering group histograms:");
      for (const auto& group : m_groups) {
        if (!group.second->doHistograms()) continue;
        std::string groupName = group.first;
        std::replace( groupName.begin(), groupName.end(), ':', '_');
        group.second->setDataName("data"+m_histogramSuffix);
        ATH_CHECK( group.second->giveDataHist(histSvc(), std::string("/RATESTREAM/All/Rate_Group_HLT/" + groupName + "/data")) );
        group.second->setRateVsMuName("rateVsMu"+m_histogramSuffix);
        ATH_CHECK( group.second->giveMuHist(histSvc(), std::string("/RATESTREAM/All/Rate_Group_HLT/" + groupName + "/rateVsMu")) );
        if (m_useBunchCrossingData) {
          group.second->setRateVsTrainName("rateVsTrain"+m_histogramSuffix);
          ATH_CHECK( group.second->giveTrainHist(histSvc(), std::string("/RATESTREAM/All/Rate_Group_HLT/" + groupName + "/rateVsTrain")) );
        } else group.second->clearTrainHist();
      }
    }
    if (m_globalGroups.size()) {
      ATH_MSG_DEBUG("################## Registering global group histograms:");
      for (const auto& group : m_globalGroups) {
        if (!group.second->doHistograms()) continue;
        group.second->setDataName("data"+m_histogramSuffix);
        ATH_CHECK( group.second->giveDataHist(histSvc(), std::string("/RATESTREAM/All/Rate_Group_HLT/RATE_GLOBAL_" + group.first + "/data")) );
        group.second->setRateVsMuName("rateVsMu"+m_histogramSuffix);
        ATH_CHECK( group.second->giveMuHist(histSvc(), std::string("/RATESTREAM/All/Rate_Group_HLT/RATE_GLOBAL_" + group.first + "/rateVsMu")) );
        if (m_useBunchCrossingData){
        group.second->setRateVsTrainName("rateVsTrain"+m_histogramSuffix);
        ATH_CHECK( group.second->giveTrainHist(histSvc(), std::string("/RATESTREAM/All/Rate_Group_HLT/RATE_GLOBAL_" + group.first + "/rateVsTrain")) );
        } else group.second->clearTrainHist();
      }
    }
  }
 
  // Has the user set a lumi extrapolation? If not - set a default
  if (m_enableLumiExtrapolation && m_targetLumi == 0) setTargetLumi(1e34);
 
  // We now know the final lumi scaling so we can set the bunch scaling
  const uint32_t ebPairedBunches = m_enhancedBiasRatesTool->getPairedBunches();
  ATH_MSG_INFO("Number of paired bunches in input file:" << m_enhancedBiasRatesTool->getPairedBunches());
  m_weightingValues.m_bunchFactor = m_targetBunches / (double)ebPairedBunches;
 
  return StatusCode::SUCCESS;
}

printInputSummary()

void RatesAnalysisAlg::printInputSummary ( ) const

private

Print the input data instantaneous luminosity, mu and number of bunches.

Note this is averaged as the data are processed - so should only be printed at the end.

Definition at line 846 of file RatesAnalysisAlg.cxx.

                                               {
  ATH_MSG_INFO("Input " << (m_enhancedBiasRatesTool->isMC() ? "MC" : "EB Data") 
    << " with <L_inst.> = "
    << m_enhancedBiasRatesTool->getAverageLumi() 
    << " cm-2s-1, <mu> = "
    << m_enhancedBiasRatesTool->getAverageMu()
    << ", paired bunches = " 
    << m_enhancedBiasRatesTool->getPairedBunches());
}

printStatistics()

void RatesAnalysisAlg::printStatistics ( ) const

private

Print some extra statistics on events processed.

Definition at line 842 of file RatesAnalysisAlg.cxx.

                                             {
  ATH_MSG_INFO("Processed " << m_eventCounter << " raw events, " << m_weightedEventCounter << " weighted. Total LHC wall-time of " << m_ratesDenominator << " s.");
}

printTarget()

void RatesAnalysisAlg::printTarget ( ) const

private

Print the target instantaneous luminosity, mu and number of bunches.

Definition at line 834 of file RatesAnalysisAlg.cxx.

                                         {
  if (m_enableLumiExtrapolation) {
    ATH_MSG_INFO("Calculating rates for a target L_inst. = " << m_targetLumi << " cm-2s-1, mu = " << m_targetMu << ", paired bunches = " << m_targetBunches);
  } else {
    ATH_MSG_INFO("Luminosity extrapolation is switched off. Input files will determin the paired bunches, L_inst. and mu profile.");
  }
}

ratesExecute()

virtual StatusCode RatesAnalysisAlg::ratesExecute ( )

pure virtual

To be implemented by the user.

Supply pass/fail for all "triggers"

Implemented in FullMenu, L1TopoRatesCalculator, and RatesEmulationExample.

ratesFinalize()

virtual StatusCode RatesAnalysisAlg::ratesFinalize ( )

pure virtual

To be implemented by the user.

Implemented in FullMenu, L1TopoRatesCalculator, and RatesEmulationExample.

ratesInitialize()

virtual StatusCode RatesAnalysisAlg::ratesInitialize ( )

pure virtual

To be implemented by the user.

Register "triggers" to calculate the rate for

Implemented in FullMenu, L1TopoRatesCalculator, and RatesEmulationExample.

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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

retrieveMetadata() [1/2]

template<typename T>

StatusCode AthAnalysisAlgorithm::retrieveMetadata ( const std::string & folder, const std::string & key, T & out )

inlineinherited

Helper function to access IOVMetaDataContainer information helped in the MetaDataStore.

Definition at line 65 of file AthAnalysisAlgorithm.h.

                                                                                                            {
        try {
            return AthAnalysisHelper::retrieveMetadata(folder,key,out,inputMetaStore());
        } catch(std::exception& e) {
            ATH_MSG_WARNING(e.what());
            return StatusCode::FAILURE;
        }
    }

retrieveMetadata() [2/2]

template<typename T>

StatusCode AthAnalysisAlgorithm::retrieveMetadata ( const std::string & folder, const std::string & key, T & out, const IOVTime & time, int channel = -1 )

inlineinherited

Helper function to access IOVMetaDataContainer information held in InputMetaDataStore, but will check IOVTime.

Also can give a channel (leave as -1 to take first available) IOVTime(runNumber, eventNumber) is a valid constructor for example

Definition at line 76 of file AthAnalysisAlgorithm.h.

                                                                                                                                                 {
        try {
            return AthAnalysisHelper::retrieveMetadata(folder,key,out,inputMetaStore(),time,channel);
        } catch(std::exception& e) {
            ATH_MSG_WARNING(e.what());
            return StatusCode::FAILURE;
        }
    }

setExponentialMuScalingFactor()

void RatesAnalysisAlg::setExponentialMuScalingFactor ( const double f )

inline

Set the exponential scaling factor for relevant chains.

scaling = exp(f * (targetMu - eventMu))

Parameters

f	Exponential factor

Definition at line 184 of file RatesAnalysisAlg.h.

{ m_expoScalingFactor = f; }

setTargetLumi()

void RatesAnalysisAlg::setTargetLumi ( const double lumi )

inline

Set the target instantaneous luminosity.

Assumes a full-ring. Mu is derived.

Parameters

lumi	The target lumi in cm-2s-1

Definition at line 172 of file RatesAnalysisAlg.h.

{ setTargetLumiBunches(lumi, EnhancedBiasWeighter::FULL_RING); }

setTargetLumiBunches()

void RatesAnalysisAlg::setTargetLumiBunches	(	const double	lumi,
		const int32_t	bunches )

Set the target instantaneous luminosity and number of bunches.

Mu is derived.

Parameters

lumi	The target lumi in cm-2s-1
bunches	The target number of paired bunches

Definition at line 796 of file RatesAnalysisAlg.cxx.

                                                                                    {
  if (m_eventCounter > 1) { // All settings must be defined before we start looping over the sample
    ATH_MSG_WARNING("Too late to call setTargetLumiBunches. Do this during ratesInitialize().");
    return;
  }
  m_targetLumi = lumi;
  if (bunches == 0) {
    ATH_MSG_WARNING("Cannot have bunches = 0. Setting to 1.");
    m_targetBunches = 1;
  } else {
    m_targetBunches = bunches;
  }
  m_targetMu = (lumi * m_inelasticCrossSection) / (bunches * EnhancedBiasWeighter::LHC_FREQUENCY);
  printTarget();
}

setTargetLumiMu()

void RatesAnalysisAlg::setTargetLumiMu	(	const double	lumi,
		const double	mu )

Set the target instantaneous luminosity and mu.

Number of bunches in the ring is derived.

Parameters

lumi	The target lumi in cm-2s-1
mu	The target pileup

Definition at line 776 of file RatesAnalysisAlg.cxx.

                                                                         {
  if (m_eventCounter > 1) { // All settings must be defined before we start looping over the sample
    ATH_MSG_WARNING("Too late to call setTargetLumiMu. Do this during ratesInitialize().");
    return;
  }
  m_targetLumi = lumi;
  if (isZero(mu)) {
    ATH_MSG_WARNING("Cannot have <mu> = 0. Setting to 1.");
    m_targetMu = 1;
  } else {
    m_targetMu = mu;
  }
  m_targetBunches = round((lumi * m_inelasticCrossSection) / (mu * EnhancedBiasWeighter::LHC_FREQUENCY));
  if (m_targetBunches == 0 || m_targetBunches > EnhancedBiasWeighter::FULL_RING) {
    ATH_MSG_WARNING("Un-physical number of bunches " << m_targetBunches << ", should be within 1 < N < " << EnhancedBiasWeighter::FULL_RING+1);
    if (m_targetBunches == 0) ++m_targetBunches;
  }
  printTarget();
}

setTargetMu()

void RatesAnalysisAlg::setTargetMu ( const double mu )

inline

Set the target pileup.

Assumes a full-ring. Inst. lumi is derived.

Parameters

mu	The target pileup

Definition at line 178 of file RatesAnalysisAlg.h.

{ setTargetMuBunches(mu, EnhancedBiasWeighter::FULL_RING); } 

setTargetMuBunches()

void RatesAnalysisAlg::setTargetMuBunches	(	const double	mu,
		const int32_t	bunches )

Set the target mu and number of bunches.

The instantaneous luminosity is derived.

Parameters

mu	The target pileup
bunches	The target number of paired bunches

Definition at line 813 of file RatesAnalysisAlg.cxx.

                                                                                {
  if (m_eventCounter > 1) { // All settings must be defined before we start looping over the sample
    ATH_MSG_WARNING("Too late to call setTargetMuBunches. Do this during ratesInitialize().");
    return;
  }
  if (bunches == 0) {
    ATH_MSG_WARNING("Cannot have paired bunches = 0. Setting to 1.");
    m_targetBunches = 1;
  } else {
    m_targetBunches = bunches;
  }
  if (isZero(mu)) {
    ATH_MSG_WARNING("Cannot have mu = 0. Setting to 1.");
    m_targetMu = 1;
  } else {
    m_targetMu = mu;
  }
  m_targetLumi = (mu * bunches * EnhancedBiasWeighter::LHC_FREQUENCY) / m_inelasticCrossSection;
  printTarget();
}

setTriggerDesicison() [1/2]

StatusCode RatesAnalysisAlg::setTriggerDesicison	(	const std::string &	name,
		const bool	triggerIsPassed = true,
		const bool	triggerIsActive = true )

Set the pass/fail decision for an item.

Parameters

name	Name of the registered trigger
triggerIsPassed	Trigger decision.

Definition at line 346 of file RatesAnalysisAlg.cxx.

                                                                                                                              {
  // Currently - we call execute on setPassed, so the user would be unable to overwrite a decision set e.g. by the TDT.
  // so for now we only accept positive decisions here.
  if (triggerIsPassed || triggerIsActive) {
    const auto iterator = m_triggers.find(name);
    if (iterator == m_triggers.end()) {
      ATH_MSG_ERROR("Cannot find trigger " << name << " did you call newTrigger for this in initialize?");
      return StatusCode::FAILURE;
    }
    iterator->second->setPassedAndExecute(triggerIsPassed, triggerIsActive, m_weightingValues); // There is logic in the RatesTrigger to prevent multiple calls per event by accident.
    m_activatedTriggers.insert( iterator->second.get() );
  }
  return StatusCode::SUCCESS;
}

setTriggerDesicison() [2/2]

StatusCode RatesAnalysisAlg::setTriggerDesicison	(	const std::string &	name,
		const double	threshold )

Set the pass threshold for a Scan Trigger item.

Parameters

name	Name of the registered scan-trigger
threshold	The passed threshold in the event

Definition at line 362 of file RatesAnalysisAlg.cxx.

                                                                                              {
  const auto iterator = m_scanTriggers.find(name);
  if (iterator == m_scanTriggers.end()) {
    ATH_MSG_ERROR("Cannot find scan-trigger " << name << " did you call newScanTrigger for this in initialize?");
    return StatusCode::FAILURE;
  }
  iterator->second->setPassedAndExecute(threshold, m_weightingValues); // There is logic in the RatesScanTrigger to prevent multiple calls per event by accident.
  m_activatedTriggers.insert( static_cast<RatesTrigger*>(iterator->second.get()));
  return StatusCode::SUCCESS;
}

sysExecute()

StatusCode AthAnalysisAlgorithm::sysExecute ( const EventContext & ctx )

overridevirtualinherited

override to do firstEvent method

Definition at line 72 of file AthAnalysisAlgorithm.cxx.

                                                                   {
  if(!m_doneFirstEvent) {
    m_doneFirstEvent=true;
    if( firstExecute().isFailure() ) {
      ATH_MSG_FATAL("Failure in firstEvent method");
      return StatusCode::FAILURE;
    }
  }
  return AthHistogramAlgorithm::sysExecute(ctx);
}

sysInitialize()

StatusCode AthAnalysisAlgorithm::sysInitialize ( )

overridevirtualinherited

Function initialising the tool in the correct way in Athena.

Reimplemented from AthHistogramAlgorithm.

Definition at line 50 of file AthAnalysisAlgorithm.cxx.

                                               {
 
      // Connect to the IncidentSvc:
      ServiceHandle< IIncidentSvc > incSvc( "IncidentSvc", name() );
      ATH_CHECK( incSvc.retrieve() );
 
      // Set up the right callbacks: //but ensure we don't double-register if sysInitialize called twice (appears to be the case)
      incSvc->removeListener( this, IncidentType::BeginInputFile );
      incSvc->addListener( this, IncidentType::BeginInputFile, 0, true );
      incSvc->removeListener( this, IncidentType::EndInputFile );
      incSvc->addListener( this, IncidentType::EndInputFile, 0, true );
      incSvc->removeListener( this, "MetaDataStop" );
      incSvc->addListener( this, "MetaDataStop", 0, true );
 
 
      // Let the base class do its thing:
      ATH_CHECK( AthHistogramAlgorithm::sysInitialize() );
 
      // Return gracefully:
      return StatusCode::SUCCESS;
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< 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.

tree()

TTree * AthHistogramming::tree ( const std::string & treeName, const std::string & tDir = "", const std::string & stream = "" )

protectedinherited

Simplify the retrieval of registered TTrees.

Definition at line 378 of file AthHistogramming.cxx.

{
  // Build a 32 bit hash out of the name
  const hash_t treeHash = this->hash(treeName);
 
  // See if this entry exists in the map
  TreeMap_t::const_iterator it = m_treeMap.find( treeHash );
  if ( it == m_treeMap.end() ) // It doesn't exist!
    { // Let's see into the THistSvc if somebody else has registered the TTree...
 
      // Need to copy the strings as we will massage them from here on
      std::string treeNameCopy = treeName;
      std::string tDirCopy     = tDir;
      std::string streamCopy   = stream;
 
      // Massage the final string to book things
      std::string bookingString("");
      this->buildBookingString( bookingString, treeNameCopy, tDirCopy, streamCopy );
 
      TTree* treePointer(NULL);
      if ( !((histSvc()->getTree(bookingString, treePointer)).isSuccess()) )
        {
          m_msg << MSG::WARNING
                << "Problem retrieving the TTree with name " << treeNameCopy
                << " in " << m_name << "... it doesn't exist, neither in the cached map nor in the THistSvc!"
                << " Will return an NULL pointer... you have to handle it correctly!" << endmsg;
          return NULL;
        }
      // If we get to here, we actually found the TTree in the THistSvc.
      // So let's add it to the local cache map and return its pointer
      m_treeMap.insert( m_treeMap.end(), std::pair< const hash_t, TTree* >( treeHash, treePointer ) );
      return treePointer;
    }
 
  // Return the pointer to the TTree that we got from the local cache map
  return it->second;
}

updateEvtStore()

void AthAnalysisAlgorithm::updateEvtStore ( Gaudi::Details::PropertyBase & prop )

protectedinherited

Definition at line 45 of file AthAnalysisAlgorithm.cxx.

                                                                        {
  evtStore().release().ignore(); 
  evtStore().setTypeAndName(prop.toString());
}

updateVHKA()

void AthCommonDataStore< AthCommonMsg< 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);
      }
    }
  }

writeMetadata()

void RatesAnalysisAlg::writeMetadata ( )

private

Write to outpute tree (if any) the metadata needed downstream.

Definition at line 873 of file RatesAnalysisAlg.cxx.

                                     {
  if (!m_metadataTree) {
    return;
  }
  m_runNumber = m_enhancedBiasRatesTool->getRunNumber();
  m_metadataTree->Branch("runNumber", &m_runNumber);
  m_metadataTree->Branch("targetMu", &m_targetMu);
  m_metadataTree->Branch("targetBunches", &m_targetBunches);
  m_metadataTree->Branch("targetLumi", &m_targetLumi);
  
  double bunchCrossingRate = m_enhancedBiasRatesTool->getBunchCrossingRate();
  m_metadataTree->Branch("bunchCrossingRate", &bunchCrossingRate);
  int doMultiSliceDiJet = m_doMultiSliceDiJet;
  m_metadataTree->Branch("multiSliceDiJet", &doMultiSliceDiJet);
 
  std::vector<std::string> triggers;
  std::vector<std::string> lowers;
  std::vector<double> prescales;
  std::vector<double> express;
  triggers.reserve(m_triggers.size());
  lowers.reserve(m_triggers.size());
  prescales.reserve(m_triggers.size());
  express.reserve(m_triggers.size());
  for (const auto& trigger : m_triggers) {
    triggers.push_back(trigger.first);
    lowers.push_back(trigger.second->getSeedName());
    prescales.push_back(trigger.second->getPrescale() );
    express.push_back(trigger.second->getPrescale(true /*includeExpress*/) );
  }
  for (const auto& group : m_groups) {
    triggers.push_back(group.first);
    lowers.push_back("-");
    prescales.push_back(-1);
    express.push_back(-1);
  }
  for (const auto& group : m_globalGroups) {
    triggers.push_back("RATE_GLOBAL_" + group.first);
    lowers.push_back("-");
    prescales.push_back(-1);
    express.push_back(-1);
  }
  m_metadataTree->Branch("triggers", &triggers);
  m_metadataTree->Branch("lowers", &lowers);
  m_metadataTree->Branch("prescales", &prescales);
  m_metadataTree->Branch("express", &express);
  std::vector<int32_t> bunchGroups;
  bunchGroups.reserve(16);
 
  uint32_t masterKey = 0;
  uint32_t hltPrescaleKey = 0;
  uint32_t lvl1PrescaleKey = 0;
 
  if(!m_enhancedBiasRatesTool->isMC()){
    bunchGroups = m_enhancedBiasRatesTool->getBunchGroups();
  }
  if(!m_configSvc.empty() && m_configSvc.isValid() ){
    if  ((bunchGroups.size() == 0 || std::all_of(bunchGroups.begin(), bunchGroups.end(), [](int i) { return i==0; }) ) && (!m_enhancedBiasRatesTool->isMC())) {
      const TrigConf::L1BunchGroupSet& bgs = m_configSvc->l1BunchGroupSet(Gaudi::Hive::currentContext());
      for (size_t i = 0; i < bgs.maxNBunchGroups(); ++i ) {
        bunchGroups.push_back(bgs.getBunchGroup(i)->size());
      }
    }
    masterKey = m_configSvc->masterKey();
    hltPrescaleKey = m_configSvc->hltPrescaleKey();
    lvl1PrescaleKey = m_configSvc->lvl1PrescaleKey();
  }
 
      
  m_metadataTree->Branch("bunchGroups", &bunchGroups);
  
  m_metadataTree->Branch("hltChainIDGroup", &m_hltChainIDGroup);
  m_metadataTree->Branch("l1ItemID", &m_l1ItemID);
 
  m_metadataTree->Branch("masterKey", &masterKey);
  m_metadataTree->Branch("lvl1PrescaleKey", &lvl1PrescaleKey);
  m_metadataTree->Branch("hltPrescaleKey", &hltPrescaleKey);
  std::string atlasProject = std::getenv("AtlasProject");
  std::string atlasVersion = std::getenv("AtlasVersion");
  m_metadataTree->Branch("AtlasProject", &atlasProject);
  m_metadataTree->Branch("AtlasVersion", &atlasVersion);
  m_metadataTree->Fill();
}

Member Data Documentation

m_activatedTriggers

std::unordered_set<RatesTrigger*> RatesAnalysisAlg::m_activatedTriggers

private

Triggers which were changed & hence need to be reset at the event end.

Definition at line 255 of file RatesAnalysisAlg.h.

m_activeGroups

std::unordered_set<RatesGroup*> RatesAnalysisAlg::m_activeGroups

private

All groups which are enabled (PS >= 1)

Definition at line 257 of file RatesAnalysisAlg.h.

m_autoTriggers

std::vector<std::string> RatesAnalysisAlg::m_autoTriggers

private

List of triggers which it is up to us to the algorithm to work out the pass/fail for.

Definition at line 259 of file RatesAnalysisAlg.h.

m_bcidHist

TH1D* RatesAnalysisAlg::m_bcidHist

private

Histogram of the BCIDs distribution of the processing.

Definition at line 300 of file RatesAnalysisAlg.h.

m_configSvc

ServiceHandle<TrigConf::ITrigConfigSvc> RatesAnalysisAlg::m_configSvc {this, "TrigConfigSvc", "TrigConf::xAODConfigSvc"}

private

Definition at line 273 of file RatesAnalysisAlg.h.

{this, "TrigConfigSvc", "TrigConf::xAODConfigSvc"};

m_currentEventIsUnbiased

Gaudi::Property<bool> RatesAnalysisAlg::m_currentEventIsUnbiased

private

If the current event was triggered online by RDx or not.

Random seeded HLT chains must only see these

Definition at line 286 of file RatesAnalysisAlg.h.

m_currentFile

TFile* AthAnalysisAlgorithm::m_currentFile {nullptr}

privateinherited

Definition at line 120 of file AthAnalysisAlgorithm.h.

{nullptr}; //used to cache the current file

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_doExpressRates

Gaudi::Property<bool> RatesAnalysisAlg::m_doExpressRates {this, "DoExpressRates", false, "Calculate total rates for the express stream."}

private

Definition at line 284 of file RatesAnalysisAlg.h.

{this, "DoExpressRates", false, "Calculate total rates for the express stream."};

m_doGlobalGroups

Gaudi::Property<bool> RatesAnalysisAlg::m_doGlobalGroups {this, "DoGlobalGroups", false, "Calculate total rates for each trigger level."}

private

Definition at line 282 of file RatesAnalysisAlg.h.

{this, "DoGlobalGroups", false, "Calculate total rates for each trigger level."};

m_doHistograms

Gaudi::Property<bool> RatesAnalysisAlg::m_doHistograms {this, "DoHistograms", true, "Switch on histogram output of rate vs. mu and position in train."}

protected

Definition at line 191 of file RatesAnalysisAlg.h.

{this, "DoHistograms", true, "Switch on histogram output of rate vs. mu and position in train."};

m_doMultiSliceDiJet

Gaudi::Property<bool> RatesAnalysisAlg::m_doMultiSliceDiJet {this, "DoMultiSliceDiJet", false, "Enable the HS-softer-than-PU (HSTP) filter; reweight the Slices according to Jet/ETMiss procedure; recommended by PMG for di-jet slices."}

protected

Definition at line 192 of file RatesAnalysisAlg.h.

{this, "DoMultiSliceDiJet", false, "Enable the HS-softer-than-PU (HSTP) filter; reweight the Slices according to Jet/ETMiss procedure; recommended by PMG for di-jet slices."};

m_doneFirstEvent

bool AthAnalysisAlgorithm::m_doneFirstEvent {false}

privateinherited

Definition at line 122 of file AthAnalysisAlgorithm.h.

{false};

m_doTriggerGroups

Gaudi::Property<bool> RatesAnalysisAlg::m_doTriggerGroups {this, "DoTriggerGroups", false, "Calculate total rates for each group of triggers."}

private

Definition at line 283 of file RatesAnalysisAlg.h.

{this, "DoTriggerGroups", false, "Calculate total rates for each group of triggers."};

m_doUniqueRates

Gaudi::Property<bool> RatesAnalysisAlg::m_doUniqueRates {this, "DoUniqueRates", false, "Calculate unique rates for all chains (slow). Requires DoGlobalGroups=True too."}

private

Definition at line 281 of file RatesAnalysisAlg.h.

{this, "DoUniqueRates", false, "Calculate unique rates for all chains (slow). Requires DoGlobalGroups=True too."}; 

m_effMap

EffMap_t AthHistogramming::m_effMap

privateinherited

The map of histogram names to their pointers.

Definition at line 208 of file AthHistogramming.h.

m_enableLumiExtrapolation

Gaudi::Property<bool> RatesAnalysisAlg::m_enableLumiExtrapolation {this, "EnableLumiExtrapolation", true, "If false then no extrapolation in L, N_bunch or <mu> will be performed.."}

private

Definition at line 287 of file RatesAnalysisAlg.h.

{this, "EnableLumiExtrapolation", true, "If false then no extrapolation in L, N_bunch or <mu> will be performed.."};

m_enhancedBiasRatesTool

ToolHandle<IEnhancedBiasWeighter> RatesAnalysisAlg::m_enhancedBiasRatesTool {this, "EnhancedBiasRatesTool", "EnhancedBiasWeighter/EnhancedBiasRatesTool"}

private

Definition at line 271 of file RatesAnalysisAlg.h.

{this, "EnhancedBiasRatesTool", "EnhancedBiasWeighter/EnhancedBiasRatesTool"};

m_eventCounter

uint32_t RatesAnalysisAlg::m_eventCounter

private

Count how many events processed.

Definition at line 296 of file RatesAnalysisAlg.h.

m_eventInfoKey

SG::ReadHandleKey<xAOD::EventInfo> RatesAnalysisAlg::m_eventInfoKey {this, "EventInfo", "EventInfo", "EventInfo name"}

private

Definition at line 275 of file RatesAnalysisAlg.h.

{this, "EventInfo", "EventInfo", "EventInfo name"}; 

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_existingTriggers

std::unordered_map<std::string, const Trig::ChainGroup*> RatesAnalysisAlg::m_existingTriggers

private

Map of triggers which we ask the TDT ChainGroup for the pass/fail.

Definition at line 261 of file RatesAnalysisAlg.h.

m_expoScalingFactor

Gaudi::Property<double> RatesAnalysisAlg::m_expoScalingFactor {this, "ExpoScalingFactor", 0.1, "Optional. Exponential factor if using exponential-mu rates scaling."}

private

Definition at line 279 of file RatesAnalysisAlg.h.

{this, "ExpoScalingFactor", 0.1, "Optional. Exponential factor if using exponential-mu rates scaling."};

m_expressGroupName

const std::string RatesAnalysisAlg::m_expressGroupName = "Express"

private

Definition at line 269 of file RatesAnalysisAlg.h.

m_expressTriggers

std::unordered_set<RatesTrigger*> RatesAnalysisAlg::m_expressTriggers

private

Triggers with non-zero express PS, used to print them at the end.

Definition at line 256 of file RatesAnalysisAlg.h.

m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

m_globalGroups

std::unordered_map<std::string, std::unique_ptr<RatesGroup> > RatesAnalysisAlg::m_globalGroups

private

Big (master) groups which do the OR of the whole menu.

Definition at line 252 of file RatesAnalysisAlg.h.

m_graphMap

GraphMap_t AthHistogramming::m_graphMap

privateinherited

The map of TGraph names to their pointers.

Definition at line 222 of file AthHistogramming.h.

m_groups

std::unordered_map<std::string, std::unique_ptr<RatesGroup> > RatesAnalysisAlg::m_groups

private

All regular and CPS groups.

Definition at line 251 of file RatesAnalysisAlg.h.

m_histMap

HistMap_t AthHistogramming::m_histMap

privateinherited

The map of histogram names to their pointers.

Definition at line 201 of file AthHistogramming.h.

m_histNamePostfix

std::string AthHistogramAlgorithm::m_histNamePostfix

privateinherited

The postfix for the histogram THx name.

Definition at line 97 of file AthHistogramAlgorithm.h.

m_histNamePrefix

std::string AthHistogramAlgorithm::m_histNamePrefix

privateinherited

The prefix for the histogram THx name.

Definition at line 94 of file AthHistogramAlgorithm.h.

m_histogramSuffix

Gaudi::Property<std::string> RatesAnalysisAlg::m_histogramSuffix {this, "histogramSuffix", "", "Optional suffix to add to the name of the rate denominator histogram."}

private

Definition at line 290 of file RatesAnalysisAlg.h.

{this, "histogramSuffix", "", "Optional suffix to add to the name of the rate denominator histogram."};

m_histSvc

ServiceHandle<ITHistSvc> AthHistogramAlgorithm::m_histSvc

privateinherited

Default constructor: AthHistogramAlgorithm();.

a handle on the Hist/TTree registration service

Definition at line 83 of file AthHistogramAlgorithm.h.

m_histTitlePostfix

std::string AthHistogramAlgorithm::m_histTitlePostfix

privateinherited

The postfix for the histogram THx title.

Definition at line 103 of file AthHistogramAlgorithm.h.

m_histTitlePrefix

std::string AthHistogramAlgorithm::m_histTitlePrefix

privateinherited

The prefix for the histogram THx title.

Definition at line 100 of file AthHistogramAlgorithm.h.

m_hltChainIDGroup

std::vector<std::vector<std::string> > RatesAnalysisAlg::m_hltChainIDGroup

private

Definition at line 264 of file RatesAnalysisAlg.h.

m_inelasticCrossSection

Gaudi::Property<double> RatesAnalysisAlg::m_inelasticCrossSection {this, "InelasticCrossSection", 8e-26, "Inelastic cross section in units cm^2. Default 80 mb at 13 TeV."}

private

Definition at line 280 of file RatesAnalysisAlg.h.

{this, "InelasticCrossSection", 8e-26, "Inelastic cross section in units cm^2. Default 80 mb at 13 TeV."};

m_inputMetaStore

ServiceHandle< StoreGateSvc > AthAnalysisAlgorithm::m_inputMetaStore

privateinherited

Object accessing the input metadata store.

Definition at line 116 of file AthAnalysisAlgorithm.h.

m_l1GroupName

const std::string RatesAnalysisAlg::m_l1GroupName = "L1"

private

Definition at line 267 of file RatesAnalysisAlg.h.

m_l1ItemID

std::vector<std::vector<std::string> > RatesAnalysisAlg::m_l1ItemID

private

Definition at line 265 of file RatesAnalysisAlg.h.

m_l2GroupName

const std::string RatesAnalysisAlg::m_l2GroupName = "HLT"

private

Definition at line 268 of file RatesAnalysisAlg.h.

m_linearLumiFactor

double RatesAnalysisAlg::m_linearLumiFactor

protected

Definition at line 188 of file RatesAnalysisAlg.h.

m_lowerTrigger

std::unordered_map<std::string, std::string> RatesAnalysisAlg::m_lowerTrigger

private

Map of triggers lower chain, to tell if a HLT trigger ran or not.

Definition at line 262 of file RatesAnalysisAlg.h.

m_lowestPrescale

std::unordered_map<size_t, double> RatesAnalysisAlg::m_lowestPrescale

private

Lowest prescale within a CPS group, key is the hash of the CPS group name.

Definition at line 258 of file RatesAnalysisAlg.h.

m_metadataTree

TTree* RatesAnalysisAlg::m_metadataTree

private

Used to write out some metadata needed by post-processing (e.g.

bunchgroup, lumi)

Definition at line 302 of file RatesAnalysisAlg.h.

m_msg

MsgStream AthHistogramming::m_msg

privateinherited

Cached Message Stream.

Definition at line 248 of file AthHistogramming.h.

m_name

std::string AthHistogramming::m_name

privateinherited

Instance name.

Definition at line 245 of file AthHistogramming.h.

m_outputMetaStore

ServiceHandle< StoreGateSvc > AthAnalysisAlgorithm::m_outputMetaStore

privateinherited

Object accessing the output metadata store.

Definition at line 118 of file AthAnalysisAlgorithm.h.

m_prefix

std::string AthHistogramAlgorithm::m_prefix

privateinherited

Name of the ROOT output stream (file)

Definition at line 88 of file AthHistogramAlgorithm.h.

m_prescalesJSON

Gaudi::Property<std::map<std::string, std::map<std::string, double> > > RatesAnalysisAlg::m_prescalesJSON {this, "PrescalesJSON", {}, "Optional JSON of prescales from the TrigMenuRuleBook to apply."}

private

Definition at line 289 of file RatesAnalysisAlg.h.

{this, "PrescalesJSON", {},  "Optional JSON of prescales from the TrigMenuRuleBook to apply."};

m_ratesDenominator

double RatesAnalysisAlg::m_ratesDenominator

protected

How much walltime is seen by the algorithm.

This is what we need to normalise to.

Definition at line 190 of file RatesAnalysisAlg.h.

m_rootDir

std::string AthHistogramAlgorithm::m_rootDir

privateinherited

Name of the ROOT directory.

Definition at line 91 of file AthHistogramAlgorithm.h.

m_runNumber

uint32_t RatesAnalysisAlg::m_runNumber

private

What is the RunNumber.

Definition at line 295 of file RatesAnalysisAlg.h.

m_scalingHist

TH1D* RatesAnalysisAlg::m_scalingHist

private

One-bin histogram to store the normalisation of the sample, for use in later combinations.

Definition at line 299 of file RatesAnalysisAlg.h.

m_scanTriggers

std::unordered_map<std::string, std::unique_ptr<RatesScanTrigger> > RatesAnalysisAlg::m_scanTriggers

private

All individual rates-scan triggers (L1 or HLT)

Definition at line 250 of file RatesAnalysisAlg.h.

m_streamName

std::string AthHistogramming::m_streamName

privateinherited

Name of the ROOT output stream (file)

Definition at line 226 of file AthHistogramming.h.

m_targetBunches

double RatesAnalysisAlg::m_targetBunches

private

How many bunches the prediction is targeting.

Definition at line 293 of file RatesAnalysisAlg.h.

m_targetLumi

double RatesAnalysisAlg::m_targetLumi

private

What instantaneous luminosity the prediction is targeting.

Definition at line 294 of file RatesAnalysisAlg.h.

m_targetMu

double RatesAnalysisAlg::m_targetMu

private

What pileup level the prediction is targeting.

Definition at line 292 of file RatesAnalysisAlg.h.

m_tdt

ToolHandle<Trig::TrigDecisionTool> RatesAnalysisAlg::m_tdt {this, "TrigDecisionTool", "Trig::TrigDecisionTool/TrigDecisionTool"}

private

Definition at line 272 of file RatesAnalysisAlg.h.

{this, "TrigDecisionTool", "Trig::TrigDecisionTool/TrigDecisionTool"};

m_treeMap

TreeMap_t AthHistogramming::m_treeMap

privateinherited

The map of TTree names to their pointers.

Definition at line 215 of file AthHistogramming.h.

m_triggers

std::unordered_map<std::string, std::unique_ptr<RatesTrigger> > RatesAnalysisAlg::m_triggers

protected

All individual triggers (L1 or HLT)

Definition at line 195 of file RatesAnalysisAlg.h.

m_truthHS_jets_RHKey

SG::ReadHandleKey<xAOD::JetContainer> RatesAnalysisAlg::m_truthHS_jets_RHKey {this, "TruthHSJetsKey", "AntiKt4TruthJets", "Key for the hard scatter truth jet collection"}

private

Definition at line 276 of file RatesAnalysisAlg.h.

{this, "TruthHSJetsKey", "AntiKt4TruthJets", "Key for the hard scatter truth jet collection"};

m_truthPU_jets_RHKey

SG::ReadHandleKey<xAOD::JetContainer> RatesAnalysisAlg::m_truthPU_jets_RHKey {this, "truthPUJetsKey", "InTimeAntiKt4TruthJets", "Key for the pileup jet collection"}

private

Definition at line 277 of file RatesAnalysisAlg.h.

{this, "truthPUJetsKey", "InTimeAntiKt4TruthJets", "Key for the pileup jet collection"};

m_uniqueGroups

std::unordered_map<std::string, std::unique_ptr<RatesGroup> > RatesAnalysisAlg::m_uniqueGroups

private

Groups used to obtain unique rates for chains.

Definition at line 253 of file RatesAnalysisAlg.h.

m_useBunchCrossingData

Gaudi::Property<bool> RatesAnalysisAlg::m_useBunchCrossingData {this, "UseBunchCrossingData", true, "BunchCrossing data requires CONDBR2 access. Can be disabled here if this is a problem."}

private

Definition at line 285 of file RatesAnalysisAlg.h.

{this, "UseBunchCrossingData", true, "BunchCrossing data requires CONDBR2 access. Can be disabled here if this is a problem."};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vetoStartOfTrain

Gaudi::Property<uint32_t> RatesAnalysisAlg::m_vetoStartOfTrain {this, "VetoStartOfTrain", 0, "How many BCID to veto at the start of a bunch train."}

private

Definition at line 288 of file RatesAnalysisAlg.h.

{this, "VetoStartOfTrain", 0, "How many BCID to veto at the start of a bunch train."};

m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

m_weightedEventCounter

double RatesAnalysisAlg::m_weightedEventCounter

private

Count how many weighted events were processed.

Definition at line 297 of file RatesAnalysisAlg.h.

m_weightingValues

WeightingValuesSummary_t RatesAnalysisAlg::m_weightingValues

protected

Possible weighting & lumi extrapolation values for the current event.

Definition at line 189 of file RatesAnalysisAlg.h.

---

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

• RatesAnalysisAlg.h
• RatesAnalysisAlg.cxx