InDet::XAODToInDetClusterConversion Class Reference

#include <XAODToInDetClusterConversion.h>

Inheritance diagram for InDet::XAODToInDetClusterConversion:

Public Member Functions
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &ctx) const override
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
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	convertPixelClusters (const EventContext &ctx) const
StatusCode	convertStripClusters (const EventContext &ctx) const
StatusCode	convertHgtdClusters (const EventContext &ctx) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
const PixelID *	m_pixelID {}
const SCT_ID *	m_stripID {}
const HGTD_ID *	m_hgtdID {}
ToolHandle< ISiLorentzAngleTool >	m_lorentzAngleTool {this, "LorentzAngleTool", "", "Tool to retrieve Lorentz angle of SCT"}
SG::ReadCondHandleKey< InDetDD::SiDetectorElementCollection >	m_pixelDetEleCollKey {this, "PixelDetEleCollKey", "ITkPixelDetectorElementCollection", "Key of SiDetectorElementCollection for Pixel"}
SG::ReadHandleKey< xAOD::PixelClusterContainer >	m_inputPixelClusterContainerKey {this, "InputPixelClustersName", "ITkPixelClusters", "name of the input xAOD pixel cluster container"}
SG::WriteHandleKey< InDet::PixelClusterContainer >	m_outputPixelClusterContainerKey {this, "OutputPixelClustersName", "ITkPixelClusters", "name of the output InDet pixel cluster container"}
SG::WriteHandleKey< InDet::SiClusterContainer >	m_pixelClusterContainerLinkKey {this, "PixelClustersLinkName", "ITkPixelClusters"}
SG::WriteHandleKey< std::vector< unsigned int > >	m_pixelClusterOffSetKey {this, "PixelClusterOffSetKey", "ITkPixelClustersOffsets"}
SG::WriteDecorHandleKey< xAOD::PixelClusterContainer >	m_pixelClusterLinkKey {this, "PixelClusterLinkKey", m_inputPixelClusterContainerKey, "pixelClusterLink", "Decoration to link Trk object to xAOD" }
SG::ReadCondHandleKey< InDetDD::SiDetectorElementCollection >	m_stripDetEleCollKey {this, "StripDetEleCollKey", "ITkStripDetectorElementCollection", "Key of SiDetectorElementCollection for Strip"}
SG::ReadHandleKey< xAOD::StripClusterContainer >	m_inputStripClusterContainerKey {this, "InputStripClustersName", "ITkStripClusters", "name of the input xAOD strip cluster container"}
SG::WriteHandleKey< InDet::SCT_ClusterContainer >	m_outputStripClusterContainerKey {this, "OutputStripClustersName", "ITkStripClusters", "name of the output InDet pixel cluster container"}
SG::WriteHandleKey< InDet::SiClusterContainer >	m_stripClusterContainerLinkKey {this, "StripClustersLinkName", "ITkStripClusters"}
SG::WriteHandleKey< std::vector< unsigned int > >	m_stripClusterOffSetKey {this, "StripClusterOffSetKey", "ITkStripClustersOffsets"}
SG::WriteDecorHandleKey< xAOD::StripClusterContainer >	m_stripClusterLinkKey {this, "StripClusterLinkKey", m_inputStripClusterContainerKey, "sctClusterLink", "Decoration to link Trk object to xAOD" }
SG::ReadCondHandleKey< InDetDD::HGTD_DetectorElementCollection >	m_HGTDDetEleCollKey {this, "HGTDDetEleCollKey", "HGTD_DetectorElementCollection", "Key of HGTD_DetectorElementCollection for HGTD"}
SG::ReadHandleKey< xAOD::HGTDClusterContainer >	m_inputHgtdClusterContainerKey {this, "InputHGTDClustersName", "HGTD_Clusters", "name of the input xAOD hgtd cluster container"}
SG::WriteHandleKey<::HGTD_ClusterContainer >	m_outputHgtdClusterContainerKey {this, "OutputHGTDClustersName", "HGTD_Clusters", "name of the output InDet hgtd cluster container"}
SG::WriteDecorHandleKey< xAOD::HGTDClusterContainer >	m_hgdtClusterLinkKey {this, "HgtdClusterLinkKey", m_inputHgtdClusterContainerKey, "hgtdClusterLink", "Decoration to link Trk object to xAOD" }
Gaudi::Property< bool >	m_processPixel {this, "ProcessPixel", false}
Gaudi::Property< bool >	m_processStrip {this, "ProcessStrip", false}
Gaudi::Property< bool >	m_processHgtd {this, "ProcessHgtd", false}
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 36 of file XAODToInDetClusterConversion.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

convertHgtdClusters()

StatusCode InDet::XAODToInDetClusterConversion::convertHgtdClusters ( const EventContext & ctx ) const

private

Definition at line 222 of file XAODToInDetClusterConversion.cxx.

                                                                                            {
    const InDetDD::HGTD_DetectorElementCollection *hgtdElements{};
    ATH_CHECK(SG::get(hgtdElements,m_HGTDDetEleCollKey, ctx));
    
    const xAOD::HGTDClusterContainer *inputHgtdClusters{};
    ATH_CHECK(SG::get(inputHgtdClusters, m_inputHgtdClusterContainerKey, ctx));
 
    using Link_t = ElementLink< ::HGTD_ClusterCollection >;
    SG::WriteDecorHandle<xAOD::HGTDClusterContainer, Link_t> dec_link{m_hgdtClusterLinkKey,ctx};
    
    SG::WriteHandle outputHgtdClusterContainer{m_outputHgtdClusterContainerKey, ctx};
    ATH_CHECK( outputHgtdClusterContainer.record (std::make_unique<::HGTD_ClusterContainer>(m_hgtdID->wafer_hash_max(), EventContainers::Mode::OfflineFast)) );
    ATH_MSG_DEBUG( "Container '" << m_outputHgtdClusterContainerKey.key() << "' initialised" );
 
    ContainerAccessor<xAOD::HGTDCluster, IdentifierHash, 1>
      hgtdAccessor ( *inputHgtdClusters,
         [] (const xAOD::HGTDCluster& cl) -> IdentifierHash { return cl.identifierHash(); },
         hgtdElements->size());
 
    const auto& allIdHashes = hgtdAccessor.allIdentifiers();
    for (const auto& hashId : allIdHashes) {
      const auto *element = InDetDD::HGTDDetEl::getDetectorElement(hashId,*hgtdElements);
      if ( element == nullptr ) {
        ATH_MSG_FATAL( "Invalid hgtd detector element for hash " << hashId);
        return StatusCode::FAILURE;
      }
 
      std::unique_ptr<::HGTD_ClusterCollection> collection = std::make_unique<::HGTD_ClusterCollection>(hashId);
 
      // Get the detector element and range for the idHash
      for (const auto& this_range : hgtdAccessor.rangesForIdentifierDirect(hashId)) {
        for (auto start = this_range.first; start != this_range.second; ++start) {
          const xAOD::HGTDCluster* in_cluster = *start;
 
          ::HGTD_Cluster* cluster = nullptr;
          //cluster is overwritten, but it is saved in 'collection' and later moved
          //coverity[RESOURCE_LEAK]
          ATH_CHECK( TrackingUtilities::convertXaodToInDetCluster(*in_cluster, *element, cluster) );
          cluster->setHashAndIndex(hashId, collection->size());
 
          // Add to Collection
          collection->push_back(cluster);
          dec_link(*in_cluster) = Link_t{cluster, *collection};
        }
      }
 
      ::HGTD_ClusterContainer::IDC_WriteHandle lock = outputHgtdClusterContainer->getWriteHandle(hashId);
      ATH_CHECK(lock.addOrDelete( std::move(collection) ));
 
    } // loop on hashIds
 
    ATH_CHECK( outputHgtdClusterContainer.setConst() );
 
    return StatusCode::SUCCESS;
  }

convertPixelClusters()

StatusCode InDet::XAODToInDetClusterConversion::convertPixelClusters ( const EventContext & ctx ) const

private

Definition at line 82 of file XAODToInDetClusterConversion.cxx.

                                                                                             {
    const InDetDD::SiDetectorElementCollection* pixElements{};
    ATH_CHECK(SG::get(pixElements, m_pixelDetEleCollKey, ctx));
 
    const xAOD::PixelClusterContainer *inputPixelClusters{};
    ATH_CHECK(SG::get(inputPixelClusters, m_inputPixelClusterContainerKey, ctx));
  
    using Link_t = ElementLink< InDet::PixelClusterCollection >;
    SG::WriteDecorHandle<xAOD::PixelClusterContainer, Link_t> dec_link{m_pixelClusterLinkKey,ctx};
    SG::WriteHandle outputPixelClusterContainer{m_outputPixelClusterContainerKey, ctx};
    ATH_CHECK( outputPixelClusterContainer.record (std::make_unique<InDet::PixelClusterContainer>(m_pixelID->wafer_hash_max(), EventContainers::Mode::OfflineFast)) );
    ATH_MSG_DEBUG( "Container '" << m_outputPixelClusterContainerKey.key() << "' initialised" );
 
    ATH_CHECK( outputPixelClusterContainer.symLink( m_pixelClusterContainerLinkKey ) );
 
 
    // Conversion
    // Access to the cluster from a given detector element is possible
    // via the ContainerAccessor.
    ContainerAccessor<xAOD::PixelCluster, IdentifierHash, 1>
      pixelAccessor ( *inputPixelClusters,
          [] (const xAOD::PixelCluster& cl) -> IdentifierHash { return cl.identifierHash(); },
          pixElements->size());
 
    const auto& allIdHashes = pixelAccessor.allIdentifiers();
    for (const auto& hashId : allIdHashes) {
      const InDetDD::SiDetectorElement *element = pixElements->getDetectorElement(hashId);
      if ( element == nullptr ) {
        ATH_MSG_FATAL( "Invalid pixel detector element for hash " << hashId);
        return StatusCode::FAILURE;
      }
 
      std::unique_ptr<InDet::PixelClusterCollection> collection = std::make_unique<InDet::PixelClusterCollection>(hashId);
 
      // Get the detector element and range for the idHash
      for (const auto& this_range : pixelAccessor.rangesForIdentifierDirect(hashId)) {
        for (auto start = this_range.first; start != this_range.second; ++start) {
          const xAOD::PixelCluster* in_cluster = *start;
 
          InDet::PixelCluster* cluster = nullptr;
          ATH_CHECK( TrackingUtilities::convertXaodToInDetCluster(*in_cluster, *element, *m_pixelID, cluster) );
          //coverity[FORWARD_NULL:FALSE]
          cluster->setHashAndIndex(hashId, collection->size());
 
          // Add to Collection
          collection->push_back(cluster);
          dec_link(*in_cluster) = Link_t{cluster, *collection};
        }
      }
 
      InDet::PixelClusterContainer::IDC_WriteHandle lock = outputPixelClusterContainer->getWriteHandle(hashId);
      ATH_CHECK(lock.addOrDelete( std::move(collection) ));
 
    } // loop on hashIds
 
    auto offsets = std::make_unique<std::vector<unsigned int>>(m_pixelID->wafer_hash_max(), 0);
    unsigned int counter(0);
    for (const auto coll : *outputPixelClusterContainer) {
      (*offsets)[coll->identifyHash()] = counter;
      counter += coll->size();
    }
    SG::WriteHandle offSetHandle{m_pixelClusterOffSetKey ,ctx};
    ATH_CHECK(offSetHandle.record(std::move(offsets)));
 
    return StatusCode::SUCCESS;
  }

convertStripClusters()

StatusCode InDet::XAODToInDetClusterConversion::convertStripClusters ( const EventContext & ctx ) const

private

Definition at line 149 of file XAODToInDetClusterConversion.cxx.

                                                                                             {
    const InDetDD::SiDetectorElementCollection* stripElements{};
    ATH_CHECK(SG::get(stripElements, m_stripDetEleCollKey, ctx));
    const xAOD::StripClusterContainer *inputStripClusters{};
    ATH_CHECK(SG::get(inputStripClusters, m_inputStripClusterContainerKey, ctx));
    
    using Link_t = ElementLink< InDet::SCT_ClusterCollection >;
    SG::WriteDecorHandle<xAOD::StripClusterContainer, Link_t> dec_link{m_stripClusterLinkKey,ctx};
 
    SG::WriteHandle outputStripClusterContainer{m_outputStripClusterContainerKey, ctx};
    ATH_CHECK( outputStripClusterContainer.record (std::make_unique<InDet::SCT_ClusterContainer>(m_stripID->wafer_hash_max(), EventContainers::Mode::OfflineFast)) );
    ATH_MSG_DEBUG( "Container '" << m_outputStripClusterContainerKey.key() << "' initialised" );
 
    ATH_CHECK( outputStripClusterContainer.symLink( m_stripClusterContainerLinkKey ) );
 
    // Conversion
    // Access to the cluster from a given detector element is possible
    // via the ContainerAccessor.
    ContainerAccessor<xAOD::StripCluster, IdentifierHash, 1>
      stripAccessor ( *inputStripClusters,
          [] (const xAOD::StripCluster& cl) -> IdentifierHash { return cl.identifierHash(); },
          stripElements->size());
 
 
 
    const auto& allIdHashes = stripAccessor.allIdentifiers();
    for (const auto& hashId : allIdHashes) {
      const InDetDD::SiDetectorElement *element = stripElements->getDetectorElement(hashId);
      if ( element == nullptr ) {
        ATH_MSG_FATAL( "Invalid strip detector element for hash " << hashId);
        return StatusCode::FAILURE;
      }
 
      bool isBarrel = element->isBarrel();
      double shift = not isBarrel ? m_lorentzAngleTool->getLorentzShift(hashId, ctx) : 0.;
 
      std::unique_ptr<InDet::SCT_ClusterCollection> collection = std::make_unique<InDet::SCT_ClusterCollection>(hashId);
 
 
      // Get the detector element and range for the idHash
      for (const auto& this_range : stripAccessor.rangesForIdentifierDirect(hashId)) {
        for (auto start = this_range.first; start != this_range.second; ++start) {
          const xAOD::StripCluster* in_cluster = *start;
 
          InDet::SCT_Cluster* cluster = nullptr;
          ATH_CHECK( TrackingUtilities::convertXaodToInDetCluster(*in_cluster, *element, *m_stripID, cluster, shift) );
          //coverity[FORWARD_NULL:FALSE]
          cluster->setHashAndIndex(hashId, collection->size());
 
 
          // Add to Collection
          collection->push_back( cluster );
          dec_link(*in_cluster) = Link_t{cluster, *collection};
        }
      }
 
      InDet::SCT_ClusterContainer::IDC_WriteHandle lock = outputStripClusterContainer->getWriteHandle(hashId);
      ATH_CHECK(lock.addOrDelete( std::move(collection) ));
 
    }
 
    auto offsets = std::make_unique<std::vector<unsigned int>>(m_stripID->wafer_hash_max(), 0);
    unsigned int counter(0);
    for (const auto coll : *outputStripClusterContainer) {
      (*offsets)[coll->identifyHash()] = counter;
      counter += coll->size();
    }
    SG::WriteHandle offSetHandle{m_stripClusterOffSetKey ,ctx};
    ATH_CHECK(offSetHandle.record(std::move(offsets)));
 
    return StatusCode::SUCCESS;
  }

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

StatusCode InDet::XAODToInDetClusterConversion::execute ( const EventContext & ctx ) const

overridevirtual

Definition at line 61 of file XAODToInDetClusterConversion.cxx.

  {
    ATH_MSG_DEBUG( "Executing " << name() << " ... ");
    if (m_processPixel) {
      ATH_MSG_DEBUG("Converting Pixel Clusters: xAOD -> InDet");
      ATH_CHECK( convertPixelClusters(ctx) );
    }
 
    if (m_processStrip) {
      ATH_MSG_DEBUG("Converting Strip Clusters: xAOD -> InDet");
      ATH_CHECK( convertStripClusters(ctx) );
    }
 
    if (m_processHgtd) {
      ATH_MSG_DEBUG("Converting HGTD Clusters: xAOD -> InDet");
      ATH_CHECK( convertHgtdClusters(ctx) );
    }
 
    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();
  }

initialize()

StatusCode InDet::XAODToInDetClusterConversion::initialize ( )

overridevirtual

Definition at line 22 of file XAODToInDetClusterConversion.cxx.

                                                      {
    ATH_MSG_INFO( "Initializing " << name() << " ... " );
 
    // Pixel Clusters
    ATH_CHECK( m_pixelDetEleCollKey.initialize(m_processPixel) );
    if (m_processPixel) {
      ATH_CHECK( detStore()->retrieve(m_pixelID,"PixelID") );
    }
    ATH_CHECK( m_inputPixelClusterContainerKey.initialize(m_processPixel) );
    ATH_CHECK( m_pixelClusterContainerLinkKey.initialize(m_processPixel) );
    ATH_CHECK( m_outputPixelClusterContainerKey.initialize(m_processPixel) );
    ATH_CHECK(m_pixelClusterOffSetKey.initialize(m_processPixel));
    ATH_CHECK( m_pixelClusterLinkKey.initialize(m_processPixel));
 
    // Strip Clusters
    ATH_CHECK( m_stripDetEleCollKey.initialize(m_processStrip) );
    if (m_processStrip) {
        ATH_CHECK( detStore()->retrieve(m_stripID, "SCT_ID") );
    }
    ATH_CHECK( m_inputStripClusterContainerKey.initialize(m_processStrip) );
    ATH_CHECK( m_stripClusterContainerLinkKey.initialize(m_processStrip) );
    ATH_CHECK( m_outputStripClusterContainerKey.initialize(m_processStrip) );
    ATH_CHECK( m_stripClusterOffSetKey.initialize(m_processStrip));
    ATH_CHECK( m_stripClusterLinkKey.initialize(m_processStrip));
 
    ATH_CHECK( m_lorentzAngleTool.retrieve(EnableTool{not m_lorentzAngleTool.empty()}) );
 
    // Hgtd Clusters
    ATH_CHECK( m_HGTDDetEleCollKey.initialize(m_processHgtd) );
    if (m_processHgtd) {
      ATH_CHECK( detStore()->retrieve(m_hgtdID, "HGTD_ID") );
    }
    ATH_CHECK( m_inputHgtdClusterContainerKey.initialize(m_processHgtd) );
    ATH_CHECK( m_outputHgtdClusterContainerKey.initialize(m_processHgtd) );
    ATH_CHECK( m_hgdtClusterLinkKey.initialize(m_processHgtd));
 
    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_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 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_hgdtClusterLinkKey

SG::WriteDecorHandleKey<xAOD::HGTDClusterContainer> InDet::XAODToInDetClusterConversion::m_hgdtClusterLinkKey {this, "HgtdClusterLinkKey", m_inputHgtdClusterContainerKey, "hgtdClusterLink", "Decoration to link Trk object to xAOD" }

private

Definition at line 79 of file XAODToInDetClusterConversion.h.

{this, "HgtdClusterLinkKey", m_inputHgtdClusterContainerKey, "hgtdClusterLink", "Decoration to link Trk object to xAOD"  };

m_HGTDDetEleCollKey

SG::ReadCondHandleKey<InDetDD::HGTD_DetectorElementCollection> InDet::XAODToInDetClusterConversion::m_HGTDDetEleCollKey {this, "HGTDDetEleCollKey", "HGTD_DetectorElementCollection", "Key of HGTD_DetectorElementCollection for HGTD"}

private

Definition at line 75 of file XAODToInDetClusterConversion.h.

{this, "HGTDDetEleCollKey", "HGTD_DetectorElementCollection", "Key of HGTD_DetectorElementCollection for HGTD"};

m_hgtdID

const HGTD_ID* InDet::XAODToInDetClusterConversion::m_hgtdID {}

private

Definition at line 54 of file XAODToInDetClusterConversion.h.

{};

m_inputHgtdClusterContainerKey

SG::ReadHandleKey<xAOD::HGTDClusterContainer> InDet::XAODToInDetClusterConversion::m_inputHgtdClusterContainerKey {this, "InputHGTDClustersName", "HGTD_Clusters", "name of the input xAOD hgtd cluster container"}

private

Definition at line 76 of file XAODToInDetClusterConversion.h.

{this, "InputHGTDClustersName", "HGTD_Clusters", "name of the input xAOD hgtd cluster container"};

m_inputPixelClusterContainerKey

SG::ReadHandleKey<xAOD::PixelClusterContainer> InDet::XAODToInDetClusterConversion::m_inputPixelClusterContainerKey {this, "InputPixelClustersName", "ITkPixelClusters", "name of the input xAOD pixel cluster container"}

private

Definition at line 59 of file XAODToInDetClusterConversion.h.

{this, "InputPixelClustersName", "ITkPixelClusters", "name of the input xAOD pixel cluster container"};

m_inputStripClusterContainerKey

SG::ReadHandleKey<xAOD::StripClusterContainer> InDet::XAODToInDetClusterConversion::m_inputStripClusterContainerKey {this, "InputStripClustersName", "ITkStripClusters", "name of the input xAOD strip cluster container"}

private

Definition at line 68 of file XAODToInDetClusterConversion.h.

{this, "InputStripClustersName", "ITkStripClusters", "name of the input xAOD strip cluster container"};

m_lorentzAngleTool

ToolHandle<ISiLorentzAngleTool> InDet::XAODToInDetClusterConversion::m_lorentzAngleTool {this, "LorentzAngleTool", "", "Tool to retrieve Lorentz angle of SCT"}

private

Definition at line 56 of file XAODToInDetClusterConversion.h.

{this, "LorentzAngleTool", "", "Tool to retrieve Lorentz angle of SCT"};

m_outputHgtdClusterContainerKey

SG::WriteHandleKey<::HGTD_ClusterContainer> InDet::XAODToInDetClusterConversion::m_outputHgtdClusterContainerKey {this, "OutputHGTDClustersName", "HGTD_Clusters", "name of the output InDet hgtd cluster container"}

private

Definition at line 78 of file XAODToInDetClusterConversion.h.

{this, "OutputHGTDClustersName", "HGTD_Clusters", "name of the output InDet hgtd cluster container"};

m_outputPixelClusterContainerKey

SG::WriteHandleKey<InDet::PixelClusterContainer> InDet::XAODToInDetClusterConversion::m_outputPixelClusterContainerKey {this, "OutputPixelClustersName", "ITkPixelClusters", "name of the output InDet pixel cluster container"}

private

Definition at line 61 of file XAODToInDetClusterConversion.h.

{this, "OutputPixelClustersName", "ITkPixelClusters", "name of the output InDet pixel cluster container"};

m_outputStripClusterContainerKey

SG::WriteHandleKey<InDet::SCT_ClusterContainer> InDet::XAODToInDetClusterConversion::m_outputStripClusterContainerKey {this, "OutputStripClustersName", "ITkStripClusters", "name of the output InDet pixel cluster container"}

private

Definition at line 70 of file XAODToInDetClusterConversion.h.

{this, "OutputStripClustersName", "ITkStripClusters", "name of the output InDet pixel cluster container"};

m_pixelClusterContainerLinkKey

SG::WriteHandleKey< InDet::SiClusterContainer > InDet::XAODToInDetClusterConversion::m_pixelClusterContainerLinkKey {this, "PixelClustersLinkName", "ITkPixelClusters"}

private

Definition at line 62 of file XAODToInDetClusterConversion.h.

{this, "PixelClustersLinkName", "ITkPixelClusters"};

m_pixelClusterLinkKey

SG::WriteDecorHandleKey<xAOD::PixelClusterContainer> InDet::XAODToInDetClusterConversion::m_pixelClusterLinkKey {this, "PixelClusterLinkKey", m_inputPixelClusterContainerKey, "pixelClusterLink", "Decoration to link Trk object to xAOD" }

private

Definition at line 65 of file XAODToInDetClusterConversion.h.

{this, "PixelClusterLinkKey", m_inputPixelClusterContainerKey, "pixelClusterLink", "Decoration to link Trk object to xAOD"  };

m_pixelClusterOffSetKey

SG::WriteHandleKey<std::vector<unsigned int> > InDet::XAODToInDetClusterConversion::m_pixelClusterOffSetKey {this, "PixelClusterOffSetKey", "ITkPixelClustersOffsets"}

private

Definition at line 63 of file XAODToInDetClusterConversion.h.

{this, "PixelClusterOffSetKey", "ITkPixelClustersOffsets"};

m_pixelDetEleCollKey

SG::ReadCondHandleKey<InDetDD::SiDetectorElementCollection> InDet::XAODToInDetClusterConversion::m_pixelDetEleCollKey {this, "PixelDetEleCollKey", "ITkPixelDetectorElementCollection", "Key of SiDetectorElementCollection for Pixel"}

private

Definition at line 58 of file XAODToInDetClusterConversion.h.

{this, "PixelDetEleCollKey", "ITkPixelDetectorElementCollection", "Key of SiDetectorElementCollection for Pixel"};

m_pixelID

const PixelID* InDet::XAODToInDetClusterConversion::m_pixelID {}

private

Definition at line 52 of file XAODToInDetClusterConversion.h.

{}; 

m_processHgtd

Gaudi::Property<bool> InDet::XAODToInDetClusterConversion::m_processHgtd {this, "ProcessHgtd", false}

private

Definition at line 83 of file XAODToInDetClusterConversion.h.

{this, "ProcessHgtd", false};

m_processPixel

Gaudi::Property<bool> InDet::XAODToInDetClusterConversion::m_processPixel {this, "ProcessPixel", false}

private

Definition at line 81 of file XAODToInDetClusterConversion.h.

{this, "ProcessPixel", false};

m_processStrip

Gaudi::Property<bool> InDet::XAODToInDetClusterConversion::m_processStrip {this, "ProcessStrip", false}

private

Definition at line 82 of file XAODToInDetClusterConversion.h.

{this, "ProcessStrip", false};

m_stripClusterContainerLinkKey

SG::WriteHandleKey< InDet::SiClusterContainer > InDet::XAODToInDetClusterConversion::m_stripClusterContainerLinkKey {this, "StripClustersLinkName", "ITkStripClusters"}

private

Definition at line 71 of file XAODToInDetClusterConversion.h.

{this, "StripClustersLinkName", "ITkStripClusters"};

m_stripClusterLinkKey

SG::WriteDecorHandleKey<xAOD::StripClusterContainer> InDet::XAODToInDetClusterConversion::m_stripClusterLinkKey {this, "StripClusterLinkKey", m_inputStripClusterContainerKey, "sctClusterLink", "Decoration to link Trk object to xAOD" }

private

Definition at line 73 of file XAODToInDetClusterConversion.h.

{this, "StripClusterLinkKey", m_inputStripClusterContainerKey, "sctClusterLink", "Decoration to link Trk object to xAOD"  };

m_stripClusterOffSetKey

SG::WriteHandleKey<std::vector<unsigned int> > InDet::XAODToInDetClusterConversion::m_stripClusterOffSetKey {this, "StripClusterOffSetKey", "ITkStripClustersOffsets"}

private

Definition at line 72 of file XAODToInDetClusterConversion.h.

{this, "StripClusterOffSetKey", "ITkStripClustersOffsets"};

m_stripDetEleCollKey

SG::ReadCondHandleKey<InDetDD::SiDetectorElementCollection> InDet::XAODToInDetClusterConversion::m_stripDetEleCollKey {this, "StripDetEleCollKey", "ITkStripDetectorElementCollection", "Key of SiDetectorElementCollection for Strip"}

private

Definition at line 67 of file XAODToInDetClusterConversion.h.

{this, "StripDetEleCollKey", "ITkStripDetectorElementCollection", "Key of SiDetectorElementCollection for Strip"};

m_stripID

const SCT_ID* InDet::XAODToInDetClusterConversion::m_stripID {}

private

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

• XAODToInDetClusterConversion.h
• XAODToInDetClusterConversion.cxx