Class for selecting jets that pass cleaning cuts. More...

#include <JetCleaningTool.h>

Inheritance diagram for JetCleaningTool:

Collaboration diagram for JetCleaningTool:

Public Types
enum	CleaningLevel { SuperLooseBadLLP, VeryLooseBadLLP, LooseBad, LooseBadLLP, LooseBadTrigger, TightBad, UnknownCut }
	Levels of cut. More...

Public Member Functions
	JetCleaningTool (const std::string &name="JetCleaningTool")
	Standard constructor. More...

	JetCleaningTool (const CleaningLevel alevel, const bool doUgly=false)
	Cut-based constructor. More...

	JetCleaningTool (const std::string &name, const CleaningLevel alevel, const bool doUgly=false)
	Cut and string based constructor. More...

virtual	~JetCleaningTool ()
	Standard destructor. More...

virtual StatusCode	initialize () override
	Initialize method. More...

const asg::AcceptInfo &	getAcceptInfo () const

asg::AcceptData	accept (const int isJetClean, const int fmaxIndex) const
	The DFCommonJets decoration accept method. More...

asg::AcceptData	accept (const int isJetClean, const double sumpttrk, const double fmax, const double eta, const double pt, const int fmaxIndex) const
	The DFCommonJets decoration + tight method More...

asg::AcceptData	accept (const double emf, const double hecf, const double larq, const double hecq, const double sumpttrk, const double eta, const double pt, const double fmax, const double negE, const double AverageLArQF, const int fMaxIndex) const
	The main accept method: the actual cuts are applied here. More...

asg::AcceptData	accept (const xAOD::Jet &jet) const
	The D3PDReader accept method. More...

int	keep (const xAOD::Jet &jet) const final
	Method to select. More...

virtual StatusCode	decorate (const xAOD::JetContainer &jets) const override
	Decorate a jet collection without otherwise modifying it. More...

bool	containsHotCells (const xAOD::Jet &jet, const unsigned int runNumber) const
	Hot cell checks. More...

CleaningLevel	getCutLevel (const std::string &) const
	Helpers for cut names. More...

std::string	getCutName (const CleaningLevel) const

virtual void	print () const
	Print the state of the tool. More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

virtual StatusCode	modify (xAOD::JetContainer &jets) const override final
	Concrete implementation of the function inherited from IJetModifier. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	readHotCells ()
	Hot cells reading helper. More...

void	missingVariable (const std::string &varName) const

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
Gaudi::Property< std::string >	m_cutName {this, "CutLevel", "" }
	Name of the cut. More...

CleaningLevel	m_cutLevel {LooseBad}

Gaudi::Property< bool >	m_doUgly {this, "DoUgly", false}

Gaudi::Property< bool >	m_useDecorations {this, "UseDecorations", true}

Gaudi::Property< bool >	m_useLooseDecorForTightCut {this, "UseLooseDecorForTightCut", false}

SG::ConstAccessor< char >	m_acc_jetClean {"DFCommonJets_jetClean_LooseBad"}

Gaudi::Property< std::string >	m_jetContainerName {this, "JetContainer", "", "SG key for input jet container"}

SG::WriteDecorHandleKey< xAOD::JetContainer >	m_jetCleanKey {this, "JetCleaningName", "isClean", "SG key for output jet cleaning decoration"}

asg::AcceptInfo	m_accept

Gaudi::Property< std::string >	m_hotCellsFile {this, "HotCellsFile", ""}
	Hot cells caching. More...

std::unordered_map< unsigned int, std::vector< std::unique_ptr< JCT::HotCell > > >	m_hotCellsMap

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Class for selecting jets that pass cleaning cuts.

Author: Zach Marshall

Date: Feb 2014

Definition at line 39 of file JetCleaningTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

◆ CleaningLevel

enum JetCleaningTool::CleaningLevel

Levels of cut.

Enumerator
SuperLooseBadLLP
VeryLooseBadLLP
LooseBad
LooseBadLLP
LooseBadTrigger
TightBad
UnknownCut

Definition at line 46 of file JetCleaningTool.h.

   {
     SuperLooseBadLLP,
     VeryLooseBadLLP,
     LooseBad,
     LooseBadLLP,
     LooseBadTrigger,
     TightBad,
     UnknownCut
   };

Constructor & Destructor Documentation

◆ JetCleaningTool() [1/3]

JetCleaningTool::JetCleaningTool ( const std::string & name = "JetCleaningTool" )

Standard constructor.

Definition at line 89 of file JetCleaningTool.cxx.

90 : asg::AsgTool(name) {}

◆ JetCleaningTool() [2/3]

JetCleaningTool::JetCleaningTool	(	const CleaningLevel	alevel,
		const bool	doUgly = `false`
	)

Cut-based constructor.

Definition at line 92 of file JetCleaningTool.cxx.

   : JetCleaningTool( "JetCleaningTool_"+getCutName(alevel) )
 {
   m_cutLevel=alevel;
   m_doUgly = doUgly;
 }

◆ JetCleaningTool() [3/3]

JetCleaningTool::JetCleaningTool	(	const std::string &	name,
		const CleaningLevel	alevel,
		const bool	doUgly = `false`
	)

Cut and string based constructor.

Definition at line 100 of file JetCleaningTool.cxx.

   : JetCleaningTool(name)
 {
   m_cutLevel=alevel;
   m_doUgly = doUgly;
 }

◆ ~JetCleaningTool()

JetCleaningTool::~JetCleaningTool ( )

virtualdefault

Standard destructor.

Member Function Documentation

◆ accept() [1/4]

asg::AcceptData JetCleaningTool::accept	(	const double	emf,
		const double	hecf,
		const double	larq,
		const double	hecq,
		const double	sumpttrk,
		const double	eta,
		const double	pt,
		const double	fmax,
		const double	negE,
		const double	AverageLArQF,
		const int	fMaxIndex
	)		const

The main accept method: the actual cuts are applied here.

Definition at line 209 of file JetCleaningTool.cxx.

 {
   asg::AcceptData acceptData (&m_accept);
   acceptData.setCutResult( "Cleaning", false );
  
   // -----------------------------------------------------------
   // Do the actual selection
   if (pt<DBL_MIN) return acceptData;
   const double chf=sumpttrk/pt;
  
   //=============================================================
   //Run-II ugly cuts
   //=============================================================
   if(m_doUgly && fmaxIndex==17) return acceptData;
  
   //=============================================================
   //Run-II very loose LLP cuts
   // From https://indico.cern.ch/event/642438/contributions/2704590/attachments/1514445/2362870/082117a_HCW_NCB_LLP.pdf
   //=============================================================
   if (VeryLooseBadLLP == m_cutLevel){
     if (fmax>0.80) return acceptData;
     if (emf>0.96) return acceptData;
     acceptData.setCutResult( "Cleaning", true );
     return acceptData;
   }
  
   //=============================================================
   //Run-II loose cuts
   //=============================================================
   //Non-collision background & cosmics
   const bool useLLP = (LooseBadLLP == m_cutLevel); // LLP cleaning cannot use emf...
   const bool isTrigger = (LooseBadTrigger == m_cutLevel); // trigger cannot use chf
   const bool useSuperLLP = (SuperLooseBadLLP == m_cutLevel); // other LLP cleaning...
   if (!useLLP && !useSuperLLP) {
     if(!isTrigger && emf<0.05 && chf<0.05 && std::fabs(eta)<2)            return acceptData;
     if(emf<0.05 && std::fabs(eta)>=2)                       return acceptData;
   }
   if(fmax>0.99 && std::fabs(eta)<2)                       return acceptData;
   //HEC spike-- gone as of 2017! 
   if(hecf>0.5 && std::fabs(hecq)>0.5 && AverageLArQF/65535>0.8)                     return acceptData;
   //EM calo noise
   if(emf>0.95 && std::fabs(larq)>0.8 && std::fabs(eta)<2.8 && AverageLArQF/65535>0.8)    return acceptData;
   // LLP cleaning uses negative energy cut
   // (https://indico.cern.ch/event/472320/contribution/8/attachments/1220731/1784456/JetTriggerMeeting_20160102.pdf)
   if (useLLP && std::fabs(negE*0.001)>4 && fmax >0.85) return acceptData;
   // another LLP cleaning cutting softer on negative energy
   if (useSuperLLP && std::fabs(negE*0.001)>60) return acceptData;
   
   if (LooseBad==m_cutLevel || LooseBadLLP==m_cutLevel || SuperLooseBadLLP==m_cutLevel || LooseBadTrigger==m_cutLevel){
     acceptData.setCutResult( "Cleaning", true );
     return acceptData;
   }
  
   //=============================================================
   //Run-II tight cuts
   //=============================================================
   // NCB monojet-style cut in central, EMF cut in forward
   if (fmax<DBL_MIN) return acceptData;
   if(std::fabs(eta)<2.4 && chf/fmax<0.1) return acceptData;
   //if(std::fabs(eta)>=2.4 && emf<0.1) return acceptData;
   if(TightBad==m_cutLevel){
     acceptData.setCutResult( "Cleaning", true );
     return acceptData;
   }
  
   // We should never arrive here!
   ATH_MSG_ERROR( "Unknown cut name: " << getCutName( m_cutLevel ) << " in JetCleaningTool" );
   return acceptData;
 }

◆ accept() [2/4]

asg::AcceptData JetCleaningTool::accept	(	const int	isJetClean,
		const double	sumpttrk,
		const double	fmax,
		const double	eta,
		const double	pt,
		const int	fmaxIndex
	)		const

The DFCommonJets decoration + tight method

Definition at line 172 of file JetCleaningTool.cxx.

 {                
     asg::AcceptData acceptData (&m_accept);
     acceptData.setCutResult( "Cleaning", false );
     const double chf=sumpttrk/pt;
  
     //=============================================================
     //Run-II ugly cuts
     //=============================================================
     if(m_doUgly && fmaxIndex==17) return acceptData;
  
     //=============================================================
     //Tight cleaning taken from decoration
     //=============================================================
     if(isJetClean==0) return acceptData;  //fails Loose cleaning
     else if (fmax<DBL_MIN) return acceptData;
     else if(std::fabs(eta)<2.4 && chf/fmax<0.1) return acceptData;
     else{
         acceptData.setCutResult( "Cleaning", true );
         return acceptData;
     }
  
     // We should never arrive here!
     ATH_MSG_ERROR( "Unknown cut name: " << getCutName( m_cutLevel ) << " in JetCleaningTool" );
     return acceptData;
  
 }

◆ accept() [3/4]

asg::AcceptData JetCleaningTool::accept	(	const int	isJetClean,
		const int	fmaxIndex
	)		const

The DFCommonJets decoration accept method.

Definition at line 145 of file JetCleaningTool.cxx.

 {                
     asg::AcceptData acceptData (&m_accept);
     acceptData.setCutResult( "Cleaning", false );
  
     //=============================================================
     //Run-II ugly cuts
     //=============================================================
     if(m_doUgly && fmaxIndex==17) return acceptData;
  
     //=============================================================
     //Loose/tight cleaning taken from decoration
     //=============================================================
     if(isJetClean==0) return acceptData;
     else{
         acceptData.setCutResult( "Cleaning", true );
         return acceptData;
     }
  
     // We should never arrive here!
     ATH_MSG_ERROR( "Unknown cut name: " << getCutName( m_cutLevel ) << " in JetCleaningTool" );
     return acceptData;
  
 }

◆ accept() [4/4]

asg::AcceptData JetCleaningTool::accept ( const xAOD::Jet & jet ) const

The D3PDReader accept method.

Definition at line 298 of file JetCleaningTool.cxx.

 {
   std::vector<float> sumPtTrkvec;
   jet.getAttribute( xAOD::JetAttribute::SumPtTrkPt500, sumPtTrkvec );
   double sumpttrk = 0;
   if( ! sumPtTrkvec.empty() ) sumpttrk = sumPtTrkvec[0];
   // fmax index is not necessarily required
   // This is only used if doUgly is set
   // Handle it gracefully if the variable is not present but doUgly is false
   int FracSamplingMaxIndex = -1;
   if (!jet.getAttribute(xAOD::JetAttribute::FracSamplingMaxIndex,FracSamplingMaxIndex) && m_doUgly)
       missingVariable("FracSamplingMaxIndex"); 
   // get tight cleaning variables
   float FracSamplingMax = 0;
   if (!jet.getAttribute(xAOD::JetAttribute::FracSamplingMax,FracSamplingMax))
       missingVariable("FracSamplingMax");
  
   //start jet cleaning 
   int isJetClean = 0; 
   if( m_useDecorations && m_acc_jetClean.isAvailable(jet) ) { //decoration is already available for all jets 
     isJetClean = m_acc_jetClean(jet);
  
     // compute tight cleaning on top of the loose cleaning decoration
     if (m_cutLevel==TightBad && m_useLooseDecorForTightCut) {
       return accept (isJetClean, sumpttrk, FracSamplingMax, jet.eta(), jet.pt(), FracSamplingMaxIndex);
     }
     else {
       return accept (isJetClean, FracSamplingMaxIndex);
     }
   }
   else{   //running over AOD, need to use all variables
       ATH_MSG_DEBUG("DFCommon jet cleaning variable not available ... Using jet cleaning tool");
       // Get all of the required variables
       // Do it this way so we can gracefully handle missing variables (rather than segfaults)
       
       float EMFrac = 0;
       if (!jet.getAttribute(xAOD::JetAttribute::EMFrac,EMFrac))
           missingVariable("EMFrac");
       
       float HECFrac = 0;
       if (!jet.getAttribute(xAOD::JetAttribute::HECFrac,HECFrac))
           missingVariable("HECFrac");
       
       float LArQuality = 0;
       if (!jet.getAttribute(xAOD::JetAttribute::LArQuality,LArQuality))
           missingVariable("LArQuality");
     
      
       float HECQuality = 0;
       if (!jet.getAttribute(xAOD::JetAttribute::HECQuality,HECQuality))
           missingVariable("HECQuality");
  
      
       float NegativeE = 0;
       if (!jet.getAttribute(xAOD::JetAttribute::NegativeE,NegativeE))
           missingVariable("NegativeE");
  
      
  
       float AverageLArQF = 0;
       if (!jet.getAttribute(xAOD::JetAttribute::AverageLArQF,AverageLArQF))
           missingVariable("AverageLArQF");
  
       return accept (EMFrac,
               HECFrac,
               LArQuality,
               HECQuality,
               sumpttrk,
               jet.eta(),
               jet.pt(),
               FracSamplingMax,
               NegativeE,
               AverageLArQF,
               FracSamplingMaxIndex);}
 }

◆ containsHotCells()

bool JetCleaningTool::containsHotCells	(	const xAOD::Jet &	jet,
		const unsigned int	runNumber
	)		const

Hot cell checks.

Definition at line 389 of file JetCleaningTool.cxx.

 {
     // Check if the runNumber contains bad cells
     std::unordered_map<unsigned int, std::vector<std::unique_ptr<JCT::HotCell>>>::const_iterator hotCells = m_hotCellsMap.find(runNumber);
     if (hotCells != m_hotCellsMap.end())
     {
         // The run contains hot cells
         // Check if the jet is affected by one of the hot cells
         for (const std::unique_ptr<JCT::HotCell>& cell : hotCells->second)
             if (cell->jetAffectedByHotCell(jet))
                 return true;
     }
     return false;
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ decorate()

StatusCode JetCleaningTool::decorate ( const xAOD::JetContainer & jets ) const

overridevirtual

Decorate a jet collection without otherwise modifying it.

Implements IJetDecorator.

Definition at line 374 of file JetCleaningTool.cxx.

 {
     ATH_MSG_DEBUG(" Decorating jets with jet cleaning decoration : " << m_jetCleanKey.key());
  
     SG::WriteDecorHandle<xAOD::JetContainer, bool> cleanHandle(m_jetCleanKey);
  
     for (const xAOD::Jet *jet : jets) {
         cleanHandle(*jet) = accept(*jet).getCutResult("Cleaning");
     }
  
     return StatusCode::SUCCESS;
  
 }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ getAcceptInfo()

const asg::AcceptInfo& JetCleaningTool::getAcceptInfo ( ) const

inline

Definition at line 72 of file JetCleaningTool.h.

   {
     return m_accept;
     }

◆ getCutLevel()

JetCleaningTool::CleaningLevel JetCleaningTool::getCutLevel ( const std::string & s ) const

Helpers for cut names.

Definition at line 405 of file JetCleaningTool.cxx.

 {
   if (s=="SuperLooseBadLLP") return SuperLooseBadLLP;
   if (s=="VeryLooseBadLLP") return VeryLooseBadLLP;
   if (s=="LooseBad")     return LooseBad;
   if (s=="LooseBadLLP")     return LooseBadLLP;
   if (s=="LooseBadTrigger")     return LooseBadTrigger;
   if (s=="TightBad")     return TightBad;
   ATH_MSG_ERROR( "Unknown cut level requested: " << s );
   return UnknownCut;  
 }

◆ getCutName()

std::string JetCleaningTool::getCutName ( const CleaningLevel c ) const

Definition at line 417 of file JetCleaningTool.cxx.

 {
   if (c==SuperLooseBadLLP) return "SuperLooseBadLLP";
   if (c==VeryLooseBadLLP) return "VeryLooseBadLLP";
   if (c==LooseBad)     return "LooseBad";
   if (c==LooseBadLLP)     return "LooseBadLLP";
   if (c==LooseBadTrigger)     return "LooseBadTrigger";
   if (c==TightBad)     return "TightBad";
   return "UnknownCut";
 }

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                     {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getKey( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       return ( proxy == nullptr ? 0 : proxy->sgkey() );
 #endif // XAOD_STANDALONE
    }

◆ getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                             {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getName( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       static const std::string dummy = "";
       return ( proxy == nullptr ? dummy : proxy->name() );
 #endif // XAOD_STANDALONE
    }

◆ getProperty()

template<class T >

const T* asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

◆ initialize()

StatusCode JetCleaningTool::initialize ( )

overridevirtual

Initialize method.

Reimplemented from asg::AsgTool.

Definition at line 116 of file JetCleaningTool.cxx.

 {
   if (UnknownCut==m_cutLevel){
     ATH_MSG_ERROR( "Tool initialized with unknown cleaning level." );
     return StatusCode::FAILURE;
   }
  
   if (m_cutName!="") m_cutLevel = getCutLevel( m_cutName );
   ATH_MSG_INFO( "Configured with cut level " << getCutName( m_cutLevel ) );
   std::string jetCleanDFName = "DFCommonJets_jetClean_"+getCutName(m_cutLevel);
   // if UseLooseDecorForTightCut=true, retrieve loose cleaning decoration to compute tight cleaning
   if (m_useLooseDecorForTightCut) jetCleanDFName = "DFCommonJets_jetClean_"+getCutName(LooseBad);
   m_acc_jetClean = jetCleanDFName;
   m_jetCleanKey = m_jetContainerName + "." + getCutName(m_cutLevel);
  
   ATH_MSG_DEBUG( "Initialized decorator name: " << jetCleanDFName );
  
   m_accept.addCut( "Cleaning", "Cleaning of the jet" );
     
   // Read in the map of runNumbers to bad cells
   ATH_CHECK(readHotCells());
    
   ATH_CHECK(m_jetCleanKey.initialize(!m_jetContainerName.empty()));
  
   return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ keep()

int JetCleaningTool::keep ( const xAOD::Jet & jet ) const

inlinefinalvirtual

Method to select.

Returns true if jet is selected.

Implements IJetSelector.

Definition at line 104 of file JetCleaningTool.h.

105 { return static_cast<bool>(accept(jet)); }

◆ missingVariable()

void JetCleaningTool::missingVariable ( const std::string & varName ) const

private

Definition at line 292 of file JetCleaningTool.cxx.

 {
     ATH_MSG_FATAL(Form("JetCleaningTool failed to retrieve a required variable - please confirm that the xAOD::Jet being passed contains the variable named %s",varName.c_str()));
     throw std::runtime_error(Form("JetCleaningTool failed to retrieve a required variable - please confirm that the xAOD::Jet being passed contains the variable named %s",varName.c_str()));
 }

◆ modify()

virtual StatusCode IJetDecorator::modify ( xAOD::JetContainer & jets ) const

inlinefinaloverridevirtualinherited

Concrete implementation of the function inherited from IJetModifier.

Implements IJetModifier.

Definition at line 32 of file IJetDecorator.h.

32 {return decorate(jets);};

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns: The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                   {
  
       return MSG::name( msg().level() );
    }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

                              {
  
       ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
       return;
    }

◆ readHotCells()

StatusCode JetCleaningTool::readHotCells ( )

private

Hot cells reading helper.

Definition at line 430 of file JetCleaningTool.cxx.

 {
     if (m_hotCellsFile.empty()) return StatusCode::SUCCESS;
     
     // Ensure that the file exists
     if ( !JCT::utils::fileExists(m_hotCellsFile) )
     {
         ATH_MSG_ERROR("Failed to find hot cells file: " << m_hotCellsFile);
         return StatusCode::FAILURE;
     }
  
     // Now parse the file
     TEnv readCells;
     if (readCells.ReadFile(m_hotCellsFile.value().c_str(),kEnvGlobal))
     {
         ATH_MSG_ERROR("Cannot read hot cells file: " << m_hotCellsFile);
         return StatusCode::FAILURE;
     }
  
     // Get the list of run numbers
     const TString runNumbersString = readCells.GetValue("RunNumbers","");
     if (runNumbersString=="")
     {
         ATH_MSG_ERROR("No RunNumbers field was specified in the hot cells file: " << m_hotCellsFile);
         return StatusCode::FAILURE;
     }
  
     // Convert into a vector
     std::vector<unsigned int> runNumbers = JCT::utils::vectorize<unsigned int>(runNumbersString,", ");
     if (runNumbers.empty())
     {
         ATH_MSG_ERROR("RunNumbers field specified, but value is empty or not unsigned ints for hot cells file: " << m_hotCellsFile);
         return StatusCode::FAILURE;
     }
  
     // Loop over the run numbers
     for (unsigned int run : runNumbers){
         std::vector<std::unique_ptr<JCT::HotCell>>& cellVec = m_hotCellsMap[run];
  
         // The number of hot cells should be below 100 for a given run...
         for (size_t iCell = 0; iCell < 100; ++iCell)
         {
             const TString baseName = Form("Run%u.Cell%zu.",run,iCell);
  
             // Read the cell info
             const int   layer  = readCells.GetValue(baseName+"Layer", -1  );
             const float minEta = readCells.GetValue(baseName+"EtaMin",-10.);
             const float maxEta = readCells.GetValue(baseName+"EtaMax", 10.);
             const float minPhi = readCells.GetValue(baseName+"PhiMin",-10.);
             const float maxPhi = readCells.GetValue(baseName+"PhiMax", 10.);
  
             // Check that the input makes sense
             if (layer < 0 && minEta < -5 && maxEta > 5 && minPhi < -5 && maxPhi > 5)
                 continue;
             if (layer < 0 || minEta < -5 || maxEta > 5 || minPhi < -5 || maxPhi > 5)
             {
                 ATH_MSG_ERROR("Partially specified cell - please check the file: " << m_hotCellsFile);
                 ATH_MSG_ERROR(Form("Got Layer=%d, EtaMin=%f, EtaMax=%f, PhiMin=%f, PhiMax=%f",layer,minEta,maxEta,minPhi,maxPhi));
                 return StatusCode::FAILURE;
             }
             cellVec.emplace_back(std::make_unique<JCT::HotCell>(layer,minEta,maxEta,minPhi,maxPhi));
         }
         
         // Ensure we found the expected run
         if (cellVec.empty())
         {
             ATH_MSG_ERROR("Specified that Run# " << run << " contains hot cells, but did not find any corresponding cells in the file: " << m_hotCellsFile);
             return StatusCode::FAILURE;
         }
     }
     
     // Done
     return StatusCode::SUCCESS;
 }

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

   {
     h.renounce();
     PBASE::renounce (h);
   }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_acc_jetClean

SG::ConstAccessor<char> JetCleaningTool::m_acc_jetClean {"DFCommonJets_jetClean_LooseBad"}

private

Definition at line 124 of file JetCleaningTool.h.

◆ m_accept

asg::AcceptInfo JetCleaningTool::m_accept

private

Definition at line 129 of file JetCleaningTool.h.

◆ m_cutLevel

CleaningLevel JetCleaningTool::m_cutLevel {LooseBad}

private

Definition at line 120 of file JetCleaningTool.h.

◆ m_cutName

Gaudi::Property<std::string> JetCleaningTool::m_cutName {this, "CutLevel", "" }

private

Name of the cut.

Definition at line 119 of file JetCleaningTool.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_doUgly

Gaudi::Property<bool> JetCleaningTool::m_doUgly {this, "DoUgly", false}

private

Definition at line 121 of file JetCleaningTool.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_hotCellsFile

Gaudi::Property<std::string> JetCleaningTool::m_hotCellsFile {this, "HotCellsFile", ""}

private

Hot cells caching.

Definition at line 132 of file JetCleaningTool.h.

◆ m_hotCellsMap

std::unordered_map<unsigned int, std::vector<std::unique_ptr<JCT::HotCell> > > JetCleaningTool::m_hotCellsMap

private

Definition at line 133 of file JetCleaningTool.h.

◆ m_jetCleanKey

SG::WriteDecorHandleKey<xAOD::JetContainer> JetCleaningTool::m_jetCleanKey {this, "JetCleaningName", "isClean", "SG key for output jet cleaning decoration"}

private

Definition at line 128 of file JetCleaningTool.h.

◆ m_jetContainerName

Gaudi::Property<std::string> JetCleaningTool::m_jetContainerName {this, "JetContainer", "", "SG key for input jet container"}

private

Definition at line 127 of file JetCleaningTool.h.

◆ m_useDecorations

Gaudi::Property<bool> JetCleaningTool::m_useDecorations {this, "UseDecorations", true}

private

Definition at line 122 of file JetCleaningTool.h.

◆ m_useLooseDecorForTightCut

Gaudi::Property<bool> JetCleaningTool::m_useLooseDecorForTightCut {this, "UseLooseDecorForTightCut", false}

private

Definition at line 123 of file JetCleaningTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Enumeration Documentation

◆ CleaningLevel

Constructor & Destructor Documentation

◆ JetCleaningTool() [1/3]

◆ JetCleaningTool() [2/3]

◆ JetCleaningTool() [3/3]

◆ ~JetCleaningTool()

Member Function Documentation

◆ accept() [1/4]

◆ accept() [2/4]

◆ accept() [3/4]

◆ accept() [4/4]

◆ containsHotCells()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ decorate()

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getAcceptInfo()

◆ getCutLevel()

◆ getCutName()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ keep()

◆ missingVariable()

◆ modify()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ readHotCells()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_acc_jetClean

◆ m_accept

◆ m_cutLevel

◆ m_cutName

◆ m_detStore

◆ m_doUgly

◆ m_evtStore

◆ m_hotCellsFile

◆ m_hotCellsMap

◆ m_jetCleanKey

◆ m_jetContainerName

◆ m_useDecorations

◆ m_useLooseDecorForTightCut

◆ m_varHandleArraysDeclared

◆ m_vhka