#include <HcalZSAlgoRealistic.h>

Inheritance diagram for HcalZSAlgoRealistic:

Public Member Functions
	HcalZSAlgoRealistic (bool markAndPass, bool use1ts, std::pair< int, int > HBsearchTS, std::pair< int, int > HEsearchTS, std::pair< int, int > HOsearchTS, std::pair< int, int > HFsearchTS)

	HcalZSAlgoRealistic (bool markAndPass, bool use1ts, int levelHB, int levelHE, int levelHO, int levelHF, std::pair< int, int > HBsearchTS, std::pair< int, int > HEsearchTS, std::pair< int, int > HOsearchTS, std::pair< int, int > HFsearchTS)

	~HcalZSAlgoRealistic () override=default

Public Member Functions inherited from HcalZeroSuppressionAlgo
void	clearDbService ()

void	setDbService (const HcalDbService *db)

void	suppress (const HBHEDigiCollection &input, HBHEDigiCollection &output)

void	suppress (const HODigiCollection &input, HODigiCollection &output)

void	suppress (const HFDigiCollection &input, HFDigiCollection &output)

void	suppress (const QIE10DigiCollection &input, QIE10DigiCollection &output)

void	suppress (const QIE11DigiCollection &input, QIE11DigiCollection &output)

virtual	~HcalZeroSuppressionAlgo ()=default

Protected Member Functions
bool	shouldKeep (const HBHEDataFrame &digi) const override

bool	shouldKeep (const HODataFrame &digi) const override

bool	shouldKeep (const HFDataFrame &digi) const override

bool	shouldKeep (const QIE10DataFrame &digi) const override

bool	shouldKeep (const QIE11DataFrame &digi) const override

Protected Member Functions inherited from HcalZeroSuppressionAlgo
	HcalZeroSuppressionAlgo (bool markAndPass)

Private Member Functions
template<class Digi >
bool	keepMe (const Digi &inp, int start, int finish, int threshold, uint32_t zsmask) const

template<>
bool	keepMe (const QIE10DataFrame &inp, int start, int finish, int threshold, uint32_t zsmask) const

template<>
bool	keepMe (const QIE11DataFrame &inp, int start, int finish, int threshold, uint32_t zsmask) const

Private Attributes
std::pair< int, int >	HBsearchTS_

std::pair< int, int >	HEsearchTS_

std::pair< int, int >	HFsearchTS_

std::pair< int, int >	HOsearchTS_

int	thresholdHB_

int	thresholdHE_

int	thresholdHF_

int	thresholdHO_

bool	use1ts_

bool	usingDBvalues

Additional Inherited Members
Protected Attributes inherited from HcalZeroSuppressionAlgo
const HcalDbService *	m_dbService

Detailed Description

Simple amplitude-based zero suppression algorithm. For each digi, add up consecutive 2 samples in a slice of 10 time samples, beginning with (start) sample. If any of the sums are greater then the threshold, keep the event.

For Run3 and Run4 HB and HE only 1TS is used

Definition at line 17 of file HcalZSAlgoRealistic.h.

Constructor & Destructor Documentation

◆ HcalZSAlgoRealistic() [1/2]

HcalZSAlgoRealistic::HcalZSAlgoRealistic	(	bool	markAndPass,
		bool	use1ts,
		std::pair< int, int >	HBsearchTS,
		std::pair< int, int >	HEsearchTS,
		std::pair< int, int >	HOsearchTS,
		std::pair< int, int >	HFsearchTS
	)

Definition at line 27 of file HcalZSAlgoRealistic.cc.

References thresholdHB_, thresholdHE_, thresholdHF_, thresholdHO_, and usingDBvalues.

     : HcalZeroSuppressionAlgo(mp),
       use1ts_(use1ts),
       HBsearchTS_(HBsearchTS),
       HEsearchTS_(HEsearchTS),
       HOsearchTS_(HOsearchTS),
       HFsearchTS_(HFsearchTS) {
   thresholdHB_ = -1;
   thresholdHE_ = -1;
   thresholdHO_ = -1;
   thresholdHF_ = -1;
   usingDBvalues = true;
 }

◆ HcalZSAlgoRealistic() [2/2]

HcalZSAlgoRealistic::HcalZSAlgoRealistic	(	bool	markAndPass,
		bool	use1ts,
		int	levelHB,
		int	levelHE,
		int	levelHO,
		int	levelHF,
		std::pair< int, int >	HBsearchTS,
		std::pair< int, int >	HEsearchTS,
		std::pair< int, int >	HOsearchTS,
		std::pair< int, int >	HFsearchTS
	)

Definition at line 4 of file HcalZSAlgoRealistic.cc.

References usingDBvalues.

     : HcalZeroSuppressionAlgo(mp),
       use1ts_(use1ts),
       thresholdHB_(levelHB),
       thresholdHE_(levelHE),
       thresholdHO_(levelHO),
       thresholdHF_(levelHF),
       HBsearchTS_(HBsearchTS),
       HEsearchTS_(HEsearchTS),
       HOsearchTS_(HOsearchTS),
       HFsearchTS_(HFsearchTS) {
   usingDBvalues = false;
 }

◆ ~HcalZSAlgoRealistic()

HcalZSAlgoRealistic::~HcalZSAlgoRealistic ( )

overridedefault

Member Function Documentation

◆ keepMe() [1/3]

template<class Digi >

bool HcalZSAlgoRealistic::keepMe	(	const Digi &	inp,
		int	start,
		int	finish,
		int	threshold,
		uint32_t	zsmask
	)		const

private

Definition at line 47 of file HcalZSAlgoRealistic.cc.

References gpuClustering::adc, HcalDbService::getHcalZSThreshold(), mps_fire::i, HcalZeroSuppressionAlgo::m_dbService, DiMuonV_cfg::threshold, and usingDBvalues.

Referenced by shouldKeep().

                                                                                                              {
   if ((usingDBvalues) && (threshold < 0) && (m_dbService != nullptr)) {
     threshold = (m_dbService->getHcalZSThreshold(inp.id()))->getValue();
   }
 
   // determine the sum of 2 timeslices
   for (int i = start; i < finish; i++) {
     if ((zsmask & (1 << i)) != 0)
       continue;
     if ((inp[i].adc() + inp[i + 1].adc()) >= threshold)
       return true;
   }
   return false;
 }

◆ keepMe() [2/3]

template<>

bool HcalZSAlgoRealistic::keepMe	(	const QIE10DataFrame &	inp,
		int	start,
		int	finish,
		int	threshold,
		uint32_t	zsmask
	)		const

private

Definition at line 65 of file HcalZSAlgoRealistic.cc.

References gpuClustering::adc, mps_fire::i, and DiMuonV_cfg::threshold.

                                                                                             {
   if ((usingDBvalues) && (threshold < 0) && (m_dbService != nullptr)) {
     threshold = (m_dbService->getHcalZSThreshold(inp.id()))->getValue();
   }
 
   // determine the sum of 2 timeslices
   for (int i = start; i < finish; i++) {
     if ((inp[i].adc() + inp[i + 1].adc()) >= threshold)
       return true;
   }
   return false;
 }

◆ keepMe() [3/3]

template<>

bool HcalZSAlgoRealistic::keepMe	(	const QIE11DataFrame &	inp,
		int	start,
		int	finish,
		int	threshold,
		uint32_t	zsmask
	)		const

private

Definition at line 80 of file HcalZSAlgoRealistic.cc.

References mps_fire::i, and DiMuonV_cfg::threshold.

                                                                                             {
   if ((usingDBvalues) && (threshold < 0) && (m_dbService != nullptr)) {
     threshold = (m_dbService->getHcalZSThreshold(inp.id()))->getValue();
   }
 
   // sum of 2 timeslices or just single one
   for (int i = start; i < finish; i++) {
     int sum = inp[i].adc();
     if (!use1ts_)
       sum += inp[i + 1].adc();
     if (sum >= threshold)
       return true;
   }
   return false;
 }

◆ shouldKeep() [1/5]

bool HcalZSAlgoRealistic::shouldKeep ( const HBHEDataFrame & digi ) const

overrideprotectedvirtual

Implements HcalZeroSuppressionAlgo.

Definition at line 97 of file HcalZSAlgoRealistic.cc.

References HBsearchTS_, HcalBarrel, HEsearchTS_, HBHEDataFrame::id(), keepMe(), SiStripPI::max, SiStripPI::min, HBHEDataFrame::size(), HcalDetId::subdet(), thresholdHB_, thresholdHE_, and HBHEDataFrame::zsCrossingMask().

                                                                     {
   if (digi.id().subdet() == HcalBarrel) {
     int start = std::max(0, HBsearchTS_.first);
     int finish = std::min(digi.size() - 1, HBsearchTS_.second);
     return keepMe(digi, start, finish, thresholdHB_, digi.zsCrossingMask());
   } else {
     int start = std::max(0, HEsearchTS_.first);
     int finish = std::min(digi.size() - 1, HEsearchTS_.second);
     return keepMe(digi, start, finish, thresholdHE_, digi.zsCrossingMask());
   }
 }

◆ shouldKeep() [2/5]

bool HcalZSAlgoRealistic::shouldKeep ( const HODataFrame & digi ) const

overrideprotectedvirtual

Implements HcalZeroSuppressionAlgo.

Definition at line 109 of file HcalZSAlgoRealistic.cc.

References HOsearchTS_, keepMe(), SiStripPI::max, SiStripPI::min, HODataFrame::size(), thresholdHO_, and HODataFrame::zsCrossingMask().

                                                                   {
   int start = std::max(0, HOsearchTS_.first);
   int finish = std::min(digi.size() - 1, HOsearchTS_.second);
   return keepMe(digi, start, finish, thresholdHO_, digi.zsCrossingMask());
 }

◆ shouldKeep() [3/5]

bool HcalZSAlgoRealistic::shouldKeep ( const HFDataFrame & digi ) const

overrideprotectedvirtual

Implements HcalZeroSuppressionAlgo.

Definition at line 115 of file HcalZSAlgoRealistic.cc.

References HFsearchTS_, keepMe(), SiStripPI::max, SiStripPI::min, HFDataFrame::size(), thresholdHF_, and HFDataFrame::zsCrossingMask().

                                                                   {
   int start = std::max(0, HFsearchTS_.first);
   int finish = std::min(digi.size() - 1, HFsearchTS_.second);
   return keepMe(digi, start, finish, thresholdHF_, digi.zsCrossingMask());
 }

◆ shouldKeep() [4/5]

bool HcalZSAlgoRealistic::shouldKeep ( const QIE10DataFrame & digi ) const

overrideprotectedvirtual

Implements HcalZeroSuppressionAlgo.

Definition at line 121 of file HcalZSAlgoRealistic.cc.

References HFsearchTS_, keepMe(), SiStripPI::max, SiStripPI::min, QIE10DataFrame::samples(), and thresholdHF_.

                                                                      {
   int start = std::max(0, HFsearchTS_.first);
   int finish = std::min((int)digi.samples() - 1, HFsearchTS_.second);
   return keepMe(digi, start, finish, thresholdHF_, 0);
 }

◆ shouldKeep() [5/5]

bool HcalZSAlgoRealistic::shouldKeep ( const QIE11DataFrame & digi ) const

overrideprotectedvirtual

Implements HcalZeroSuppressionAlgo.

Definition at line 127 of file HcalZSAlgoRealistic.cc.

References HBsearchTS_, HcalBarrel, HEsearchTS_, QIE11DataFrame::id(), keepMe(), SiStripPI::max, SiStripPI::min, QIE11DataFrame::samples(), thresholdHB_, and thresholdHE_.

                                                                      {
   HcalDetId hid(digi.id());
   if (hid.subdet() == HcalBarrel) {
     int start = std::max(0, HBsearchTS_.first);
     int finish = std::min(digi.samples() - 1, HBsearchTS_.second);
     return keepMe(digi, start, finish, thresholdHB_, 0);
   } else {
     int start = std::max(0, HEsearchTS_.first);
     int finish = std::min(digi.samples() - 1, HEsearchTS_.second);
     return keepMe(digi, start, finish, thresholdHE_, 0);
   }
 }

Member Data Documentation

◆ HBsearchTS_

std::pair<int, int> HcalZSAlgoRealistic::HBsearchTS_

private

Definition at line 49 of file HcalZSAlgoRealistic.h.

Referenced by shouldKeep().

◆ HEsearchTS_

std::pair<int, int> HcalZSAlgoRealistic::HEsearchTS_

private

Definition at line 49 of file HcalZSAlgoRealistic.h.

Referenced by shouldKeep().

◆ HFsearchTS_

std::pair<int, int> HcalZSAlgoRealistic::HFsearchTS_

private

Definition at line 49 of file HcalZSAlgoRealistic.h.

Referenced by shouldKeep().

◆ HOsearchTS_

std::pair<int, int> HcalZSAlgoRealistic::HOsearchTS_

private

Definition at line 49 of file HcalZSAlgoRealistic.h.

Referenced by shouldKeep().

◆ thresholdHB_

int HcalZSAlgoRealistic::thresholdHB_

private

Definition at line 48 of file HcalZSAlgoRealistic.h.

Referenced by HcalZSAlgoRealistic(), and shouldKeep().

◆ thresholdHE_

int HcalZSAlgoRealistic::thresholdHE_

private

Definition at line 48 of file HcalZSAlgoRealistic.h.

Referenced by HcalZSAlgoRealistic(), and shouldKeep().

◆ thresholdHF_

int HcalZSAlgoRealistic::thresholdHF_

private

Definition at line 48 of file HcalZSAlgoRealistic.h.

Referenced by HcalZSAlgoRealistic(), and shouldKeep().

◆ thresholdHO_

int HcalZSAlgoRealistic::thresholdHO_

private

Definition at line 48 of file HcalZSAlgoRealistic.h.

Referenced by HcalZSAlgoRealistic(), and shouldKeep().

◆ use1ts_

bool HcalZSAlgoRealistic::use1ts_

private

Definition at line 47 of file HcalZSAlgoRealistic.h.

◆ usingDBvalues

bool HcalZSAlgoRealistic::usingDBvalues

private

Definition at line 47 of file HcalZSAlgoRealistic.h.

Referenced by HcalZSAlgoRealistic(), and keepMe().

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HcalZSAlgoRealistic() [1/2]

◆ HcalZSAlgoRealistic() [2/2]

◆ ~HcalZSAlgoRealistic()

Member Function Documentation

◆ keepMe() [1/3]

◆ keepMe() [2/3]

◆ keepMe() [3/3]

◆ shouldKeep() [1/5]

◆ shouldKeep() [2/5]

◆ shouldKeep() [3/5]

◆ shouldKeep() [4/5]

◆ shouldKeep() [5/5]

Member Data Documentation

◆ HBsearchTS_

◆ HEsearchTS_

◆ HFsearchTS_

◆ HOsearchTS_

◆ thresholdHB_

◆ thresholdHE_

◆ thresholdHF_

◆ thresholdHO_

◆ use1ts_

◆ usingDBvalues