Athena Algorithm that merges a given set of CaloCalibrationHitContainers into a single CaloCalibrationHitContainers - based on CollectionMerger by Elmar Ritsch. More...

#include <CalibrationHitMerger.h>

Inheritance diagram for LArG4::CalibrationHitMerger:

Collaboration diagram for LArG4::CalibrationHitMerger:

Classes
class	LessHit

Public Member Functions
	CalibrationHitMerger (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor.
virtual	~CalibrationHitMerger ()=default
	Destructor.
virtual StatusCode	initialize () override final
	Athena algorithm's interface methods.
virtual StatusCode	execute () override final
	Athena Algorithm execute.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

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 std::set< CaloCalibrationHit *, LessHit >	calibrationHits_t
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	initializeVarHandleKey (SG::VarHandleKey &varHandleKey) const
	Initialize the given VarHandleKey.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadHandleKeyArray< CaloCalibrationHitContainer >	m_inputHits {this, "InputHits", {}, "Input collection ReadHandleKeys"}
SG::WriteHandleKey< CaloCalibrationHitContainer >	m_outputHits {this, "OutputHits", "", "Output collection WriteHandleKeys"}
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Athena Algorithm that merges a given set of CaloCalibrationHitContainers into a single CaloCalibrationHitContainers - based on CollectionMerger by Elmar Ritsch.

Definition at line 26 of file CalibrationHitMerger.h.

Member Typedef Documentation

◆ calibrationHits_t

typedef std::set< CaloCalibrationHit*, LessHit > LArG4::CalibrationHitMerger::calibrationHits_t

private

Definition at line 49 of file CalibrationHitMerger.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ CalibrationHitMerger()

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

Constructor.

Definition at line 8 of file CalibrationHitMerger.cxx.

                                                                                                 :
  ::AthAlgorithm( name, pSvcLocator )
{}

◆ ~CalibrationHitMerger()

virtual LArG4::CalibrationHitMerger::~CalibrationHitMerger ( )

virtualdefault

Destructor.

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< 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< 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< 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< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< 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< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode LArG4::CalibrationHitMerger::execute ( )

finaloverridevirtual

Athena Algorithm execute.

Definition at line 22 of file CalibrationHitMerger.cxx.

{
  // skip if not input collection
  if ( m_inputHits.empty() ) {
    return StatusCode::SUCCESS;
  }
  // TODO: is there a way to conveniently get the total number of hits in all m_inputHits
  //       and reserve the corresponding size in the outputHandle
  SG::WriteHandle<CaloCalibrationHitContainer> outputHandle{m_outputHits};
  ATH_CHECK( outputHandle.record(std::make_unique<CaloCalibrationHitContainer>()) );
  calibrationHits_t calibrationHits;
  unsigned int nHitsMerged(0);
  for ( const auto& collKey: m_inputHits ) {
    SG::ReadHandle<CaloCalibrationHitContainer> inputHandle{collKey};
    ATH_MSG_DEBUG(inputHandle.name() << " has " << inputHandle->size() << " hits.");
    for ( const CaloCalibrationHit* hit: *inputHandle ) {
      // If we haven't had a hit in this cell before, create one and add
      // it to the hit collection.
 
      // If we've had a hit in this cell before, then add the energy to
      // the existing hit.
 
      // Look for the key in the hitCollection (this is a binary search).
      auto bookmark = calibrationHits.lower_bound(hit);
 
      // The lower_bound method of a map finds the first element
      // whose key is not less than the identifier.  If this element
      // == our hit, we've found a match.
 
      // Reminders:
      // bookmark = iterator (pointer) into the hitCollection set.
      // (*bookmark) = a member of the set, which is a LArG4Hit*.
 
      // Equals() is a function defined in LArG4Hit.h; it has the value of
      // "true" when a LArG4Hit* points to the same identifier.
 
      if (bookmark == calibrationHits.end() ||
          !(*bookmark)->Equals(hit)) {
        auto&& hitCopy = std::make_unique<CaloCalibrationHit>(*hit);
        // We haven't had a hit in this readout cell before.  Add it
        // to our set.
        if (calibrationHits.empty() ||
            bookmark == calibrationHits.begin()) {
          // Insert the hit before the first entry in the map.
          calibrationHits.insert(hitCopy.release());
        } else {
          // We'just done a binary search of hitCollection, so we should use
          // the results of that search to speed up the insertion of a new
          // hit into the map.  The "insert" method is faster if the new
          // entry is right _after_ the bookmark.  If we left bookmark
          // unchanged, the new entry would go right _before_ the
          // bookmark.  We therefore want to decrement the bookmark from
          // the lower_bound search.
          calibrationHits.insert(--bookmark, hitCopy.release());
        }
      } else {
        ++nHitsMerged;
        // Update the existing hit.
        (*bookmark)->Add(hit);
      }
    }
  }
 
  // Loop through the hits...
  for(auto *hit : calibrationHits)
  {
    // Can we actually do this with move?
    outputHandle->push_back(hit);
  } // End of loop over hits
  // Clean up
  calibrationHits.clear();
  ATH_MSG_DEBUG(outputHandle.name() << " has " << outputHandle->size() << " hits. Merged " << nHitsMerged << " hits.");
  return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ initialize()

StatusCode LArG4::CalibrationHitMerger::initialize ( )

finaloverridevirtual

Athena algorithm's interface methods.

Athena Algorithm initialize.

Definition at line 13 of file CalibrationHitMerger.cxx.

{
  ATH_CHECK(m_inputHits.initialize());
  ATH_CHECK(m_outputHits.initialize());
  return StatusCode::SUCCESS;
}

◆ initializeVarHandleKey()

StatusCode LArG4::CalibrationHitMerger::initializeVarHandleKey ( SG::VarHandleKey & varHandleKey ) const

private

Initialize the given VarHandleKey.

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< 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.

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< 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< 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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< 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< 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< 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< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_inputHits

SG::ReadHandleKeyArray<CaloCalibrationHitContainer> LArG4::CalibrationHitMerger::m_inputHits {this, "InputHits", {}, "Input collection ReadHandleKeys"}

private

Definition at line 54 of file CalibrationHitMerger.h.

54{this, "InputHits", {}, "Input collection ReadHandleKeys"};

◆ m_outputHits

SG::WriteHandleKey<CaloCalibrationHitContainer> LArG4::CalibrationHitMerger::m_outputHits {this, "OutputHits", "", "Output collection WriteHandleKeys"}

private

Definition at line 56 of file CalibrationHitMerger.h.

56{this, "OutputHits", "", "Output collection WriteHandleKeys"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

The documentation for this class was generated from the following files:

Classes

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ calibrationHits_t

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ CalibrationHitMerger()

◆ ~CalibrationHitMerger()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ initialize()

◆ initializeVarHandleKey()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_inputHits

◆ m_outputHits

◆ m_varHandleArraysDeclared

◆ m_vhka