ThreeThresholdAlgorithm Class Reference

#include <ThreeThresholdAlgorithm.h>

Inheritance diagram for ThreeThresholdAlgorithm:

Public Member Functions
void	addFed (sistrip::FEDZSChannelUnpacker &unpacker, uint16_t ipair, std::vector< SiStripCluster > &out)
void	addFed (sistrip::FEDZSChannelUnpacker &unpacker, uint16_t ipair, output_t::FastFiller &out) override
void	cleanState () override
void	clusterizeDetUnit (const edm::DetSet< SiStripDigi > &, output_t::FastFiller &)
void	clusterizeDetUnit (const edmNew::DetSet< SiStripDigi > &, output_t::FastFiller &)
template<class digiDetSet >
void	clusterizeDetUnit_ (const digiDetSet &digis, output_t::FastFiller &output)
void	stripByStripAdd (uint16_t strip, uint8_t adc, std::vector< SiStripCluster > &out)
void	stripByStripAdd (uint16_t strip, uint8_t adc, output_t::FastFiller &out) override
bool	stripByStripBegin (uint32_t id)
void	stripByStripEnd (std::vector< SiStripCluster > &out)
void	stripByStripEnd (output_t::FastFiller &out) 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 &)
void	clusterize (const edmNew::DetSetVector< SiStripDigi > &, output_t &)
std::vector< const FedChannelConnection * > const &	currentConnection () const
virtual void	initialize (const edm::EventSetup &)
virtual	~StripClusterizerAlgorithm ()

Private Member Functions
void	addToCandidate (const SiStripDigi &digi)
void	addToCandidate (uint16_t strip, uint8_t adc)
void	appendBadNeighbors ()
void	applyGains ()
bool	candidateAccepted () const
bool	candidateEnded (const uint16_t &) const
void	clearCandidate ()
template<class T >
void	clusterizeDetUnit_ (const T &, output_t::FastFiller &)
template<class T >
void	endCandidate (T &)
uint16_t	firstStrip () const
	ThreeThresholdAlgorithm (float, float, float, unsigned, unsigned, unsigned, std::string qualityLabel, bool setDetId, bool removeApvShots, float minGoodCharge)

Private Attributes
std::vector< uint8_t >	ADCs
SiStripApvShotCleaner	ApvCleaner
bool	candidateLacksSeed
float	ChannelThreshold
float	ClusterThresholdSquared
uint16_t	lastStrip
uint8_t	MaxAdjacentBad
uint8_t	MaxSequentialBad
uint8_t	MaxSequentialHoles
float	minGoodCharge
float	noiseSquared
bool	RemoveApvShots
float	SeedThreshold

Friends
class	StripClusterizerAlgorithmFactory

Additional Inherited Members
Public Types inherited from StripClusterizerAlgorithm
typedef edmNew::DetSetVector < SiStripCluster >	output_t
Protected Member Functions inherited from StripClusterizerAlgorithm
bool	allBadBetween (uint16_t L, const uint16_t &R) const
bool	bad (const uint16_t &strip) const
uint32_t	currentId ()
float	gain (const uint16_t &strip) const
bool	isModuleBad (const uint32_t &id) const
bool	isModuleUsable (const uint32_t &id) const
float	noise (const uint16_t &strip) const
bool	setDetId (const uint32_t)
	StripClusterizerAlgorithm ()
Protected Attributes inherited from StripClusterizerAlgorithm
bool	_setDetId
std::string	qualityLabel

Detailed Description

Definition at line 6 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  setDetId, bool  removeApvShots, float  minGoodCharge  )

private

Definition at line 11 of file ThreeThresholdAlgorithm.cc.

References StripClusterizerAlgorithm::_setDetId, ADCs, lastStrip, StripClusterizerAlgorithm::qualityLabel, and StripClusterizerAlgorithm::setDetId().

  : ChannelThreshold( chan ), SeedThreshold( seed ), ClusterThresholdSquared( cluster*cluster ),
    MaxSequentialHoles( holes ), MaxSequentialBad( bad ), MaxAdjacentBad( adj ), RemoveApvShots(removeApvShots), minGoodCharge(minGoodCharge) {
  _setDetId=setDetId;
  qualityLabel = (qL);
  ADCs.reserve(128);

  // this has to be initialized before the first call to candidateEnded()
  // and this is probably a bad place to initialize it
  lastStrip = 0;
}

Member Function Documentation

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

inlinevirtual

Reimplemented from StripClusterizerAlgorithm.

Definition at line 20 of file ThreeThresholdAlgorithm.h.

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

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

void ThreeThresholdAlgorithm::addFed ( sistrip::FEDZSChannelUnpacker &  unpacker, uint16_t  ipair, output_t::FastFiller &  out  )

inlineoverridevirtual

Reimplemented from StripClusterizerAlgorithm.

Definition at line 28 of file ThreeThresholdAlgorithm.h.

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

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

void ThreeThresholdAlgorithm::addToCandidate ( const SiStripDigi &  digi )

inlineprivate

Definition at line 65 of file ThreeThresholdAlgorithm.h.

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

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

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

void ThreeThresholdAlgorithm::addToCandidate ( uint16_t  strip, uint8_t  adc  )

inlineprivate

Definition at line 68 of file ThreeThresholdAlgorithm.cc.

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

                                            { 
  float Noise = noise( strip );
  if(  adc < static_cast<uint8_t>( Noise * ChannelThreshold) || bad(strip) )
    return;

  if(candidateLacksSeed) candidateLacksSeed  =  adc < static_cast<uint8_t>( Noise * SeedThreshold);
  if(ADCs.empty()) lastStrip = strip - 1; // begin candidate
  while( ++lastStrip < strip ) ADCs.push_back(0); // pad holes

  ADCs.push_back( adc );
  noiseSquared += Noise*Noise;
}

void ThreeThresholdAlgorithm::appendBadNeighbors ( )

inlineprivate

Definition at line 119 of file ThreeThresholdAlgorithm.cc.

References ADCs, StripClusterizerAlgorithm::bad(), firstStrip(), lastStrip, bookConverter::max, and MaxAdjacentBad.

Referenced by endCandidate().

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

void ThreeThresholdAlgorithm::applyGains ( )

inlineprivate

Definition at line 104 of file ThreeThresholdAlgorithm.cc.

References ecalMGPA::adc(), ADCs, RecoTauCleanerPlugins::charge, f, firstStrip(), and StripClusterizerAlgorithm::gain().

Referenced by endCandidate().

             {
  uint16_t strip = firstStrip();
  for( auto &  adc :  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)/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 ( ) const

inlineprivate

Definition at line 96 of file ThreeThresholdAlgorithm.cc.

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

Referenced by endCandidate().

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

bool ThreeThresholdAlgorithm::candidateEnded ( const uint16_t &  testStrip ) const

inlineprivate

Definition at line 55 of file ThreeThresholdAlgorithm.cc.

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

Referenced by clusterizeDetUnit_(), and stripByStripAdd().

                                                {
  uint16_t holes = testStrip - lastStrip - 1;
  return ( ( (!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 
         !allBadBetween( lastStrip, testStrip ) // not all holes are bad strips)
         )
       );
}

void ThreeThresholdAlgorithm::cleanState ( )

inlineoverridevirtual

Reimplemented from StripClusterizerAlgorithm.

Definition at line 42 of file ThreeThresholdAlgorithm.h.

References clearCandidate().

{clearCandidate();}

void ThreeThresholdAlgorithm::clearCandidate ( )

inlineprivate

Definition at line 64 of file ThreeThresholdAlgorithm.h.

References ADCs, candidateLacksSeed, and noiseSquared.

Referenced by cleanState(), clusterizeDetUnit_(), endCandidate(), and stripByStripBegin().

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

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

virtual

Implements StripClusterizerAlgorithm.

Definition at line 128 of file ThreeThresholdAlgorithm.cc.

References clusterizeDetUnit_().

{clusterizeDetUnit_(digis,output);}

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

virtual

Implements StripClusterizerAlgorithm.

Definition at line 129 of file ThreeThresholdAlgorithm.cc.

References clusterizeDetUnit_().

{clusterizeDetUnit_(digis,output);}

template<class digiDetSet >

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

inline

Definition at line 27 of file ThreeThresholdAlgorithm.cc.

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

                                                                        {
  if(isModuleBad(digis.detId())) return;
  if (!setDetId( digis.detId() )) return;

#ifdef EDM_ML_DEBUG
  if(!isModuleUsable(digis.detId() )) 
    LogWarning("ThreeThresholdAlgorithm") << " id " << digis.detId() << " not usable???" << std::endl;
#endif

  
  typename digiDetSet::const_iterator  
    scan( digis.begin() ), 
    end(  digis.end() );

  if(RemoveApvShots){
    ApvCleaner.clean(digis,scan,end);
  }

  clearCandidate();
  while( scan != end ) {
    while( scan != end  && !candidateEnded( scan->strip() ) ) 
      addToCandidate(*scan++);
    endCandidate(output);
  }
}

template<class T >

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

private

Referenced by clusterizeDetUnit().

template<class T >

void ThreeThresholdAlgorithm::endCandidate ( T &  out )

inlineprivate

Definition at line 84 of file ThreeThresholdAlgorithm.cc.

References ADCs, appendBadNeighbors(), applyGains(), candidateAccepted(), siStripClusterTools::chargePerCM(), clearCandidate(), StripClusterizerAlgorithm::currentId(), firstStrip(), and minGoodCharge.

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

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

uint16_t ThreeThresholdAlgorithm::firstStrip ( ) const

inlineprivate

Definition at line 58 of file ThreeThresholdAlgorithm.h.

References ADCs, and lastStrip.

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

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

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

inlinevirtual

Reimplemented from StripClusterizerAlgorithm.

Definition at line 144 of file ThreeThresholdAlgorithm.cc.

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

Referenced by addFed().

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

void ThreeThresholdAlgorithm::stripByStripAdd ( uint16_t  strip, uint8_t  adc, output_t::FastFiller &  out  )

inlineoverridevirtual

Reimplemented from StripClusterizerAlgorithm.

Definition at line 35 of file ThreeThresholdAlgorithm.h.

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

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

bool ThreeThresholdAlgorithm::stripByStripBegin ( uint32_t  id )

inlinevirtual

Implements StripClusterizerAlgorithm.

Definition at line 133 of file ThreeThresholdAlgorithm.cc.

References assert(), clearCandidate(), StripClusterizerAlgorithm::isModuleUsable(), and StripClusterizerAlgorithm::setDetId().

                               {
  if (!setDetId( id )) return false;
#ifdef EDM_ML_DEBUG
  assert(isModuleUsable( id ));
#endif
  clearCandidate();
  return true;
}

void ThreeThresholdAlgorithm::stripByStripEnd ( std::vector< SiStripCluster > &  out )

inlinevirtual

Reimplemented from StripClusterizerAlgorithm.

Definition at line 151 of file ThreeThresholdAlgorithm.cc.

References endCandidate().

                                                { 
  endCandidate(out);
}

void ThreeThresholdAlgorithm::stripByStripEnd ( output_t::FastFiller &  out )

inlineoverridevirtual

Reimplemented from StripClusterizerAlgorithm.

Definition at line 40 of file ThreeThresholdAlgorithm.h.

References endCandidate().

{ endCandidate(out);}

Friends And Related Function Documentation

friend class StripClusterizerAlgorithmFactory

friend

Definition at line 8 of file ThreeThresholdAlgorithm.h.

Member Data Documentation

std::vector<uint8_t> ThreeThresholdAlgorithm::ADCs

private

Definition at line 52 of file ThreeThresholdAlgorithm.h.

Referenced by addToCandidate(), appendBadNeighbors(), applyGains(), candidateAccepted(), candidateEnded(), clearCandidate(), endCandidate(), firstStrip(), and ThreeThresholdAlgorithm().

SiStripApvShotCleaner ThreeThresholdAlgorithm::ApvCleaner

private

Definition at line 75 of file ThreeThresholdAlgorithm.h.

Referenced by clusterizeDetUnit_().

bool ThreeThresholdAlgorithm::candidateLacksSeed

private

Definition at line 55 of file ThreeThresholdAlgorithm.h.

Referenced by addToCandidate(), candidateAccepted(), and clearCandidate().

float ThreeThresholdAlgorithm::ChannelThreshold

private

Definition at line 70 of file ThreeThresholdAlgorithm.h.

Referenced by addToCandidate().

float ThreeThresholdAlgorithm::ClusterThresholdSquared

private

Definition at line 70 of file ThreeThresholdAlgorithm.h.

Referenced by candidateAccepted().

uint16_t ThreeThresholdAlgorithm::lastStrip

private

Definition at line 53 of file ThreeThresholdAlgorithm.h.

Referenced by addToCandidate(), appendBadNeighbors(), candidateEnded(), firstStrip(), and ThreeThresholdAlgorithm().

uint8_t ThreeThresholdAlgorithm::MaxAdjacentBad

private

Definition at line 71 of file ThreeThresholdAlgorithm.h.

Referenced by appendBadNeighbors().

uint8_t ThreeThresholdAlgorithm::MaxSequentialBad

private

Definition at line 71 of file ThreeThresholdAlgorithm.h.

Referenced by candidateEnded().

uint8_t ThreeThresholdAlgorithm::MaxSequentialHoles

private

Definition at line 71 of file ThreeThresholdAlgorithm.h.

Referenced by candidateEnded().

float ThreeThresholdAlgorithm::minGoodCharge

private

Definition at line 73 of file ThreeThresholdAlgorithm.h.

Referenced by endCandidate().

float ThreeThresholdAlgorithm::noiseSquared

private

Definition at line 54 of file ThreeThresholdAlgorithm.h.

Referenced by addToCandidate(), candidateAccepted(), and clearCandidate().

bool ThreeThresholdAlgorithm::RemoveApvShots

private

Definition at line 72 of file ThreeThresholdAlgorithm.h.

Referenced by clusterizeDetUnit_().

float ThreeThresholdAlgorithm::SeedThreshold

private

Definition at line 70 of file ThreeThresholdAlgorithm.h.

Referenced by addToCandidate().