RatesScanTrigger Class Reference

Used to calculate a rate scan as a function of some threshold value. More...

#include <RatesScanTrigger.h>

Inheritance diagram for RatesScanTrigger:

Collaboration diagram for RatesScanTrigger:

Public Types
enum	TriggerBehaviour_t { kTriggerAboveThreshold, kTriggerBelowThreshold }
	enum to describe if a trigger should activate for values >= or <= than the thresold More...

Public Member Functions
	RatesScanTrigger (const std::string &name, IMessageSvc *msgSvc, const double thresholdMin, const double thresholdMax, const uint32_t thresholdBins=100, const TriggerBehaviour_t behaviour=kTriggerBelowThreshold, const double prescale=1., const std::string &seedName="", const double seedPrecale=1., const ExtrapStrat_t extrapolation=ExtrapStrat_t::kLINEAR)
	Construct new RatesScanTrigger to enumerate the rate for a single L1 or HLT trigger as a function of some threshold. More...
	RatesScanTrigger (const std::string &name, IMessageSvc *msgSvc, const std::vector< double > &thresholdBinEdges, const TriggerBehaviour_t behaviour=kTriggerBelowThreshold, const double prescale=1., const std::string &seedName="", const double seedPrecale=1., const ExtrapStrat_t extrapolation=ExtrapStrat_t::kLINEAR)
	Construct new RatesScanTrigger to enumerate the rate for a single L1 or HLT trigger as a function of some threshold. More...
virtual	~RatesScanTrigger ()
	RatesScanTrigger (const RatesScanTrigger &)=delete
RatesScanTrigger &	operator= (const RatesScanTrigger &)=delete
void	reset () override
	If I was used in an event, reset me. More...
void	passThreshold (const double t, const bool unbiasedEvent=false)
	Sets the threshold the event. More...
void	setPassedAndExecute (const double t, const WeightingValuesSummary_t &weights)
	Set the pass threshold and immediately call execute. More...
void	execute (const WeightingValuesSummary_t &weights) override
	Execute trigger rate emulation. More...
const std::string	printRate (const double ratesDenominator) const override
	Prints the RatesScanTrigger's rate (different output to a regular trigger) More...
StatusCode	giveThresholdHist (const ServiceHandle< ITHistSvc > &svc, const std::string &name)
void	setSeedsFromRandom (const bool i)
	Set if this trigger is to behave as if it seeds from a random L1 item. More...
void	setPassed (const bool passed=true, const bool active=true, const bool unbiasedEvent=false)
	Set the pass/fail bool. More...
void	setPassedAndExecute (const bool passed, const bool active, const WeightingValuesSummary_t &weights)
	Set the pass/fail bool and immediately call execute. More...
size_t	getSeedHash () const
const std::string &	getSeedName () const
	Get the name of the seed of this trigger. More...
double	getSeedPrescale () const
	Get the prescale of the seed of this trigger. More...
size_t	getHash () const
	Get the hash of the name of this trigger. More...
const std::string &	getName () const
	Get the name of this trigger. More...
double	getPrescale (const bool includeExpress=false) const
	Gets the triggers prescale. More...
bool	getPassed () const
	If the trigger passed in the event. More...
bool	getActive () const
	If the trigger passed in the event. More...
bool	getDisabled () const
	If I or my seed were prescaled out. More...
void	setUniqueGroup (const RatesGroup *unique)
	If I have a group which is calculating my unique rate. More...
void	setCoherentFactor (const double lowestCommonPrescale)
	If i'm in a CPS group, set the lowest commons PS factor of the group. More...
void	setCPS (const std::string &group)
	If I'm in a CPS group, set the group name (I'll keep a copy of the hash) More...
size_t	getCPSID () const
	Get the hash of my CPS group name. More...
double	getCoherentFactor () const
	Get the lowest common prescale factor of all triggers in my CPS group. More...
const std::string	printConfig () const
	Prints the RatesTrigger's configuration. More...
const std::string	printExpressRate (const double ratesDenominator) const
	Prints the RatesTrigger's express rate. More...
StatusCode	giveMuHist (const ServiceHandle< ITHistSvc > &svc, const std::string &name)
StatusCode	giveTrainHist (const ServiceHandle< ITHistSvc > &svc, const std::string &name)
StatusCode	giveDataHist (const ServiceHandle< ITHistSvc > &svc, const std::string &name)
void	clearTrainHist ()
	In some jobs we don't want to do the rates vs. More...
TH1 *	getDataHist ()
bool	doHistograms () const
	If histogramming was enabled in this rates object. More...
const std::string &	getExtrapolationFactorString (ExtrapStrat_t strat) const
double	getExtrapolationFactor (const WeightingValuesSummary_t &weights, const ExtrapStrat_t strat) const
bool	msgLvl (const MSG::Level lvl) const
	Test the output level. More...
MsgStream &	msg () const
	The standard message stream. More...
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream. More...
void	setLevel (MSG::Level lvl)
	Change the current logging level. More...

Static Public Member Functions
static bool	isZero (double v)
static bool	isNotPositive (double v)

Protected Attributes
bool	m_pass
	Did the trigger pass or not? More...
bool	m_active
	Was the trigger active? (Did it run) More...
bool	m_seedsFromRandom
	Does this trigger seed from a random trigger? If so it should only be exposed to unbiased events. More...
double	m_rateAccumulator
	Weighted events passed. More...
double	m_rateAccumulator2
	Weighted events passed squared. More...
double	m_rateExpressAccumulator
	Weighted express stream events. More...
double	m_rateExpressAccumulator2
	Weighted express stream events squared. More...
double	m_ratesActive
double	m_ratesActive2
size_t	m_CPSID
	If I'm in a coherent prescale group, my group's ID (hash of the group name) More...
double	m_coherentFactor
	If I'm in a coherent prescale group, the prescale of the lowest non-disabled chain in the group. More...
const RatesGroup *	m_uniqueGroup
	Pointer to the group which is calculating my unique rate. More...
const std::string	m_name
	My name. More...
const std::string	m_seed
	My seed, "" if no seed. More...
const size_t	m_nameHash
	Hash of my name. More...
const size_t	m_seedHash
	Has of my seed name. More...
const double	m_prescale
	My prescale factor. More...
const double	m_expressPrescale
	My express stream prescale factor, gets applied on top of the regular prescale. More...
const double	m_seedPrescale
const double	m_totalPrescaleWeight
	Equal to 1/m_seedPrescale*m_prescale. More...
const double	m_totalPrescaleWeightExpress
	Equal to 1/m_seedPrescale*m_prescale*m_expressPrescale. More...
const ExtrapStrat_t	m_extrapolationStrategy
	How this trigger is to scale with luminosity. More...
bool	m_doHistograms
	If histogramming is switched on. More...
std::unique_ptr< TH1 >	m_rateVsMu
	Histogram of rate as a fn. More...
std::unique_ptr< TH1 >	m_rateVsTrain
	Histogram of rate as a fn. More...
std::unique_ptr< TH1 >	m_data
	Histogram of raw rates quantites, for when we need to normalise offline (e.g. More...
TH1 *	m_rateVsMuCachedPtr {}
	Cached, non-owning pointer. More...
TH1 *	m_rateVsTrainCachedPtr {}
	Cached, non-owning pointer. More...
TH1 *	m_dataCachedPtr {}
	Cached, non-owning pointer. More...

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc. More...

Private Attributes
std::unique_ptr< TH1 >	m_rateScanHist
	Even if we are not exporting it - we still need this histo. More...
TH1 *	m_rateScanHistCachedPtr
double	m_thresholdPassed
	Analogous to m_pass. More...
TriggerBehaviour_t	m_behaviour
	If we need to be above or below the threshold to cause the trigger to fire. More...
std::string	m_nm
	Message source name. More...
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels) More...
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer. More...
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level. More...
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging) More...

Detailed Description

Used to calculate a rate scan as a function of some threshold value.

Typically a pT cut

Definition at line 14 of file RatesScanTrigger.h.

Member Enumeration Documentation

TriggerBehaviour_t

enum RatesScanTrigger::TriggerBehaviour_t

enum to describe if a trigger should activate for values >= or <= than the thresold

Enumerator
kTriggerAboveThreshold	Trigger for >= threshold.
kTriggerBelowThreshold	Trigger for <= threshold.

Definition at line 20 of file RatesScanTrigger.h.

                          {
    kTriggerAboveThreshold, 
    kTriggerBelowThreshold  
  };

Constructor & Destructor Documentation

RatesScanTrigger() [1/3]

RatesScanTrigger::RatesScanTrigger	(	const std::string &	name,
		IMessageSvc *	msgSvc,
		const double	thresholdMin,
		const double	thresholdMax,
		const uint32_t	thresholdBins = 100,
		const TriggerBehaviour_t	behaviour = kTriggerBelowThreshold,
		const double	prescale = 1.,
		const std::string &	seedName = "",
		const double	seedPrecale = 1.,
		const ExtrapStrat_t	extrapolation = ExtrapStrat_t::kLINEAR
	)

Construct new RatesScanTrigger to enumerate the rate for a single L1 or HLT trigger as a function of some threshold.

Parameters

name	Name of the trigger
msgSvc	Reference to message service
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 of the trigger. Anything < 1 is considered disabled
seedName	The name of any L1 seed the trigger has, leave blank if L1 item / no L1 seed.
seedPrescale	The prescale of any L1 seed. Leave = 1 if no L1 seed.
extrapolation	The luminosity extrapolation strategy to be applied to this trigger

Definition at line 10 of file RatesScanTrigger.cxx.

                                                                       :
  RatesTrigger(name, msgSvc, prescale, -1, seedName, seedPrescale, /*base histograms*/false, extrapolation),
  m_rateScanHist(std::make_unique<TH1D>("", TString(name + ";Threshold;Rate [Hz]"), thresholdBins, thresholdMin, thresholdMax)),
  m_rateScanHistCachedPtr(m_rateScanHist.get()), m_thresholdPassed(0), m_behaviour(behaviour)
  {
    m_rateScanHist->Sumw2(true);
  }

RatesScanTrigger() [2/3]

RatesScanTrigger::RatesScanTrigger	(	const std::string &	name,
		IMessageSvc *	msgSvc,
		const std::vector< double > &	thresholdBinEdges,
		const TriggerBehaviour_t	behaviour = kTriggerBelowThreshold,
		const double	prescale = 1.,
		const std::string &	seedName = "",
		const double	seedPrecale = 1.,
		const ExtrapStrat_t	extrapolation = ExtrapStrat_t::kLINEAR
	)

Construct new RatesScanTrigger to enumerate the rate for a single L1 or HLT trigger as a function of some threshold.

Parameters

name	Name of the trigger
log	Reference to message service
thresholdBinEdged	Vector of bin edges to use for quantifying rate as a function of threshold
behaviour	If the trigger should activate above (kTriggerAboveThreshold) or below (kTriggerBelowThreshold) the threshold
prescale	The prescale of the trigger. Anything < 1 is considered disabled
seedName	The name of any L1 seed the trigger has, leave blank if L1 item / no L1 seed.
seedPrescale	The prescale of any L1 seed. Leave = 1 if no L1 seed.
extrapolation	The luminosity extrapolation strategy to be applied to this trigger

Definition at line 24 of file RatesScanTrigger.cxx.

                                                                       :
  RatesTrigger(name, msgSvc, prescale, -1, seedName, seedPrescale, false, extrapolation),
  m_rateScanHist(nullptr), m_rateScanHistCachedPtr(nullptr), m_thresholdPassed(0), m_behaviour(behaviour)
  {
    if (thresholdBinEdged.size() < 2) {
      ATH_MSG_ERROR("Need more than one entry in thresholdBinEdged to define histogram binning.");
      return;
    }
    size_t nBins = thresholdBinEdged.size() - 1;
    m_rateScanHist = std::make_unique<TH1D>("", TString(name + ";Threshold;Rate [Hz]"), nBins, thresholdBinEdged.data());
    m_rateScanHist->Sumw2(true);
 
    m_rateScanHistCachedPtr = m_rateScanHist.get();
  }

~RatesScanTrigger()

RatesScanTrigger::~RatesScanTrigger ( )

virtual

Definition at line 45 of file RatesScanTrigger.cxx.

                                    {
}

RatesScanTrigger() [3/3]

RatesScanTrigger::RatesScanTrigger ( const RatesScanTrigger &  )

delete

Member Function Documentation

clearTrainHist()

void RatesHistoBase::clearTrainHist ( )

inherited

In some jobs we don't want to do the rates vs.

position in train

Definition at line 76 of file RatesHistoBase.cxx.

                                    {
  m_rateVsTrain.reset();
  m_rateVsTrainCachedPtr = nullptr;
}

doHistograms()

bool RatesHistoBase::doHistograms ( ) const

inlineinherited

If histogramming was enabled in this rates object.

Definition at line 99 of file RatesHistoBase.h.

execute()

void RatesScanTrigger::execute ( const WeightingValuesSummary_t &  weights )

overridevirtual

Execute trigger rate emulation.

If the trigger passed threshold is within the defined range then fill the relevant histogram bins

Parameters

weights

Set of weighting values which may be needed.

Reimplemented from RatesTrigger.

Definition at line 66 of file RatesScanTrigger.cxx.

                                                                      {
  if (m_thresholdPassed == std::numeric_limits<double>::min()) return; // Did not pass
  // This histogram we *do* include the extrapolation weight as we plot vs. some trigger property, not some event property
  double w = m_totalPrescaleWeight * weights.m_enhancedBiasWeight * getExtrapolationFactor(weights, m_extrapolationStrategy);
  // Fill the histogram cumulatively
  // We match exactly with the *lower* edge of all bins
  const int nBins = m_rateScanHistCachedPtr->GetNbinsX();
  for (int bin = 1; bin <= nBins; ++bin) {
    const double low = m_rateScanHistCachedPtr->GetBinLowEdge(bin);
    const double width = m_rateScanHistCachedPtr->GetBinWidth(bin);
    if ( (m_behaviour == kTriggerAboveThreshold && m_thresholdPassed < (low + width)) ||
         (m_behaviour == kTriggerBelowThreshold && m_thresholdPassed > low)) {
      m_rateScanHistCachedPtr->Fill(m_rateScanHistCachedPtr->GetBinCenter(bin), w);
    }
  }
  // Underflow && Overflow
  const double xMin = m_rateScanHistCachedPtr->GetXaxis()->GetXmin();
  const double xMax = m_rateScanHistCachedPtr->GetXaxis()->GetXmax();
  if ( (m_behaviour == kTriggerAboveThreshold && m_thresholdPassed < xMin) || m_behaviour == kTriggerBelowThreshold ) {
    m_rateScanHistCachedPtr->Fill(xMin - 1., w);
  }
  if ( m_behaviour == kTriggerAboveThreshold || (m_behaviour == kTriggerBelowThreshold && m_thresholdPassed >= xMax) ) {
    m_rateScanHistCachedPtr->Fill(xMax + 1, w);
  }
}

getActive()

bool RatesTrigger::getActive ( ) const

inherited

If the trigger passed in the event.

Definition at line 159 of file RatesTrigger.cxx.

{ return m_active; }

getCoherentFactor()

double RatesTrigger::getCoherentFactor ( ) const

inherited

Get the lowest common prescale factor of all triggers in my CPS group.

Definition at line 171 of file RatesTrigger.cxx.

{ return m_coherentFactor; } 

getCPSID()

size_t RatesTrigger::getCPSID ( ) const

inherited

Get the hash of my CPS group name.

Definition at line 169 of file RatesTrigger.cxx.

{ return m_CPSID; }

getDataHist()

TH1 * RatesHistoBase::getDataHist ( )

inherited

Returns

cached, non-owning, histogram pointer or nullptr. Does not cause error

Definition at line 82 of file RatesHistoBase.cxx.

                                 {
  return m_dataCachedPtr; // Caller must be able to deal with nullptr (e.g unique rates groups calling on their trigger)
}

getDisabled()

bool RatesTrigger::getDisabled ( ) const

inherited

If I or my seed were prescaled out.

Definition at line 161 of file RatesTrigger.cxx.

{ return (isNotPositive(m_prescale) || isNotPositive(m_seedPrescale)); }

getExtrapolationFactor()

double RatesHistoBase::getExtrapolationFactor ( const WeightingValuesSummary_t &  weights, const ExtrapStrat_t  strat  ) const

inherited

Definition at line 93 of file RatesHistoBase.cxx.

                                                                                                                      {
  switch (strat) {
    case kLINEAR: return weights.m_linearLumiFactor;
    case kEXPO_MU: return weights.m_expoMuFactor;
    case kBUNCH_SCALING: return weights.m_bunchFactor;
    case kMU_SCALING: return weights.m_muFactor;
    case kNONE: return weights.m_noScaling;
    default: ATH_MSG_ERROR("Error in getExtrapolationFactor. Unknown ExtrapStrat_t ENUM supplied " << strat);
  }
  return 0.;
}

getExtrapolationFactorString()

const std::string & RatesHistoBase::getExtrapolationFactorString ( ExtrapStrat_t  strat ) const

inherited

Definition at line 87 of file RatesHistoBase.cxx.

                                                                                       {
  static const std::vector<std::string> values{"LINEAR_L","LINEAR_BUNCH_EXPO_MU","LINEAR_BUNCHES","LINEAR_MU","NONE"};
  return values.at(static_cast<size_t>(strat)); 
}

getHash()

size_t RatesTrigger::getHash ( ) const

inherited

Get the hash of the name of this trigger.

Definition at line 153 of file RatesTrigger.cxx.

{ return m_nameHash; }

getName()

const std::string & RatesTrigger::getName ( ) const

inherited

Get the name of this trigger.

Definition at line 155 of file RatesTrigger.cxx.

{ return m_name; }

getPassed()

bool RatesTrigger::getPassed ( ) const

inherited

If the trigger passed in the event.

Definition at line 157 of file RatesTrigger.cxx.

{ return m_pass; }

getPrescale()

double RatesTrigger::getPrescale ( const bool  includeExpress = false ) const

inherited

Gets the triggers prescale.

Parameters

includeExpress

If true, the items express prescale is added on top of its regular prescale

Definition at line 95 of file RatesTrigger.cxx.

                                                                { 
  if (includeExpress) return m_prescale * m_expressPrescale;
  return m_prescale;
}

getSeedHash()

size_t RatesTrigger::getSeedHash ( ) const

inherited

Definition at line 147 of file RatesTrigger.cxx.

{ return m_seedHash; }

getSeedName()

const std::string & RatesTrigger::getSeedName ( ) const

inherited

Get the name of the seed of this trigger.

Definition at line 149 of file RatesTrigger.cxx.

{ return m_seed; }

getSeedPrescale()

double RatesTrigger::getSeedPrescale ( ) const

inherited

Get the prescale of the seed of this trigger.

Definition at line 151 of file RatesTrigger.cxx.

{ return m_seedPrescale; }

giveDataHist()

StatusCode RatesHistoBase::giveDataHist ( const ServiceHandle< ITHistSvc > &  svc, const std::string &  name  )

inherited

Definition at line 66 of file RatesHistoBase.cxx.

                                                                                                  { 
  if (!m_data.get()) {
    ATH_MSG_ERROR("RatesHistoBase::giveDataHist Warning requested histograms when histograming is OFF here.");
    return StatusCode::FAILURE;
  }
  ATH_CHECK( svc->regHist(name, std::move(m_data)) );
  return StatusCode::SUCCESS;
}

giveMuHist()

StatusCode RatesHistoBase::giveMuHist ( const ServiceHandle< ITHistSvc > &  svc, const std::string &  name  )

inherited

Definition at line 46 of file RatesHistoBase.cxx.

                                                                                                { 
  if (!m_rateVsMu.get()) { 
    ATH_MSG_ERROR("RatesHistoBase::giveMuHist Warning requested histograms when histograming is OFF here.");
    return StatusCode::FAILURE;
  }
  ATH_CHECK( svc->regHist(name, std::move(m_rateVsMu)) );
  return StatusCode::SUCCESS;
}

giveThresholdHist()

StatusCode RatesScanTrigger::giveThresholdHist	(	const ServiceHandle< ITHistSvc > &	svc,
		const std::string &	name
	)

Definition at line 61 of file RatesScanTrigger.cxx.

                                                                                                         { 
  ATH_CHECK( svc->regHist(name, std::move(m_rateScanHist)) );
  return StatusCode::SUCCESS;
}

giveTrainHist()

StatusCode RatesHistoBase::giveTrainHist ( const ServiceHandle< ITHistSvc > &  svc, const std::string &  name  )

inherited

Definition at line 56 of file RatesHistoBase.cxx.

                                                                                                   { 
  if (!m_rateVsTrain.get()) {
    ATH_MSG_ERROR("RatesHistoBase::giveTrainHist Warning requested histograms when histograming is OFF here.");
    return StatusCode::FAILURE;
  }
  ATH_CHECK( svc->regHist(name, std::move(m_rateVsTrain)) );
  return StatusCode::SUCCESS;
}

initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  m_lvl = m_imsg ?
    static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
    MSG::INFO;
}

isNotPositive()

static bool RatesHistoBase::isNotPositive ( double  v )

inlinestaticinherited

Definition at line 104 of file RatesHistoBase.h.

{ return v < 1e-10; } //<! Helper fn to check if the value is non positive = trigger is disabled

isZero()

static bool RatesHistoBase::isZero ( double  v )

inlinestaticinherited

Definition at line 103 of file RatesHistoBase.h.

{ return fabs(v) < 1e-10; } //<! Helper fn

msg() [1/2]

MsgStream & AthMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 164 of file AthMessaging.h.

{
  MsgStream* ms = m_msg_tls.get();
  if (!ms) {
    if (!m_initialized.test_and_set()) initMessaging();
    ms = new MsgStream(m_imsg,m_nm);
    m_msg_tls.reset( ms );
  }
 
  ms->setLevel (m_lvl);
  return *ms;
}

msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level  lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 179 of file AthMessaging.h.

{ return msg() << lvl; }

msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level  lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns

boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

{
  if (!m_initialized.test_and_set()) initMessaging();
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

operator=()

RatesScanTrigger& RatesScanTrigger::operator= ( const RatesScanTrigger &  )

delete

passThreshold()

void RatesScanTrigger::passThreshold	(	const double	t,
		const bool	unbiasedEvent = false
	)

Sets the threshold the event.

Parameters

t	The threshold reached by the event
unbiasedEvent	If the event was triggered at random online

Definition at line 48 of file RatesScanTrigger.cxx.

                                                                             {
  if (m_seedsFromRandom == true && unbiasedEvent == false) return;
  m_thresholdPassed = t;
}

printConfig()

const std::string RatesTrigger::printConfig ( ) const

inherited

Prints the RatesTrigger's configuration.

Definition at line 100 of file RatesTrigger.cxx.

                                                {
  std::stringstream ss;
  ss << std::setfill(' ') 
     << "Prescale:" << std::setw(11) << std::left << m_prescale 
     << " xpress:" << std::setw(11) << std::left << m_expressPrescale 
     << " CPSID:" << std::setw(11) << std::left << m_CPSID 
     << " seedPS:" << std::setw(11) << std::left << m_seedPrescale 
     << " : " << (m_seed != "" ? m_seed : "") << (m_seed != "" ? " -> " : "") << m_name;
  return ss.str();
}

printExpressRate()

const std::string RatesTrigger::printExpressRate ( const double  ratesDenominator ) const

inherited

Prints the RatesTrigger's express rate.

Parameters

ratesDenominator

The walltime for the run, needed to normalise from integrated weighted counts to a rate.

Returns

The information to be printed

Definition at line 131 of file RatesTrigger.cxx.

                                                                                  {
  std::stringstream ss;
  ss << std::setfill(' '); 
  ss << "Express Rate: " << std::setw(11) << std::right << m_rateExpressAccumulator/ratesDenominator 
     << " +- "    << std::setw(11) << std::left << sqrt(m_rateExpressAccumulator2)/ratesDenominator << " Hz";
  ss << " : ";
  ss << m_name << " [PS:" << m_prescale << "] [EXPRESS PS:" << m_expressPrescale << "]";
  if (m_seed != "") ss << " <- " << m_seed << " [PS:" << m_seedPrescale << "]";
  ss << " (Extrap:"<< getExtrapolationFactorString(m_extrapolationStrategy) <<")";
  return ss.str();
}

printRate()

const std::string RatesScanTrigger::printRate ( const double  ratesDenominator ) const

overridevirtual

Prints the RatesScanTrigger's rate (different output to a regular trigger)

Parameters

ratesDenominator

The walltime for the run, needed to normalise from integrated weighted counts to a rate.

Reimplemented from RatesTrigger.

Definition at line 92 of file RatesScanTrigger.cxx.

                                                                               {
  std::stringstream ss;
  const int nBins = m_rateScanHistCachedPtr->GetNbinsX();
  ss << std::setfill(' '); 
  ss << m_name << " [PS:" << m_prescale << "]";
  if (m_seed != "") ss << " <- " << m_seed << " [PS:" << m_seedPrescale << "]";
  ss << " (Extrap:"<< getExtrapolationFactorString(m_extrapolationStrategy) << ")" << std::endl;
 
  if (m_behaviour == kTriggerBelowThreshold) {
 
    ss << "    Threshold <= " << std::setw(11) << std::left << std::as_const(*m_rateScanHistCachedPtr).GetXaxis()->GetXmin();
    ss << " Rate :" << std::setw(11) << std::right << m_rateScanHistCachedPtr->GetBinContent(0)/ratesDenominator;
    ss << " +- "   << std::setw(11) << std::left << m_rateScanHistCachedPtr->GetBinError(0)/ratesDenominator << " Hz" << std::endl;
 
    for (int bin = 1; bin <= nBins; ++bin) {
      ss << "    Threshold <= ";
      ss << std::setw(11) << std::left << m_rateScanHistCachedPtr->GetBinLowEdge(bin) + m_rateScanHistCachedPtr->GetBinWidth(bin);
      ss << " Rate :" << std::setw(11) << std::right << m_rateScanHistCachedPtr->GetBinContent(bin)/ratesDenominator;
      ss << " +- "   << std::setw(11) << std::left << m_rateScanHistCachedPtr->GetBinError(bin)/ratesDenominator << " Hz";
      ss << std::endl;
    }
 
    ss << "    Threshold >  " << std::setw(11) << std::left << std::as_const(*m_rateScanHistCachedPtr).GetXaxis()->GetXmax();
    ss << " Rate :" << std::setw(11) << std::right << m_rateScanHistCachedPtr->GetBinContent(nBins+1)/ratesDenominator;
    ss << " +- "   << std::setw(11) << std::left << m_rateScanHistCachedPtr->GetBinError(nBins+1)/ratesDenominator << " Hz";
  
  } else if (m_behaviour == kTriggerAboveThreshold) {
 
    ss << "    Threshold <  " << std::setw(11) << std::left << std::as_const(*m_rateScanHistCachedPtr).GetXaxis()->GetXmin();
    ss << " Rate: " << std::setw(11) << std::right << m_rateScanHistCachedPtr->GetBinContent(0)/ratesDenominator;
    ss << " +- "   << std::setw(11) << std::left << m_rateScanHistCachedPtr->GetBinError(0)/ratesDenominator << " Hz" << std::endl;
  
    for (int bin = 1; bin <= nBins; ++bin) {
      ss << "    Threshold >= ";
      ss << std::setw(11) << std::left << m_rateScanHistCachedPtr->GetBinLowEdge(bin);
      ss << " Rate: " << std::setw(11) << std::right << m_rateScanHistCachedPtr->GetBinContent(bin)/ratesDenominator;
      ss << " +- "   << std::setw(11) << std::left << m_rateScanHistCachedPtr->GetBinError(bin)/ratesDenominator << " Hz";
      ss << std::endl;
    }
 
    ss << "    Threshold >= " << std::setw(11) << std::left << std::as_const(*m_rateScanHistCachedPtr).GetXaxis()->GetXmax();
    ss << " Rate: " << std::setw(11) << std::right << m_rateScanHistCachedPtr->GetBinContent(nBins+1)/ratesDenominator;
    ss << " +- "   << std::setw(11) << std::left << m_rateScanHistCachedPtr->GetBinError(nBins+1)/ratesDenominator << " Hz";
  
  }
 
  return ss.str();
}

reset()

void RatesScanTrigger::reset ( )

inlineoverridevirtual

If I was used in an event, reset me.

Reimplemented from RatesTrigger.

Definition at line 75 of file RatesScanTrigger.h.

setCoherentFactor()

void RatesTrigger::setCoherentFactor ( const double  lowestCommonPrescale )

inherited

If i'm in a CPS group, set the lowest commons PS factor of the group.

Definition at line 165 of file RatesTrigger.cxx.

{ m_coherentFactor = lowestCommonPrescale; } 

setCPS()

void RatesTrigger::setCPS ( const std::string &  group )

inherited

If I'm in a CPS group, set the group name (I'll keep a copy of the hash)

Definition at line 167 of file RatesTrigger.cxx.

{ m_CPSID = std::hash<std::string>{}(group); }

setLevel()

void AthMessaging::setLevel ( MSG::Level  lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

setPassed()

void RatesTrigger::setPassed ( const bool  passed = true, const bool  active = true, const bool  unbiasedEvent = false  )

inherited

Set the pass/fail bool.

Execute needs to be called separately afterwards.

Definition at line 38 of file RatesTrigger.cxx.

                                                                                           { 
  if (m_seedsFromRandom == true && unbiasedEvent == false) return;
  if (m_active && !m_pass) throw std::runtime_error("Cannot pass if not active");
  m_pass = passed;
  m_active = active;
}

setPassedAndExecute() [1/2]

void RatesTrigger::setPassedAndExecute ( const bool  passed, const bool  active, const WeightingValuesSummary_t &  weights  )

inherited

Set the pass/fail bool and immediately call execute.

Should only be done once per event.

Parameters

i	If the trigger passed or failed the event @weights Struct of weighting information for the event

Definition at line 45 of file RatesTrigger.cxx.

                                                                                                                    { 
  if (m_seedsFromRandom == true && weights.m_isUnbiased == false) return;
  if (m_pass == false && m_active == false) { // Protect against two positive calls/event
    if (m_active && !m_pass) throw std::runtime_error("Cannot pass if not active");
    m_pass = passed;
    m_active = active;
    execute(weights);
  }
}

setPassedAndExecute() [2/2]

void RatesScanTrigger::setPassedAndExecute	(	const double	t,
		const WeightingValuesSummary_t &	weights
	)

Set the pass threshold and immediately call execute.

Should only be done once per event.

Parameters

t	The threshold reached by the event
weights	Set of weighting values which may be needed.

Definition at line 53 of file RatesScanTrigger.cxx.

                                                                                                  {
  if (m_seedsFromRandom == true && weights.m_isUnbiased == false) return;
  if (m_thresholdPassed != std::numeric_limits<double>::min()) return; // We've already done this event
  m_thresholdPassed = t;
  execute(weights);
}

setSeedsFromRandom()

void RatesTrigger::setSeedsFromRandom ( const bool  i )

inherited

Set if this trigger is to behave as if it seeds from a random L1 item.

Definition at line 145 of file RatesTrigger.cxx.

{ m_seedsFromRandom = i; }

setUniqueGroup()

void RatesTrigger::setUniqueGroup ( const RatesGroup *  unique )

inherited

If I have a group which is calculating my unique rate.

Definition at line 163 of file RatesTrigger.cxx.

{ m_uniqueGroup = unique; } 

Member Data Documentation

ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

m_active

bool RatesTrigger::m_active

protectedinherited

Was the trigger active? (Did it run)

Definition at line 115 of file RatesTrigger.h.

m_behaviour

TriggerBehaviour_t RatesScanTrigger::m_behaviour

private

If we need to be above or below the threshold to cause the trigger to fire.

Definition at line 112 of file RatesScanTrigger.h.

m_coherentFactor

double RatesTrigger::m_coherentFactor

protectedinherited

If I'm in a coherent prescale group, the prescale of the lowest non-disabled chain in the group.

Definition at line 125 of file RatesTrigger.h.

m_CPSID

size_t RatesTrigger::m_CPSID

protectedinherited

If I'm in a coherent prescale group, my group's ID (hash of the group name)

Definition at line 124 of file RatesTrigger.h.

m_data

std::unique_ptr<TH1> RatesHistoBase::m_data

protectedinherited

Histogram of raw rates quantites, for when we need to normalise offline (e.g.

grid processing)

Definition at line 112 of file RatesHistoBase.h.

m_dataCachedPtr

TH1* RatesHistoBase::m_dataCachedPtr {}

protectedinherited

Cached, non-owning pointer.

Definition at line 115 of file RatesHistoBase.h.

m_doHistograms

bool RatesHistoBase::m_doHistograms

protectedinherited

If histogramming is switched on.

Definition at line 109 of file RatesHistoBase.h.

m_expressPrescale

const double RatesTrigger::m_expressPrescale

protectedinherited

My express stream prescale factor, gets applied on top of the regular prescale.

Definition at line 134 of file RatesTrigger.h.

m_extrapolationStrategy

const ExtrapStrat_t RatesTrigger::m_extrapolationStrategy

protectedinherited

How this trigger is to scale with luminosity.

Definition at line 139 of file RatesTrigger.h.

m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

m_name

const std::string RatesTrigger::m_name

protectedinherited

My name.

Definition at line 129 of file RatesTrigger.h.

m_nameHash

const size_t RatesTrigger::m_nameHash

protectedinherited

Hash of my name.

Definition at line 131 of file RatesTrigger.h.

m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

m_pass

bool RatesTrigger::m_pass

protectedinherited

Did the trigger pass or not?

Definition at line 114 of file RatesTrigger.h.

m_prescale

const double RatesTrigger::m_prescale

protectedinherited

My prescale factor.

Definition at line 133 of file RatesTrigger.h.

m_rateAccumulator

double RatesTrigger::m_rateAccumulator

protectedinherited

Weighted events passed.

Definition at line 117 of file RatesTrigger.h.

m_rateAccumulator2

double RatesTrigger::m_rateAccumulator2

protectedinherited

Weighted events passed squared.

Definition at line 118 of file RatesTrigger.h.

m_rateExpressAccumulator

double RatesTrigger::m_rateExpressAccumulator

protectedinherited

Weighted express stream events.

Definition at line 119 of file RatesTrigger.h.

m_rateExpressAccumulator2

double RatesTrigger::m_rateExpressAccumulator2

protectedinherited

Weighted express stream events squared.

Definition at line 120 of file RatesTrigger.h.

m_ratesActive

double RatesTrigger::m_ratesActive

protectedinherited

Definition at line 121 of file RatesTrigger.h.

m_ratesActive2

double RatesTrigger::m_ratesActive2

protectedinherited

Definition at line 122 of file RatesTrigger.h.

m_rateScanHist

std::unique_ptr<TH1> RatesScanTrigger::m_rateScanHist

private

Even if we are not exporting it - we still need this histo.

Definition at line 109 of file RatesScanTrigger.h.

m_rateScanHistCachedPtr

TH1* RatesScanTrigger::m_rateScanHistCachedPtr

private

Definition at line 110 of file RatesScanTrigger.h.

m_rateVsMu

std::unique_ptr<TH1> RatesHistoBase::m_rateVsMu

protectedinherited

Histogram of rate as a fn.

of the input event's mu

Definition at line 110 of file RatesHistoBase.h.

m_rateVsMuCachedPtr

TH1* RatesHistoBase::m_rateVsMuCachedPtr {}

protectedinherited

Cached, non-owning pointer.

Definition at line 113 of file RatesHistoBase.h.

m_rateVsTrain

std::unique_ptr<TH1> RatesHistoBase::m_rateVsTrain

protectedinherited

Histogram of rate as a fn.

of position in bunch train

Definition at line 111 of file RatesHistoBase.h.

m_rateVsTrainCachedPtr

TH1* RatesHistoBase::m_rateVsTrainCachedPtr {}

protectedinherited

Cached, non-owning pointer.

Definition at line 114 of file RatesHistoBase.h.

m_seed

const std::string RatesTrigger::m_seed

protectedinherited

My seed, "" if no seed.

Definition at line 130 of file RatesTrigger.h.

m_seedHash

const size_t RatesTrigger::m_seedHash

protectedinherited

Has of my seed name.

Definition at line 132 of file RatesTrigger.h.

m_seedPrescale

const double RatesTrigger::m_seedPrescale

protectedinherited

Definition at line 135 of file RatesTrigger.h.

m_seedsFromRandom

bool RatesTrigger::m_seedsFromRandom

protectedinherited

Does this trigger seed from a random trigger? If so it should only be exposed to unbiased events.

Definition at line 116 of file RatesTrigger.h.

m_thresholdPassed

double RatesScanTrigger::m_thresholdPassed

private

Analogous to m_pass.

This is the threshold that the trigger passed in the event

Definition at line 111 of file RatesScanTrigger.h.

m_totalPrescaleWeight

const double RatesTrigger::m_totalPrescaleWeight

protectedinherited

Equal to 1/m_seedPrescale*m_prescale.

Definition at line 136 of file RatesTrigger.h.

m_totalPrescaleWeightExpress

const double RatesTrigger::m_totalPrescaleWeightExpress

protectedinherited

Equal to 1/m_seedPrescale*m_prescale*m_expressPrescale.

Definition at line 137 of file RatesTrigger.h.

m_uniqueGroup

const RatesGroup* RatesTrigger::m_uniqueGroup

protectedinherited

Pointer to the group which is calculating my unique rate.

Definition at line 127 of file RatesTrigger.h.

---

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

• RatesScanTrigger.h
• RatesScanTrigger.cxx