#include <ThreeThresholdAlgorithm.h>

Inheritance diagram for ThreeThresholdAlgorithm:

Public Types
using	Det = StripClusterizerAlgorithm::Det

using	State = StripClusterizerAlgorithm::State

Public Types inherited from StripClusterizerAlgorithm
typedef edmNew::DetSetVector< SiStripCluster >	output_t

Public Member Functions
void	clusterizeDetUnit (const edm::DetSet< SiStripDigi > &, output_t::TSFastFiller &) const override

void	clusterizeDetUnit (const edmNew::DetSet< SiStripDigi > &, output_t::TSFastFiller &) const override

void	stripByStripAdd (State &state, uint16_t strip, uint8_t adc, output_t::TSFastFiller &out) const override

void	stripByStripAdd (State &state, uint16_t strip, uint8_t adc, std::vector< SiStripCluster > &out) const override

Det	stripByStripBegin (uint32_t id) const override

void	stripByStripEnd (State &state, output_t::TSFastFiller &out) const override

void	stripByStripEnd (State &state, std::vector< SiStripCluster > &out) const override

Public Member Functions inherited from StripClusterizerAlgorithm
std::vector< uint32_t > const &	allDetIds () const

SiStripDetCabling const *	cabling () const

void	clusterize (const edm::DetSetVector< SiStripDigi > &, output_t &) const

void	clusterize (const edmNew::DetSetVector< SiStripDigi > &, output_t &) const

std::vector< const FedChannelConnection * > const &	currentConnection (const Det &det) const

virtual void	initialize (const edm::EventSetup &)

virtual	~StripClusterizerAlgorithm ()

Private Member Functions
void	addToCandidate (State &state, const SiStripDigi &digi) const

void	addToCandidate (State &state, uint16_t strip, uint8_t adc) const

void	appendBadNeighbors (State &state) const

void	applyGains (State &state) const

bool	candidateAccepted (State const &state) const

bool	candidateEnded (State const &state, const uint16_t &) const

void	clearCandidate (State &state) const

template<class digiDetSet >
void	clusterizeDetUnit_ (const digiDetSet &digis, output_t::TSFastFiller &output) const

template<class T >
void	clusterizeDetUnit_ (const T &, output_t::TSFastFiller &) const

template<class T >
void	endCandidate (State &state, T &) const

uint16_t	firstStrip (State const &state) const

	ThreeThresholdAlgorithm (float, float, float, unsigned, unsigned, unsigned, std::string qualityLabel, bool removeApvShots, float minGoodCharge)

Private Attributes
float	ChannelThreshold

float	ClusterThresholdSquared

uint8_t	MaxAdjacentBad

uint8_t	MaxSequentialBad

uint8_t	MaxSequentialHoles

float	minGoodCharge

bool	RemoveApvShots

float	SeedThreshold

Friends
class	StripClusterizerAlgorithmFactory

Additional Inherited Members
Static Public Attributes inherited from StripClusterizerAlgorithm
static constexpr unsigned short	invalidI = std::numeric_limits<unsigned short>::max()

Protected Member Functions inherited from StripClusterizerAlgorithm
Det	findDetId (const uint32_t) const

bool	isModuleBad (const uint32_t &id) const

bool	isModuleUsable (const uint32_t &id) const

	StripClusterizerAlgorithm ()

Protected Attributes inherited from StripClusterizerAlgorithm
std::string	qualityLabel

Detailed Description

Definition at line 6 of file ThreeThresholdAlgorithm.h.

Member Typedef Documentation

◆ Det

using ThreeThresholdAlgorithm::Det = StripClusterizerAlgorithm::Det

Definition at line 11 of file ThreeThresholdAlgorithm.h.

◆ State

using ThreeThresholdAlgorithm::State = StripClusterizerAlgorithm::State

Definition at line 10 of file ThreeThresholdAlgorithm.h.

Constructor & Destructor Documentation

◆ ThreeThresholdAlgorithm()

ThreeThresholdAlgorithm::ThreeThresholdAlgorithm	(	float	chan,
		float	seed,
		float	cluster,
		unsigned	holes,
		unsigned	bad,
		unsigned	adj,
		std::string	qualityLabel,
		bool	removeApvShots,
		float	minGoodCharge
	)

private

Definition at line 10 of file ThreeThresholdAlgorithm.cc.

     : ChannelThreshold(chan),
       SeedThreshold(seed),
       ClusterThresholdSquared(cluster * cluster),
       MaxSequentialHoles(holes),
       MaxSequentialBad(bad),
       MaxAdjacentBad(adj),
       RemoveApvShots(removeApvShots),
       minGoodCharge(minGoodCharge) {
   qualityLabel = (qL);
 }

References StripClusterizerAlgorithm::qualityLabel.

Member Function Documentation

◆ addToCandidate() [1/2]

void ThreeThresholdAlgorithm::addToCandidate	(	State &	state,
		const SiStripDigi &	digi
	)		const

inlineprivate

Definition at line 56 of file ThreeThresholdAlgorithm.h.

56 { addToCandidate(state, digi.strip(), digi.adc()); }

References SiStripDigi::adc(), addToCandidate(), and SiStripDigi::strip().

Referenced by addToCandidate(), clusterizeDetUnit_(), and stripByStripAdd().

◆ addToCandidate() [2/2]

void ThreeThresholdAlgorithm::addToCandidate	(	State &	state,
		uint16_t	strip,
		uint8_t	adc
	)		const

inlineprivate

Definition at line 69 of file ThreeThresholdAlgorithm.cc.

                                                                                                    {
   float Noise = state.det().noise(strip);
   if (adc < static_cast<uint8_t>(Noise * ChannelThreshold) || state.det().bad(strip))
     return;
  
   if (state.candidateLacksSeed)
     state.candidateLacksSeed = adc < static_cast<uint8_t>(Noise * SeedThreshold);
   if (state.ADCs.empty())
     state.lastStrip = strip - 1;  // begin candidate
   while (++state.lastStrip < strip)
     state.ADCs.push_back(0);  // pad holes
  
   state.ADCs.push_back(adc);
   state.noiseSquared += Noise * Noise;
 }

References ecalMGPA::adc(), StripClusterizerAlgorithm::State::ADCs, StripClusterizerAlgorithm::Det::bad(), StripClusterizerAlgorithm::State::candidateLacksSeed, ChannelThreshold, StripClusterizerAlgorithm::State::det(), StripClusterizerAlgorithm::State::lastStrip, StripClusterizerAlgorithm::Det::noise(), DigiDM_cff::Noise, StripClusterizerAlgorithm::State::noiseSquared, SeedThreshold, and digitizers_cfi::strip.

◆ appendBadNeighbors()

void ThreeThresholdAlgorithm::appendBadNeighbors ( State & state ) const

inlineprivate

Definition at line 115 of file ThreeThresholdAlgorithm.cc.

                                                                           {
   uint8_t max = MaxAdjacentBad;
   while (0 < max--) {
     if (state.det().bad(firstStrip(state) - 1)) {
       state.ADCs.insert(state.ADCs.begin(), 0);
     }
     if (state.det().bad(state.lastStrip + 1)) {
       state.ADCs.push_back(0);
       state.lastStrip++;
     }
   }
 }

References StripClusterizerAlgorithm::State::ADCs, StripClusterizerAlgorithm::Det::bad(), StripClusterizerAlgorithm::State::det(), firstStrip(), StripClusterizerAlgorithm::State::lastStrip, SiStripPI::max, and MaxAdjacentBad.

Referenced by endCandidate().

◆ applyGains()

void ThreeThresholdAlgorithm::applyGains ( State & state ) const

inlineprivate

Definition at line 102 of file ThreeThresholdAlgorithm.cc.

                                                                   {
   uint16_t strip = firstStrip(state);
   for (auto& adc : state.ADCs) {
 #ifdef EDM_ML_DEBUG
     // if(adc > 255) throw InvalidChargeException( SiStripDigi(strip,adc) );
 #endif
     // if(adc > 253) continue; //saturated, do not scale
     auto charge = int(float(adc) / state.det().gain(strip++) + 0.5f);  //adding 0.5 turns truncation into rounding
     if (adc < 254)
       adc = (charge > 1022 ? 255 : (charge > 253 ? 254 : charge));
   }
 }

References ecalMGPA::adc(), StripClusterizerAlgorithm::State::ADCs, ALCARECOTkAlJpsiMuMu_cff::charge, StripClusterizerAlgorithm::State::det(), firstStrip(), StripClusterizerAlgorithm::Det::gain(), createfilelist::int, and digitizers_cfi::strip.

Referenced by endCandidate().

◆ candidateAccepted()

bool ThreeThresholdAlgorithm::candidateAccepted ( State const & state ) const

inlineprivate

Definition at line 96 of file ThreeThresholdAlgorithm.cc.

                                                                                {
   return (!state.candidateLacksSeed &&
           state.noiseSquared * ClusterThresholdSquared <=
               std::pow(float(std::accumulate(state.ADCs.begin(), state.ADCs.end(), int(0))), 2.f));
 }

References StripClusterizerAlgorithm::State::ADCs, StripClusterizerAlgorithm::State::candidateLacksSeed, ClusterThresholdSquared, createfilelist::int, StripClusterizerAlgorithm::State::noiseSquared, and funct::pow().

Referenced by endCandidate().

◆ candidateEnded()

bool ThreeThresholdAlgorithm::candidateEnded	(	State const &	state,
		const uint16_t &	testStrip
	)		const

inlineprivate

Definition at line 59 of file ThreeThresholdAlgorithm.cc.

                                                                                                        {
   uint16_t holes = testStrip - state.lastStrip - 1;
   return (((!state.ADCs.empty()) &       // a candidate exists, and
            (holes > MaxSequentialHoles)  // too many holes if not all are bad strips, and
            ) &&
           (holes > MaxSequentialBad ||                             // (too many bad strips anyway, or
            !state.det().allBadBetween(state.lastStrip, testStrip)  // not all holes are bad strips)
            ));
 }

References StripClusterizerAlgorithm::State::ADCs, StripClusterizerAlgorithm::Det::allBadBetween(), StripClusterizerAlgorithm::State::det(), StripClusterizerAlgorithm::State::lastStrip, MaxSequentialBad, and MaxSequentialHoles.

Referenced by clusterizeDetUnit_(), and stripByStripAdd().

◆ clearCandidate()

void ThreeThresholdAlgorithm::clearCandidate ( State & state ) const

inlineprivate

Definition at line 51 of file ThreeThresholdAlgorithm.h.

                                           {
     state.candidateLacksSeed = true;
     state.noiseSquared = 0;
     state.ADCs.clear();
   }

References StripClusterizerAlgorithm::State::ADCs, StripClusterizerAlgorithm::State::candidateLacksSeed, and StripClusterizerAlgorithm::State::noiseSquared.

Referenced by endCandidate().

◆ clusterizeDetUnit() [1/2]

void ThreeThresholdAlgorithm::clusterizeDetUnit	(	const edm::DetSet< SiStripDigi > &	digis,
		output_t::TSFastFiller &	output
	)		const

overridevirtual

Implements StripClusterizerAlgorithm.

Definition at line 128 of file ThreeThresholdAlgorithm.cc.

                                                                                     {
   clusterizeDetUnit_(digis, output);
 }

References clusterizeDetUnit_(), and convertSQLitetoXML_cfg::output.

◆ clusterizeDetUnit() [2/2]

void ThreeThresholdAlgorithm::clusterizeDetUnit	(	const edmNew::DetSet< SiStripDigi > &	digis,
		output_t::TSFastFiller &	output
	)		const

overridevirtual

Implements StripClusterizerAlgorithm.

Definition at line 132 of file ThreeThresholdAlgorithm.cc.

                                                                                     {
   clusterizeDetUnit_(digis, output);
 }

References clusterizeDetUnit_(), and convertSQLitetoXML_cfg::output.

◆ clusterizeDetUnit_() [1/2]

template<class digiDetSet >

void ThreeThresholdAlgorithm::clusterizeDetUnit_	(	const digiDetSet &	digis,
		output_t::TSFastFiller &	output
	)		const

inlineprivate

Definition at line 31 of file ThreeThresholdAlgorithm.cc.

                                                                                                                    {
   if (isModuleBad(digis.detId()))
     return;
  
   auto const& det = findDetId(digis.detId());
   if (!det.valid())
     return;
  
 #ifdef EDM_ML_DEBUG
   if (!isModuleUsable(digis.detId()))
     edm::LogWarning("ThreeThresholdAlgorithm") << " id " << digis.detId() << " not usable???" << std::endl;
 #endif
  
   typename digiDetSet::const_iterator scan(digis.begin()), end(digis.end());
  
   SiStripApvShotCleaner ApvCleaner;
   if (RemoveApvShots) {
     ApvCleaner.clean(digis, scan, end);
   }
  
   State state(det);
   while (scan != end) {
     while (scan != end && !candidateEnded(state, scan->strip()))
       addToCandidate(state, *scan++);
     endCandidate(state, output);
   }
 }

References addToCandidate(), candidateEnded(), SiStripApvShotCleaner::clean(), end, endCandidate(), StripClusterizerAlgorithm::findDetId(), StripClusterizerAlgorithm::isModuleBad(), StripClusterizerAlgorithm::isModuleUsable(), convertSQLitetoXML_cfg::output, and RemoveApvShots.

◆ clusterizeDetUnit_() [2/2]

template<class T >

void ThreeThresholdAlgorithm::clusterizeDetUnit_	(	const T &	,
		output_t::TSFastFiller &
	)		const

private

Referenced by clusterizeDetUnit().

◆ endCandidate()

template<class T >

void ThreeThresholdAlgorithm::endCandidate	(	State &	state,
		T &	out
	)		const

inlineprivate

Definition at line 86 of file ThreeThresholdAlgorithm.cc.

                                                                             {
   if (candidateAccepted(state)) {
     applyGains(state);
     appendBadNeighbors(state);
     if (siStripClusterTools::chargePerCM(state.det().detId, state.ADCs.begin(), state.ADCs.end()) > minGoodCharge)
       out.push_back(SiStripCluster(firstStrip(state), state.ADCs.begin(), state.ADCs.end()));
   }
   clearCandidate(state);
 }

References StripClusterizerAlgorithm::State::ADCs, appendBadNeighbors(), applyGains(), candidateAccepted(), siStripClusterTools::chargePerCM(), clearCandidate(), StripClusterizerAlgorithm::State::det(), StripClusterizerAlgorithm::Det::detId, firstStrip(), minGoodCharge, and MillePedeFileConverter_cfg::out.

Referenced by clusterizeDetUnit_(), stripByStripAdd(), and stripByStripEnd().

◆ firstStrip()

uint16_t ThreeThresholdAlgorithm::firstStrip ( State const & state ) const

inlineprivate

Definition at line 44 of file ThreeThresholdAlgorithm.h.

44 { return state.lastStrip - state.ADCs.size() + 1; }

References StripClusterizerAlgorithm::State::ADCs, and StripClusterizerAlgorithm::State::lastStrip.

Referenced by appendBadNeighbors(), applyGains(), and endCandidate().

◆ stripByStripAdd() [1/2]

void ThreeThresholdAlgorithm::stripByStripAdd	(	State &	state,
		uint16_t	strip,
		uint8_t	adc,
		output_t::TSFastFiller &	out
	)		const

inlineoverridevirtual

Reimplemented from StripClusterizerAlgorithm.

Definition at line 21 of file ThreeThresholdAlgorithm.h.

                                                                                                             {
     if (candidateEnded(state, strip))
       endCandidate(state, out);
     addToCandidate(state, strip, adc);
   }

References ecalMGPA::adc(), addToCandidate(), candidateEnded(), endCandidate(), MillePedeFileConverter_cfg::out, and digitizers_cfi::strip.

◆ stripByStripAdd() [2/2]

void ThreeThresholdAlgorithm::stripByStripAdd	(	State &	state,
		uint16_t	strip,
		uint8_t	adc,
		std::vector< SiStripCluster > &	out
	)		const

overridevirtual

Reimplemented from StripClusterizerAlgorithm.

Definition at line 139 of file ThreeThresholdAlgorithm.cc.

                                                                                     {
   if (candidateEnded(state, strip))
     endCandidate(state, out);
   addToCandidate(state, SiStripDigi(strip, adc));
 }

References ecalMGPA::adc(), addToCandidate(), candidateEnded(), endCandidate(), MillePedeFileConverter_cfg::out, and digitizers_cfi::strip.

◆ stripByStripBegin()

StripClusterizerAlgorithm::Det ThreeThresholdAlgorithm::stripByStripBegin ( uint32_t id ) const

overridevirtual

Implements StripClusterizerAlgorithm.

Definition at line 137 of file ThreeThresholdAlgorithm.cc.

137 { return findDetId(id); }

References StripClusterizerAlgorithm::findDetId().

◆ stripByStripEnd() [1/2]

void ThreeThresholdAlgorithm::stripByStripEnd	(	State &	state,
		output_t::TSFastFiller &	out
	)		const

inlineoverridevirtual

Reimplemented from StripClusterizerAlgorithm.

Definition at line 27 of file ThreeThresholdAlgorithm.h.

27 { endCandidate(state, out); }

References endCandidate(), and MillePedeFileConverter_cfg::out.

◆ stripByStripEnd() [2/2]

void ThreeThresholdAlgorithm::stripByStripEnd	(	State &	state,
		std::vector< SiStripCluster > &	out
	)		const

overridevirtual

Reimplemented from StripClusterizerAlgorithm.

Definition at line 148 of file ThreeThresholdAlgorithm.cc.

                                                                                                 {
   endCandidate(state, out);
 }

References endCandidate(), and MillePedeFileConverter_cfg::out.

Friends And Related Function Documentation

◆ StripClusterizerAlgorithmFactory

friend class StripClusterizerAlgorithmFactory

friend

Definition at line 7 of file ThreeThresholdAlgorithm.h.

Member Data Documentation

◆ ChannelThreshold

float ThreeThresholdAlgorithm::ChannelThreshold

private

Definition at line 61 of file ThreeThresholdAlgorithm.h.

Referenced by addToCandidate().

◆ ClusterThresholdSquared

float ThreeThresholdAlgorithm::ClusterThresholdSquared

private

Definition at line 61 of file ThreeThresholdAlgorithm.h.

Referenced by candidateAccepted().

◆ MaxAdjacentBad

uint8_t ThreeThresholdAlgorithm::MaxAdjacentBad

private

Definition at line 62 of file ThreeThresholdAlgorithm.h.

Referenced by appendBadNeighbors().

◆ MaxSequentialBad

uint8_t ThreeThresholdAlgorithm::MaxSequentialBad

private

Definition at line 62 of file ThreeThresholdAlgorithm.h.

Referenced by candidateEnded().

◆ MaxSequentialHoles

uint8_t ThreeThresholdAlgorithm::MaxSequentialHoles

private

Definition at line 62 of file ThreeThresholdAlgorithm.h.

Referenced by candidateEnded().

◆ minGoodCharge

float ThreeThresholdAlgorithm::minGoodCharge

private

Definition at line 64 of file ThreeThresholdAlgorithm.h.

Referenced by endCandidate().

◆ RemoveApvShots

bool ThreeThresholdAlgorithm::RemoveApvShots

private

Definition at line 63 of file ThreeThresholdAlgorithm.h.

Referenced by clusterizeDetUnit_().

◆ SeedThreshold

float ThreeThresholdAlgorithm::SeedThreshold

private

Definition at line 61 of file ThreeThresholdAlgorithm.h.

Referenced by addToCandidate().

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Det

◆ State

Constructor & Destructor Documentation

◆ ThreeThresholdAlgorithm()

Member Function Documentation

◆ addToCandidate() [1/2]

◆ addToCandidate() [2/2]

◆ appendBadNeighbors()

◆ applyGains()

◆ candidateAccepted()

◆ candidateEnded()

◆ clearCandidate()

◆ clusterizeDetUnit() [1/2]

◆ clusterizeDetUnit() [2/2]

◆ clusterizeDetUnit_() [1/2]

◆ clusterizeDetUnit_() [2/2]

◆ endCandidate()

◆ firstStrip()

◆ stripByStripAdd() [1/2]

◆ stripByStripAdd() [2/2]

◆ stripByStripBegin()

◆ stripByStripEnd() [1/2]

◆ stripByStripEnd() [2/2]

Friends And Related Function Documentation

◆ StripClusterizerAlgorithmFactory

Member Data Documentation

◆ ChannelThreshold

◆ ClusterThresholdSquared

◆ MaxAdjacentBad

◆ MaxSequentialBad

◆ MaxSequentialHoles

◆ minGoodCharge

◆ RemoveApvShots

◆ SeedThreshold