top::SignValueSelector Class Reference

Many of the tools need a sign (>=) and a value (2). More...

#include <SignValueSelector.h>

Inherits top::EventSelectorBase.

Inherited by top::HTSelector, top::JetNGhostSelector, top::KLFitterSelector, top::METMWTSelector, top::METSelector, top::MLLSelector, top::MWTSelector, top::NElectronNMuonSelector, top::NElectronNMuonTightSelector, top::NElectronSelector, top::NElectronTightSelector, top::NFwdElectronSelector, top::NFwdElectronTightSelector, top::NJetBtagSelector, top::NJetSelector, top::NLargeJetSelector, top::NMuonSelector, top::NMuonTightSelector, top::NPhotonSelector, top::NRCJetSelector, top::NSoftMuonSelector, top::NTauSelector, top::NTauTightSelector, top::NVarRCJetSelector, and top::RunNumberSelector.

Collaboration diagram for top::SignValueSelector:

Public Types
enum	Sign {   signNOIDEA, signEQ, signLT, signGT,   signLTEQ, signGTEQ }
	Many of the tools will be supplied with an equality (or inequality) by the user. More...

Public Member Functions
	SignValueSelector (const std::string &name, std::string params, bool multiplicityMode=false, bool cutValueMode=false)
	Constructor for tools that need a sign and a value. More...
	SignValueSelector (const std::string &name, std::string params, bool multiplicityMode, bool cutValueMode, std::string delim, std::string replace, std::string default_prefix)
	Overloaded constructor with additional options to do string splitting on delimiter and concatantion with a new string. More...
virtual std::string	name () const override
	The name is generated in the constructor for this kind of tool. More...
virtual bool	apply (const top::Event &) const =0
	This does stuff based on the information in an event. More...
virtual bool	applyParticleLevel (const top::ParticleLevelEvent &) const
	This does stuff based on the information in a particle level event. More...

Protected Member Functions
void	checkValueIsInteger ()
	Integers are annoying in C++. More...
void	checkMultiplicityIsInteger ()
	Integers are annoying in C++. More...
Sign	sign () const
	Get the sign setup in the constructor. More...
double	value () const
	Get the cut value assigned in the constructor. More...
std::string	valueString () const
	Get the cut value assigned in the constructor. More...
std::string	valueStringDelimReplace () const
	valueString which is manipulated to replace delimiter with new string More...
double	multiplicity () const
	Get the cut multiplicity assigned in the constructor. More...
Sign	decodesign (std::string &params)
	Take the string params, look for one of the allowed inequalities (or equality) and return that. More...
bool	checkFloat (double value, double cut) const
	Compare a cut supplied by the user with the value calculated in the event. More...
bool	checkInt (int value, int cut) const
	Compare a cut supplied by the user with the value calculated in the event. More...
const std::string	signstring () const
	Convert the sign enum back to a string for use in the name and print outs. More...

Private Attributes
std::string	m_name
	Hold the name of the tool, filled by the constructor. More...
Sign	m_sign
	The sign of the cut, filled by the constructor. More...
double	m_cutvalue
	The value of the cut, filled by the constructor. More...
std::string	m_cutvalueString
	The value of the cut in the case it's a string, filled by the constructor. More...
double	m_multiplicity
	The multiplicity for cuts that take both a value and a multiplicity e.g. EL_N 25000 >= 2. More...
std::string	m_cutvalueStringDelimReplace
	The value of the cut when it is a string, with replacement of delimiter with a replacement substring. More...

Detailed Description

Many of the tools need a sign (>=) and a value (2).

For example, if we want at least two leptons. This is an intermediate 'base' class that implements all the functionality these tools need in one place.

Definition at line 16 of file SignValueSelector.h.

Member Enumeration Documentation

Sign

enum top::SignValueSelector::Sign

Many of the tools will be supplied with an equality (or inequality) by the user.

They're decoded from the text input and saved in this 'sign' format.

Enumerator
signNOIDEA
signEQ
signLT
signGT
signLTEQ
signGTEQ

Definition at line 23 of file SignValueSelector.h.

              {
      signNOIDEA,  //the user clearly did something wrong, expect to exit / crash
      signEQ,      // ==
      signLT,      // <
      signGT,      // >
      signLTEQ,    // <=
      signGTEQ     // >=
    };

Constructor & Destructor Documentation

SignValueSelector() [1/2]

top::SignValueSelector::SignValueSelector	(	const std::string &	name,
		std::string	params,
		bool	multiplicityMode = false,
		bool	cutValueMode = false
	)

Constructor for tools that need a sign and a value.

For example selectors based on multiplicity and cuts.

Parameters

name	The name of the tool to be used in print outs
params	The parameters to setup the tool with. Note that it's not constant because it's edited by the decodesign function (to remove stuff).
multiplicityMode	Will this take both a cut value and a multiplicity. For example b-tagging. MV1 0.5 >= 2. Two mv1 tags of atleast 0.5. The default is the "normal" cut mode for cuts like MET, HT etc.
cutValueMode	The cut value can also be a string, e.g. FixedCutBEff_77 The default behaviour is false (the cut value is not a string). Note that cutValueMode = true only makes sense if multiplicityMode = true

Definition at line 12 of file SignValueSelector.cxx.

                                                          :
    m_sign(signNOIDEA),
    m_cutvalue(0),
    m_cutvalueString(""),
    m_multiplicity(-1) {
    m_cutvalueStringDelimReplace = "";
    //cutValueMode always set to false if multiplicityMode is false
    if (!multiplicityMode) cutValueMode = false;
    //get the sign and remove it from the params text
    m_sign = decodesign(params);
    if (!cutValueMode) std::istringstream(params) >> m_cutvalue >> m_multiplicity;
    else std::istringstream(params) >> m_cutvalueString >> m_multiplicity;
 
    //form the name string for the tool
    std::stringstream ss;
    if (!multiplicityMode) ss << name << " " << signstring() << " " << m_cutvalue;
    else {
      if (m_multiplicity < 0) {
        throw std::runtime_error("Cut value and multiplicity must be set for " + name);
      }
 
      if (!cutValueMode) ss << name << " " << m_cutvalue << " " << signstring() << " " << m_multiplicity;
      else ss << name << " " << m_cutvalueString << " " << signstring() << " " << m_multiplicity;
    }
 
    m_name = ss.str();
  }

SignValueSelector() [2/2]

top::SignValueSelector::SignValueSelector	(	const std::string &	name,
		std::string	params,
		bool	multiplicityMode,
		bool	cutValueMode,
		std::string	delim,
		std::string	replace,
		std::string	default_prefix
	)

Overloaded constructor with additional options to do string splitting on delimiter and concatantion with a new string.

Parameters

delim	- delimiter to split with
replace	- string to replace the delimiter when concatanating
default_prefix	- if it was not possible to split, the code was probably expecting something to be prepended to the string so cover this

Definition at line 41 of file SignValueSelector.cxx.

                                                                 :
    SignValueSelector(name, params, multiplicityMode, cutValueMode) {
    // This function is only if we need a bit of additional string manipulation
    // Required for the btagging selector when we start doing "alg:wp"
    // If string is empty, do the split, otherwise just return the stored value
 
    std::vector<std::string> tokens;
    tokenize(m_cutvalueString, tokens, delim);
    if (tokens.size() > 1) {
      for (const auto& cutString : tokens) {
        m_cutvalueStringDelimReplace += cutString;
        m_cutvalueStringDelimReplace += replace;
      }
      // Tidy up the end of the string
      m_cutvalueStringDelimReplace = m_cutvalueStringDelimReplace.substr(0,
                                                                         m_cutvalueStringDelimReplace.length() -
                                                                         replace.length());
    }
    // We are kind, and keep some backwards compatablity, so incase you did not know the syntax changed, hopefully we
    // provided the most likely default
    else {
      ATH_MSG_INFO("SignValueSelector :: We are using a default_prefix as we could not split on a delimiter.");
      m_cutvalueStringDelimReplace = default_prefix + replace + m_cutvalueString;
      ATH_MSG_INFO("SignValueSelector :: The final result is " << m_cutvalueStringDelimReplace);
    }
  }

Member Function Documentation

apply()

virtual bool top::EventSelectorBase::apply ( const top::Event &  ) const

pure virtualinherited

This does stuff based on the information in an event.

The idea is that you implement this to return either true or false based on the information held within top::Event. If this returns true then the event is kept. If it returns false then the event is removed.

Parameters

top::Event

The current event.

Returns

true if the event should be kept, false otherwise.

Implemented in top::GlobalTrigDecisionSelector, top::GlobalTrigMatchSelector, top::JetResponsePlots, top::TrigDecisionLooseSelector, top::TrigDecisionTightSelector, top::JetFlavorPlots, top::TrigDecisionSelector, top::ExamplePlots, top::JetCleaningSelector, top::JetFtagEffPlots, top::NoBadMuonSelector, top::FakesMMConfigs, top::PrimaryVertexSelector, top::GRLSelector, top::NElectronNMuonTightSelector, top::GoodCaloSelector, top::NElectronNMuonSelector, top::TrigMatchSelector, top::PrintEventSelector, top::NFwdElectronSelector, top::TrackJetCleaningSelector, top::RunNumberSelector, top::HTSelector, top::NJetBtagSelector, top::OSLeptonTightSelector, top::MLLSelector, top::MWTSelector, top::NElectronTightSelector, top::NFwdElectronTightSelector, top::NMuonTightSelector, top::OSLeptonSelector, top::METMWTSelector, top::METSelector, top::MLLWindow, top::NElectronSelector, top::NJetSelector, top::NMuonSelector, top::NPhotonSelector, top::NSoftMuonSelector, top::NTauSelector, top::NTauTightSelector, top::SSLeptonTightSelector, top::NVarRCJetSelector, top::SSLeptonSelector, top::NLargeJetSelector, top::NRCJetSelector, top::NeutrinoWeighting, top::Chi2LJets, top::ParticleLevelSelector, top::RecoLevelSelector, top::Sonnenschein, top::JetNGhostSelector, top::SaveEventSelector, top::PTMaxReco, top::InitialSelector, top::KLFitterRun, top::KLFitterSelector, and top::PseudoTopRecoRun.

applyParticleLevel()

virtual bool top::EventSelectorBase::applyParticleLevel ( const top::ParticleLevelEvent &  ) const

inlinevirtualinherited

This does stuff based on the information in a particle level event.

The idea is that you implement this to return either true or false, based on the information held within the top::ParticleLevelEvent. If this function returns true, then the event is kept, otherwise it is removed. The function has a default implementation (which returns true) because it is expected that many EventSelector objects do not operate on ParticleLevelEvent objects.

Parameters

top::ParticleLevelEvent	the current particle level event.
true	if the event should be kept (i.e. it passed the selector criteria), false otherwise.

Reimplemented in top::JetNGhostSelector, top::PrintEventSelector, top::PseudoTopRecoRun, top::NElectronNMuonTightSelector, top::NElectronNMuonSelector, top::NFwdElectronSelector, top::HTSelector, top::OSLeptonTightSelector, top::MLLSelector, top::MWTSelector, top::NElectronTightSelector, top::NFwdElectronTightSelector, top::NMuonTightSelector, top::OSLeptonSelector, top::METMWTSelector, top::METSelector, top::MLLWindow, top::NElectronSelector, top::NJetSelector, top::NMuonSelector, top::NPhotonSelector, top::NSoftMuonSelector, top::NTauSelector, top::SSLeptonTightSelector, top::SSLeptonSelector, top::ParticleLevelSelector, top::RecoLevelSelector, top::NVarRCJetSelector, top::NLargeJetSelector, and top::NRCJetSelector.

Definition at line 73 of file EventSelectorBase.h.

{return true;}

checkFloat()

bool top::SignValueSelector::checkFloat ( double  value, double  cut  ) const

protected

Compare a cut supplied by the user with the value calculated in the event.

For floating point numbers.

Parameters

value	The value from the event.
cut	The cut the user wants to apply.

Returns

True if the cut is passed.

Definition at line 133 of file SignValueSelector.cxx.

                                                                   {
    switch (m_sign) {
    case signNOIDEA: {
      throw std::runtime_error("SignValueSelector::checkFloat: Can't recognise the sign");
    }
 
    case signEQ: {
      throw std::runtime_error("SignValueSelector::checkFloat: Can't compare floats with ==");
    }
 
    case signLT:
      return value < cut;
 
    case signGT:
      return value > cut;
 
    case signLTEQ:
      return value <= cut;
 
    case signGTEQ:
      return value >= cut;
    }
 
    return false;
  }

checkInt()

bool top::SignValueSelector::checkInt ( int  value, int  cut  ) const

protected

Compare a cut supplied by the user with the value calculated in the event.

For integer numbers.

Parameters

value	The value from the event.
cut	The cut the user wants to apply.

Returns

True if the cut is passed.

Definition at line 159 of file SignValueSelector.cxx.

                                                           {
    switch (m_sign) {
    case signNOIDEA: {
      throw std::runtime_error("SignValueSelector::checkInt: Can't recognise the sign");
    }
 
    case signEQ:
      return value == cut;
 
    case signLT:
      return value < cut;
 
    case signGT:
      return value > cut;
 
    case signLTEQ:
      return value <= cut;
 
    case signGTEQ:
      return value >= cut;
    }
 
    return false;
  }

checkMultiplicityIsInteger()

void top::SignValueSelector::checkMultiplicityIsInteger ( )

protected

Integers are annoying in C++.

Your first thought when reading in an integer is probably just to read it in with cin to an integer variable. This seems to not work, as it'll just read the integer component and ignore the rest of the string. The approach here then is to read it in as a floating point number and ask that number if it is equal to itself rounded down (integers are, fractional numbers are not)

Since the user probably didn't mean to cut on njets >= 2.3 we should interrupt the job and print a useful error message if it doesn't work.

Definition at line 82 of file SignValueSelector.cxx.

                                                     {
    if (multiplicity() != floor(multiplicity())) {
      ATH_MSG_ERROR("The number " << multiplicity() << " is not an integer\n"
          << "As defined in " << name() << "\n");
      throw std::runtime_error("Failed parsing multiplicity cut for SignValueSelector");
    }
  }

checkValueIsInteger()

void top::SignValueSelector::checkValueIsInteger ( )

protected

Integers are annoying in C++.

Mostly used by the NLargeJet selectors.

Definition at line 74 of file SignValueSelector.cxx.

                                              {
    if (value() != floor(value())) {
      ATH_MSG_ERROR("The number " << value() << " is not an integer\n"
          << "As defined in " << name() << "\n");
      throw std::runtime_error("Failed parsing value for SignValueSelector");
    }
  }

decodesign()

SignValueSelector::Sign top::SignValueSelector::decodesign ( std::string &  params )

protected

Take the string params, look for one of the allowed inequalities (or equality) and return that.

It also removes the text from the string so the string can then be passed on to some code to extract the numerical value.

Parameters

params

The string that contains something like ">= 2". It will return the " 2" via the params parameter.

Returns

For the above example, the sign ">=" will be configured.

Definition at line 110 of file SignValueSelector.cxx.

                                                                       {
    Sign tempsign(signNOIDEA);
 
    if (params.find("==") != std::string::npos) {
      tempsign = signEQ;
      params.erase(params.find("=="), 2);
    } else if (params.find("<=") != std::string::npos) {
      tempsign = signLTEQ;
      params.erase(params.find("<="), 2);
    } else if (params.find(">=") != std::string::npos) {
      tempsign = signGTEQ;
      params.erase(params.find(">="), 2);
    } else if (params.find("<") != std::string::npos) {
      tempsign = signLT;
      params.erase(params.find("<"), 1);
    } else if (params.find(">") != std::string::npos) {
      tempsign = signGT;
      params.erase(params.find(">"), 1);
    }
 
    return tempsign;
  }

multiplicity()

double top::SignValueSelector::multiplicity ( ) const

protected

Get the cut multiplicity assigned in the constructor.

This is used for cuts that take a value and a multiplicity, for example EL_N 25000 >= 2 means at least two electrons with pT > 25 GeV. You can chain these together to make non-symmetric cuts. For example EL_N 25000 >= 2 EL_N 40000 >= 1

Returns

The multiplicity is actually integer, but it's stored in a double so that we can check it's an integer when we read it in.

Definition at line 106 of file SignValueSelector.cxx.

                                               {
    return m_multiplicity;
  }

name()

std::string top::SignValueSelector::name ( ) const

overridevirtual

The name is generated in the constructor for this kind of tool.

Implements top::EventSelectorBase.

Reimplemented in top::JetNGhostSelector.

Definition at line 70 of file SignValueSelector.cxx.

                                          {
    return m_name;
  }

sign()

SignValueSelector::Sign top::SignValueSelector::sign ( ) const

protected

Get the sign setup in the constructor.

Definition at line 90 of file SignValueSelector.cxx.

                                                      {
    return m_sign;
  }

signstring()

const std::string top::SignValueSelector::signstring ( ) const

protected

Convert the sign enum back to a string for use in the name and print outs.

Returns

A short string version of the name

Definition at line 184 of file SignValueSelector.cxx.

                                                      {
    switch (m_sign) {
    case signNOIDEA: {
      ATH_MSG_ERROR("SignValueSelector is confused\n"
          << "Check that your cuts have one of: "
          << "==, >, >=, <, <=\n");
      throw std::runtime_error("SignValueSelector::signstring: Can't recognise the comparison operator");
    }
 
    case signEQ:
      return "==";
 
    case signLT:
      return "<";
 
    case signGT:
      return ">";
 
    case signLTEQ:
      return "<=";
 
    case signGTEQ:
      return ">=";
    }
 
    return "";
  }

value()

double top::SignValueSelector::value ( ) const

protected

Get the cut value assigned in the constructor.

Definition at line 94 of file SignValueSelector.cxx.

                                        {
    return m_cutvalue;
  }

valueString()

std::string top::SignValueSelector::valueString ( ) const

protected

Get the cut value assigned in the constructor.

This is for when the cut is a string

Definition at line 98 of file SignValueSelector.cxx.

                                                 {
    return m_cutvalueString;
  }

valueStringDelimReplace()

std::string top::SignValueSelector::valueStringDelimReplace ( ) const

protected

valueString which is manipulated to replace delimiter with new string

Definition at line 102 of file SignValueSelector.cxx.

                                                             {
    return m_cutvalueStringDelimReplace;
  }

Member Data Documentation

m_cutvalue

double top::SignValueSelector::m_cutvalue

private

The value of the cut, filled by the constructor.

Definition at line 174 of file SignValueSelector.h.

m_cutvalueString

std::string top::SignValueSelector::m_cutvalueString

private

The value of the cut in the case it's a string, filled by the constructor.

Definition at line 177 of file SignValueSelector.h.

m_cutvalueStringDelimReplace

std::string top::SignValueSelector::m_cutvalueStringDelimReplace

private

The value of the cut when it is a string, with replacement of delimiter with a replacement substring.

Definition at line 183 of file SignValueSelector.h.

m_multiplicity

double top::SignValueSelector::m_multiplicity

private

The multiplicity for cuts that take both a value and a multiplicity e.g. EL_N 25000 >= 2.

Definition at line 180 of file SignValueSelector.h.

m_name

std::string top::SignValueSelector::m_name

private

Hold the name of the tool, filled by the constructor.

Definition at line 168 of file SignValueSelector.h.

m_sign

Sign top::SignValueSelector::m_sign

private

The sign of the cut, filled by the constructor.

Definition at line 171 of file SignValueSelector.h.

---

The documentation for this class was generated from the following files:

• SignValueSelector.h
• SignValueSelector.cxx