#include <xAODLeptonPairFilter.h>

Inheritance diagram for xAODLeptonPairFilter:

Collaboration diagram for xAODLeptonPairFilter:

Public Member Functions
virtual StatusCode	filterInitialize () override final
virtual StatusCode	filterEvent (const EventContext &ctx) override final
	GenFilter (const std::string &name, ISvcLocator *pSvcLocator)
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
virtual bool	filterPassed (const EventContext &ctx) const
	Get filter decision:
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
	Set filter decision:
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	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
Event loop algorithm methods: not to be overloaded
StatusCode	initialize ()
StatusCode	execute (const EventContext &ctx)
	Execute method.
StatusCode	finalize ()
Gen-specific event loop methods: to be overloaded!
virtual StatusCode	filterFinalize ()
Counters
int	nPassed () const
int	nFailed () const
int	nNeeded () const
bool	keepAll () const
Event collection accessors (const and non-const)
HepMC::GenEvent *event	ATLAS_NOT_CONST_THREAD_SAFE ()
	Access the current signal event (first in the McEventCollection).
McEventCollection *events	ATLAS_NOT_CONST_THREAD_SAFE ()
	Access the current event's McEventCollection.
const HepMC::GenEvent *	event_const (const EventContext &ctx) const
	Access the current signal event (const).
const McEventCollection *	events_const (const EventContext &ctx) const
	Access the current event's McEventCollection (const).

Protected Member Functions
virtual bool	isReEntrant () const override final
	Legacy algorithms are not thread-safe.
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
Counters and requirements
int	m_nPass
int	m_nFail
int	m_nNeeded
bool	m_keepAll

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
SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_truthPartContKey {this, "TruthParticleContainerKey", "TruthGen"}
Gaudi::Property< int >	m_nSFOS_Max {this,"NSFOS_Max",0,"Number of Same Flavor Opposite Sign Max"}
Gaudi::Property< int >	m_nSFOS_Min {this,"NSFOS_Min",0,"Number of Same Flavor Opposite Sign Min"}
Gaudi::Property< int >	m_nSFSS_Max {this,"NSFSS_Max",-1,"Number of Same Flavor Same Sign Max"}
Gaudi::Property< int >	m_nSFSS_Min {this,"NSFSS_Min",-1,"Number of Same Flavor Same Sign Min"}
Gaudi::Property< int >	m_nOFOS_Max {this,"NOFOS_Max",-1,"Number of Opposite Flavor Opposite Sign Max"}
Gaudi::Property< int >	m_nOFOS_Min {this,"NOFOS_Min",-1,"Number of Opposite Flavor Opposite Sign Min"}
Gaudi::Property< int >	m_nOFSS_Max {this,"NOFSS_Max",-1,"Number of Opposite Flavor Same Sign Max"}
Gaudi::Property< int >	m_nOFSS_Min {this,"NOFSS_Min",-1,"Number of Opposite Flavor Same Sign Min"}
Gaudi::Property< int >	m_nPairSum_Max {this,"NPairSum_Max",-1,"Number of Pair sum Max"}
Gaudi::Property< int >	m_nPairSum_Min {this,"NPairSum_Min",-1,"Number of Pair sum Min"}
Gaudi::Property< bool >	m_bUseSFOSInSum {this,"UseSFOSInSum",false,"SFOS to be considered in sum"}
Gaudi::Property< bool >	m_bUseSFSSInSum {this,"UseSFSSInSum",false,"SFSS to be considered in sum"}
Gaudi::Property< bool >	m_bUseOFOSInSum {this,"UseOFOSInSum",false,"OFOS to be considered in sum"}
Gaudi::Property< bool >	m_bUseOFSSInSum {this,"UseOFSSInSum",false,"OFSS to be considered in sum"}
Gaudi::Property< bool >	m_onlyMassiveParents {this,"OnlyMassiveParents",false,"only count leptons with a parent with M>20 GeV"}
Gaudi::Property< double >	m_Ptmin {this,"Ptcut",10000.,"min Pt"}
Gaudi::Property< double >	m_EtaRange {this,"Etacut",10.,"Eta range max"}
Gaudi::Property< int >	m_nLeptons_Max {this,"NLeptons_Max",-1," max num leptons"}
Gaudi::Property< int >	m_nLeptons_Min {this,"NLeptons_Min",0," min num leptons"}
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
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

Properties
SG::ReadHandleKey< McEventCollection >	m_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }
	Const handle to the MC event collection.
std::string	m_mcEventKey {}
	StoreGate key for the MC event collection (defaults to GEN_EVENT).
BooleanProperty	m_mkMcEvent {this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"}
	Flag to determine if a new MC event collection should be made if it doesn't exist.

Detailed Description

Definition at line 25 of file xAODLeptonPairFilter.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

◆ ATLAS_NOT_CONST_THREAD_SAFE() [1/2]

McEventCollection *events GenBase::ATLAS_NOT_CONST_THREAD_SAFE ( )

inherited

Access the current event's McEventCollection.

Note: This function will make a new McEventCollection if there is not already a valid one and MakeMcEvent=True.

◆ ATLAS_NOT_CONST_THREAD_SAFE() [2/2]

HepMC::GenEvent *event GenBase::ATLAS_NOT_CONST_THREAD_SAFE ( )

inlineinherited

Access the current signal event (first in the McEventCollection).

Note: This function will make a new McEventCollection if there is not already a valid one and MakeMcEvent=True.

Definition at line 74 of file GenBase.h.

                                                      {
    if (events()->empty())
      ATH_MSG_ERROR("McEventCollection is empty during first event access");
    return *(events()->begin());
  }

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ event_const()

const HepMC::GenEvent * GenBase::event_const ( const EventContext & ctx ) const

inlineinherited

Access the current signal event (const).

Definition at line 81 of file GenBase.h.

                                                                    {
    const McEventCollection* coll = events_const(ctx);
    if (coll->empty())
      ATH_MSG_ERROR("Const McEventCollection is empty during first event access");
    return *(coll->begin());
  }

◆ events_const()

const McEventCollection * GenBase::events_const ( const EventContext & ctx ) const

inlineinherited

Access the current event's McEventCollection (const).

Definition at line 95 of file GenBase.h.

                                                                         {
    SG::ReadHandle<McEventCollection> ret = SG::makeHandle(m_mcevents_const, ctx);
    if (!ret.isValid())
      ATH_MSG_ERROR("No McEventCollection found in StoreGate with key " << m_mcevents_const.key());
    return ret.cptr();
  }

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode GenFilter::execute ( const EventContext & ctx )

virtualinherited

Execute method.

Todo: Probably the filter should only look at the first event... right?

Reimplemented from GenBase.

Definition at line 27 of file GenFilter.cxx.

                                                     {
  if (events_const(ctx)->empty()) {
    ATH_MSG_ERROR("No events found in McEventCollection");
    return StatusCode::FAILURE;
  } else if (events_const(ctx)->size() > 1) {
    ATH_MSG_WARNING("More than one event in current McEventCollection -- which is valid?");
  }
  StatusCode sc = filterEvent(ctx);
  if (filterPassed(ctx) || m_keepAll ) {
    ATH_MSG_DEBUG("Event passed filter");
    m_nPass += 1;
  } else {
    ATH_MSG_DEBUG("Event failed filter");
    m_nFail += 1;
  }
  // Bail out once we have enough events
  if (m_nPass >= m_nNeeded && m_nNeeded > 0)
    sc = StatusCode::FAILURE;
  return sc;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthCommonAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 89 of file AthCommonAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return BaseAlg::extraOutputDeps();
}

◆ filterEvent()

StatusCode xAODLeptonPairFilter::filterEvent ( const EventContext & ctx )

finaloverridevirtual

Implements GenFilter.

Definition at line 36 of file xAODLeptonPairFilter.cxx.

                                                                    {
//---------------------------------------------------------------------------
 
  // Loop over all events in McEventCollection
  std::vector<int> vLeptonPDGIDs;
  std::vector<double> vLeptonPt;
  std::vector<double> vLeptonEta;
  std::vector<  std::vector < size_t > > vLeptonParentPDGIDs;
 
  // Retrieve TruthGen container from xAOD Gen slimmer, contains all particles witout barcode_zero and
  // duplicated barcode ones
  SG::ReadHandle<xAOD::TruthParticleContainer> xTruthParticleContainer{m_truthPartContKey, ctx};
  CHECK(xTruthParticleContainer.isValid());
 
  // Loop over all particles in the event 
  for (const xAOD::TruthParticle* pitr : *xTruthParticleContainer) {
        if( !MC::isStable(pitr) ) continue;
        // check stable particles only
        // We do not place requirements on their origins (updated: optionally rejecting hadron decays)
        // save pdg ids of found leptons
        // do not consider taus
        if( !MC::isElectron(pitr) && !MC::isMuon(pitr) ) continue;
        //only consider leptons which satisfy  pt and eta requirements
        if( (pitr->pt() < m_Ptmin) || std::abs(pitr->eta()) > m_EtaRange) continue;
              if(m_onlyMassiveParents)
              {
                  auto p = pitr;
                  bool massiveParent = false;
                  while(p)
                  {
                      auto vxp = p->prodVtx();
                      if(!vxp) break;
                      if(vxp->nIncomingParticles()!=1) break;
                      p = vxp->incomingParticle(0);
                      const int pdg = std::abs(p->pdgId());
                      if(!(MC::isSMLepton(pdg) || MC::isPhoton(pdg)))
                      {
                          massiveParent = (p->m()>20000);
                          break;
                      }
                  }
                  if(!massiveParent) continue;
              }
 
        vLeptonPDGIDs.push_back(pitr->pdgId());
        vLeptonPt.push_back(pitr->pt());
        vLeptonEta.push_back(pitr->eta());
 
        std::vector<size_t> parentPDG_tmp;
        for(size_t thisParent_id=0; thisParent_id<pitr->prodVtx()->nIncomingParticles();thisParent_id++) {
          parentPDG_tmp.push_back(pitr->prodVtx()->incomingParticle(thisParent_id)->pdgId());
        }
        vLeptonParentPDGIDs.push_back(std::move(parentPDG_tmp));
    } //loop over TruthParticles
 
 
  int nLeptons = vLeptonPDGIDs.size();
 
  //Filter automatically passes if number of leptons is different than expected
  if (!(  (nLeptons >= m_nLeptons_Min) && 
      (m_nLeptons_Max < 0 || nLeptons <= m_nLeptons_Max) )) {
    ATH_MSG_INFO("# Lep = "<<nLeptons << " Pass"  );
    return StatusCode::SUCCESS;
  }
 
  int nSFOS = 0;
  int nSFSS = 0;
  int nOFOS = 0;
  int nOFSS = 0;
 
  int id1 = 0;
  int id2 = 0;
  //loop over all possible pair combinations of the leptons
  //which were found.  
  for (unsigned int i = 0 ; i < vLeptonPDGIDs.size() ; i++){
    //don't double count 
    for (unsigned int j = i ; j < vLeptonPDGIDs.size() ; j++){
        //Do not compare the lepton with itself
        if(i==j) continue;
    id1 = vLeptonPDGIDs[i];
    id2 = vLeptonPDGIDs[j];
    //classify the pair and count it
    if(std::abs(id1)==std::abs(id2) && id1*id2 < 0) nSFOS+=1;
    else if(std::abs(id1)==std::abs(id2) && id1*id2 > 0) nSFSS+=1;
    else if(std::abs(id1)!=std::abs(id2) && id1*id2 < 0) nOFOS+=1;
    else if(std::abs(id1)!=std::abs(id2) && id1*id2 > 0) nOFSS+=1;
    else ATH_MSG_ERROR( "Couldn't classify lepton pair"  );
    }
  }
 
  //based on configuration
  //create sum of multiple pair combinations
  //which can alternatively be cut on instead
  //of the individual ones
  int nPairSum = 0;
  if(m_bUseSFOSInSum) nPairSum+=nSFOS;
  if(m_bUseSFSSInSum) nPairSum+=nSFSS;
  if(m_bUseOFOSInSum) nPairSum+=nOFOS;
  if(m_bUseOFSSInSum) nPairSum+=nOFSS;
 
 
  bool passSFOS = false;
  bool passSFSS = false;
  bool passOFOS = false;
  bool passOFSS = false;
  bool passPairSum = false;
  //Test if number of lepton pairs satisfies requirements
  //The maximum requirement is ignored if it is negative
  //No requirement is made if both min and max values are negative
  ATH_MSG_INFO("# Lep " << vLeptonPDGIDs.size() << ", "<< nSFOS << " SFOS, "<<nSFSS<< " SFSS, " << nOFOS << " OFOS, " << nOFSS << " OFSS pairs ," << nPairSum << "summed pairs"  );
 
  if(nSFOS >= m_nSFOS_Min && (m_nSFOS_Max<0 || nSFOS <= m_nSFOS_Max)) passSFOS=true;
  if(nSFSS >= m_nSFSS_Min && (m_nSFSS_Max<0 || nSFSS <= m_nSFSS_Max)) passSFSS=true;
  if(nOFOS >= m_nOFOS_Min && (m_nOFOS_Max<0 || nOFOS <= m_nOFOS_Max)) passOFOS=true;
  if(nOFSS >= m_nOFSS_Min && (m_nOFSS_Max<0 || nOFSS <= m_nOFSS_Max)) passOFSS=true;
  if(nPairSum >= m_nPairSum_Min && (m_nPairSum_Max<0 || nPairSum <= m_nPairSum_Max)) passPairSum=true;
 
  if(passSFOS && passSFSS && passOFOS && passOFSS && passPairSum){
    ATH_MSG_INFO("Pass"  );
    for (unsigned int i = 0;i<vLeptonPDGIDs.size();i++){
       int pdg = vLeptonPDGIDs[i];
       double pt = vLeptonPt[i];
       double eta = vLeptonEta[i];
       msg(MSG::DEBUG) << pdg << ": Pt = "<<pt<<", Eta = "<<eta << ", Parent PDG: ";
       for (unsigned int j=0;j<vLeptonParentPDGIDs[i].size();j++) msg(MSG::DEBUG) << vLeptonParentPDGIDs[i][j];
       msg(MSG::DEBUG) << endmsg;
    }
    return StatusCode::SUCCESS;
  }
 
  // if we get here we have failed
  setFilterPassed(false, ctx);
  ATH_MSG_INFO("Fail"  );
  return StatusCode::SUCCESS;
}

◆ filterFinalize()

virtual StatusCode GenFilter::filterFinalize ( )

inlinevirtualinherited

Reimplemented in BoostedHadTopAndTopPair, BSignalFilter, ChargedTracksWeightFilter, DecaysFinalStateFilter, DecayVolumeFilter, DiBjetFilter, DiLeptonMassFilter, FourLeptonInvMassFilter, HeavyFlavorHadronFilter, HTFilter, LeptonFilter, LeptonPairFilter, M4MuIntervalFilter, MuDstarFilter, MultiBjetFilter, MultiCjetFilter, MultiParticleFilter, ParentChildwStatusFilter, ParticleDecayFilter, QCDTruthJetFilter, QCDTruthMultiJetFilter, TauFilter, TrimuMassRangeFilter, TTbarPlusHeavyFlavorFilter, TTbarWithJpsimumuFilter, VBFHbbEtaSortingFilter, xAODBSignalFilter, xAODChargedTracksWeightFilter, xAODDiLeptonMassFilter, xAODHeavyFlavorHadronFilter, xAODHTFilter, xAODMultiBjetFilter, xAODMultiCjetFilter, xAODTauFilter, xAODTTbarWithJpsimumuFilter, xAODXtoVVDecayFilterExtended, and XtoVVDecayFilterExtended.

Definition at line 47 of file GenFilter.h.

47{ return StatusCode::SUCCESS; }

◆ filterInitialize()

StatusCode xAODLeptonPairFilter::filterInitialize ( )

finaloverridevirtual

Reimplemented from GenFilter.

Definition at line 29 of file xAODLeptonPairFilter.cxx.

                                                  {
//---------------------------------------------------------------------------
  CHECK(m_truthPartContKey.initialize());
  return StatusCode::SUCCESS;
}

◆ filterPassed()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Get filter decision:

Definition at line 93 of file AthCommonAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

◆ finalize()

StatusCode GenFilter::finalize ( )

inherited

Definition at line 50 of file GenFilter.cxx.

                               {
  ATH_MSG_INFO("Events passed = " << m_nPass << "  Events failed = " << m_nFail);
  CHECK(filterFinalize());
  return StatusCode::SUCCESS;
}

◆ GenFilter()

GenFilter::GenFilter	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 33 of file GenFilter.cxx.

  : GenBase(name, pSvcLocator)
{
  declareProperty("TotalPassed", m_nNeeded=-1);
  declareProperty("KeepAllEvents", m_keepAll=false);
  m_nPass = 0;
  m_nFail = 0;
}

◆ initialize()

StatusCode GenFilter::initialize ( )

virtualinherited

Reimplemented from GenBase.

Definition at line 18 of file GenFilter.cxx.

                                 {
  CHECK(GenBase::initialize());
  m_nPass = 0;
  m_nFail = 0;
  CHECK(filterInitialize());
  return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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.

◆ isClonable()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

inlineoverridevirtualinherited

Specify if the algorithm is clonable.

Only relevant for non-reentrant algorithms. Actual number of clones needs to be set via the "Cardinality" property.

Reimplemented in AFP_DigiTop, AlgB, AlgT, BCM_Digitization, CscDigitBuilder, CscDigitToCscRDO, G4AtlasAlg, G4RunAlg, HGTD_Digitization, HiveAlgBase, InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ISF::SimKernelMT, ITk::StripDigitization, ITkPixelCablingAlg, ITkStripCablingAlg, LArHitEMapMaker, LArTTL1Maker, LUCID_DigiTop, LVL1::L1TopoSimulation, MergeCalibHits, MergeGenericMuonSimHitColl, MergeHijingPars, MergeMcEventCollection, MergeTrackRecordCollection, MergeTruthJets, MergeTruthParticles, MuonDigitizer, PileUpMTAlg, PixelDigitization, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_Digitization, SCT_FlaggedConditionTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_PrepDataToxAOD, SCT_RawDataToxAOD, SCT_ReadCalibChipDataTestAlg, SCT_ReadCalibDataTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_SiliconConditionsTestAlg, SCT_StripVetoTestAlg, SCT_TdaqEnabledTestAlg, SCT_TestCablingAlg, SCTEventFlagWriter, SCTRawDataProvider, SCTSiLorentzAngleTestAlg, SCTSiPropertiesTestAlg, SGInputLoader, Simulation::BeamEffectsAlg, TileHitVecToCnt, TileMuonFitter, TilePulseForTileMuonReceiver, TileRawChannelMaker, TRTDigitization, and ZDC_DigiTop.

Definition at line 68 of file AthCommonAlgorithm.h.

                                           {
    return true;
  }

◆ isReEntrant()

virtual bool AthAlgorithm::isReEntrant ( ) const

inlinefinaloverrideprotectedvirtualinherited

Legacy algorithms are not thread-safe.

Definition at line 47 of file AthAlgorithm.h.

47{ return false; }

◆ keepAll()

bool GenFilter::keepAll ( ) const

inlineinherited

Definition at line 55 of file GenFilter.h.

55{return m_keepAll; }

◆ msg()

MsgStream & AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ nFailed()

int GenFilter::nFailed ( ) const

inlineinherited

Definition at line 53 of file GenFilter.h.

53{ return m_nFail; }

◆ nNeeded()

int GenFilter::nNeeded ( ) const

inlineinherited

Definition at line 54 of file GenFilter.h.

54{ return m_nNeeded; }

◆ nPassed()

int GenFilter::nPassed ( ) const

inlineinherited

Definition at line 52 of file GenFilter.h.

52{ return m_nPass; }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ setFilterPassed()

virtual void AthCommonAlgorithm< Gaudi::Algorithm >::setFilterPassed	(	bool	state,
		const EventContext &	ctx ) const

inlinevirtualinherited

Set filter decision:

Reimplemented in AthFilterAlgorithm.

Definition at line 99 of file AthCommonAlgorithm.h.

                                                                            {
    execState( ctx ).setFilterPassed( state );
  }

◆ sysExecute()

StatusCode AthCommonAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Reimplemented in AthAnalysisAlgorithm.

Definition at line 80 of file AthCommonAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

◆ sysInitialize()

StatusCode AthCommonAlgorithm< Gaudi::Algorithm >::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, HypoBase, InputMakerBase, and PyAthena::Alg.

Definition at line 60 of file AthCommonAlgorithm.cxx.

                                                      {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }      
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;  
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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_bUseOFOSInSum

Gaudi::Property<bool> xAODLeptonPairFilter::m_bUseOFOSInSum {this,"UseOFOSInSum",false,"OFOS to be considered in sum"}

private

Definition at line 65 of file xAODLeptonPairFilter.h.

65{this,"UseOFOSInSum",false,"OFOS to be considered in sum"};

◆ m_bUseOFSSInSum

Gaudi::Property<bool> xAODLeptonPairFilter::m_bUseOFSSInSum {this,"UseOFSSInSum",false,"OFSS to be considered in sum"}

private

Definition at line 66 of file xAODLeptonPairFilter.h.

66{this,"UseOFSSInSum",false,"OFSS to be considered in sum"};

◆ m_bUseSFOSInSum

Gaudi::Property<bool> xAODLeptonPairFilter::m_bUseSFOSInSum {this,"UseSFOSInSum",false,"SFOS to be considered in sum"}

private

Definition at line 63 of file xAODLeptonPairFilter.h.

63{this,"UseSFOSInSum",false,"SFOS to be considered in sum"};

◆ m_bUseSFSSInSum

Gaudi::Property<bool> xAODLeptonPairFilter::m_bUseSFSSInSum {this,"UseSFSSInSum",false,"SFSS to be considered in sum"}

private

Definition at line 64 of file xAODLeptonPairFilter.h.

64{this,"UseSFSSInSum",false,"SFSS to be considered in sum"};

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

◆ m_EtaRange

Gaudi::Property<double> xAODLeptonPairFilter::m_EtaRange {this,"Etacut",10.,"Eta range max"}

private

Definition at line 75 of file xAODLeptonPairFilter.h.

75{this,"Etacut",10.,"Eta range max"};

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthCommonAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 108 of file AthCommonAlgorithm.h.

◆ m_keepAll

bool GenFilter::m_keepAll

protectedinherited

Definition at line 66 of file GenFilter.h.

◆ m_mcEventKey

std::string GenBase::m_mcEventKey {}

protectedinherited

StoreGate key for the MC event collection (defaults to GEN_EVENT).

Definition at line 110 of file GenBase.h.

110{};

◆ m_mcevents_const

SG::ReadHandleKey<McEventCollection> GenBase::m_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }

privateinherited

Const handle to the MC event collection.

Definition at line 119 of file GenBase.h.

119{ this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" };

◆ m_mkMcEvent

BooleanProperty GenBase::m_mkMcEvent {this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"}

protectedinherited

Flag to determine if a new MC event collection should be made if it doesn't exist.

Definition at line 112 of file GenBase.h.

112{this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"};

◆ m_nFail

int GenFilter::m_nFail

protectedinherited

Definition at line 64 of file GenFilter.h.

◆ m_nLeptons_Max

Gaudi::Property<int> xAODLeptonPairFilter::m_nLeptons_Max {this,"NLeptons_Max",-1," max num leptons"}

private

Definition at line 81 of file xAODLeptonPairFilter.h.

81{this,"NLeptons_Max",-1," max num leptons"};

◆ m_nLeptons_Min

Gaudi::Property<int> xAODLeptonPairFilter::m_nLeptons_Min {this,"NLeptons_Min",0," min num leptons"}

private

Definition at line 82 of file xAODLeptonPairFilter.h.

82{this,"NLeptons_Min",0," min num leptons"};

◆ m_nNeeded

int GenFilter::m_nNeeded

protectedinherited

Definition at line 65 of file GenFilter.h.

◆ m_nOFOS_Max

Gaudi::Property<int> xAODLeptonPairFilter::m_nOFOS_Max {this,"NOFOS_Max",-1,"Number of Opposite Flavor Opposite Sign Max"}

private

Definition at line 49 of file xAODLeptonPairFilter.h.

49{this,"NOFOS_Max",-1,"Number of Opposite Flavor Opposite Sign Max"};

◆ m_nOFOS_Min

Gaudi::Property<int> xAODLeptonPairFilter::m_nOFOS_Min {this,"NOFOS_Min",-1,"Number of Opposite Flavor Opposite Sign Min"}

private

Definition at line 50 of file xAODLeptonPairFilter.h.

50{this,"NOFOS_Min",-1,"Number of Opposite Flavor Opposite Sign Min"};

◆ m_nOFSS_Max

Gaudi::Property<int> xAODLeptonPairFilter::m_nOFSS_Max {this,"NOFSS_Max",-1,"Number of Opposite Flavor Same Sign Max"}

private

Definition at line 53 of file xAODLeptonPairFilter.h.

53{this,"NOFSS_Max",-1,"Number of Opposite Flavor Same Sign Max"};

◆ m_nOFSS_Min

Gaudi::Property<int> xAODLeptonPairFilter::m_nOFSS_Min {this,"NOFSS_Min",-1,"Number of Opposite Flavor Same Sign Min"}

private

Definition at line 54 of file xAODLeptonPairFilter.h.

54{this,"NOFSS_Min",-1,"Number of Opposite Flavor Same Sign Min"};

◆ m_nPairSum_Max

Gaudi::Property<int> xAODLeptonPairFilter::m_nPairSum_Max {this,"NPairSum_Max",-1,"Number of Pair sum Max"}

private

Definition at line 58 of file xAODLeptonPairFilter.h.

58{this,"NPairSum_Max",-1,"Number of Pair sum Max"};

◆ m_nPairSum_Min

Gaudi::Property<int> xAODLeptonPairFilter::m_nPairSum_Min {this,"NPairSum_Min",-1,"Number of Pair sum Min"}

private

Definition at line 59 of file xAODLeptonPairFilter.h.

59{this,"NPairSum_Min",-1,"Number of Pair sum Min"};

◆ m_nPass

int GenFilter::m_nPass

protectedinherited

Definition at line 63 of file GenFilter.h.

◆ m_nSFOS_Max

Gaudi::Property<int> xAODLeptonPairFilter::m_nSFOS_Max {this,"NSFOS_Max",0,"Number of Same Flavor Opposite Sign Max"}

private

Definition at line 41 of file xAODLeptonPairFilter.h.

41{this,"NSFOS_Max",0,"Number of Same Flavor Opposite Sign Max"};

◆ m_nSFOS_Min

Gaudi::Property<int> xAODLeptonPairFilter::m_nSFOS_Min {this,"NSFOS_Min",0,"Number of Same Flavor Opposite Sign Min"}

private

Definition at line 42 of file xAODLeptonPairFilter.h.

42{this,"NSFOS_Min",0,"Number of Same Flavor Opposite Sign Min"};

◆ m_nSFSS_Max

Gaudi::Property<int> xAODLeptonPairFilter::m_nSFSS_Max {this,"NSFSS_Max",-1,"Number of Same Flavor Same Sign Max"}

private

Definition at line 45 of file xAODLeptonPairFilter.h.

45{this,"NSFSS_Max",-1,"Number of Same Flavor Same Sign Max"};

◆ m_nSFSS_Min

Gaudi::Property<int> xAODLeptonPairFilter::m_nSFSS_Min {this,"NSFSS_Min",-1,"Number of Same Flavor Same Sign Min"}

private

Definition at line 46 of file xAODLeptonPairFilter.h.

46{this,"NSFSS_Min",-1,"Number of Same Flavor Same Sign Min"};

◆ m_onlyMassiveParents

Gaudi::Property<bool> xAODLeptonPairFilter::m_onlyMassiveParents {this,"OnlyMassiveParents",false,"only count leptons with a parent with M>20 GeV"}

private

Definition at line 70 of file xAODLeptonPairFilter.h.

70{this,"OnlyMassiveParents",false,"only count leptons with a parent with M>20 GeV"};

◆ m_Ptmin

Gaudi::Property<double> xAODLeptonPairFilter::m_Ptmin {this,"Ptcut",10000.,"min Pt"}

private

Definition at line 74 of file xAODLeptonPairFilter.h.

74{this,"Ptcut",10000.,"min Pt"};

◆ m_truthPartContKey

SG::ReadHandleKey<xAOD::TruthParticleContainer> xAODLeptonPairFilter::m_truthPartContKey {this, "TruthParticleContainerKey", "TruthGen"}

private

Definition at line 34 of file xAODLeptonPairFilter.h.

34{this, "TruthParticleContainerKey", "TruthGen"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Properties

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Function Documentation

◆ ATLAS_NOT_CONST_THREAD_SAFE() [1/2]

◆ ATLAS_NOT_CONST_THREAD_SAFE() [2/2]

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ event_const()

◆ events_const()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterEvent()

◆ filterFinalize()

◆ filterInitialize()

◆ filterPassed()

◆ finalize()

◆ GenFilter()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ isReEntrant()

◆ keepAll()

◆ msg()

◆ msgLvl()

◆ nFailed()

◆ nNeeded()

◆ nPassed()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_bUseOFOSInSum

◆ m_bUseOFSSInSum

◆ m_bUseSFOSInSum

◆ m_bUseSFSSInSum

◆ m_detStore

◆ m_EtaRange

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_keepAll

◆ m_mcEventKey

◆ m_mcevents_const

◆ m_mkMcEvent

◆ m_nFail

◆ m_nLeptons_Max

◆ m_nLeptons_Min

◆ m_nNeeded

◆ m_nOFOS_Max

◆ m_nOFOS_Min

◆ m_nOFSS_Max

◆ m_nOFSS_Min

◆ m_nPairSum_Max

◆ m_nPairSum_Min

◆ m_nPass

◆ m_nSFOS_Max

◆ m_nSFOS_Min

◆ m_nSFSS_Max

◆ m_nSFSS_Min

◆ m_onlyMassiveParents

◆ m_Ptmin

◆ m_truthPartContKey

◆ m_varHandleArraysDeclared

◆ m_vhka