Container for binned sums of calorimeter variables. More...

#include <CaloSum.h>

Collaboration diagram for CaloSum:

Public Types
enum	CaloRegion { Central = 0x01, EndCap = 0x02, Forward = 0x04, Em = 0x08, Had = 0x10, UnknownRegion = 0xff }
	Region indicator implementation. More...

enum	CaloVarType { E = 0x01, EDensity = 0x02, EFraction = 0x04, Et = 0x08, EtFraction = 0x10, UnknownType = 0xff }
	Binned variable type. More...

typedef std::pair< CaloRegion, CaloSampling::CaloSample >	key_t
	Key type for compressed storage. More...

typedef std::vector< double >	data_t
	Data type for parallel running sums in a bin. More...

typedef data_t::iterator	data_iter_t
	Data iterator type. More...

typedef data_t::const_iterator	data_const_iter_t
	Data const iterator type. More...

typedef std::vector< data_t >	bin_t
	Bin type. More...

typedef bin_t::iterator	bin_iter_t
	Bin iterator type. More...

typedef bin_t::const_iterator	bin_const_iter_t
	Bin const iterator type. More...

typedef std::map< key_t, bin_t >	store_t
	Store data type. More...

typedef store_t::iterator	store_iter_t
	Store iterator type. More...

typedef store_t::const_iterator	store_const_iter_t
	Store const iterator type. More...

typedef std::pair< double, double >	range_t
	Range type. More...

typedef std::vector< range_t >	range_cont_t
	Range container type. More...

typedef std::map< CaloRegion, range_cont_t >	range_map_t
	Range map type. More...

typedef store_const_iter_t	const_iterator
	Store iterator type. More...

Public Member Functions
	CaloSum ()
	Default constructor. More...

	CaloSum (CaloVarType varType, const CaloBinDescriptor< double > &theBins, size_t numberOfSums=1)
	Useful constructor. More...

virtual	~CaloSum ()
	Useful constructor. More...

virtual bool	setRegion (const CaloSum::CaloRegion &theRegion, double etaLow, double etaHigh)
	Configure regions. More...

virtual bool	setRegion (const CaloSum::CaloRegion &theRegion, const std::vector< double > &etaLow, const std::vector< double > &etaHigh)
	Configure regions. More...

virtual CaloRegion	getRegion (double theEta) const
	Retrieve region for a given eta. More...

virtual bool	getRange (const CaloRegion &theRegion, std::vector< double > &lowEtas, std::vector< double > &highEtas) const
	Returns eta range(s) for a given region. More...

virtual CaloVarType	getVarType () const
	Returns binned variable type. More...

virtual size_t	getNumberOfBins () const
	Returns number of bins. More...

virtual size_t	getNumberOfSums () const
	Returns number of sums in each bin. More...

virtual bool	getVariableRange (double &lowLimit, double &highLimit) const
	Returs lower and upper limit of binned variable range. More...

virtual bool	getBinEdges (size_t theIndex, double &lowEdge, double &highEdge) const
	Returns bin edges for a given bin. More...

virtual bool	getBinCenter (size_t theIndex, double &binCenter) const
	Returns bin center. More...

virtual const CaloBinDescriptor< double > &	getBinDescriptor () const
	Returns reference to complete bin descriptor. More...

virtual bool	add (const CaloCell *theCell, double theBinnedVariable, const std::vector< double > &theSummedVariables)
	Add to sums. More...

virtual bool	add (const CaloCell *theCell, double theBinnedVariable, double theSummedVariable)
	Add to sum. More...

virtual bool	add (const CaloSampling::CaloSample &theSampling, double theEta, double theBinnedVariable, const std::vector< double > &theSummedVariables)
	Add to sums. More...

virtual bool	add (const CaloSampling::CaloSample &theSampling, double theEta, double theBinnedVariable, double theSummedVariable)
	Add to sums. More...

const_iterator	begin () const
	Store begin iterator. More...

const_iterator	end () const
	Store end iterator. More...

bool	getSums (const_iterator &theIterator, size_t theBinIndex, std::vector< double > &theSums) const
	Returns sums for a given iterator. More...

bool	getSums (const_iterator &theIterator, double theBinnedVariable, std::vector< double > &theSums) const
	Returns sums for a given binned variable. More...

bool	getSums (const CaloSum::CaloRegion &theRegion, const CaloSampling::CaloSample &theSampling, size_t theIndex, std::vector< double > &theSums) const
	Returns sums for a given key and index. More...

bool	getSums (const CaloSum::CaloRegion &theRegion, const CaloSampling::CaloSample &theSampling, double theBinnedVariable, std::vector< double > &theSums) const
	Returns sums for a given key and binned variable. More...

virtual bool	contains (const CaloSum::CaloRegion &theRegion) const
	Returns sums for a given sampling, eta, and index. More...

virtual bool	contains (const CaloSampling::CaloSample &theSampling) const
	Checks if sampling in store. More...

virtual bool	contains (const CaloSum::CaloRegion &theRegion, const CaloSampling::CaloSample &theSampling) const
	Checks if region/sampling combination is in store. More...

Static Public Member Functions
static CaloRegion	getRegion (const_iterator &theIterator)
	Returns region for a given iterator. More...

static CaloSampling::CaloSample	getSampling (const_iterator &theIterator)
	Returns sampling for a given iterator. More...

Protected Member Functions
key_t	getKey (double theEta, const CaloSampling::CaloSample &theSample) const
	Translate into key. More...

bool	setUp ()
	Set up defaults. More...

Static Protected Member Functions
static key_t	getKey (const CaloRegion &theRegion, const CaloSampling::CaloSample &theSample)
	Translate into key. More...

Private Attributes
bool	m_defaultRanges
	Process flow control: indicates default range overwrite. More...

size_t	m_numberOfSums
	Store size: number of sums. More...

CaloVarType	m_varType
	Binned variable type. More...

CaloBinDescriptor< double >	m_binDescriptor
	Bin descriptor. More...

range_map_t	m_regionRanges
	Store for region ranges. More...

store_t	m_sumStore
	Store for sums. More...

Detailed Description

Container for binned sums of calorimeter variables.

Author: Peter Loch loch@.nosp@m.phys.nosp@m.ics.a.nosp@m.rizo.nosp@m.na.ed.nosp@m.u

Date: Feb.8, 2005

Version: 0

Simple data container for indexed running sums. Presently three indices are supported:

CaloRegion indicates a calorimeter region.
CaloSample indicates a calorimeter sampling.
BinIndex indicates a variable bin index

It is possible to run several sums in a given bin. The binned variable can be different from the summed variable(s).

CaloRegions can be configured by the client. Three named regions are available, indentified by enumerators with default settings:

Central central region \( |\eta| < 0.8\) ;
EndCap endcap region \( 0.8 < |\eta| < 2.5 \) ;
Forward forward region \( |\eta| > 2.5 \) ;
EM electromagnetic calorimeter only
HAD hadronic calorimeter only

More than one \( \eta \) range can be assigned for each region, thus allowing categorizing these regions as non-contiguous entities. Also, the regions can overlap. In this case the to-be-summed quantities are added to all sums in overlapping regions.

Warning: Overlapping regions not yet correctly implemented!

Other configuration parameters are the type of the binned variable and the number of sums in each bin.

Code example:

// get a bin descriptor with equidistant bins
CaloBinDescriptor<double> theBins(100,0.,100000.);
// instantiate for energy density binning
CaloSum theSums(CaloSums::EDensity,theBins);

Todo:: Implement an option which allows definition of regions by sampling, i.e. no \( \eta \) cuts.

Definition at line 17 of file CaloSum.h.

Member Typedef Documentation

◆ bin_const_iter_t

typedef bin_t::const_iterator CaloSum::bin_const_iter_t

Bin const iterator type.

Definition at line 58 of file CaloSum.h.

◆ bin_iter_t

typedef bin_t::iterator CaloSum::bin_iter_t

Bin iterator type.

Definition at line 56 of file CaloSum.h.

◆ bin_t

typedef std::vector<data_t> CaloSum::bin_t

Bin type.

Definition at line 54 of file CaloSum.h.

◆ const_iterator

typedef store_const_iter_t CaloSum::const_iterator

Store iterator type.

Definition at line 123 of file CaloSum.h.

◆ data_const_iter_t

typedef data_t::const_iterator CaloSum::data_const_iter_t

Data const iterator type.

Definition at line 51 of file CaloSum.h.

◆ data_iter_t

typedef data_t::iterator CaloSum::data_iter_t

Data iterator type.

Definition at line 49 of file CaloSum.h.

◆ data_t

typedef std::vector<double> CaloSum::data_t

Data type for parallel running sums in a bin.

Definition at line 47 of file CaloSum.h.

◆ key_t

typedef std::pair<CaloRegion,CaloSampling::CaloSample> CaloSum::key_t

Key type for compressed storage.

Definition at line 44 of file CaloSum.h.

◆ range_cont_t

typedef std::vector<range_t> CaloSum::range_cont_t

Range container type.

Definition at line 70 of file CaloSum.h.

◆ range_map_t

typedef std::map<CaloRegion,range_cont_t> CaloSum::range_map_t

Range map type.

Definition at line 72 of file CaloSum.h.

◆ range_t

typedef std::pair<double,double> CaloSum::range_t

Range type.

Definition at line 68 of file CaloSum.h.

◆ store_const_iter_t

typedef store_t::const_iterator CaloSum::store_const_iter_t

Store const iterator type.

Definition at line 65 of file CaloSum.h.

◆ store_iter_t

typedef store_t::iterator CaloSum::store_iter_t

Store iterator type.

Definition at line 63 of file CaloSum.h.

◆ store_t

typedef std::map<key_t,bin_t> CaloSum::store_t

Store data type.

Definition at line 61 of file CaloSum.h.

Member Enumeration Documentation

◆ CaloRegion

enum CaloSum::CaloRegion

Region indicator implementation.

Enumerator
Central	Central region indicator.
EndCap	Central region indicator.
Forward	Forward region indicator.
Em	Electromagnetic calorimeter indicator.
Had	Hadronic calorimeter indicator.
UnknownRegion	Unknown region.

Definition at line 22 of file CaloSum.h.

     {
       Central       = 0x01, 
       EndCap        = 0x02, 
       Forward       = 0x04, 
       Em            = 0x08, 
       Had           = 0x10, 
       UnknownRegion = 0xff  
     };

◆ CaloVarType

enum CaloSum::CaloVarType

Binned variable type.

Enumerator
E	Energy amplitude.
EDensity	Energy density.
EFraction	Energy fraction.
Et	Transverse energy amplitude.
EtFraction	Transverse energy fraction.
UnknownType	Unknown variable type.

Definition at line 33 of file CaloSum.h.

     {
       E           = 0x01,   
       EDensity    = 0x02,   
       EFraction   = 0x04,   
       Et          = 0x08,   
       EtFraction  = 0x10,   
       UnknownType = 0xff    
     };

Constructor & Destructor Documentation

◆ CaloSum() [1/2]

CaloSum::CaloSum ( )

Default constructor.

Usefulness limited, allows only default configuration, but has no bin descriptor, i.e. no sums!

Definition at line 18 of file CaloSum.cxx.

                  :   m_defaultRanges(true)
            , m_numberOfSums(0)
            , m_varType(UnknownType)
            , m_binDescriptor(size_t(0),0.,0.) {}

◆ CaloSum() [2/2]

CaloSum::CaloSum	(	CaloVarType	varType,
		const CaloBinDescriptor< double > &	theBins,
		size_t	numberOfSums = `1`
	)

Useful constructor.

Accepts a variable type indicator, a bin descriptor, and the number of sums in a bin.

Parameters

varType	variable type indicator
theBins	bin descriptor
numberOfSums	number of running sums (default 1 if omitted)

The constructor implements default range assignments to each region

Central \( -0.8 < \eta < 0.8 \)
EndCap \( -2.5 < \eta < -0.8 \) and \( 0.8 < \eta < 2.5 \)
Forward \( -5.0 < \eta < -2.5 \) and \( 2.5 < \eta < 5.0 \)

This constructor implements only the regions defined above.

Definition at line 24 of file CaloSum.cxx.

   : m_defaultRanges(true)
     , m_numberOfSums(numberOfSums)
     , m_varType(varType)
     , m_binDescriptor(theBins)
 {
   this->setUp();
 }

◆ ~CaloSum()

CaloSum::~CaloSum ( )

virtualdefault

Useful constructor.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Constructor allows to give a list of regions. ‍/ CaloSum(CaloVarType varType, const CaloBinDescriptor<double>& theBins, const std::vector<CaloRegion>& theRegions, size_t numberOfSums = 1 ); /*! Descructor

Member Function Documentation

◆ add() [1/4]

bool CaloSum::add	(	const CaloCell *	theCell,
		double	theBinnedVariable,
		const std::vector< double > &	theSummedVariables
	)

virtual

Add to sums.

Returns false if problems adding (outside region range, outside binned variable range).

Parameters

theCell	pointer to a `CaloCell`
theBinnedVariable	binned variable
theSummedVariables	summed variables

In case of dimension mismatch, only the members of theSummedVariables fitting within the configured dimensions will be used.

If the cell is in a new region or sampling, a new key is generated and added to the internal store. No pre-setting of included (region,sampling) pairs (the keys) is necessary or possible. Unwanted combinations have to be avoided by the algorithms.

Definition at line 234 of file CaloSum.cxx.

 {
   // get sampling
   CaloSampling::CaloSample theSampling = theCell->caloDDE()->getSampling();
   // add up
   return this->add(theSampling,theCell->eta(),theBinnedVariable,
            theSummedVariables);
 }

◆ add() [2/4]

bool CaloSum::add	(	const CaloCell *	theCell,
		double	theBinnedVariable,
		double	theSummedVariable
	)

virtual

Add to sum.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

theCell	pointer to a `CaloCell`
theBinnedVariable	binned variable
theSummedVariable	summed variable

Definition at line 226 of file CaloSum.cxx.

 {
   std::vector<double> theSums; theSums.push_back(theSummedVariable);
   return this->add(theCell,theBinnedVariable,theSums);
 }

◆ add() [3/4]

bool CaloSum::add	(	const CaloSampling::CaloSample &	theSampling,
		double	theEta,
		double	theBinnedVariable,
		const std::vector< double > &	theSummedVariables
	)

virtual

Add to sums.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

theSampling	sampling indicator
theEta	eta of `CaloCell`
theBinnedVariable	binned variable
theSummedVariables	summed variables

Uses explicit sampling indicator and eta instead of CaloCell reference.

Definition at line 255 of file CaloSum.cxx.

 {
   // find bin
   size_t theIndex = m_binDescriptor.getIndex(theBinnedVariable);
   if ( m_binDescriptor.outOfRange(theIndex) )
     {
       return false;
     }
   // get key
   key_t theKey = this->getKey(theEta,theSampling);
   // find in map and generate new if not found
   store_iter_t theAllocator = m_sumStore.find(theKey);
   if ( theAllocator == m_sumStore.end() )
     {
       data_t theDataVector; 
       theDataVector.resize(m_numberOfSums,0.);
       bin_t  theBinVector;  
       theBinVector.resize(m_binDescriptor.getNumberOfBins(),
               theDataVector);
       m_sumStore[theKey] = theBinVector;
       theAllocator       = m_sumStore.find(theKey);
     }
   // sum up
   size_t theSize =
     (((*theAllocator).second)[theIndex]).size() <= theSummedVariables.size()
     ? (((*theAllocator).second)[theIndex]).size()
     : theSummedVariables.size();
   for ( unsigned int i=0; i<theSize; i++ )
     {
       (((*theAllocator).second)[theIndex])[i] += theSummedVariables[i];
     }
  
   return true;
 }

◆ add() [4/4]

bool CaloSum::add	(	const CaloSampling::CaloSample &	theSampling,
		double	theEta,
		double	theBinnedVariable,
		double	theSummedVariable
	)

virtual

Add to sums.

Parameters

theSampling	sampling indicator
theEta	eta of `CaloCell`
theBinnedVariable	binned variable
theSummedVariable	summed variable

Definition at line 246 of file CaloSum.cxx.

 {
   std::vector<double> theSums; theSums.push_back(theSummedVariable);
   return this->add(theSampling,theEta,theBinnedVariable,theSums);
 }

◆ begin()

CaloSum::const_iterator CaloSum::begin ( ) const

Store begin iterator.

Definition at line 297 of file CaloSum.cxx.

 {
   return m_sumStore.begin();
 }

◆ contains() [1/3]

bool CaloSum::contains ( const CaloSampling::CaloSample & theSampling ) const

virtual

Checks if sampling in store.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Returns true if given sampling is in store.

Parameters

theSampling sampling indicator

Definition at line 402 of file CaloSum.cxx.

 {
   bool found = false;
   store_const_iter_t firstEntry = m_sumStore.begin();
   store_const_iter_t lastEntry  = m_sumStore.end();
   while ( firstEntry != lastEntry && ! found )
     {
       found = ((*firstEntry).first).second == theSampling;
       ++firstEntry;
     } 
   return found;
 }

◆ contains() [2/3]

bool CaloSum::contains ( const CaloSum::CaloRegion & theRegion ) const

virtual

Returns sums for a given sampling, eta, and index.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

theSampling	sampling indicator
theEta	eta value
theIndex	bin index
theSums	reference to vector with running sums

Returns sums for a given sampling, eta, and binned variable

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

theSampling	sampling indicator
theEta	eta value
theBinnedVariable	binned variable
theSums	reference to vector with running sums

Checks if region in store

Returns true if given region is in store.

Parameters

theRegion region indicator

Definition at line 389 of file CaloSum.cxx.

 {
   bool found = false;
   store_const_iter_t firstEntry = m_sumStore.begin();
   store_const_iter_t lastEntry  = m_sumStore.end();
   while ( firstEntry != lastEntry && ! found )
     {
       found = ((*firstEntry).first).first == theRegion;
       ++firstEntry;
     } 
   return found;
 }

◆ contains() [3/3]

bool CaloSum::contains	(	const CaloSum::CaloRegion &	theRegion,
		const CaloSampling::CaloSample &	theSampling
	)		const

virtual

Checks if region/sampling combination is in store.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Returns true if given region/sampling combination is in store.

Parameters

theRegion	region indicator
theSampling	sampling indicator

Definition at line 415 of file CaloSum.cxx.

 {
   return 
     m_sumStore.find(CaloSum::getKey(theRegion,theSampling)) != 
     m_sumStore.end();
 }

◆ end()

CaloSum::const_iterator CaloSum::end ( ) const

Store end iterator.

Definition at line 302 of file CaloSum.cxx.

 {
   return m_sumStore.end();
 }

◆ getBinCenter()

bool CaloSum::getBinCenter	(	size_t	theIndex,
		double &	binCenter
	)		const

virtual

Returns bin center.

Returns false if configuration incorrect or index invalid.

Parameters

theIndex	bin index
binCenter	center of bin

Definition at line 202 of file CaloSum.cxx.

 {
   double lowEdge, highEdge;
   if ( this->getBinEdges(theIndex,lowEdge,highEdge) ) 
     {
       binCenter = ( highEdge + lowEdge ) / 2.;
       return true;
     }
   else
     {
       return false;
     }
 }

◆ getBinDescriptor()

const CaloBinDescriptor< double > & CaloSum::getBinDescriptor ( ) const

virtual

Returns reference to complete bin descriptor.

Definition at line 216 of file CaloSum.cxx.

 {
   return m_binDescriptor;
 }

◆ getBinEdges()

bool CaloSum::getBinEdges	(	size_t	theIndex,
		double &	lowEdge,
		double &	highEdge
	)		const

virtual

Returns bin edges for a given bin.

Returns false if configuration incorrect or index invalid.

Parameters

theIndex	bin index
lowEdge	reference to variable containing lower bin limit on return
highEdge	reference to variable containing upper bin limit on return

Definition at line 193 of file CaloSum.cxx.

 {
   lowerLimit = m_binDescriptor.lowerBinEdge(theIndex);
   upperLimit = m_binDescriptor.upperBinEdge(theIndex);
   return lowerLimit < upperLimit;
 }

◆ getKey() [1/2]

CaloSum::key_t CaloSum::getKey	(	const CaloRegion &	theRegion,
		const CaloSampling::CaloSample &	theSample
	)

staticprotected

Translate into key.

Parameters

theRegion	region indicator
theSample	sampling indicator

Definition at line 443 of file CaloSum.cxx.

 {
   return key_t(theRegion,theSampling);
 }

◆ getKey() [2/2]

CaloSum::key_t CaloSum::getKey	(	double	theEta,
		const CaloSampling::CaloSample &	theSample
	)		const

protected

Translate into key.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

theEta	eta value
theSample	sampling indicator

Definition at line 450 of file CaloSum.cxx.

 {
   CaloRegion theRegion = this->getRegion(theEta);
   return this->getKey(theRegion,theSampling);
 }

◆ getNumberOfBins()

size_t CaloSum::getNumberOfBins ( ) const

virtual

Returns number of bins.

Return value 0 means incomplete configuration.

Definition at line 173 of file CaloSum.cxx.

 {
   return m_binDescriptor.getNumberOfBins();
 }

◆ getNumberOfSums()

size_t CaloSum::getNumberOfSums ( ) const

virtual

Returns number of sums in each bin.

Return value 0 means incomplete configuration.

Definition at line 178 of file CaloSum.cxx.

 {
   //  return m_sumStore.size() > 0 
   //   ? ((m_sumStore.begin()).second).size()
   //    : 0;
   return m_numberOfSums;
 }

◆ getRange()

bool CaloSum::getRange	(	const CaloRegion &	theRegion,
		std::vector< double > &	lowEtas,
		std::vector< double > &	highEtas
	)		const

virtual

Returns eta range(s) for a given region.

The ranges are returned in vectors owned by the client. The vectors are not cleared before filling, i.e. ranges are added if vectors already contain data.

Parameters

theRegion	region on input
lowEtas	reference to vector for lower eta limits
highEtas	reference to vector for upper eta limits

Definition at line 143 of file CaloSum.cxx.

 {
   range_map_t::const_iterator fRegion = m_regionRanges.find(theRegion);
   if ( fRegion != m_regionRanges.end() )
     {
       lowEtas.resize(((*fRegion).second).size());
       highEtas.resize(((*fRegion).second).size());
       for ( unsigned int i=0; i<((*fRegion).second).size(); i++ )
     {
       lowEtas[i]  = (((*fRegion).second)[i]).first;
       highEtas[i] = (((*fRegion).second)[i]).second; 
     }
       return true;
     }
   else
     {
       return false;
     }
 }

◆ getRegion() [1/2]

CaloSum::CaloRegion CaloSum::getRegion ( const_iterator & theIterator )

static

Returns region for a given iterator.

Parameters

theIterator store iterator

Definition at line 308 of file CaloSum.cxx.

 {
   return ((*theIterator).first).first;
 }

◆ getRegion() [2/2]

CaloSum::CaloRegion CaloSum::getRegion ( double theEta ) const

virtual

Retrieve region for a given eta.

Returns UnknownRegion if eta outside of all eta ranges. Returns first region in which eta is found.

Parameters

theEta eta on input

Definition at line 124 of file CaloSum.cxx.

 {
   range_map_t::const_iterator fRegion = m_regionRanges.begin();
   bool isFound = false;
   while ( ! isFound && fRegion != m_regionRanges.end() )
     {
       range_cont_t::const_iterator fRange = ((*fRegion).second).begin();
       while ( ! isFound && fRange != ((*fRegion).second).end() )
     {
       double lowEdge  = (*fRange).first;
       double highEdge = (*fRange).second;
       isFound = ( lowEdge <= theEta && theEta < highEdge );
       ++fRange;
     }
       ++fRegion;
     }
   return isFound ? (*(--fRegion)).first : UnknownRegion ;
 }

◆ getSampling()

CaloSampling::CaloSample CaloSum::getSampling ( const_iterator & theIterator )

static

Returns sampling for a given iterator.

Parameters

theIterator store iterator

Definition at line 314 of file CaloSum.cxx.

 {
   return ((*theIterator).first).second;
 }

◆ getSums() [1/4]

bool CaloSum::getSums	(	const CaloSum::CaloRegion &	theRegion,
		const CaloSampling::CaloSample &	theSampling,
		double	theBinnedVariable,
		std::vector< double > &	theSums
	)		const

Returns sums for a given key and binned variable.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

theRegion	region indicator
theSampling	sampling indicator
theBinnedVariable	bin index
theSums	reference to vector with running sums

Definition at line 369 of file CaloSum.cxx.

 {
   return this->getSums(theRegion,
                theSampling,
                m_binDescriptor.getIndex(theBinnedVariable),
                theSums);
 }

◆ getSums() [2/4]

bool CaloSum::getSums	(	const CaloSum::CaloRegion &	theRegion,
		const CaloSampling::CaloSample &	theSampling,
		size_t	theIndex,
		std::vector< double > &	theSums
	)		const

Returns sums for a given key and index.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

theRegion	region indicator
theSampling	sampling indicator
theIndex	bin index
theSums	reference to vector with running sums

Definition at line 345 of file CaloSum.cxx.

 {
   // check basics
   if ( m_binDescriptor.outOfRange(theIndex) )
     {
       return false;
     }
   // find element
   key_t theKey = CaloSum::getKey(theRegion,theSampling);
   store_const_iter_t theAccessor = m_sumStore.find(theKey);
   if ( theAccessor != m_sumStore.end() )
     {
       theSums.resize((((*theAccessor).second)[theIndex]).size(),0.);
       std::copy((((*theAccessor).second)[theIndex]).begin(),
         (((*theAccessor).second)[theIndex]).end(),
         theSums.begin());
       return !theSums.empty();
     }
   return false;
 }

◆ getSums() [3/4]

bool CaloSum::getSums	(	const_iterator &	theIterator,
		double	theBinnedVariable,
		std::vector< double > &	theSums
	)		const

Returns sums for a given binned variable.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Parameters

theIterator	store iterator
theBinnedVariable	bin variable value
theSums	reference to vector with running sums

Definition at line 336 of file CaloSum.cxx.

 {
   return this->getSums(theIterator,
                m_binDescriptor.getIndex(theBinnedVariable),
                theSums);
 }

◆ getSums() [4/4]

bool CaloSum::getSums	(	const_iterator &	theIterator,
		size_t	theBinIndex,
		std::vector< double > &	theSums
	)		const

Returns sums for a given iterator.

Returns false if invalid iterator or index mismatch. Fills vector on successful return without clearing, i.e. sums are added as new members to the vector.

Parameters

theIterator	store iterator
theBinIndex	index of bin
theSums	reference to vector with running sums

Definition at line 319 of file CaloSum.cxx.

 {
   // check index range
   if ( m_binDescriptor.outOfRange(theIndex) )
     {
       return false;
     } 
   // check sum vector
   theSums.resize( (((*theIterator).second)[theIndex]).size(), 0. );
   std::copy( (((*theIterator).second)[theIndex]).begin(),
          (((*theIterator).second)[theIndex]).end(),
          theSums.begin());
   return !theSums.empty();
 }

◆ getVariableRange()

bool CaloSum::getVariableRange	(	double &	lowLimit,
		double &	highLimit
	)		const

virtual

Returs lower and upper limit of binned variable range.

Returns false if configuration incorrect, especially if lowLimit < highLimit.

Parameters

lowLimit	reference to variable storing lower limit on return
highLimit	reference to variable storing upper limit on return

Definition at line 186 of file CaloSum.cxx.

 {
   lowerLimit = m_binDescriptor.lowerBound();
   upperLimit = m_binDescriptor.upperBound();
   return lowerLimit < upperLimit;
 }

◆ getVarType()

CaloSum::CaloVarType CaloSum::getVarType ( ) const

virtual

Returns binned variable type.

Definition at line 119 of file CaloSum.cxx.

 {
   return m_varType;
 }

◆ setRegion() [1/2]

bool CaloSum::setRegion	(	const CaloSum::CaloRegion &	theRegion,
		const std::vector< double > &	etaLow,
		const std::vector< double > &	etaHigh
	)

virtual

Configure regions.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Assigns eta ranges to a region.

Parameters

theRegion	region indicator
etaLow	vector of lower eta limits
etaHigh	vector of upper eta limits

It is expected that both vectors have the same dimension. Otherwise ranges up to the smallest dimension will be configured.

Definition at line 94 of file CaloSum.cxx.

 {
   // check matching vectors
   if ( lowEtas.size() != highEtas.size() || lowEtas.empty() )
     {
       return false;
     }
   // check on defaults
   if ( m_defaultRanges ) 
     {
       m_regionRanges.clear();
       m_defaultRanges = false;
     }
  
   // store eta ranges
   for (unsigned int i=0; i<lowEtas.size(); i++ )
     {
       range_t theRange(lowEtas[i],highEtas[i]);
       (m_regionRanges[theRegion]).push_back(theRange);
     }
   return !m_regionRanges.empty();
 }

◆ setRegion() [2/2]

bool CaloSum::setRegion	(	const CaloSum::CaloRegion &	theRegion,
		double	etaLow,
		double	etaHigh
	)

virtual

Configure regions.

Assigns one eta range to a region. This method overwrites the default settings.

Parameters

theRegion	region indicator
etaLow	lower eta limit
etaHigh	upper eta limit

Definition at line 54 of file CaloSum.cxx.

 {
   std::vector<double> lowEtas;  lowEtas.push_back(etaLow);
   std::vector<double> highEtas; highEtas.push_back(etaHigh);
   return this->setRegion(theRegion,lowEtas,highEtas);
 }

◆ setUp()

bool CaloSum::setUp ( )

protected

Set up defaults.

Definition at line 427 of file CaloSum.cxx.

 {
   // pre-defined ranges
   range_t centralRange(-0.8,0.8);
   (m_regionRanges[Central]).push_back(centralRange);
   range_t endCapPos(0.8,2.5);
   range_t endCapNeg(-2.5,-0.8);
   (m_regionRanges[EndCap]).push_back(endCapPos);
   (m_regionRanges[EndCap]).push_back(endCapNeg);
   range_t forwardPos(2.5,5.0);
   range_t forwardNeg(-5.0,-2.5);
   (m_regionRanges[Forward]).push_back(forwardPos);
   (m_regionRanges[Forward]).push_back(forwardNeg);
   return true;
 }

Member Data Documentation

◆ m_binDescriptor

CaloBinDescriptor<double> CaloSum::m_binDescriptor

private

Bin descriptor.

Definition at line 493 of file CaloSum.h.

◆ m_defaultRanges

bool CaloSum::m_defaultRanges

private

Process flow control: indicates default range overwrite.

Definition at line 484 of file CaloSum.h.

◆ m_numberOfSums

size_t CaloSum::m_numberOfSums

private

Store size: number of sums.

Definition at line 487 of file CaloSum.h.

◆ m_regionRanges

range_map_t CaloSum::m_regionRanges

private

Store for region ranges.

Definition at line 496 of file CaloSum.h.

◆ m_sumStore

store_t CaloSum::m_sumStore

private

Store for sums.

Definition at line 499 of file CaloSum.h.

◆ m_varType

CaloVarType CaloSum::m_varType

private

Binned variable type.

Definition at line 490 of file CaloSum.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ bin_const_iter_t

◆ bin_iter_t

◆ bin_t

◆ const_iterator

◆ data_const_iter_t

◆ data_iter_t

◆ data_t

◆ key_t

◆ range_cont_t

◆ range_map_t

◆ range_t

◆ store_const_iter_t

◆ store_iter_t

◆ store_t

Member Enumeration Documentation

◆ CaloRegion

◆ CaloVarType

Constructor & Destructor Documentation

◆ CaloSum() [1/2]

◆ CaloSum() [2/2]

◆ ~CaloSum()

Member Function Documentation

◆ add() [1/4]

◆ add() [2/4]

◆ add() [3/4]

◆ add() [4/4]

◆ begin()

◆ contains() [1/3]

◆ contains() [2/3]

◆ contains() [3/3]

◆ end()

◆ getBinCenter()

◆ getBinDescriptor()

◆ getBinEdges()

◆ getKey() [1/2]

◆ getKey() [2/2]

◆ getNumberOfBins()

◆ getNumberOfSums()

◆ getRange()

◆ getRegion() [1/2]

◆ getRegion() [2/2]

◆ getSampling()

◆ getSums() [1/4]

◆ getSums() [2/4]

◆ getSums() [3/4]

◆ getSums() [4/4]

◆ getVariableRange()

◆ getVarType()

◆ setRegion() [1/2]

◆ setRegion() [2/2]

◆ setUp()

Member Data Documentation

◆ m_binDescriptor

◆ m_defaultRanges

◆ m_numberOfSums

◆ m_regionRanges

◆ m_sumStore

◆ m_varType