Selector< T > Class Template Reference

Functor that operates on <T> More...

#include "CommonTools/Utils/interface/Selector.h"

Inheritance diagram for Selector< T >:

Public Types
typedef std::pair< index_type, size_t >	cut_flow_item
typedef std::vector< cut_flow_item >	cut_flow_map
typedef T	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
void	clear (index_type const &i)
void	clear (std::string const &s)
	Turn off a given selection cut. More...
bool	considerCut (index_type const &i) const
bool	considerCut (std::string const &s) const
	consider the cut at index "s" More...
double	cut (index_type const &i, double val) const
	Access the double cut values at index "s". More...
int	cut (index_type const &i, 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...
int	cut (std::string s, int val) const
	Access the int cut values at index "s". More...
pat::strbitset	getBitTemplate () const
	Get an empty bitset with the proper names. More...
double	getPasses (index_type const &i) const
double	getPasses (std::string const &s) const
	Return the number of passing cases. More...
bool	ignoreCut (index_type const &i) const
bool	ignoreCut (std::string const &s) const
	ignore the cut at index "s" More...
virtual bool	operator() (T const &t)
	This provides an alternative signature without the second ret. More...
virtual bool	operator() (T const &t, edm::EventBase const &e)
	This provides an alternative signature that includes extra information. More...
virtual bool	operator() (T const &t, edm::EventBase const &e, pat::strbitset &ret)
	This provides an alternative signature that includes extra information. More...
virtual bool	operator() (T const &t, pat::strbitset &ret)=0
	This provides the interface for base classes to select objects. More...
bool	operator[] (index_type const &i) const
bool	operator[] (std::string const &s) const
void	passCut (pat::strbitset &ret, index_type const &i)
void	passCut (pat::strbitset &ret, std::string const &s)
	Passing cuts. More...
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, double cut)
	This is the registration of an individual cut string, with a double cut value. 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...
	Selector ()
	Constructor clears the bits. More...
void	set (index_type const &i, bool val=true)
void	set (index_type const &i, double cut, bool val=true)
void	set (index_type const &i, int cut, bool val=true)
void	set (std::string const &s, bool val=true)
	Set a given selection cut, on or off. More...
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 (std::string const &s, int cut, bool val=true)
	Set a given selection cut, on or off, and reset int cut value. More...
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 ()

Protected Attributes
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

template<class T>
class Selector< T >

Functor that operates on <T>

Implements a string-indexed bit_vector.

class template that implements an interface to Selector utilities. This allows the user to access individual cuts based on a string index. The user can then turn individual cuts on and off at will.

Author

Salvatore Rappoccio

Definition at line 22 of file Selector.h.

Member Typedef Documentation

cut_flow_item

template<class T>

typedef std::pair<index_type, size_t> Selector< T >::cut_flow_item

Definition at line 26 of file Selector.h.

cut_flow_map

template<class T>

typedef std::vector<cut_flow_item> Selector< T >::cut_flow_map

Definition at line 27 of file Selector.h.

data_type

template<class T>

typedef T Selector< T >::data_type

Definition at line 24 of file Selector.h.

double_map

template<class T>

typedef std::map<index_type, double> Selector< T >::double_map

Definition at line 29 of file Selector.h.

index_type

template<class T>

typedef pat::strbitset::index_type Selector< T >::index_type

Definition at line 25 of file Selector.h.

int_map

template<class T>

typedef std::map<index_type, int> Selector< T >::int_map

Definition at line 28 of file Selector.h.

Constructor & Destructor Documentation

Selector()

template<class T>

Selector< T >::Selector ( )

inline

Constructor clears the bits.

Definition at line 32 of file Selector.h.

             {
    bits_.clear();
    intCuts_.clear();
    doubleCuts_.clear();
    cutFlow_.clear();
    retInternal_ = getBitTemplate();
  }

~Selector()

template<class T>

virtual Selector< T >::~Selector ( )

inlinevirtual

Definition at line 39 of file Selector.h.

{}

Member Function Documentation

clear() [1/2]

template<class T>

void Selector< T >::clear ( index_type const &  i )

inline

Definition at line 113 of file Selector.h.

{ bits_[i] = false; }

clear() [2/2]

template<class T>

void Selector< T >::clear ( std::string const &  s )

inline

Turn off a given selection cut.

Definition at line 111 of file Selector.h.

{ clear(index_type(&bits_, s)); }

Referenced by Selector< edm::Ptr< reco::Photon > >::clear().

considerCut() [1/2]

template<class T>

bool Selector< T >::considerCut ( index_type const &  i ) const

inline

Definition at line 124 of file Selector.h.

{ return bits_[i] == true; }

considerCut() [2/2]

template<class T>

bool Selector< T >::considerCut ( std::string const &  s ) const

inline

consider the cut at index "s"

Definition at line 123 of file Selector.h.

{ return bits_[s] == true; }

Referenced by Selector< edm::Ptr< reco::Photon > >::print(), and Selector< edm::Ptr< reco::Photon > >::printActiveCuts().

cut() [1/4]

template<class T>

double Selector< T >::cut ( index_type const &  i, double  val  ) const

inline

Access the double cut values at index "s".

Definition at line 160 of file Selector.h.

{ return doubleCuts_.find(i)->second; };

cut() [2/4]

template<class T>

int Selector< T >::cut ( index_type const &  i, int  val  ) const

inline

Access the int cut values at index "s".

Definition at line 158 of file Selector.h.

{ return intCuts_.find(i)->second; };

Referenced by Selector< edm::Ptr< reco::Photon > >::push_back(), and Selector< edm::Ptr< reco::Photon > >::set().

cut() [3/4]

template<class T>

double Selector< T >::cut ( std::string  s, double  val  ) const

inline

Access the double cut values at index "s".

Definition at line 165 of file Selector.h.

{ return cut(index_type(&bits_, s), val); };

Referenced by Selector< edm::Ptr< reco::Photon > >::cut().

cut() [4/4]

template<class T>

int Selector< T >::cut ( std::string  s, int  val  ) const

inline

Access the int cut values at index "s".

Definition at line 163 of file Selector.h.

{ return cut(index_type(&bits_, s), val); };

Referenced by Selector< edm::Ptr< reco::Photon > >::cut().

getBitTemplate()

template<class T>

pat::strbitset Selector< T >::getBitTemplate ( ) const

inline

Get an empty bitset with the proper names.

Definition at line 168 of file Selector.h.

                                      {
    pat::strbitset ret = bits_;
    ret.set(false);
    for (cut_flow_map::const_iterator cutsBegin = cutFlow_.begin(), cutsEnd = cutFlow_.end(), icut = cutsBegin;
         icut != cutsEnd;
         ++icut) {
      if (ignoreCut(icut->first))
        ret[icut->first] = true;
    }
    return ret;
  }

Referenced by SimpleJetFilter::filter(), WPlusJetsEventSelector::operator()(), Selector< edm::Ptr< reco::Photon > >::Selector(), and VersionedSelector< edm::Ptr< reco::Photon > >::VersionedSelector().

getPasses() [1/2]

template<class T>

double Selector< T >::getPasses ( index_type const &  i ) const

inline

Definition at line 228 of file Selector.h.

                                              {
    cut_flow_map::const_iterator found = cutFlow_.end();
    for (cut_flow_map::const_iterator cutsBegin = cutFlow_.begin(), cutsEnd = cutFlow_.end(), icut = cutsBegin;
         icut != cutsEnd && found == cutsEnd;
         ++icut) {
      if (icut->first == i) {
        found = icut;
      }
    }
    return found->second;
  }

getPasses() [2/2]

template<class T>

double Selector< T >::getPasses ( std::string const &  s ) const

inline

Return the number of passing cases.

Definition at line 227 of file Selector.h.

{ return getPasses(index_type(&bits_, s)); }

Referenced by Selector< edm::Ptr< reco::Photon > >::getPasses().

ignoreCut() [1/2]

template<class T>

bool Selector< T >::ignoreCut ( index_type const &  i ) const

inline

Definition at line 128 of file Selector.h.

{ return bits_[i] == false; }

ignoreCut() [2/2]

template<class T>

bool Selector< T >::ignoreCut ( std::string const &  s ) const

inline

ignore the cut at index "s"

Definition at line 127 of file Selector.h.

{ return bits_[s] == false; }

Referenced by Selector< edm::Ptr< reco::Photon > >::getBitTemplate(), VersionedSelector< edm::Ptr< reco::Photon > >::operator()(), and Selector< edm::Ptr< reco::Photon > >::setIgnored().

operator()() [1/4]

template<class T>

virtual bool Selector< T >::operator() ( T const &  t )

inlinevirtual

This provides an alternative signature without the second ret.

Reimplemented in VersionedSelector< T >, VersionedSelector< edm::Ptr< reco::Photon > >, VersionedSelector< edm::Ptr< reco::Muon > >, VersionedSelector< edm::Ptr< reco::GsfElectron > >, VersionedSelector< edm::Ptr< pat::Photon > >, and VersionedSelector< edm::Ptr< pat::Electron > >.

Definition at line 74 of file Selector.h.

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

operator()() [2/4]

template<class T>

virtual bool Selector< T >::operator() ( T const &  t, edm::EventBase const &  e  )

inlinevirtual

This provides an alternative signature that includes extra information.

Reimplemented in VersionedSelector< T >, VersionedSelector< edm::Ptr< reco::Photon > >, VersionedSelector< edm::Ptr< reco::Muon > >, VersionedSelector< edm::Ptr< reco::GsfElectron > >, VersionedSelector< edm::Ptr< pat::Photon > >, and VersionedSelector< edm::Ptr< pat::Electron > >.

Definition at line 85 of file Selector.h.

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

operator()() [3/4]

template<class T>

virtual bool Selector< T >::operator() ( T const &  t, edm::EventBase const &  e, pat::strbitset &  ret  )

inlinevirtual

This provides an alternative signature that includes extra information.

Reimplemented in VersionedSelector< T >, MuonVPlusJetsIDSelectionFunctor, VersionedSelector< edm::Ptr< reco::Photon > >, VersionedSelector< edm::Ptr< reco::Muon > >, VersionedSelector< edm::Ptr< reco::GsfElectron > >, VersionedSelector< edm::Ptr< pat::Photon > >, and VersionedSelector< edm::Ptr< pat::Electron > >.

Definition at line 82 of file Selector.h.

{ return operator()(t, ret); }

Referenced by Selector< edm::Ptr< reco::Photon > >::operator()().

operator()() [4/4]

template<class T>

virtual bool Selector< T >::operator() ( T const &  t, pat::strbitset &  ret  )

pure virtual

This provides the interface for base classes to select objects.

Implemented in PVObjectSelector, PVSelector, VersionedSelector< T >, MuonVPlusJetsIDSelectionFunctor, PFMuonSelector, JetIDSelectionFunctor, PFJetIDSelectionFunctor, SimpleCutBasedElectronIDSelectionFunctor, ElectronVPlusJetsIDSelectionFunctor, VersionedSelector< edm::Ptr< reco::Photon > >, VersionedSelector< edm::Ptr< reco::Muon > >, VersionedSelector< edm::Ptr< reco::GsfElectron > >, VersionedSelector< edm::Ptr< pat::Photon > >, and VersionedSelector< edm::Ptr< pat::Electron > >.

Referenced by Selector< edm::Ptr< reco::Photon > >::operator()().

operator[]() [1/2]

template<class T>

bool Selector< T >::operator[] ( index_type const &  i ) const

inline

Definition at line 120 of file Selector.h.

{ return bits_[i]; }

operator[]() [2/2]

template<class T>

bool Selector< T >::operator[] ( std::string const &  s ) const

inline

Access the selector cut at index "s". "true" means to consider the cut. "false" means to ignore the cut.

Definition at line 118 of file Selector.h.

{ return bits_[s]; }

passCut() [1/2]

template<class T>

void Selector< T >::passCut ( pat::strbitset &  ret, index_type const &  i  )

inline

Definition at line 144 of file Selector.h.

                                                       {
    ret[i] = true;
    cut_flow_map::iterator found = cutFlow_.end();
    for (cut_flow_map::iterator cutsBegin = cutFlow_.begin(), cutsEnd = cutFlow_.end(), icut = cutsBegin;
         icut != cutsEnd && found == cutsEnd;
         ++icut) {
      if (icut->first == i) {
        found = icut;
      }
    }
    ++(found->second);
  }

passCut() [2/2]

template<class T>

void Selector< T >::passCut ( pat::strbitset &  ret, std::string const &  s  )

inline

Passing cuts.

Definition at line 142 of file Selector.h.

{ passCut(ret, index_type(&bits_, s)); }

Referenced by VersionedSelector< edm::Ptr< reco::Photon > >::operator()(), and Selector< edm::Ptr< reco::Photon > >::passCut().

print()

template<class T>

void Selector< T >::print ( std::ostream &  out ) const

inline

Print the cut flow.

Definition at line 191 of file Selector.h.

                                    {
    for (cut_flow_map::const_iterator cutsBegin = cutFlow_.begin(), cutsEnd = cutFlow_.end(), icut = cutsBegin;
         icut != cutsEnd;
         ++icut) {
      char buff[1000];
      if (considerCut(icut->first)) {
        sprintf(buff,
                "%6lu : %20s %10lu",
                static_cast<unsigned long>(icut - cutsBegin),
                icut->first.str().c_str(),
                static_cast<unsigned long>(icut->second));
      } else {
        sprintf(
            buff, "%6lu : %20s %10s", static_cast<unsigned long>(icut - cutsBegin), icut->first.str().c_str(), "off");
      }
      out << buff << std::endl;
    }
  }

Referenced by WPlusJetsEventSelector::printSelectors().

printActiveCuts()

template<class T>

void Selector< T >::printActiveCuts ( std::ostream &  out ) const

inline

Print the cuts being considered.

Definition at line 211 of file Selector.h.

                                              {
    bool already_printed_one = false;
    for (cut_flow_map::const_iterator cutsBegin = cutFlow_.begin(), cutsEnd = cutFlow_.end(), icut = cutsBegin;
         icut != cutsEnd;
         ++icut) {
      if (considerCut(icut->first)) {
        if (already_printed_one)
          out << ", ";
        out << icut->first;
        already_printed_one = true;
      }
    }
    out << std::endl;
  }

push_back() [1/3]

template<class T>

virtual void Selector< T >::push_back ( std::string const &  s )

inlinevirtual

This is the registration of an individual cut string.

Definition at line 42 of file Selector.h.

                                             {
    bits_.push_back(s);
    index_type i(&bits_, s);
    // don't need to check to see if the key is already there,
    // bits_ does that.
    cutFlow_.push_back(cut_flow_item(i, 0));
  }

push_back() [2/3]

template<class T>

virtual void Selector< T >::push_back ( std::string const &  s, double  cut  )

inlinevirtual

This is the registration of an individual cut string, with a double cut value.

Definition at line 61 of file Selector.h.

                                                         {
    bits_.push_back(s);
    index_type i(&bits_, s);
    doubleCuts_[i] = cut;
    // don't need to check to see if the key is already there,
    // bits_ does that.
    cutFlow_.push_back(cut_flow_item(i, 0));
  }

push_back() [3/3]

template<class T>

virtual void Selector< T >::push_back ( std::string const &  s, int  cut  )

inlinevirtual

This is the registration of an individual cut string, with an int cut value.

Definition at line 51 of file Selector.h.

                                                      {
    bits_.push_back(s);
    index_type i(&bits_, s);
    intCuts_[i] = cut;
    // don't need to check to see if the key is already there,
    // bits_ does that.
    cutFlow_.push_back(cut_flow_item(i, 0));
  }

set() [1/6]

template<class T>

void Selector< T >::set ( index_type const &  i, bool  val = true  )

inline

Definition at line 94 of file Selector.h.

{ bits_[i] = val; }

set() [2/6]

template<class T>

void Selector< T >::set ( index_type const &  i, double  cut, bool  val = true  )

inline

Definition at line 105 of file Selector.h.

                                                             {
    bits_[i] = val;
    doubleCuts_[i] = cut;
  }

set() [3/6]

template<class T>

void Selector< T >::set ( index_type const &  i, int  cut, bool  val = true  )

inline

Definition at line 98 of file Selector.h.

                                                          {
    bits_[i] = val;
    intCuts_[i] = cut;
  }

set() [4/6]

template<class T>

void Selector< T >::set ( std::string const &  s, bool  val = true  )

inline

Set a given selection cut, on or off.

Definition at line 93 of file Selector.h.

{ set(index_type(&bits_, s), val); }

Referenced by pat::Flags::get(), Selector< edm::Ptr< reco::Photon > >::set(), and Selector< edm::Ptr< reco::Photon > >::setIgnoredCuts().

set() [5/6]

template<class T>

void Selector< T >::set ( std::string const &  s, double  cut, bool  val = true  )

inline

Set a given selection cut, on or off, and reset int cut value.

Definition at line 104 of file Selector.h.

{ set(index_type(&bits_, s), cut); }

Referenced by Selector< edm::Ptr< reco::Photon > >::set().

set() [6/6]

template<class T>

void Selector< T >::set ( std::string const &  s, int  cut, bool  val = true  )

inline

Set a given selection cut, on or off, and reset int cut value.

Definition at line 97 of file Selector.h.

{ set(index_type(&bits_, s), cut); }

Referenced by Selector< edm::Ptr< reco::Photon > >::set().

setIgnored()

template<class T>

void Selector< T >::setIgnored ( pat::strbitset &  ret )

inline

set ignored bits

Definition at line 181 of file Selector.h.

                                     {
    for (cut_flow_map::const_iterator cutsBegin = cutFlow_.begin(), cutsEnd = cutFlow_.end(), icut = cutsBegin;
         icut != cutsEnd;
         ++icut) {
      if (ignoreCut(icut->first))
        ret[icut->first] = true;
    }
  }

Referenced by VersionedSelector< edm::Ptr< reco::Photon > >::operator()(), and Selector< edm::Ptr< reco::Photon > >::operator()().

setIgnoredCuts()

template<class T>

void Selector< T >::setIgnoredCuts ( std::vector< std::string > const &  bitsToIgnore )

inline

set the bits to ignore from a vector

Definition at line 131 of file Selector.h.

                                                                {
    for (std::vector<std::string>::const_iterator ignoreBegin = bitsToIgnore.begin(),
                                                  ignoreEnd = bitsToIgnore.end(),
                                                  ibit = ignoreBegin;
         ibit != ignoreEnd;
         ++ibit) {
      set(*ibit, false);
    }
  }

Member Data Documentation

bits_

template<class T>

pat::strbitset Selector< T >::bits_

protected

the bitset indexed by strings

Definition at line 241 of file Selector.h.

Referenced by Selector< edm::Ptr< reco::Photon > >::clear(), Selector< edm::Ptr< reco::Photon > >::considerCut(), Selector< edm::Ptr< reco::Photon > >::cut(), Selector< edm::Ptr< reco::Photon > >::getBitTemplate(), Selector< edm::Ptr< reco::Photon > >::getPasses(), Selector< edm::Ptr< reco::Photon > >::ignoreCut(), Selector< edm::Ptr< reco::Photon > >::operator[](), Selector< edm::Ptr< reco::Photon > >::passCut(), Selector< edm::Ptr< reco::Photon > >::push_back(), Selector< edm::Ptr< reco::Photon > >::Selector(), and Selector< edm::Ptr< reco::Photon > >::set().

cutFlow_

template<class T>

cut_flow_map Selector< T >::cutFlow_

protected

map of cut flows in "human" order

Definition at line 245 of file Selector.h.

Referenced by Selector< edm::Ptr< reco::Photon > >::getBitTemplate(), Selector< edm::Ptr< reco::Photon > >::getPasses(), Selector< edm::Ptr< reco::Photon > >::passCut(), Selector< edm::Ptr< reco::Photon > >::print(), Selector< edm::Ptr< reco::Photon > >::printActiveCuts(), Selector< edm::Ptr< reco::Photon > >::push_back(), Selector< edm::Ptr< reco::Photon > >::Selector(), and Selector< edm::Ptr< reco::Photon > >::setIgnored().

doubleCuts_

template<class T>

double_map Selector< T >::doubleCuts_

protected

the double-value cut map

Definition at line 244 of file Selector.h.

Referenced by Selector< edm::Ptr< reco::Photon > >::cut(), Selector< edm::Ptr< reco::Photon > >::push_back(), Selector< edm::Ptr< reco::Photon > >::Selector(), and Selector< edm::Ptr< reco::Photon > >::set().

intCuts_

template<class T>

int_map Selector< T >::intCuts_

protected

the int-value cut map

Definition at line 243 of file Selector.h.

Referenced by Selector< edm::Ptr< reco::Photon > >::cut(), Selector< edm::Ptr< reco::Photon > >::push_back(), Selector< edm::Ptr< reco::Photon > >::Selector(), and Selector< edm::Ptr< reco::Photon > >::set().

retInternal_

template<class T>

pat::strbitset Selector< T >::retInternal_

protected

internal ret if users don't care about return bits

Definition at line 242 of file Selector.h.

Referenced by Selector< edm::Ptr< reco::Photon > >::operator()(), VersionedSelector< edm::Ptr< reco::Photon > >::operator()(), Selector< edm::Ptr< reco::Photon > >::Selector(), and VersionedSelector< edm::Ptr< reco::Photon > >::VersionedSelector().