CMS 3D CMS Logo
List of all members | Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends
ThreeThresholdAlgorithm Class Referencefinal

#include <ThreeThresholdAlgorithm.h>

Inheritance diagram for ThreeThresholdAlgorithm:
StripClusterizerAlgorithm

Public Types

using Det = StripClusterizerAlgorithm::Det
 
using State = StripClusterizerAlgorithm::State
 
- Public Types inherited from StripClusterizerAlgorithm
using Det = SiStripClusterizerConditions::Det
 
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
 
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
void clusterize (const edm::DetSetVector< SiStripDigi > &, output_t &) const
 
void clusterize (const edmNew::DetSetVector< SiStripDigi > &, output_t &) const
 
const SiStripClusterizerConditions & conditions () const
 
void initialize (const edm::EventSetup &es)
 
Det const & stripByStripBegin (uint32_t id) const
 
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 (const edm::ESGetToken< SiStripClusterizerConditions, SiStripClusterizerConditionsRcd > &, float, float, float, unsigned, unsigned, unsigned, 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

- Protected Member Functions inherited from StripClusterizerAlgorithm
 StripClusterizerAlgorithm (const edm::ESGetToken< SiStripClusterizerConditions, SiStripClusterizerConditionsRcd > &conditionsToken)
 

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 ( const edm::ESGetToken< SiStripClusterizerConditions, SiStripClusterizerConditionsRcd > &  conditionsToken,
float  chan,
float  seed,
float  cluster,
unsigned  holes,
unsigned  bad,
unsigned  adj,
bool  removeApvShots,
float  minGoodCharge 
)
private

Definition at line 10 of file ThreeThresholdAlgorithm.cc.

20  : StripClusterizerAlgorithm(conditionsToken),
21  ChannelThreshold(chan),
22  SeedThreshold(seed),
23  ClusterThresholdSquared(cluster * cluster),
24  MaxSequentialHoles(holes),
25  MaxSequentialBad(bad),
26  MaxAdjacentBad(adj),
27  RemoveApvShots(removeApvShots),
28  minGoodCharge(minGoodCharge) {}

Member Function Documentation

◆ addToCandidate() [1/2]

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

Definition at line 54 of file ThreeThresholdAlgorithm.h.

54 { 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 71 of file ThreeThresholdAlgorithm.cc.

71  {
72  float Noise = state.det().noise(strip);
73  if (adc < static_cast<uint8_t>(Noise * ChannelThreshold) || state.det().bad(strip))
74  return;
75 
76  if (state.candidateLacksSeed)
77  state.candidateLacksSeed = adc < static_cast<uint8_t>(Noise * SeedThreshold);
78  if (state.ADCs.empty())
79  state.lastStrip = strip - 1; // begin candidate
80  while (++state.lastStrip < strip)
81  state.ADCs.push_back(0); // pad holes
82 
83  state.ADCs.push_back(adc);
84  state.noiseSquared += Noise * Noise;
85 }

References ecalLiteDTU::adc(), ChannelThreshold, DigiDM_cff::Noise, SeedThreshold, and digitizers_cfi::strip.

◆ appendBadNeighbors()

void ThreeThresholdAlgorithm::appendBadNeighbors ( State &  state) const
inlineprivate

Definition at line 119 of file ThreeThresholdAlgorithm.cc.

119  {
120  uint8_t max = MaxAdjacentBad;
121  while (0 < max--) {
122  if (state.det().bad(firstStrip(state) - 1)) {
123  state.ADCs.insert(state.ADCs.begin(), 0);
124  }
125  if (state.det().bad(state.lastStrip + 1)) {
126  state.ADCs.push_back(0);
127  state.lastStrip++;
128  }
129  }
130 }

References firstStrip(), SiStripPI::max, and MaxAdjacentBad.

Referenced by endCandidate().

◆ applyGains()

void ThreeThresholdAlgorithm::applyGains ( State &  state) const
inlineprivate

Definition at line 106 of file ThreeThresholdAlgorithm.cc.

106  {
107  uint16_t strip = firstStrip(state);
108  for (auto& adc : state.ADCs) {
109 #ifdef EDM_ML_DEBUG
110  // if(adc > 255) throw InvalidChargeException( SiStripDigi(strip,adc) );
111 #endif
112  // if(adc > 253) continue; //saturated, do not scale
113  auto charge = int(float(adc) * state.det().weight(strip++) + 0.5f); //adding 0.5 turns truncation into rounding
114  if (adc < 254)
115  adc = (charge > 1022 ? 255 : (charge > 253 ? 254 : charge));
116  }
117 }

References ecalLiteDTU::adc(), ALCARECOTkAlJpsiMuMu_cff::charge, firstStrip(), createfilelist::int, and digitizers_cfi::strip.

Referenced by endCandidate().

◆ candidateAccepted()

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

Definition at line 100 of file ThreeThresholdAlgorithm.cc.

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

References ClusterThresholdSquared, createfilelist::int, and funct::pow().

Referenced by endCandidate().

◆ candidateEnded()

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

Definition at line 61 of file ThreeThresholdAlgorithm.cc.

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

References MaxSequentialBad, and MaxSequentialHoles.

Referenced by clusterizeDetUnit_(), and stripByStripAdd().

◆ clearCandidate()

void ThreeThresholdAlgorithm::clearCandidate ( State &  state) const
inlineprivate

Definition at line 49 of file ThreeThresholdAlgorithm.h.

49  {
50  state.candidateLacksSeed = true;
51  state.noiseSquared = 0;
52  state.ADCs.clear();
53  }

Referenced by endCandidate().

◆ clusterizeDetUnit() [1/2]

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

Reimplemented from StripClusterizerAlgorithm.

Definition at line 132 of file ThreeThresholdAlgorithm.cc.

133  {
134  clusterizeDetUnit_(digis, output);
135 }

References clusterizeDetUnit_(), and convertSQLitetoXML_cfg::output.

◆ clusterizeDetUnit() [2/2]

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

Reimplemented from StripClusterizerAlgorithm.

Definition at line 136 of file ThreeThresholdAlgorithm.cc.

137  {
138  clusterizeDetUnit_(digis, output);
139 }

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.

31  {
32  const auto& cond = conditions();
33  if (cond.isModuleBad(digis.detId()))
34  return;
35 
36  auto const& det = cond.findDetId(digis.detId());
37  if (!det.valid())
38  return;
39 
40 #ifdef EDM_ML_DEBUG
41  if (!cond.isModuleUsable(digis.detId()))
42  edm::LogWarning("ThreeThresholdAlgorithm") << " id " << digis.detId() << " not usable???" << std::endl;
43 #endif
44 
45  typename digiDetSet::const_iterator scan(digis.begin()), end(digis.end());
46 
47  SiStripApvShotCleaner ApvCleaner;
48  if (RemoveApvShots) {
49  ApvCleaner.clean(digis, scan, end);
50  }
51 
52  output.reserve(16);
53  State state(det);
54  while (scan != end) {
55  while (scan != end && !candidateEnded(state, scan->strip()))
56  addToCandidate(state, *scan++);
57  endCandidate(state, output);
58  }
59 }

References addToCandidate(), candidateEnded(), SiStripApvShotCleaner::clean(), StripClusterizerAlgorithm::conditions(), mps_fire::end, endCandidate(), 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 88 of file ThreeThresholdAlgorithm.cc.

88  {
89  if (candidateAccepted(state)) {
90  applyGains(state);
91  if (MaxAdjacentBad > 0)
92  appendBadNeighbors(state);
93  if (minGoodCharge <= 0 ||
94  siStripClusterTools::chargePerCM(state.det().detId, state.ADCs.begin(), state.ADCs.end()) > minGoodCharge)
95  out.push_back(std::move(SiStripCluster(firstStrip(state), state.ADCs.begin(), state.ADCs.end())));
96  }
97  clearCandidate(state);
98 }

References appendBadNeighbors(), applyGains(), candidateAccepted(), siStripClusterTools::chargePerCM(), clearCandidate(), firstStrip(), MaxAdjacentBad, minGoodCharge, eostools::move(), and MillePedeFileConverter_cfg::out.

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

◆ firstStrip()

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

Definition at line 42 of file ThreeThresholdAlgorithm.h.

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

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 19 of file ThreeThresholdAlgorithm.h.

19  {
20  if (candidateEnded(state, strip))
21  endCandidate(state, out);
22  addToCandidate(state, strip, adc);
23  }

References ecalLiteDTU::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 141 of file ThreeThresholdAlgorithm.cc.

144  {
145  if (candidateEnded(state, strip))
146  endCandidate(state, out);
147  addToCandidate(state, SiStripDigi(strip, adc));
148 }

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

◆ stripByStripEnd() [1/2]

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

Reimplemented from StripClusterizerAlgorithm.

Definition at line 25 of file ThreeThresholdAlgorithm.h.

25 { 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 150 of file ThreeThresholdAlgorithm.cc.

150  {
151  endCandidate(state, out);
152 }

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 59 of file ThreeThresholdAlgorithm.h.

Referenced by addToCandidate().

◆ ClusterThresholdSquared

float ThreeThresholdAlgorithm::ClusterThresholdSquared
private

Definition at line 59 of file ThreeThresholdAlgorithm.h.

Referenced by candidateAccepted().

◆ MaxAdjacentBad

uint8_t ThreeThresholdAlgorithm::MaxAdjacentBad
private

Definition at line 60 of file ThreeThresholdAlgorithm.h.

Referenced by appendBadNeighbors(), and endCandidate().

◆ MaxSequentialBad

uint8_t ThreeThresholdAlgorithm::MaxSequentialBad
private

Definition at line 60 of file ThreeThresholdAlgorithm.h.

Referenced by candidateEnded().

◆ MaxSequentialHoles

uint8_t ThreeThresholdAlgorithm::MaxSequentialHoles
private

Definition at line 60 of file ThreeThresholdAlgorithm.h.

Referenced by candidateEnded().

◆ minGoodCharge

float ThreeThresholdAlgorithm::minGoodCharge
private

Definition at line 62 of file ThreeThresholdAlgorithm.h.

Referenced by endCandidate().

◆ RemoveApvShots

bool ThreeThresholdAlgorithm::RemoveApvShots
private

Definition at line 61 of file ThreeThresholdAlgorithm.h.

Referenced by clusterizeDetUnit_().

◆ SeedThreshold

float ThreeThresholdAlgorithm::SeedThreshold
private

Definition at line 59 of file ThreeThresholdAlgorithm.h.

Referenced by addToCandidate().

StripClusterizerAlgorithm::StripClusterizerAlgorithm
StripClusterizerAlgorithm(const edm::ESGetToken< SiStripClusterizerConditions, SiStripClusterizerConditionsRcd > &conditionsToken)
Definition: StripClusterizerAlgorithm.h:60
ThreeThresholdAlgorithm::MaxAdjacentBad
uint8_t MaxAdjacentBad
Definition: ThreeThresholdAlgorithm.h:60
ThreeThresholdAlgorithm::addToCandidate
void addToCandidate(State &state, const SiStripDigi &digi) const
Definition: ThreeThresholdAlgorithm.h:54
ThreeThresholdAlgorithm::candidateAccepted
bool candidateAccepted(State const &state) const
Definition: ThreeThresholdAlgorithm.cc:100
ThreeThresholdAlgorithm::endCandidate
void endCandidate(State &state, T &) const
Definition: ThreeThresholdAlgorithm.cc:88
ThreeThresholdAlgorithm::candidateEnded
bool candidateEnded(State const &state, const uint16_t &) const
Definition: ThreeThresholdAlgorithm.cc:61
convertSQLitetoXML_cfg.output
output
Definition: convertSQLitetoXML_cfg.py:72
digitizers_cfi.strip
strip
Definition: digitizers_cfi.py:19
siStripClusterTools::chargePerCM
float chargePerCM(DetId detid, Iter a, Iter b)
Definition: SiStripClusterTools.h:29
ThreeThresholdAlgorithm::minGoodCharge
float minGoodCharge
Definition: ThreeThresholdAlgorithm.h:62
ThreeThresholdAlgorithm::appendBadNeighbors
void appendBadNeighbors(State &state) const
Definition: ThreeThresholdAlgorithm.cc:119
edm::LogWarning
Log< level::Warning, false > LogWarning
Definition: MessageLogger.h:122
ecalLiteDTU::adc
constexpr int adc(sample_type sample)
get the ADC sample (12 bits)
Definition: EcalLiteDTUSample.h:12
ThreeThresholdAlgorithm::ClusterThresholdSquared
float ClusterThresholdSquared
Definition: ThreeThresholdAlgorithm.h:59
fileCollector.seed
seed
Definition: fileCollector.py:127
ThreeThresholdAlgorithm::firstStrip
uint16_t firstStrip(State const &state) const
Definition: ThreeThresholdAlgorithm.h:42
ThreeThresholdAlgorithm::SeedThreshold
float SeedThreshold
Definition: ThreeThresholdAlgorithm.h:59
mps_fire.end
end
Definition: mps_fire.py:242
SiStripDigi::adc
const uint16_t & adc() const
Definition: SiStripDigi.h:34
ThreeThresholdAlgorithm::applyGains
void applyGains(State &state) const
Definition: ThreeThresholdAlgorithm.cc:106
ThreeThresholdAlgorithm::RemoveApvShots
bool RemoveApvShots
Definition: ThreeThresholdAlgorithm.h:61
ThreeThresholdAlgorithm::MaxSequentialBad
uint8_t MaxSequentialBad
Definition: ThreeThresholdAlgorithm.h:60
ThreeThresholdAlgorithm::clusterizeDetUnit_
void clusterizeDetUnit_(const T &, output_t::TSFastFiller &) const
SiStripApvShotCleaner
Definition: SiStripApvShotCleaner.h:11
ALCARECOTkAlJpsiMuMu_cff.charge
charge
Definition: ALCARECOTkAlJpsiMuMu_cff.py:47
cond
Definition: plugin.cc:23
ThreeThresholdAlgorithm::clearCandidate
void clearCandidate(State &state) const
Definition: ThreeThresholdAlgorithm.h:49
StripClusterizerAlgorithm::conditions
const SiStripClusterizerConditions & conditions() const
Definition: StripClusterizerAlgorithm.h:36
SiStripDigi::strip
const uint16_t & strip() const
Definition: SiStripDigi.h:33
SiStripPI::max
Definition: SiStripPayloadInspectorHelper.h:169
State
State
Definition: RPixErrorChecker.h:15
createfilelist.int
int
Definition: createfilelist.py:10
ThreeThresholdAlgorithm::ChannelThreshold
float ChannelThreshold
Definition: ThreeThresholdAlgorithm.h:59
eostools.move
def move(src, dest)
Definition: eostools.py:511
SiStripApvShotCleaner::clean
bool clean(const edmNew::DetSet< SiStripDigi > &in, edmNew::DetSet< SiStripDigi >::const_iterator &scan, edmNew::DetSet< SiStripDigi >::const_iterator &end)
Definition: SiStripApvShotCleaner.h:19
RunInfoPI::state
state
Definition: RunInfoPayloadInspectoHelper.h:16
officialStyle.chan
chan
lumi = TPaveText(lowX+0.38, lowY+0.061, lowX+0.45, lowY+0.161, "NDC") lumi.SetBorderSize( 0 ) lumi....
Definition: officialStyle.py:106
ThreeThresholdAlgorithm::MaxSequentialHoles
uint8_t MaxSequentialHoles
Definition: ThreeThresholdAlgorithm.h:60
MillePedeFileConverter_cfg.out
out
Definition: MillePedeFileConverter_cfg.py:31
funct::pow
Power< A, B >::type pow(const A &a, const B &b)
Definition: Power.h:29
SiStripDigi
A Digi for the silicon strip detector, containing both strip and adc information, and suitable for st...
Definition: SiStripDigi.h:12
DigiDM_cff.Noise
Noise
Definition: DigiDM_cff.py:38
SiStripCluster
Definition: SiStripCluster.h:9
Generated for CMSSW Reference Manual by doxygen 1.8.16