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
typedef edmNew::DetSetVector < SiStripCluster >	output_t

Public Member Functions
void	addFed (State &state, sistrip::FEDZSChannelUnpacker &unpacker, uint16_t ipair, std::vector< SiStripCluster > &out) const
void	addFed (State &state, sistrip::FEDZSChannelUnpacker &unpacker, uint16_t ipair, output_t::TSFastFiller &out) const override
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
Det	stripByStripBegin (uint32_t id) const
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
virtual void	addFed (Det const &det, sistrip::FEDZSChannelUnpacker &unpacker, uint16_t ipair, std::vector< SiStripCluster > &out) const
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 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 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

using ThreeThresholdAlgorithm::Det = StripClusterizerAlgorithm::Det

Definition at line 13 of file ThreeThresholdAlgorithm.h.

using ThreeThresholdAlgorithm::State = StripClusterizerAlgorithm::State

Definition at line 12 of file ThreeThresholdAlgorithm.h.

Constructor & Destructor Documentation

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 11 of file ThreeThresholdAlgorithm.cc.

References StripClusterizerAlgorithm::qualityLabel.

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

Member Function Documentation

void ThreeThresholdAlgorithm::addFed ( State &  state, sistrip::FEDZSChannelUnpacker &  unpacker, uint16_t  ipair, std::vector< SiStripCluster > &  out  ) const

inline

Definition at line 23 of file ThreeThresholdAlgorithm.h.

References sistrip::FEDZSChannelUnpacker::adc(), sistrip::FEDZSChannelUnpacker::hasData(), GenerateHcalLaserBadRunList::out, sistrip::FEDZSChannelUnpacker::sampleNumber(), and stripByStripAdd().

                                                                                                                           {
    while (unpacker.hasData()) {
      stripByStripAdd(state,unpacker.sampleNumber()+ipair*256,unpacker.adc(),out);
      unpacker++;
    }
  }

void ThreeThresholdAlgorithm::addFed ( State &  state, sistrip::FEDZSChannelUnpacker &  unpacker, uint16_t  ipair, output_t::TSFastFiller &  out  ) const

inlineoverridevirtual

Reimplemented from StripClusterizerAlgorithm.

Definition at line 31 of file ThreeThresholdAlgorithm.h.

References sistrip::FEDZSChannelUnpacker::adc(), sistrip::FEDZSChannelUnpacker::hasData(), GenerateHcalLaserBadRunList::out, sistrip::FEDZSChannelUnpacker::sampleNumber(), and stripByStripAdd().

                                                                                                                                {
    while (unpacker.hasData()) {
      stripByStripAdd(state, unpacker.sampleNumber()+ipair*256,unpacker.adc(),out);
      unpacker++;
    }
  }

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

inlineprivate

Definition at line 62 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 65 of file ThreeThresholdAlgorithm.cc.

References StripClusterizerAlgorithm::State::ADCs, StripClusterizerAlgorithm::Det::bad(), StripClusterizerAlgorithm::State::candidateLacksSeed, ChannelThreshold, StripClusterizerAlgorithm::State::det(), StripClusterizerAlgorithm::State::lastStrip, StripClusterizerAlgorithm::Det::noise(), StripClusterizerAlgorithm::State::noiseSquared, and SeedThreshold.

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

References StripClusterizerAlgorithm::State::ADCs, StripClusterizerAlgorithm::Det::bad(), StripClusterizerAlgorithm::State::det(), firstStrip(), StripClusterizerAlgorithm::State::lastStrip, bookConverter::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 101 of file ThreeThresholdAlgorithm.cc.

References ecalMGPA::adc(), StripClusterizerAlgorithm::State::ADCs, RecoTauCleanerPlugins::charge, StripClusterizerAlgorithm::State::det(), firstStrip(), and StripClusterizerAlgorithm::Det::gain().

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().gain(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 93 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 52 of file ThreeThresholdAlgorithm.cc.

References StripClusterizerAlgorithm::State::ADCs, StripClusterizerAlgorithm::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 61 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

Implements StripClusterizerAlgorithm.

Definition at line 125 of file ThreeThresholdAlgorithm.cc.

References clusterizeDetUnit_().

{clusterizeDetUnit_(digis,output);}

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

overridevirtual

Implements StripClusterizerAlgorithm.

Definition at line 126 of file ThreeThresholdAlgorithm.cc.

References clusterizeDetUnit_().

{clusterizeDetUnit_(digis,output);}

template<class digiDetSet >

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

inline

Definition at line 21 of file ThreeThresholdAlgorithm.cc.

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

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

template<class T >

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

private

Referenced by clusterizeDetUnit().

template<class T >

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

inlineprivate

Definition at line 81 of file ThreeThresholdAlgorithm.cc.

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

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

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

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

inlineprivate

Definition at line 55 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 136 of file ThreeThresholdAlgorithm.cc.

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

Referenced by addFed().

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

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

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

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

virtual

Implements StripClusterizerAlgorithm.

Definition at line 130 of file ThreeThresholdAlgorithm.cc.

References StripClusterizerAlgorithm::findDetId().

                                     {
  return findDetId( id );
}

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

overridevirtual

Reimplemented from StripClusterizerAlgorithm.

Definition at line 143 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 43 of file ThreeThresholdAlgorithm.h.

References endCandidate().

{ endCandidate(state,out);}

Friends And Related Function Documentation

friend class StripClusterizerAlgorithmFactory

friend

Definition at line 8 of file ThreeThresholdAlgorithm.h.

Member Data Documentation

float ThreeThresholdAlgorithm::ChannelThreshold

private

Definition at line 67 of file ThreeThresholdAlgorithm.h.

Referenced by addToCandidate().

float ThreeThresholdAlgorithm::ClusterThresholdSquared

private

Definition at line 67 of file ThreeThresholdAlgorithm.h.

Referenced by candidateAccepted().

uint8_t ThreeThresholdAlgorithm::MaxAdjacentBad

private

Definition at line 68 of file ThreeThresholdAlgorithm.h.

Referenced by appendBadNeighbors().

uint8_t ThreeThresholdAlgorithm::MaxSequentialBad

private

Definition at line 68 of file ThreeThresholdAlgorithm.h.

Referenced by candidateEnded().

uint8_t ThreeThresholdAlgorithm::MaxSequentialHoles

private

Definition at line 68 of file ThreeThresholdAlgorithm.h.

Referenced by candidateEnded().

float ThreeThresholdAlgorithm::minGoodCharge

private

Definition at line 70 of file ThreeThresholdAlgorithm.h.

Referenced by endCandidate().

bool ThreeThresholdAlgorithm::RemoveApvShots

private

Definition at line 69 of file ThreeThresholdAlgorithm.h.

Referenced by clusterizeDetUnit_().

float ThreeThresholdAlgorithm::SeedThreshold

private

Definition at line 67 of file ThreeThresholdAlgorithm.h.

Referenced by addToCandidate().