RatesHistoBase Class Reference

Basic base class for any common functionality between RatesTrigger and RatesGroup This means that everyone has access to the same histograms. More...

#include <RatesHistoBase.h>

Inheritance diagram for RatesHistoBase:

Collaboration diagram for RatesHistoBase:

Public Member Functions
	RatesHistoBase (const std::string &name, IMessageSvc *msgSvc, const bool doHistograms=true)
virtual	~RatesHistoBase ()
	RatesHistoBase (const RatesHistoBase &)=delete
RatesHistoBase &	operator= (const RatesHistoBase &)=delete
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.
TH1 *	getDataHist ()
bool	doHistograms () const
	If histogramming was enabled in this rates object.
const std::string &	getExtrapolationFactorString (ExtrapStrat_t strat) const
double	getExtrapolationFactor (const WeightingValuesSummary_t &weights, const ExtrapStrat_t strat) const
void	setDataName (const std::string &newName)
void	setRateVsMuName (const std::string &newName)
void	setRateVsTrainName (const std::string &newName)
bool	msgLvl (const MSG::Level lvl) const
	Test the output level.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.
void	setLevel (MSG::Level lvl)
	Change the current logging level.

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

Protected Attributes
std::string	m_name
	My name.
bool	m_doHistograms
	If histogramming is switched on.
std::unique_ptr< TH1 >	m_rateVsMu
	Histogram of rate as a fn.
std::unique_ptr< TH1 >	m_rateVsTrain
	Histogram of rate as a fn.
std::unique_ptr< TH1 >	m_data
	Histogram of raw rates quantites, for when we need to normalise offline (e.g.
TH1 *	m_rateVsMuCachedPtr {}
	Cached, non-owning pointer.
TH1 *	m_rateVsTrainCachedPtr {}
	Cached, non-owning pointer.
TH1 *	m_dataCachedPtr {}
	Cached, non-owning pointer.

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

Private Attributes
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels).
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging).

Detailed Description

Basic base class for any common functionality between RatesTrigger and RatesGroup This means that everyone has access to the same histograms.

Definition at line 85 of file RatesHistoBase.h.

Constructor & Destructor Documentation

RatesHistoBase() [1/2]

RatesHistoBase::RatesHistoBase	(	const std::string &	name,
		IMessageSvc *	msgSvc,
		const bool	doHistograms = true )

Definition at line 10 of file RatesHistoBase.cxx.

                                                                                                  :
  AthMessaging(msgSvc, name),
  m_name(name),
  m_doHistograms(doHistograms)
{
  if (doHistograms) {
    m_rateVsMu = std::make_unique<TH1D>("",TString(name + ";#mu;Rate / Unit #mu [Hz]"),226,-.5,225.5);
    m_rateVsMu->Sumw2(true);
    m_rateVsMu->SetName("rateVsMu");
    m_rateVsMuCachedPtr = m_rateVsMu.get();
 
    m_rateVsTrain = std::make_unique<TH1D>("",TString(name + ";Distance Into Train;Rate / BCID [Hz]"),100,-0.5,99.5);
    m_rateVsTrain->Sumw2(true);
    m_rateVsTrain->SetName("rateVsTrain");
    m_rateVsTrainCachedPtr = m_rateVsTrain.get();
 
    m_data =  std::make_unique<TH1D>("",TString(";Variable;Raw Data"), RatesBinIdentifier_t::kNRATES_BINS, -.5, RatesBinIdentifier_t::kNRATES_BINS - .5);
    m_data->Sumw2(true);
    m_data->SetName("data");
    // Set bin labels based on RatesBinIdentifier_t
    m_data->GetXaxis()->SetBinLabel(1, "Actve Raw");
    m_data->GetXaxis()->SetBinLabel(2, "Active Weighted");
    m_data->GetXaxis()->SetBinLabel(3, "Pass Raw");
    m_data->GetXaxis()->SetBinLabel(4, "Pass Weighted OR");
    m_data->GetXaxis()->SetBinLabel(5, "Pass Weighted AND");
    m_data->GetXaxis()->SetBinLabel(6, "Express");
    m_data->GetXaxis()->SetBinLabel(7, "Unique");
    m_dataCachedPtr = m_data.get();
 
  }
}

~RatesHistoBase()

RatesHistoBase::~RatesHistoBase ( )

virtual

Definition at line 43 of file RatesHistoBase.cxx.

                                {
}

RatesHistoBase() [2/2]

RatesHistoBase::RatesHistoBase ( const RatesHistoBase & )

delete

Member Function Documentation

clearTrainHist()

void RatesHistoBase::clearTrainHist

(

)

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

inline

If histogramming was enabled in this rates object.

Definition at line 100 of file RatesHistoBase.h.

getDataHist()

TH1 * RatesHistoBase::getDataHist

(

)

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

getExtrapolationFactor()

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

Definition at line 96 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

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)); 
}

giveDataHist()

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

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 )

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;
}

giveTrainHist()

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

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();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

isNotPositive()

bool RatesHistoBase::isNotPositive ( double v )

inlinestatic

Definition at line 105 of file RatesHistoBase.h.

{ return v < std::numeric_limits<double>::min(); } //<! Helper fn to check if the value is non positive = trigger is disabled

isZero()

bool RatesHistoBase::isZero ( double v )

inlinestatic

Definition at line 104 of file RatesHistoBase.h.

{ return std::abs(v) < std::numeric_limits<double>::min(); } //<! 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 167 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 182 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 user did not set explicit message level we have to initialize
  // the messaging and retrieve the default via the MessageSvc.
  if (m_lvl==MSG::NIL && !m_initialized.test_and_set()) initMessaging();
 
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

operator=()

RatesHistoBase & RatesHistoBase::operator= ( const RatesHistoBase & )

delete

setDataName()

void RatesHistoBase::setDataName

(

const std::string &

newName

)

Definition at line 92 of file RatesHistoBase.cxx.

{if (m_data) m_data->SetName(newName.c_str());}

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;
}

setRateVsMuName()

void RatesHistoBase::setRateVsMuName

(

const std::string &

newName

)

Definition at line 93 of file RatesHistoBase.cxx.

{if (m_rateVsMu) m_rateVsMu->SetName(newName.c_str());}

setRateVsTrainName()

void RatesHistoBase::setRateVsTrainName

(

const std::string &

newName

)

Definition at line 94 of file RatesHistoBase.cxx.

{if (m_rateVsTrain) m_rateVsTrain->SetName(newName.c_str());}

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_data

std::unique_ptr<TH1> RatesHistoBase::m_data

protected

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

grid processing)

Definition at line 116 of file RatesHistoBase.h.

m_dataCachedPtr

TH1* RatesHistoBase::m_dataCachedPtr {}

protected

Cached, non-owning pointer.

Definition at line 119 of file RatesHistoBase.h.

{}; 

m_doHistograms

bool RatesHistoBase::m_doHistograms

protected

If histogramming is switched on.

Definition at line 113 of file RatesHistoBase.h.

m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_lvl

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

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

{ MSG::NIL };

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

std::string RatesHistoBase::m_name

protected

My name.

Definition at line 112 of file RatesHistoBase.h.

m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

m_rateVsMu

std::unique_ptr<TH1> RatesHistoBase::m_rateVsMu

protected

Histogram of rate as a fn.

of the input event's mu

Definition at line 114 of file RatesHistoBase.h.

m_rateVsMuCachedPtr

TH1* RatesHistoBase::m_rateVsMuCachedPtr {}

protected

Cached, non-owning pointer.

Definition at line 117 of file RatesHistoBase.h.

{}; 

m_rateVsTrain

std::unique_ptr<TH1> RatesHistoBase::m_rateVsTrain

protected

Histogram of rate as a fn.

of position in bunch train

Definition at line 115 of file RatesHistoBase.h.

m_rateVsTrainCachedPtr

TH1* RatesHistoBase::m_rateVsTrainCachedPtr {}

protected

Cached, non-owning pointer.

Definition at line 118 of file RatesHistoBase.h.

{};  

---

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

• RatesHistoBase.h
• RatesHistoBase.cxx