IDC_OverlayBase.icc

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
/// @author Tadej Novak
/// @author Christos Anastopoulos DataPool strategy
/// @author Andrei Gaponenko <agaponenko@lbl.gov>, 2006-2009
 
#include <Identifier/Identifier.h>
#include <Identifier/IdentifierHash.h>
 
#include "AthContainers/OwnershipPolicy.h"
 
#include "IDC_OverlayCommon.h"
 
template <bool sortCollections, bool usePool, typename Type, typename IDC_Container>
StatusCode IDC_OverlayBase::overlayContainerImpl(
    const IDC_Container *bkgContainer,
    const IDC_Container *signalContainer,
    IDC_Container *outputContainer,
    DataPool<Type> *dataItems) const
{
 
  ATH_MSG_DEBUG("overlayContainer<>() begin");
  typedef typename IDC_Container::base_value_type Collection;
 
  // There are some use cases where background is empty
  if (!bkgContainer) {
    // Only loop through the signal collections and copy them over
    for (const auto &[hashId, ptr] : signalContainer->GetAllHashPtrPair()) {
      // Copy the signal collection
      std::unique_ptr<Collection> signalCollection = nullptr;
      if constexpr (usePool){
        signalCollection = Overlay::copyCollection(hashId, ptr, *dataItems);
      } else {
        signalCollection = Overlay::copyCollection(hashId, ptr);
      }
      if (outputContainer->addCollection(signalCollection.get(), hashId).isFailure()) {
        ATH_MSG_ERROR("Adding signal Collection with hashId " << hashId << " failed");
        return StatusCode::FAILURE;
      } else {
        //coverity[RESOURCE_LEAK]
        (void)signalCollection.release();
      }
    }
 
    return StatusCode::SUCCESS;
  }
 
 
  // The MC signal container should typically be smaller than bkgContainer,
  // because the latter contains all the noise, minimum bias and pile up.
  // Thus we firstly iterate over signal hashes and store them in a map.
  std::vector < std::pair<IdentifierHash, bool> > overlapMap;
  overlapMap.reserve(signalContainer->numberOfCollections());
  for (const auto &[hashId, ptr] : signalContainer->GetAllHashPtrPair()) {
    overlapMap.emplace_back(hashId, false);
  }
 
  // Now loop through the background hashes and copy unique ones over
  for (const auto &[hashId, ptr] : bkgContainer->GetAllHashPtrPair()) {
    auto search = std::lower_bound( overlapMap.begin(), overlapMap.end(), hashId,
       [](const std::pair<IdentifierHash, bool> &lhs,  IdentifierHash rhs) -> bool { return lhs.first < rhs; } );
    if (search == overlapMap.end() || search->first != hashId) {
      // Copy the background collection
      std::unique_ptr<Collection> bkgCollection = nullptr;
      if constexpr (usePool) {
        bkgCollection = Overlay::copyCollection(hashId, ptr, *dataItems);
      } else {
        bkgCollection = Overlay::copyCollection(hashId, ptr);
      }
      if (outputContainer->addCollection(bkgCollection.get(), hashId).isFailure()) {
        ATH_MSG_ERROR("Adding background Collection with hashId " << hashId << " failed");
        return StatusCode::FAILURE;
      } else {
        //coverity[RESOURCE_LEAK]
        (void)bkgCollection.release();
      }
    } else {
      // Flip the overlap flag
      search->second = true;
    }
  }
 
  // Finally loop through the map and process the signal and overlay if
  // necessary
  for (const auto &[hashId, overlap] : overlapMap) {
    // Copy the signal collection
    std::unique_ptr<Collection> signalCollection = nullptr;
    if constexpr (usePool) {
      signalCollection = Overlay::copyCollection(
          hashId, signalContainer->indexFindPtr(hashId), *dataItems);
    } else {
      signalCollection = Overlay::copyCollection(
          hashId, signalContainer->indexFindPtr(hashId));
    }
 
    if (overlap) { // Do overlay
      // Create the output collection, only works for Inner Detector
      auto outputCollection = std::make_unique<Collection>(hashId);
      outputCollection->setIdentifier(signalCollection->identify());
      if constexpr (usePool) {
        // if we use pool the output is also to go to the pool
        outputCollection->clear(SG::VIEW_ELEMENTS);
      }
      // Copy the background collection
      // Merge collections
      std::unique_ptr<Collection> bkgCollection = nullptr;
      if constexpr (usePool) {
        bkgCollection = Overlay::copyCollection(
            hashId, bkgContainer->indexFindPtr(hashId), *dataItems);
        if constexpr (sortCollections) {
          Overlay::mergeSortedCollections(bkgCollection.get(), signalCollection.get(),
                                          outputCollection.get(), this, *dataItems);
        } else {
          Overlay::mergeCollections(bkgCollection.get(), signalCollection.get(),
                                    outputCollection.get(), this, *dataItems);
        }
      } else {
        bkgCollection =
            Overlay::copyCollection(hashId, bkgContainer->indexFindPtr(hashId));
        Overlay::mergeCollections(bkgCollection.get(), signalCollection.get(),
                                  outputCollection.get(), this);
      }
      if (outputContainer->addCollection(outputCollection.get(), hashId).isFailure()) {
        ATH_MSG_ERROR("Adding overlaid Collection with hashId " << hashId << " failed");
        return StatusCode::FAILURE;
      } else {
        //coverity[RESOURCE_LEAK]
        std::ignore = outputCollection.release();
      }
    } else { // Only write signal out
      if (outputContainer->addCollection(signalCollection.get(), hashId).isFailure()) {
        ATH_MSG_ERROR("Adding signal Collection with hashId " << hashId << " failed");
        return StatusCode::FAILURE;
      } else {
        //coverity[RESOURCE_LEAK]
        (void)signalCollection.release();
      }
    }
  }
  return StatusCode::SUCCESS;
}
 
template <typename IDC_Container>
StatusCode IDC_OverlayBase::overlayContainer(const IDC_Container *bkgContainer,
                                             const IDC_Container *signalContainer,
                                             IDC_Container *outputContainer) const
{
  return overlayContainerImpl<false, false, void>(
    bkgContainer, signalContainer, outputContainer, nullptr);
}
 
template <typename IDC_Container, typename Type>
StatusCode IDC_OverlayBase::overlayContainer(const IDC_Container *bkgContainer,
                                             const IDC_Container *signalContainer,
                                             IDC_Container *outputContainer,
                                             DataPool<Type>& dataItems) const
{
  return overlayContainerImpl<false, true>(
    bkgContainer, signalContainer, outputContainer, &dataItems);
}
 
template <typename IDC_Container, typename Type>
StatusCode IDC_OverlayBase::overlayContainerWithSorting(const IDC_Container *bkgContainer,
                                                        const IDC_Container *signalContainer,
                                                        IDC_Container *outputContainer,
                                                        DataPool<Type>& dataItems) const
{
  return overlayContainerImpl<true, true>(
    bkgContainer, signalContainer, outputContainer, &dataItems);
}