reco::tau::RecoTauQualityCuts Class Reference

#include <RecoTauQualityCuts.h>

Public Types
typedef std::function< bool(const Candidate &)>	CandQCutFunc
typedef std::vector< CandQCutFunc >	CandQCutFuncCollection
typedef std::map< int, CandQCutFuncCollection >	CandQCutFuncMap
typedef std::function< bool(const TrackBaseRef &)>	TrackQCutFunc
typedef std::vector< TrackQCutFunc >	TrackQCutFuncCollection

Public Member Functions
bool	filterCand (const reco::Candidate &cand) const
	Filter a single Candidate. More...
template<typename CandRefType >
bool	filterCandRef (const CandRefType &cand) const
	Filter a Candidate held by a smart pointer or Ref. More...
template<typename Coll >
Coll	filterCandRefs (const Coll &refcoll, bool invert=false) const
	Filter a ref vector of Candidates. More...
bool	filterChargedCand (const reco::Candidate &cand) const
	or a single charged candidate More...
bool	filterTrack (const reco::TrackBaseRef &track) const
	Filter a single Track. More...
bool	filterTrack (const reco::TrackRef &track) const
bool	filterTrack (const reco::Track &track) const
template<typename Coll >
Coll	filterTracks (const Coll &coll, bool invert=false) const
	Filter a collection of Tracks. More...
	RecoTauQualityCuts (const edm::ParameterSet &qcuts)
void	setLeadTrack (const reco::Track &leadTrack) const
	Update the leading track. More...
void	setLeadTrack (const reco::Candidate &leadCand) const
void	setLeadTrack (const reco::CandidateRef &leadCand) const
void	setPV (const reco::VertexRef &vtx) const
	Update the primary vertex. More...

Private Member Functions
bool	filterCandByType (const reco::Candidate &cand) const
bool	filterGammaCand (const reco::Candidate &cand) const
bool	filterNeutralHadronCand (const reco::Candidate &cand) const
bool	filterTrack_ (const reco::Track *track) const

Private Attributes
bool	checkHitPattern_
bool	checkPV_
const reco::Track *	leadTrack_
double	maxDeltaZ_
double	maxDeltaZToLeadTrack_
double	maxTrackChi2_
double	maxTransverseImpactParameter_
double	minGammaEt_
double	minNeutralHadronEt_
int	minTrackHits_
int	minTrackPixelHits_
double	minTrackPt_
double	minTrackVertexWeight_
reco::VertexRef	pv_

Detailed Description

Definition at line 33 of file RecoTauQualityCuts.h.

Member Typedef Documentation

typedef std::function<bool (const Candidate&)> reco::tau::RecoTauQualityCuts::CandQCutFunc

Definition at line 39 of file RecoTauQualityCuts.h.

typedef std::vector<CandQCutFunc> reco::tau::RecoTauQualityCuts::CandQCutFuncCollection

Definition at line 40 of file RecoTauQualityCuts.h.

typedef std::map<int, CandQCutFuncCollection> reco::tau::RecoTauQualityCuts::CandQCutFuncMap

Definition at line 41 of file RecoTauQualityCuts.h.

typedef std::function<bool (const TrackBaseRef&)> reco::tau::RecoTauQualityCuts::TrackQCutFunc

Definition at line 37 of file RecoTauQualityCuts.h.

typedef std::vector<TrackQCutFunc> reco::tau::RecoTauQualityCuts::TrackQCutFuncCollection

Definition at line 38 of file RecoTauQualityCuts.h.

Constructor & Destructor Documentation

reco::tau::RecoTauQualityCuts::RecoTauQualityCuts ( const edm::ParameterSet &  qcuts )

explicit

Definition at line 293 of file RecoTauQualityCuts.cc.

References Exception, edm::ParameterSet::exists(), edm::ParameterSet::getParameter(), edm::ParameterSet::getParameterNames(), dataset::name, TSGForRoadSearch_cfi::option, and AlCaHLTBitMon_QueryRunRegistry::string.

{
  // Setup all of our predicates
  CandQCutFuncCollection chargedHadronCuts;
  CandQCutFuncCollection gammaCuts;
  CandQCutFuncCollection neutralHadronCuts;

  // Make sure there are no extra passed options
  std::set<std::string> passedOptionSet;
  std::vector<std::string> passedOptions = qcuts.getParameterNames();

  for(auto const& option : passedOptions) {
    passedOptionSet.insert(option);
  }

  unsigned int nCuts = 0;
  auto getDouble = [&qcuts, &passedOptionSet, &nCuts](const std::string& name) {
    if(qcuts.exists(name)) {
      ++nCuts;
      passedOptionSet.erase(name);
      return qcuts.getParameter<double>(name);
    }
    return -1.0;
  };
  auto getUint = [&qcuts, &passedOptionSet, &nCuts](const std::string& name) -> unsigned int {
    if(qcuts.exists(name)) {
      ++nCuts;
      passedOptionSet.erase(name);
      return qcuts.getParameter<unsigned int>(name);
    }
    return 0;
  };

  // Build all the QCuts for tracks
  minTrackPt_ = getDouble("minTrackPt");
  maxTrackChi2_ = getDouble("maxTrackChi2");
  minTrackPixelHits_ = getUint("minTrackPixelHits");
  minTrackHits_ = getUint("minTrackHits");
  maxTransverseImpactParameter_ = getDouble("maxTransverseImpactParameter");
  maxDeltaZ_ = getDouble("maxDeltaZ");
  maxDeltaZToLeadTrack_ = getDouble("maxDeltaZToLeadTrack");
  // Require tracks to contribute a minimum weight to the associated vertex.
  minTrackVertexWeight_ = getDouble("minTrackVertexWeight");
  
  // Use bit-wise & to avoid conditional code
  checkHitPattern_ = (minTrackHits_ > 0) || (minTrackPixelHits_ > 0);
  checkPV_ = (maxTransverseImpactParameter_ >= 0) ||
             (maxDeltaZ_ >= 0) ||
             (maxDeltaZToLeadTrack_ >= 0) ||
             (minTrackVertexWeight_ >= 0);

  // Build the QCuts for gammas
  minGammaEt_ = getDouble("minGammaEt");

  // Build QCuts for netural hadrons
  minNeutralHadronEt_ = getDouble("minNeutralHadronEt");

  // Check if there are any remaining unparsed QCuts
  if ( !passedOptionSet.empty() ) {
    std::string unParsedOptions;
    bool thereIsABadParameter = false;
    for(auto const& option : passedOptionSet ) {
      // Workaround for HLT - TODO FIXME
      if ( option == "useTracksInsteadOfPFHadrons" ) {
        // Crash if true - no one should have this option enabled.
        if ( qcuts.getParameter<bool>("useTracksInsteadOfPFHadrons") ) {
          throw cms::Exception("DontUseTracksInQcuts")
            << "The obsolete exception useTracksInsteadOfPFHadrons "
            << "is set to true in the quality cut config." << std::endl;
        }
        continue;
      }
      
      // If we get to this point, there is a real unknown parameter
      thereIsABadParameter = true;
      
      unParsedOptions += option;
      unParsedOptions += "\n";
    }
    if ( thereIsABadParameter ) {
      throw cms::Exception("BadQualityCutConfig")
        << " The PSet passed to the RecoTauQualityCuts class had"
        << " the following unrecognized options: " << std::endl
        << unParsedOptions;
    }
  }

  // Make sure there are at least some quality cuts
  if ( !nCuts ) {
    throw cms::Exception("BadQualityCutConfig")
      << " No options were passed to the quality cut class!" << std::endl;
  }
}

Member Function Documentation

bool reco::tau::RecoTauQualityCuts::filterCand

(

const reco::Candidate &

cand

)

const

Filter a single Candidate.

Definition at line 532 of file RecoTauQualityCuts.cc.

References reco::Candidate::charge(), and mps_fire::result.

Referenced by filterCandRef(), and filterTracks().

{
  auto trackRef = getTrackRef(cand);
  bool result = true;

  if (trackRef.isNonnull()) {
    result = filterTrack(trackRef);
  } 
  else {
    auto gsfTrackRef = getGsfTrackRef(cand);
    if (gsfTrackRef.isNonnull())
      result = filterTrack(gsfTrackRef);
    else if (cand.charge() != 0) {
      result = filterChargedCand(cand);
    }
  }
  
  if(result)
    result = filterCandByType(cand);

  return result;
}

bool reco::tau::RecoTauQualityCuts::filterCandByType ( const reco::Candidate &  cand ) const

private

Definition at line 513 of file RecoTauQualityCuts.cc.

References funct::abs(), and reco::Candidate::pdgId().

Referenced by filterCandRefs().

                                                                         {
  switch(std::abs(cand.pdgId())) {
  case 22:
    return filterGammaCand(cand);
  case 130:
    return filterNeutralHadronCand(cand);
  // We use the same qcuts for muons/electrons and charged hadrons.
  case 211:
  case 11:
  case 13:
    // no cuts ATM (track cuts applied in filterCand)
    return true;
  // Return false if we dont' know how to deal with this particle type
  default:
    return false;
  };
  return false;
}

template<typename CandRefType >

bool reco::tau::RecoTauQualityCuts::filterCandRef ( const CandRefType &  cand ) const

inline

Filter a Candidate held by a smart pointer or Ref.

Definition at line 79 of file RecoTauQualityCuts.h.

References filterCand().

Referenced by filterCandRefs().

{ return filterCand(*cand); }

template<typename Coll >

Coll reco::tau::RecoTauQualityCuts::filterCandRefs ( const Coll &  refcoll, bool  invert = false  ) const

inline

Filter a ref vector of Candidates.

Definition at line 83 of file RecoTauQualityCuts.h.

References filterCandByType(), filterCandRef(), filterGammaCand(), filterNeutralHadronCand(), filterTrack_(), TopAnalysis_sequences::invert, and convertSQLitetoXML_cfg::output.

Referenced by reco::tau::RecoTauVertexAssociator::getLeadCand(), reco::tau::RecoTauPiZeroTrivialPlugin::operator()(), reco::tau::RecoTauPiZeroCombinatoricPlugin::operator()(), reco::tau::RecoTauBuilderCombinatoricPlugin::operator()(), reco::tau::RecoTauBuilderConePlugin::operator()(), reco::tau::RecoTauPiZeroStripPlugin::operator()(), reco::tau::PFRecoTauChargedHadronFromPFCandidatePlugin::operator()(), and reco::tau::RecoTauPiZeroStripPlugin2::operator()().

  {
    Coll output;
    for(auto const& cand : refcoll ) {
      if ( filterCandRef(cand)^invert ) output.push_back(cand);
    }
    return output;
  }

bool reco::tau::RecoTauQualityCuts::filterChargedCand

(

const reco::Candidate &

cand

)

const

or a single charged candidate

Definition at line 459 of file RecoTauQualityCuts.cc.

References reco::Candidate::charge(), pat::PackedCandidate::dxy(), pat::PackedCandidate::dz(), getTrack(), reco::tau::qcuts::minPackedCandVertexWeight(), pat::PackedCandidate::pt(), and HiIsolationCommonParameters_cff::track.

Referenced by reco::tau::PFRecoTauChargedHadronFromGenericTrackPlugin< TrackClass >::filterTrack(), and setPV().

                                                                          {

  if (cand.charge() == 0)
    return true;
  const pat::PackedCandidate* pCand = dynamic_cast<const pat::PackedCandidate*>(&cand);
  if (pCand == nullptr)
    return true;

  //Get track, it should be present for cands with pT(charged)>0.5GeV
  //and check track quality critera other than vertex weight
  auto track = getTrack(cand);
  if (track != nullptr){
    if (!filterTrack(*track))
      return false;
  } else {//Candidates without track (pT(charged)<0.5GeV): Can still check pT and calculate dxy and dz
    if(minTrackPt_ >= 0 && !(pCand->pt() > minTrackPt_)) return false;
    if(checkPV_ && pv_.isNull()) {
      edm::LogError("QCutsNoPrimaryVertex") << "Primary vertex Ref in " <<
    "RecoTauQualityCuts is invalid. - filterChargedCand";
      return false;
    }

    if(maxTransverseImpactParameter_ >= 0 &&
       !(std::fabs(pCand->dxy(pv_->position())) <= maxTransverseImpactParameter_))
      return false;
    if(maxDeltaZ_ >= 0 && !(std::fabs(pCand->dz(pv_->position())) <= maxDeltaZ_)) return false;
    if(maxDeltaZToLeadTrack_ >= 0) {
      if ( leadTrack_ == nullptr) {
    edm::LogError("QCutsNoValidLeadTrack") << "Lead track Ref in " <<
      "RecoTauQualityCuts is invalid. - filterChargedCand";
    return false;
      }

      if(!(std::fabs(pCand->dz(pv_->position()) - leadTrack_->dz(pv_->position())) <= maxDeltaZToLeadTrack_))
    return false;
    }
  }
  if(minTrackVertexWeight_ >= 0. &&
     !(qcuts::minPackedCandVertexWeight(*pCand, &pv_,  minTrackVertexWeight_)))
     return false;

  return true;
}

bool reco::tau::RecoTauQualityCuts::filterGammaCand ( const reco::Candidate &  cand ) const

private

Definition at line 503 of file RecoTauQualityCuts.cc.

References reco::Candidate::et().

Referenced by filterCandRefs().

                                                                        {
  if(minGammaEt_ >= 0 && !(cand.et() > minGammaEt_)) return false;
  return true;
}

bool reco::tau::RecoTauQualityCuts::filterNeutralHadronCand ( const reco::Candidate &  cand ) const

private

Definition at line 508 of file RecoTauQualityCuts.cc.

References reco::Candidate::et().

Referenced by filterCandRefs().

                                                                                {
  if(minNeutralHadronEt_ >= 0 && !(cand.et() > minNeutralHadronEt_)) return false;
  return true;
}

bool reco::tau::RecoTauQualityCuts::filterTrack

(

const reco::TrackBaseRef &

track

)

const

Filter a single Track.

Definition at line 405 of file RecoTauQualityCuts.cc.

References edm::RefToBase< T >::get().

Referenced by reco::tau::PFRecoTauChargedHadronFromGenericTrackPlugin< TrackClass >::filterTrack(), filterTracks(), and setPV().

{
  if (!filterTrack_(track.get()))
    return false;
  if(minTrackVertexWeight_ >= 0. && !(pv_->trackWeight(convertRef(track)) >= minTrackVertexWeight_)) return false;
  return true;
}

bool reco::tau::RecoTauQualityCuts::filterTrack

(

const reco::TrackRef &

track

)

const

Definition at line 413 of file RecoTauQualityCuts.cc.

References edm::Ref< C, T, F >::get().

{
  if (!filterTrack_(track.get()))
    return false;
  if(minTrackVertexWeight_ >= 0. && !(pv_->trackWeight(convertRef(track)) >= minTrackVertexWeight_)) return false;
  return true;
}

bool reco::tau::RecoTauQualityCuts::filterTrack

(

const reco::Track &

track

)

const

Definition at line 421 of file RecoTauQualityCuts.cc.

{
  return filterTrack_(&track);
}

bool reco::tau::RecoTauQualityCuts::filterTrack_ ( const reco::Track *  track ) const

private

Definition at line 426 of file RecoTauQualityCuts.cc.

References reco::TrackBase::dxy(), reco::TrackBase::dz(), reco::TrackBase::hitPattern(), reco::TrackBase::normalizedChi2(), reco::HitPattern::numberOfValidHits(), reco::HitPattern::numberOfValidPixelHits(), and reco::TrackBase::pt().

Referenced by filterCandRefs().

{
  if(minTrackPt_ >= 0 && !(track->pt() > minTrackPt_)) return false;
  if(maxTrackChi2_ >= 0 && !(track->normalizedChi2() <= maxTrackChi2_)) return false;
  if(checkHitPattern_) {
    const reco::HitPattern &hitPattern = track->hitPattern();
    if(minTrackPixelHits_ > 0 && !(hitPattern.numberOfValidPixelHits() >= minTrackPixelHits_)) return false;
    if(minTrackHits_ > 0 && !(hitPattern.numberOfValidHits() >= minTrackHits_)) return false;
  }
  if(checkPV_ && pv_.isNull()) {
    edm::LogError("QCutsNoPrimaryVertex") << "Primary vertex Ref in " <<
      "RecoTauQualityCuts is invalid. - filterTrack";
    return false;
  }

  if(maxTransverseImpactParameter_ >= 0 &&
     !(std::fabs(track->dxy(pv_->position())) <= maxTransverseImpactParameter_))
      return false;
  if(maxDeltaZ_ >= 0 && !(std::fabs(track->dz(pv_->position())) <= maxDeltaZ_)) return false;
  if(maxDeltaZToLeadTrack_ >= 0) {
    if ( !leadTrack_) {
      edm::LogError("QCutsNoValidLeadTrack") << "Lead track Ref in " <<
        "RecoTauQualityCuts is invalid. - filterTrack";
      return false;
    }

    if(!(std::fabs(track->dz(pv_->position()) - leadTrack_->dz(pv_->position())) <= maxDeltaZToLeadTrack_))
      return false;
  }

  return true;
}

template<typename Coll >

Coll reco::tau::RecoTauQualityCuts::filterTracks ( const Coll &  coll, bool  invert = false  ) const

inline

Filter a collection of Tracks.

Definition at line 65 of file RecoTauQualityCuts.h.

References filterCand(), filterTrack(), TopAnalysis_sequences::invert, and convertSQLitetoXML_cfg::output.

  {
    Coll output;
    for(auto const& track : coll ) {
      if ( filterTrack(track)^invert ) output.push_back(track);
    }
    return output;
  }

void reco::tau::RecoTauQualityCuts::setLeadTrack

(

const reco::Track &

leadTrack

)

const

Update the leading track.

Definition at line 555 of file RecoTauQualityCuts.cc.

References TauDiscriminatorTools::leadTrack.

Referenced by setPV().

{
  leadTrack_ = &leadTrack;
}

void reco::tau::RecoTauQualityCuts::setLeadTrack

(

const reco::Candidate &

leadCand

)

const

Definition at line 560 of file RecoTauQualityCuts.cc.

References getTrack().

{
  leadTrack_ = getTrack(leadCand);
}

void reco::tau::RecoTauQualityCuts::setLeadTrack

(

const reco::CandidateRef &

leadCand

)

const

Update the leading track (using reference) If null, this will set the lead track ref null.

Definition at line 565 of file RecoTauQualityCuts.cc.

References getTrack(), and edm::Ref< C, T, F >::isNonnull().

{
  if ( leadCand.isNonnull() ) {
    leadTrack_ = getTrack(*leadCand);
  } else {
    // Set null
    leadTrack_ = nullptr;
  }
}

void reco::tau::RecoTauQualityCuts::setPV ( const reco::VertexRef &  vtx ) const

inline

Update the primary vertex.

Definition at line 46 of file RecoTauQualityCuts.h.

References filterChargedCand(), filterTrack(), reco::tau::leadCand(), TauDiscriminatorTools::leadTrack, pv_, setLeadTrack(), HiIsolationCommonParameters_cff::track, and extraflags_cff::vtx.

Referenced by reco::tau::RecoTauBuilderCombinatoricPlugin::operator()(), reco::tau::RecoTauBuilderConePlugin::operator()(), reco::tau::RecoTauPiZeroStripPlugin::operator()(), reco::tau::PFRecoTauChargedHadronFromPFCandidatePlugin::operator()(), reco::tau::RecoTauPiZeroStripPlugin2::operator()(), reco::tau::PFRecoTauChargedHadronFromGenericTrackPlugin< TrackClass >::operator()(), and reco::tau::RecoTauVertexAssociator::setEvent().

{ pv_ = vtx; }

Member Data Documentation

bool reco::tau::RecoTauQualityCuts::checkHitPattern_

private

Definition at line 113 of file RecoTauQualityCuts.h.

bool reco::tau::RecoTauQualityCuts::checkPV_

private

Definition at line 114 of file RecoTauQualityCuts.h.

const reco::Track* reco::tau::RecoTauQualityCuts::leadTrack_

mutableprivate

Definition at line 101 of file RecoTauQualityCuts.h.

double reco::tau::RecoTauQualityCuts::maxDeltaZ_

private

Definition at line 108 of file RecoTauQualityCuts.h.

double reco::tau::RecoTauQualityCuts::maxDeltaZToLeadTrack_

private

Definition at line 109 of file RecoTauQualityCuts.h.

double reco::tau::RecoTauQualityCuts::maxTrackChi2_

private

Definition at line 104 of file RecoTauQualityCuts.h.

double reco::tau::RecoTauQualityCuts::maxTransverseImpactParameter_

private

Definition at line 107 of file RecoTauQualityCuts.h.

double reco::tau::RecoTauQualityCuts::minGammaEt_

private

Definition at line 111 of file RecoTauQualityCuts.h.

double reco::tau::RecoTauQualityCuts::minNeutralHadronEt_

private

Definition at line 112 of file RecoTauQualityCuts.h.

int reco::tau::RecoTauQualityCuts::minTrackHits_

private

Definition at line 106 of file RecoTauQualityCuts.h.

int reco::tau::RecoTauQualityCuts::minTrackPixelHits_

private

Definition at line 105 of file RecoTauQualityCuts.h.

double reco::tau::RecoTauQualityCuts::minTrackPt_

private

Definition at line 103 of file RecoTauQualityCuts.h.

double reco::tau::RecoTauQualityCuts::minTrackVertexWeight_

private

Definition at line 110 of file RecoTauQualityCuts.h.

reco::VertexRef reco::tau::RecoTauQualityCuts::pv_

mutableprivate

Definition at line 99 of file RecoTauQualityCuts.h.

Referenced by setPV().