#include <ThinNegativeEnergyCaloClustersAlg.h>

Inheritance diagram for ThinNegativeEnergyCaloClustersAlg:

Collaboration diagram for ThinNegativeEnergyCaloClustersAlg:

Public Member Functions
	ThinNegativeEnergyCaloClustersAlg (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor with parameters:
virtual	~ThinNegativeEnergyCaloClustersAlg ()=default
	Destructor:
virtual StatusCode	initialize () override final
	Athena algorithm's initalize hook.
StatusCode	execute (const EventContext &ctx) const override final
	Athena algorithm's execute hook.
virtual StatusCode	finalize () override final
	Athena algorithm's finalize hook.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.
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
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`.
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
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
StringProperty	m_streamName
BooleanProperty	m_doThinning
	Should the thinning run?
SG::ThinningHandleKey< xAOD::CaloClusterContainer >	m_caloClustersKey
	Names of the containers to thin.
std::atomic< unsigned long >	m_nEventsProcessed
	Counters.
std::atomic< unsigned long >	m_nCaloClustersProcessed
std::atomic< unsigned long >	m_nCaloClustersThinned
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 25 of file ThinNegativeEnergyCaloClustersAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ ThinNegativeEnergyCaloClustersAlg()

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

Constructor with parameters:

Definition at line 32 of file ThinNegativeEnergyCaloClustersAlg.cxx.

  : AthReentrantAlgorithm(name, pSvcLocator)
  , m_nEventsProcessed(0)
  , m_nCaloClustersProcessed(0)
  , m_nCaloClustersThinned(0)
{}

◆ ~ThinNegativeEnergyCaloClustersAlg()

virtual ThinNegativeEnergyCaloClustersAlg::~ThinNegativeEnergyCaloClustersAlg ( )

virtualdefault

Destructor:

Member Function Documentation

◆ cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality ( ) const

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.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

{
  return 0;
}

◆ 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.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ 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.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

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

finaloverride

Athena algorithm's execute hook.

Definition at line 86 of file ThinNegativeEnergyCaloClustersAlg.cxx.

{
  // Increase the event counter
  m_nEventsProcessed.fetch_add(1, std::memory_order_relaxed);
 
  // Is thinning required?
  if (!m_doThinning) {
    return StatusCode::SUCCESS;
  }
 
  // Retrieve truth and vertex containers
  SG::ThinningHandle<xAOD::CaloClusterContainer> caloClusters(m_caloClustersKey,
                                                              ctx);
 
  // Set up masks
  std::vector<bool> mask;
  int nCaloClusters = caloClusters->size();
  m_nCaloClustersProcessed.fetch_add(nCaloClusters, std::memory_order_relaxed);
  mask.assign(nCaloClusters, false);
 
  // Loop over CaloClusters and update mask
  unsigned long int nCaloClustersThinned = 0;
  for (int i = 0; i < nCaloClusters; ++i) {
    const xAOD::CaloCluster* caloCluster = (*caloClusters)[i];
    // Retain postive energy clusters
    if (caloCluster->rawE() > 0.0) {
      mask[i] = true;
    } else {
      ++nCaloClustersThinned;
    }
  }
  m_nCaloClustersThinned.fetch_add(nCaloClustersThinned,
                                   std::memory_order_relaxed);
 
  // Apply masks to thinning service
  caloClusters.keep(mask);
 
  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 ( ) const

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

◆ filterPassed()

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

inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

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

◆ finalize()

StatusCode ThinNegativeEnergyCaloClustersAlg::finalize ( )

finaloverridevirtual

Athena algorithm's finalize hook.

Definition at line 75 of file ThinNegativeEnergyCaloClustersAlg.cxx.

{
  ATH_MSG_DEBUG("Finalizing " << name() << "...");
  ATH_MSG_INFO("Processed " << m_nEventsProcessed << " events containing "
                            << m_nCaloClustersProcessed << " CaloClusters");
  ATH_MSG_INFO("Removed " << m_nCaloClustersThinned
                          << " negative energy CaloClusters ");
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode ThinNegativeEnergyCaloClustersAlg::initialize ( )

finaloverridevirtual

Athena algorithm's initalize hook.

Definition at line 44 of file ThinNegativeEnergyCaloClustersAlg.cxx.

{
  ATH_MSG_DEBUG("Initializing " << name() << "...");
 
  // Print out the used configuration
  ATH_MSG_DEBUG(" using = " << m_streamName);
 
  // Is truth thinning required?
  if (!m_doThinning) {
    ATH_MSG_INFO("Negative energy CaloClusters thinning not required");
  } else {
    ATH_MSG_INFO("Negative energy CaloClusters will be thinned");
  }
 
  if (m_doThinning && m_streamName.empty()) {
    ATH_MSG_ERROR("StreamName property has not been initialized.");
    return StatusCode::FAILURE;
  }
  ATH_CHECK(m_caloClustersKey.initialize(m_streamName, m_doThinning));
 
  // Initialize the counters to zero
  m_nEventsProcessed = 0;
  m_nCaloClustersProcessed = 0;
  m_nCaloClustersThinned = 0;
 
  ATH_MSG_DEBUG("==> done with initialize " << name() << "...");
 
  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 ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Reimplemented in InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ITkPixelCablingAlg, ITkStripCablingAlg, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, 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, and Simulation::BeamEffectsAlg.

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

{
  // Reentrant algorithms are clonable.
  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 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 HypoBase, and InputMakerBase.

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_caloClustersKey

SG::ThinningHandleKey<xAOD::CaloClusterContainer> ThinNegativeEnergyCaloClustersAlg::m_caloClustersKey

private

Initial value:

{
    this,
    "CaloClustersKey",
    "CaloCalTopoClusters",
    "StoreGate key for the CaloClustersContainer to be thinned"
  }

Names of the containers to thin.

Definition at line 61 of file ThinNegativeEnergyCaloClustersAlg.h.

                                                                 {
    this,
    "CaloClustersKey",
    "CaloCalTopoClusters",
    "StoreGate key for the CaloClustersContainer to be thinned"
  };

◆ 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_doThinning

BooleanProperty ThinNegativeEnergyCaloClustersAlg::m_doThinning

private

Initial value:

{
    this,
    "ThinNegativeEnergyCaloClusters",
    true,
    "Should the thinning of negative energy calo clusters be run?"
  }

Should the thinning run?

Definition at line 53 of file ThinNegativeEnergyCaloClustersAlg.h.

                              {
    this,
    "ThinNegativeEnergyCaloClusters",
    true,
    "Should the thinning of negative energy calo clusters be run?"
  };

◆ 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_nCaloClustersProcessed

std::atomic<unsigned long> ThinNegativeEnergyCaloClustersAlg::m_nCaloClustersProcessed

mutableprivate

Definition at line 70 of file ThinNegativeEnergyCaloClustersAlg.h.

◆ m_nCaloClustersThinned

std::atomic<unsigned long> ThinNegativeEnergyCaloClustersAlg::m_nCaloClustersThinned

mutableprivate

Definition at line 71 of file ThinNegativeEnergyCaloClustersAlg.h.

◆ m_nEventsProcessed

std::atomic<unsigned long> ThinNegativeEnergyCaloClustersAlg::m_nEventsProcessed

mutableprivate

Counters.

Definition at line 69 of file ThinNegativeEnergyCaloClustersAlg.h.

◆ m_streamName

StringProperty ThinNegativeEnergyCaloClustersAlg::m_streamName

private

Initial value:

{
    this,
    "StreamName",
    "",
    "Name of the stream for which thinning is being done."
  }

Definition at line 45 of file ThinNegativeEnergyCaloClustersAlg.h.

                             {
    this,
    "StreamName",
    "",
    "Name of the stream for which thinning is being done."
  };

◆ 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:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ ThinNegativeEnergyCaloClustersAlg()

◆ ~ThinNegativeEnergyCaloClustersAlg()

Member Function Documentation

◆ cardinality()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_caloClustersKey

◆ m_detStore

◆ m_doThinning

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_nCaloClustersProcessed

◆ m_nCaloClustersThinned

◆ m_nEventsProcessed

◆ m_streamName

◆ m_varHandleArraysDeclared

◆ m_vhka