Hold binned EM fraction data. More...

#include <CaloEMFrac.h>

Collaboration diagram for CaloEMFrac:

Classes
struct	EMFracData
	Per-bin data. More...

Public Member Functions
	CaloEMFrac ()
	Default Constructor.
	CaloEMFrac (int nBinEta, float MinEta, float MaxEta, int nBinLogEClus, float MinLogEClus, float MaxLogEClus, int nBinLogEDens, float MinLogEDens, float MaxLogEDens, int nBinLogDepth, float MinLogDepth, float MaxLogDepth)
	Constructor.
int	getNbinsEta () const
	Return the number of bins in eta.
float	getEtaMin () const
	Return the minimum eta for the first bin.
float	getEtaMax () const
	Return the maximum eta for the last bin.
int	getNbinsLogEClus () const
	Return the number of bins in log10(cluster energy).
float	getLogEClusMin () const
	Return the minimum log10(cluster energy) for the first bin.
float	getLogEClusMax () const
	Return the maximum log10(cluster energy) for the last bin.
int	getNbinsLogEDens () const
	Return the number of bins in log10(cluster energy density).
float	getLogEDensMin () const
	Return the minimum log10(cluster energy density) for the first bin.
float	getLogEDensMax () const
	Return the maximum log10(cluster energy density) for the last bin.
int	getNbinsLogDepth () const
	Return the number of bins in log10(cluster depth).
float	getLogDepthMin () const
	Return the minimum log10(cluster depth) for the first bin.
float	getLogDepthMax () const
	Return the maximum log10(cluster depth) for the last bin.
const struct EMFracData *	getEMFracData (float eta, float logEClus, float logEDens, float logDepth) const
	Return EM fraction data for one bin.
void	setEMFracData (float eta, float logEClus, float logEDens, float logDepth, const struct EMFracData &theData)
	Set EM fraction data for one bin.

Private Member Functions
int	getEtaLogEClusBin (float eta, float logEClus) const
	Find the eta/logEClus bin number.
int	getBin (float eta, float logEClus, float logEDens, float logDepth) const
	Find a bin number.

Private Attributes
int	m_nBinEta
	Number of eta bins.
int	m_nBinLogEClus
	Number of log10(cluster energy) bins.
int	m_nBinLogEDens
	Number of log10(cluster energy density) bins.
int	m_nBinLogDepth
	Number of log10(cluster depth) bins.
float	m_MinEta
	Minimum eta for the first bin.
float	m_MinLogEClus
	Minimum log10(cluster energy) for the first bin.
float	m_MinLogEDens
	Minimum log10(cluster energy density) for the first bin.
float	m_MinLogDepth
	Minimum log10(cluster depth) for the first bin.
float	m_MaxEta
	Maximum eta for the last bin.
float	m_MaxLogEClus
	Maximum log10(cluster energy) for the last bin.
float	m_MaxLogEDens
	Maximum log10(cluster energy density) for the last bin.
float	m_MaxLogDepth
	Maximum log10(cluster depth) for the last bin.
std::vector< struct EMFracData >	m_data
	The table.

Detailed Description

Hold binned EM fraction data.

This class holds data on the average EM fraction of EM clusters. These data are binned along four axes:

The (absolute value of the) cluster eta.
The (log10 of the) cluster energy.
The (log10 of the) cluster energy density. (In later versions, this is normalized by the cluster energy.)
The (log10 of the) cluster depth.

In each bin, we store the mean EM fraction in the bin, plus information about distribution width and number of entries.

Definition at line 35 of file CaloEMFrac.h.

Constructor & Destructor Documentation

◆ CaloEMFrac() [1/2]

CaloEMFrac::CaloEMFrac ( )

Default Constructor.

(Only intended for use by persistency.)

Definition at line 18 of file CaloEMFrac.cxx.

  : m_nBinEta(0),
    m_nBinLogEClus(0),
    m_nBinLogEDens(0),
    m_nBinLogDepth(0),
    m_MinEta(0),
    m_MinLogEClus(0),
    m_MinLogEDens(0),
    m_MinLogDepth(0),
    m_MaxEta(0),
    m_MaxLogEClus(0),
    m_MaxLogEDens(0),
    m_MaxLogDepth(0)
{
}

◆ CaloEMFrac() [2/2]

CaloEMFrac::CaloEMFrac	(	int	nBinEta,
		float	MinEta,
		float	MaxEta,
		int	nBinLogEClus,
		float	MinLogEClus,
		float	MaxLogEClus,
		int	nBinLogEDens,
		float	MinLogEDens,
		float	MaxLogEDens,
		int	nBinLogDepth,
		float	MinLogDepth,
		float	MaxLogDepth )

Constructor.

Parameters

nBinEta	Number of bins in eta.
MinEta	Minimum eta for the first bin.
MaxEta	Maximum eta for the last bin.
nBinLogEClus	Number of bins in log10(cluster energy).
MinLogEClus	Minimum log10(cluster energy) for the first bin.
MaxLogEClus	Maximum log10(cluster energy) for the last bin.
nBinLogEDens	Number of bins in log10(cluster energy density).
MinLogEDens	Minimum log10(cluster energy density) for the first bin.
MaxLogEDens	Maximum log10(cluster energy density) for the last bin.
nBinLogDepth	Number of bins in log10(cluster depth).
MinLogDepth	Minimum log10(cluster depth) for the first bin.
MaxLogDepth	Maximum log10(cluster depth) for the last bin.

Definition at line 50 of file CaloEMFrac.cxx.

              : m_nBinEta          (nBinEta),      
                m_nBinLogEClus  (nBinLogEClus),    
                m_nBinLogEDens  (nBinLogEDens),
                m_nBinLogDepth  (nBinLogDepth),
                m_MinEta        (MinEta),       
                m_MinLogEClus   (MinLogEClus),     
                m_MinLogEDens   (MinLogEDens), 
                m_MinLogDepth   (MinLogDepth), 
                m_MaxEta        (MaxEta),       
                m_MaxLogEClus   (MaxLogEClus),     
                m_MaxLogEDens   (MaxLogEDens), 
                m_MaxLogDepth   (MaxLogDepth) 
{
} 

Member Function Documentation

◆ getBin()

int CaloEMFrac::getBin	(	float	eta,
		float	logEClus,
		float	logEDens,
		float	logDepth ) const

private

Find a bin number.

Parameters

eta	Cluster eta.
logEClus	log10(cluster energy)
logEDens	log10(cluster energy density) (possibly normalized)
logDepth	log10(cluster depth)

Returns: The bin number, or -1 if out of range.

Definition at line 164 of file CaloEMFrac.cxx.

{
  int iLogEDens,iLogDepth;
 
  const int iEtaLogEClus = getEtaLogEClusBin(eta, logEClus);
  if ( iEtaLogEClus > -1 ) {
    iLogEDens = (int)((logEDens-m_MinLogEDens)/(m_MaxLogEDens-m_MinLogEDens)*m_nBinLogEDens);
    if ( iLogEDens >= 0 && iLogEDens < m_nBinLogEDens ) {
      iLogDepth = (int)((logDepth-m_MinLogDepth)/(m_MaxLogDepth-m_MinLogDepth)*m_nBinLogDepth);
      if ( iLogDepth >= 0 && iLogDepth < m_nBinLogDepth ) {
    return (iLogDepth + m_nBinLogDepth * 
        (iLogEDens + m_nBinLogEDens * 
         iEtaLogEClus));
      }
    }
  }
  return -1;
}

◆ getEMFracData()

const struct CaloEMFrac::EMFracData * CaloEMFrac::getEMFracData	(	float	eta,
		float	logEClus,
		float	logEDens,
		float	logDepth ) const

Return EM fraction data for one bin.

Parameters

eta	Cluster eta.
logEClus	log10(cluster energy)
logEDens	log10(cluster energy density) (possibly normalized)
logDepth	log10(cluster depth)

Returns: Pointer to the bin data, or 0 if out of range.

The pointer may be invalidated by a subsequent setEMFracData call.

Definition at line 90 of file CaloEMFrac.cxx.

{
  int iBin = getBin(eta,logEClus,logEDens,logDepth);
  if ( iBin > -1 && iBin < (int)m_data.size() ) 
    return (& m_data[iBin]);
  else
    return nullptr;
}

◆ getEtaLogEClusBin()

int CaloEMFrac::getEtaLogEClusBin	(	float	eta,
		float	logEClus ) const

private

Find the eta/logEClus bin number.

Parameters

eta	Cluster eta.
logEClus	log10(cluster energy)

Returns: Bin number in the eta/logEClus subspace, or -1 if out of range.

Definition at line 140 of file CaloEMFrac.cxx.

{
  int iEta,iLogEClus;
 
  iEta = (int)((eta-m_MinEta)/(m_MaxEta-m_MinEta)*m_nBinEta);
  if ( iEta >= 0 && iEta < m_nBinEta ) {
    iLogEClus = (int)((logEClus-m_MinLogEClus)/(m_MaxLogEClus-m_MinLogEClus)*m_nBinLogEClus);
    if ( iLogEClus >= 0 && iLogEClus < m_nBinLogEClus ) {
      return (iEta*m_nBinLogEClus+iLogEClus);
    }
  }
  return (-1);
 
}

◆ getEtaMax()

float CaloEMFrac::getEtaMax ( ) const

inline

Return the maximum eta for the last bin.

Definition at line 100 of file CaloEMFrac.h.

100{return m_MaxEta;}

◆ getEtaMin()

float CaloEMFrac::getEtaMin ( ) const

inline

Return the minimum eta for the first bin.

Definition at line 98 of file CaloEMFrac.h.

98{return m_MinEta;}

◆ getLogDepthMax()

float CaloEMFrac::getLogDepthMax ( ) const

inline

Return the maximum log10(cluster depth) for the last bin.

Definition at line 121 of file CaloEMFrac.h.

121{return m_MaxLogDepth;}

◆ getLogDepthMin()

float CaloEMFrac::getLogDepthMin ( ) const

inline

Return the minimum log10(cluster depth) for the first bin.

Definition at line 119 of file CaloEMFrac.h.

119{return m_MinLogDepth;}

◆ getLogEClusMax()

float CaloEMFrac::getLogEClusMax ( ) const

inline

Return the maximum log10(cluster energy) for the last bin.

Definition at line 107 of file CaloEMFrac.h.

107{return m_MaxLogEClus;}

◆ getLogEClusMin()

float CaloEMFrac::getLogEClusMin ( ) const

inline

Return the minimum log10(cluster energy) for the first bin.

Definition at line 105 of file CaloEMFrac.h.

105{return m_MinLogEClus;}

◆ getLogEDensMax()

float CaloEMFrac::getLogEDensMax ( ) const

inline

Return the maximum log10(cluster energy density) for the last bin.

Definition at line 114 of file CaloEMFrac.h.

114{return m_MaxLogEDens;}

◆ getLogEDensMin()

float CaloEMFrac::getLogEDensMin ( ) const

inline

Return the minimum log10(cluster energy density) for the first bin.

Definition at line 112 of file CaloEMFrac.h.

112{return m_MinLogEDens;}

◆ getNbinsEta()

int CaloEMFrac::getNbinsEta ( ) const

inline

Return the number of bins in eta.

Definition at line 96 of file CaloEMFrac.h.

96{return m_nBinEta;}

◆ getNbinsLogDepth()

int CaloEMFrac::getNbinsLogDepth ( ) const

inline

Return the number of bins in log10(cluster depth).

Definition at line 117 of file CaloEMFrac.h.

117{return m_nBinLogDepth;}

◆ getNbinsLogEClus()

int CaloEMFrac::getNbinsLogEClus ( ) const

inline

Return the number of bins in log10(cluster energy).

Definition at line 103 of file CaloEMFrac.h.

103{return m_nBinLogEClus;}

◆ getNbinsLogEDens()

int CaloEMFrac::getNbinsLogEDens ( ) const

inline

Return the number of bins in log10(cluster energy density).

Definition at line 110 of file CaloEMFrac.h.

110{return m_nBinLogEDens;}

◆ setEMFracData()

void CaloEMFrac::setEMFracData	(	float	eta,
		float	logEClus,
		float	logEDens,
		float	logDepth,
		const struct EMFracData &	theData )

Set EM fraction data for one bin.

Parameters

eta	Cluster eta.
logEClus	log10(cluster energy)
logEDens	log10(cluster energy density) (possibly normalized)
logDepth	log10(cluster depth)
theData	The bin data.

This will overwrite any earlier data for the same bin. If the coordinates are out of range, this is a no-op.

Definition at line 115 of file CaloEMFrac.cxx.

{
  const int iEtaLogEClus = getEtaLogEClusBin(eta, logEClus);
  if ( iEtaLogEClus > -1 ) {
    const int iFilledEntries = m_data.size()/(m_nBinLogEDens*m_nBinLogDepth);
    if ( iEtaLogEClus >= iFilledEntries ) 
      m_data.resize((iFilledEntries+1)*(m_nBinLogEDens*m_nBinLogDepth));
    const int iBin = getBin(eta,logEClus,logEDens,logDepth);
    if ( iBin > -1 ) {
      m_data[iBin] = theData;
    }
  }
}

Member Data Documentation

◆ m_data

std::vector<struct EMFracData> CaloEMFrac::m_data

private

The table.

Binned in the following order, least-rapidly varying first: eta, logEClus, logEDens, logDepth.

Definition at line 190 of file CaloEMFrac.h.

◆ m_MaxEta

float CaloEMFrac::m_MaxEta

private

Maximum eta for the last bin.

Definition at line 179 of file CaloEMFrac.h.

◆ m_MaxLogDepth

float CaloEMFrac::m_MaxLogDepth

private

Maximum log10(cluster depth) for the last bin.

Definition at line 185 of file CaloEMFrac.h.

◆ m_MaxLogEClus

float CaloEMFrac::m_MaxLogEClus

private

Maximum log10(cluster energy) for the last bin.

Definition at line 181 of file CaloEMFrac.h.

◆ m_MaxLogEDens

float CaloEMFrac::m_MaxLogEDens

private

Maximum log10(cluster energy density) for the last bin.

Definition at line 183 of file CaloEMFrac.h.

◆ m_MinEta

float CaloEMFrac::m_MinEta

private

Minimum eta for the first bin.

Definition at line 170 of file CaloEMFrac.h.

◆ m_MinLogDepth

float CaloEMFrac::m_MinLogDepth

private

Minimum log10(cluster depth) for the first bin.

Definition at line 176 of file CaloEMFrac.h.

◆ m_MinLogEClus

float CaloEMFrac::m_MinLogEClus

private

Minimum log10(cluster energy) for the first bin.

Definition at line 172 of file CaloEMFrac.h.

◆ m_MinLogEDens

float CaloEMFrac::m_MinLogEDens

private

Minimum log10(cluster energy density) for the first bin.

Definition at line 174 of file CaloEMFrac.h.

◆ m_nBinEta

int CaloEMFrac::m_nBinEta

private

Number of eta bins.

Definition at line 161 of file CaloEMFrac.h.

◆ m_nBinLogDepth

int CaloEMFrac::m_nBinLogDepth

private

Number of log10(cluster depth) bins.

Definition at line 167 of file CaloEMFrac.h.

◆ m_nBinLogEClus

int CaloEMFrac::m_nBinLogEClus

private

Number of log10(cluster energy) bins.

Definition at line 163 of file CaloEMFrac.h.

◆ m_nBinLogEDens

int CaloEMFrac::m_nBinLogEDens

private

Number of log10(cluster energy density) bins.

Definition at line 165 of file CaloEMFrac.h.

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CaloEMFrac() [1/2]

◆ CaloEMFrac() [2/2]

Member Function Documentation

◆ getBin()

◆ getEMFracData()

◆ getEtaLogEClusBin()

◆ getEtaMax()

◆ getEtaMin()

◆ getLogDepthMax()

◆ getLogDepthMin()

◆ getLogEClusMax()

◆ getLogEClusMin()

◆ getLogEDensMax()

◆ getLogEDensMin()

◆ getNbinsEta()

◆ getNbinsLogDepth()

◆ getNbinsLogEClus()

◆ getNbinsLogEDens()

◆ setEMFracData()

Member Data Documentation

◆ m_data

◆ m_MaxEta

◆ m_MaxLogDepth

◆ m_MaxLogEClus

◆ m_MaxLogEDens

◆ m_MinEta

◆ m_MinLogDepth

◆ m_MinLogEClus

◆ m_MinLogEDens

◆ m_nBinEta

◆ m_nBinLogDepth

◆ m_nBinLogEClus

◆ m_nBinLogEDens