algorithms/calorimetry/CalorimeterClusterShape.h

0001 // SPDX-License-Identifier: LGPL-3.0-or-later
0002 // Copyright (C) 2025 Chao Peng, Dhevan Gangadharan, Sebouh Paul, Derek Anderson
0003
0004 #pragma once
0005
0006 #include "algorithms/interfaces/WithPodConfig.h"
0007 #include "CalorimeterClusterShapeConfig.h"
0008
0009 #include <algorithms/algorithm.h>
0010 #include <edm4eic/ClusterCollection.h>
0011 #include <edm4eic/MCRecoClusterParticleAssociationCollection.h>
0012 #include <functional>
0013 #include <map>
0014 #include <optional>
0015 #include <string>
0016 #include <string_view>
0017
0018
0019
0020 namespace eicrecon {
0021
0022   // --------------------------------------------------------------------------
0023   //! Algorithm input/output
0024   // --------------------------------------------------------------------------
0025   using CalorimeterClusterShapeAlgorithm = algorithms::Algorithm<
0026     algorithms::Input<
0027       edm4eic::ClusterCollection,
0028       std::optional<edm4eic::MCRecoClusterParticleAssociationCollection>
0029     >,
0030     algorithms::Output<
0031       edm4eic::ClusterCollection,
0032       std::optional<edm4eic::MCRecoClusterParticleAssociationCollection>
0033     >
0034   >;
0035
0036
0037
0038   // --------------------------------------------------------------------------
0039   //! Calculate cluster shapes for provided clusters
0040   // --------------------------------------------------------------------------
0041   /*! An algorithm which takes a collection of clusters,
0042    *  computes their cluster shape parameters, and saves
0043    *  outputs the same clusters with computed parameters.
0044    */
0045   class CalorimeterClusterShape
0046     : public CalorimeterClusterShapeAlgorithm
0047     , public WithPodConfig<CalorimeterClusterShapeConfig>
0048   {
0049
0050     public:
0051
0052       // ctor
0053       CalorimeterClusterShape(std::string_view name) :
0054         CalorimeterClusterShapeAlgorithm {
0055           name,
0056           {"inputClusters", "inputMCClusterAssociations"},
0057           {"outputClusters", "outputMCClusterAssociations"},
0058           "Computes cluster shape parameters"
0059         } {}
0060
0061       // public methods
0062       void init() final;
0063       void process(const Input&, const Output&) const final;
0064
0065     private:
0066
0067       //! constant weighting
0068       static double constWeight(double /*E*/, double /*tE*/, double /*p*/, int /*type*/) {
0069         return 1.0;
0070       }
0071
0072       //! linear weighting by energy
0073       static double linearWeight(double E, double /*tE*/, double /*p*/, int /*type*/) {
0074         return E;
0075       }
0076
0077       //! log weighting by energy
0078       static double logWeight(double E, double tE, double base, int /*type*/) {
0079         return std::max(0., base + std::log(E / tE));
0080       }
0081
0082       //! map of weighting method to function
0083       const std::map<std::string, std::function<double(double, double, double, int)>> m_weightMethods = {
0084         {"none", constWeight},
0085         {"linear", linearWeight},
0086         {"log", logWeight}
0087       };
0088
0089       //! weight function selected by m_cfg.energyWeight
0090       std::function<double(double, double, double, int)> m_weightFunc;
0091
0092   };
0093
0094 }  // namespace eicrecon