#include <MuonClusterHypoTool.h>

Inheritance diagram for MuonClusterHypoTool:

Collaboration diagram for MuonClusterHypoTool:

Classes
struct	DecisionInfo

Public Member Functions
	MuonClusterHypoTool (const std::string &type, const std::string &name, const IInterface *parent)
	~MuonClusterHypoTool ()
StatusCode	initialize ()
StatusCode	decide (DecisionInfo &input) const
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

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
HLT::Identifier	m_decisionId
ToolHandle< GenericMonitoringTool >	m_monTool { this, "MonTool", "", "Monitoring tool" }
Gaudi::Property< bool >	m_acceptAll {this, "acceptAll", false, "Whether we are to accept all MuonRoIClusters or only those that pass selection"}
Gaudi::Property< int >	m_nRoIEndCap {this, "nRoIEndCap", 4, "Number of RoI required to reconstruct a cluster in the Endcap"}
Gaudi::Property< int >	m_nRoIBarrel {this, "nRoIBarrel", 3, "Number of RoI required to reconstruct a cluster in the Barrel"}
Gaudi::Property< float >	m_etaMax {this, "maxEta", 2.5, "Maximum eta value below which muonRoIClusters can reliably be reconstructed"}
Gaudi::Property< float >	m_etaMid {this, "midEta", 1.0, "Eta value used to define the boundary between the Barrel and Endcap"}
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 31 of file MuonClusterHypoTool.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

◆ MuonClusterHypoTool()

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

Definition at line 33 of file MuonClusterHypoTool.cxx.

36 : AthAlgTool( type, name, parent ),

37 m_decisionId( HLT::Identifier::fromToolName( name ) ) {}

AthAlgTool::AthAlgTool

AthAlgTool()

Default constructor:

HLT::Identifier::fromToolName

static HLT::Identifier fromToolName(const std::string &tname)

Definition HLTIdentifier.cxx:21

MuonClusterHypoTool::m_decisionId

HLT::Identifier m_decisionId

Definition MuonClusterHypoTool.h:50

◆ ~MuonClusterHypoTool()

MuonClusterHypoTool::~MuonClusterHypoTool ( )

Definition at line 49 of file MuonClusterHypoTool.cxx.

49{}

Member Function Documentation

◆ decide()

StatusCode MuonClusterHypoTool::decide ( DecisionInfo & input ) const

Definition at line 51 of file MuonClusterHypoTool.cxx.

{
    auto monNumberRoI    = Monitored::Scalar<int>( "numberRoI",  -99 );
 
    auto monEtaClust     = Monitored::Scalar<float>( "etaClust", -99 );
    auto monPhiClust     = Monitored::Scalar<float>( "phiClust", -99 );
    auto monEtaClustPass = Monitored::Scalar<float>( "etaClustPass", -99 );
    auto monPhiClustPass = Monitored::Scalar<float>( "phiClustPass", -99 );
 
    auto monNumRoIB      = Monitored::Scalar<int>( "nRoIBarrel",  -99 );
    auto monNumRoIE      = Monitored::Scalar<int>( "nRoIEndcap",  -99 );
    auto monNumRoIBPass  = Monitored::Scalar<int>( "nRoIBarrelPass",  -99 );
    auto monNumRoIEPass  = Monitored::Scalar<int>( "nRoIEndcapPass",  -99 );
 
    auto result          = Monitored::Scalar<Bool_t>( "result", false );
    auto chainActive     = Monitored::Scalar<Bool_t>( "chainActive", false );
 
    auto t1              = Monitored::Timer("TIME_HypoTool"); // microseconds
    auto t2              = Monitored::Timer("TIME_HypoTool_GetCluster");
    auto t3              = Monitored::Timer("TIME_HypoTool_Selection");
 
    auto monitorIt = Monitored::Group( m_monTool, monNumberRoI, monEtaClust, monPhiClust,
                                       monNumRoIB, monNumRoIE, monEtaClustPass, monPhiClustPass,
                                       result, monNumRoIBPass, monNumRoIEPass, chainActive,
                                       t1, t2, t3 );
 
    const xAOD::TrigCompositeContainer *compCont = input.Composites;
    TrigCompositeUtils::DecisionIDContainer prev = input.activeChainIDs;
 
    // Exctracting MuonClusterRoI info
    ATH_MSG_DEBUG("Found  " << compCont->size() << " TrigComposite objects");
 
    int numberRoI = 0;
    float etaClust = -99;
    float phiClust = -99;
 
    bool foundMuonRoICluster = false;
 
    t2.start();
    for(const xAOD::TrigComposite *compObj : *compCont) {
        ATH_MSG_DEBUG("TrigComposite ptr = " << compObj);
        ATH_MSG_DEBUG("Found object named Cluster : " << (compObj->name()== "Cluster" ? "yes":"no"));
        if(compObj->name() == "Cluster" ) {
            foundMuonRoICluster = true;
            //if we can't access all the variables necessary for the trigger hypothesis,
            //return FAILURE, because it means the variables are missing
            if(!compObj->getDetail("nRoIs", numberRoI)) { return StatusCode::FAILURE; }
            if(!compObj->getDetail("ClusterEta", etaClust)) { return StatusCode::FAILURE; }
            if(!compObj->getDetail("ClusterPhi", phiClust)) { return StatusCode::FAILURE; }
        }
    }
    t2.stop();
    if( !foundMuonRoICluster ) { return StatusCode::FAILURE;}
 
    // Updating Monitoring values
    monNumberRoI = numberRoI;
    monEtaClust  = etaClust;
    monPhiClust  = phiClust;
 
    // Monitor ALL muonRoICluster multiplicities
    if(fabs(etaClust)< m_etaMid){
        monNumRoIB = numberRoI;
    } else if((fabs(etaClust)>= m_etaMid && fabs(etaClust)<= m_etaMax)){
        monNumRoIE = numberRoI;
    }
 
    // Bool as to whether we passed.
    result = false;
 
    // acceptAll can be enabled for testing
    if(m_acceptAll) {
        t3.start();
        result = true;
        ATH_MSG_DEBUG("Accept property is set: taking all the events");
        t3.stop();
 
    } else {
 
        t3.start();
        result = true; //set result to true in case of errors for safety
 
        ATH_MSG_DEBUG("Cluster has " << numberRoI << " muon RoIs, at (eta, phi) = (" << etaClust << ", " << phiClust << ")");
 
        // Cut on number of RoIs in the cluster
        if(fabs(etaClust)<=m_etaMax) {
 
            if(fabs(etaClust)< m_etaMid && numberRoI >= m_nRoIBarrel) {
 
                    ATH_MSG_DEBUG("Cluster passes barrel selection > " << m_nRoIBarrel << " RoIs");
 
                    // monitored variables
                    monNumRoIBPass = numberRoI;
                    monEtaClustPass = etaClust;
                    monPhiClustPass = phiClust;
                    result = true;
 
            } else if((fabs(etaClust)>= m_etaMid && fabs(etaClust)<= m_etaMax) && numberRoI >= m_nRoIEndCap) {
 
                    ATH_MSG_DEBUG("Cluster passes endcap selection > " << m_nRoIEndCap << " RoIs");
 
                    // monitored variables
                    monNumRoIEPass = numberRoI;
                    monEtaClustPass = etaClust;
                    monPhiClustPass = phiClust;
                    result = true;
 
            } else {
                ATH_MSG_DEBUG("Cluster does not satisfy all the conditions... event not accepted");
                result = false;
            }
 
        } else {
            ATH_MSG_DEBUG("Cluster location past maximum permitted eta... event not accepted");
            result = false;
        }
 
        t3.stop();
 
    }
 
    ATH_MSG_DEBUG( "Writing out active chains:" );
    for (DecisionID activeChain : prev)
    {
        ATH_MSG_DEBUG( HLT::Identifier( activeChain ) );
    }
 
    // Checking if this HypoTool's chain is active in this event...
    chainActive = prev.count(m_decisionId.numeric()) > 0;
    if( (prev.count(m_decisionId.numeric()) > 0 ) )
    {
        // If it's active, then check selection. ie nothing should pass if its not active.
        if( result ) {
            addDecisionID( m_decisionId.numeric(), input.decision );
            ATH_MSG_DEBUG("event accepted");
 
            return StatusCode::SUCCESS;
        }
        else {
            return StatusCode::SUCCESS;
        }
    } else {
        return StatusCode::SUCCESS;
    }
}

◆ 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

◆ initialize()

StatusCode MuonClusterHypoTool::initialize ( )

Definition at line 39 of file MuonClusterHypoTool.cxx.

{
   if ( !m_monTool.empty() ) ATH_CHECK( m_monTool.retrieve() );
 
   ATH_MSG_INFO("Initialization completed successfully:");
   ATH_MSG_INFO("Tool configured for chain/id: " << m_decisionId);
 
   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();
  }

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

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

Gaudi::Property<bool> MuonClusterHypoTool::m_acceptAll {this, "acceptAll", false, "Whether we are to accept all MuonRoIClusters or only those that pass selection"}

private

Definition at line 52 of file MuonClusterHypoTool.h.

52{this, "acceptAll", false, "Whether we are to accept all MuonRoIClusters or only those that pass selection"};

◆ m_decisionId

HLT::Identifier MuonClusterHypoTool::m_decisionId

private

Definition at line 50 of file MuonClusterHypoTool.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_etaMax

Gaudi::Property<float> MuonClusterHypoTool::m_etaMax {this, "maxEta", 2.5, "Maximum eta value below which muonRoIClusters can reliably be reconstructed"}

private

Definition at line 55 of file MuonClusterHypoTool.h.

55{this, "maxEta", 2.5, "Maximum eta value below which muonRoIClusters can reliably be reconstructed"};

◆ m_etaMid

Gaudi::Property<float> MuonClusterHypoTool::m_etaMid {this, "midEta", 1.0, "Eta value used to define the boundary between the Barrel and Endcap"}

private

Definition at line 56 of file MuonClusterHypoTool.h.

56{this, "midEta", 1.0, "Eta value used to define the boundary between the Barrel and Endcap"};

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

ToolHandle<GenericMonitoringTool> MuonClusterHypoTool::m_monTool { this, "MonTool", "", "Monitoring tool" }

private

Definition at line 51 of file MuonClusterHypoTool.h.

51{ this, "MonTool", "", "Monitoring tool" };

◆ m_nRoIBarrel

Gaudi::Property<int> MuonClusterHypoTool::m_nRoIBarrel {this, "nRoIBarrel", 3, "Number of RoI required to reconstruct a cluster in the Barrel"}

private

Definition at line 54 of file MuonClusterHypoTool.h.

54{this, "nRoIBarrel", 3, "Number of RoI required to reconstruct a cluster in the Barrel"};

◆ m_nRoIEndCap

Gaudi::Property<int> MuonClusterHypoTool::m_nRoIEndCap {this, "nRoIEndCap", 4, "Number of RoI required to reconstruct a cluster in the Endcap"}

private

Definition at line 53 of file MuonClusterHypoTool.h.

53{this, "nRoIEndCap", 4, "Number of RoI required to reconstruct a cluster in the Endcap"};

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

Classes

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ MuonClusterHypoTool()

◆ ~MuonClusterHypoTool()

Member Function Documentation

◆ decide()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_acceptAll

◆ m_decisionId

◆ m_detStore

◆ m_etaMax

◆ m_etaMid

◆ m_evtStore

◆ m_monTool

◆ m_nRoIBarrel

◆ m_nRoIEndCap

◆ m_varHandleArraysDeclared

◆ m_vhka