an IAsgSelectionTool that performs basic pt and eta cut (with an optional eta gap) More...

#include <AsgPtEtaSelectionTool.h>

Inheritance diagram for CP::AsgPtEtaSelectionTool:

Collaboration diagram for CP::AsgPtEtaSelectionTool:

Public Member Functions
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function. More...

virtual const asg::AcceptInfo &	getAcceptInfo () const override
	Declare the interface ID for this pure-virtual interface class to the Athena framework. More...

virtual asg::AcceptData	accept (const xAOD::IParticle *particle) const override
	The main accept method: the actual cuts are applied here. More...

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, V, H > &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

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
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

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

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

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

Private Attributes
int	m_minPtCutIndex { -1 }
	Index for the minimum pT selection. More...

int	m_maxPtCutIndex { -1 }
	Index for the maximum pT selection. More...

int	m_minEtaCutIndex { -1 }
	Index for the minimum eta selection. More...

int	m_maxEtaCutIndex { -1 }
	Index for the maximum eta selection. More...

int	m_etaGapCutIndex { -1 }
	Index for the eta gap selection. More...

int	m_minRapidityCutIndex { -1 }
	Index for the minimum rapidity selection. More...

int	m_maxRapidityCutIndex { -1 }
	Index for the maximum rapidity selection. More...

int	m_egammaCastCutIndex { -1 }
	Index for the e/gamma casting. More...

int	m_egammaClusterCutIndex { -1 }
	Index for the e/gamma calo-cluster. More...

int	m_dressedPropertiesIndex { -1 }
	Index for the existence of dressed properties. More...

int	m_jetCastCutIndex { -1 }
	Index for the jet casting. More...

std::atomic< bool >	m_shouldPrintCastWarning {true}
	a version of m_printCastWarning that we modify once we printed the warning More...

std::atomic< bool >	m_shouldPrintClusterWarning {true}
	a version of m_printClusterWarning that we modify once we printed the warning More...

asg::AcceptInfo	m_accept
	the asg::AcceptInfo we are using More...

std::unique_ptr< SG::ConstAccessor< float > >	m_dressedPtAccessor {}
	dressed pt and eta accessors More...

std::unique_ptr< SG::ConstAccessor< float > >	m_dressedEtaAccessor {}

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


Gaudi::Property< float >	m_minPt {this, "minPt", 0, "minimum pt to require (or 0 for no pt cut)"}
	tool properties More...

Gaudi::Property< float >	m_maxPt {this, "maxPt", 0, "maximum pt to require (or 0 for no pt cut)"}

Gaudi::Property< float >	m_minEta {this, "minEta", 0, "minimum abs(eta) to allow (or 0 for no eta cut)"}

Gaudi::Property< float >	m_maxEta {this, "maxEta", 0, "maximum abs(eta) to allow (or 0 for no eta cut)"}

Gaudi::Property< float >	m_etaGapLow {this, "etaGapLow", 0, "low end of the eta gap"}

Gaudi::Property< float >	m_etaGapHigh {this, "etaGapHigh", 0, "high end of the eta gap (or 0 for no eta gap)"}

Gaudi::Property< float >	m_minRapidity {this, "minRapidity", 0, "minimum abs(rapidity) to allow (or 0 for no eta cut)"}

Gaudi::Property< float >	m_maxRapidity {this, "maxRapidity", 0, "maximum abs(rapidity) to allow (or 0 for no eta cut)"}

Gaudi::Property< bool >	m_useClusterEta {this, "useClusterEta", false, "whether to use the cluster eta (for electrons only)"}

Gaudi::Property< bool >	m_useDressedProperties {this, "useDressedProperties", false, "whether to use the dressed kinematic properties (for truth particles only)"}

Gaudi::Property< bool >	m_useConstituentMomentum {this, "useConstituentMomentum", false, "whether to use the constituent momentum (for jets only) (not for pt)"}

Gaudi::Property< bool >	m_printCastWarning {this, "printCastWarning", true, "whether to print a warning/error when the cast fails"}

Gaudi::Property< bool >	m_printClusterWarning {this, "printClusterWarning", true, "whether to print a warning/error when the cluster is missing"}

Detailed Description

an IAsgSelectionTool that performs basic pt and eta cut (with an optional eta gap)

This is a very basic selection that needs to happen on all object types to some degree. Instead of doing this separately for each type, it is just one basic tool for all IParticle implementations. Also, this is a tool, not an algorithm, because we already have an algorithm wrapping generic selection tools and there is no benefit to making it an algorithm.

There may be some overlap with the individual selectors for the given object types, but having a tool for this allows to apply it at any point in the algorithm sequence.

Definition at line 34 of file AsgPtEtaSelectionTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

◆ accept()

asg::AcceptData CP::AsgPtEtaSelectionTool::accept ( const xAOD::IParticle * ) const

overridevirtual

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

Implements IAsgSelectionTool.

Definition at line 162 of file AsgPtEtaSelectionTool.cxx.

   {
     asg::AcceptData accept (&m_accept);
  
     // Check if dressed properties exist if needed
     if (m_useDressedProperties) {
        if (!m_dressedPtAccessor->isAvailable(*particle)) {
          ANA_MSG_WARNING ("dressed decorations not available");
          return accept;
        }
        accept.setCutResult (m_dressedPropertiesIndex, true);
     }
  
     // Perform the tranverse momentum cuts.
     if (m_minPtCutIndex >= 0 || m_maxPtCutIndex >= 0)
     {
       float pt = particle->pt();
       if (m_useDressedProperties) {
         pt = (*m_dressedPtAccessor) (*particle);
       }
  
       if (m_minPtCutIndex >= 0) {
         if (!std::isfinite(pt) || pt < 0.)
         {
           ANA_MSG_WARNING ("invalid pt value, setting object to fail pt-cut: " << pt);
           accept.setCutResult (m_minPtCutIndex, false);
         } else
         {
           accept.setCutResult (m_minPtCutIndex, pt >= m_minPt);
         }
       }
       if (m_maxPtCutIndex >= 0) {
         accept.setCutResult (m_maxPtCutIndex, pt < m_maxPt);
       }
     }
  
     // Perform the eta cut(s).
     if (m_minEtaCutIndex >= 0 || m_maxEtaCutIndex >= 0 || m_etaGapCutIndex >= 0)
     {
       float absEta = 0;
  
       if (m_useClusterEta == true)
       {
         const xAOD::Egamma *egamma
           = dynamic_cast<const xAOD::Egamma*>(particle);
         if (egamma == nullptr)
         {
           if (m_shouldPrintCastWarning)
             ANA_MSG_ERROR ("failed to cast input particle to electron");
           m_shouldPrintCastWarning = false;
           return accept;
         }
         accept.setCutResult (m_egammaCastCutIndex, true);
         const xAOD::CaloCluster *const caloCluster {egamma->caloCluster()};
         if (!caloCluster)
         {
           if (m_shouldPrintClusterWarning)
             ANA_MSG_ERROR ("no calo-cluster associated with e-gamma object");
           m_shouldPrintClusterWarning = false;
           return accept;
         }
         accept.setCutResult (m_egammaClusterCutIndex, true);
         absEta = std::abs (caloCluster->etaBE(2));
       } else if (m_useDressedProperties)
       {
         absEta = std::abs ((*m_dressedEtaAccessor) (*particle));
       } else if (m_useConstituentMomentum == true)
       {
         const xAOD::Jet *jet
           = dynamic_cast<const xAOD::Jet*>(particle);
         if (jet == nullptr)
         {
           if (m_shouldPrintCastWarning)
             ANA_MSG_ERROR ("failed to cast input particle to jet");
           m_shouldPrintCastWarning = false;
           return accept;
         }
         accept.setCutResult (m_jetCastCutIndex, true);
         absEta = std::abs (jet->getAttribute<xAOD::JetFourMom_t>("JetConstitScaleMomentum").eta());
       } else
       {
         absEta = std::abs (particle->eta());
       }
  
       if (m_minEtaCutIndex >= 0) {
         accept.setCutResult (m_minEtaCutIndex, absEta > m_minEta);
       }
       if (m_maxEtaCutIndex >= 0) {
         accept.setCutResult (m_maxEtaCutIndex, absEta <= m_maxEta);
       }
       if (m_etaGapCutIndex >= 0) {
         accept.setCutResult (m_etaGapCutIndex, (absEta < m_etaGapLow ||
                                                   absEta > m_etaGapHigh));
       }
     }
  
     // Perform the rapdity cut(s).
     if (m_minRapidityCutIndex >= 0 || m_maxRapidityCutIndex >= 0)
     {
       float absRapidity = 0;
  
       if (m_useConstituentMomentum == true)
       {
         const xAOD::Jet *jet
           = dynamic_cast<const xAOD::Jet*>(particle);
         if (jet == nullptr)
         {
           if (m_shouldPrintCastWarning)
             ANA_MSG_ERROR ("failed to cast input particle to jet");
           m_shouldPrintCastWarning = false;
           return accept;
         }
         accept.setCutResult (m_jetCastCutIndex, true);
         absRapidity = std::abs (jet->getAttribute<xAOD::JetFourMom_t>("JetConstitScaleMomentum").Rapidity());
       } else
       {
         absRapidity = std::abs (particle->rapidity());
       }
  
       if (m_minRapidityCutIndex >= 0) {
         accept.setCutResult (m_minRapidityCutIndex, absRapidity > m_minRapidity);
       }
       if (m_maxRapidityCutIndex >= 0) {
         accept.setCutResult (m_maxRapidityCutIndex, absRapidity <= m_maxRapidity);
       }
     }
  
     return accept;
   }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	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, V, H > &	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, V, H > &	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, V, H > &	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, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

◆ 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 & CP::AsgPtEtaSelectionTool::getAcceptInfo ( ) const

overridevirtual

Declare the interface ID for this pure-virtual interface class to the Athena framework.

Method to get the AcceptInfo to query what cuts are defined.

Implements IAsgSelectionTool.

Definition at line 154 of file AsgPtEtaSelectionTool.cxx.

   {
     return m_accept;
   }

◆ 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 CP::AsgPtEtaSelectionTool::initialize ( )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 27 of file AsgPtEtaSelectionTool.cxx.

   {
     if (bool{m_useDressedProperties} + bool{m_useClusterEta} + bool{m_useConstituentMomentum} > 1)
     {
       ATH_MSG_ERROR ("only one of 'useDressedProperties', 'useClusterEta' and 'useConstituentMomentum' can be used at the same time");
       return StatusCode::FAILURE;
     }
     if (m_minPt < 0 || !std::isfinite (m_minPt))
     {
       ATH_MSG_ERROR ("invalid value of minPt: " << m_minPt);
       return StatusCode::FAILURE;
     }
     if (m_maxPt < 0 || !std::isfinite (m_maxPt))
     {
       ATH_MSG_ERROR ("invalid value of maxPt: " << m_maxPt);
       return StatusCode::FAILURE;
     }
     if (m_minEta < 0 || !std::isfinite (m_minEta))
     {
       ATH_MSG_ERROR ("invalid value of minEta: " << m_minEta);
       return StatusCode::FAILURE;
     }
     if (m_maxEta < 0 || !std::isfinite (m_maxEta))
     {
       ATH_MSG_ERROR ("invalid value of maxEta: " << m_maxEta);
       return StatusCode::FAILURE;
     }
     if (m_etaGapLow < 0 || !std::isfinite (m_etaGapLow))
     {
       ATH_MSG_ERROR ("invalid value of etaGapLow: " << m_etaGapLow);
       return StatusCode::FAILURE;
     }
     if (m_etaGapHigh < 0 || !std::isfinite (m_etaGapHigh))
     {
       ATH_MSG_ERROR ("invalid value of etaGapHigh: " << m_etaGapHigh);
       return StatusCode::FAILURE;
     }
     if (m_etaGapHigh > 0 && m_etaGapLow >= m_etaGapHigh)
     {
       ATH_MSG_ERROR ("invalid eta gap: " << m_etaGapLow << " to " << m_etaGapHigh);
       return StatusCode::FAILURE;
     }
     if (m_etaGapLow > 0 && m_minEta > 0 && m_etaGapLow <= m_minEta)
     {
       ATH_MSG_ERROR ("etaGapLow=" << m_etaGapLow << " <= minEta=" << m_minEta);
       return StatusCode::FAILURE;
     }
     if (m_etaGapHigh > 0 && m_maxEta > 0 && m_etaGapHigh >= m_maxEta)
     {
       ATH_MSG_ERROR ("etaGapHigh=" << m_etaGapHigh << " >= maxEta=" << m_maxEta);
       return StatusCode::FAILURE;
     }
     if (m_minRapidity < 0 || !std::isfinite (m_minRapidity))
     {
       ATH_MSG_ERROR ("invalid value of minRapidity: " << m_minRapidity);
       return StatusCode::FAILURE;
     }
     if (m_maxRapidity < 0 || !std::isfinite (m_maxRapidity))
     {
       ATH_MSG_ERROR ("invalid value of maxRapidity: " << m_maxRapidity);
       return StatusCode::FAILURE;
     }
     if ((m_minRapidity > 0 && m_maxRapidity > 0) &&
         (m_minRapidity >= m_maxRapidity))
     {
       ATH_MSG_ERROR ("invalid rapidity range: " << m_minRapidity << " to " << m_maxRapidity);
       return StatusCode::FAILURE;
     }
     if ((m_minEta > 0 || m_maxEta > 0) && (m_minRapidity > 0 || m_maxRapidity > 0))
     {
       ATH_MSG_ERROR ("cannot use both eta and rapidity cuts at the same time");
       return StatusCode::FAILURE;
     }
  
     if (m_useDressedProperties) {
        ATH_MSG_DEBUG( "Performing pt and eta cuts on the dressed properties" );
        m_dressedPropertiesIndex = m_accept.addCut ("dressedProperties", "has dressed properties");
        m_dressedPtAccessor = std::make_unique<SG::ConstAccessor<float>> ("pt_dressed");
        m_dressedEtaAccessor = std::make_unique<SG::ConstAccessor<float>> ("eta_dressed");
     }
     if (m_minPt > 0) {
        ATH_MSG_DEBUG( "Performing pt >= " << m_minPt << " MeV selection" );
        m_minPtCutIndex = m_accept.addCut ("minPt", "minimum pt cut");
     }
     if (m_maxPt > 0) {
        ATH_MSG_DEBUG( "Performing pt < " << m_maxPt << " MeV selection" );
        m_maxPtCutIndex = m_accept.addCut ("maxPt", "maximum pt cut");
     }
     if (m_useClusterEta) {
        ATH_MSG_DEBUG( "Performing eta cut on the e/gamma cluster" );
        m_egammaCastCutIndex = m_accept.addCut ("castEgamma", "cast to egamma");
        m_egammaClusterCutIndex = m_accept.addCut ("caloCluster", "egamma object has cluster");
     }
     if (m_useConstituentMomentum) {
        ATH_MSG_DEBUG( "Performing eta/rapidity cut on the jet constituent momentum" );
        m_jetCastCutIndex = m_accept.addCut ("castJet", "cast to jet");
     }
     if (m_minEta > 0) {
        ATH_MSG_DEBUG( "Performing |eta| >= " << m_minEta << " selection");
        m_minEtaCutIndex = m_accept.addCut ("minEta", "minimum eta cut");
     }
     if (m_maxEta > 0) {
        ATH_MSG_DEBUG( "Performing |eta| < " << m_maxEta << " selection" );
        m_maxEtaCutIndex = m_accept.addCut ("maxEta", "maximum eta cut");
     }
     if (m_etaGapHigh > 0) {
        ATH_MSG_DEBUG( "Performing !( " << m_etaGapLow << " < |eta| < "
                       << m_etaGapHigh << " ) selection" );
        m_etaGapCutIndex = m_accept.addCut ("etaGap", "eta gap cut");
     }
     if (m_minRapidity > 0) {
        ATH_MSG_DEBUG( "Performing |rapidity| >= " << m_minRapidity << " selection");
        m_minRapidityCutIndex = m_accept.addCut ("minRapidity", "minimum eta cut");
     }
     if (m_maxRapidity > 0) {
        ATH_MSG_DEBUG( "Performing |rapidity| < " << m_maxRapidity << " selection" );
        m_maxRapidityCutIndex = m_accept.addCut ("maxRapidity", "maximum eta cut");
     }
     m_shouldPrintCastWarning = m_printCastWarning;
     m_shouldPrintClusterWarning = m_printClusterWarning;
  
     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.

◆ 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, LundVariablesTool, 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;
    }

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

asg::AcceptInfo CP::AsgPtEtaSelectionTool::m_accept

private

the asg::AcceptInfo we are using

Definition at line 141 of file AsgPtEtaSelectionTool.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_dressedEtaAccessor

std::unique_ptr<SG::ConstAccessor<float> > CP::AsgPtEtaSelectionTool::m_dressedEtaAccessor {}

private

Definition at line 146 of file AsgPtEtaSelectionTool.h.

◆ m_dressedPropertiesIndex

int CP::AsgPtEtaSelectionTool::m_dressedPropertiesIndex { -1 }

private

Index for the existence of dressed properties.

Definition at line 109 of file AsgPtEtaSelectionTool.h.

◆ m_dressedPtAccessor

std::unique_ptr<SG::ConstAccessor<float> > CP::AsgPtEtaSelectionTool::m_dressedPtAccessor {}

private

dressed pt and eta accessors

Definition at line 145 of file AsgPtEtaSelectionTool.h.

◆ m_egammaCastCutIndex

int CP::AsgPtEtaSelectionTool::m_egammaCastCutIndex { -1 }

private

Index for the e/gamma casting.

Definition at line 105 of file AsgPtEtaSelectionTool.h.

◆ m_egammaClusterCutIndex

int CP::AsgPtEtaSelectionTool::m_egammaClusterCutIndex { -1 }

private

Index for the e/gamma calo-cluster.

Definition at line 107 of file AsgPtEtaSelectionTool.h.

◆ m_etaGapCutIndex

int CP::AsgPtEtaSelectionTool::m_etaGapCutIndex { -1 }

private

Index for the eta gap selection.

Definition at line 99 of file AsgPtEtaSelectionTool.h.

◆ m_etaGapHigh

Gaudi::Property<float> CP::AsgPtEtaSelectionTool::m_etaGapHigh {this, "etaGapHigh", 0, "high end of the eta gap (or 0 for no eta gap)"}

private

Definition at line 79 of file AsgPtEtaSelectionTool.h.

◆ m_etaGapLow

Gaudi::Property<float> CP::AsgPtEtaSelectionTool::m_etaGapLow {this, "etaGapLow", 0, "low end of the eta gap"}

private

Definition at line 78 of file AsgPtEtaSelectionTool.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_jetCastCutIndex

int CP::AsgPtEtaSelectionTool::m_jetCastCutIndex { -1 }

private

Index for the jet casting.

Definition at line 111 of file AsgPtEtaSelectionTool.h.

◆ m_maxEta

Gaudi::Property<float> CP::AsgPtEtaSelectionTool::m_maxEta {this, "maxEta", 0, "maximum abs(eta) to allow (or 0 for no eta cut)"}

private

Definition at line 77 of file AsgPtEtaSelectionTool.h.

◆ m_maxEtaCutIndex

int CP::AsgPtEtaSelectionTool::m_maxEtaCutIndex { -1 }

private

Index for the maximum eta selection.

Definition at line 97 of file AsgPtEtaSelectionTool.h.

◆ m_maxPt

Gaudi::Property<float> CP::AsgPtEtaSelectionTool::m_maxPt {this, "maxPt", 0, "maximum pt to require (or 0 for no pt cut)"}

private

Definition at line 75 of file AsgPtEtaSelectionTool.h.

◆ m_maxPtCutIndex

int CP::AsgPtEtaSelectionTool::m_maxPtCutIndex { -1 }

private

Index for the maximum pT selection.

Definition at line 93 of file AsgPtEtaSelectionTool.h.

◆ m_maxRapidity

Gaudi::Property<float> CP::AsgPtEtaSelectionTool::m_maxRapidity {this, "maxRapidity", 0, "maximum abs(rapidity) to allow (or 0 for no eta cut)"}

private

Definition at line 81 of file AsgPtEtaSelectionTool.h.

◆ m_maxRapidityCutIndex

int CP::AsgPtEtaSelectionTool::m_maxRapidityCutIndex { -1 }

private

Index for the maximum rapidity selection.

Definition at line 103 of file AsgPtEtaSelectionTool.h.

◆ m_minEta

Gaudi::Property<float> CP::AsgPtEtaSelectionTool::m_minEta {this, "minEta", 0, "minimum abs(eta) to allow (or 0 for no eta cut)"}

private

Definition at line 76 of file AsgPtEtaSelectionTool.h.

◆ m_minEtaCutIndex

int CP::AsgPtEtaSelectionTool::m_minEtaCutIndex { -1 }

private

Index for the minimum eta selection.

Definition at line 95 of file AsgPtEtaSelectionTool.h.

◆ m_minPt

Gaudi::Property<float> CP::AsgPtEtaSelectionTool::m_minPt {this, "minPt", 0, "minimum pt to require (or 0 for no pt cut)"}

private

tool properties

Definition at line 74 of file AsgPtEtaSelectionTool.h.

◆ m_minPtCutIndex

int CP::AsgPtEtaSelectionTool::m_minPtCutIndex { -1 }

private

Index for the minimum pT selection.

Definition at line 91 of file AsgPtEtaSelectionTool.h.

◆ m_minRapidity

Gaudi::Property<float> CP::AsgPtEtaSelectionTool::m_minRapidity {this, "minRapidity", 0, "minimum abs(rapidity) to allow (or 0 for no eta cut)"}

private

Definition at line 80 of file AsgPtEtaSelectionTool.h.

◆ m_minRapidityCutIndex

int CP::AsgPtEtaSelectionTool::m_minRapidityCutIndex { -1 }

private

Index for the minimum rapidity selection.

Definition at line 101 of file AsgPtEtaSelectionTool.h.

◆ m_printCastWarning

Gaudi::Property<bool> CP::AsgPtEtaSelectionTool::m_printCastWarning {this, "printCastWarning", true, "whether to print a warning/error when the cast fails"}

private

Definition at line 85 of file AsgPtEtaSelectionTool.h.

◆ m_printClusterWarning

Gaudi::Property<bool> CP::AsgPtEtaSelectionTool::m_printClusterWarning {this, "printClusterWarning", true, "whether to print a warning/error when the cluster is missing"}

private

Definition at line 86 of file AsgPtEtaSelectionTool.h.

◆ m_shouldPrintCastWarning

std::atomic<bool> CP::AsgPtEtaSelectionTool::m_shouldPrintCastWarning {true}

mutableprivate

a version of m_printCastWarning that we modify once we printed the warning

I don't like modifying property values in the tool itself, so I copy it over here and then modify once I print out.

Technically this tool isn't thread-safe due to the use of TAccept, but once we move to master this will be fixed, so this member is already made thread-safe so that we don't trip up on that later.

Definition at line 124 of file AsgPtEtaSelectionTool.h.

◆ m_shouldPrintClusterWarning

std::atomic<bool> CP::AsgPtEtaSelectionTool::m_shouldPrintClusterWarning {true}

mutableprivate

a version of m_printClusterWarning that we modify once we printed the warning

I don't like modifying property values in the tool itself, so I copy it over here and then modify once I print out.

Technically this tool isn't thread-safe due to the use of TAccept, but once we move to master this will be fixed, so this member is already made thread-safe so that we don't trip up on that later.

Definition at line 137 of file AsgPtEtaSelectionTool.h.

◆ m_useClusterEta

Gaudi::Property<bool> CP::AsgPtEtaSelectionTool::m_useClusterEta {this, "useClusterEta", false, "whether to use the cluster eta (for electrons only)"}

private

Definition at line 82 of file AsgPtEtaSelectionTool.h.

◆ m_useConstituentMomentum

Gaudi::Property<bool> CP::AsgPtEtaSelectionTool::m_useConstituentMomentum {this, "useConstituentMomentum", false, "whether to use the constituent momentum (for jets only) (not for pt)"}

private

Definition at line 84 of file AsgPtEtaSelectionTool.h.

◆ m_useDressedProperties

Gaudi::Property<bool> CP::AsgPtEtaSelectionTool::m_useDressedProperties {this, "useDressedProperties", false, "whether to use the dressed kinematic properties (for truth particles only)"}

private

Definition at line 83 of file AsgPtEtaSelectionTool.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 Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Function Documentation

◆ accept()

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

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getAcceptInfo()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_accept

◆ m_detStore

◆ m_dressedEtaAccessor

◆ m_dressedPropertiesIndex

◆ m_dressedPtAccessor

◆ m_egammaCastCutIndex

◆ m_egammaClusterCutIndex

◆ m_etaGapCutIndex

◆ m_etaGapHigh

◆ m_etaGapLow

◆ m_evtStore

◆ m_jetCastCutIndex

◆ m_maxEta

◆ m_maxEtaCutIndex

◆ m_maxPt

◆ m_maxPtCutIndex

◆ m_maxRapidity

◆ m_maxRapidityCutIndex

◆ m_minEta

◆ m_minEtaCutIndex

◆ m_minPt

◆ m_minPtCutIndex

◆ m_minRapidity

◆ m_minRapidityCutIndex

◆ m_printCastWarning

◆ m_printClusterWarning

◆ m_shouldPrintCastWarning

◆ m_shouldPrintClusterWarning

◆ m_useClusterEta

◆ m_useConstituentMomentum

◆ m_useDressedProperties

◆ m_varHandleArraysDeclared

◆ m_vhka