IsolationBuilder.h

Go to the documentation of this file.

 
/*
  Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
*/
 
// IsolationBuilder.h
// Header file for class IsolationBuilder
#ifndef ISOLATIONALGS_ISOLATIONBUILDER_H
#define ISOLATIONALGS_ISOLATIONBUILDER_H 1
 
// STL includes
#include <set>
#include <string>
#include <utility>
#include <vector>
 
// FrameWork includes
#include "AthContainers/AuxElement.h"
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
#include "GaudiKernel/ToolHandle.h"
#include "StoreGate/ReadHandleKey.h"
#include "StoreGate/WriteDecorHandle.h"
#include "StoreGate/WriteDecorHandleKey.h"
#include "StoreGate/WriteDecorHandleKeyArray.h"
 
#include "RecoToolInterfaces/IsolationCommon.h"
#include "xAODPrimitives/IsolationFlavour.h"
#include "xAODPrimitives/IsolationType.h"
 
#include "IsolationCorrections/IIsolationCorrectionTool.h"
#include "xAODBase/IParticleContainer.h"
#include "xAODPrimitives/IsolationConeSize.h"
#include "xAODPrimitives/IsolationHelpers.h"
 
#include "RecoToolInterfaces/ICaloCellIsolationTool.h"
#include "RecoToolInterfaces/ICaloTopoClusterIsolationTool.h"
#include "RecoToolInterfaces/INeutralEFlowIsolationTool.h"
#include "RecoToolInterfaces/ITrackIsolationTool.h"
 
#include "CaloEvent/CaloCellContainer.h"
 
class IsolationBuilder : public AthReentrantAlgorithm
{

  // Public methods:
public:
  // Copy constructor:

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

  virtual ~IsolationBuilder();
 
  // Athena algorithm's Hooks
  virtual StatusCode initialize() override final;
  virtual StatusCode execute(const EventContext& ctx) const override final;
  virtual StatusCode finalize() override final;

  // Private data:
private:
  IsolationBuilder();

  Gaudi::Property<std::string> m_ElectronContainerName{
    this,
    "ElectronCollectionContainerName",
    "Electrons"
  };
 
  Gaudi::Property<std::string> m_FwdElectronContainerName{
    this,
    "FwdElectronCollectionContainerName",
    "ForwardElectrons"
  };
 
  Gaudi::Property<std::string> m_PhotonContainerName{
    this,
    "PhotonCollectionContainerName",
    "Photons"
  };
 
  Gaudi::Property<std::string> m_MuonContainerName{
    this,
    "MuonCollectionContainerName",
    "Muons"
  };

  ToolHandle<xAOD::ICaloCellIsolationTool> m_cellIsolationTool{
    this,
    "CaloCellIsolationTool",
    "",
    "Handle of the calo cell IsolationTool"
  };

  SG::ReadHandleKey<CaloCellContainer> m_cellsKey{
    this,
    "CellCollectionName",
    "AllCalo",
    "Name of container which contain calo cells"
  };

  ToolHandle<xAOD::ICaloTopoClusterIsolationTool> m_topoIsolationTool{
    this,
    "CaloTopoIsolationTool",
    "",
    "Handle of the calo topo IsolationTool"
  };

  ToolHandle<xAOD::INeutralEFlowIsolationTool> m_pflowIsolationTool{
    this,
    "PFlowIsolationTool",
    "",
    "Handle of the pflow IsolationTool"
  };

  ToolHandle<xAOD::ITrackIsolationTool> m_trackIsolationTool{
    this,
    "TrackIsolationTool",
    "",
    "Handle of the track IsolationTool"
  };

  Gaudi::Property<bool> m_isTrigger{ this, "IsTrigger", false };
 
  // FIXME:  need to add the electron bremAssoc stuff
  Gaudi::Property<bool> m_useBremAssoc{ this,
                                        "useBremAssoc",
                                        true,
                                        "use track to track assoc after brem" };
 
  Gaudi::Property<bool> m_allTrackRemoval{ this, "AllTrackRemoval", true };
 
  Gaudi::Property<bool> m_storepileupCorrection{ this, "storepileupCorrection", false };

  Gaudi::Property<std::vector<std::vector<int>>> m_elisoInts{
    this,
    "ElIsoTypes",
    {},
    "The isolation types to do for electrons: vector of vector of enum type "
    "Iso::IsolationType"
  };
 
  Gaudi::Property<std::vector<std::vector<int>>> m_elcorInts{
    this,
    "ElCorTypes",
    {},
    "The correction types to do for electron iso: vector of vector of enum "
    "type Iso::IsolationCalo/TrackCorrection"
  };
 
  Gaudi::Property<std::vector<std::vector<int>>> m_elcorIntsExtra{
    this,
    "ElCorTypesExtra",
    {},
    "The extra correction types to store but not apply for electrons"
  };

  Gaudi::Property<std::vector<std::vector<int>>> m_phisoInts{
    this,
    "PhIsoTypes",
    {},
    "The isolation types to do for photons: vector of vector of enum type "
    "Iso::IsolationType"
  };
 
  Gaudi::Property<std::vector<std::vector<int>>> m_phcorInts{
    this,
    "PhCorTypes",
    {},
    "The correction types to do for photons iso: vector of vector of enum type "
    "Iso::IsolationCalo/TrackCorrection"
  };
 
  Gaudi::Property<std::vector<std::vector<int>>> m_phcorIntsExtra{
    this,
    "PhCorTypesExtra",
    {},
    "The extra correction types to store but not apply for photons"
  };
 
  Gaudi::Property<std::vector<std::vector<int>>> m_muisoInts{
    this,
    "MuIsoTypes",
    {},
    "The isolation types to do for Muons : vector of vector of enum type "
    "Iso::IsolationType"
  };
 
  Gaudi::Property<std::vector<std::vector<int>>> m_mucorInts{
    this,
    "MuCorTypes",
    {},
    "The correction types to do for Muon iso: vector of vector of enum type "
    "Iso::IsolationCalo/TrackCorrection"
  };
 
  Gaudi::Property<std::vector<std::vector<int>>> m_mucorIntsExtra{
    this,
    "MuCorTypesExtra",
    {},
    "The extra correction types to store but not apply for muons"
  };
 
  Gaudi::Property<std::vector<std::vector<int>>> m_feisoInts{
    this,
    "FeIsoTypes",
    {},
    "The isolation types to do for forward electron: vector of vector of enum "
    "type Iso::IsolationType"
  };
 
  Gaudi::Property<std::vector<std::vector<int>>> m_fecorInts{
    this,
    "FeCorTypes",
    {},
    "The correction types to do for forward electron iso: vector of vector of "
    "enum type Iso::IsolationCalo/TrackCorrection"
  };
 
  Gaudi::Property<std::vector<std::vector<int>>> m_fecorIntsExtra{
    this,
    "FeCorTypesExtra",
    {},
    "The extra correction types to store but not apply for forward electrons"
  };
 
  struct CaloIsoHelpKey
  {
    CaloIsoHelpKey(IDataHandleHolder* owningAlg);

    void declare(IDataHandleHolder* owningAlg);

    SG::WriteDecorHandleKeyArray<xAOD::IParticleContainer> isoDeco;

    std::map<xAOD::Iso::IsolationCaloCorrection,
             SG::WriteDecorHandleKey<xAOD::IParticleContainer>>
      coreCorDeco;

    std::map<xAOD::Iso::IsolationCaloCorrection,
             SG::WriteDecorHandleKeyArray<xAOD::IParticleContainer>>
      noncoreCorDeco;

    std::vector<xAOD::Iso::IsolationType> isoTypes;

    xAOD::CaloCorrection CorrList;
    // xAOD::CaloCorrection CorrListExtra; // should ideally pass this, but not
    // possible yet
    SG::WriteDecorHandleKey<xAOD::IParticleContainer> corrBitsetDeco;
  };
 
  std::vector<std::pair<xAOD::Iso::IsolationFlavour, CaloIsoHelpKey>>
    m_elCaloIso;
  std::vector<std::pair<xAOD::Iso::IsolationFlavour, CaloIsoHelpKey>>
    m_phCaloIso;
  std::vector<std::pair<xAOD::Iso::IsolationFlavour, CaloIsoHelpKey>>
    m_feCaloIso;
  std::vector<std::pair<xAOD::Iso::IsolationFlavour, CaloIsoHelpKey>>
    m_muCaloIso;
 
  struct TrackIsoHelpKey
  {
    TrackIsoHelpKey(IDataHandleHolder* owningAlg);

    void declare(IDataHandleHolder* owningAlg);

    SG::WriteDecorHandleKeyArray<xAOD::IParticleContainer> isoDeco;
    SG::WriteDecorHandleKeyArray<xAOD::IParticleContainer> isoDecoV;

    std::map<xAOD::Iso::IsolationTrackCorrection,
             SG::WriteDecorHandleKey<xAOD::IParticleContainer>>
      coreCorDeco;

    std::vector<xAOD::Iso::IsolationType> isoTypes;

    xAOD::TrackCorrection CorrList;
    // xAOD::TrackCorrection CorrListExtra; // should ideally pass this, but not
    // possible yet
    SG::WriteDecorHandleKey<xAOD::IParticleContainer> corrBitsetDeco;
  };
 
  std::vector<std::pair<xAOD::Iso::IsolationFlavour, TrackIsoHelpKey>>
    m_elTrackIso;
  std::vector<std::pair<xAOD::Iso::IsolationFlavour, TrackIsoHelpKey>>
    m_phTrackIso;
  std::vector<std::pair<xAOD::Iso::IsolationFlavour, TrackIsoHelpKey>>
    m_muTrackIso;
 
  struct CaloIsoHelpHandles
  {
 
    CaloIsoHelpHandles(const CaloIsoHelpKey& keys);
 
    std::vector<SG::WriteDecorHandle<xAOD::IParticleContainer, float>> isoDeco;
    std::map<xAOD::Iso::IsolationCaloCorrection,
             SG::WriteDecorHandle<xAOD::IParticleContainer, float>>
      coreCorDeco;
    std::map<xAOD::Iso::IsolationCaloCorrection,
             std::vector<SG::WriteDecorHandle<xAOD::IParticleContainer, float>>>
      noncoreCorDeco;
    SG::WriteDecorHandle<xAOD::IParticleContainer, uint32_t> corrBitsetDeco;
  };
 
  struct TrackIsoHelpHandles
  {
 
    TrackIsoHelpHandles(const TrackIsoHelpKey& keys);
 
    std::vector<SG::WriteDecorHandle<xAOD::IParticleContainer, float>> isoDeco;
    std::vector<SG::WriteDecorHandle<xAOD::IParticleContainer, float>> isoDecoV;
    std::map<xAOD::Iso::IsolationTrackCorrection,
             SG::WriteDecorHandle<xAOD::IParticleContainer, float>>
      coreCorDeco;
    SG::WriteDecorHandle<xAOD::IParticleContainer, uint32_t> corrBitsetDeco;
  };
 
  // for the time being, only mu vs eg, no separation in eg
  Gaudi::Property<std::string> m_customConfigEl{
    this,
    "CustomConfigurationNameEl",
    "",
    "use a custom configuration for electron"
  };
 
  Gaudi::Property<std::string> m_customConfigPh{
    this,
    "CustomConfigurationNamePh",
    "",
    "use a custom configuration for photon"
  };
 
  Gaudi::Property<std::string> m_customConfigFwd{
    this,
    "CustomConfigurationNameFwd",
    "",
    "use a custom configuration for forward electron"
  };
 
  Gaudi::Property<std::string> m_customConfigMu{
    this,
    "CustomConfigurationNameMu",
    "",
    "use a custom configuration for muon"
  };
 
  static bool isCoreCor(xAOD::Iso::IsolationCaloCorrection corr);

  StatusCode initializeIso(
    std::set<xAOD::Iso::IsolationFlavour>& runIsoType, // out
    std::vector<std::pair<xAOD::Iso::IsolationFlavour, CaloIsoHelpKey>>*
      caloIsoMap, // out
    std::vector<std::pair<xAOD::Iso::IsolationFlavour, TrackIsoHelpKey>>*
      trackIsoMap, // out
    const std::string& containerName,
    const std::vector<std::vector<int>>& isoInts,
    const std::vector<std::vector<int>>& corInts,
    const std::vector<std::vector<int>>& corIntsExtra,
    const std::string& customConfig);

  StatusCode addCaloIsoCorrections(size_t flavor,
                                   xAOD::Iso::IsolationFlavour isoFlav,
                                   CaloIsoHelpKey& cisoH, // in-out
                                   const std::vector<std::vector<int>>& corInts,
                                   bool corrsAreExtra,
                                   const std::string& prefix,
                                   const std::string& customConfig);

  StatusCode addTrackIsoCorrections(
    size_t flavor,
    xAOD::Iso::IsolationFlavour isoFlav,
    TrackIsoHelpKey& tisoH, // in-out
    const std::vector<std::vector<int>>& corInts,
    bool corrsAreExtra,
    const std::string& prefix,
    const std::string& customConfig);
 
  StatusCode executeCaloIso(
    const std::vector<std::pair<xAOD::Iso::IsolationFlavour, CaloIsoHelpKey>>&
      caloIsoMap,
    const CaloCellContainer* cellColl) const;
 
  StatusCode executeTrackIso(
    const std::vector<std::pair<xAOD::Iso::IsolationFlavour, TrackIsoHelpKey>>&
      trackIsoMap) const;
 
  void declareIso(
    std::vector<std::pair<xAOD::Iso::IsolationFlavour, CaloIsoHelpKey>>&
      caloIso);
  void declareIso(
    std::vector<std::pair<xAOD::Iso::IsolationFlavour, TrackIsoHelpKey>>&
      trackIso);
};
 
#endif //> !ISOLATIONALGS_ISOLATIONBUILDER_H