Helper class for calculating the energy interpolation table. More...

Inheritance diagram for CaloSwEtaoff_v3::Builder:

Collaboration diagram for CaloSwEtaoff_v3::Builder:

Public Member Functions
	Builder (const CxxUtils::Array< 4 > &correction, const CxxUtils::Array< 2 > &regions, const CxxUtils::Array< 2 > &forms, float aeta, float u, int region_ndx)
	Constructor. More...

virtual float	calculate (int energy_ndx, bool &good) const
	Calculate the correction for tabulated energy ENERGY_NDX. More...

Static Private Member Functions
static float	calc0 (float aeta, float u, const CaloRec::Array< 2 > &coef)
	Evaluate the function Form 0. More...

static float	calc3 (float aeta, float u, const CaloRec::Array< 2 > &coef)
	Evaluate the function Form 3. More...

static float	calc4 (float aeta, float u, const CaloRec::Array< 2 > &coef)
	Evaluate the function Form 4. More...

static float	calc5 (float aeta, float u, const CaloRec::Array< 2 > &coef)
	Evaluate the function Form 5. More...

static float	calc10 (float aeta, float u, const CaloRec::Array< 2 > &coef)
	Evaluate the function Form 10. More...

static float	calc11 (float aeta, float u, const CaloRec::Array< 2 > &coef)
	Evaluate the function Form 11. More...

static float	calc13 (float aeta, float u, const CaloRec::Array< 2 > &coef, float xlo, float xhi)
	Evaluate the function Form 13. More...

Private Attributes
const CxxUtils::Array< 4 > &	m_correction

const CxxUtils::Array< 2 > &	m_regions
	Table of regions. More...

const CxxUtils::Array< 2 > &	m_forms
	Functional form per region. More...

int	m_region_ndx
	The index of the region in which we're evaluating the correction. More...

float	m_aeta
	The abs(eta) at which the correction is being evaluated (in cal-local coordinates). More...

float	m_u
	The fractional offset in the cell of this cluster. More...

int	m_form
	The index of the functional form we're evaluating. More...

Detailed Description

Helper class for calculating the energy interpolation table.

Definition at line 172 of file CaloSwEtaoff_v3.h.

Constructor & Destructor Documentation

◆ Builder()

CaloSwEtaoff_v3::Builder::Builder	(	const CxxUtils::Array< 4 > &	correction,
		const CxxUtils::Array< 2 > &	regions,
		const CxxUtils::Array< 2 > &	forms,
		float	aeta,
		float	u,
		int	region_ndx
	)

Constructor.

Constructor for energy interpolation table helper class.

Gets correction information, the abs(eta) at which the correction is being evaluated (in cal-local coordinates), the fractional cell offset u, and the index of the region for this correction.

Parameters

correction	Tabulated arrays of function parameters.
regions	Table of regions.
forms	Functional form per region.
aeta	The absolute value of \(\eta\) at which the correction is being evaluated (in cal-local coordinates).
u	The fractional offset of the cluster within the cell.
region_ndx	The index of the region within which the correction is being evaluated.

Definition at line 129 of file CaloSwEtaoff_v3.cxx.

   : m_correction (correction),
     m_regions (regions),
     m_forms (forms),
     m_region_ndx (region_ndx),
     m_aeta (aeta),
     m_u (u),
     m_form (regions[region_ndx][REG_FORM])
 {
 }

Member Function Documentation

◆ calc0()

float CaloSwEtaoff_v3::Builder::calc0	(	float	aeta,
		float	u,
		const CaloRec::Array< 2 > &	coef
	)

staticprivate

Evaluate the function Form 0.

Evaluate the correction function for Form 0.

Parameters

aeta	The \(\|\eta\|\) of the cluster being corrected.
u	The fractional offset of the cluster within the cell.
coef	Array of polynomial coefficients for each parameter.

Definition at line 268 of file CaloSwEtaoff_v3.cxx.

 {
   const unsigned int NPAR = 5;
   double pars[NPAR];
   poly_eval (aeta, coef, NPAR, pars);
   double c = (u>=0) ? pars[2] : pars[3];
   return pars[0] * (std::atan (pars[1] * u) + c*u + pars[4]);
 }

◆ calc10()

float CaloSwEtaoff_v3::Builder::calc10	(	float	aeta,
		float	u,
		const CaloRec::Array< 2 > &	coef
	)

staticprivate

Evaluate the function Form 10.

Evaluate the correction function for Form 10.

Parameters

aeta	The \(\|\eta\|\) of the cluster being corrected.
u	The fractional offset of the cluster within the cell.
coef	Array of polynomial coefficients for each parameter.

Definition at line 345 of file CaloSwEtaoff_v3.cxx.

 {
   const unsigned int NPAR = 7;
   double pars[NPAR];
   poly_eval (aeta, coef, NPAR, pars);
   double c = pars[2];
   if (u < 0)
     c = -c - 2*std::atan(pars[1]);
  
   double offs = pars[0] * (atan (pars[1] * u) + c*u + pars[3]) +
     pars[4] * std::cos (u * pars[5] * M_PI + pars[6]);
   if (u > 0.9 || u < -0.9) {
     double xdiff = pars[4] * (std::cos (pars[5] * M_PI + pars[6]) -
                               std::cos (- pars[5] * M_PI + pars[6]));
     if (u > 0.9)
       offs -= (u-0.9)*(1./0.1) * xdiff/2;
     else
       offs += (-0.9-u)*(1./0.1) * xdiff/2;
   }
   return offs;
 }

◆ calc11()

float CaloSwEtaoff_v3::Builder::calc11	(	float	aeta,
		float	u,
		const CaloRec::Array< 2 > &	coef
	)

staticprivate

Evaluate the function Form 11.

Evaluate the correction function for Form 11.

Parameters

aeta	The \(\|\eta\|\) of the cluster being corrected.
u	The fractional offset of the cluster within the cell.
coef	Array of polynomial coefficients for each parameter.

Definition at line 376 of file CaloSwEtaoff_v3.cxx.

 {
   const unsigned int NPAR = 8;
   double pars[NPAR];
   poly_eval (aeta, coef, NPAR, pars);
   double c = (u>=0) ? pars[2] : pars[3];
   return pars[0] * (std::atan (pars[1] * u) + c*u + pars[4])
     + pars[5] * std::cos (u * pars[6] * M_PI + pars[7]);
 }

◆ calc13()

float CaloSwEtaoff_v3::Builder::calc13	(	float	aeta,
		float	u,
		const CaloRec::Array< 2 > &	coef,
		float	xlo,
		float	xhi
	)

staticprivate

Evaluate the function Form 13.

Evaluate the correction function for Form 5.

Parameters

aeta	The \(\|\eta\|\) of the cluster being corrected.
u	The fractional offset of the cluster within the cell.
coef	Array of polynomial coefficients for each parameter.

Definition at line 395 of file CaloSwEtaoff_v3.cxx.

 {
   const unsigned int NPAR = 1;
   double pars[NPAR];
   float x = (aeta - xlo) / (xhi - xlo) ;
   poly_eval (x, coef, NPAR, pars);
   return pars[0];
 }

◆ calc3()

float CaloSwEtaoff_v3::Builder::calc3	(	float	aeta,
		float	u,
		const CaloRec::Array< 2 > &	coef
	)

staticprivate

Evaluate the function Form 3.

Evaluate the correction function for Form 3.

Parameters

aeta	The \(\|\eta\|\) of the cluster being corrected.
u	The fractional offset of the cluster within the cell.
coef	Array of polynomial coefficients for each parameter.

Definition at line 286 of file CaloSwEtaoff_v3.cxx.

 {
   const unsigned int NPAR = 4;
   double pars[NPAR];
   poly_eval (aeta, coef, NPAR, pars);
   double c = pars[2];
   if (u < 0)
     c = -c - 2*std::atan(pars[1]);
   return pars[0] * (std::atan (pars[1] * u) + c*u + pars[3]);
 }

◆ calc4()

float CaloSwEtaoff_v3::Builder::calc4	(	float	aeta,
		float	u,
		const CaloRec::Array< 2 > &	coef
	)

staticprivate

Evaluate the function Form 4.

Evaluate the correction function for Form 4.

Parameters

aeta	The \(\|\eta\|\) of the cluster being corrected.
u	The fractional offset of the cluster within the cell.
coef	Array of polynomial coefficients for each parameter.

Definition at line 306 of file CaloSwEtaoff_v3.cxx.

 {
   const unsigned int NPAR = 3;
   double pars[NPAR];
   poly_eval (aeta, coef, NPAR, pars);
   double b = std::max ((double)pars[1], 1e-5);
   double atanb = std::atan(b);
   double sq = std::sqrt (b/atanb - 1);
   double den = (sq/b*atanb - std::atan(sq));
   return  pars[0]* ((- std::atan (b*u) + u*atanb) / den +
                     pars[2]*(1-std::abs(u)));
 }

◆ calc5()

float CaloSwEtaoff_v3::Builder::calc5	(	float	aeta,
		float	u,
		const CaloRec::Array< 2 > &	coef
	)

staticprivate

Evaluate the function Form 5.

Evaluate the correction function for Form 4.

Parameters

aeta	The \(\|\eta\|\) of the cluster being corrected.
u	The fractional offset of the cluster within the cell.
coef	Array of polynomial coefficients for each parameter.

Definition at line 328 of file CaloSwEtaoff_v3.cxx.

 {
   const unsigned int NPAR = 1;
   double pars[NPAR];
   poly_eval (aeta, coef, NPAR, pars);
   return pars[0];
 }

◆ calculate()

float CaloSwEtaoff_v3::Builder::calculate	(	int	energy_ndx,
		bool &	good
	)		const

virtual

Calculate the correction for tabulated energy ENERGY_NDX.

Calculate the correction for one tabulated energy index.

Parameters

energy_ndx	The tabulated energy index for which the correction should be calculated.
good[out]	Set to true if the calculation succeeded.

Definition at line 152 of file CaloSwEtaoff_v3.cxx.

 {
   // Find the proper array of coefficients.
   CaloRec::Array<2> coef = m_correction[energy_ndx][m_region_ndx];
  
   // If we don't have coefficients for this energy/region, skip it.
   if (coef[0].end()[-1] == 0) {
     good = false;
     return 0;
   }
  
   // Which functional form to use?
   int form;
   if (m_forms.size() != 0 && m_forms.size(1) != 0)
     form = m_forms[m_region_ndx][energy_ndx];
   else
     form = m_form;
  
   // Evaluate the correction!
   good = true;
   float ret = 0;
  
   // Required just for case 13
   float xlo=0 ;
   float xhi=0 ;
   unsigned int reg_n = m_regions.size();
  
   switch (form) {
   case 0:
     ret = calc0 (m_aeta, m_u, coef);
     break;
   case 3:
     ret = calc3 (m_aeta, m_u, coef);
     break;
   case 4:
     ret = calc4 (m_aeta, m_u, coef);
     break;
   case 5:
     ret = calc5 (m_aeta, m_u, coef);
     break;
   case 10:
     ret = calc10 (m_aeta, m_u, coef);
     break;
   case 11:
     ret = calc11 (m_aeta, m_u, coef);
     break;
   case 13:
  
     for (unsigned int i=0; i < reg_n; i++) {
       if (m_aeta >= m_regions[i][REG_LO] && m_aeta < m_regions[i][REG_HI])
       {
          xlo = m_regions[i][REG_LO] ;
          xhi = m_regions[i][REG_HI] ;
       }
     }
  
     ret = calc13 (m_aeta, m_u, coef, xlo, xhi);
     break;
   default:
     abort();
   }
  
   // Protection against correction blowing up due to numerical
   // problems in calculating the polynomial interpolation.
   if (fabs(ret) > 0.025) {
     ret = 0;
     good = false;
   }
  
   return ret;
 }

Member Data Documentation

◆ m_aeta

float CaloSwEtaoff_v3::Builder::m_aeta

private

The abs(eta) at which the correction is being evaluated (in cal-local coordinates).

Definition at line 227 of file CaloSwEtaoff_v3.h.

◆ m_correction

const CxxUtils::Array<4>& CaloSwEtaoff_v3::Builder::m_correction

private

Definition at line 214 of file CaloSwEtaoff_v3.h.

◆ m_form

int CaloSwEtaoff_v3::Builder::m_form

private

The index of the functional form we're evaluating.

Definition at line 233 of file CaloSwEtaoff_v3.h.

◆ m_forms

const CxxUtils::Array<2>& CaloSwEtaoff_v3::Builder::m_forms

private

Functional form per region.

Definition at line 220 of file CaloSwEtaoff_v3.h.

◆ m_region_ndx

int CaloSwEtaoff_v3::Builder::m_region_ndx

private

The index of the region in which we're evaluating the correction.

Definition at line 223 of file CaloSwEtaoff_v3.h.

◆ m_regions

const CxxUtils::Array<2>& CaloSwEtaoff_v3::Builder::m_regions

private

Table of regions.

Definition at line 217 of file CaloSwEtaoff_v3.h.

◆ m_u

float CaloSwEtaoff_v3::Builder::m_u

private

The fractional offset in the cell of this cluster.

Definition at line 230 of file CaloSwEtaoff_v3.h.

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

Public Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Builder()

Member Function Documentation

◆ calc0()

◆ calc10()

◆ calc11()

◆ calc13()

◆ calc3()

◆ calc4()

◆ calc5()

◆ calculate()

Member Data Documentation

◆ m_aeta

◆ m_correction

◆ m_form

◆ m_forms

◆ m_region_ndx

◆ m_regions

◆ m_u