CP::CalibratedMuonsProvider Class Reference

decorates a muon collection with efficiency and scale factor More...

#include <CalibratedMuonsProvider.h>

Inheritance diagram for CP::CalibratedMuonsProvider:

Collaboration diagram for CP::CalibratedMuonsProvider:

Public Member Functions
	CalibratedMuonsProvider (const std::string &name, ISvcLocator *svcLoc)
	Regular Algorithm constructor.
virtual StatusCode	initialize () override
	Function initialising the algorithm.
virtual StatusCode	execute () override
	Function executing the algorithm.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual StatusCode	execute (const EventContext &)
	Execute method with EventContext.
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
const EventContext &	getContext () const
	Deprecated methods (use the ones with EventContext).
bool	filterPassed () const
void	setFilterPassed (bool state) 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.

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::EventInfo >	m_eventInfo {this, "EventInfoContName", "EventInfo", "event info key"}
SG::ReadHandleKey< xAOD::MuonContainer >	m_inputKey {this, "Input", "Muons", " Name of the muon container to calibrate"}
	muon container
SG::WriteHandleKey< xAOD::MuonContainer >	m_outputKey
SG::WriteDecorHandleKeyArray< xAOD::MuonContainer >	m_ptDecorKeys {this, "DecorationKeys", {}}
	Additionally declare the two decorations made by MCAST.
ToolHandle< IMuonCalibrationAndSmearingTool >	m_tool {this, "Tool", ""}
	Muon calibration tool.
Gaudi::Property< bool >	m_useRndNumber {this, "useRndRunNumber", false}
SG::ReadDecorHandleKey< xAOD::EventInfo >	m_rndNumKey
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

decorates a muon collection with efficiency and scale factor

Definition at line 21 of file CalibratedMuonsProvider.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

CalibratedMuonsProvider()

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

Regular Algorithm constructor.

Definition at line 12 of file CalibratedMuonsProvider.cxx.

: AthAlgorithm(name, svcLoc) {}

Member Function Documentation

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.

{ return m_detStore; }

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.

{ return m_evtStore; }

execute() [1/2]

virtual StatusCode AthAlgorithm::execute ( const EventContext & )

inlinevirtualinherited

Execute method with EventContext.

Override this method if acccess to the EventContext is needed.

Definition at line 85 of file AthAlgorithm.h.

                                                    {
    return execute();
  }

execute() [2/2]

StatusCode CP::CalibratedMuonsProvider::execute ( void )

overridevirtual

Function executing the algorithm.

Reimplemented from AthAlgorithm.

Definition at line 27 of file CalibratedMuonsProvider.cxx.

                                                {
        const EventContext& ctx = Gaudi::Hive::currentContext();
        SG::ReadHandle<xAOD::MuonContainer> muons{m_inputKey, ctx};
        if (!muons.isValid()) {
            ATH_MSG_FATAL("No muon container found");
            return StatusCode::FAILURE;
        }
 
        xAOD::ShallowCopyResult_t<xAOD::MuonContainer> output =
            xAOD::shallowCopy(*muons, ctx);
 
        if (!output.first || !output.second) {
            ATH_MSG_FATAL("Creation of shallow copy failed");
            return StatusCode::FAILURE;
        }
 
        if (!setOriginalObjectLink(*muons, *output.first)) {
            ATH_MSG_ERROR("Failed to add original object links to shallow copy of " << m_inputKey);
            return StatusCode::FAILURE;
        }
        for (xAOD::Muon* iParticle : *(output.first)) {
            ATH_MSG_DEBUG(" Old pt=" << iParticle->pt());
            if (m_tool->applyCorrection(*iParticle).code() == CorrectionCode::Error) return StatusCode::FAILURE;
            ATH_MSG_DEBUG(" New pt=" << iParticle->pt());
        }
        SG::WriteHandle<xAOD::MuonContainer> writeHandle{m_outputKey, ctx};
        ATH_CHECK(writeHandle.recordNonConst(std::move(output.first), std::move(output.second)));
        // Return gracefully:
        return StatusCode::SUCCESS;
    }

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

filterPassed()

bool AthAlgorithm::filterPassed ( ) const

inherited

Definition at line 94 of file AthAlgorithm.cxx.

                                      {
  return execState( Gaudi::Hive::currentContext() ).filterPassed();
}

getContext()

const EventContext & AthAlgorithm::getContext ( ) const

inherited

Deprecated methods (use the ones with EventContext).

Definition at line 90 of file AthAlgorithm.cxx.

                                                   {
  return Gaudi::Hive::currentContext();
}

initialize()

StatusCode CP::CalibratedMuonsProvider::initialize ( )

overridevirtual

Function initialising the algorithm.

Definition at line 14 of file CalibratedMuonsProvider.cxx.

                                                   {
        ATH_CHECK(m_eventInfo.initialize());
        ATH_CHECK(m_inputKey.initialize());
        ATH_CHECK(m_outputKey.initialize());
        m_ptDecorKeys.emplace_back(m_outputKey.key() + ".InnerDetectorPt");
        m_ptDecorKeys.emplace_back(m_outputKey.key() + ".MuonSpectrometerPt");
        ATH_CHECK(m_ptDecorKeys.initialize());
        ATH_CHECK(m_rndNumKey.initialize(m_useRndNumber));
        ATH_CHECK(m_tool.retrieve());
        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.

isReEntrant()

virtual bool AthAlgorithm::isReEntrant ( ) const

inlinefinaloverrideprotectedvirtualinherited

Legacy algorithms are not thread-safe.

Definition at line 118 of file AthAlgorithm.h.

{ return false; }

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

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

void AthAlgorithm::setFilterPassed ( bool state ) const

inherited

Definition at line 98 of file AthAlgorithm.cxx.

                                                     {
  execState( Gaudi::Hive::currentContext() ).setFilterPassed(state);
}

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< Gaudi::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< 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_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_eventInfo

SG::ReadHandleKey<xAOD::EventInfo> CP::CalibratedMuonsProvider::m_eventInfo {this, "EventInfoContName", "EventInfo", "event info key"}

private

Definition at line 32 of file CalibratedMuonsProvider.h.

{this, "EventInfoContName", "EventInfo", "event info key"};

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 AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 121 of file AthAlgorithm.h.

m_inputKey

SG::ReadHandleKey<xAOD::MuonContainer> CP::CalibratedMuonsProvider::m_inputKey {this, "Input", "Muons", " Name of the muon container to calibrate"}

private

muon container

Definition at line 34 of file CalibratedMuonsProvider.h.

{this, "Input", "Muons", " Name of the muon container to calibrate"};

m_outputKey

SG::WriteHandleKey<xAOD::MuonContainer> CP::CalibratedMuonsProvider::m_outputKey

private

Initial value:

{this, "Output", "CalibratedMuons",
                                                            "Name of the final container written to storegate"}

Definition at line 35 of file CalibratedMuonsProvider.h.

                                                       {this, "Output", "CalibratedMuons",
                                                            "Name of the final container written to storegate"};

m_ptDecorKeys

SG::WriteDecorHandleKeyArray<xAOD::MuonContainer> CP::CalibratedMuonsProvider::m_ptDecorKeys {this, "DecorationKeys", {}}

private

Additionally declare the two decorations made by MCAST.

Definition at line 38 of file CalibratedMuonsProvider.h.

{this, "DecorationKeys", {}};

m_rndNumKey

SG::ReadDecorHandleKey<xAOD::EventInfo> CP::CalibratedMuonsProvider::m_rndNumKey

private

Initial value:

{this, "RandomNumberDecor", m_eventInfo, "RandomRunNumber",
                                                            "Dependency on the random run number"}

Definition at line 43 of file CalibratedMuonsProvider.h.

                                                       {this, "RandomNumberDecor", m_eventInfo, "RandomRunNumber",
                                                            "Dependency on the random run number"};

m_tool

ToolHandle<IMuonCalibrationAndSmearingTool> CP::CalibratedMuonsProvider::m_tool {this, "Tool", ""}

private

Muon calibration tool.

Definition at line 41 of file CalibratedMuonsProvider.h.

{this, "Tool", ""};

m_useRndNumber

Gaudi::Property<bool> CP::CalibratedMuonsProvider::m_useRndNumber {this, "useRndRunNumber", false}

private

Definition at line 42 of file CalibratedMuonsProvider.h.

{this, "useRndRunNumber", false};

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:

• CalibratedMuonsProvider.h
• CalibratedMuonsProvider.cxx