GCC Code Coverage Report

Directory: ./
File: src/iguana/algorithms/clas12/PhotonGBTFilter/Algorithm.h
Date: 2025-03-24 18:50:00
Exec Total Coverage
Lines: 1 1 100.0%
Functions: 3 4 75.0%
Branches: 5 12 41.7%
Line Branch Exec Source
1 #pragma once
2
3 #include "iguana/algorithms/Algorithm.h"
4
5 #include <Math/Vector3D.h>
6 #include <Math/VectorUtil.h>
7
8 namespace iguana::clas12 {
9
10 ///
11 /// @brief_algo Filter the `REC::Particle` photons using pretrained GBT models
12 ///
13 /// For each photon (labeled the photon of interest or POI), we obtain its intrinsic features (energy, angle, pcal edep, etc.) and features corresponding to its nearest neighbors (angle of proximity, energy difference, etc.). This requires the reading of both the REC::Particle and REC::Calorimeter banks. An input std::vector<float> is produced and passed to the pretrained GBT models, which yield a classification score between 0 and 1. An option variable `threshold` then determines the minimum photon `p-value` to survive the cut.
14 ///
15 /// @begin_doc_algo{clas12::PhotonGBTFilter | Filter}
16 /// @input_banks{REC::Particle, REC::Calorimeter, RUN::config}
17 /// @output_banks{REC::Particle}
18 /// @end_doc
19 ///
20 /// @begin_doc_config{clas12/PhotonGBTFilter}
21 /// @config_param{pass | int | cook type}
22 /// @config_param{threshold | double | minimum value to qualify a photon as "true"}
23 /// @end_doc
24 class PhotonGBTFilter : public Algorithm
25 {
26
27
5/12
✓ Branch 0 (2→3) taken 2 times.
✗ Branch 1 (2→6) not taken.
✓ Branch 2 (7→8) taken 2 times.
✗ Branch 3 (7→18) not taken.
✓ Branch 4 (8→9) taken 2 times.
✗ Branch 5 (8→11) not taken.
✓ Branch 6 (11→12) taken 2 times.
✗ Branch 7 (11→22) not taken.
✓ Branch 8 (14→15) taken 2 times.
✗ Branch 9 (14→22) not taken.
✗ Branch 10 (18→19) not taken.
✗ Branch 11 (18→21) not taken.
 14 DEFINE_IGUANA_ALGORITHM(PhotonGBTFilter, clas12::PhotonGBTFilter)
28
29 public:
30
31 void Start(hipo::banklist& banks) override;
32 void Run(hipo::banklist& banks) const override;
33 void Stop() override;
34
35 /// Applies forward detector cut using REC::Particle Theta
36 /// @param theta lab angle of the particle with respect to the beam direction (radians)
37 /// @returns `true` if the particle's theta is within the forward detector coverage, `false` otherwise
38 bool ForwardDetectorFilter(float const theta) const;
39
40 private:
41
42 struct calo_row_data {
43 double pcal_x = 0;
44 double pcal_y = 0;
45 double pcal_z = 0;
46 double ecin_x = 0;
47 double ecin_y = 0;
48 double ecin_z = 0;
49 double ecout_x = 0;
50 double ecout_y = 0;
51 double ecout_z = 0;
52 double pcal_e = 0;
53 double pcal_m2u = 0;
54 double pcal_m2v = 0;
55 double ecin_e = 0;
56 double ecin_m2u = 0;
57 double ecin_m2v = 0;
58 double ecout_e = 0;
59 double ecout_m2u = 0;
60 double ecout_m2v = 0;
61 };
62
63 /// Applies pid purity cuts to photons, compatible to how the GBT models are trained
64 /// @param E energy of the photon
65 /// @param Epcal energy the photon has deposited in the pre-shower calorimeter
66 /// @param theta lab angle of the photon with respect to the beam direction (radians)
67 /// @returns `true` if the photon passes the pid purity cuts, `false` otherwise
68 bool PidPurityPhotonFilter(float const E, float const Epcal, float const theta) const;
69
70 /// Classifies the photon for a given event as signal or background
71 /// @param particleBank the REC::Particle hipo bank
72 /// @param caloBank the REC::Calorimeter hipo bank
73 /// @param calo_map the std::map<> of calorimeter data for the event, indexed by pindex
74 /// @param row the row corresponding to the photon being classified
75 /// @param runnum the current run number
76 /// @returns `true` if the photon is to be considered signal, otherwise `false`
77 bool Filter(hipo::bank const &particleBank, hipo::bank const &caloBank, std::map<int, PhotonGBTFilter::calo_row_data> calo_map, int const row, int const runnum) const;
78
79
80 /// Calls the appropriate CatBoost model for the given run group, classifying the photon of interest
81 /// @param input_data the input features of the model
82 /// @param runnum the run number associated to the event
83 /// @returns `true` if the
84 bool ClassifyPhoton(std::vector<float> const &input_data, int const runnum) const;
85
86
87 /// Gets calorimeter data for particles in the event
88 /// @param bank the bank to get data from
89 /// @returns a map with keys as particle indices (pindex) and values as calo_row_data structs
90 std::map<int, PhotonGBTFilter::calo_row_data> GetCaloMap(hipo::bank const &bank) const;
91
92
93 /// Gets the calorimeter vector for a particle in the event
94 /// @param crd data struct of a single REC::Calorimeter's row data
95 /// @returns a ROOT::Math::XYZVector with the coordinates of the particle in the calorimeter
96 ROOT::Math::XYZVector GetParticleCaloVector(PhotonGBTFilter::calo_row_data calo_row) const;
97
98 /// Gets the model function for the run number
99 /// @param runnum the run of the associated event
100 /// @returns GBT function for the run period
101 std::function<double(std::vector<float> const &)> getModelFunction(int runnum) const;
102
103 /// `hipo::banklist`
104 hipo::banklist::size_type b_particle;
105 hipo::banklist::size_type b_calorimeter;
106 hipo::banklist::size_type b_config; // RUN::config
107
108 /// Threshold value for model predictions
109 double o_threshold = 0.78;
110
111 /// Integer for the event reconstruction pass
112 int o_pass = 1;
113
114 /// Map for the GBT Models to use depending on pass and run number
115 static std::map<std::tuple<int, int, int>, std::function<double(std::vector<float> const &)>> const modelMap;
116 };
117
118 }
119