ThreeThresholdAlgorithm Class Reference

#include <ThreeThresholdAlgorithm.h>

Inheritance diagram for ThreeThresholdAlgorithm:

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
template<class digiDetSet >
void	clusterizeDetUnit_ (const digiDetSet &digis, output_t::TSFastFiller &output) const
void	stripByStripAdd (State &state, uint16_t strip, uint8_t adc, std::vector< SiStripCluster > &out) const override
void	stripByStripAdd (State &state, uint16_t strip, uint8_t adc, output_t::TSFastFiller &out) const override
void	stripByStripEnd (State &state, std::vector< SiStripCluster > &out) const override
void	stripByStripEnd (State &state, output_t::TSFastFiller &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 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

using ThreeThresholdAlgorithm::Det = StripClusterizerAlgorithm::Det

Definition at line 11 of file ThreeThresholdAlgorithm.h.

using ThreeThresholdAlgorithm::State = StripClusterizerAlgorithm::State

Definition at line 10 of file ThreeThresholdAlgorithm.h.

Constructor & Destructor Documentation

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.

    : StripClusterizerAlgorithm(conditionsToken),
      ChannelThreshold(chan),
      SeedThreshold(seed),
      ClusterThresholdSquared(cluster * cluster),
      MaxSequentialHoles(holes),
      MaxSequentialBad(bad),
      MaxAdjacentBad(adj),
      RemoveApvShots(removeApvShots),
      minGoodCharge(minGoodCharge) {}

Member Function Documentation

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

inlineprivate

Definition at line 54 of file ThreeThresholdAlgorithm.h.

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

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

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

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

inlineprivate

Definition at line 71 of file ThreeThresholdAlgorithm.cc.

References StripClusterizerAlgorithm::State::ADCs, SiStripClusterizerConditions::Det::bad(), StripClusterizerAlgorithm::State::candidateLacksSeed, ChannelThreshold, StripClusterizerAlgorithm::State::det(), StripClusterizerAlgorithm::State::lastStrip, SiStripClusterizerConditions::Det::noise(), SiStripSimParameters_cfi::Noise, StripClusterizerAlgorithm::State::noiseSquared, SeedThreshold, and gpuVertexFinder::while().

                                                                                                   {
  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;
}

void ThreeThresholdAlgorithm::appendBadNeighbors ( State &  state ) const

inlineprivate

Definition at line 119 of file ThreeThresholdAlgorithm.cc.

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

Referenced by endCandidate().

                                                                          {
  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++;
    }
  }
}

void ThreeThresholdAlgorithm::applyGains ( State &  state ) const

inlineprivate

Definition at line 106 of file ThreeThresholdAlgorithm.cc.

References gpuClustering::adc, StripClusterizerAlgorithm::State::ADCs, RecoTauCleanerPlugins::charge, StripClusterizerAlgorithm::State::det(), firstStrip(), digitizers_cfi::strip, and SiStripClusterizerConditions::Det::weight().

Referenced by endCandidate().

                                                                  {
  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().weight(strip++) + 0.5f);  //adding 0.5 turns truncation into rounding
    if (adc < 254)
      adc = (charge > 1022 ? 255 : (charge > 253 ? 254 : charge));
  }
}

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

inlineprivate

Definition at line 100 of file ThreeThresholdAlgorithm.cc.

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

Referenced by endCandidate().

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

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

inlineprivate

Definition at line 61 of file ThreeThresholdAlgorithm.cc.

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

Referenced by clusterizeDetUnit_(), and stripByStripAdd().

                                                                                                       {
  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)
           ));
}

void ThreeThresholdAlgorithm::clearCandidate ( State &  state ) const

inlineprivate

Definition at line 49 of file ThreeThresholdAlgorithm.h.

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

Referenced by endCandidate().

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

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.

References clusterizeDetUnit_().

                                                                                    {
  clusterizeDetUnit_(digis, output);
}

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.

References clusterizeDetUnit_().

                                                                                    {
  clusterizeDetUnit_(digis, output);
}

template<class T >

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

private

Referenced by clusterizeDetUnit().

template<class digiDetSet >

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

inline

Definition at line 31 of file ThreeThresholdAlgorithm.cc.

References addToCandidate(), candidateEnded(), SiStripApvShotCleaner::clean(), StripClusterizerAlgorithm::conditions(), dataset::end, endCandidate(), RemoveApvShots, and edmNew::DetSetVector< T >::TSFastFiller::reserve().

                                                                                                                   {
  const auto& cond = conditions();
  if (cond.isModuleBad(digis.detId()))
    return;

  auto const& det = cond.findDetId(digis.detId());
  if (!det.valid())
    return;

#ifdef EDM_ML_DEBUG
  if (!cond.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);
  }

  output.reserve(16);
  State state(det);
  while (scan != end) {
    while (scan != end && !candidateEnded(state, scan->strip()))
      addToCandidate(state, *scan++);
    endCandidate(state, output);
  }
}

template<class T >

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

inlineprivate

Definition at line 88 of file ThreeThresholdAlgorithm.cc.

References StripClusterizerAlgorithm::State::ADCs, appendBadNeighbors(), applyGains(), candidateAccepted(), siStripClusterTools::chargePerCM(), clearCandidate(), StripClusterizerAlgorithm::State::det(), SiStripClusterizerConditions::Det::detId, firstStrip(), MaxAdjacentBad, minGoodCharge, and eostools::move().

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

                                                                            {
  if (candidateAccepted(state)) {
    applyGains(state);
    if (MaxAdjacentBad > 0)
      appendBadNeighbors(state);
    if (minGoodCharge <= 0 ||
        siStripClusterTools::chargePerCM(state.det().detId, state.ADCs.begin(), state.ADCs.end()) > minGoodCharge)
      out.push_back(std::move(SiStripCluster(firstStrip(state), state.ADCs.begin(), state.ADCs.end())));
  }
  clearCandidate(state);
}

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

inlineprivate

Definition at line 42 of file ThreeThresholdAlgorithm.h.

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

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

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

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.

References addToCandidate(), candidateEnded(), and endCandidate().

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

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.

References addToCandidate(), candidateEnded(), and endCandidate().

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

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

overridevirtual

Reimplemented from StripClusterizerAlgorithm.

Definition at line 150 of file ThreeThresholdAlgorithm.cc.

References endCandidate().

                                                                                                {
  endCandidate(state, out);
}

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

inlineoverridevirtual

Reimplemented from StripClusterizerAlgorithm.

Definition at line 25 of file ThreeThresholdAlgorithm.h.

References endCandidate().

{ endCandidate(state, out); }

Friends And Related Function Documentation

friend class StripClusterizerAlgorithmFactory

friend

Definition at line 7 of file ThreeThresholdAlgorithm.h.

Member Data Documentation

float ThreeThresholdAlgorithm::ChannelThreshold

private

Definition at line 59 of file ThreeThresholdAlgorithm.h.

Referenced by addToCandidate().

float ThreeThresholdAlgorithm::ClusterThresholdSquared

private

Definition at line 59 of file ThreeThresholdAlgorithm.h.

Referenced by candidateAccepted().

uint8_t ThreeThresholdAlgorithm::MaxAdjacentBad

private

Definition at line 60 of file ThreeThresholdAlgorithm.h.

Referenced by appendBadNeighbors(), and endCandidate().

uint8_t ThreeThresholdAlgorithm::MaxSequentialBad

private

Definition at line 60 of file ThreeThresholdAlgorithm.h.

Referenced by candidateEnded().

uint8_t ThreeThresholdAlgorithm::MaxSequentialHoles

private

Definition at line 60 of file ThreeThresholdAlgorithm.h.

Referenced by candidateEnded().

float ThreeThresholdAlgorithm::minGoodCharge

private

Definition at line 62 of file ThreeThresholdAlgorithm.h.

Referenced by endCandidate().

bool ThreeThresholdAlgorithm::RemoveApvShots

private

Definition at line 61 of file ThreeThresholdAlgorithm.h.

Referenced by clusterizeDetUnit_().

float ThreeThresholdAlgorithm::SeedThreshold

private

Definition at line 59 of file ThreeThresholdAlgorithm.h.

Referenced by addToCandidate().