top::JetCleaningSelector Class Reference

Event selection using the official jet cleaning tool. More...

#include <JetCleaningSelector.h>

Inheritance diagram for top::JetCleaningSelector:

Collaboration diagram for top::JetCleaningSelector:

Public Member Functions
	JetCleaningSelector (const std::string &level, std::shared_ptr< top::TopConfig > config)
	Setup the jet group's cleaning tool. More...
bool	apply (const top::Event &event) const override
	Only accept the event if the tool says all the jets are okay. More...
std::string	name () const override
	Print the name of the tool and level. More...
virtual bool	applyParticleLevel (const top::ParticleLevelEvent &) const
	This does stuff based on the information in a particle level event. More...

Private Member Functions
bool	checkBadBatman (const top::Event &event) const
	A helper function to check if the event passes BadBatman cleaning in a specified range (from config) of RunNUmbers. More...

Private Attributes
ToolHandle< IJetSelector >	m_jetCleaningToolLooseBad
	The jet cleaning tools. More...
ToolHandle< IJetSelector >	m_jetCleaningToolTightBad
ToolHandle< ECUtils::IEventCleaningTool >	m_jetEventCleaningToolLooseBad
	The jet event cleaning tools. More...
ToolHandle< ECUtils::IEventCleaningTool >	m_jetEventCleaningToolTightBad
std::string	m_level
	The level to configure to, so we can print it in the name. More...
bool	m_useLooseBad
bool	m_useEventLevelJetCleaningTool
std::shared_ptr< top::TopConfig >	m_config

Detailed Description

Event selection using the official jet cleaning tool.

Hurray! The jet cleaning tool is one one of the few that exists in xAOD format already)

Call the jet cleaning tool and reject the event if any of the jets that passed the event selection are marked as bad. Probably should check that this is okay after overlap removal.

Definition at line 28 of file JetCleaningSelector.h.

Constructor & Destructor Documentation

JetCleaningSelector()

top::JetCleaningSelector::JetCleaningSelector ( const std::string &  level, std::shared_ptr< top::TopConfig >  config  )

explicit

Setup the jet group's cleaning tool.

The cutlevel is specified in the constructor as a little bit of text.

Parameters

level

How harsh you want the cleaning to be. For example MediumBad.

Definition at line 13 of file JetCleaningSelector.cxx.

                                                                                                     :
    m_level(level),
    m_useLooseBad(true),
    m_config(config) {
    if (!m_config->isTruthDxAOD()) {
      m_jetCleaningToolLooseBad = ToolHandle<IJetSelector>("JetCleaningToolLooseBad");
      m_jetCleaningToolTightBad = ToolHandle<IJetSelector>("JetCleaningToolTightBad");
      m_jetEventCleaningToolLooseBad = ToolHandle<ECUtils::IEventCleaningTool>("JetEventCleaningToolLooseBad");
      m_jetEventCleaningToolTightBad = ToolHandle<ECUtils::IEventCleaningTool>("JetEventCleaningToolTightBad");
 
      if (m_level != "LooseBad" && m_level != "TightBad") {
        ATH_MSG_ERROR("JetCleaningSelector level not recognised - " << m_level << "\n"
            << "Should be LooseBad or TightBad");
        throw std::runtime_error ("JetCleaningSelector: Cannot continue");
      }
 
      if (m_level == "LooseBad") m_useLooseBad = true;
      if (m_level == "TightBad") m_useLooseBad = false;
 
 
      m_useEventLevelJetCleaningTool = m_config->useEventLevelJetCleaningTool();
 
      // Checking configuration for particle-flow jets:
      if (m_config->useParticleFlowJets()) {
        top::check(m_useLooseBad,
                   "JetCleaningSelector: This cleaning configuration is not available for particle-flow jets. The only available configuration is\n JETCLEAN LooseBad");
      }
 
      // We can't yet use jet cleaning or event cleaning tools for particle-flow jets
      if (!m_config->useParticleFlowJets()) {
        if (m_useEventLevelJetCleaningTool) {
          if (m_useLooseBad) top::check(
              m_jetEventCleaningToolLooseBad.retrieve(), "Failed to retrieve JetEventCleaningToolLooseBad");
          else top::check(m_jetEventCleaningToolTightBad.retrieve(), "Failed to retrieve JetEventCleaningToolTightBad");
 
        } else {
          if (m_useLooseBad) top::check(
              m_jetCleaningToolLooseBad.retrieve(), "Failed to retrieve JetCleaningToolLooseBad");
          else top::check(m_jetCleaningToolTightBad.retrieve(), "Failed to retrieve JetCleaningToolTightBad");
        }
      } // end (!m_config->useParticleFlowJets())
    }
  }

Member Function Documentation

apply()

bool top::JetCleaningSelector::apply ( const top::Event &  event ) const

overridevirtual

Only accept the event if the tool says all the jets are okay.

Returns

True to accept the event, false otherwise.

Implements top::EventSelectorBase.

Definition at line 57 of file JetCleaningSelector.cxx.

                                                             {
    if (m_config->isTruthDxAOD()) return true;
 
    if (m_config->useParticleFlowJets()) {
      top::check(event.m_info->isAvailable<char>(
        "DFCommonJets_eventClean_LooseBad"),
      "JetCleaningSelector: DFCommonJets_eventClean_LooseBad not available in EventInfo. Needed for particle-flow jets cleaning");
      bool result = event.m_info->auxdataConst<char>("DFCommonJets_eventClean_LooseBad");
 
      if (result && m_config->useBadBatmanCleaning()) {
        // passed the standard cleaning
        // finally, check if the BadBatman cleaning should be applied
        return JetCleaningSelector::checkBadBatman(event);
      }
      return result;
    }
 
    // There are two jet cleaning tools and we have a request to test the event level one
    // These should be very close/ equivalent as we already handle the OR and JVT elsewhere
    if (m_useEventLevelJetCleaningTool) {
      // If we are to use the event object, we can just do acceptEvent
 
      if (m_useLooseBad) return m_jetEventCleaningToolLooseBad->acceptEvent(&event.m_jets);
      else return m_jetEventCleaningToolTightBad->acceptEvent(&event.m_jets);
    }
    // This is the default/standard method for jet cleaning
    else {
      for (const auto* const jetPtr : event.m_jets) {
        if (m_useLooseBad) {
          if (m_jetCleaningToolLooseBad->keep(*jetPtr) == 0) {
            return false;
          }
        } else {
          if (m_jetCleaningToolTightBad->keep(*jetPtr) == 0) {
            return false;
          }
        }
      }
    }
 
    // passed the standard cleaning
    // finally, check if the BadBatman cleaning should be applied
    if (m_config->useBadBatmanCleaning()) {
      return JetCleaningSelector::checkBadBatman(event);
    }
 
    return true;
  }

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;}

checkBadBatman()

bool top::JetCleaningSelector::checkBadBatman ( const top::Event &  event ) const

private

A helper function to check if the event passes BadBatman cleaning in a specified range (from config) of RunNUmbers.

Returns

true if event passes

Definition at line 110 of file JetCleaningSelector.cxx.

                                                                      {
    // we apply this only to Data
    if (m_config->isMC()) {
      return true;
    }
    // first check if the RunNUmber are within the specified range
    const unsigned int runNumber = event.m_info->runNumber();
 
    if ((m_config->badBatmanCleaningMin() >= runNumber) || (m_config->badBatmanCleaningMax() <= runNumber)) {
      // is outside of the specified range
      return true;
    }
 
    top::check(event.m_info->isAvailable<char>(
      "DFCommonJets_isBadBatman"),
    "JetCleaningSelector: DFCommonJets_isBadBatman not available in EventInfo. Needed for BadBatman cleaning");
    const bool result = event.m_info->auxdataConst<char>("DFCommonJets_isBadBatman");
    // we need to return negation of the flag as it is true for problematic events
    return !result;
  }

name()

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

overridevirtual

Print the name of the tool and level.

Returns

The name of the tool and the level that it has been configured at.

Implements top::EventSelectorBase.

Definition at line 106 of file JetCleaningSelector.cxx.

                                            {
    return "JETCLEAN " + m_level;
  }

Member Data Documentation

m_config

std::shared_ptr<top::TopConfig> top::JetCleaningSelector::m_config

private

Definition at line 76 of file JetCleaningSelector.h.

m_jetCleaningToolLooseBad

ToolHandle<IJetSelector> top::JetCleaningSelector::m_jetCleaningToolLooseBad

private

The jet cleaning tools.

Definition at line 64 of file JetCleaningSelector.h.

m_jetCleaningToolTightBad

ToolHandle<IJetSelector> top::JetCleaningSelector::m_jetCleaningToolTightBad

private

Definition at line 65 of file JetCleaningSelector.h.

m_jetEventCleaningToolLooseBad

ToolHandle<ECUtils::IEventCleaningTool> top::JetCleaningSelector::m_jetEventCleaningToolLooseBad

private

The jet event cleaning tools.

Definition at line 68 of file JetCleaningSelector.h.

m_jetEventCleaningToolTightBad

ToolHandle<ECUtils::IEventCleaningTool> top::JetCleaningSelector::m_jetEventCleaningToolTightBad

private

Definition at line 69 of file JetCleaningSelector.h.

m_level

std::string top::JetCleaningSelector::m_level

private

The level to configure to, so we can print it in the name.

Definition at line 72 of file JetCleaningSelector.h.

m_useEventLevelJetCleaningTool

bool top::JetCleaningSelector::m_useEventLevelJetCleaningTool

private

Definition at line 74 of file JetCleaningSelector.h.

m_useLooseBad

bool top::JetCleaningSelector::m_useLooseBad

private

Definition at line 73 of file JetCleaningSelector.h.

---

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

• JetCleaningSelector.h
• JetCleaningSelector.cxx