PFJetIDSelectionFunctor Class Reference

PF Jet selector for pat::Jets. More...

#include "PhysicsTools/Utilities/interface/PFJetIDSelectionFunctor.h"

Inheritance diagram for PFJetIDSelectionFunctor:

Public Types
enum	Quality_t { LOOSE, TIGHT, N_QUALITY }
enum	Version_t { FIRSTDATA, N_VERSIONS }
Public Types inherited from Selector< pat::Jet >
typedef std::binary_function < pat::Jet, pat::strbitset, bool >	base_type
typedef std::pair< index_type, size_t >	cut_flow_item
typedef std::vector < cut_flow_item >	cut_flow_map
typedef pat::Jet	data_type
typedef std::map< index_type, double >	double_map
typedef pat::strbitset::index_type	index_type
typedef std::map< index_type, int >	int_map

Public Member Functions
bool	firstDataCuts (reco::Jet const &jet, pat::strbitset &ret)
bool	operator() (const pat::Jet &jet, pat::strbitset &ret)
	This provides the interface for base classes to select objects. More...
bool	operator() (const reco::PFJet &jet, pat::strbitset &ret)
bool	operator() (const reco::PFJet &jet)
	PFJetIDSelectionFunctor ()
	PFJetIDSelectionFunctor (edm::ParameterSet const &params)
	PFJetIDSelectionFunctor (Version_t version, Quality_t quality)
Public Member Functions inherited from Selector< pat::Jet >
void	clear (std::string const &s)
	Turn off a given selection cut. More...
void	clear (index_type const &i)
bool	considerCut (std::string const &s) const
	consider the cut at index "s" More...
bool	considerCut (index_type const &i) const
int	cut (index_type const &i, int val) const
	Access the int cut values at index "s". More...
double	cut (index_type const &i, double val) const
	Access the double cut values at index "s". More...
int	cut (std::string s, int val) const
	Access the int cut values at index "s". More...
double	cut (std::string s, double val) const
	Access the double cut values at index "s". More...
pat::strbitset	getBitTemplate () const
	Get an empty bitset with the proper names. More...
double	getPasses (std::string const &s) const
	Return the number of passing cases. More...
double	getPasses (index_type const &i) const
bool	ignoreCut (std::string const &s) const
	ignore the cut at index "s" More...
bool	ignoreCut (index_type const &i) const
virtual bool	operator() (pat::Jetconst &t)
	This provides an alternative signature without the second ret. More...
virtual bool	operator() (pat::Jetconst &t, edm::EventBase const &e, pat::strbitset &ret)
	This provides an alternative signature that includes extra information. More...
virtual bool	operator() (pat::Jetconst &t, edm::EventBase const &e)
	This provides an alternative signature that includes extra information. More...
bool	operator[] (std::string const &s) const
bool	operator[] (index_type const &i) const
void	passCut (pat::strbitset &ret, std::string const &s)
	Passing cuts. More...
void	passCut (pat::strbitset &ret, index_type const &i)
void	print (std::ostream &out) const
	Print the cut flow. More...
void	printActiveCuts (std::ostream &out) const
	Print the cuts being considered. More...
virtual void	push_back (std::string const &s)
	This is the registration of an individual cut string. More...
virtual void	push_back (std::string const &s, int cut)
	This is the registration of an individual cut string, with an int cut value. More...
virtual void	push_back (std::string const &s, double cut)
	This is the registration of an individual cut string, with a double cut value. More...
	Selector ()
	Constructor clears the bits. More...
void	set (std::string const &s, bool val=true)
	Set a given selection cut, on or off. More...
void	set (index_type const &i, bool val=true)
void	set (std::string const &s, int cut, bool val=true)
	Set a given selection cut, on or off, and reset int cut value. More...
void	set (index_type const &i, int cut, bool val=true)
void	set (std::string const &s, double cut, bool val=true)
	Set a given selection cut, on or off, and reset int cut value. More...
void	set (index_type const &i, double cut, bool val=true)
void	setIgnored (pat::strbitset &ret)
	set ignored bits More...
void	setIgnoredCuts (std::vector< std::string > const &bitsToIgnore)
	set the bits to ignore from a vector More...
virtual	~Selector ()

Private Attributes
index_type	indexCEF_
index_type	indexCHF_
index_type	indexNCH_
index_type	indexNConstituents_
index_type	indexNEF_
index_type	indexNHF_
Quality_t	quality_
Version_t	version_

Additional Inherited Members
Protected Attributes inherited from Selector< pat::Jet >
pat::strbitset	bits_
	the bitset indexed by strings More...
cut_flow_map	cutFlow_
	map of cut flows in "human" order More...
double_map	doubleCuts_
	the double-value cut map More...
int_map	intCuts_
	the int-value cut map More...
pat::strbitset	retInternal_
	internal ret if users don't care about return bits More...

Detailed Description

PF Jet selector for pat::Jets.

Selector functor for pat::Jets that implements quality cuts based on studies of noise patterns.

Please see https://twiki.cern.ch/twiki/bin/view/CMS/SWGuidePATSelectors for a general overview of the selectors.

Author

Salvatore Rappoccio

Version

Id:

PFJetIDSelectionFunctor.h,v 1.23 2012/05/25 08:12:18 veelken Exp

Definition at line 28 of file PFJetIDSelectionFunctor.h.

Member Enumeration Documentation

enum PFJetIDSelectionFunctor::Quality_t

Enumerator
LOOSE
TIGHT
N_QUALITY

Definition at line 33 of file PFJetIDSelectionFunctor.h.

{ LOOSE, TIGHT, N_QUALITY};

enum PFJetIDSelectionFunctor::Version_t

Enumerator
FIRSTDATA
N_VERSIONS

Definition at line 32 of file PFJetIDSelectionFunctor.h.

{ FIRSTDATA, N_VERSIONS };

Constructor & Destructor Documentation

PFJetIDSelectionFunctor::PFJetIDSelectionFunctor ( )

inline

Definition at line 35 of file PFJetIDSelectionFunctor.h.

{}

PFJetIDSelectionFunctor::PFJetIDSelectionFunctor ( edm::ParameterSet const &  params )

inline

will have other options eventually, most likely

Definition at line 37 of file PFJetIDSelectionFunctor.h.

References Selector< pat::Jet >::bits_, edm::ParameterSet::exists(), FIRSTDATA, Selector< pat::Jet >::getBitTemplate(), edm::ParameterSet::getParameter(), indexCEF_, indexCHF_, indexNCH_, indexNConstituents_, indexNEF_, indexNHF_, LOOSE, Selector< pat::Jet >::push_back(), quality_, Selector< pat::Jet >::retInternal_, Selector< pat::Jet >::set(), Selector< pat::Jet >::setIgnoredCuts(), TIGHT, and version_.

 {
   std::string versionStr = params.getParameter<std::string>("version");
   std::string qualityStr = params.getParameter<std::string>("quality");

   if ( versionStr == "FIRSTDATA" ) 
     version_ = FIRSTDATA;
   else
     version_ = FIRSTDATA;  

   if      ( qualityStr == "LOOSE") quality_ = LOOSE;
   else if ( qualityStr == "TIGHT") quality_ = TIGHT;
   else quality_ = LOOSE;

    push_back("CHF" );
    push_back("NHF" );
    push_back("CEF" );
    push_back("NEF" );
    push_back("NCH" );
    push_back("nConstituents");


    // Set some default cuts for LOOSE, TIGHT
    if ( quality_ == LOOSE ) {
      set("CHF", 0.0);
      set("NHF", 0.99);
      set("CEF", 0.99);
      set("NEF", 0.99);
      set("NCH", 0);
      set("nConstituents", 1);
    } else if ( quality_ == TIGHT ) {
      set("CHF", 0.0);
      set("NHF", 0.9);
      set("CEF", 0.99);
      set("NEF", 0.9);
      set("NCH", 0);
      set("nConstituents", 1);      
    }


    // Now check the configuration to see if the user changed anything
    if ( params.exists("CHF") ) set("CHF", params.getParameter<double>("CHF") );
    if ( params.exists("NHF") ) set("NHF", params.getParameter<double>("NHF") );
    if ( params.exists("CEF") ) set("CEF", params.getParameter<double>("CEF") );
    if ( params.exists("NEF") ) set("NEF", params.getParameter<double>("NEF") );
    if ( params.exists("NCH") ) set("NCH", params.getParameter<int>   ("NCH") );
    if ( params.exists("nConstuents") ) set("nConstituents", params.getParameter<int> ("nConstituents") );

    if ( params.exists("cutsToIgnore") )
      setIgnoredCuts( params.getParameter<std::vector<std::string> >("cutsToIgnore") );


    indexNConstituents_ = index_type (&bits_, "nConstituents");
    indexNEF_ = index_type (&bits_, "NEF");
    indexNHF_ = index_type (&bits_, "NHF");
    indexCEF_ = index_type (&bits_, "CEF");
    indexCHF_ = index_type (&bits_, "CHF");
    indexNCH_ = index_type (&bits_, "NCH");

    retInternal_ = getBitTemplate();
    
  }

PFJetIDSelectionFunctor::PFJetIDSelectionFunctor ( Version_t  version, Quality_t  quality  )

inline

Definition at line 101 of file PFJetIDSelectionFunctor.h.

References Selector< pat::Jet >::bits_, Selector< pat::Jet >::getBitTemplate(), indexCEF_, indexCHF_, indexNCH_, indexNConstituents_, indexNEF_, indexNHF_, LOOSE, Selector< pat::Jet >::push_back(), quality_, Selector< pat::Jet >::retInternal_, Selector< pat::Jet >::set(), and TIGHT.

                                  :
  version_(version), quality_(quality)
 {

    push_back("CHF" );
    push_back("NHF" );
    push_back("CEF" );
    push_back("NEF" );
    push_back("NCH" );
    push_back("nConstituents");


    // Set some default cuts for LOOSE, TIGHT
    if ( quality_ == LOOSE ) {
      set("CHF", 0.0);
      set("NHF", 0.99);
      set("CEF", 0.99);
      set("NEF", 0.99);
      set("NCH", 0);
      set("nConstituents", 1);
    } else if ( quality_ == TIGHT ) {
      set("CHF", 0.0);
      set("NHF", 0.9);
      set("CEF", 0.99);
      set("NEF", 0.9);
      set("NCH", 0);
      set("nConstituents", 1);      
    }


    indexNConstituents_ = index_type (&bits_, "nConstituents");
    indexNEF_ = index_type (&bits_, "NEF");
    indexNHF_ = index_type (&bits_, "NHF");
    indexCEF_ = index_type (&bits_, "CEF");
    indexCHF_ = index_type (&bits_, "CHF");
    indexNCH_ = index_type (&bits_, "NCH");

    retInternal_ = getBitTemplate();   
 }

Member Function Documentation

bool PFJetIDSelectionFunctor::firstDataCuts ( reco::Jet const &  jet, pat::strbitset &  ret  )

inline

Definition at line 183 of file PFJetIDSelectionFunctor.h.

References abs, reco::CompositePtrCandidate::begin(), reco::PFJet::chargedEmEnergy(), pat::Jet::chargedEmEnergyFraction(), reco::PFJet::chargedHadronEnergy(), pat::Jet::chargedHadronEnergyFraction(), reco::PFJet::chargedMultiplicity(), pat::Jet::chargedMultiplicity(), Selector< pat::Jet >::cut(), alignCSCRings::e, reco::PFJet::electronEnergy(), reco::CompositePtrCandidate::end(), reco::LeafCandidate::energy(), reco::LeafCandidate::eta(), reco::PFJet::HFEMEnergy(), reco::PFJet::HFHadronEnergy(), pat::Jet::HFHadronEnergy(), Selector< pat::Jet >::ignoreCut(), indexCEF_, indexCHF_, indexNCH_, indexNConstituents_, indexNEF_, indexNHF_, pat::Jet::isBasicJet(), pat::Jet::isPFJet(), metsig::jet, reco::PFJet::muonEnergy(), reco::PFJet::neutralEmEnergy(), pat::Jet::neutralEmEnergyFraction(), reco::PFJet::neutralHadronEnergy(), pat::Jet::neutralHadronEnergy(), reco::CompositePtrCandidate::numberOfDaughters(), pat::Jet::numberOfDaughters(), Selector< pat::Jet >::passCut(), reco::PFJet::photonEnergy(), run_regression::ret, pat::strbitset::set(), and Selector< pat::Jet >::setIgnored().

Referenced by operator()().

  {    
    ret.set(false);

    // cache some variables
    double chf = 0.0;
    double nhf = 0.0;
    double cef = 0.0;
    double nef = 0.0;
    int    nch = 0;
    int    nconstituents = 0;

    // Have to do this because pat::Jet inherits from reco::Jet but not reco::PFJet
    reco::PFJet const * pfJet = dynamic_cast<reco::PFJet const *>(&jet);
    pat::Jet const * patJet = dynamic_cast<pat::Jet const *>(&jet);
    reco::BasicJet const * basicJet = dynamic_cast<reco::BasicJet const *>(&jet);

    if ( patJet != 0 ) {
      if ( patJet->isPFJet() ) {
    chf = patJet->chargedHadronEnergyFraction();
    nhf = ( patJet->neutralHadronEnergy() + patJet->HFHadronEnergy() ) / patJet->energy();
    cef = patJet->chargedEmEnergyFraction();
    nef = patJet->neutralEmEnergyFraction();
    nch = patJet->chargedMultiplicity();
    nconstituents = patJet->numberOfDaughters();
      } 
      // Handle the special case where this is a composed jet for
      // subjet analyses
      else if ( patJet->isBasicJet() ) {
    double e_chf = 0.0;
    double e_nhf = 0.0;
    double e_cef = 0.0;
    double e_nef = 0.0;
    nch = 0;
    nconstituents = 0;

    for ( reco::Jet::const_iterator ibegin = patJet->begin(),
        iend = patJet->end(), isub = ibegin;
          isub != iend; ++isub ) {
      reco::PFJet const * pfsub = dynamic_cast<reco::PFJet const *>( &*isub );
      e_chf += pfsub->chargedHadronEnergy();
      e_nhf += (pfsub->neutralHadronEnergy() + pfsub->HFHadronEnergy());
      e_cef += pfsub->chargedEmEnergy();
      e_nef += pfsub->neutralEmEnergy();
      nch += pfsub->chargedMultiplicity();
      nconstituents += pfsub->numberOfDaughters();
    }
    double e = patJet->energy();
    if ( e > 0.000001 ) {
      chf = e_chf / e;
      nhf = e_nhf / e;
      cef = e_cef / e;
      nef = e_nef / e;
    } else {
      chf = nhf = cef = nef = 0.0;
    }
      }
    } // end if pat jet
    else if ( pfJet != 0 ) {
      // CV: need to compute energy fractions in a way that works for corrected as well as for uncorrected PFJets
      double jetEnergyUncorrected = 
    pfJet->chargedHadronEnergy() 
       + pfJet->neutralHadronEnergy()
       + pfJet->photonEnergy()
       + pfJet->electronEnergy()
       + pfJet->muonEnergy()
       + pfJet->HFHadronEnergy()
       + pfJet->HFEMEnergy();
      if ( jetEnergyUncorrected > 0. ) {
    chf = pfJet->chargedHadronEnergy() / jetEnergyUncorrected;
        nhf = ( pfJet->neutralHadronEnergy() + pfJet->HFHadronEnergy() ) / jetEnergyUncorrected;
        cef = pfJet->chargedEmEnergy() / jetEnergyUncorrected;
        nef = pfJet->neutralEmEnergy() / jetEnergyUncorrected;
      }
      nch = pfJet->chargedMultiplicity();
      nconstituents = pfJet->numberOfDaughters();
    } // end if PF jet
    // Handle the special case where this is a composed jet for
    // subjet analyses
    else if ( basicJet != 0 ) {
      double e_chf = 0.0;
      double e_nhf = 0.0;
      double e_cef = 0.0;
      double e_nef = 0.0;
      nch = 0;
      nconstituents = 0;
      
      for ( reco::Jet::const_iterator ibegin = basicJet->begin(),
          iend = patJet->end(), isub = ibegin;
        isub != iend; ++isub ) {
    reco::PFJet const * pfsub = dynamic_cast<reco::PFJet const *>( &*isub );
    e_chf += pfsub->chargedHadronEnergy();
    e_nhf += (pfsub->neutralHadronEnergy() + pfsub->HFHadronEnergy());
    e_cef += pfsub->chargedEmEnergy();
    e_nef += pfsub->neutralEmEnergy();
    nch += pfsub->chargedMultiplicity();
    nconstituents += pfsub->numberOfDaughters();
      }
      double e = basicJet->energy();
      if ( e > 0.000001 ) {
    chf = e_chf / e;
    nhf = e_nhf / e;
    cef = e_cef / e;
    nef = e_nef / e;
      }
    } // end if basic jet


    // Cuts for all |eta|:
    if ( ignoreCut(indexNConstituents_) || nconstituents > cut(indexNConstituents_, int() ) ) passCut( ret, indexNConstituents_);
    if ( ignoreCut(indexNEF_)           || ( nef < cut(indexNEF_, double()) ) ) passCut( ret, indexNEF_);
    if ( ignoreCut(indexNHF_)           || ( nhf < cut(indexNHF_, double()) ) ) passCut( ret, indexNHF_);    
    // Cuts for |eta| < 2.4:
    if ( ignoreCut(indexCEF_)           || ( cef < cut(indexCEF_, double()) || std::abs(jet.eta()) > 2.4 ) ) passCut( ret, indexCEF_);
    if ( ignoreCut(indexCHF_)           || ( chf > cut(indexCHF_, double()) || std::abs(jet.eta()) > 2.4 ) ) passCut( ret, indexCHF_);
    if ( ignoreCut(indexNCH_)           || ( nch > cut(indexNCH_, int())    || std::abs(jet.eta()) > 2.4 ) ) passCut( ret, indexNCH_);    

    //std::cout << "<PFJetIDSelectionFunctor::firstDataCuts>:" << std::endl;
    //std::cout << " jet: Pt = " << jet.pt() << ", eta = " << jet.eta() << ", phi = " << jet.phi() << std::endl;
    //ret.print(std::cout);

    setIgnored( ret );
    return (bool)ret;
  }

bool PFJetIDSelectionFunctor::operator() ( const pat::Jet &  t, pat::strbitset &  ret  )

inlinevirtual

This provides the interface for base classes to select objects.

Implements Selector< pat::Jet >.

Definition at line 146 of file PFJetIDSelectionFunctor.h.

References pat::Jet::correctedJet(), pat::Jet::currentJECLevel(), FIRSTDATA, firstDataCuts(), pat::Jet::jecSetsAvailable(), run_regression::ret, and version_.

Referenced by operator()().

  {
    if ( version_ == FIRSTDATA ) {
      if ( jet.currentJECLevel() == "Uncorrected" || !jet.jecSetsAvailable() ) 
    return firstDataCuts( jet, ret );
      else 
    return firstDataCuts( jet.correctedJet("Uncorrected"), ret );
    }
    else {
      return false;
    }
  }

bool PFJetIDSelectionFunctor::operator() ( const reco::PFJet &  jet, pat::strbitset &  ret  )

inline

Definition at line 164 of file PFJetIDSelectionFunctor.h.

References FIRSTDATA, firstDataCuts(), and version_.

  {
    if ( version_ == FIRSTDATA ) return firstDataCuts( jet, ret );
    else {
      return false;
    }
  }

bool PFJetIDSelectionFunctor::operator() ( const reco::PFJet &  jet )

inline

Definition at line 172 of file PFJetIDSelectionFunctor.h.

References operator()(), Selector< pat::Jet >::retInternal_, pat::strbitset::set(), and Selector< pat::Jet >::setIgnored().

  {
    retInternal_.set(false);
    operator()(jet, retInternal_);
    setIgnored(retInternal_);
    return (bool)retInternal_;
  }

Member Data Documentation

index_type PFJetIDSelectionFunctor::indexCEF_

private

Definition at line 317 of file PFJetIDSelectionFunctor.h.

Referenced by firstDataCuts(), and PFJetIDSelectionFunctor().

index_type PFJetIDSelectionFunctor::indexCHF_

private

Definition at line 318 of file PFJetIDSelectionFunctor.h.

Referenced by firstDataCuts(), and PFJetIDSelectionFunctor().

index_type PFJetIDSelectionFunctor::indexNCH_

private

Definition at line 319 of file PFJetIDSelectionFunctor.h.

Referenced by firstDataCuts(), and PFJetIDSelectionFunctor().

index_type PFJetIDSelectionFunctor::indexNConstituents_

private

Definition at line 314 of file PFJetIDSelectionFunctor.h.

Referenced by firstDataCuts(), and PFJetIDSelectionFunctor().

index_type PFJetIDSelectionFunctor::indexNEF_

private

Definition at line 315 of file PFJetIDSelectionFunctor.h.

Referenced by firstDataCuts(), and PFJetIDSelectionFunctor().

index_type PFJetIDSelectionFunctor::indexNHF_

private

Definition at line 316 of file PFJetIDSelectionFunctor.h.

Referenced by firstDataCuts(), and PFJetIDSelectionFunctor().

Quality_t PFJetIDSelectionFunctor::quality_

private

Definition at line 312 of file PFJetIDSelectionFunctor.h.

Referenced by PFJetIDSelectionFunctor().

Version_t PFJetIDSelectionFunctor::version_

private

Definition at line 311 of file PFJetIDSelectionFunctor.h.

Referenced by operator()(), and PFJetIDSelectionFunctor().