EnhancedBiasWeighter Class Reference

Tool to calculate data-driven rates using EnhancedBias datasets. More...

#include <EnhancedBiasWeighter.h>

Inheritance diagram for EnhancedBiasWeighter:

Public Member Functions
	EnhancedBiasWeighter (const std::string &name)
virtual StatusCode	initialize () override
	Initialize is required by AsgTool base class.
virtual StatusCode	finalize () override
virtual StatusCode	addBranches (const EventContext &ctx) const override
	Decorate the AOD with EnhancedBias weighting quantities such that no CVMFS or DB access is required on subsequent passes through the dAOD to perform rates.
virtual double	getEBWeight (const xAOD::EventInfo *eventInfo) const override
virtual double	getEBWeight (const EventContext &context) const override
virtual double	getBunchCrossingRate () const override
virtual double	getEBLiveTime (const xAOD::EventInfo *eventInfo) const override
virtual double	getEBLiveTime (const EventContext &context) const override
virtual double	getLBLength (const xAOD::EventInfo *eventInfo) const override
virtual double	getLBLength (const EventContext &context) const override
virtual double	getLBLumi (const xAOD::EventInfo *eventInfo) const override
virtual double	getLBLumi (const EventContext &context) const override
virtual double	getAverageLumi () const override
virtual double	getAverageMu () const override
virtual double	getDeadtime (const int lumiblock=-1) const override
virtual uint32_t	getPairedBunches () const override
virtual StatusCode	getDistanceIntoTrain (const xAOD::EventInfo *eventInfo, uint32_t &distance, const EventContext &ctx) const override
virtual uint32_t	getRunNumber () const override
virtual bool	isUnbiasedEvent (const xAOD::EventInfo *eventInfo) const override
virtual bool	isGoodLB (const xAOD::EventInfo *eventInfo) const override
virtual bool	isGoodLB (const EventContext &context) const override
virtual bool	isMC () const override
virtual std::unordered_map< std::string, ChainDetail >	parsePrescaleXML (const std::string &prescaleXML) const override
	Parse a presscale XML and return a ordered summary of its content To make most use of the XML parsing available already in this class.
virtual const std::vector< int32_t > &	getBunchGroups () const override
virtual void	print () const
	Print the state of the tool.
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	sysInitialize () override
	Perform system initialization for an algorithm.
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
	DeclareInterfaceID (IAugmentationTool, 1, 0)
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Static Public Attributes
static constexpr double	LHC_FREQUENCY = 11245.5
static constexpr uint32_t	FULL_RING = 2738
	Number of bunches in a full ring.

Protected Member Functions
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.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	loadWeights ()
	Read into memory from XML event weights for this EnhancedBias run.
StatusCode	loadLumi ()
	Read into memory this EnhancedBias run's XML.
StatusCode	trackAverages (const xAOD::EventInfo *eventInfo) const
	Internal function to keep track of the mean instantaneous lumi & mean pileup of the EB/MC sample being processed.
StatusCode	trackAverages (const EventContext &context) const
int32_t	getEventEBID (const xAOD::EventInfo *eventInfo) const
int32_t	getEventEBID (const EventContext &context) const
std::string	findLocalFile (const std::string &fileName) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadCondHandleKey< BunchCrossingCondData >	m_bunchCrossingKey {this, "BunchCrossingKey", "BunchCrossingData", "Key BunchCrossing CDO" }
	Tool to get distance into bunch train.
Gaudi::Property< uint32_t >	m_runNumber {this, "RunNumber", 0, "Run we're processing (if data), needed at initialize to locate and read in extra configuration."}
Gaudi::Property< bool >	m_errorOnMissingEBWeights {this, "ErrorOnMissingEBWeights", false, "If true, Throws error if EB weights are missing."}
Gaudi::Property< bool >	m_enforceEBGRL {this, "EnforceEBGRL", true, "Each Enhanced Bias run has a 'good run list' style veto on some LB. If this flag is true, events in these LB get weight 0"}
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_isMC {this, "IsMC", false, "MC mode? If so we need a cross section and filter efficiency"}
Gaudi::Property< double >	m_mcCrossSection {this, "MCCrossSection", 0.0, "If running over MC. The process cross section in nb (AMI gives thins in nb)"}
Gaudi::Property< double >	m_mcFilterEfficiency {this, "MCFilterEfficiency", 1.0, "If running over MC. The process filter efficiency (0.0-1.0)"}
Gaudi::Property< double >	m_mcKFactor {this, "MCKFactor", 1.0, "If running over MC. The process filter efficiency (0.0-1.0)"}
Gaudi::Property< bool >	m_mcIgnoreGeneratorWeights {this, "MCIgnoreGeneratorWeights", false, "If running over MC. Flag to ignore the generator weight."}
Gaudi::Property< double >	m_inelasticCrossSection {this, "InelasticCrossSection", 8e-26, "Inelastic cross section in units cm^2. Default 80 mb at 13 TeV."}
Gaudi::Property< std::string >	m_weightsDirectory {this, "EBWeightsDirectory", "", "Path to directory with EB XML weights files, if empty they will be read from calibration area"}
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."}
Gaudi::Property< double >	m_targetLumi {this, "TargetLuminosity", 2e34, "Targer inst. luminosity, assuming full ring."}
double	m_deadtime
	Online deadtime to correct for in rate prediction.
uint32_t	m_pairedBunches
	Online number of paired bunches.
double	m_mcModifiedCrossSection
	Product of xsec, filter & kfactor.
std::unordered_map< uint64_t, int32_t >	m_eventNumberToIdMap
	Map event number to a weighting ID.
std::unordered_map< uint32_t, float > m_eventLivetime	ATLAS_THREAD_SAFE
	Cache of per-event livetime as a function of LB [LB -> effective walltime per event].
std::mutex	m_mutex
	Protection for above map.
Gaudi::Accumulators::AveragingCounter< double > m_lumiAverage	ATLAS_THREAD_SAFE
	The average instantaneous lumionosity over all events.
Gaudi::Accumulators::AveragingCounter< double > m_muAverage	ATLAS_THREAD_SAFE
	The average mu over all events.
std::unordered_map< int32_t, double >	m_idToWeightMap
	Map a weighting ID to a Enhanced Bias event weight.
std::unordered_map< int32_t, uint8_t >	m_idToUnbiasedMap
	Map a weighting ID to a flag if this weight is from an unbiased (RD) trigger online.
std::unordered_map< uint32_t, uint32_t >	m_eventsPerLB
	Map of how many EnhancedBias events were recorded per LB.
std::unordered_map< uint32_t, double >	m_lumiPerLB
	Map of instantaneous luminosity per LB.
std::unordered_map< uint32_t, uint8_t >	m_goodLB
	Like a Good Run List flag for EnhancedBias runs.
std::unordered_map< uint32_t, double >	m_deadtimePerLB
	Map of average deadtime per LB.
std::vector< int32_t >	m_bunches
	Number of BCIDs in each bunch group.
ReadLumiBlock	m_readLumiBlock
	Cache lumi block lengths.
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Tool to calculate data-driven rates using EnhancedBias datasets.

Definition at line 47 of file EnhancedBiasWeighter.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

EnhancedBiasWeighter()

EnhancedBiasWeighter::EnhancedBiasWeighter

(

const std::string &

name

)

Definition at line 29 of file EnhancedBiasWeighter.cxx.

  : asg::AsgTool( name ),
  m_deadtime(1.),
  m_pairedBunches(0),
  m_mcModifiedCrossSection(0.)
{}

Member Function Documentation

addBranches()

StatusCode EnhancedBiasWeighter::addBranches ( const EventContext & ctx ) const

overridevirtual

Decorate the AOD with EnhancedBias weighting quantities such that no CVMFS or DB access is required on subsequent passes through the dAOD to perform rates.

addBranches is required by DerivationFramework::AugmentationTool

Implements DerivationFramework::IAugmentationTool.

Definition at line 722 of file EnhancedBiasWeighter.cxx.

{
  // Set up the decorator
  SG::AuxElement::Decorator< double >   decoratorEBWeight("EnhancedBiasWeight"); 
  SG::AuxElement::Decorator< double >   decoratorEBLivetime("EnhancedBiasLivetime"); 
  SG::AuxElement::Decorator< double >   decoratorLBLumi("LBLumi"); 
  SG::AuxElement::Decorator< double >   decoratorDeadtime("Deadtime"); 
  SG::AuxElement::Decorator< uint32_t > decoratorBCIDDistanceFromFront("BCIDDistanceFromFront"); 
  SG::AuxElement::Decorator< char >     decoratorUnbiasedFlag("IsUnbiasedEventFlag");
  SG::AuxElement::Decorator< char >     decoratorGoodLBFlag("IsGoodLBFlag");  
 
  const xAOD::EventInfo* eventInfo(nullptr);
  uint32_t distance = 0;
  ATH_CHECK( evtStore()->retrieve(eventInfo, "EventInfo") ); // FIXME Use Handles
  ATH_CHECK( getDistanceIntoTrain(eventInfo, distance, ctx) );
 
  decoratorEBWeight(*eventInfo) = getEBWeight(eventInfo);
  decoratorEBLivetime(*eventInfo) = getEBLiveTime(eventInfo);
  decoratorLBLumi(*eventInfo) = getLBLumi(eventInfo);
  decoratorUnbiasedFlag(*eventInfo) = isUnbiasedEvent(eventInfo);
  decoratorGoodLBFlag(*eventInfo) = isGoodLB(eventInfo);
  decoratorDeadtime(*eventInfo) = getDeadtime(eventInfo->lumiBlock());
  decoratorBCIDDistanceFromFront(*eventInfo) = distance;
 
  return StatusCode::SUCCESS;
}

declareGaudiProperty()

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

DeclareInterfaceID()

DerivationFramework::IAugmentationTool::DeclareInterfaceID ( IAugmentationTool , 1 , 0  )

inherited

declareProperty()

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

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::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; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::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

finalize()

StatusCode EnhancedBiasWeighter::finalize ( )

overridevirtual

Definition at line 69 of file EnhancedBiasWeighter.cxx.

{
  ATH_MSG_DEBUG ("Finalizing " << name() << "...");
  return StatusCode::SUCCESS;
}

findLocalFile()

std::string EnhancedBiasWeighter::findLocalFile ( const std::string & fileName ) const

private

Definition at line 750 of file EnhancedBiasWeighter.cxx.

                                                                              {
 
  if (m_weightsDirectory.empty()) {
    ATH_MSG_ERROR("Local directory for EB xml not set!");
    return "";
  }
 
  std::string fullName = m_weightsDirectory+ "/" + fileName;
 
  if (!std::filesystem::exists(fullName)) {
    ATH_MSG_ERROR("File " << fullName << " not found!");
    return "";
  }
 
  return fullName;
}

getAverageLumi()

double EnhancedBiasWeighter::getAverageLumi ( ) const

overridevirtual

Returns

The mean luminosity of all events seen

Implements IEnhancedBiasWeighter.

Definition at line 711 of file EnhancedBiasWeighter.cxx.

{
  return m_lumiAverage.mean();
}

getAverageMu()

double EnhancedBiasWeighter::getAverageMu ( ) const

overridevirtual

Returns

<mu> over all events seen

Implements IEnhancedBiasWeighter.

Definition at line 716 of file EnhancedBiasWeighter.cxx.

{
  return m_muAverage.mean();
}

getBunchCrossingRate()

double EnhancedBiasWeighter::getBunchCrossingRate ( ) const

overridevirtual

Returns

The bunch crossing rate

Implements IEnhancedBiasWeighter.

Definition at line 470 of file EnhancedBiasWeighter.cxx.

                                                        {
  return m_pairedBunches * LHC_FREQUENCY;
}

getBunchGroups()

virtual const std::vector< int32_t > & EnhancedBiasWeighter::getBunchGroups ( ) const

inlineoverridevirtual

Returns

The number of BCIDs in each bunch group

Implements IEnhancedBiasWeighter.

Definition at line 174 of file EnhancedBiasWeighter.h.

{ return m_bunches; }

getDeadtime()

double EnhancedBiasWeighter::getDeadtime ( const int lumiblock = -1 ) const

overridevirtual

Returns

the fractional deadtime in the event. Reported as function per LB if value is available else a fixed number There is no deadtime in MC, so for MC this will always return 1. Retrieved from CVMFS XML or fetched from TRIG1 dAOD

Implements IEnhancedBiasWeighter.

Definition at line 684 of file EnhancedBiasWeighter.cxx.

{
  if (m_isMC) {
    return 1.;
  }
  else if (m_deadtimePerLB.count(lumiblock)) {
    return m_deadtimePerLB.at(lumiblock);
  }
  return m_deadtime;
}

getDistanceIntoTrain()

StatusCode EnhancedBiasWeighter::getDistanceIntoTrain ( const xAOD::EventInfo * eventInfo, uint32_t & distance, const EventContext & ctx ) const

overridevirtual

Returns

How far into the current train this BCID is. Retrieved from the database using the BunchCrossingCondData or fetched from TRIG1 dAOD

Implements IEnhancedBiasWeighter.

Definition at line 700 of file EnhancedBiasWeighter.cxx.

{
  if (!m_useBunchCrossingData) return StatusCode::SUCCESS;
 
  SG::ReadCondHandle<BunchCrossingCondData> bunchCrossingTool (m_bunchCrossingKey, ctx);
  ATH_CHECK( bunchCrossingTool.isValid() );
  distance = bunchCrossingTool->distanceFromFront( eventInfo->bcid(), BunchCrossingCondData::BunchDistanceType::BunchCrossings );
 
  return StatusCode::SUCCESS;
}

getEBLiveTime() [1/2]

double EnhancedBiasWeighter::getEBLiveTime ( const EventContext & context ) const

overridevirtual

Implements IEnhancedBiasWeighter.

Definition at line 515 of file EnhancedBiasWeighter.cxx.

{
    if (m_isMC) {
 
      ATH_MSG_ERROR( "Cannot use EventContext based getEBLiveTime with MC. Needs full EventInfo.");
      return 0.;
 
    } else {
 
      uint32_t lumiBlock = context.eventID().lumi_block();
      std::lock_guard<std::mutex> scopeLock(m_mutex);
 
      // Check the cache
      const auto inCacheIterator = m_eventLivetime.find( lumiBlock );
      if (inCacheIterator != m_eventLivetime.end()) return inCacheIterator->second;
 
      // Else calculate
      const auto mapIterator = m_eventsPerLB.find(lumiBlock);
      if (mapIterator == m_eventsPerLB.end() ) {
        if (m_errorOnMissingEBWeights) {
          ATH_MSG_ERROR( "Couldn't find LB info for LB: " << lumiBlock );
        }
        return 0.;
      } 
      const int32_t eventsInThisLB = mapIterator->second;
      const double lbLength = m_readLumiBlock.getLumiBlockLength(lumiBlock, msg());
      // This event is one in eventsInThisLB, so has an effective temporal contribution of:
      double eventLivetime = 0;
      if (eventsInThisLB > 0 && fabs(lbLength) > 1e-10) eventLivetime = (1. / static_cast<double>(eventsInThisLB)) * lbLength;
      // Cache this (mutable)
      m_eventLivetime[lumiBlock] = eventLivetime;
      return eventLivetime;
 
    } // isData
 
}

getEBLiveTime() [2/2]

double EnhancedBiasWeighter::getEBLiveTime ( const xAOD::EventInfo * eventInfo ) const

overridevirtual

Returns

The amount of online walltime contributed by this event For data, this is based on the LB length and the number of events in the LB For MC, this is fixed by the sample cross section, the inelastic cross section and the mu of the current event. Retrieved from COOL and CVMFS XML or fetched from TRIG1 dAOD

Implements IEnhancedBiasWeighter.

Definition at line 473 of file EnhancedBiasWeighter.cxx.

{
    if (m_isMC) {
 
      // Probability that a single pp interaction yields this MC process (ratio of xsec)
      const double probOfProcess = m_mcModifiedCrossSection / m_inelasticCrossSection; 
      // Probability that a single bunch-crossing yeild this MC process. Binomial statistics (1 - Prob(exactly 0 interactions, given mu interactions)).
      const double probOfBunchCrossing = 1. - std::pow( 1. - probOfProcess, std::ceil(eventInfo->actualInteractionsPerCrossing()) );
      const double bunchCrossingRate = m_pairedBunches * LHC_FREQUENCY;
      // How much wall-time does this event represent? This is the reciprocal of the rate, which is the % per crossing scaled by the crossing rate.
      ATH_MSG_DEBUG("MC livetime debug: probOfProcess:" << probOfProcess << " probOfBunchCrossing:" << probOfBunchCrossing << " bunchCrossingRate:" << bunchCrossingRate << " time:" << (1. / (probOfBunchCrossing * bunchCrossingRate)));
      return 1. / (probOfBunchCrossing * bunchCrossingRate);
 
    } else {
 
      uint32_t lumiBlock = eventInfo->lumiBlock();
      std::lock_guard<std::mutex> scopeLock(m_mutex);
 
      // Check the cache
      const auto inCacheIterator = m_eventLivetime.find( lumiBlock );
      if (inCacheIterator != m_eventLivetime.end()) return inCacheIterator->second;
 
      // Else calculate
      const auto mapIterator = m_eventsPerLB.find(lumiBlock);
      if (mapIterator == m_eventsPerLB.end() ) {
        if (m_errorOnMissingEBWeights) {
          ATH_MSG_ERROR( "Couldn't find LB info for LB: " << lumiBlock );
        }
        return 0;
      } 
      const int32_t eventsInThisLB = mapIterator->second;
      const double lbLength = m_readLumiBlock.getLumiBlockLength(lumiBlock, msg());
      // This event is one in eventsInThisLB, so has an effective temporal contribution of:
      double eventLivetime = 0;
      if (eventsInThisLB > 0 && fabs(lbLength) > 1e-10) eventLivetime = (1. / static_cast<double>(eventsInThisLB)) * lbLength;
      // Cache this (mutable)
      m_eventLivetime[lumiBlock] = eventLivetime;
      return eventLivetime;
 
    } // isData
}

getEBWeight() [1/2]

double EnhancedBiasWeighter::getEBWeight ( const EventContext & context ) const

overridevirtual

Implements IEnhancedBiasWeighter.

Definition at line 428 of file EnhancedBiasWeighter.cxx.

{
 
  if (m_enforceEBGRL && !isGoodLB(context)) {
    return 0;
  }
 
  ATH_CHECK( trackAverages(context), 0 );
 
  if (m_isMC) {
 
    ATH_MSG_ERROR( "Cannot use EventContext based getEBWeight with MC. Needs full EventInfo.");
    return 0.;
 
  } else { // isData
 
    int32_t ebID = getEventEBID(context);
    const auto mapIterator = m_idToWeightMap.find(ebID);
    if (mapIterator == m_idToWeightMap.end() ) {
      ATH_MSG_ERROR( "Couldn't find enhanced bias weight for event with ID " << ebID);
      return 0;
    }
    return mapIterator->second;
 
  } // isData
}

getEBWeight() [2/2]

double EnhancedBiasWeighter::getEBWeight ( const xAOD::EventInfo * eventInfo ) const

overridevirtual

Returns

The effective number of events this one event represents from online, given EnhancedBias online prescales. For MC, this is the generator weight Retrieved from CVMFS XML, EventInfo (MC) or fetched from TRIG1 dAOD

Implements IEnhancedBiasWeighter.

Definition at line 391 of file EnhancedBiasWeighter.cxx.

{
  if (m_enforceEBGRL && !isGoodLB(eventInfo)) {
    return 0;
  }
 
  ATH_CHECK( trackAverages(eventInfo), 0 );
 
  if (m_isMC && m_doMultiSliceDiJet) {
    return static_cast<double>(eventInfo->mcEventWeight(0)) * m_mcModifiedCrossSection * m_targetLumi;
 
  } else if (m_isMC) {
 
    if (m_mcIgnoreGeneratorWeights) {
      return 1.;
    }
 
    const std::vector<float> weights = eventInfo->mcEventWeights();
    if (weights.size() > 0) {
      return weights[0];
    }
    return 1.;
 
  } else { // isData
 
    int32_t ebID = getEventEBID(eventInfo);
    const auto mapIterator = m_idToWeightMap.find(ebID);
    if (mapIterator == m_idToWeightMap.end() ) {
      ATH_MSG_ERROR( "Couldn't find enhanced bias weight for event with ID " << ebID);
      return 0;
    }
    return mapIterator->second;
 
  } // isData
}

getEventEBID() [1/2]

int32_t EnhancedBiasWeighter::getEventEBID ( const EventContext & context ) const

private

Definition at line 372 of file EnhancedBiasWeighter.cxx.

{
  const uint64_t eventNumber = context.eventID().event_number();
 
  const auto mapIterator = m_eventNumberToIdMap.find(eventNumber);
  if (mapIterator != m_eventNumberToIdMap.end()) {
    return mapIterator->second;
  }
  // Unfortunately, earlier weighting XMLs have 32 bit signed event number. Hence we also have to try this option
  const int32_t eventNumber32 = static_cast<int32_t>(eventNumber);
  const auto mapIterator32 = m_eventNumberToIdMap.find(eventNumber32);
  if (mapIterator32 != m_eventNumberToIdMap.end()) {
    return mapIterator32->second;
  } else {
    ATH_MSG_ERROR( "Couldn't find enhanced bias info for event " << eventNumber);
    return -1;
  } 
}

getEventEBID() [2/2]

int32_t EnhancedBiasWeighter::getEventEBID ( const xAOD::EventInfo * eventInfo ) const

private

Returns

Internal mapping of an event number to a weight ID. Retrieved from CVMFS XML or fetched from TRIG1 dAOD

Definition at line 353 of file EnhancedBiasWeighter.cxx.

{
  const uint64_t eventNumber = eventInfo->eventNumber();
 
  const auto mapIterator = m_eventNumberToIdMap.find(eventNumber);
  if (mapIterator != m_eventNumberToIdMap.end()) {
    return mapIterator->second;
  }
  // Unfortunately, earlier weighting XMLs have 32 bit signed event number. Hence we also have to try this option
  const int32_t eventNumber32 = static_cast<int32_t>(eventNumber);
  const auto mapIterator32 = m_eventNumberToIdMap.find(eventNumber32);
  if (mapIterator32 != m_eventNumberToIdMap.end()) {
    return mapIterator32->second;
  } else {
    ATH_MSG_ERROR( "Couldn't find enhanced bias info for event " << eventNumber);
    return -1;
  } 
}

getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

getLBLength() [1/2]

double EnhancedBiasWeighter::getLBLength ( const EventContext & context ) const

overridevirtual

Implements IEnhancedBiasWeighter.

Definition at line 565 of file EnhancedBiasWeighter.cxx.

                                                                          {
  if (m_isMC) {
    ATH_MSG_ERROR( "getLBLength Does not work for MC.");
    return 0.;
  } else {
    uint32_t lumiBlock = context.eventID().lumi_block();
    const double lbLength = m_readLumiBlock.getLumiBlockLength(lumiBlock, msg());
    return lbLength;
  } // isData
}

getLBLength() [2/2]

double EnhancedBiasWeighter::getLBLength ( const xAOD::EventInfo * eventInfo ) const

overridevirtual

Returns

The length of the current LB in seconds. Only for data Retrieved from COOL, only for data

Implements IEnhancedBiasWeighter.

Definition at line 552 of file EnhancedBiasWeighter.cxx.

                                                                             {
  if (m_isMC) {
    ATH_MSG_ERROR( "getLBLength Does not work for MC.");
    return 0.;
  } else {
    uint32_t lumiBlock = eventInfo->lumiBlock();
    const double lbLength = m_readLumiBlock.getLumiBlockLength(lumiBlock, msg());
    return lbLength;
  } // isData
}

getLBLumi() [1/2]

double EnhancedBiasWeighter::getLBLumi ( const EventContext & context ) const

overridevirtual

Implements IEnhancedBiasWeighter.

Definition at line 664 of file EnhancedBiasWeighter.cxx.

{
  if (m_isMC) {
 
    ATH_MSG_ERROR( "Cannot use EventContext based getLBLumi with MC. Needs full EventInfo.");
    return 0.;
 
  } else { // isData
 
    uint32_t lumiBlock = context.eventID().lumi_block();
    const auto mapIterator = m_lumiPerLB.find(lumiBlock);
    if (mapIterator == m_lumiPerLB.end() ) {
      ATH_MSG_ERROR( "Couldn't find lumi info for LB: " << lumiBlock );
      return 0.;
    }
    return mapIterator->second;
 
  } // isData
}

getLBLumi() [2/2]

double EnhancedBiasWeighter::getLBLumi ( const xAOD::EventInfo * eventInfo ) const

overridevirtual

Returns

the instantaneous luminosity for the current event in units of cm-2s-1. For data, based on the current LB For MC, based on the event mu Retrieved from CVMFS XML or fetched from TRIG1 dAOD

Implements IEnhancedBiasWeighter.

Definition at line 644 of file EnhancedBiasWeighter.cxx.

{
  if (m_isMC) {
 
    const double mu = std::ceil( eventInfo->actualInteractionsPerCrossing() );
    return (mu * LHC_FREQUENCY * m_pairedBunches) / m_inelasticCrossSection;
 
  } else { // isData
 
    uint32_t lumiBlock = eventInfo->lumiBlock();
    const auto mapIterator = m_lumiPerLB.find(lumiBlock);
    if (mapIterator == m_lumiPerLB.end() ) {
      ATH_MSG_ERROR( "Couldn't find lumi info for LB: " << lumiBlock );
      return 0.;
    }
    return mapIterator->second;
 
  } // isData
}

getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

getPairedBunches()

uint32_t EnhancedBiasWeighter::getPairedBunches ( ) const

overridevirtual

Returns

The number of colliding bunches in the Enhanced Bias run being used. For MC this will return the number of bunches which corresponds to a full-ring. Retrieved from CVMFS XML or fetched from TRIG1 dAOD

Implements IEnhancedBiasWeighter.

Definition at line 695 of file EnhancedBiasWeighter.cxx.

{
  return m_pairedBunches;
}

getProperty()

template<class T>

const T * asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

getRunNumber()

uint32_t EnhancedBiasWeighter::getRunNumber ( ) const

overridevirtual

Returns

the RunNumber.

Implements IEnhancedBiasWeighter.

Definition at line 640 of file EnhancedBiasWeighter.cxx.

                                                  {
  return m_runNumber;
}

initialize()

StatusCode EnhancedBiasWeighter::initialize ( void )

overridevirtual

Initialize is required by AsgTool base class.

Check if we're MC or data, and if data check if we're to load the weighting info or read it from the input file

Reimplemented from asg::AsgTool.

Definition at line 36 of file EnhancedBiasWeighter.cxx.

{
  ATH_MSG_DEBUG ("Initializing " << name() << "...");
  ATH_CHECK( m_bunchCrossingKey.initialize( m_useBunchCrossingData ) );
 
  if (m_isMC) {
 
    if (m_mcCrossSection == 0 || m_mcFilterEfficiency == 0) {
      ATH_MSG_FATAL("For MC rates, a cross section and filter efficiency must be supplied.");
      return StatusCode::FAILURE;
    }
    m_deadtime = 1.; // No deadtime for MC
    m_pairedBunches = FULL_RING; // Assume full-ring
    const double mcCrossSectionInSqCm = 1e-33 * m_mcCrossSection; // Convert nb -> cm^2 
    m_mcModifiedCrossSection = mcCrossSectionInSqCm * m_mcFilterEfficiency * m_mcKFactor;
    ATH_MSG_INFO ("Running over MC with xsec:" << m_mcCrossSection << " nb, filter efficiency:" << m_mcFilterEfficiency << ", k-factor:" << m_mcKFactor);
 
  } else { // isData
 
    if (m_runNumber == 0u) {
      ATH_MSG_FATAL("calculateWeightingData is TRUE, but the RunNumber property has not been set. This must be set such that we can read in the correct data.");
      return StatusCode::FAILURE;
    }
    ATH_MSG_INFO ("calculateWeightingData is TRUE. This job will read in EnhancedBias weighting data from CVMFS and COOL.");
    ATH_CHECK( loadWeights() );
    ATH_CHECK( loadLumi() );
 
  } // end isData
 
 
  return StatusCode::SUCCESS;
}

inputHandles()

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

isGoodLB() [1/2]

bool EnhancedBiasWeighter::isGoodLB ( const EventContext & context ) const

overridevirtual

Implements IEnhancedBiasWeighter.

Definition at line 616 of file EnhancedBiasWeighter.cxx.

{
  if (m_isMC) {
    
    return true;
 
  } else { // isData
 
    uint32_t lumiBlock = context.eventID().lumi_block();
 
    const auto mapIterator = m_goodLB.find(lumiBlock);
    if (mapIterator == m_goodLB.end() ) {
      ATH_MSG_ERROR( "Couldn't find LB good/bad info for LB: " << lumiBlock );
      return false;
    }
    return static_cast<bool>(mapIterator->second);
 
  } // isData
}

isGoodLB() [2/2]

bool EnhancedBiasWeighter::isGoodLB ( const xAOD::EventInfo * eventInfo ) const

overridevirtual

Returns

If the current lumi block should be used for rates or vetoed due to online deadtime Not a concern for MC Retrieved from CVMFS XML or fetched from TRIG1 dAOD

Implements IEnhancedBiasWeighter.

Definition at line 596 of file EnhancedBiasWeighter.cxx.

{
  if (m_isMC) {
    
    return true;
 
  } else { // isData
 
    uint32_t lumiBlock = eventInfo->lumiBlock();
 
    const auto mapIterator = m_goodLB.find(lumiBlock);
    if (mapIterator == m_goodLB.end() ) {
      ATH_MSG_ERROR( "Couldn't find LB good/bad info for LB: " << lumiBlock );
      return false;
    }
    return static_cast<bool>(mapIterator->second);
 
  } // isData
}

isMC()

bool EnhancedBiasWeighter::isMC ( ) const

overridevirtual

Returns

If the tool is configured to process MC

Implements IEnhancedBiasWeighter.

Definition at line 636 of file EnhancedBiasWeighter.cxx.

                                      {
  return m_isMC;
}

isUnbiasedEvent()

bool EnhancedBiasWeighter::isUnbiasedEvent ( const xAOD::EventInfo * eventInfo ) const

overridevirtual

Returns

If the current event was selected online by a fully unbiased trigger for MC we cannot play such games and return True so that every trigger is queried. the user is expected to know that a j0 trigger running on a ttbar MC is going to underestimate the rate of the j0 trigger running on MinBias. Retrieved from CVMFS XML or fetched from TRIG1 dAOD

Implements IEnhancedBiasWeighter.

Definition at line 577 of file EnhancedBiasWeighter.cxx.

{
  if (m_isMC) {
 
    return true;
 
  } else { //isData
 
    int32_t ebID = getEventEBID(eventInfo);
    const auto mapIterator = m_idToUnbiasedMap.find(ebID);
    if (mapIterator == m_idToUnbiasedMap.end() ) {
      ATH_MSG_ERROR("Couldn't find isUnbiased information for event with ID " << ebID);
      return false;
    }
    return mapIterator->second;
  
  } // isData
}

loadLumi()

StatusCode EnhancedBiasWeighter::loadLumi ( )

private

Read into memory this EnhancedBias run's XML.

Definition at line 146 of file EnhancedBiasWeighter.cxx.

{
  // Fetch LB time from COOL for this run
  const uint32_t runNumber = m_runNumber;
  if (m_readLumiBlock.updateLumiBlocks(runNumber, msg()) == false) {
    ATH_MSG_FATAL("Unable to load this runs luminosity values from COOL.");
    return StatusCode::FAILURE;
  }
 
  // Read in number of events to expect 
  // Construct name
  std::stringstream fileName;
  fileName    << "enhanced_bias_run_" << runNumber << ".xml";
  std::string runFile = (!m_weightsDirectory.empty()) ? findLocalFile(fileName.str()) : PathResolverFindCalibFile("TrigCostRootAnalysis/" + fileName.str() );  // Check standard area
  
  ATH_MSG_DEBUG("Using run file " << runFile);
  if (runFile == "") {
    msg() << (m_errorOnMissingEBWeights ? MSG::ERROR : MSG::WARNING)  << "Could not retrieve " << fileName.str() << ", cannot perform enhanced bias weighting." << endmsg;
    return (m_errorOnMissingEBWeights ? StatusCode::FAILURE : StatusCode::SUCCESS);
  }
 
  std::unique_ptr<TXMLEngine> xml(new TXMLEngine());
  const XMLDocPointer_t xmlDoc = xml->ParseFile( runFile.c_str() );
 
  if (xmlDoc == nullptr) {
    ATH_MSG_FATAL ("Could not parse " << fileName.str() << ", cannot perform enhanced bias weighting.");
    return StatusCode::FAILURE;
  }
 
  const XMLNodePointer_t mainNode = xml->DocGetRootElement(xmlDoc);
  if ( xml->GetNodeName(mainNode) != std::string("trigger") ) {
    ATH_MSG_ERROR ("Canot parse XML. Expected 'trigger' node, got " << xml->GetNodeName(mainNode));
    return StatusCode::FAILURE;
  }
  XMLNodePointer_t listNode = xml->GetChild( mainNode );
 
  while ( listNode != 0 ) { // Loop over all menu elements
    const std::string listName = xml->GetNodeName(listNode);
 
    if (listName == "lb_list") {
      
      XMLNodePointer_t node = xml->GetChild( listNode );
      while( node != 0) {
        if ( xml->GetNodeName(node) != std::string("lb") ) {
          ATH_MSG_ERROR ("Canot parse XML. Expected 'lb' node, got " << xml->GetNodeName(node));
          return StatusCode::FAILURE;
        }
        const uint32_t lb      = std::atoi( xml->GetAttr(node, "id") );
        const double   lumi    = std::atof( xml->GetAttr(node, "lumi") );
        const uint32_t nEvents = std::atoi( xml->GetNodeContent(node) );
        const std::string flag = xml->HasAttr(node, "flag") ? xml->GetAttr(node, "flag") : "";  
 
        m_eventsPerLB[lb] = nEvents;
        m_goodLB[lb] = (flag == "bad" ? 0 : 1); 
        m_lumiPerLB[lb] = lumi < 1e10 ? 1e30 * lumi : lumi;
 
        if (xml->HasAttr(node, "deadtime")) {
          // Deadtime is a weight factor, the weight will be multiplied by deadtime + 1
          m_deadtimePerLB[lb] = 1. + std::atof( xml->GetAttr(node, "deadtime") );
        }
 
        node = xml->GetNext(node); 
      }
 
    } else if (listName == "lumivalues") {
 
      XMLNodePointer_t node = xml->GetChild( listNode );
      while( node != 0) { 
        if ( xml->GetNodeName(node) == std::string("deadtime") ) {
          m_deadtime = 1. + std::atof( xml->GetNodeContent(node) );
        }
        node = xml->GetNext(node);
      }
      
    } else if (listName == "bunchgroups") {
 
      XMLNodePointer_t node = xml->GetChild( listNode );
      while( node != 0) { 
        m_bunches.push_back( std::atoi( xml->GetNodeContent(node) ) );
        if ( xml->GetNodeName(node) == std::string("bunchgroup") && xml->HasAttr(node, "name") &&
            (std::string(xml->GetAttr(node, "name")) == "Paired" || std::string(xml->GetAttr(node, "name")) == "Filled")) {
          m_pairedBunches = std::atoi( xml->GetNodeContent(node) );
        }
        node = xml->GetNext(node);
      }
      
    } else if (listName == "filters") {
 
      ATH_MSG_DEBUG("Found filters section of enhanced bias XML. Unused by this application.");
 
    } else {
 
      ATH_MSG_INFO("Encountered unknown element in enhanced bias XML: " << listName << " ignoring it.");
 
    }
 
    listNode = xml->GetNext(listNode);
  }
 
  ATH_MSG_INFO ("Loaded " << m_eventsPerLB.size() << " EnhancedBias lumi block's info for run " << runNumber);
  return StatusCode::SUCCESS;
}

loadWeights()

StatusCode EnhancedBiasWeighter::loadWeights ( )

private

Read into memory from XML event weights for this EnhancedBias run.

Definition at line 75 of file EnhancedBiasWeighter.cxx.

{
  // Construct name
  std::stringstream fileName;
  const uint32_t runNumber = m_runNumber; // This is because Gaudi::Properties have special behaviour with the << operator
  fileName  << "EnhancedBiasWeights_" << runNumber << ".xml";
  std::string weightingFile = (!m_weightsDirectory.empty()) ? findLocalFile(fileName.str()) : PathResolverFindCalibFile("TrigCostRootAnalysis/" + fileName.str() );  // Check standard area
 
  ATH_MSG_DEBUG("Using weighting file " << weightingFile);
 
  if (weightingFile == "") {
    msg() << (m_errorOnMissingEBWeights ? MSG::ERROR : MSG::WARNING)  << "Could not retrieve " << fileName.str() << ", cannot perform enhanced bias weighting." << endmsg;
    return (m_errorOnMissingEBWeights ? StatusCode::FAILURE : StatusCode::SUCCESS);
  }
 
  std::unique_ptr<TXMLEngine> xml(new TXMLEngine() );
  XMLDocPointer_t xmlDoc = xml->ParseFile( weightingFile.c_str() );
 
  if (xmlDoc == nullptr) {
    ATH_MSG_WARNING ("Could not parse " << fileName.str() << ", cannot perform enhanced bias weighting.");
    return StatusCode::FAILURE;
  }
 
  // Navigate XML
  const XMLNodePointer_t mainNode = xml->DocGetRootElement(xmlDoc);
  if ( xml->GetNodeName(mainNode) != std::string("run") ) {
    ATH_MSG_ERROR ("Canot parse XML. Expected 'run' node, got " << xml->GetNodeName(mainNode));
    return StatusCode::FAILURE;
  }
  const XMLNodePointer_t weightsNode = xml->GetChild( mainNode );
  const XMLNodePointer_t eventsNode  = xml->GetNext( weightsNode );
 
  XMLNodePointer_t weightNode = xml->GetChild( weightsNode );
  XMLNodePointer_t eventNode  = xml->GetChild( eventsNode );
 
  while ( weightNode != 0 ) { // Loop over all weight elements
    if ( xml->GetNodeName(weightNode) != std::string("weight") ) {
      ATH_MSG_ERROR ("Canot parse XML. Expected 'weight' node, got " << xml->GetNodeName(weightNode));
      return StatusCode::FAILURE;
    }
 
    const int32_t id   = std::atoi(xml->GetAttr(weightNode, "id") );
    const double weight = std::atof(xml->GetAttr(weightNode, "value") );
    int32_t unbiased = 0;
    if ( xml->HasAttr(weightNode, "unbiased") == true ) {
      unbiased = std::atoi(xml->GetAttr(weightNode, "unbiased"));
    }
 
    m_idToWeightMap[id] = weight;
    m_idToUnbiasedMap[id] = unbiased;
 
    weightNode = xml->GetNext(weightNode);
  }
 
  while ( eventNode != 0 ) { // Loop over all event elements
    if ( xml->GetNodeName(eventNode) != std::string("e") ) {
      ATH_MSG_ERROR ("Canot parse XML. Expected 'e' (event) node, got " << xml->GetNodeName(eventNode));
      return StatusCode::FAILURE;
    }
    const uint64_t eventNumber  = std::strtoll(xml->GetAttr(eventNode, "n"), nullptr, 10); //Number
    const int32_t eventWeightID = std::stoi(xml->GetAttr(eventNode, "w") ); //Weight ID
 
    m_eventNumberToIdMap[eventNumber] = eventWeightID;
 
    eventNode = xml->GetNext(eventNode);
  }
 
  ATH_MSG_INFO ("Loaded " << m_eventNumberToIdMap.size() << " event weights for run " << runNumber);
  return StatusCode::SUCCESS;
}

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns

The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

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

parsePrescaleXML()

std::unordered_map< std::string, ChainDetail > EnhancedBiasWeighter::parsePrescaleXML ( const std::string & prescaleXML ) const

overridevirtual

Parse a presscale XML and return a ordered summary of its content To make most use of the XML parsing available already in this class.

Parameters

prescaleXML

File name of a prescales file as generated by the RuleBook

Returns

Set of L1 or HLT chain names mapped to their desired prescale

Implements IEnhancedBiasWeighter.

Definition at line 249 of file EnhancedBiasWeighter.cxx.

                                                                                                                  {
  std::unordered_map<std::string, ChainDetail> result;
 
  std::string xmlFile = PathResolverFindDataFile( prescaleXML ); 
  if (xmlFile == "") {
    ATH_MSG_ERROR ("Could not retrieve " << prescaleXML << ", place it somewhere PathResolver can find it (such as the current directory).");
    return result;
  }
 
  std::unique_ptr<TXMLEngine> xml(new TXMLEngine());
  const XMLDocPointer_t xmlDoc = xml->ParseFile( xmlFile.c_str() );
 
  if (xmlDoc == nullptr) {
    ATH_MSG_WARNING ("Could not parse " << prescaleXML << ", please check that it is valid XML.");
    return result;
  }
 
  // Get access to main node
  XMLNodePointer_t mainNode = xml->DocGetRootElement(xmlDoc);
  if ( xml->GetNodeName(mainNode) != std::string("trigger") ) {
    ATH_MSG_ERROR ("Canot parse XML. Expected 'trigger' node, got " << xml->GetNodeName(mainNode));
    return result;
  }
  XMLNodePointer_t listNode = xml->GetChild( mainNode );
 
 
  while ( listNode != nullptr) { // Loop over all menu elements
    const std::string listName = xml->GetNodeName(listNode);
 
    // if (_listName == "PredictionLumi") {
    //   Float_t predictionLumi = stringToFloat( xml->GetNodeContent(listNode) );
    // }
    if (listName != "level") { // Find the "level" item
      listNode = xml->GetNext(listNode);
      continue;
    }
 
    XMLNodePointer_t sigNode = xml->GetChild( listNode );
    while( sigNode != nullptr) {
      if (xml->GetNodeName(sigNode) != std::string("signature")) { // Find the "signature" items
        sigNode = xml->GetNext(sigNode);
        continue;
      }
 
      XMLNodePointer_t sigDetailsNode = xml->GetChild( sigNode );
      std::string chainName;
      while( sigDetailsNode != nullptr) {
 
        if (xml->GetNodeContent(sigDetailsNode) == nullptr) {
          sigDetailsNode = xml->GetNext(sigDetailsNode);
          continue;
        }
 
        const std::string detail = xml->GetNodeName(sigDetailsNode);
        if (detail == "sig_name") {
          chainName = xml->GetNodeContent(sigDetailsNode);
          result[chainName] = ChainDetail();
        } else if (detail == "sig_counter") {
          result[chainName].m_counter = std::stoi( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "prescale" || detail == "chain_prescale") { // This is an alternate name
          result[chainName].m_prescale = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "lower_chain_name") {
          // Later processing here does not expect any spaces, so remove them now. Pure comma separated list
          std::string lower = xml->GetNodeContent(sigDetailsNode);
          while (lower.find(" ") != std::string::npos) lower.replace( lower.find(" "), 1, "");
          result[chainName].m_lowerName = std::move(lower);
        } else if (detail == "evts_passed") {
          result[chainName].m_eventsPassed = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "evts_passed_weighted") {
          result[chainName].m_eventsPassedWeighted = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "rate") {
          result[chainName].m_rate = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "rate_err") {
          result[chainName].m_rateErr = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "passthrough") {
          result[chainName].m_passthroughPrescale = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "rerun_prescale") {
          result[chainName].m_rerunPrescale = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "express_prescale") {
          result[chainName].m_expressPrescale = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "efficiency") {
          result[chainName].m_efficiency = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "efficiency_err") {
          result[chainName].m_efficiencyErr = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "prescaled_efficiency") {
          result[chainName].m_prescaledEfficiency = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "prescaled_efficiency_error") {
          result[chainName].m_prescaledEfficiencyErr = std::stod( xml->GetNodeContent(sigDetailsNode) );
        } else if (detail == "comment") {
          result[chainName].m_comment = xml->GetNodeContent(sigDetailsNode);
        } else {
          ATH_MSG_DEBUG("Input prescales XML contains additional data which cannot be parsed at present:" << detail);
        }
 
        sigDetailsNode = xml->GetNext(sigDetailsNode);
      }
      sigNode = xml->GetNext(sigNode);
    }
    listNode = xml->GetNext(listNode);
  }
 
  return result;
}

print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

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

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

sysStart()

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

trackAverages() [1/2]

StatusCode EnhancedBiasWeighter::trackAverages ( const EventContext & context ) const

private

Definition at line 456 of file EnhancedBiasWeighter.cxx.

{
  m_lumiAverage += getLBLumi(context);
  return StatusCode::SUCCESS;
}

trackAverages() [2/2]

StatusCode EnhancedBiasWeighter::trackAverages ( const xAOD::EventInfo * eventInfo ) const

private

Internal function to keep track of the mean instantaneous lumi & mean pileup of the EB/MC sample being processed.

Definition at line 463 of file EnhancedBiasWeighter.cxx.

{
  m_muAverage += std::ceil( eventInfo->actualInteractionsPerCrossing() );
  m_lumiAverage += getLBLumi(eventInfo);
  return StatusCode::SUCCESS;
}

updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

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

Member Data Documentation

ATLAS_THREAD_SAFE [1/3]

std::unordered_map<uint32_t, float> m_eventLivetime EnhancedBiasWeighter::ATLAS_THREAD_SAFE

mutableprivate

Cache of per-event livetime as a function of LB [LB -> effective walltime per event].

Definition at line 211 of file EnhancedBiasWeighter.h.

ATLAS_THREAD_SAFE [2/3]

Gaudi::Accumulators::AveragingCounter<double> m_lumiAverage EnhancedBiasWeighter::ATLAS_THREAD_SAFE

mutableprivate

The average instantaneous lumionosity over all events.

Definition at line 213 of file EnhancedBiasWeighter.h.

ATLAS_THREAD_SAFE [3/3]

Gaudi::Accumulators::AveragingCounter<double> m_muAverage EnhancedBiasWeighter::ATLAS_THREAD_SAFE

mutableprivate

The average mu over all events.

Definition at line 214 of file EnhancedBiasWeighter.h.

FULL_RING

uint32_t EnhancedBiasWeighter::FULL_RING = 2738

staticconstexpr

Number of bunches in a full ring.

Definition at line 56 of file EnhancedBiasWeighter.h.

LHC_FREQUENCY

double EnhancedBiasWeighter::LHC_FREQUENCY = 11245.5

staticconstexpr

Definition at line 55 of file EnhancedBiasWeighter.h.

m_bunchCrossingKey

SG::ReadCondHandleKey<BunchCrossingCondData> EnhancedBiasWeighter::m_bunchCrossingKey {this, "BunchCrossingKey", "BunchCrossingData", "Key BunchCrossing CDO" }

private

Tool to get distance into bunch train.

Definition at line 190 of file EnhancedBiasWeighter.h.

{this, "BunchCrossingKey", "BunchCrossingData", "Key BunchCrossing CDO" }; 

m_bunches

std::vector<int32_t> EnhancedBiasWeighter::m_bunches

private

Number of BCIDs in each bunch group.

Definition at line 223 of file EnhancedBiasWeighter.h.

m_deadtime

double EnhancedBiasWeighter::m_deadtime

private

Online deadtime to correct for in rate prediction.

Currently a constant for the EB period

Definition at line 206 of file EnhancedBiasWeighter.h.

m_deadtimePerLB

std::unordered_map<uint32_t, double> EnhancedBiasWeighter::m_deadtimePerLB

private

Map of average deadtime per LB.

Definition at line 221 of file EnhancedBiasWeighter.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_doMultiSliceDiJet

Gaudi::Property<bool> EnhancedBiasWeighter::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."}

private

Definition at line 203 of file EnhancedBiasWeighter.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_enforceEBGRL

Gaudi::Property<bool> EnhancedBiasWeighter::m_enforceEBGRL {this, "EnforceEBGRL", true, "Each Enhanced Bias run has a 'good run list' style veto on some LB. If this flag is true, events in these LB get weight 0"}

private

Definition at line 194 of file EnhancedBiasWeighter.h.

{this, "EnforceEBGRL", true, "Each Enhanced Bias run has a 'good run list' style veto on some LB. If this flag is true, events in these LB get weight 0"};

m_errorOnMissingEBWeights

Gaudi::Property<bool> EnhancedBiasWeighter::m_errorOnMissingEBWeights {this, "ErrorOnMissingEBWeights", false, "If true, Throws error if EB weights are missing."}

private

Definition at line 193 of file EnhancedBiasWeighter.h.

{this, "ErrorOnMissingEBWeights", false, "If true, Throws error if EB weights are missing."};

m_eventNumberToIdMap

std::unordered_map<uint64_t, int32_t> EnhancedBiasWeighter::m_eventNumberToIdMap

private

Map event number to a weighting ID.

Definition at line 209 of file EnhancedBiasWeighter.h.

m_eventsPerLB

std::unordered_map<uint32_t, uint32_t> EnhancedBiasWeighter::m_eventsPerLB

private

Map of how many EnhancedBias events were recorded per LB.

Definition at line 218 of file EnhancedBiasWeighter.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_goodLB

std::unordered_map<uint32_t, uint8_t> EnhancedBiasWeighter::m_goodLB

private

Like a Good Run List flag for EnhancedBias runs.

Definition at line 220 of file EnhancedBiasWeighter.h.

m_idToUnbiasedMap

std::unordered_map<int32_t, uint8_t> EnhancedBiasWeighter::m_idToUnbiasedMap

private

Map a weighting ID to a flag if this weight is from an unbiased (RD) trigger online.

Definition at line 217 of file EnhancedBiasWeighter.h.

m_idToWeightMap

std::unordered_map<int32_t, double> EnhancedBiasWeighter::m_idToWeightMap

private

Map a weighting ID to a Enhanced Bias event weight.

Definition at line 216 of file EnhancedBiasWeighter.h.

m_inelasticCrossSection

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

private

Definition at line 201 of file EnhancedBiasWeighter.h.

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

m_isMC

Gaudi::Property<bool> EnhancedBiasWeighter::m_isMC {this, "IsMC", false, "MC mode? If so we need a cross section and filter efficiency"}

private

Definition at line 196 of file EnhancedBiasWeighter.h.

{this, "IsMC", false,  "MC mode? If so we need a cross section and filter efficiency"};

m_lumiPerLB

std::unordered_map<uint32_t, double> EnhancedBiasWeighter::m_lumiPerLB

private

Map of instantaneous luminosity per LB.

Definition at line 219 of file EnhancedBiasWeighter.h.

m_mcCrossSection

Gaudi::Property<double> EnhancedBiasWeighter::m_mcCrossSection {this, "MCCrossSection", 0.0, "If running over MC. The process cross section in nb (AMI gives thins in nb)"}

private

Definition at line 197 of file EnhancedBiasWeighter.h.

{this, "MCCrossSection", 0.0, "If running over MC. The process cross section in nb (AMI gives thins in nb)"};

m_mcFilterEfficiency

Gaudi::Property<double> EnhancedBiasWeighter::m_mcFilterEfficiency {this, "MCFilterEfficiency", 1.0, "If running over MC. The process filter efficiency (0.0-1.0)"}

private

Definition at line 198 of file EnhancedBiasWeighter.h.

{this, "MCFilterEfficiency", 1.0, "If running over MC. The process filter efficiency (0.0-1.0)"}; 

m_mcIgnoreGeneratorWeights

Gaudi::Property<bool> EnhancedBiasWeighter::m_mcIgnoreGeneratorWeights {this, "MCIgnoreGeneratorWeights", false, "If running over MC. Flag to ignore the generator weight."}

private

Definition at line 200 of file EnhancedBiasWeighter.h.

{this, "MCIgnoreGeneratorWeights", false, "If running over MC. Flag to ignore the generator weight."}; 

m_mcKFactor

Gaudi::Property<double> EnhancedBiasWeighter::m_mcKFactor {this, "MCKFactor", 1.0, "If running over MC. The process filter efficiency (0.0-1.0)"}

private

Definition at line 199 of file EnhancedBiasWeighter.h.

{this, "MCKFactor", 1.0, "If running over MC. The process filter efficiency (0.0-1.0)"}; 

m_mcModifiedCrossSection

double EnhancedBiasWeighter::m_mcModifiedCrossSection

private

Product of xsec, filter & kfactor.

In units of cm

Definition at line 208 of file EnhancedBiasWeighter.h.

m_mutex

std::mutex EnhancedBiasWeighter::m_mutex

mutableprivate

Protection for above map.

Definition at line 212 of file EnhancedBiasWeighter.h.

m_pairedBunches

uint32_t EnhancedBiasWeighter::m_pairedBunches

private

Online number of paired bunches.

Definition at line 207 of file EnhancedBiasWeighter.h.

m_readLumiBlock

ReadLumiBlock EnhancedBiasWeighter::m_readLumiBlock

private

Cache lumi block lengths.

Get this from COOL.

Definition at line 225 of file EnhancedBiasWeighter.h.

m_runNumber

Gaudi::Property<uint32_t> EnhancedBiasWeighter::m_runNumber {this, "RunNumber", 0, "Run we're processing (if data), needed at initialize to locate and read in extra configuration."}

private

Definition at line 192 of file EnhancedBiasWeighter.h.

{this, "RunNumber", 0, "Run we're processing (if data), needed at initialize to locate and read in extra configuration."};

m_targetLumi

Gaudi::Property<double> EnhancedBiasWeighter::m_targetLumi {this, "TargetLuminosity", 2e34, "Targer inst. luminosity, assuming full ring."}

private

Definition at line 204 of file EnhancedBiasWeighter.h.

{this, "TargetLuminosity", 2e34, "Targer inst. luminosity, assuming full ring."};

m_useBunchCrossingData

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

private

Definition at line 195 of file EnhancedBiasWeighter.h.

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

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

m_weightsDirectory

Gaudi::Property<std::string> EnhancedBiasWeighter::m_weightsDirectory {this, "EBWeightsDirectory", "", "Path to directory with EB XML weights files, if empty they will be read from calibration area"}

private

Definition at line 202 of file EnhancedBiasWeighter.h.

{this, "EBWeightsDirectory", "", "Path to directory with EB XML weights files, if empty they will be read from calibration area"};  

---

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

• EnhancedBiasWeighter.h
• EnhancedBiasWeighter.cxx