#include <AsgRingerSelectorTool.h>

Inheritance diagram for Ringer::AsgRingerSelectorTool:

Collaboration diagram for Ringer::AsgRingerSelectorTool:

Public Member Functions
virtual ASG_TOOL_CLASS2(AsgRingerSelectorTool, IAsgRingerSelectorTool, IAsgSelectionTool) AsgRingerSelectorTool(const std	~AsgRingerSelectorTool ()
	Standard constructor.
virtual StatusCode	initialize () override
	Gaudi Service Interface method implementations.
virtual StatusCode	finalize () override
	Gaudi Service Interface method implementations.
virtual const asg::AcceptInfo &	getAcceptInfo () const override
	Method to get the plain TAccept for the last particle.
virtual float	predict (const xAOD::TrigRingerRings *) const override
	@briel Calculation of model output for fast calorimetry or fast photon step (HLT usage only)
virtual float	predict (const xAOD::TrigRingerRings , const xAOD::TrigElectron ) const override
	@briel Calculation of model output for fast electron step (HLT usage only)
virtual asg::AcceptData	accept (const xAOD::TrigRingerRings *, float discr, float mu) const override
	Accept method.
virtual asg::AcceptData	accept (const xAOD::IParticle *) 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>

Private Attributes
asg::AcceptInfo	m_accept
onnx::RingerSelector	m_selector
Gaudi::Property< std::vector< std::string > >	m_configFiles {this, "ConfigFiles", {}, "Ringer Run3 Calib Path"}
ServiceHandle< AthOnnx::IOnnxRuntimeSvc >	m_onnxSvc { this, "ONNXRuntimeSvc", "AthOnnx::OnnxRuntimeSvc", "Name of the service to use" }
Gaudi::Property< bool >	m_useTansigOutput {this, "UseTansigOutput", {}, "Use tansig output."}
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 24 of file AsgRingerSelectorTool.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

◆ ~AsgRingerSelectorTool()

Ringer::AsgRingerSelectorTool::~AsgRingerSelectorTool ( )

virtual

Standard constructor.

Standard destructor

Definition at line 23 of file AsgRingerSelectorTool.cxx.

24{}

Member Function Documentation

◆ accept() [1/2]

asg::AcceptData Ringer::AsgRingerSelectorTool::accept ( const xAOD::IParticle * ) const

overridevirtual

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

Implements Ringer::IAsgRingerSelectorTool.

Definition at line 55 of file AsgRingerSelectorTool.cxx.

{
  asg::AcceptData acceptData(&m_accept);
  return acceptData; 
}

◆ accept() [2/2]

asg::AcceptData Ringer::AsgRingerSelectorTool::accept	(	const xAOD::TrigRingerRings *	ringsCluster,
		float	discr,
		float	mu ) const

overridevirtual

Accept method.

Implements Ringer::IAsgRingerSelectorTool.

Definition at line 63 of file AsgRingerSelectorTool.cxx.

{
  asg::AcceptData acceptData(&m_accept);
  bool pass = m_selector.accept( ringsCluster, discr, mu );
  acceptData.setCutResult("Pass", pass); 
  return acceptData;
}

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

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

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

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ 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 Ringer::AsgRingerSelectorTool::finalize ( )

overridevirtual

Gaudi Service Interface method implementations.

Definition at line 48 of file AsgRingerSelectorTool.cxx.

{
  return StatusCode::SUCCESS;
}

◆ getAcceptInfo()

virtual const asg::AcceptInfo & Ringer::AsgRingerSelectorTool::getAcceptInfo ( ) const

inlineoverridevirtual

Method to get the plain TAccept for the last particle.

Implements Ringer::IAsgRingerSelectorTool.

Definition at line 52 of file AsgRingerSelectorTool.h.

52{ 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 Ringer::AsgRingerSelectorTool::initialize ( void )

overridevirtual

Gaudi Service Interface method implementations.

Reimplemented from asg::AsgTool.

Definition at line 31 of file AsgRingerSelectorTool.cxx.

{
  
  for( auto& configFile : m_configFiles )
  {
    if( m_selector.read_from( configFile, &*m_onnxSvc ).isFailure() ){
        ATH_MSG_ERROR( "It's not possible to read all tuning files from " << configFile );
        return StatusCode::FAILURE;
    } 
  }
 
  m_accept.addCut("Pass", "Aproved by ringer");
  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.

◆ predict() [1/2]

float Ringer::AsgRingerSelectorTool::predict ( const xAOD::TrigRingerRings * ringsCluster ) const

overridevirtual

@briel Calculation of model output for fast calorimetry or fast photon step (HLT usage only)

Implements Ringer::IAsgRingerSelectorTool.

Definition at line 73 of file AsgRingerSelectorTool.cxx.

{
  float output = m_selector.predict( ringsCluster , nullptr);
  return m_useTansigOutput ? tanh(output) : output;
}

◆ predict() [2/2]

float Ringer::AsgRingerSelectorTool::predict	(	const xAOD::TrigRingerRings *	ringsCluster,
		const xAOD::TrigElectron *	el ) const

overridevirtual

@briel Calculation of model output for fast electron step (HLT usage only)

Implements Ringer::IAsgRingerSelectorTool.

Definition at line 81 of file AsgRingerSelectorTool.cxx.

{
  float output =  m_selector.predict( ringsCluster , el);
  return m_useTansigOutput ? tanh(output) : output;
}

◆ 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

asg::AcceptInfo Ringer::AsgRingerSelectorTool::m_accept

private

Definition at line 77 of file AsgRingerSelectorTool.h.

◆ m_configFiles

Gaudi::Property<std::vector<std::string> > Ringer::AsgRingerSelectorTool::m_configFiles {this, "ConfigFiles", {}, "Ringer Run3 Calib Path"}

private

Definition at line 80 of file AsgRingerSelectorTool.h.

80{this, "ConfigFiles", {}, "Ringer Run3 Calib Path"};

◆ 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_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_onnxSvc

ServiceHandle< AthOnnx::IOnnxRuntimeSvc > Ringer::AsgRingerSelectorTool::m_onnxSvc { this, "ONNXRuntimeSvc", "AthOnnx::OnnxRuntimeSvc", "Name of the service to use" }

private

Definition at line 81 of file AsgRingerSelectorTool.h.

81{ this, "ONNXRuntimeSvc", "AthOnnx::OnnxRuntimeSvc", "Name of the service to use" };

◆ m_selector

onnx::RingerSelector Ringer::AsgRingerSelectorTool::m_selector

private

Definition at line 78 of file AsgRingerSelectorTool.h.

◆ m_useTansigOutput

Gaudi::Property<bool> Ringer::AsgRingerSelectorTool::m_useTansigOutput {this, "UseTansigOutput", {}, "Use tansig output."}

private

Definition at line 82 of file AsgRingerSelectorTool.h.

82{this, "UseTansigOutput", {}, "Use tansig output."};

◆ 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

Constructor & Destructor Documentation

◆ ~AsgRingerSelectorTool()

Member Function Documentation

◆ accept() [1/2]

◆ accept() [2/2]

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ getAcceptInfo()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ predict() [1/2]

◆ predict() [2/2]

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_accept

◆ m_configFiles

◆ m_detStore

◆ m_evtStore

◆ m_onnxSvc

◆ m_selector

◆ m_useTansigOutput

◆ m_varHandleArraysDeclared

◆ m_vhka