GainSwitchTools Class Reference

#include <GainSwitchTools.h>

Public Types
enum	ShowerShapeType { ShowerShapeType::Full5x5 =0, ShowerShapeType::Fractions }

Static Public Member Functions
static void	correctHadem (reco::GsfElectron::ShowerShape &showerShape, float eNewOverEOld, const GainSwitchTools::ShowerShapeType ssType)
static void	correctHadem (reco::Photon::ShowerShape &showerShape, float eNewOverEOld)
template<typename R , typename H , typename M >
static edm::Ref< typename H::element_type >	findNewRef (R const &, H const &, M const &)
static std::vector< DetId >	gainSwitchedIdsIn5x5 (const DetId &id, const EcalRecHitCollection *recHits, const CaloTopology *topology)
static const std::vector< int >	gainSwitchFlags ()
static bool	hasEBGainSwitch (const reco::SuperCluster &superClus, const EcalRecHitCollection *recHits)
static bool	hasEBGainSwitch (const EcalRecHitCollection *recHits)
static bool	hasEBGainSwitchIn5x5 (const reco::SuperCluster &superClus, const EcalRecHitCollection *recHits, const CaloTopology *topology)
template<typename HANDLE >
static reco::SuperClusterRef	matchSCBySeedCrys (const reco::SuperCluster &, HANDLE const &)
template<typename HANDLE >
static reco::SuperClusterRef	matchSCBySeedCrys (const reco::SuperCluster &, HANDLE const &, int maxDEta, int maxDPhi)
static float	newRawEnergyNoFracs (const reco::SuperCluster &superClus, const std::vector< DetId > gainSwitchedHitIds, const EcalRecHitCollection *oldRecHits, const EcalRecHitCollection *newRecHits)
static int	nrCrysWithFlagsIn5x5 (const DetId &id, const std::vector< int > &flags, const EcalRecHitCollection *recHits, const CaloTopology *topology)
template<bool noZS>
static reco::GsfElectron::ShowerShape	redoEcalShowerShape (reco::GsfElectron::ShowerShape showerShape, const reco::SuperClusterRef &superClus, const EcalRecHitCollection *recHits, const CaloTopology *topology, const CaloGeometry *geometry)
template<bool noZS>
static reco::Photon::ShowerShape	redoEcalShowerShape (reco::Photon::ShowerShape showerShape, const reco::SuperClusterRef &superClus, const EcalRecHitCollection *recHits, const CaloTopology *topology, const CaloGeometry *geometry)

Static Private Member Functions
static int	calDIEta (int lhs, int rhs)
static int	calDIPhi (int lhs, int rhs)

Static Private Attributes
static const std::vector< int >	gainSwitchFlags_ ={EcalRecHit::kHasSwitchToGain6,EcalRecHit::kHasSwitchToGain1}

Detailed Description

Definition at line 21 of file GainSwitchTools.h.

Member Enumeration Documentation

enum GainSwitchTools::ShowerShapeType

strong

Enumerator
Full5x5
Fractions

Definition at line 25 of file GainSwitchTools.h.

                            {
    Full5x5=0,Fractions //Full 5x5 would be better known as "NoFractions", its not a full 5x5, fractions is the standard showershape
  };

Member Function Documentation

int GainSwitchTools::calDIEta ( int  lhs, int  rhs  )

staticprivate

Definition at line 122 of file GainSwitchTools.cc.

Referenced by matchSCBySeedCrys().

{
  int retVal = lhs - rhs;
  if(lhs*rhs<0){ //crossing zero
    if(retVal<0) retVal++;
    else retVal--;
  }
  return retVal;
}

int GainSwitchTools::calDIPhi ( int  lhs, int  rhs  )

staticprivate

Definition at line 132 of file GainSwitchTools.cc.

Referenced by matchSCBySeedCrys().

{
  int retVal = lhs-rhs;
  while(retVal>180) retVal-=360;
  while(retVal<-180) retVal+=360;
  return retVal;
}

void GainSwitchTools::correctHadem ( reco::GsfElectron::ShowerShape &  showerShape, float  eNewOverEOld, const GainSwitchTools::ShowerShapeType  ssType  )

static

Definition at line 104 of file GainSwitchTools.cc.

References Full5x5, reco::GsfElectron::ShowerShape::hcalDepth1OverEcal, reco::GsfElectron::ShowerShape::hcalDepth1OverEcalBc, reco::GsfElectron::ShowerShape::hcalDepth2OverEcal, and reco::GsfElectron::ShowerShape::hcalDepth2OverEcalBc.

Referenced by PhotonGSCrysSimpleFixer::produce(), GsfEleGSCrysSimpleFixer::produce(), and GsfElectronGSCrysFixer::produce().

{
  if(ssType==ShowerShapeType::Full5x5) showerShape.hcalDepth1OverEcal/=eNewOverEOld;
  if(ssType==ShowerShapeType::Full5x5) showerShape.hcalDepth2OverEcal/=eNewOverEOld;
  showerShape.hcalDepth1OverEcalBc/=eNewOverEOld;
  showerShape.hcalDepth2OverEcalBc/=eNewOverEOld;
}

void GainSwitchTools::correctHadem ( reco::Photon::ShowerShape &  showerShape, float  eNewOverEOld  )

static

Definition at line 113 of file GainSwitchTools.cc.

References reco::Photon::ShowerShape::hcalDepth1OverEcal, reco::Photon::ShowerShape::hcalDepth1OverEcalBc, reco::Photon::ShowerShape::hcalDepth2OverEcal, and reco::Photon::ShowerShape::hcalDepth2OverEcalBc.

{
  showerShape.hcalDepth1OverEcal/=eNewOverEOld;
  showerShape.hcalDepth2OverEcal/=eNewOverEOld;
  showerShape.hcalDepth1OverEcalBc/=eNewOverEOld;
  showerShape.hcalDepth2OverEcalBc/=eNewOverEOld;
}

template<typename R , typename H , typename M >

edm::Ref< typename H::element_type > GainSwitchTools::findNewRef ( R const &  _oldRef, H const &  _newHandle, M const &  _map  )

static

Definition at line 80 of file GainSwitchTools.h.

Referenced by GEDPhotonCoreGSCrysFixer::produce(), ConversionGSCrysFixer::produce(), PFGSFixLinker::produce(), and GsfElectronCoreGSCrysFixer::produce().

{
  for (unsigned iC(0); iC != _newHandle->size(); ++iC) {
    edm::Ref<typename H::element_type> ref(_newHandle, iC);
    auto&& mappedRef(_map[ref]);
    if (mappedRef.id() == _oldRef.id() && mappedRef.key() == _oldRef.key())
      return ref;
  }
  return edm::Ref<typename H::element_type>(_newHandle.id());
}

std::vector< DetId > GainSwitchTools::gainSwitchedIdsIn5x5 ( const DetId &  id, const EcalRecHitCollection *  recHits, const CaloTopology *  topology  )

static

Definition at line 64 of file GainSwitchTools.cc.

References edm::SortedCollection< T, SORT >::end(), edm::SortedCollection< T, SORT >::find(), gainSwitchFlags(), CaloTopology::getSubdetectorTopology(), CaloNavigator< T, TOPO >::home(), and CaloNavigator< T, TOPO >::offsetBy().

Referenced by PhotonGSCrysSimpleFixer::produce(), and GsfEleGSCrysSimpleFixer::produce().

{
  std::vector<DetId> gsDetIds;
  CaloNavigator<DetId> cursor = CaloNavigator<DetId>( id, topology->getSubdetectorTopology( id ) );
  
  for ( int eastNr = -2; eastNr <= 2; ++eastNr ) { //east is eta in barrel
    for ( int northNr = -2; northNr <= 2; ++northNr ) { //north is phi in barrel
      cursor.home();
      cursor.offsetBy( eastNr, northNr);
      DetId id = *cursor;
      auto recHitIt = recHits->find(id);
      if(recHitIt!=recHits->end() && 
     recHitIt->checkFlags(gainSwitchFlags())){
    gsDetIds.push_back(id);
      }
    }
  }
  return gsDetIds;
}

static const std::vector<int> GainSwitchTools::gainSwitchFlags ( )

inlinestatic

Definition at line 37 of file GainSwitchTools.h.

References gainSwitchFlags_.

Referenced by gainSwitchedIdsIn5x5(), hasEBGainSwitch(), and hasEBGainSwitchIn5x5().

{return gainSwitchFlags_;}

bool GainSwitchTools::hasEBGainSwitch ( const reco::SuperCluster &  superClus, const EcalRecHitCollection *  recHits  )

static

Definition at line 33 of file GainSwitchTools.cc.

References reco::SuperCluster::clusters(), EcalBarrel, edm::SortedCollection< T, SORT >::end(), edm::SortedCollection< T, SORT >::find(), gainSwitchFlags(), and reco::SuperCluster::seed().

{
  if(!recHits || superClus.seed()->seed().subdetId()!=EcalBarrel) return false;
  for(const auto & clus : superClus.clusters()){
    for(const auto& hit : clus->hitsAndFractions()){
      auto recHitIt = recHits->find(hit.first);
      if(recHitIt!=recHits->end() && 
     recHitIt->checkFlags(gainSwitchFlags())){
    return true;
      }
    }
  }
  return false; 
}

bool GainSwitchTools::hasEBGainSwitch ( const EcalRecHitCollection *  recHits )

static

Definition at line 54 of file GainSwitchTools.cc.

References EcalBarrel, gainSwitchFlags(), and hit::id.

{
  if(!recHits) return false;
  for(auto hit : *recHits){
    if(hit.id().subdetId()==EcalBarrel && hit.checkFlags(gainSwitchFlags())) return true;
  }
  return false;
}

bool GainSwitchTools::hasEBGainSwitchIn5x5 ( const reco::SuperCluster &  superClus, const EcalRecHitCollection *  recHits, const CaloTopology *  topology  )

static

Definition at line 48 of file GainSwitchTools.cc.

References EcalBarrel, gainSwitchFlags(), nrCrysWithFlagsIn5x5(), HLT_25ns10e33_v2_cff::recHits, reco::SuperCluster::seed(), and ecaldqm::topology().

Referenced by GEDPhotonGSCrysFixer::produce(), PhotonGSCrysSimpleFixer::produce(), GsfEleGSCrysSimpleFixer::produce(), GsfElectronGSCrysFixer::produce(), and EGGainSwitchFlagProducer< C >::produce().

{
  if(recHits || superClus.seed()->seed().subdetId()!=EcalBarrel) return nrCrysWithFlagsIn5x5(superClus.seed()->seed(),gainSwitchFlags(),recHits,topology)!=0;
  else return false;
}

template<typename HANDLE >

reco::SuperClusterRef GainSwitchTools::matchSCBySeedCrys ( const reco::SuperCluster &  sc, HANDLE const &  scColl  )

static

Definition at line 93 of file GainSwitchTools.h.

References reco::SuperCluster::seed().

Referenced by EGRefinedSCFixer::produce().

{
  for(size_t scNr=0;scNr<scColl->size();scNr++){
    if(scColl->at(scNr).seed()->seed().rawId() ==sc.seed()->seed().rawId())
      return reco::SuperClusterRef(scColl,scNr);
  }
  return reco::SuperClusterRef(nullptr,0);
}

template<typename HANDLE >

reco::SuperClusterRef GainSwitchTools::matchSCBySeedCrys ( const reco::SuperCluster &  sc, HANDLE const &  scColl, int  maxDEta, int  maxDPhi  )

static

Definition at line 104 of file GainSwitchTools.h.

References calDIEta(), calDIPhi(), EcalBarrel, and reco::SuperCluster::seed().

{
  reco::SuperClusterRef bestRef(scColl.id());

  int bestDIR2 = maxDEta*maxDEta+maxDPhi*maxDPhi+1; //+1 is to make it slightly bigger than max allowed
  
  if(sc.seed()->seed().subdetId()==EcalBarrel){
    EBDetId scDetId(sc.seed()->seed());
    
    for(size_t scNr=0;scNr<scColl->size();scNr++){
      reco::SuperClusterRef matchRef(scColl,scNr);
      if(matchRef->seed()->seed().subdetId()==EcalBarrel){
    EBDetId matchDetId(matchRef->seed()->seed());
    int dIEta = calDIEta(scDetId.ieta(),matchDetId.ieta());
    int dIPhi = calDIPhi(scDetId.iphi(),matchDetId.iphi());
    int dIR2 = dIEta*dIEta+dIPhi*dIPhi;
    if(dIR2<bestDIR2){
      bestDIR2=dIR2;
      bestRef = reco::SuperClusterRef(scColl,scNr);
    }
      }
    }
    
    
  }
  return bestRef;
}

float GainSwitchTools::newRawEnergyNoFracs ( const reco::SuperCluster &  superClus, const std::vector< DetId >  gainSwitchedHitIds, const EcalRecHitCollection *  oldRecHits, const EcalRecHitCollection *  newRecHits  )

static

Definition at line 86 of file GainSwitchTools.cc.

References edm::SortedCollection< T, SORT >::end(), edm::SortedCollection< T, SORT >::find(), and reco::SuperCluster::rawEnergy().

Referenced by PhotonGSCrysSimpleFixer::produce(), and GsfEleGSCrysSimpleFixer::produce().

{
  double oldEnergy=0.;
  double newEnergy=0.;
  for(auto& id : gainSwitchedHitIds){
    auto oldRecHitIt = oldRecHits->find(id);
    if(oldRecHitIt!=oldRecHits->end()) oldEnergy+=oldRecHitIt->energy();
    auto newRecHitIt = newRecHits->find(id);
    if(newRecHitIt!=newRecHits->end()) newEnergy+=newRecHitIt->energy();
  }
  
  float newRawEnergy = superClus.rawEnergy() - oldEnergy + newEnergy;
  
  return newRawEnergy;
}

int GainSwitchTools::nrCrysWithFlagsIn5x5 ( const DetId &  id, const std::vector< int > &  flags, const EcalRecHitCollection *  recHits, const CaloTopology *  topology  )

static

Definition at line 11 of file GainSwitchTools.cc.

References edm::SortedCollection< T, SORT >::end(), edm::SortedCollection< T, SORT >::find(), CaloTopology::getSubdetectorTopology(), CaloNavigator< T, TOPO >::home(), and CaloNavigator< T, TOPO >::offsetBy().

Referenced by hasEBGainSwitchIn5x5().

{
  int nrFound=0;
  CaloNavigator<DetId> cursor = CaloNavigator<DetId>( id, topology->getSubdetectorTopology( id ) );
  
  for ( int eastNr = -2; eastNr <= 2; ++eastNr ) { //east is eta in barrel
    for ( int northNr = -2; northNr <= 2; ++northNr ) { //north is phi in barrel
      cursor.home();
      cursor.offsetBy( eastNr, northNr);
      DetId id = *cursor;
      if (recHits != nullptr) {
    auto recHitIt = recHits->find(id);
    if(recHitIt!=recHits->end() && 
       recHitIt->checkFlags(flags)){
      nrFound++;
    }
      }
    }
  }
  return nrFound;
}

template<bool noZS>

reco::GsfElectron::ShowerShape GainSwitchTools::redoEcalShowerShape ( reco::GsfElectron::ShowerShape  showerShape, const reco::SuperClusterRef &  superClus, const EcalRecHitCollection *  recHits, const CaloTopology *  topology, const CaloGeometry *  geometry  )

static

Definition at line 134 of file GainSwitchTools.h.

References EcalClusterToolsT< noZS >::covariances(), EcalClusterToolsT< noZS >::e1x5(), reco::GsfElectron::ShowerShape::e1x5, reco::GsfElectron::ShowerShape::e2nd, EcalClusterToolsT< noZS >::e2x5Max(), reco::GsfElectron::ShowerShape::e2x5Max, EcalClusterToolsT< noZS >::e3x3(), EcalClusterToolsT< noZS >::e5x5(), reco::GsfElectron::ShowerShape::e5x5, reco::GsfElectron::ShowerShape::eBottom, reco::GsfElectron::ShowerShape::eLeft, reco::GsfElectron::ShowerShape::eMax, reco::GsfElectron::ShowerShape::eRight, reco::GsfElectron::ShowerShape::eTop, edm::isNotFinite(), EcalClusterToolsT< noZS >::localCovariances(), reco::GsfElectron::ShowerShape::r9, reco::GsfElectron::ShowerShape::sigmaEtaEta, reco::GsfElectron::ShowerShape::sigmaIetaIeta, reco::GsfElectron::ShowerShape::sigmaIetaIphi, reco::GsfElectron::ShowerShape::sigmaIphiIphi, and mathSSE::sqrt().

{
  const reco::CaloCluster & seedClus = *(superClus->seed());
  
  std::vector<float> covariances = EcalClusterToolsT<noZS>::covariances(seedClus,recHits,topology,geometry);
  std::vector<float> localCovariances = EcalClusterToolsT<noZS>::localCovariances(seedClus,recHits,topology);
  showerShape.sigmaEtaEta = sqrt(covariances[0]);
  showerShape.sigmaIetaIeta = sqrt(localCovariances[0]);
  showerShape.sigmaIphiIphi =!edm::isNotFinite(localCovariances[2]) ? sqrt(localCovariances[2]) : 0;
  showerShape.e1x5 = EcalClusterToolsT<noZS>::e1x5(seedClus,recHits,topology);
  showerShape.e2x5Max = EcalClusterToolsT<noZS>::e2x5Max(seedClus,recHits,topology);
  showerShape.e5x5 = EcalClusterToolsT<noZS>::e5x5(seedClus,recHits,topology);
  showerShape.r9 = EcalClusterToolsT<noZS>::e3x3(seedClus,recHits,topology)/superClus->rawEnergy();  
  const float see_by_spp = showerShape.sigmaIetaIeta*showerShape.sigmaIphiIphi;
  if(  see_by_spp > 0 ) {
    showerShape.sigmaIetaIphi = localCovariances[1] / see_by_spp;
  } else if ( localCovariances[1] > 0 ) {
    showerShape.sigmaIetaIphi = 1.f;
  } else {
    showerShape.sigmaIetaIphi = -1.f;
  }
  showerShape.eMax          = EcalClusterTools::eMax(seedClus,recHits);
  showerShape.e2nd          = EcalClusterTools::e2nd(seedClus,recHits);
  showerShape.eTop          = EcalClusterTools::eTop(seedClus,recHits,topology);
  showerShape.eLeft         = EcalClusterTools::eLeft(seedClus,recHits,topology);
  showerShape.eRight        = EcalClusterTools::eRight(seedClus,recHits,topology);
  showerShape.eBottom       = EcalClusterTools::eBottom(seedClus,recHits,topology);
  return showerShape;
}

template<bool noZS>

reco::Photon::ShowerShape GainSwitchTools::redoEcalShowerShape ( reco::Photon::ShowerShape  showerShape, const reco::SuperClusterRef &  superClus, const EcalRecHitCollection *  recHits, const CaloTopology *  topology, const CaloGeometry *  geometry  )

static

Definition at line 166 of file GainSwitchTools.h.

References EcalClusterToolsT< noZS >::covariances(), EcalClusterToolsT< noZS >::e1x3(), reco::Photon::ShowerShape::e1x3, EcalClusterToolsT< noZS >::e1x5(), reco::Photon::ShowerShape::e1x5, EcalClusterToolsT< noZS >::e2nd(), reco::Photon::ShowerShape::e2nd, EcalClusterToolsT< noZS >::e2x2(), reco::Photon::ShowerShape::e2x2, reco::Photon::ShowerShape::e2x5, EcalClusterToolsT< noZS >::e2x5Bottom(), reco::Photon::ShowerShape::e2x5Bottom, EcalClusterToolsT< noZS >::e2x5Left(), reco::Photon::ShowerShape::e2x5Left, EcalClusterToolsT< noZS >::e2x5Max(), reco::Photon::ShowerShape::e2x5Max, EcalClusterToolsT< noZS >::e2x5Right(), reco::Photon::ShowerShape::e2x5Right, EcalClusterToolsT< noZS >::e2x5Top(), reco::Photon::ShowerShape::e2x5Top, EcalClusterToolsT< noZS >::e3x3(), reco::Photon::ShowerShape::e3x3, EcalClusterToolsT< noZS >::e5x5(), reco::Photon::ShowerShape::e5x5, EcalClusterToolsT< noZS >::eBottom(), reco::Photon::ShowerShape::eBottom, EcalClusterToolsT< noZS >::eLeft(), reco::Photon::ShowerShape::eLeft, EcalClusterToolsT< noZS >::eMax(), EcalClusterToolsT< noZS >::eRight(), reco::Photon::ShowerShape::eRight, EcalClusterToolsT< noZS >::eTop(), reco::Photon::ShowerShape::eTop, edm::isNotFinite(), EcalClusterToolsT< noZS >::localCovariances(), reco::Photon::ShowerShape::maxEnergyXtal, reco::Photon::ShowerShape::sigmaEtaEta, reco::Photon::ShowerShape::sigmaIetaIeta, reco::Photon::ShowerShape::sigmaIphiIphi, and mathSSE::sqrt().

{
  const reco::CaloCluster & seedClus = *(superClus->seed());
  
  std::vector<float> covariances = EcalClusterToolsT<noZS>::covariances(seedClus,recHits,topology,geometry);
  std::vector<float> localCovariances = EcalClusterToolsT<noZS>::localCovariances(seedClus,recHits,topology);
  showerShape.sigmaEtaEta = sqrt(covariances[0]);
  showerShape.e1x5 = EcalClusterToolsT<noZS>::e1x5(seedClus,recHits,topology); 
  showerShape.e2x5 = EcalClusterToolsT<noZS>::e2x5Max(seedClus,recHits,topology);
  showerShape.e3x3 = EcalClusterToolsT<noZS>::e3x3(seedClus,recHits,topology);
  showerShape.e5x5 = EcalClusterToolsT<noZS>::e5x5(seedClus,recHits,topology);
  showerShape.maxEnergyXtal =  EcalClusterToolsT<noZS>::eMax(seedClus,recHits);
  //showerShape.effSigmaRR fine as its preshower, this only does ECAL shapes
  showerShape.sigmaIetaIeta = sqrt(localCovariances[0]);
  showerShape.sigmaIphiIphi =!edm::isNotFinite(localCovariances[2]) ? sqrt(localCovariances[2]) : 0;
  showerShape.e2nd =  EcalClusterToolsT<noZS>::e2nd(seedClus,recHits);
  showerShape.eTop =  EcalClusterToolsT<noZS>::eTop(seedClus,recHits,topology);
  showerShape.eLeft =  EcalClusterToolsT<noZS>::eLeft(seedClus,recHits,topology);
  showerShape.eRight =  EcalClusterToolsT<noZS>::eRight(seedClus,recHits,topology);
  showerShape.eBottom =  EcalClusterToolsT<noZS>::eBottom(seedClus,recHits,topology);
  showerShape.e1x3 = EcalClusterToolsT<noZS>::e1x3(seedClus,recHits,topology);
  showerShape.e2x2 = EcalClusterToolsT<noZS>::e2x2(seedClus,recHits,topology);
  showerShape.e2x5Max = EcalClusterToolsT<noZS>::e2x5Max(seedClus,recHits,topology);
  showerShape.e2x5Left = EcalClusterToolsT<noZS>::e2x5Left(seedClus,recHits,topology);
  showerShape.e2x5Right = EcalClusterToolsT<noZS>::e2x5Right(seedClus,recHits,topology);
  showerShape.e2x5Top = EcalClusterToolsT<noZS>::e2x5Top(seedClus,recHits,topology);
  showerShape.e2x5Bottom = EcalClusterToolsT<noZS>::e2x5Bottom(seedClus,recHits,topology);

  return showerShape;
}

Member Data Documentation

const std::vector< int > GainSwitchTools::gainSwitchFlags_ ={EcalRecHit::kHasSwitchToGain6,EcalRecHit::kHasSwitchToGain1}

staticprivate

Definition at line 73 of file GainSwitchTools.h.

Referenced by gainSwitchFlags().