CP::JvtSelectionToolBase Class Reference

#include <JvtSelectionToolBase.h>

Inheritance diagram for CP::JvtSelectionToolBase:

Collaboration diagram for CP::JvtSelectionToolBase:

Public Member Functions
virtual	~JvtSelectionToolBase ()=default
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual const asg::AcceptInfo &	getAcceptInfo () const override
	Declare the interface ID for this pure-virtual interface class to the Athena framework.
virtual asg::AcceptData	accept (const xAOD::IParticle *jet) const override
	The main accept method: the actual cuts are applied here.
virtual StatusCode	decorate (const xAOD::JetContainer &jets) const override
	Decorate a jet collection without otherwise modifying it.
	AsgTool (const std::string &name)
	Constructor specifying the tool instance's name.
	AsgTool (const AsgTool &)=delete
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () 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.
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
virtual bool	isInRange (const xAOD::IParticle *jet) const
virtual bool	select (const xAOD::IParticle *jet) const =0
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.

Protected Attributes
Gaudi::Property< float >	m_minPtForJvt
Gaudi::Property< float >	m_maxPtForJvt
Gaudi::Property< float >	m_minEta
Gaudi::Property< float >	m_maxEta
Gaudi::Property< std::string >	m_jetEtaName
SG::ReadHandleKey< xAOD::JetContainer >	m_jetContainer
SG::ReadDecorHandleKey< xAOD::JetContainer >	m_jvtMomentKey
SG::WriteDecorHandleKey< xAOD::JetContainer >	m_passJvtKey
asg::AcceptInfo	m_info
int	m_cutPos = 0
SG::ConstAccessor< float >	m_etaAcc { m_jetEtaName }

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>

Private Attributes
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 17 of file JvtSelectionToolBase.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

~JvtSelectionToolBase()

virtual CP::JvtSelectionToolBase::~JvtSelectionToolBase ( )

virtualdefault

Member Function Documentation

accept()

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

overridevirtual

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

Implements IAsgSelectionTool.

Definition at line 23 of file JvtSelectionToolBase.cxx.

                                                                             {
        asg::AcceptData data(&m_info);
        data.setCutResult(m_cutPos, select(jet));
        return data;
    }

AsgTool() [1/2]

asg::AsgTool::AsgTool ( const AsgTool & )

delete

AsgTool() [2/2]

asg::AsgTool::AsgTool

(

const std::string &

name

)

Constructor specifying the tool instance's name.

Definition at line 51 of file AsgTool.cxx.

      : AsgToolBase(
#ifndef XAOD_STANDALONE
                    ::getType(name), ::getName(name), ::getParent(name)
#else // not XAOD_STANDALONE
                    name
#endif // not XAOD_STANDALONE
                    )
#ifdef XAOD_STANDALONE
      , m_event()
#endif // XAOD_STANDALONE
   {
      ToolStore::put( this ).ignore(); // Register the tool in the ToolStore
   }

declareGaudiProperty()

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

declareProperty()

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

decorate()

StatusCode CP::JvtSelectionToolBase::decorate ( const xAOD::JetContainer & jets ) const

overridevirtual

Decorate a jet collection without otherwise modifying it.

Implements IJetDecorator.

Definition at line 36 of file JvtSelectionToolBase.cxx.

                                                                                {
        if(m_passJvtKey.key().empty()){
            ATH_MSG_ERROR("Attempted to decorate jets with JVT decision, but decoration name was not configured!");
            return StatusCode::FAILURE;
        }
        SG::WriteDecorHandle<xAOD::JetContainer, char>  passJvtHandle(m_passJvtKey);
        for(const xAOD::Jet* jet : jets) passJvtHandle(*jet) = select(jet);
        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.

{ return m_detStore; }

evtStore()

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.

{ 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::JvtSelectionToolBase::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 21 of file JvtSelectionToolBase.cxx.

{ return m_info; }

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::JvtSelectionToolBase::initialize ( void )

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.

Reimplemented in CP::FJvtSelectionTool, CP::JvtSelectionTool, and CP::NNJvtSelectionTool.

Definition at line 10 of file JvtSelectionToolBase.cxx.

                                                {
        m_etaAcc = SG::ConstAccessor<float>(m_jetEtaName);
        m_cutPos = m_info.addCut("Jvt", "Whether the jet passes the Jvt selection");
 
        ATH_CHECK(m_jetContainer.initialize());
        ATH_CHECK(m_jvtMomentKey.initialize());
        ATH_CHECK(m_passJvtKey.initialize(SG::AllowEmpty));
 
        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.

isInRange()

bool CP::JvtSelectionToolBase::isInRange ( const xAOD::IParticle * jet ) const

protectedvirtual

Definition at line 29 of file JvtSelectionToolBase.cxx.

                                                                       {
        if (jet->pt() < m_minPtForJvt || jet->pt() > m_maxPtForJvt)
            return false;
        float eta = m_etaAcc(*jet);
        return std::abs(eta) >= m_minEta && std::abs(eta) <= m_maxEta;
    }

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.

{return decorate(jets);};

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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 AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.

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

select()

virtual bool CP::JvtSelectionToolBase::select ( const xAOD::IParticle * jet ) const

protectedpure virtual

Implemented in CP::FJvtSelectionTool, CP::JvtSelectionTool, and CP::NNJvtSelectionTool.

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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

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_cutPos

int CP::JvtSelectionToolBase::m_cutPos = 0

protected

Definition at line 54 of file JvtSelectionToolBase.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_etaAcc

SG::ConstAccessor<float> CP::JvtSelectionToolBase::m_etaAcc { m_jetEtaName }

protected

Definition at line 56 of file JvtSelectionToolBase.h.

{ m_jetEtaName };

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_info

asg::AcceptInfo CP::JvtSelectionToolBase::m_info

protected

Definition at line 52 of file JvtSelectionToolBase.h.

m_jetContainer

SG::ReadHandleKey<xAOD::JetContainer> CP::JvtSelectionToolBase::m_jetContainer

protected

Initial value:

{
                this, "JetContainer", "", "The name of the jet container"}

Definition at line 43 of file JvtSelectionToolBase.h.

                                                        {
                this, "JetContainer", "", "The name of the jet container"};

m_jetEtaName

Gaudi::Property<std::string> CP::JvtSelectionToolBase::m_jetEtaName

protected

Initial value:

{
                this, "JetEtaName", "eta", "The name of the jet eta to use."}

Definition at line 40 of file JvtSelectionToolBase.h.

                                             {
                this, "JetEtaName", "eta", "The name of the jet eta to use."};

m_jvtMomentKey

SG::ReadDecorHandleKey<xAOD::JetContainer> CP::JvtSelectionToolBase::m_jvtMomentKey

protected

Initial value:

{
                this, "JvtMomentName", m_jetContainer, "", "The name of the Jvt moment to use"}

Definition at line 45 of file JvtSelectionToolBase.h.

                                                             {
                this, "JvtMomentName", m_jetContainer, "", "The name of the Jvt moment to use"};

m_maxEta

Gaudi::Property<float> CP::JvtSelectionToolBase::m_maxEta

protected

Initial value:

{
                this, "MaxEtaForJvt", 2.5, "Accept all jets with |eta| above this"}

Definition at line 37 of file JvtSelectionToolBase.h.

                                     {
                this, "MaxEtaForJvt", 2.5, "Accept all jets with |eta| above this"};

m_maxPtForJvt

Gaudi::Property<float> CP::JvtSelectionToolBase::m_maxPtForJvt

protected

Initial value:

{
                this, "MaxPtForJvt", 60e3, "Accept all jets with pT above this"}

Definition at line 33 of file JvtSelectionToolBase.h.

                                          {
                this, "MaxPtForJvt", 60e3, "Accept all jets with pT above this"};

m_minEta

Gaudi::Property<float> CP::JvtSelectionToolBase::m_minEta

protected

Initial value:

{
                this, "MinEtaForJvt", -1, "Accept all jets with |eta| below this"}

Definition at line 35 of file JvtSelectionToolBase.h.

                                     {
                this, "MinEtaForJvt", -1, "Accept all jets with |eta| below this"};

m_minPtForJvt

Gaudi::Property<float> CP::JvtSelectionToolBase::m_minPtForJvt

protected

Initial value:

{
                this, "MinPtForJvt", 20e3, "Accept all jets with pT below this"}

Definition at line 31 of file JvtSelectionToolBase.h.

                                          {
                this, "MinPtForJvt", 20e3, "Accept all jets with pT below this"};

m_passJvtKey

SG::WriteDecorHandleKey<xAOD::JetContainer> CP::JvtSelectionToolBase::m_passJvtKey

protected

Initial value:

{
                this, "PassFlagName", m_jetContainer, "", "SG key for output pass-JVT decoration"}

Definition at line 47 of file JvtSelectionToolBase.h.

                                                            {
                this, "PassFlagName", m_jetContainer, "", "SG key for output pass-JVT decoration"};

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:

• JvtSelectionToolBase.h
• JvtSelectionToolBase.cxx