Algorithm creating xAOD::Muons from EF Muons (class TrigMuonEFInfo) More...

#include <TrigMuonEFInfoToMuonCnvAlg.h>

Inheritance diagram for xAODMaker::TrigMuonEFInfoToMuonCnvAlg:

Collaboration diagram for xAODMaker::TrigMuonEFInfoToMuonCnvAlg:

Public Member Functions
	TrigMuonEFInfoToMuonCnvAlg (const std::string &name, ISvcLocator *svcLoc)
	Regular algorithm constructor.
virtual StatusCode	initialize ()
	Function initialising the algorithm.
virtual StatusCode	finalize ()
	Function initialising the algorithm.
virtual StatusCode	execute ()
	Function executing the algorithm.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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

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
template<class CONT, class AUXCONT>
StatusCode	recordxAODContainers (const std::string &containerName, const std::string &auxContainerName, CONT &xaod, AUXCONT &aux)
	Utility function to record xAOD containers.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::string	m_aodContainerName
	The key of the input TrigMuonEFInfoContainer.
std::string	m_xaodMuonContainerName
	The key for the output xAOD::MuonContainer.
std::string	m_xaodCombTrkPartContainerName
	The key for the output xAOD::TrackParticleContainer for combined tracks.
std::string	m_xaodExtrapTrkPartContainerName
	The key for the output xAOD::TrackParticleContainer for extrapolated tracks.
ToolHandle< ITrigMuonEFInfoToMuonCnvTool >	m_converterTool
	Tool that actually does the conversion.
unsigned int	m_nMuonsCreated
	counters
unsigned int	m_nCombTrksCreated
unsigned int	m_nExtrapTrksCreated
unsigned int	m_nproc
DataObjIDColl	m_extendedExtraObjects
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

Algorithm creating xAOD::Muons from EF Muons (class TrigMuonEFInfo)

   This algorithm can be used to translate the EF Muons coming
   from an AOD, and create xAOD::Muon objects out of them
   for an output xAOD.

Author: Mark Owen marko.nosp@m.wen@.nosp@m.cern..nosp@m.ch

Definition at line 36 of file TrigMuonEFInfoToMuonCnvAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ TrigMuonEFInfoToMuonCnvAlg()

TrigMuonEFInfoToMuonCnvAlg::TrigMuonEFInfoToMuonCnvAlg	(	const std::string &	name,
		ISvcLocator *	svcLoc )

Regular algorithm constructor.

Definition at line 21 of file TrigMuonEFInfoToMuonCnvAlg.cxx.

                                                                                                  :
    AthAlgorithm( name, svcLoc ),
    m_converterTool("TrigMuonEFInfoMuonCnvTool/TrigMuonEFInfoMuonCnvTool"),
    m_nMuonsCreated(0),
    m_nCombTrksCreated(0),
    m_nExtrapTrksCreated(0),
    m_nproc(0)
{
    declareProperty( "AODContainerName", m_aodContainerName = "HLT_MuonEFInfo" ); // need to fix the name
    declareProperty( "xAODMuonContainerName", m_xaodMuonContainerName = "HLT_Muons" );
    declareProperty( "xAODCombinedTrackParticleContainerName", m_xaodCombTrkPartContainerName = "HLT_MuonCombinedTrackParticles" );
    declareProperty( "xAODExtrapolatedTrackParticleContainerName", m_xaodExtrapTrkPartContainerName = "HLT_MuonExtrapolatedTrackParticles" );
    declareProperty( "ConverterTool", m_converterTool );
}

Member Function Documentation

◆ declareGaudiProperty()

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

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

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

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode TrigMuonEFInfoToMuonCnvAlg::execute ( )

virtual

Function executing the algorithm.

Definition at line 61 of file TrigMuonEFInfoToMuonCnvAlg.cxx.

                                               {
    
    // Retrieve the AOD particles:
    const TrigMuonEFInfoContainer* aod = evtStore()->tryConstRetrieve<TrigMuonEFInfoContainer>(m_aodContainerName);
    if (!aod) {
        ATH_MSG_WARNING("No TrigMuonEFInfoContainer with key " << m_aodContainerName << " found. Do nothing.");
        return StatusCode::SUCCESS;
    }
    
    ATH_MSG_DEBUG( "Retrieved particles with key: " << m_aodContainerName );
    
    // Create the xAOD muon container and its auxiliary store:
    xAOD::MuonContainer* xaodMuon = new xAOD::MuonContainer();
    xAOD::MuonAuxContainer* auxMuon = new xAOD::MuonAuxContainer();
    ATH_CHECK(recordxAODContainers( m_xaodMuonContainerName, m_xaodMuonContainerName + "Aux.", *xaodMuon, *auxMuon));
    
    // Create the xAOD track particle containers and auxiliary stores:
    xAOD::TrackParticleContainer* xaodCombTrackParticles = new xAOD::TrackParticleContainer();
    xAOD::TrackParticleAuxContainer* auxCombTrack = new xAOD::TrackParticleAuxContainer();
    ATH_CHECK(recordxAODContainers( m_xaodCombTrkPartContainerName, m_xaodCombTrkPartContainerName + "Aux.", *xaodCombTrackParticles, *auxCombTrack));
    xAOD::TrackParticleContainer* xaodExtrapTrackParticles = new xAOD::TrackParticleContainer();
    xAOD::TrackParticleAuxContainer* auxExtrapTrack = new xAOD::TrackParticleAuxContainer();
    ATH_CHECK(recordxAODContainers( m_xaodExtrapTrkPartContainerName, m_xaodExtrapTrkPartContainerName + "Aux.", *xaodExtrapTrackParticles, *auxExtrapTrack));
 
    // call the converter tool which does the work
    StatusCode sc = m_converterTool->convertTrigMuonEFInfoContainer( *aod, *xaodMuon, xaodCombTrackParticles, xaodExtrapTrackParticles);
    if(sc.isFailure()) {
        ATH_MSG_ERROR("Converter tool failed");
        return sc;
    }
    // update our counters
    ++m_nproc;
    m_nMuonsCreated += xaodMuon->size();
    m_nCombTrksCreated += xaodCombTrackParticles->size();
    m_nExtrapTrksCreated += xaodExtrapTrackParticles->size();
 
    return StatusCode::SUCCESS;
 
}//execute

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< 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 & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 50 of file AthAlgorithm.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 Algorithm::extraOutputDeps();
}

◆ finalize()

StatusCode TrigMuonEFInfoToMuonCnvAlg::finalize ( )

virtual

Function initialising the algorithm.

Definition at line 50 of file TrigMuonEFInfoToMuonCnvAlg.cxx.

                                                {
  ATH_MSG_INFO("Statistics for conversion:");
  ATH_MSG_INFO("Successfully processed " << m_nproc << " events");
  if(m_nproc>0) {
    ATH_MSG_INFO("Created " << m_nMuonsCreated << " xAOD::Muons, average per event = " << ((double)m_nMuonsCreated)/((double)m_nproc));
    ATH_MSG_INFO("Created " << m_nCombTrksCreated << " combined xAOD::TrackParticles, average per event = " << ((double)m_nCombTrksCreated)/((double)m_nproc));
    ATH_MSG_INFO("Created " << m_nExtrapTrksCreated << " extrapolated xAOD::TrackParticles, average per event = " << ((double)m_nExtrapTrksCreated)/((double)m_nproc));
  }
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode TrigMuonEFInfoToMuonCnvAlg::initialize ( )

virtual

Function initialising the algorithm.

Definition at line 36 of file TrigMuonEFInfoToMuonCnvAlg.cxx.

                                                  {
 
  // print some settings
  ATH_MSG_INFO( "AODContainerName  = " << m_aodContainerName << ",  xAODMuonContainerName = " << m_xaodMuonContainerName );
  ATH_MSG_INFO( "xAODCombinedTrackParticleContainerName = " << m_xaodCombTrkPartContainerName << ", xAODExtrapolatedTrackParticleContainerName = " << m_xaodExtrapTrkPartContainerName);
  ATH_MSG_INFO( "ConverterTool = " << m_converterTool.typeAndName());
  
  // retrieve converter tool
  ATH_CHECK(m_converterTool.retrieve());
  
  // Return gracefully
  return StatusCode::SUCCESS;
}

◆ inputHandles()

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

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::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< 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.

◆ recordxAODContainers()

template<class CONT, class AUXCONT>

StatusCode xAODMaker::TrigMuonEFInfoToMuonCnvAlg::recordxAODContainers	(	const std::string &	containerName,
		const std::string &	auxContainerName,
		CONT &	xaod,
		AUXCONT &	aux )

private

Utility function to record xAOD containers.

◆ 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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::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< Algorithm > >.

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

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::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< 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< 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_aodContainerName

std::string xAODMaker::TrigMuonEFInfoToMuonCnvAlg::m_aodContainerName

private

The key of the input TrigMuonEFInfoContainer.

Definition at line 51 of file TrigMuonEFInfoToMuonCnvAlg.h.

◆ m_converterTool

ToolHandle<ITrigMuonEFInfoToMuonCnvTool> xAODMaker::TrigMuonEFInfoToMuonCnvAlg::m_converterTool

private

Tool that actually does the conversion.

Definition at line 60 of file TrigMuonEFInfoToMuonCnvAlg.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_nCombTrksCreated

unsigned int xAODMaker::TrigMuonEFInfoToMuonCnvAlg::m_nCombTrksCreated

private

Definition at line 64 of file TrigMuonEFInfoToMuonCnvAlg.h.

◆ m_nExtrapTrksCreated

unsigned int xAODMaker::TrigMuonEFInfoToMuonCnvAlg::m_nExtrapTrksCreated

private

Definition at line 65 of file TrigMuonEFInfoToMuonCnvAlg.h.

◆ m_nMuonsCreated

unsigned int xAODMaker::TrigMuonEFInfoToMuonCnvAlg::m_nMuonsCreated

private

counters

Definition at line 63 of file TrigMuonEFInfoToMuonCnvAlg.h.

◆ m_nproc

unsigned int xAODMaker::TrigMuonEFInfoToMuonCnvAlg::m_nproc

private

Definition at line 66 of file TrigMuonEFInfoToMuonCnvAlg.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ m_xaodCombTrkPartContainerName

std::string xAODMaker::TrigMuonEFInfoToMuonCnvAlg::m_xaodCombTrkPartContainerName

private

The key for the output xAOD::TrackParticleContainer for combined tracks.

Definition at line 55 of file TrigMuonEFInfoToMuonCnvAlg.h.

◆ m_xaodExtrapTrkPartContainerName

std::string xAODMaker::TrigMuonEFInfoToMuonCnvAlg::m_xaodExtrapTrkPartContainerName

private

The key for the output xAOD::TrackParticleContainer for extrapolated tracks.

Definition at line 57 of file TrigMuonEFInfoToMuonCnvAlg.h.

◆ m_xaodMuonContainerName

std::string xAODMaker::TrigMuonEFInfoToMuonCnvAlg::m_xaodMuonContainerName

private

The key for the output xAOD::MuonContainer.

Definition at line 53 of file TrigMuonEFInfoToMuonCnvAlg.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

◆ TrigMuonEFInfoToMuonCnvAlg()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ recordxAODContainers()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_aodContainerName

◆ m_converterTool

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_nCombTrksCreated

◆ m_nExtrapTrksCreated

◆ m_nMuonsCreated

◆ m_nproc

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_xaodCombTrkPartContainerName

◆ m_xaodExtrapTrkPartContainerName

◆ m_xaodMuonContainerName