CP::AsgNumDecorationSelectionTool< T > Class Template Reference

a templated IAsgSelectionTool that performs basic cut on numerical decorations (e.g., int, uint8_t) More...

#include <AsgNumDecorationSelectionTool.h>

Inheritance diagram for CP::AsgNumDecorationSelectionTool< T >:

Collaboration diagram for CP::AsgNumDecorationSelectionTool< T >:

Public Member Functions
	AsgNumDecorationSelectionTool (const std::string &type, const std::string &myname, const IInterface *parent)
virtual	~AsgNumDecorationSelectionTool ()
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 *particle) const override
	The main accept method: the actual cuts are applied here.
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
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
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.

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>

Static Private Member Functions
static std::string	getDefaultDecorationName ()

Private Attributes
Gaudi::Property< std::string >	m_name {this, "decorationName", getDefaultDecorationName(), "name of the decoration on which the cuts are applied"}
Gaudi::Property< bool >	m_doEqual {this, "doEqual", false, "require to equal a value"}
Gaudi::Property< bool >	m_doMin {this, "doMin", false, "require a min value"}
Gaudi::Property< bool >	m_doMax {this, "doMax", false, "require a max value"}
Gaudi::Property< float >	m_equal {this, "equal", 0.0f, "equal value to require"}
Gaudi::Property< float >	m_min {this, "min", 0.0f, "minimum value to require"}
Gaudi::Property< float >	m_max {this, "max", 0.0f, "maximum value to require"}
int	m_equalCutIndex { -1 }
int	m_minCutIndex { -1 }
int	m_maxCutIndex { -1 }
std::unique_ptr< SG::ConstAccessor< T > >	m_accessor
asg::AcceptInfo	m_accept
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

template<typename T>
class CP::AsgNumDecorationSelectionTool< T >

a templated IAsgSelectionTool that performs basic cut on numerical decorations (e.g., int, uint8_t)

Definition at line 24 of file AsgNumDecorationSelectionTool.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

AsgNumDecorationSelectionTool()

template<typename T>

CP::AsgNumDecorationSelectionTool< T >::AsgNumDecorationSelectionTool	(	const std::string &	type,
		const std::string &	myname,
		const IInterface *	parent )

Definition at line 12 of file AsgNumDecorationSelectionTool.cxx.

    : asg::AsgTool(std::string(asg::ptrToString(parent))+"#"+type+"/"+myname)
  {
    // cppcheck-suppress missingReturn; false positive
  }

~AsgNumDecorationSelectionTool()

template<typename T>

CP::AsgNumDecorationSelectionTool< T >::~AsgNumDecorationSelectionTool ( )

virtual

Definition at line 21 of file AsgNumDecorationSelectionTool.cxx.

  {
  }

Member Function Documentation

accept()

template<typename T>

asg::AcceptData CP::AsgNumDecorationSelectionTool< T >::accept ( const xAOD::IParticle * ) const

overridevirtual

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

Implements IAsgSelectionTool.

Definition at line 68 of file AsgNumDecorationSelectionTool.cxx.

  {
    asg::AcceptData accept(&m_accept);
 
    const SG::AuxElement* aux = dynamic_cast<const SG::AuxElement*>(particle);
    if (!aux) {
      ATH_MSG_ERROR("Particle is not derived from AuxElement, cannot read decoration. Cut considered as failed.");
      return accept; // reject all cuts by default
    }
 
    if (!m_accessor->isAvailable(*aux)) {
      ATH_MSG_WARNING("Decoration \"" << m_name << "\" not available; setting all cuts as passed.");
      if (m_equalCutIndex >= 0) accept.setCutResult(m_equalCutIndex, true);
      if (m_minCutIndex >= 0)   accept.setCutResult(m_minCutIndex, true);
      if (m_maxCutIndex >= 0)   accept.setCutResult(m_maxCutIndex, true);
      return accept;
    }
 
    const T value = (*m_accessor)(*aux);
 
    if (m_equalCutIndex >= 0) {
      accept.setCutResult(m_equalCutIndex, static_cast<float>(value) == m_equal);
    }
 
    if (m_minCutIndex >= 0) {
      accept.setCutResult(m_minCutIndex, static_cast<float>(value) >= m_min);
    }
 
    if (m_maxCutIndex >= 0) {
      accept.setCutResult(m_maxCutIndex, static_cast<float>(value) < m_max);
    }
 
    return accept;
  }

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

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

template<typename T>

const asg::AcceptInfo & CP::AsgNumDecorationSelectionTool< T >::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 62 of file AsgNumDecorationSelectionTool.cxx.

  {
    return m_accept;
  }

getDefaultDecorationName()

template<typename T>

std::string CP::AsgNumDecorationSelectionTool< T >::getDefaultDecorationName ( )

inlinestaticprivate

Definition at line 43 of file AsgNumDecorationSelectionTool.h.

                                                {
      std::string typeName = typeid(T).name();
      return "dummy_" + typeName;
    }

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

template<typename T>

StatusCode CP::AsgNumDecorationSelectionTool< T >::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.

Definition at line 33 of file AsgNumDecorationSelectionTool.cxx.

  {
    if (m_doEqual) {
      if (m_doMin || m_doMax) {
        ATH_MSG_WARNING("Equal cut overrides min/max on \"" << m_name << "\"; disabling min/max.");
        m_doMin = false;
        m_doMax = false;
      }
      ATH_MSG_DEBUG("Applying " << m_name << " == " << m_equal << " selection");
      m_equalCutIndex = m_accept.addCut("equal", "Exact equality cut");
    }
 
    if (m_doMin) {
      ATH_MSG_DEBUG("Applying " << m_name << " >= " << m_min << " selection");
      m_minCutIndex = m_accept.addCut("min", "Minimum cut");
    }
 
    if (m_doMax) {
      ATH_MSG_DEBUG("Applying " << m_name << " < " << m_max << " selection");
      m_maxCutIndex = m_accept.addCut("max", "Maximum cut");
    }
 
    // Construct the decoration accessor for the desired type
    m_accessor = std::make_unique<SG::ConstAccessor<T>>(m_name);
 
    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()

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

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_accept

template<typename T>

asg::AcceptInfo CP::AsgNumDecorationSelectionTool< T >::m_accept

private

Definition at line 62 of file AsgNumDecorationSelectionTool.h.

m_accessor

template<typename T>

std::unique_ptr<SG::ConstAccessor<T> > CP::AsgNumDecorationSelectionTool< T >::m_accessor

private

Definition at line 60 of file AsgNumDecorationSelectionTool.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_doEqual

template<typename T>

Gaudi::Property<bool> CP::AsgNumDecorationSelectionTool< T >::m_doEqual {this, "doEqual", false, "require to equal a value"}

private

Definition at line 49 of file AsgNumDecorationSelectionTool.h.

{this, "doEqual", false, "require to equal a value"};

m_doMax

template<typename T>

Gaudi::Property<bool> CP::AsgNumDecorationSelectionTool< T >::m_doMax {this, "doMax", false, "require a max value"}

private

Definition at line 51 of file AsgNumDecorationSelectionTool.h.

{this, "doMax", false, "require a max value"};

m_doMin

template<typename T>

Gaudi::Property<bool> CP::AsgNumDecorationSelectionTool< T >::m_doMin {this, "doMin", false, "require a min value"}

private

Definition at line 50 of file AsgNumDecorationSelectionTool.h.

{this, "doMin", false, "require a min value"};

m_equal

template<typename T>

Gaudi::Property<float> CP::AsgNumDecorationSelectionTool< T >::m_equal {this, "equal", 0.0f, "equal value to require"}

private

Definition at line 52 of file AsgNumDecorationSelectionTool.h.

{this, "equal", 0.0f, "equal value to require"};

m_equalCutIndex

template<typename T>

int CP::AsgNumDecorationSelectionTool< T >::m_equalCutIndex { -1 }

private

Definition at line 56 of file AsgNumDecorationSelectionTool.h.

{ -1 };

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_max

template<typename T>

Gaudi::Property<float> CP::AsgNumDecorationSelectionTool< T >::m_max {this, "max", 0.0f, "maximum value to require"}

private

Definition at line 54 of file AsgNumDecorationSelectionTool.h.

{this, "max", 0.0f, "maximum value to require"};

m_maxCutIndex

template<typename T>

int CP::AsgNumDecorationSelectionTool< T >::m_maxCutIndex { -1 }

private

Definition at line 58 of file AsgNumDecorationSelectionTool.h.

{ -1 };

m_min

template<typename T>

Gaudi::Property<float> CP::AsgNumDecorationSelectionTool< T >::m_min {this, "min", 0.0f, "minimum value to require"}

private

Definition at line 53 of file AsgNumDecorationSelectionTool.h.

{this, "min", 0.0f, "minimum value to require"};

m_minCutIndex

template<typename T>

int CP::AsgNumDecorationSelectionTool< T >::m_minCutIndex { -1 }

private

Definition at line 57 of file AsgNumDecorationSelectionTool.h.

{ -1 };

m_name

template<typename T>

Gaudi::Property<std::string> CP::AsgNumDecorationSelectionTool< T >::m_name {this, "decorationName", getDefaultDecorationName(), "name of the decoration on which the cuts are applied"}

private

Definition at line 48 of file AsgNumDecorationSelectionTool.h.

{this, "decorationName", getDefaultDecorationName(), "name of the decoration on which the cuts are applied"};

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:

• AsgNumDecorationSelectionTool.h
• AsgNumDecorationSelectionTool.cxx