Muon::TruthTrackRecordsAlg Class Reference

#include <TruthTrackRecordsAlg.h>

Inheritance diagram for Muon::TruthTrackRecordsAlg:

Collaboration diagram for Muon::TruthTrackRecordsAlg:

Classes
struct	SummaryDecors

Public Member Functions
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &ctx) const override
virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...
virtual bool	isClonable () const override
	Specify if the algorithm is clonable. More...
virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm. More...
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...
virtual bool	filterPassed (const EventContext &ctx) const
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
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. More...

Private Types
using	WriteDecorArray_f = DecorHandlePtrVec_t< xAOD::TruthParticleContainer, float >
	Struct object encapsulating all write-decorators. More...
using	WriteDecorArray_b = DecorHandlePtrVec_t< xAOD::TruthParticleContainer, char >
using	WriteDecorArray_fvec = DecorHandlePtrVec_t< xAOD::TruthParticleContainer, std::vector< float > >
using	DecorKey_t = SG::WriteDecorHandleKeyArray< xAOD::TruthParticleContainer >
	Declaration of the key arrays, which are all initialized as empty (they will be filled up by @fillWriteDecorator). More...
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	addTrackRecords (const EventContext &ctx, const xAOD::TruthParticle &truthParticle, SummaryDecors &myDecors) const
	addTrackRecords is the actual function that decorates muons with track records. More...
template<typename T >
StatusCode	fillWriteDecorator (SG::WriteDecorHandleKeyArray< xAOD::TruthParticleContainer, T > &writeKey, const std::string &keyName) const
	This function fills the arrays of write-decorator keys and initializes them. More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_muonTruth {this, "muonTruth", "MuonTruthParticles"}
	Key of the container of truth muons that will be decorated. More...
SG::ReadHandleKeyArray< TrackRecordCollection >	m_trackRecords
	Keys of the containers of track records in different detector positions. More...
DecorKey_t	m_muonSnapShotX {this, "SnapShotX", { }, "Position decoration..."}
DecorKey_t	m_muonSnapShotY {this, "SnapShotY", { }, "Position decoration..."}
DecorKey_t	m_muonSnapShotZ {this, "SnapShotZ", { }, "Position decoration..."}
DecorKey_t	m_muonSnapShotPx {this, "SnapShotPx", { }, "Momentum decoration..."}
DecorKey_t	m_muonSnapShotPy {this, "SnapShotPy", { }, "Momentum decoration..."}
DecorKey_t	m_muonSnapShotPz {this, "SnapShotPz", { }, "Momentum decoration..."}
DecorKey_t	m_muonSnapShotMtc {this, "SnapShotMtc", { }, "is matched decoration..."}
DecorKey_t	m_muonSnapShotEX {this, "SnapShotEX", { }, "Position decoration..."}
DecorKey_t	m_muonSnapShotEY {this, "SnapShotEY", { }, "Position decoration..."}
DecorKey_t	m_muonSnapShotEZ {this, "SnapShotEZ", { }, "Position decoration..."}
DecorKey_t	m_muonSnapShotEPx {this, "SnapShotEPx", { }, "Momentum decoration..."}
DecorKey_t	m_muonSnapShotEPy {this, "SnapShotEPy", { }, "Momentum decoration..."}
DecorKey_t	m_muonSnapShotEPz {this, "SnapShotEPz", { }, "Momentum decoration..."}
DecorKey_t	m_muonSnapShotEcov {this, "SnapShotEcov", { }, "Covariance decoration"}
DecorKey_t	m_muonSnapShotEis {this, "SnapShotEis", { }, "Flag decoration whether the extrapolation worked"}
ToolHandle< Trk::IExtrapolator >	m_extrapolator {this, "Extrapolator", "Trk::Extrapolator/AtlasExtrapolator"}
	Extrapolation tool handle. More...
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks. More...
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 26 of file TruthTrackRecordsAlg.h.

Member Typedef Documentation

DecorKey_t

using Muon::TruthTrackRecordsAlg::DecorKey_t = SG::WriteDecorHandleKeyArray<xAOD::TruthParticleContainer>

private

Declaration of the key arrays, which are all initialized as empty (they will be filled up by @fillWriteDecorator).

Each decorKeyArray, which is an array of keys, represents a property, and its elements represents that property evaluated at different detector positions. List of properties: x,y,x,px,py,pz are position and momentum in a given layer; matchedDecor is a flag saying if a record has been recorded in that layer; ex,ey,ez,epx,epy,epz are extrapolated position and momentum; ecov is a vector encapsulating the covariance matrix from extrapolation; eis is a flag representing if the extrapolation has been successful.

Definition at line 106 of file TruthTrackRecordsAlg.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

WriteDecorArray_b

using Muon::TruthTrackRecordsAlg::WriteDecorArray_b = DecorHandlePtrVec_t<xAOD::TruthParticleContainer, char>

private

Definition at line 46 of file TruthTrackRecordsAlg.h.

WriteDecorArray_f

using Muon::TruthTrackRecordsAlg::WriteDecorArray_f = DecorHandlePtrVec_t<xAOD::TruthParticleContainer, float>

private

Struct object encapsulating all write-decorators.

Each decorArray represents a property, and its elements represents that property evaluated at different detector positions. List of properties: x,y,x,px,py,pz are position and momentum in a given layer; matchedDecor is a flag saying if a record has been recorded in that layer; ex,ey,ez,epx,epy,epz are extrapolated position and momentum; ecov is a vector encapsulating the covariance matrix from extrapolation; eis is a flag representing if the extrapolation has been successful. We can decouple declaration and population of this object because vectors can be initialized empty.

Definition at line 45 of file TruthTrackRecordsAlg.h.

WriteDecorArray_fvec

using Muon::TruthTrackRecordsAlg::WriteDecorArray_fvec = DecorHandlePtrVec_t<xAOD::TruthParticleContainer, std::vector<float> >

private

Definition at line 47 of file TruthTrackRecordsAlg.h.

Member Function Documentation

addTrackRecords()

StatusCode Muon::TruthTrackRecordsAlg::addTrackRecords ( const EventContext &  ctx, const xAOD::TruthParticle &  truthParticle, SummaryDecors &  myDecors  ) const

private

addTrackRecords is the actual function that decorates muons with track records.

Firstly, if production vertex is available, we save position and momentum at production. Then we loop over snapshot positions (e.g. calo entry level) and, in each position, we loop over track records. If the record is descendand of the muon, we save position and momentum in that position, as well as the tracking volume and record name (= snapshot position). Then, by means of another loop over all records of a truth muon, we extrapolate each record to the next shapshot position. Specifically, we save the extrapolated position and momentum, the extrapolation's covariance matrix, and a flag representing the extrapolation outcome.

Parameters

ctx	tells in which event we are
truthParticle	a pointer to the truth muon
myDecors	reference to the decorator summary object

loop over collection and find trackRecord with the same bar code. If we find a record, we save position and momentum

Make sure that the parameter vector has the same size

Save record name

Save tracking volume

Second loop, extrapolate between the points

If the track record is named, then we should have a volume

Definition at line 105 of file TruthTrackRecordsAlg.cxx.

                                                                                                                                                   {          
 
        // first loop over track records, store parameters at the different positions
        const xAOD::TruthVertex* vertex = truthParticle.prodVtx();
        const Trk::TrackingGeometry* trackingGeometry = m_extrapolator->trackingGeometry();
 
        std::vector<RecordPars> parameters;
        if (vertex) {
            parameters.emplace_back(Amg::Vector3D{vertex->x(), vertex->y(), vertex->z()},
                                    Amg::Vector3D{truthParticle.px(), truthParticle.py(), truthParticle.pz()});
        }
        else {parameters.emplace_back();}
 
        size_t idx{0};
        for (SG::ReadHandle<TrackRecordCollection>& trackRecordCollection : m_trackRecords.makeHandles(ctx)) {
            ATH_CHECK(trackRecordCollection.isPresent());
    
            const std::string r_name = trackRecordCollection.key();
            float& x = (*myDecors.xDecor[idx])(truthParticle);
            float& y = (*myDecors.yDecor[idx])(truthParticle);
            float& z = (*myDecors.zDecor[idx])(truthParticle);
            float& px = (*myDecors.pxDecor[idx])(truthParticle);
            float& py = (*myDecors.pyDecor[idx])(truthParticle);
            float& pz = (*myDecors.pzDecor[idx])(truthParticle);
 
            char& found_truth = (*myDecors.matchedDecor[idx])(truthParticle);
 
            x = y = z = px = py = pz = dummy_val;
            found_truth = false;
 
            // Need to always make these, to avoid crashes later
            float& ex = (*myDecors.exDecor[idx])(truthParticle);
            float& ey = (*myDecors.eyDecor[idx])(truthParticle);
            float& ez = (*myDecors.ezDecor[idx])(truthParticle);
            float& epx = (*myDecors.epxDecor[idx])(truthParticle);
            float& epy = (*myDecors.epyDecor[idx])(truthParticle);
            float& epz = (*myDecors.epzDecor[idx])(truthParticle);
 
            ex = ey = ez = epx = epy = epz = dummy_val;
 
            for (const TrackRecord& trackRecord : *trackRecordCollection) {
                if (!HepMC::is_sim_descendant(&trackRecord,&truthParticle)) continue;
                CLHEP::Hep3Vector pos = trackRecord.GetPosition();
                CLHEP::Hep3Vector mom = trackRecord.GetMomentum();
                ATH_MSG_VERBOSE("Found associated  " << r_name << " pt " << mom.perp() << " position: r " << pos.perp() << " z " << pos.z());
                x = pos.x(); y = pos.y(); z = pos.z();
                px = mom.x(); py = mom.y(); pz = mom.z();
                parameters.emplace_back(pos, mom);
                found_truth = true;
                break;
            }
 
            if (!found_truth) {parameters.emplace_back();}
            RecordPars& r_pars = parameters.back();
            r_pars.record_name = r_name;
            r_pars.idx = idx++;
 
            if (!found_truth) continue;
            const Trk::TrackingVolume* volume = nullptr;
            if (r_name == "CaloEntryLayer")
                volume = trackingGeometry->trackingVolume("InDet::Containers::InnerDetector");
            else if (r_name == "MuonEntryLayer")
                volume = trackingGeometry->trackingVolume("Calo::Container");
            else if (r_name == "MuonExitLayer")
                volume = trackingGeometry->trackingVolume("Muon::Containers::MuonSystem");
            else {
                ATH_MSG_WARNING("no destination surface for track record "<<r_name);
            }
            r_pars.volume = volume;
        }
 
        AmgSymMatrix(5) cov{AmgSymMatrix(5)::Identity()};
        cov(0, 0) = cov(1, 1) = 1e-3;
        cov(2, 2) = cov(3, 3) = 1e-6;
        cov(4, 4) = 1e-3 / truthParticle.p4().P();
        for (unsigned int i = 0; i < parameters.size() - 1; ++i) {
            const RecordPars& start_pars = parameters[i];
            const RecordPars& end_pars = parameters[i+1];
            if ( (!start_pars.record_name.empty() && !start_pars.volume) || !end_pars.volume) continue;
            Trk::CurvilinearParameters pars(start_pars.pos, start_pars.mom, truthParticle.charge(), cov);
 
            const Trk::TrackingVolume* volume = end_pars.volume;
            const std::string& r_name = end_pars.record_name;    
 
            float& ex = (*myDecors.exDecor[end_pars.idx])(truthParticle);
            float& ey = (*myDecors.eyDecor[end_pars.idx])(truthParticle);
            float& ez = (*myDecors.ezDecor[end_pars.idx])(truthParticle);
            float& epx = (*myDecors.epxDecor[end_pars.idx])(truthParticle);  
            float& epy = (*myDecors.epyDecor[end_pars.idx])(truthParticle);
            float& epz = (*myDecors.epzDecor[end_pars.idx])(truthParticle);
            
            std::vector<float>& covMat = (*myDecors.ecovDecor[end_pars.idx])(truthParticle);
 
            std::unique_ptr<Trk::TrackParameters> exPars{
                m_extrapolator->extrapolateToVolume(ctx, pars, *volume, Trk::alongMomentum, Trk::muon)};
            if (! exPars || !exPars->covariance() || !Amg::hasPositiveDiagElems(*exPars->covariance())) {
                ATH_MSG_VERBOSE("Extrapolation to "<<r_name<<" failed. ");
                continue;
            }
            (*myDecors.eisDecor[end_pars.idx])(truthParticle) = true;
            ex = exPars->position().x();
            ey = exPars->position().y();
            ez = exPars->position().z();
            epx = exPars->momentum().x();
            epy = exPars->momentum().y();
            epz = exPars->momentum().z();
            Amg::compress(*exPars->covariance(), covMat);
 
            const double errorp = Amg::error(*exPars->covariance(), Trk::qOverP);
            ATH_MSG_VERBOSE( " Extrapolated to " << r_name << std::endl
                << " truth: r " << end_pars.pos.perp() << " z "
                << end_pars.pos.z() << " p "
                << end_pars.mom.mag() << std::endl
                << " extrp: r " << exPars->position().perp() << " z "
                << exPars->position().z() << " p "
                << exPars->momentum().mag() << " res p "
                << (end_pars.mom.mag() -
                    exPars->momentum().mag())
                << " error " << errorp << " cov "
                << (*exPars->covariance())(Trk::qOverP, Trk::qOverP)
                << " pull p "
                << (end_pars.mom.mag() -
                    exPars->momentum().mag()) /
                     errorp);
        }
        return StatusCode::SUCCESS;
    }

cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

{
  return 0;
}

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleKeyArrayType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty ( Gaudi::Property< T > &  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());
 
  }

declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
  }

declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty ( Gaudi::Property< T > &  t, const SG::NotHandleType &    )

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T > &  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() [1/2]

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

evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode Muon::TruthTrackRecordsAlg::execute ( const EventContext &  ctx ) const

overridevirtual

Definition at line 76 of file TruthTrackRecordsAlg.cxx.

                                                                          {
        // skip if no input data found
        SG::ReadHandle muonTruthContainer(m_muonTruth, ctx);
        ATH_CHECK(muonTruthContainer.isPresent());
 
        SummaryDecors myDecors;
        myDecors.xDecor  = makeHandles<float>(ctx, m_muonSnapShotX);
        myDecors.yDecor  = makeHandles<float>(ctx, m_muonSnapShotY);
        myDecors.zDecor  = makeHandles<float>(ctx, m_muonSnapShotZ);
        myDecors.pxDecor = makeHandles<float>(ctx, m_muonSnapShotPx);
        myDecors.pyDecor = makeHandles<float>(ctx, m_muonSnapShotPy);
        myDecors.pzDecor = makeHandles<float>(ctx, m_muonSnapShotPz);
        myDecors.matchedDecor = makeHandles<char>(ctx, m_muonSnapShotMtc);
        myDecors.exDecor = makeHandles<float>(ctx, m_muonSnapShotEX);
        myDecors.eyDecor = makeHandles<float>(ctx, m_muonSnapShotEY);
        myDecors.ezDecor = makeHandles<float>(ctx, m_muonSnapShotEZ);
        myDecors.epxDecor = makeHandles<float>(ctx, m_muonSnapShotEPx);
        myDecors.epyDecor = makeHandles<float>(ctx, m_muonSnapShotEPy);
        myDecors.epzDecor = makeHandles<float>(ctx, m_muonSnapShotEPz);
        myDecors.ecovDecor = makeHandles<std::vector<float>>(ctx, m_muonSnapShotEcov);
        myDecors.eisDecor = makeHandles<char>(ctx, m_muonSnapShotEis);
 
        // loop over truth coll
        for (const xAOD::TruthParticle* truthParticle : *muonTruthContainer) {
            ATH_CHECK(addTrackRecords(ctx, *truthParticle, myDecors));
        }
        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 & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 94 of file AthCommonReentrantAlgorithm.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();
}

fillWriteDecorator()

template<typename T >

StatusCode Muon::TruthTrackRecordsAlg::fillWriteDecorator ( SG::WriteDecorHandleKeyArray< xAOD::TruthParticleContainer, T > &  writeKey, const std::string &  keyName  ) const

private

This function fills the arrays of write-decorator keys and initializes them.

Specifically, the key that will be written at i-th position is <property_name>_<detector_position(i)>, where property_name = writeKey, and detector_position(i) is retrieved from (= is an element of) m_trackRecords

Parameters

writeKey	reference to the (empty) array of write-decor keys that is going to be populated
keyName	reference to the property name (e.g. x, x_extr, ...)

Definition at line 41 of file TruthTrackRecordsAlg.cxx.

                                                                                            {
        for (const SG::ReadHandleKey<TrackRecordCollection>& recordKey : m_trackRecords){
            const std::string fullKey = recordKey.key() + "_" + keyName; 
            writeKey.emplace_back(m_muonTruth, fullKey);
        }
        return writeKey.initialize();
    }

filterPassed()

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

inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

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

initialize()

StatusCode Muon::TruthTrackRecordsAlg::initialize ( )

overridevirtual

Definition at line 51 of file TruthTrackRecordsAlg.cxx.

                                                {
        ATH_CHECK(m_muonTruth.initialize());
        ATH_CHECK(m_trackRecords.initialize());
 
        ATH_CHECK(fillWriteDecorator(m_muonSnapShotX, "x"));
        ATH_CHECK(fillWriteDecorator(m_muonSnapShotY, "y"));
        ATH_CHECK(fillWriteDecorator(m_muonSnapShotZ, "z"));
        ATH_CHECK(fillWriteDecorator(m_muonSnapShotPx, "px"));
        ATH_CHECK(fillWriteDecorator(m_muonSnapShotPy, "py"));
        ATH_CHECK(fillWriteDecorator(m_muonSnapShotPz, "pz"));
        ATH_CHECK(fillWriteDecorator(m_muonSnapShotMtc, "is_matched"));
        ATH_CHECK(fillWriteDecorator(m_muonSnapShotEX, "x_extr"));
        ATH_CHECK(fillWriteDecorator(m_muonSnapShotEY, "y_extr"));
        ATH_CHECK(fillWriteDecorator(m_muonSnapShotEZ, "z_extr"));
        ATH_CHECK(fillWriteDecorator(m_muonSnapShotEPx, "px_extr"));
        ATH_CHECK(fillWriteDecorator(m_muonSnapShotEPy, "py_extr"));
        ATH_CHECK(fillWriteDecorator(m_muonSnapShotEPz, "pz_extr"));
        ATH_CHECK(fillWriteDecorator(m_muonSnapShotEcov, "cov_extr"));
        ATH_CHECK(fillWriteDecorator(m_muonSnapShotEis, "is_extr"));
 
        ATH_CHECK(m_extrapolator.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.

isClonable()

bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

{
  // Reentrant algorithms are clonable.
  return true;
}

msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

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

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

inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

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

sysExecute()

StatusCode AthCommonReentrantAlgorithm< 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.

Definition at line 85 of file AthCommonReentrantAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

sysInitialize()

StatusCode AthCommonReentrantAlgorithm< 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 InputMakerBase, and HypoBase.

Definition at line 61 of file AthCommonReentrantAlgorithm.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_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_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 AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

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

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.h.

m_extrapolator

ToolHandle<Trk::IExtrapolator> Muon::TruthTrackRecordsAlg::m_extrapolator {this, "Extrapolator", "Trk::Extrapolator/AtlasExtrapolator"}

private

Extrapolation tool handle.

Definition at line 124 of file TruthTrackRecordsAlg.h.

m_muonSnapShotEcov

DecorKey_t Muon::TruthTrackRecordsAlg::m_muonSnapShotEcov {this, "SnapShotEcov", { }, "Covariance decoration"}

private

Definition at line 120 of file TruthTrackRecordsAlg.h.

m_muonSnapShotEis

DecorKey_t Muon::TruthTrackRecordsAlg::m_muonSnapShotEis {this, "SnapShotEis", { }, "Flag decoration whether the extrapolation worked"}

private

Definition at line 121 of file TruthTrackRecordsAlg.h.

m_muonSnapShotEPx

DecorKey_t Muon::TruthTrackRecordsAlg::m_muonSnapShotEPx {this, "SnapShotEPx", { }, "Momentum decoration..."}

private

Definition at line 117 of file TruthTrackRecordsAlg.h.

m_muonSnapShotEPy

DecorKey_t Muon::TruthTrackRecordsAlg::m_muonSnapShotEPy {this, "SnapShotEPy", { }, "Momentum decoration..."}

private

Definition at line 118 of file TruthTrackRecordsAlg.h.

m_muonSnapShotEPz

DecorKey_t Muon::TruthTrackRecordsAlg::m_muonSnapShotEPz {this, "SnapShotEPz", { }, "Momentum decoration..."}

private

Definition at line 119 of file TruthTrackRecordsAlg.h.

m_muonSnapShotEX

DecorKey_t Muon::TruthTrackRecordsAlg::m_muonSnapShotEX {this, "SnapShotEX", { }, "Position decoration..."}

private

Definition at line 114 of file TruthTrackRecordsAlg.h.

m_muonSnapShotEY

DecorKey_t Muon::TruthTrackRecordsAlg::m_muonSnapShotEY {this, "SnapShotEY", { }, "Position decoration..."}

private

Definition at line 115 of file TruthTrackRecordsAlg.h.

m_muonSnapShotEZ

DecorKey_t Muon::TruthTrackRecordsAlg::m_muonSnapShotEZ {this, "SnapShotEZ", { }, "Position decoration..."}

private

Definition at line 116 of file TruthTrackRecordsAlg.h.

m_muonSnapShotMtc

DecorKey_t Muon::TruthTrackRecordsAlg::m_muonSnapShotMtc {this, "SnapShotMtc", { }, "is matched decoration..."}

private

Definition at line 113 of file TruthTrackRecordsAlg.h.

m_muonSnapShotPx

DecorKey_t Muon::TruthTrackRecordsAlg::m_muonSnapShotPx {this, "SnapShotPx", { }, "Momentum decoration..."}

private

Definition at line 110 of file TruthTrackRecordsAlg.h.

m_muonSnapShotPy

DecorKey_t Muon::TruthTrackRecordsAlg::m_muonSnapShotPy {this, "SnapShotPy", { }, "Momentum decoration..."}

private

Definition at line 111 of file TruthTrackRecordsAlg.h.

m_muonSnapShotPz

DecorKey_t Muon::TruthTrackRecordsAlg::m_muonSnapShotPz {this, "SnapShotPz", { }, "Momentum decoration..."}

private

Definition at line 112 of file TruthTrackRecordsAlg.h.

m_muonSnapShotX

DecorKey_t Muon::TruthTrackRecordsAlg::m_muonSnapShotX {this, "SnapShotX", { }, "Position decoration..."}

private

Definition at line 107 of file TruthTrackRecordsAlg.h.

m_muonSnapShotY

DecorKey_t Muon::TruthTrackRecordsAlg::m_muonSnapShotY {this, "SnapShotY", { }, "Position decoration..."}

private

Definition at line 108 of file TruthTrackRecordsAlg.h.

m_muonSnapShotZ

DecorKey_t Muon::TruthTrackRecordsAlg::m_muonSnapShotZ {this, "SnapShotZ", { }, "Position decoration..."}

private

Definition at line 109 of file TruthTrackRecordsAlg.h.

m_muonTruth

SG::ReadHandleKey<xAOD::TruthParticleContainer> Muon::TruthTrackRecordsAlg::m_muonTruth {this, "muonTruth", "MuonTruthParticles"}

private

Key of the container of truth muons that will be decorated.

Definition at line 92 of file TruthTrackRecordsAlg.h.

m_trackRecords

SG::ReadHandleKeyArray<TrackRecordCollection> Muon::TruthTrackRecordsAlg::m_trackRecords

private

Initial value:

{
            this, "TrackRecordCollectionNames", {"CaloEntryLayer", "MuonEntryLayer", "MuonExitLayer"}}

Keys of the containers of track records in different detector positions.

Definition at line 96 of file TruthTrackRecordsAlg.h.

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:

• TruthTrackRecordsAlg.h
• TruthTrackRecordsAlg.cxx