DiTauWPDecorator Class Reference

#include <DiTauWPDecorator.h>

Inheritance diagram for DiTauWPDecorator:

Collaboration diagram for DiTauWPDecorator:

Public Member Functions
	DiTauWPDecorator (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~DiTauWPDecorator ()
virtual StatusCode	initialize () override
	Tool initializer.
virtual StatusCode	executeObj (xAOD::DiTauJet &xDiTau, const EventContext &ctx) const override
	Execute - called for each Ditau jet.
bool	passOmniWP (float score, float wp_thrshold) const
virtual StatusCode	eventInitialize (DiTauCandidateData *data)
	Event initializer - called at the beginning of each event.
virtual StatusCode	execute (DiTauCandidateData *data, const EventContext &ctx) const
	Execute - called for each Ditau candidate.
virtual StatusCode	finalize ()
	Finalizer.
template<class T>
bool	retrieveTool (T &tool)
	Convenience functions to handle storegate objects.
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	InterfaceID implementation needed for ToolHandle.

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>

Private Attributes
Gaudi::Property< std::string >	m_scoreName {this, "ScoreName", "", "Name of the original score"}
Gaudi::Property< std::vector< std::string > >	m_decorWPs {this, "DecorWPNames", {}, "Name of WPs"}
Gaudi::Property< std::vector< float > >	m_decorWPCuts {this, "DecorWPCuts", {}, "Cut on each WP to be docorated for ditaus"}
std::vector< SG::AuxElement::Accessor< char > >	m_charDecors
Gaudi::Property< std::string >	m_ditauContainerName {this, "DiTauContainerName", "", "Name of DiTauJetContainer, must be set when using "}
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 16 of file DiTauWPDecorator.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

DiTauWPDecorator()

DiTauWPDecorator::DiTauWPDecorator	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Definition at line 9 of file DiTauWPDecorator.cxx.

                                                                                                           :
  DiTauToolBase(type, name, parent)
{
  declareInterface<DiTauToolBase > (this);
}

~DiTauWPDecorator()

DiTauWPDecorator::~DiTauWPDecorator ( )

virtualdefault

Member Function Documentation

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

eventInitialize()

StatusCode DiTauToolBase::eventInitialize ( DiTauCandidateData * data )

virtualinherited

Event initializer - called at the beginning of each event.

Definition at line 32 of file DiTauToolBase.cxx.

{
  return StatusCode::SUCCESS;
}

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

execute()

StatusCode DiTauToolBase::execute ( DiTauCandidateData * data, const EventContext & ctx ) const

virtualinherited

Execute - called for each Ditau candidate.

Reimplemented in CellFinder, DiTauConstituentFinder, DiTauExtraVarDecorator, DiTauOnnxDiscriminantTool, DiTauTrackFinder, SeedJetBuilder, SubjetBuilder, and VertexFinder.

Definition at line 38 of file DiTauToolBase.cxx.

{
  return StatusCode::SUCCESS;
}

executeObj()

StatusCode DiTauWPDecorator::executeObj ( xAOD::DiTauJet & xDiTau, const EventContext & ctx ) const

overridevirtual

Execute - called for each Ditau jet.

Reimplemented from DiTauToolBase.

Definition at line 33 of file DiTauWPDecorator.cxx.

{
    const SG::ConstAccessor<float> acc_score(m_scoreName);
    float score = acc_score(xDiTau); 
 
    // Decorate other WPs
    for (size_t wpIndex=0; wpIndex < m_decorWPs.size(); ++wpIndex) {
      const SG::Accessor<char>& decorator = m_charDecors[wpIndex];
      decorator(xDiTau) = passOmniWP(score,m_decorWPCuts[wpIndex]);
    }
 
    return StatusCode::SUCCESS;
}

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

finalize()

StatusCode DiTauToolBase::finalize ( )

virtualinherited

Finalizer.

Reimplemented in DiTauOnnxDiscriminantTool.

Definition at line 50 of file DiTauToolBase.cxx.

{
  return StatusCode::SUCCESS;
}

initialize()

StatusCode DiTauWPDecorator::initialize ( )

overridevirtual

Tool initializer.

Reimplemented from DiTauToolBase.

Definition at line 19 of file DiTauWPDecorator.cxx.

{
  if (!m_ditauContainerName.empty() && m_decorWPs.empty()) {
    ATH_MSG_ERROR("DiTauContainerName is provided but DecorWPNames is empty");
    return StatusCode::FAILURE;
  }
 
  for (size_t wpIndex=0; wpIndex < m_decorWPs.size(); ++wpIndex) {
    m_charDecors.emplace_back(SG::AuxElement::Accessor<char>( m_decorWPs[wpIndex] ));
  }
 
  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.

interfaceID()

const InterfaceID & DiTauToolBase::interfaceID ( )

staticinherited

InterfaceID implementation needed for ToolHandle.

Definition at line 9 of file DiTauToolBase.cxx.

                                              {
  return DiTauToolBaseID;
}

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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.

passOmniWP()

bool DiTauWPDecorator::passOmniWP	(	float	score,
		float	wp_thrshold ) const

Definition at line 47 of file DiTauWPDecorator.cxx.

                                                                      { 
    return score > wp_thrshold;
}    

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

retrieveTool()

template<class T>

bool DiTauToolBase::retrieveTool ( T & tool )

inherited

Convenience functions to handle storegate objects.

Definition at line 59 of file DiTauToolBase.cxx.

                                         {
  if (tool.retrieve().isFailure()) {
    ATH_MSG_FATAL("Failed to retrieve tool " << tool);
    return false;
  } else {
    ATH_MSG_VERBOSE("Retrieved tool " << tool);
  }
  return true;
}

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_charDecors

std::vector<SG::AuxElement::Accessor<char> > DiTauWPDecorator::m_charDecors

private

Definition at line 38 of file DiTauWPDecorator.h.

m_decorWPCuts

Gaudi::Property<std::vector<float> > DiTauWPDecorator::m_decorWPCuts {this, "DecorWPCuts", {}, "Cut on each WP to be docorated for ditaus"}

private

Definition at line 36 of file DiTauWPDecorator.h.

{this, "DecorWPCuts", {}, "Cut on each WP to be docorated for ditaus"}; 

m_decorWPs

Gaudi::Property<std::vector<std::string> > DiTauWPDecorator::m_decorWPs {this, "DecorWPNames", {}, "Name of WPs"}

private

Definition at line 35 of file DiTauWPDecorator.h.

{this, "DecorWPNames", {}, "Name of WPs"};

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_ditauContainerName

Gaudi::Property<std::string> DiTauWPDecorator::m_ditauContainerName {this, "DiTauContainerName", "", "Name of DiTauJetContainer, must be set when using "}

private

Definition at line 40 of file DiTauWPDecorator.h.

{this, "DiTauContainerName", "", "Name of DiTauJetContainer, must be set when using "};

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_scoreName

Gaudi::Property<std::string> DiTauWPDecorator::m_scoreName {this, "ScoreName", "", "Name of the original score"}

private

Definition at line 34 of file DiTauWPDecorator.h.

{this, "ScoreName", "", "Name of the original score"};

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:

• DiTauWPDecorator.h
• DiTauWPDecorator.cxx