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 <iterator>
0025 #include <map>
0026 #include <string>
0027 #include <string_view>
0028 #include <unordered_map>
0029 #include <utility>
0030 #include <vector>
0031
0032 #include "CalorimeterHitsMergerConfig.h"
0033 #include "algorithms/interfaces/WithPodConfig.h"
0034
0035 namespace eicrecon {
0036
0037 // aliases for convenience
0038 using MergeMap = std::unordered_map<uint64_t, std::vector<std::size_t>>;
0039 using RefField = std::pair<std::string, int>;
0040 using MapFunc  = std::function<int(const edm4eic::CalorimeterHit&)>;
0041
0042 using CalorimeterHitsMergerAlgorithm =
0043     algorithms::Algorithm<algorithms::Input<edm4eic::CalorimeterHitCollection>,
0044                           algorithms::Output<edm4eic::CalorimeterHitCollection>>;
0045
0046 class CalorimeterHitsMerger : public CalorimeterHitsMergerAlgorithm,
0047                               public WithPodConfig<CalorimeterHitsMergerConfig> {
0048
0049 public:
0050   CalorimeterHitsMerger(std::string_view name)
0051       : CalorimeterHitsMergerAlgorithm{name,
0052                                        {"inputHitCollection"},
0053                                        {"outputHitCollection"},
0054                                        "Group readout hits from a calorimeter."} {}
0055
0056   void init() final;
0057   void process(const Input&, const Output&) const final;
0058
0059 private:
0060   uint64_t ref_mask{0};
0061
0062 private:
0063   mutable std::map<std::string, MapFunc> ref_maps;
0064   dd4hep::IDDescriptor id_desc;
0065   dd4hep::BitFieldCoder* id_decoder;
0066
0067 private:
0068   const dd4hep::Detector* m_detector{algorithms::GeoSvc::instance().detector()};
0069   const dd4hep::rec::CellIDPositionConverter* m_converter{
0070       algorithms::GeoSvc::instance().cellIDPositionConverter()};
0071
0072 private:
0073   void build_merge_map(const edm4eic::CalorimeterHitCollection* in_hits, MergeMap& merge_map) const;
0074 };
0075
0076 } // namespace eicrecon