CalorimeterClusterRecoCoG.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-or-later
// Copyright (C) 2022 Sylvester Joosten, Chao, Chao Peng, Whitney Armstrong
 
/*
 *  Reconstruct the cluster with Center of Gravity method
 *  Logarithmic weighting is used for mimicking energy deposit in transverse direction
 *
 *  Author: Chao Peng (ANL), 09/27/2020
 */
 
#pragma once
 
#include <algorithms/algorithm.h>
#include <edm4eic/ClusterCollection.h>
#include <edm4eic/EDM4eicVersion.h>
#include <edm4hep/CaloHitContribution.h>
#include <edm4hep/MCParticle.h>
#include <edm4eic/MCRecoCalorimeterHitAssociationCollection.h>
#if EDM4EIC_BUILD_VERSION >= EDM4EIC_VERSION(8, 7, 0)
#include <edm4eic/MCRecoCalorimeterHitLinkCollection.h>
#include <podio/LinkNavigator.h>
#endif
#include <edm4eic/MCRecoClusterParticleAssociationCollection.h>
#include <edm4eic/ProtoClusterCollection.h>
#include <algorithm>
#include <cmath>
#include <functional>
#include <map>
#include <memory>
#include <optional>
#include <string>
#include <string_view>
#include <utility>
 
#include "CalorimeterClusterRecoCoGConfig.h"
#include "algorithms/interfaces/WithPodConfig.h"
 
#if EDM4EIC_BUILD_VERSION >= EDM4EIC_VERSION(8, 7, 0)
#include <edm4eic/MCRecoClusterParticleLinkCollection.h>
#endif
 
static double constWeight(double /*E*/, double /*tE*/, double /*p*/, int /*type*/) { return 1.0; }
static double linearWeight(double E, double /*tE*/, double /*p*/, int /*type*/) { return E; }
static double logWeight(double E, double tE, double base, int /*type*/) {
  return std::max(0., base + std::log(E / tE));
}
 
static const std::map<std::string, std::function<double(double, double, double, int)>>
    weightMethods = {
        {"none", constWeight},
        {"linear", linearWeight},
        {"log", logWeight},
};
 
namespace eicrecon {
 
using ClustersWithAssociations =
    std::pair<std::unique_ptr<edm4eic::ClusterCollection>,
              std::unique_ptr<edm4eic::MCRecoClusterParticleAssociationCollection>>;
 
using CalorimeterClusterRecoCoGAlgorithm = algorithms::Algorithm<
    algorithms::Input<edm4eic::ProtoClusterCollection,
#if EDM4EIC_BUILD_VERSION >= EDM4EIC_VERSION(8, 7, 0)
                      std::optional<edm4eic::MCRecoCalorimeterHitLinkCollection>,
#endif
                      std::optional<edm4eic::MCRecoCalorimeterHitAssociationCollection>>,
    algorithms::Output<edm4eic::ClusterCollection,
#if EDM4EIC_BUILD_VERSION >= EDM4EIC_VERSION(8, 7, 0)
                       std::optional<edm4eic::MCRecoClusterParticleLinkCollection>,
#endif
                       std::optional<edm4eic::MCRecoClusterParticleAssociationCollection>>>;
 
class CalorimeterClusterRecoCoG : public CalorimeterClusterRecoCoGAlgorithm,
                                  public WithPodConfig<CalorimeterClusterRecoCoGConfig> {
 
public:
  CalorimeterClusterRecoCoG(std::string_view name)
      : CalorimeterClusterRecoCoGAlgorithm{
            name,
            {"inputProtoClusterCollection",
#if EDM4EIC_BUILD_VERSION >= EDM4EIC_VERSION(8, 7, 0)
             "mcRawHitLinks",
#endif
             "mcRawHitAssocations"},
            {"outputClusterCollection",
#if EDM4EIC_BUILD_VERSION >= EDM4EIC_VERSION(8, 7, 0)
             "outputLinks",
#endif
             "outputAssociations"},
            "Reconstruct a cluster with the Center of Gravity method. For "
            "simulation results it optionally creates a Cluster <-> MCParticle "
            "association provided both optional arguments are provided."} {
  }
 
public:
  void init() final;
 
  void process(const Input&, const Output&) const final;
 
private:
  std::function<double(double, double, double, int)> weightFunc;
 
private:
  std::optional<edm4eic::MutableCluster> reconstruct(const edm4eic::ProtoCluster& pcl) const;
  void associate(const edm4eic::Cluster& cl,
                 const edm4eic::MCRecoCalorimeterHitAssociationCollection* mchitassociations,
#if EDM4EIC_BUILD_VERSION >= EDM4EIC_VERSION(8, 7, 0)
                 const podio::LinkNavigator<edm4eic::MCRecoCalorimeterHitLinkCollection>& link_nav,
                 edm4eic::MCRecoClusterParticleLinkCollection* links,
#endif
                 edm4eic::MCRecoClusterParticleAssociationCollection* assocs) const;
  static edm4hep::MCParticle get_primary(const edm4hep::CaloHitContribution& contrib);
};
 
} // namespace eicrecon