algorithms/calorimetry/CalorimeterHitsMerger.h

0001 // SPDX-License-Identifier: LGPL-3.0-or-later
0002 // Copyright (C) 2022 - 2025 Chao Peng, Jihee Kim, Sylvester Joosten, Whitney Armstrong, Wouter Deconinck, David Lawrence, Derek Anderson
0003
0004 /*
0005  *  An algorithm to group readout hits from a calorimeter
0006  *  Energy is summed
0007  *
0008  *  Author: Chao Peng (ANL), 03/31/2021
0009  */
0010
0011 #pragma once
0012
0013 #include <DD4hep/Detector.h>
0014 #include <DD4hep/IDDescriptor.h>
0015 #include <DDRec/CellIDPositionConverter.h>
0016 #include <Parsers/Primitives.h>
0017 #include <algorithms/algorithm.h>
0018 #include <algorithms/geo.h>
0019 #include <edm4eic/CalorimeterHitCollection.h>
0020 #include <stdint.h>
0021 #include <cstddef>
0022 #include <functional>
0023 #include <gsl/pointers>
0024 #include <map>
0025 #include <string>
0026 #include <string_view>
0027 #include <unordered_map>
0028 #include <utility>
0029 #include <vector>
0030
0031 #include "CalorimeterHitsMergerConfig.h"
0032 #include "algorithms/interfaces/WithPodConfig.h"
0033
0034 namespace eicrecon {
0035
0036 // aliases for convenience
0037 using MergeMap = std::unordered_map<uint64_t, std::vector<std::size_t>>;
0038 using RefField = std::pair<std::string, int>;
0039 using MapFunc  = std::function<int(const edm4eic::CalorimeterHit&)>;
0040
0041 using CalorimeterHitsMergerAlgorithm =
0042     algorithms::Algorithm<algorithms::Input<edm4eic::CalorimeterHitCollection>,
0043                           algorithms::Output<edm4eic::CalorimeterHitCollection>>;
0044
0045 class CalorimeterHitsMerger : public CalorimeterHitsMergerAlgorithm,
0046                               public WithPodConfig<CalorimeterHitsMergerConfig> {
0047
0048 public:
0049   CalorimeterHitsMerger(std::string_view name)
0050       : CalorimeterHitsMergerAlgorithm{name,
0051                                        {"inputHitCollection"},
0052                                        {"outputHitCollection"},
0053                                        "Group readout hits from a calorimeter."} {}
0054
0055   void init() final;
0056   void process(const Input&, const Output&) const final;
0057
0058 private:
0059   uint64_t ref_mask{0};
0060
0061 private:
0062   mutable std::map<std::string, MapFunc> ref_maps;
0063   dd4hep::IDDescriptor id_desc;
0064   dd4hep::BitFieldCoder* id_decoder;
0065
0066 private:
0067   const dd4hep::Detector* m_detector{algorithms::GeoSvc::instance().detector()};
0068   const dd4hep::rec::CellIDPositionConverter* m_converter{
0069       algorithms::GeoSvc::instance().cellIDPositionConverter()};
0070
0071 private:
0072   void build_merge_map(const edm4eic::CalorimeterHitCollection* in_hits, MergeMap& merge_map) const;
0073 };
0074
0075 } // namespace eicrecon