#include <KLFitterSelector.h>

Inheritance diagram for top::KLFitterSelector:

Collaboration diagram for top::KLFitterSelector:

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
	KLFitterSelector (const std::string &params)

bool	apply (const top::Event &) const override
	This does stuff based on the information in an event. More...

virtual std::string	name () const override
	The name is generated in the constructor for this kind of tool. 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

Definition at line 19 of file KLFitterSelector.h.

Member Enumeration Documentation

◆ Sign

enum top::SignValueSelector::Sign

inherited

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

◆ KLFitterSelector()

top::KLFitterSelector::KLFitterSelector ( const std::string & params )

explicit

Definition at line 11 of file KLFitterSelector.cxx.

                                                             :
     SignValueSelector("KLFitter", params) {
   }

Member Function Documentation

◆ apply()

bool top::KLFitterSelector::apply ( const top::Event & ) const

overridevirtual

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.

Implements top::EventSelectorBase.

Definition at line 15 of file KLFitterSelector.cxx.

                                                           {
     // check we have a xAOD::KLFitterResultContainer
     if (event.m_KLFitterResults == nullptr) {
       return false;
     }
  
     for (auto result : *event.m_KLFitterResults) {
       // check for errors
       if (
         result->minuitDidNotConverge() == 0 &&
         result->fitAbortedDueToNaN() == 0 &&
         result->atLeastOneFitParameterAtItsLimit() == 0 &&
         result->invalidTransferFunctionAtConvergence() == 0
         ) {
         bool passPermutation = checkFloat(result->logLikelihood(), value());
         if (passPermutation) {
           return true;
         }
       } // check for errors
     } // Loop over Permutations - if we get this far, all Permutations have failed :(
     return false;
   }

◆ 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.

73 {return true;}

◆ checkFloat()

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

protectedinherited

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

protectedinherited

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 ( )

protectedinherited

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 ( )

protectedinherited

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 )

protectedinherited

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

protectedinherited

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

overridevirtualinherited

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

protectedinherited

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

protectedinherited

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

protectedinherited

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

protectedinherited

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

protectedinherited

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

privateinherited

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

privateinherited

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

privateinherited

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

privateinherited

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

privateinherited

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

privateinherited

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:

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Sign

Constructor & Destructor Documentation

◆ KLFitterSelector()

Member Function Documentation

◆ apply()

◆ applyParticleLevel()

◆ checkFloat()

◆ checkInt()

◆ checkMultiplicityIsInteger()

◆ checkValueIsInteger()

◆ decodesign()

◆ multiplicity()

◆ name()

◆ sign()

◆ signstring()

◆ value()

◆ valueString()

◆ valueStringDelimReplace()

Member Data Documentation

◆ m_cutvalue

◆ m_cutvalueString

◆ m_cutvalueStringDelimReplace

◆ m_multiplicity

◆ m_name

◆ m_sign