Wrapper around a histogram which allows for some additional filling patterns and data manipulation. More...

#include <Variable.h>

Collaboration diagram for Variable:

Public Member Functions
	Variable ()=delete
	Forbid default constructor. More...

	Variable (const std::string &name, TH1 *cacheHistoPtr, VariableType type=kPerCall)
	Construct Variable. More...

	~Variable ()=default
	Default destructor. More...

Variable &	operator= (const Variable &)=delete
	Forbid copy. More...

	Variable (const Variable &)=delete
	Forbid copy. More...

const std::string &	getName () const
	Getter for Variable's name. More...

size_t	getCalls () const
	Getter for how many times fill() has already been called on this Variable in this event. More...

float	getAccumulator () const
	Getter for accumulated value of a kPerEvent Variable. More...

StatusCode	fill (float value, float weight=1.0)
	Fill histogram (per-Call Variable), or add value to internal accumulator (per-Event Variable) to be filled at the end of the event. More...

StatusCode	fill (float xvalue, float yvalue, float weight)
	Fill histogram (per-Call Variable), or add value to internal accumulator (per-Event Variable) to be filled at the end of the event. More...

StatusCode	fill (const std::string &label, float weight=1.0)
	Fill histogram's bin (per-Call Variable) with given label. More...

StatusCode	increment (float weight=1.0)
	Convenience function. More...

StatusCode	setBinLabel (int bin, const std::string &label)
	Set label on given bin in cached histogram. More...

StatusCode	setYBinLabel (int bin, const std::string &label)
	Set label on given bin in cached histogram on y axis. More...

void	setDenominator (float value)
	Sets, until the end of the event, a denominator which will be used to normalise every Fill. More...

StatusCode	endEvent ()
	Called by the framework. More...

Private Attributes
const std::string	m_name

const VariableType	m_variableType

TH1 *	m_cacheHistoPtr

size_t	m_calls

float	m_xaccumulator

float	m_yaccumulator

float	m_weight
	Cache of the event weight. More...

float	m_oneOverDenominator
	Cache of the reciprocal of the denominator used to normalise when filling the histogram. More...

Detailed Description

Wrapper around a histogram which allows for some additional filling patterns and data manipulation.

Behaviour based on type parameter. per-Call directly fills underlying histogram for each call of fill. per-Event fills the underlying histogram exactly once in events where fill was called one or more times. The filled value is accumulated from all calls to fill during the event in per-Event mode.

Definition at line 39 of file Trigger/TrigCost/TrigCostAnalysis/src/Variable.h.

Constructor & Destructor Documentation

◆ Variable() [1/3]

Variable::Variable ( )

delete

Forbid default constructor.

◆ Variable() [2/3]

Variable::Variable	(	const std::string &	name,
		TH1 *	cacheHistoPtr,
		VariableType	type = `kPerCall`
	)

Construct Variable.

Parameters

[in]	name	Variable's name
[in]	cacheHistoPtr	Cached non-owning pointer to the histogram which this Variable wraps.
[in]	type	If the Variable should operate in per-Call mode (direct fill) or per-Event mode (accumulate and fill at the end of the event).

Definition at line 12 of file Variable.cxx.

                                                                                :
   m_name(name),
   m_variableType(type),
   m_cacheHistoPtr(cacheHistoPtr),
   m_calls(0),
   m_xaccumulator(0.),
   m_yaccumulator(0.),
   m_weight(0.),
   m_oneOverDenominator(1.) {
 }

◆ ~Variable()

Variable::~Variable ( )

default

Default destructor.

◆ Variable() [3/3]

Variable::Variable ( const Variable & )

delete

Forbid copy.

Member Function Documentation

◆ endEvent()

StatusCode Variable::endEvent ( )

Called by the framework.

Triggers actual histogram fill for a per-Event variable. Resets internals.

Definition at line 120 of file Variable.cxx.

                               {
   if (m_variableType == kPerEvent && m_calls > 0) {
     ATH_CHECK(m_cacheHistoPtr != nullptr);
     // 2D histogram
     if (m_yaccumulator > 0){
       TH2F* th2f = dynamic_cast<TH2F*>(m_cacheHistoPtr);
       if (th2f == nullptr){
         // Cast failed - should be TProfile
         dynamic_cast<TProfile*>(m_cacheHistoPtr)->Fill(m_xaccumulator * m_oneOverDenominator, m_yaccumulator, m_weight);
       } else {
         th2f->Fill(m_xaccumulator * m_oneOverDenominator, m_yaccumulator, m_weight);
       }
     } else {
       m_cacheHistoPtr->Fill(m_xaccumulator * m_oneOverDenominator, m_weight);
     }
     
   }
   m_calls = 0;
   m_xaccumulator = 0.0;
   m_yaccumulator = 0.0;
   m_weight = 0.0;
   m_oneOverDenominator = 1.0;
   return StatusCode::SUCCESS;
 }

◆ fill() [1/3]

StatusCode Variable::fill	(	const std::string &	label,
		float	weight = `1.0`
	)

Fill histogram's bin (per-Call Variable) with given label.

Parameters

[in]	label	Label of bin to fill
[in]	weight	Global event weight

Definition at line 96 of file Variable.cxx.

                                                               {
   m_cacheHistoPtr->Fill(label.c_str(), weight);
   return StatusCode::SUCCESS;
 }

◆ fill() [2/3]

StatusCode Variable::fill	(	float	value,
		float	weight = `1.0`
	)

Fill histogram (per-Call Variable), or add value to internal accumulator (per-Event Variable) to be filled at the end of the event.

Parameters

[in]	value	The payload.
[in]	weight	Global event weight

Definition at line 49 of file Variable.cxx.

                                                    {
   switch(m_variableType) {
     case kPerCall:
       ATH_CHECK(m_cacheHistoPtr != nullptr);
       m_cacheHistoPtr->Fill(value * m_oneOverDenominator, weight);
       break;
     case kPerEvent:
       ++m_calls;
       m_xaccumulator += value;
       m_weight = weight;
       break;
     default:
       return StatusCode::FAILURE;
       break;
   }
   return StatusCode::SUCCESS;
 }

◆ fill() [3/3]

StatusCode Variable::fill	(	float	xvalue,
		float	yvalue,
		float	weight
	)

Fill histogram (per-Call Variable), or add value to internal accumulator (per-Event Variable) to be filled at the end of the event.

Parameters

[in]	xvalue	The x-axis payload.
[in]	yvalue	The y-axis payload.
[in]	weight	Global event weight

Definition at line 68 of file Variable.cxx.

                                                                   {
   switch(m_variableType) {
     case kPerCall:
     {
       ATH_CHECK(m_cacheHistoPtr != nullptr);
       TH2F* th2f = dynamic_cast<TH2F*>(m_cacheHistoPtr);
       if (th2f == nullptr){
         // Cast failed - should be TProfile
         dynamic_cast<TProfile*>(m_cacheHistoPtr)->Fill(xvalue * m_oneOverDenominator, yvalue * m_oneOverDenominator, weight);
       } else {
         th2f->Fill(xvalue * m_oneOverDenominator, yvalue * m_oneOverDenominator, weight);
       }
       break;
     }
     case kPerEvent:
       ++m_calls;
       m_xaccumulator += xvalue;
       m_yaccumulator += yvalue;
       m_weight = weight;
       break;
     default:
       return StatusCode::FAILURE;
       break;
   }
   return StatusCode::SUCCESS;
 }

◆ getAccumulator()

float Variable::getAccumulator ( ) const

Getter for accumulated value of a kPerEvent Variable.

Returns: Total accumulated payload

Definition at line 34 of file Variable.cxx.

                                      {
   return m_xaccumulator;
 }

◆ getCalls()

size_t Variable::getCalls ( ) const

Getter for how many times fill() has already been called on this Variable in this event.

Returns: Number of fill calls this event.

Definition at line 29 of file Variable.cxx.

                                 {
   return m_calls;
 }

◆ getName()

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

Getter for Variable's name.

Returns: Variable's name const string reference.

Definition at line 24 of file Variable.cxx.

                                          {
   return m_name;
 }

◆ increment()

StatusCode Variable::increment ( float weight = 1.0 )

Convenience function.

Equivalent of fill(1.0, weight). For use with per-Event counting type variables.

Parameters

[in] weight Global event weight

Definition at line 102 of file Variable.cxx.

                                            {
   ATH_CHECK(fill(1.0, weight));
   return StatusCode::SUCCESS;
 }

◆ operator=()

Variable& Variable::operator= ( const Variable & )

delete

Forbid copy.

◆ setBinLabel()

StatusCode Variable::setBinLabel	(	int	bin,
		const std::string &	label
	)

Set label on given bin in cached histogram.

Parameters

[in]	bin	Bin number
[in]	label	Label to set

Definition at line 108 of file Variable.cxx.

                                                                 {
   m_cacheHistoPtr->GetXaxis()->SetBinLabel(bin, label.c_str());
   return StatusCode::SUCCESS;
 }

◆ setDenominator()

void Variable::setDenominator ( float value )

Sets, until the end of the event, a denominator which will be used to normalise every Fill.

@pram[in] value The denominator to normalise Fill operations.

Definition at line 39 of file Variable.cxx.

                                          {
   // Stored as reciprocal so as to be able to check for /0 here
   if (std::abs(value) < 1e-10) {
     m_oneOverDenominator = 0.0;
   } else {
     m_oneOverDenominator = 1. / value;
   }
 }

◆ setYBinLabel()

StatusCode Variable::setYBinLabel	(	int	bin,
		const std::string &	label
	)

Set label on given bin in cached histogram on y axis.

Parameters

[in]	bin	Bin number
[in]	label	Label to set

Definition at line 114 of file Variable.cxx.

                                                                  {
   m_cacheHistoPtr->GetYaxis()->SetBinLabel(bin, label.c_str());
   return StatusCode::SUCCESS;
 }

Member Data Documentation

◆ m_cacheHistoPtr

TH1* Variable::m_cacheHistoPtr

private

Definition at line 144 of file Trigger/TrigCost/TrigCostAnalysis/src/Variable.h.

◆ m_calls

size_t Variable::m_calls

private

Definition at line 145 of file Trigger/TrigCost/TrigCostAnalysis/src/Variable.h.

◆ m_name

const std::string Variable::m_name

private

Definition at line 142 of file Trigger/TrigCost/TrigCostAnalysis/src/Variable.h.

◆ m_oneOverDenominator

float Variable::m_oneOverDenominator

private

Cache of the reciprocal of the denominator used to normalise when filling the histogram.

Definition at line 149 of file Trigger/TrigCost/TrigCostAnalysis/src/Variable.h.

◆ m_variableType

const VariableType Variable::m_variableType

private

Definition at line 143 of file Trigger/TrigCost/TrigCostAnalysis/src/Variable.h.

◆ m_weight

float Variable::m_weight

private

Cache of the event weight.

Assumed to be the same for every call to fill with per-Event monitoring!

Definition at line 148 of file Trigger/TrigCost/TrigCostAnalysis/src/Variable.h.

◆ m_xaccumulator

float Variable::m_xaccumulator

private

Definition at line 146 of file Trigger/TrigCost/TrigCostAnalysis/src/Variable.h.

◆ m_yaccumulator

float Variable::m_yaccumulator

private

Definition at line 147 of file Trigger/TrigCost/TrigCostAnalysis/src/Variable.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Variable() [1/3]

◆ Variable() [2/3]

◆ ~Variable()

◆ Variable() [3/3]

Member Function Documentation

◆ endEvent()

◆ fill() [1/3]

◆ fill() [2/3]

◆ fill() [3/3]

◆ getAccumulator()

◆ getCalls()

◆ getName()

◆ increment()

◆ operator=()

◆ setBinLabel()

◆ setDenominator()

◆ setYBinLabel()

Member Data Documentation

◆ m_cacheHistoPtr

◆ m_calls

◆ m_name

◆ m_oneOverDenominator

◆ m_variableType

◆ m_weight

◆ m_xaccumulator

◆ m_yaccumulator