Luminosity-dependent pileup offset correction conditions object. More...

#include <CaloBCIDCoeffs.h>

Collaboration diagram for CaloBCIDCoeffs:

Public Member Functions
	CaloBCIDCoeffs (const std::vector< HWIdentifier > &hwids, const LArOnlineID_Base &online_id, const ILArOFC &ofcs, const ILArShape &shapes, const ILArMinBiasAverage &minbias)
	Constructor. More...

void	calc (const float *lumi, CxxUtils::vec_aligned_vector< float > &out) const
	Perform the calculation for a given set of per-bunch luminosities. More...

size_t	nshapes () const
	Return the number of shape points per cell. More...

size_t	nsamples_coeff () const
	Return the number of samples per cell used in the calculation (after padding). More...

Static Public Attributes
static constexpr size_t	CHUNKSIZE = 8
	Number of cells that we calculate at one time. More...

Private Member Functions
float &	coeff (size_t icoeff, size_t icell)
	Indexing into m_coeffs. More...

void	fillCoeffs (const std::vector< HWIdentifier > &hwids, const LArOnlineID_Base &online_id, const ILArOFC &ofcs, const ILArShape &shapes, const ILArMinBiasAverage &minbias)
	Initialize all coefficients. More...

void	findCellCoeffs (const float ofcs, const float shapes, bool ishec, std::vector< float > &cell_coeffs) const
	Find coefficients for one cell. More...

Private Attributes
unsigned int	m_ncell
	Number of cells. More...

unsigned int	m_npad
	Number of padding cells we need to add to get a multiple of CHUNKSIZE. More...

unsigned int	m_ncoeff
	Number of coefficients per cell (length of dot product). More...

unsigned int	m_nsamples
	Number of samples per cell (length of OFC vector). More...

unsigned int	m_nsamples_coeff
	Number of samples per cell used in the calculation, after padding. More...

unsigned int	m_nshapes
	Number of shape points per cell. More...

CxxUtils::vec_aligned_vector< float >	m_coeffs
	Storage for coeffients, m_ncoeff per cell, laid out in groups of CHUNKSIZE like this: icoeff0, icell 0 ... More...

Detailed Description

Luminosity-dependent pileup offset correction conditions object.

This implements the cell-by-cell luminosity-dependent offset correction for adjacent bunches. This was previously implemented as an algorithm (CaloBCIDAvgAlg), but it took too long to be usable in the trigger. We can, however, speed it up drastically by preformatting the constant data and saving it in a conditions object. The pieces of that related to calibration are stored here. The per-bunch luminosity information is stored in a separate conditions object, as it has a different lifetime.

The correction is carried out for each cell. Symmetry is taken into account via LArMCSym, and the calculation is done for only one cell in each symmetry group, which results in a total of 1833 cells. The calculation depends on the per-cell pulse shape S_j (j=0..N_S-1), the per-cell optimial-filter coeffients O_i (i=0..N_O-1), the per-cell average minibias M, and the per-bunch luminosity L_k (k=0..NBCID-1). It can be written as:

Offset = M \Sum_i O_i \Sum_j S_j L_(BCID+i-j)

where the luminosity array L is taken to be circular (i.e., the indexing is mod NBCID). (In cases with four samples, the luminosity index is offset by 1 for HEC cells.)

This can be rewritten grouping together terms which access the same L index:

Offset = \Sum_m (\Sum_l M O_(m+l) S_l ) L_(BCID+m)

Everything inside the parentheses can be precomputed, reducing the calculation to a dot product between a vector of constants and an appropriate subrange of the luminosity vector. The circular nature of the luminosity vector can be handled by padding the beginning and end and duplicating the values there. The special case mentioned above for four samples is handled by treating things as if we actually have five samples and padding the OFC coefficients with a zero at either the beginning or end (depending on whether the cell is HEC).

The S_j values are not positive definite (the shape is normalized to zero). So when we do the sums above, we're adding terms that are both positive and negative. This can result in some loss of precision, and means that when we reorder the sum as above, we shouldn't expect to get exactly the same result.

This calculation vectorizes well. It is better to vectorize over cells, to avoid dependencies between steps. We always do this in groups of 8 (regardless of platform) so that sums are always in the same order. This means that we need to pad things out so that the number of cells is a multiple of 8.

The optimized and vectorized calculation is found to be about a factor of 100 faster than the original naive implementation.

Definition at line 83 of file CaloBCIDCoeffs.h.

Constructor & Destructor Documentation

◆ CaloBCIDCoeffs()

CaloBCIDCoeffs::CaloBCIDCoeffs	(	const std::vector< HWIdentifier > &	hwids,
		const LArOnlineID_Base &	online_id,
		const ILArOFC &	ofcs,
		const ILArShape &	shapes,
		const ILArMinBiasAverage &	minbias
	)

Constructor.

Parameters

hwids	List of cell HWIDs for which we need to do the calculation.
online_id	Online ID helper.
ofcs	OFC coefficient conditions object.
shapes	Pulse shape conditions object.
minbias	Minimum bias conditions object.

Definition at line 138 of file CaloBCIDCoeffs.cxx.

 {
   // Number of cells we're calculating.
   m_ncell = hwids.size();
  
   // Number of cells of padding we need to add to get a multiple of CHUNKSIZE.
   m_npad = CHUNKSIZE - (m_ncell % CHUNKSIZE);
   if (m_npad == CHUNKSIZE) m_npad = 0;
  
   // Number of shape / samples.
   if (hwids.empty()) {
     m_nsamples = 0;
     m_nshapes = 0;
   }
   else {
     m_nsamples = ofcs.OFC_a (hwids[0], 0).size();
     m_nshapes = shapes.Shape (hwids[0], 0).size();
   }
  
   // Special case for 4 samples: treat this case as if we actually
   // had 5 samples, just with 0-padding.
   m_nsamples_coeff = m_nsamples;
   if (m_nsamples == 4) {
     m_nsamples_coeff = 5;
   }
  
   // Number of coefficients (length of the dot product).
   m_ncoeff = (m_nshapes-1) + 1 + (m_nsamples_coeff-1);
  
   // Initialize coeffients.
   fillCoeffs (hwids, online_id, ofcs, shapes, minbias);
 }

Member Function Documentation

◆ calc()

void CaloBCIDCoeffs::calc	(	const float *	lumi,
		CxxUtils::vec_aligned_vector< float > &	out
	)		const

Perform the calculation for a given set of per-bunch luminosities.

Parameters

lumi	Per-bunch luminosities. Should be properly offset in the BCID vector. Will access lumi[-(nshapes-1)] to lumi[nsamples-1], inclusive.
out	Output per-cell offsets.
lum	Per-bunch luminosities. Should be properly offset in the BCID vector. Will access lumi[-(nshapes-1)] to lumi[nsamples-1], inclusive.
out	Output per-cell offsets.

Definition at line 277 of file CaloBCIDCoeffs.cxx.

 {
  
  //call the implementation method
   calcImpl(lumi, m_ncell, m_ncoeff, m_nshapes, m_npad, m_coeffs, out);
   
 }

◆ coeff()

float& CaloBCIDCoeffs::coeff	(	size_t	icoeff,
		size_t	icell
	)

inlineprivate

Indexing into m_coeffs.

Parameters

icoeff	Coeffienct index.
icell	Cell index.

Definition at line 165 of file CaloBCIDCoeffs.h.

   {
     size_t chunk = icell / CHUNKSIZE;
     size_t ndx = chunk * m_ncoeff * CHUNKSIZE + icoeff * CHUNKSIZE + (icell%CHUNKSIZE);
     return m_coeffs[ndx];
   }

◆ fillCoeffs()

void CaloBCIDCoeffs::fillCoeffs	(	const std::vector< HWIdentifier > &	hwids,
		const LArOnlineID_Base &	online_id,
		const ILArOFC &	ofcs,
		const ILArShape &	shapes,
		const ILArMinBiasAverage &	minbias
	)

private

Initialize all coefficients.

Parameters

hwids	List of cell HWIDs for which we need to do the calculation.
online_id	Online ID helper.
ofcs	OFC coefficient conditions object.
shapes	Pulse shape conditions object.
minbias	Minimum bias conditions object.

Definition at line 184 of file CaloBCIDCoeffs.cxx.

 {
   // Reserve space for all coefficients.
   m_coeffs.resize (m_ncoeff * (m_ncell + m_npad));
  
   // Temporary vector to hold coefficients for one cell.
   // Declare outside the loop to reduce allocations.
   std::vector<float> cell_coeffs (m_ncoeff);
  
   for (size_t icell = 0; icell < m_ncell; ++icell) {
     HWIdentifier hwid = hwids[icell];
     float cell_minbias = minbias.minBiasAverage (hwid);
  
     // If cell_minbias <= 0, we want the result to be 0.
     // So just leave the coefficients as 0 in that case.
     if (cell_minbias > 0) {
       // Calculate coefficients for one cell.
       findCellCoeffs (ofcs.OFC_a (hwid, 0).data(),
                       shapes.Shape (hwid, 0).data(),
                       online_id.isHECchannel (hwid),
                       cell_coeffs);
  
       // Enter them into the coefficients array in the proper places.
       // Here, we also multiply everything by minbias.
       for (size_t icoeff = 0; icoeff < m_ncoeff; ++icoeff) {
         coeff(icoeff, icell) = cell_coeffs[icoeff] * cell_minbias;
       }
     }
   }
 }

◆ findCellCoeffs()

void CaloBCIDCoeffs::findCellCoeffs	(	const float *	ofcs,
		const float *	shapes,
		bool	ishec,
		std::vector< float > &	cell_coeffs
	)		const

private

Find coefficients for one cell.

Parameters

ofcs	Array of OFC coefficients for this cell.
shapes	Array of shape points for this cell.
ishec	True if this is a HEC cell.
cell_coeffs	Output coefficient array.

Definition at line 227 of file CaloBCIDCoeffs.cxx.

 {
   // Initialize output to zero.
   std::fill (cell_coeffs.begin(), cell_coeffs.end(), 0);
  
   const unsigned nsamples_coeff = m_nsamples_coeff;
   const unsigned nshapes = m_nshapes;
  
   // Loop over all combinations of sample / shape.
   for (size_t i = 0; i < nsamples_coeff; ++i) {
     for (size_t j = 0; j < nshapes; ++j) {
       // Index of coefficient we're filling.
       size_t ndx = i - j + (nshapes-1);
  
       // Find OFC coefficient.
       float ofc = 0;
       if (m_nsamples == 4)
       {
         // Special case for 4 samples: we actually calclate with five samples,
         // but pad with 0 at either the beginning or end (depending on
         // whether this is a HEC cell).
         if (ishec) {
           if (i > 0) ofc = ofcs[i-1];
         }
         else {
           if (i < 4) ofc = ofcs[i];
         }
       }
       else {
         ofc = ofcs[i];
       }
  
       // Do the multiplication and sum.
       cell_coeffs.at(ndx) += ofc * shapes[j];
     }
   }
 }

◆ nsamples_coeff()

size_t CaloBCIDCoeffs::nsamples_coeff ( ) const

inline

Return the number of samples per cell used in the calculation (after padding).

Definition at line 224 of file CaloBCIDCoeffs.h.

 {
   return m_nsamples_coeff;
 }

◆ nshapes()

size_t CaloBCIDCoeffs::nshapes ( ) const

inline

Return the number of shape points per cell.

Definition at line 213 of file CaloBCIDCoeffs.h.

 {
   return m_nshapes;
 }

Member Data Documentation

◆ CHUNKSIZE

constexpr size_t CaloBCIDCoeffs::CHUNKSIZE = 8

staticconstexpr

Number of cells that we calculate at one time.

Definition at line 126 of file CaloBCIDCoeffs.h.

◆ m_coeffs

CxxUtils::vec_aligned_vector<float> CaloBCIDCoeffs::m_coeffs

private

Storage for coeffients, m_ncoeff per cell, laid out in groups of CHUNKSIZE like this: icoeff0, icell 0 ...

icoeff0, icell CHUNKSIZE-1 icoeff1, icell 0 ... icoeff(m_ncoeff-1) icell CHUNKSIZE-1 icoeff0, icell CHUNKSIZE ...

Definition at line 157 of file CaloBCIDCoeffs.h.

◆ m_ncell

unsigned int CaloBCIDCoeffs::m_ncell

private

Number of cells.

Definition at line 130 of file CaloBCIDCoeffs.h.

◆ m_ncoeff

unsigned int CaloBCIDCoeffs::m_ncoeff

private

Number of coefficients per cell (length of dot product).

Definition at line 136 of file CaloBCIDCoeffs.h.

◆ m_npad

unsigned int CaloBCIDCoeffs::m_npad

private

Number of padding cells we need to add to get a multiple of CHUNKSIZE.

Definition at line 133 of file CaloBCIDCoeffs.h.

◆ m_nsamples

unsigned int CaloBCIDCoeffs::m_nsamples

private

Number of samples per cell (length of OFC vector).

Definition at line 139 of file CaloBCIDCoeffs.h.

◆ m_nsamples_coeff

unsigned int CaloBCIDCoeffs::m_nsamples_coeff

private

Number of samples per cell used in the calculation, after padding.

Definition at line 142 of file CaloBCIDCoeffs.h.

◆ m_nshapes

unsigned int CaloBCIDCoeffs::m_nshapes

private

Number of shape points per cell.

Definition at line 145 of file CaloBCIDCoeffs.h.

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

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CaloBCIDCoeffs()

Member Function Documentation

◆ calc()

◆ coeff()

◆ fillCoeffs()

◆ findCellCoeffs()

◆ nsamples_coeff()

◆ nshapes()

Member Data Documentation

◆ CHUNKSIZE

◆ m_coeffs

◆ m_ncell

◆ m_ncoeff

◆ m_npad

◆ m_nsamples

◆ m_nsamples_coeff

◆ m_nshapes