CaloNoise Class Reference

#include <CaloNoise.h>

Collaboration diagram for CaloNoise:

Public Types
enum	NOISETYPE { ELEC =0 , PILEUP , TOTAL }
	Conditions Data Object holding the calorimeter noise per cell and per gain. More...

Public Member Functions
	CaloNoise ()=delete
	~CaloNoise ()
	CaloNoise (const size_t nLArCells, const size_t nLArGains, const size_t nTileCells, const size_t nTileGains, const CaloCell_Base_ID *caloCellId, const NOISETYPE noisetype)
	Explicit constructor with number of cells and gains and ptr to CaloCell_ID obj.
float	getNoise (const IdentifierHash h, const int gain) const
	Accessor by IdentifierHash and gain.
float	getNoise (const Identifier id, const int gain) const
	Accessor by Identifier and gain.
float	getNoise (const HWIdentifier, const int) const =delete
	Safety net: Disallow access by HWIdentifier.
float	getEffectiveSigma (const Identifier id, const int gain, const float energy) const
float	getEffectiveSigma (const IdentifierHash h, const int gain, const float energy) const
boost::multi_array< float, 2 > &	larStorage ()
	Non-const accessor to underlying storage for filling:
boost::multi_array< float, 2 > &	tileStorage ()
const boost::multi_array< float, 2 > &	larStorage () const
	Const accessor to underlying storage for GPU data structures.
const boost::multi_array< float, 2 > &	tileStorage () const
void	setTileBlob (const CaloCondBlobFlt *flt, const float lumi)
const CaloCondBlobFlt *	getTileBlob () const
float	getLumi () const
NOISETYPE	getNoiseType () const

Private Member Functions
float	calcSig (const IdentifierHash tilehash, const int gain, const float energy) const
float	getTileEffSigma (const IdentifierHash subHash, const int gain, const float e) const

Private Attributes
const CaloCell_Base_ID *	m_caloCellId
boost::multi_array< float, 2 >	m_larNoise
boost::multi_array< float, 2 >	m_tileNoise
unsigned	m_tileHashOffset
const CaloCondBlobFlt *	m_tileBlob =nullptr
float	m_lumi =0
NOISETYPE	m_noiseType =TOTAL

Detailed Description

Definition at line 16 of file CaloNoise.h.

Member Enumeration Documentation

NOISETYPE

enum CaloNoise::NOISETYPE

Conditions Data Object holding the calorimeter noise per cell and per gain.

Enumerator
ELEC
PILEUP
TOTAL

Definition at line 21 of file CaloNoise.h.

                {ELEC=0,
         PILEUP,
         TOTAL};

Constructor & Destructor Documentation

CaloNoise() [1/2]

CaloNoise::CaloNoise ( )

delete

~CaloNoise()

CaloNoise::~CaloNoise

(

)

Definition at line 36 of file CaloNoise.cxx.

                      {
  if ( m_tileBlob) delete m_tileBlob;
}

CaloNoise() [2/2]

CaloNoise::CaloNoise	(	const size_t	nLArCells,
		const size_t	nLArGains,
		const size_t	nTileCells,
		const size_t	nTileGains,
		const CaloCell_Base_ID *	caloCellId,
		const NOISETYPE	noisetype )

Explicit constructor with number of cells and gains and ptr to CaloCell_ID obj.

Definition at line 11 of file CaloNoise.cxx.

  : m_caloCellId(caloCellId)
  , m_noiseType(noisetype)
{
 
  boost::multi_array_types::extent_gen lar_extent_gen;
  m_larNoise.resize(lar_extent_gen[nLArGains][nLArCells]);
  boost::multi_array_types::extent_gen tile_extent_gen;
  m_tileNoise.resize(tile_extent_gen[nTileGains][nTileCells]);
 
  IdentifierHash h1,h2;
  m_caloCellId->calo_cell_hash_range(CaloCell_ID::TILE, h1,h2);
  m_tileHashOffset=h1;
}

Member Function Documentation

calcSig()

float CaloNoise::calcSig ( const IdentifierHash tilehash, const int gain, const float energy ) const

private

Definition at line 42 of file CaloNoise.cxx.

                                                                                            {
 
  const double sigma1 = m_tileBlob->getData(subHash,dbGain,2);
  const double sigma2 = m_tileBlob->getData(subHash,dbGain,3);
  const double ratio  = m_tileBlob->getData(subHash,dbGain,4);
 
 
  if((sigma1 == 0. && sigma2 == 0.) || e == 0.) return 0.;
  if(sigma1 == 0.) return e/sigma2;
  if((ratio  == 0.) || sigma2 == 0.) return e/sigma1;
  const double x1 = e/sigma1;
  const double x2 = e/sigma2;
 
  constexpr std::array<float,2> valid_range{0.9,7.5};
  const float wide_gauss_sigma = std::min(std::abs(x1),std::abs(x2));
  if(wide_gauss_sigma > valid_range[1]) return wide_gauss_sigma;
 
  const float narrow_gauss_sigma= std::max(std::abs(x1),std::abs(x2));
  if(narrow_gauss_sigma < valid_range[0]) return narrow_gauss_sigma;
 
 
  const double y1= TMath::Erf(M_SQRT1_2*x1);
  const double y2= TMath::Erf(M_SQRT1_2*x2);
 
  const double z = ( y1*sigma1 + ratio*y2*sigma2 )/( sigma1 + ratio*sigma2);
 
  //return the C.L. probability (with sign!)
  //  return z;
 
  // if instead you want to return the sigma-equivalent C.L.
  // (with sign!) use the following line
  return M_SQRT2*TMath::ErfInverse(z);
}

getEffectiveSigma() [1/2]

float CaloNoise::getEffectiveSigma ( const Identifier id, const int gain, const float energy ) const

inline

Definition at line 55 of file CaloNoise.h.

                                                                                         {
    IdentifierHash h=m_caloCellId->calo_cell_hash(id);
    return getEffectiveSigma(h,gain,energy);
  }

getEffectiveSigma() [2/2]

float CaloNoise::getEffectiveSigma ( const IdentifierHash h, const int gain, const float energy ) const

inline

Definition at line 61 of file CaloNoise.h.

                                                                                            {
    if (h<m_tileHashOffset) {
      return m_larNoise[gain][h];
    }
    else {
      return getTileEffSigma(h-m_tileHashOffset,gain,energy);
    }
  }

getLumi()

float CaloNoise::getLumi ( ) const

inline

Definition at line 85 of file CaloNoise.h.

{ return m_lumi; }

getNoise() [1/3]

float CaloNoise::getNoise ( const HWIdentifier , const int  ) const

delete

Safety net: Disallow access by HWIdentifier.

getNoise() [2/3]

float CaloNoise::getNoise ( const Identifier id, const int gain ) const

inline

Accessor by Identifier and gain.

Definition at line 45 of file CaloNoise.h.

                                                            {
    IdentifierHash h=m_caloCellId->calo_cell_hash(id);
    return getNoise(h,gain);
  }

getNoise() [3/3]

float CaloNoise::getNoise ( const IdentifierHash h, const int gain ) const

inline

Accessor by IdentifierHash and gain.

Definition at line 34 of file CaloNoise.h.

                                                               {
    if (h<m_tileHashOffset) {
      return m_larNoise[gain][h];
    }
    else {
      const unsigned int dbGain = CaloCondUtils::getDbCaloGain(gain);
      return m_tileNoise[dbGain][h-m_tileHashOffset];
    }
  }

getNoiseType()

NOISETYPE CaloNoise::getNoiseType ( ) const

inline

Definition at line 87 of file CaloNoise.h.

{ return m_noiseType; }

getTileBlob()

const CaloCondBlobFlt * CaloNoise::getTileBlob ( ) const

inline

Definition at line 83 of file CaloNoise.h.

{ return m_tileBlob; }

getTileEffSigma()

float CaloNoise::getTileEffSigma ( const IdentifierHash subHash, const int gain, const float e ) const

private

Definition at line 77 of file CaloNoise.cxx.

                                                                                                  {
  // Tell clang to optimize assuming that FP exceptions can trap.
  // Otherwise, it can vectorize the division, which can lead to
  // spurious division-by-zero traps from unused vector lanes.
  CXXUTILS_TRAPPING_FP;
 
  const unsigned int dbGain = CaloCondUtils::getDbCaloGain(gain);
  if (!m_tileBlob) {
    //No data (pilup-noise only): return cached noise
    return m_tileNoise[dbGain][subHash];
  }
 
  const float sigma=calcSig(subHash,dbGain,e);
  const float a= (sigma != 0.) ? std::abs(e/sigma) : 0.0;
 
  if (m_noiseType==CaloNoise::ELEC) {
    return a;
  }
 
  //Case: Total Noise
  const float b= m_tileBlob->getData(subHash,dbGain,1);
  const int objver = m_tileBlob->getObjVersion();
  float x=0;
  if(objver==1){
    //=== Total noise parameterized as
    //=== Sigma**2 = a**2 + b**2 * Lumi
    x = std::sqrt( a*a + b*b*m_lumi );
  }
  else if (objver==2) {
    //== parameterization for pedestal = a + b*Lumi
    x = a+b*m_lumi;
  }
  else{
    throw CaloCond::VersionConflict("CaloNoise::get2dEffSigma ",objver);
  }
  return x;
}

larStorage() [1/2]

boost::multi_array< float, 2 > & CaloNoise::larStorage ( )

inline

Non-const accessor to underlying storage for filling:

Definition at line 71 of file CaloNoise.h.

{return m_larNoise;}

larStorage() [2/2]

const boost::multi_array< float, 2 > & CaloNoise::larStorage ( ) const

inline

Const accessor to underlying storage for GPU data structures.

Definition at line 75 of file CaloNoise.h.

{return m_larNoise;}

setTileBlob()

void CaloNoise::setTileBlob	(	const CaloCondBlobFlt *	flt,
		const float	lumi )

Definition at line 31 of file CaloNoise.cxx.

                                                                        {
  m_tileBlob=flt;
  m_lumi=lumi;
}

tileStorage() [1/2]

boost::multi_array< float, 2 > & CaloNoise::tileStorage ( )

inline

Definition at line 72 of file CaloNoise.h.

{return m_tileNoise;}

tileStorage() [2/2]

const boost::multi_array< float, 2 > & CaloNoise::tileStorage ( ) const

inline

Definition at line 76 of file CaloNoise.h.

{return m_tileNoise;}

Member Data Documentation

m_caloCellId

const CaloCell_Base_ID* CaloNoise::m_caloCellId

private

Definition at line 93 of file CaloNoise.h.

m_larNoise

boost::multi_array<float, 2> CaloNoise::m_larNoise

private

Definition at line 96 of file CaloNoise.h.

m_lumi

float CaloNoise::m_lumi =0

private

Definition at line 103 of file CaloNoise.h.

m_noiseType

NOISETYPE CaloNoise::m_noiseType =TOTAL

private

Definition at line 104 of file CaloNoise.h.

m_tileBlob

const CaloCondBlobFlt* CaloNoise::m_tileBlob =nullptr

private

Definition at line 102 of file CaloNoise.h.

m_tileHashOffset

unsigned CaloNoise::m_tileHashOffset

private

Definition at line 98 of file CaloNoise.h.

m_tileNoise

boost::multi_array<float, 2> CaloNoise::m_tileNoise

private

Definition at line 97 of file CaloNoise.h.

---

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

• CaloNoise.h
• CaloNoise.cxx