InDetPhysValTruthDecoratorAlg Class Reference

#include <InDetPhysValTruthDecoratorAlg.h>

Inheritance diagram for InDetPhysValTruthDecoratorAlg:

Public Member Functions
	InDetPhysValTruthDecoratorAlg (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~InDetPhysValTruthDecoratorAlg ()
virtual StatusCode	initialize ()
virtual StatusCode	finalize ()
virtual StatusCode	execute (const EventContext &ctx) const
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

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
enum	{ kPixel , kSCT , kNClusterTypes }
enum	EDecorations {   kDecorD0 , kDecorZ0 , kDecorPhi , kDecorTheta ,   kDecorZ0st , kDecorQOverP , kDecorProdR , kDecorProdZ ,   kDecorNSilHits , kDecorTime , kNDecorators }
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
bool	decorateTruth (const xAOD::TruthParticle &particle, std::vector< std::pair< SG::WriteDecorHandle< xAOD::TruthParticleContainer, float >, bool > > &float_decor, const Amg::Vector3D &perigeePos, const std::vector< std::array< uint16_t, kNClusterTypes > > &counts) const
const xAOD::TruthEvent *	getTruthHSEvent () const
bool	decorateTruthTime (std::vector< std::pair< SG::WriteDecorHandle< xAOD::TruthParticleContainer, float >, bool > > &float_decor) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
PublicToolHandle< Trk::IExtrapolator >	m_extrapolator {this,"Extrapolator","Trk::Extrapolator/AtlasExtrapolator",""}
SG::ReadDecorHandleKeyArray< xAOD::EventInfo >	m_beamSpotDecoKey
std::atomic< std::size_t >	m_nMissingTruthParticles = 0u
std::atomic< bool >	m_errorEmitted {false}
SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_truthParticleName {this, "TruthParticleContainerName", "TruthParticles", ""}
	TruthParticle container's name needed to create decorators.
Gaudi::Property< std::string >	m_prefix {this, "Prefix", "", "Decoration prefix to avoid clashes."}
Gaudi::Property< bool >	m_decoTime {this, "decorateTime", false}
SG::ReadHandleKey< xAOD::TrackMeasurementValidationContainer >	m_truthPixelClusterName {this, "PixelClusterContainerName", "PixelClusters", ""}
	TruthPixelClusterContainer and TruthSCTClusterContainer needed for truth silicon hit cut.
SG::ReadHandleKey< xAOD::TrackMeasurementValidationContainer >	m_truthSCTClusterName {this, "SCTClusterContainerName", "SCT_Clusters", ""}
SG::ReadDecorHandleKey< xAOD::TruthParticleContainer >	m_truthParticleIndexDecor {this, "TruthParticleIndexDecoration", m_truthParticleName, "origTruthIndex", "decoration name for the original truth particle index."}
SG::ReadHandleKey< xAOD::TruthEventContainer >	m_truthEventName {this, "TruthEventContainerName", "TruthEvents", ""}
SG::ReadHandleKey< xAOD::TruthPileupEventContainer >	m_truthPileupEventName {this, "TruthPileupEventContainerName", "TruthPileupEvents", ""}
Gaudi::Property< bool >	m_useTruthPVAsPerigee {this, "UseTruthPVAsPerigee", false, "Use the truth PV to calculate the perigee parameters instead of the BS"}
std::vector< std::pair< SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >, SG::AuxElement::ConstAccessor< float > > >	m_decor
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

Detailed Description

Definition at line 37 of file InDetPhysValTruthDecoratorAlg.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 Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
kPixel
kSCT
kNClusterTypes

Definition at line 47 of file InDetPhysValTruthDecoratorAlg.h.

{kPixel,kSCT,kNClusterTypes};

EDecorations

enum InDetPhysValTruthDecoratorAlg::EDecorations

private

Enumerator
kDecorD0
kDecorZ0
kDecorPhi
kDecorTheta
kDecorZ0st
kDecorQOverP
kDecorProdR
kDecorProdZ
kDecorNSilHits
kDecorTime
kNDecorators

Definition at line 95 of file InDetPhysValTruthDecoratorAlg.h.

                    {
    kDecorD0,
    kDecorZ0,
    kDecorPhi,
    kDecorTheta,
    kDecorZ0st,
    kDecorQOverP,
    kDecorProdR,
    kDecorProdZ,
    kDecorNSilHits,
    kDecorTime,
    kNDecorators
  };

Constructor & Destructor Documentation

InDetPhysValTruthDecoratorAlg()

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

Definition at line 26 of file InDetPhysValTruthDecoratorAlg.cxx.

                                                                                                            :
  AthReentrantAlgorithm(name, pSvcLocator)
{
}

~InDetPhysValTruthDecoratorAlg()

InDetPhysValTruthDecoratorAlg::~InDetPhysValTruthDecoratorAlg ( )

virtual

Definition at line 31 of file InDetPhysValTruthDecoratorAlg.cxx.

                                                               {
  // nop
}

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

decorateTruth()

bool InDetPhysValTruthDecoratorAlg::decorateTruth ( const xAOD::TruthParticle & particle, std::vector< std::pair< SG::WriteDecorHandle< xAOD::TruthParticleContainer, float >, bool > > & float_decor, const Amg::Vector3D & perigeePos, const std::vector< std::array< uint16_t, kNClusterTypes > > & counts ) const

private

Definition at line 185 of file InDetPhysValTruthDecoratorAlg.cxx.

                                                                                                                {
  ATH_MSG_VERBOSE("Decorate truth with d0 etc");
  if (particle.isNeutral()) {
    return false;
  }
  const EventContext& ctx = Gaudi::Hive::currentContext();
  const Amg::Vector3D momentum(particle.px(), particle.py(), particle.pz());
  const int pid(particle.pdgId());
  double charge = particle.charge();
 
  if (std::isnan(charge)) {
    ATH_MSG_DEBUG("charge not found on particle with pid " << pid);
    return false;
  }
   
  // @TODO float?
  float nSiHits = std::accumulate(counts.at(particle.index()).begin(), counts[particle.index()].end(), 0u);
 
  IDPVM::decorateOrRejectQuietly(particle,float_decor[kDecorNSilHits], nSiHits);
 
  const xAOD::TruthVertex* ptruthVertex(nullptr);
  try{
    ptruthVertex = particle.prodVtx();
  } catch (const std::exception& e) {
    if (not m_errorEmitted) {
      ATH_MSG_WARNING("A non existent production vertex was requested in calculating the track parameters d0 etc");
    }
    m_errorEmitted = true;
    return false;
  }
  if (!ptruthVertex) {
    ATH_MSG_DEBUG("A production vertex pointer was retrieved, but it is NULL");
    return false;
  }
  const auto xPos = ptruthVertex->x();
  const auto yPos = ptruthVertex->y();
  const auto z_truth = ptruthVertex->z();
  const Amg::Vector3D position(xPos, yPos, z_truth);
  const float prodR_truth = std::sqrt(xPos * xPos + yPos * yPos);
  // delete ptruthVertex;ptruthVertex=0;
  const Trk::CurvilinearParameters cParameters(position, momentum, charge);
 
  Trk::PerigeeSurface persf(perigeePos);
 
  std::unique_ptr<const Trk::TrackParameters> tP ( m_extrapolator->extrapolate(ctx,
                                                                               cParameters, 
                                                                               persf, Trk::anyDirection, false) );
  if (tP) {
    float d0_truth = tP->parameters()[Trk::d0];
    float theta_truth = tP->parameters()[Trk::theta];
    float z0_truth = tP->parameters()[Trk::z0];
    float phi_truth = tP->parameters()[Trk::phi];
    float qOverP_truth = tP->parameters()[Trk::qOverP]; // P or Pt ??
    float z0st_truth = z0_truth * std::sin(theta_truth);
 
    // 'safeDecorator' used to prevent a crash in case of adding something which pre-exists.
    // behaviour chosen is to reject quietly
    IDPVM::decorateOrRejectQuietly(particle,float_decor[kDecorD0],d0_truth);
    IDPVM::decorateOrRejectQuietly(particle,float_decor[kDecorZ0],z0_truth);
    IDPVM::decorateOrRejectQuietly(particle,float_decor[kDecorPhi],phi_truth);
    IDPVM::decorateOrRejectQuietly(particle,float_decor[kDecorTheta],theta_truth);
    IDPVM::decorateOrRejectQuietly(particle,float_decor[kDecorZ0st],z0st_truth);
    IDPVM::decorateOrRejectQuietly(particle,float_decor[kDecorQOverP],qOverP_truth);
    IDPVM::decorateOrRejectQuietly(particle,float_decor[kDecorProdR],prodR_truth);
    IDPVM::decorateOrRejectQuietly(particle,float_decor[kDecorProdZ],z_truth);
 
    return true;
  } else {
    ATH_MSG_DEBUG("The TrackParameters pointer for this TruthParticle is NULL");
    return false;
  }
}

decorateTruthTime()

bool InDetPhysValTruthDecoratorAlg::decorateTruthTime ( std::vector< std::pair< SG::WriteDecorHandle< xAOD::TruthParticleContainer, float >, bool > > & float_decor ) const

private

Definition at line 282 of file InDetPhysValTruthDecoratorAlg.cxx.

                                                                                                                                         {
 
  const EventContext& ctx = Gaudi::Hive::currentContext();
 
  const xAOD::TruthEvent* event = nullptr;
  const xAOD::TruthVertex* truthVtx = nullptr;
  float truthTime;
 
  // First HS event
  if (!m_truthEventName.key().empty()) {
    event = getTruthHSEvent();
    if (event) {
      truthVtx = event->signalProcessVertex();
      truthTime = (truthVtx) ? truthVtx->t() / Gaudi::Units::c_light : -9999.;
      for (const auto& link : event->truthParticleLinks()) {
        if (link.isValid()) {
          IDPVM::decorateOrRejectQuietly(**link, float_decor[kDecorTime], truthTime);
        }
      }
    }
  }
 
  // Then PU events
  if (!m_truthPileupEventName.key().empty()) {
    ATH_MSG_VERBOSE("Getting TruthPileupEventContainer");
    SG::ReadHandle<xAOD::TruthPileupEventContainer> truthPileupEventContainer(m_truthPileupEventName, ctx);
    if (!truthPileupEventContainer.isPresent()) {
      ATH_MSG_WARNING("TruthPileupEventContainer name was specified, but no container is present");
      return true;
    }
    if (truthPileupEventContainer.isValid()) {
      for (const auto event : *truthPileupEventContainer) {
        truthVtx = nullptr;
        for (std::size_t i = 0; i < event->nTruthVertices(); i++) {
          truthVtx = event->truthVertex(i);
          if (truthVtx) {
            break;
          }
        }
        truthTime = (truthVtx) ? truthVtx->t() / Gaudi::Units::c_light: -9999.;
        for (const auto& link : event->truthParticleLinks()) {
          if (link.isValid()) {
            IDPVM::decorateOrRejectQuietly(**link, float_decor[kDecorTime], truthTime);
          }
        }
      }
    }
    else {
      ATH_MSG_ERROR("TruthPileupEventContainer is invalid!");
      return false;
    }
  }
 
  return true;
 
}

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

StatusCode InDetPhysValTruthDecoratorAlg::execute ( const EventContext & ctx ) const

virtual

truthbarcode-cluster maps to be pre-stored at event level

Definition at line 74 of file InDetPhysValTruthDecoratorAlg.cxx.

                                                                    {
  SG::ReadHandle<xAOD::TruthParticleContainer> ptruth(m_truthParticleName, ctx);
  if ((not ptruth.isValid())) {
    return StatusCode::FAILURE;
  }
 
  std::size_t ptruth_size=ptruth->size();
 
  std::vector<unsigned int> truthIndexMap;
  if (!m_truthParticleIndexDecor.empty()) {
     SG::ReadDecorHandle<xAOD::TruthParticleContainer, unsigned int> decor_index(m_truthParticleIndexDecor, ctx);
     unsigned int max_size=0;
     assert( ptruth_size < std::numeric_limits<unsigned int>::max());
     for (const xAOD::TruthParticle *truth_particle : *ptruth) {
        max_size = std::max( max_size, decor_index(*truth_particle) );
     }
     if (max_size>=std::numeric_limits<unsigned int>::max()) {
        ATH_MSG_ERROR("Truth index exceed max allowed range.");
        return StatusCode::FAILURE;
     }
     ++max_size;
     truthIndexMap.resize( max_size, std::numeric_limits<unsigned int>::max());
     unsigned int new_index=0;
     for (const xAOD::TruthParticle *truth_particle : *ptruth) {
        truthIndexMap.at( decor_index(*truth_particle) ) = new_index;
        ++new_index;
     }
  }
  else {
     truthIndexMap.reserve(ptruth_size);
     for (unsigned int i=0; i<ptruth_size; ++i) {
        truthIndexMap.push_back(i);
     }
  }
 
  std::vector< IDPVM::OptionalDecoration<xAOD::TruthParticleContainer,float> >
     float_decor( IDPVM::createDecoratorsIfNeeded(*ptruth, m_decor, ctx, msgLvl(MSG::DEBUG)) );

  std::vector< std::array<uint16_t, kNClusterTypes> > tp_clustercount;
  tp_clustercount.resize(ptruth_size,std::array<uint16_t,kNClusterTypes>{});
  unsigned int missing_truth_particle=0u;
  //Loop over the pixel and sct clusters to fill the truth barcode - cluster count maps
  SG::ReadHandle<xAOD::TrackMeasurementValidationContainer> sctClusters(m_truthSCTClusterName, ctx); 
  SG::ReadHandle<xAOD::TrackMeasurementValidationContainer> pixelClusters(m_truthPixelClusterName, ctx); 
  //only decorate the truth particles with truth silicon hits if both containers are available 
  if (sctClusters.isValid() && pixelClusters.isValid()) {
    for (const auto *const sct : *sctClusters) {
      const xAOD::TrackMeasurementValidation* sctCluster = sct;
      static const SG::AuxElement::ConstAccessor< std::vector<unsigned int> > truthIndexAcc("truth_index");
      if (truthIndexAcc.isAvailable(*sctCluster)) {
        const std::vector<unsigned int> &truth_indices = truthIndexAcc(*sctCluster);
        for (auto index : truth_indices) {
           if (index != std::numeric_limits<unsigned int>::max()) {
              if (index < truthIndexMap.size() && truthIndexMap[index] != std::numeric_limits<unsigned int>::max()) {
                 ++tp_clustercount.at(truthIndexMap[index])[kSCT];
              }
              else {
                 ++missing_truth_particle;
              }
           }
        }
      }
    } // Loop over SCT clusters
   
    for (const auto *const pix : *pixelClusters) {
      const xAOD::TrackMeasurementValidation* pixCluster = pix;
      static const SG::AuxElement::ConstAccessor< std::vector<unsigned int> > truthIndexAcc("truth_index");
      if (truthIndexAcc.isAvailable(*pixCluster)) {
        const std::vector<unsigned int> &truth_indices = truthIndexAcc(*pixCluster);
        for (auto index : truth_indices) {
           if (index != std::numeric_limits<unsigned int>::max()) {
              if (index < truthIndexMap.size() && truthIndexMap[index] != std::numeric_limits<unsigned int>::max()) {
                 ++tp_clustercount.at(truthIndexMap[index])[kPixel];
              }
              else {
                 ++missing_truth_particle;
              }
           }
        }
      }
    } // Loop over PIX clusters
  }
  m_nMissingTruthParticles += missing_truth_particle;
 
  if (not float_decor.empty()) {
    Amg::Vector3D perigeePos;
    const xAOD::TruthVertex* truthVtx = getTruthHSEvent()->signalProcessVertex();
    if (m_useTruthPVAsPerigee && truthVtx) {
       perigeePos = Amg::Vector3D(truthVtx->x(), truthVtx->y(), truthVtx->z());
    }
    else {
       SG::ReadDecorHandle<xAOD::EventInfo, float> beamPosX(m_beamSpotDecoKey[0], ctx);
       SG::ReadDecorHandle<xAOD::EventInfo, float> beamPosY(m_beamSpotDecoKey[1], ctx);
       SG::ReadDecorHandle<xAOD::EventInfo, float> beamPosZ(m_beamSpotDecoKey[2], ctx);
       perigeePos = Amg::Vector3D(beamPosX(0), beamPosY(0), beamPosZ(0));
    }
    for (const xAOD::TruthParticle *truth_particle : *ptruth) {
       decorateTruth(*truth_particle, float_decor, perigeePos, tp_clustercount);
    }
    if (m_decoTime) {
      if (!decorateTruthTime(float_decor)) {
       return StatusCode::FAILURE;
      }
    }
  }
 
  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 & 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();
}

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 InDetPhysValTruthDecoratorAlg::finalize ( )

virtual

Definition at line 66 of file InDetPhysValTruthDecoratorAlg.cxx.

                                        {
  if (m_nMissingTruthParticles>0) {
    ATH_MSG_INFO( "Clusters which reference missing / thinned truth particles : " << m_nMissingTruthParticles );
  }
  return StatusCode::SUCCESS;
}

getTruthHSEvent()

const xAOD::TruthEvent * InDetPhysValTruthDecoratorAlg::getTruthHSEvent ( ) const

private

Definition at line 262 of file InDetPhysValTruthDecoratorAlg.cxx.

                                                     {
  const EventContext& ctx = Gaudi::Hive::currentContext();
  const xAOD::TruthEvent* event = nullptr;
  if (!m_truthEventName.key().empty()) {
    ATH_MSG_VERBOSE("Getting TruthEventContainer");
    SG::ReadHandle<xAOD::TruthEventContainer> truthEventContainer(m_truthEventName, ctx);
    if (truthEventContainer.isPresent()) {
      event = (truthEventContainer.isValid()) ? truthEventContainer->at(0) : nullptr;
    }
    else {
      ATH_MSG_WARNING("TruthEventContainer name was specified, but no container is present");
    }
  }
  else {
    ATH_MSG_ERROR("No valid TruthEvent!");
  }
  return event;
}

initialize()

StatusCode InDetPhysValTruthDecoratorAlg::initialize ( )

virtual

Definition at line 36 of file InDetPhysValTruthDecoratorAlg.cxx.

                                          {
  ATH_CHECK(m_extrapolator.retrieve());
  ATH_CHECK(m_beamSpotDecoKey.initialize());
  ATH_CHECK( m_truthPixelClusterName.initialize() );
  ATH_CHECK( m_truthSCTClusterName.initialize() );
 
  ATH_CHECK( m_truthParticleName.initialize());
  ATH_CHECK( m_truthParticleIndexDecor.initialize( !m_truthParticleIndexDecor.key().empty()));
 
  ATH_CHECK(m_truthEventName.initialize(!m_truthEventName.key().empty()));
  ATH_CHECK(m_truthPileupEventName.initialize(!m_truthPileupEventName.key().empty()));
 
  std::vector<std::string> decor_names(kNDecorators);
  decor_names[kDecorD0]="d0";
  decor_names[kDecorZ0]="z0";
  decor_names[kDecorPhi]="phi";
  decor_names[kDecorTheta]="theta";
  decor_names[kDecorZ0st]="z0st";
  decor_names[kDecorQOverP]="qOverP";
  decor_names[kDecorProdR]="prodR";
  decor_names[kDecorProdZ]="prodZ";
  decor_names[kDecorNSilHits]="nSilHits";
  decor_names[kDecorTime]="time";
 
  IDPVM::createDecoratorKeysAndAccessor(*this, m_truthParticleName,m_prefix.value(),decor_names, m_decor);
  assert( m_decor.size() == kNDecorators);
  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;
  }

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

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_beamSpotDecoKey

SG::ReadDecorHandleKeyArray<xAOD::EventInfo> InDetPhysValTruthDecoratorAlg::m_beamSpotDecoKey

private

Initial value:

{this, "BeamSpotDecoKeys",
        {"EventInfo.beamPosX", "EventInfo.beamPosY", "EventInfo.beamPosZ"},
    "Beamspot position decoration keys"}

Definition at line 58 of file InDetPhysValTruthDecoratorAlg.h.

     {this, "BeamSpotDecoKeys",
        {"EventInfo.beamPosX", "EventInfo.beamPosY", "EventInfo.beamPosZ"},
    "Beamspot position decoration keys"};

m_decor

std::vector< std::pair<SG::WriteDecorHandleKey<xAOD::TruthParticleContainer>,SG::AuxElement::ConstAccessor<float> > > InDetPhysValTruthDecoratorAlg::m_decor

private

Definition at line 108 of file InDetPhysValTruthDecoratorAlg.h.

m_decoTime

Gaudi::Property<bool> InDetPhysValTruthDecoratorAlg::m_decoTime {this, "decorateTime", false}

private

Definition at line 73 of file InDetPhysValTruthDecoratorAlg.h.

{this, "decorateTime", false};

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_errorEmitted

std::atomic<bool> InDetPhysValTruthDecoratorAlg::m_errorEmitted {false}

mutableprivate

Definition at line 64 of file InDetPhysValTruthDecoratorAlg.h.

{false};

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_extrapolator

PublicToolHandle<Trk::IExtrapolator> InDetPhysValTruthDecoratorAlg::m_extrapolator {this,"Extrapolator","Trk::Extrapolator/AtlasExtrapolator",""}

private

Definition at line 56 of file InDetPhysValTruthDecoratorAlg.h.

{this,"Extrapolator","Trk::Extrapolator/AtlasExtrapolator",""};

m_nMissingTruthParticles

std::atomic<std::size_t> InDetPhysValTruthDecoratorAlg::m_nMissingTruthParticles = 0u

mutableprivate

Definition at line 63 of file InDetPhysValTruthDecoratorAlg.h.

m_prefix

Gaudi::Property<std::string> InDetPhysValTruthDecoratorAlg::m_prefix {this, "Prefix", "", "Decoration prefix to avoid clashes."}

private

Definition at line 70 of file InDetPhysValTruthDecoratorAlg.h.

{this, "Prefix", "", "Decoration prefix to avoid clashes."};

m_truthEventName

SG::ReadHandleKey<xAOD::TruthEventContainer> InDetPhysValTruthDecoratorAlg::m_truthEventName {this, "TruthEventContainerName", "TruthEvents", ""}

private

Definition at line 85 of file InDetPhysValTruthDecoratorAlg.h.

{this, "TruthEventContainerName", "TruthEvents", ""};

m_truthParticleIndexDecor

SG::ReadDecorHandleKey<xAOD::TruthParticleContainer> InDetPhysValTruthDecoratorAlg::m_truthParticleIndexDecor {this, "TruthParticleIndexDecoration", m_truthParticleName, "origTruthIndex", "decoration name for the original truth particle index."}

private

Definition at line 82 of file InDetPhysValTruthDecoratorAlg.h.

{this, "TruthParticleIndexDecoration", m_truthParticleName, "origTruthIndex", "decoration name for the original truth particle index."};

m_truthParticleName

SG::ReadHandleKey<xAOD::TruthParticleContainer> InDetPhysValTruthDecoratorAlg::m_truthParticleName {this, "TruthParticleContainerName", "TruthParticles", ""}

private

TruthParticle container's name needed to create decorators.

Definition at line 67 of file InDetPhysValTruthDecoratorAlg.h.

{this, "TruthParticleContainerName",  "TruthParticles", ""};

m_truthPileupEventName

SG::ReadHandleKey<xAOD::TruthPileupEventContainer> InDetPhysValTruthDecoratorAlg::m_truthPileupEventName {this, "TruthPileupEventContainerName", "TruthPileupEvents", ""}

private

Definition at line 88 of file InDetPhysValTruthDecoratorAlg.h.

{this, "TruthPileupEventContainerName", "TruthPileupEvents", ""};

m_truthPixelClusterName

SG::ReadHandleKey<xAOD::TrackMeasurementValidationContainer> InDetPhysValTruthDecoratorAlg::m_truthPixelClusterName {this, "PixelClusterContainerName", "PixelClusters", ""}

private

TruthPixelClusterContainer and TruthSCTClusterContainer needed for truth silicon hit cut.

Definition at line 76 of file InDetPhysValTruthDecoratorAlg.h.

{this, "PixelClusterContainerName",  "PixelClusters", ""};

m_truthSCTClusterName

SG::ReadHandleKey<xAOD::TrackMeasurementValidationContainer> InDetPhysValTruthDecoratorAlg::m_truthSCTClusterName {this, "SCTClusterContainerName", "SCT_Clusters", ""}

private

Definition at line 79 of file InDetPhysValTruthDecoratorAlg.h.

{this, "SCTClusterContainerName",  "SCT_Clusters", ""};

m_useTruthPVAsPerigee

Gaudi::Property<bool> InDetPhysValTruthDecoratorAlg::m_useTruthPVAsPerigee {this, "UseTruthPVAsPerigee", false, "Use the truth PV to calculate the perigee parameters instead of the BS"}

private

Definition at line 91 of file InDetPhysValTruthDecoratorAlg.h.

{this, "UseTruthPVAsPerigee", false, "Use the truth PV to calculate the perigee parameters instead of the BS"};

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:

• InDetPhysValTruthDecoratorAlg.h
• InDetPhysValTruthDecoratorAlg.cxx