|
1 | 1 | /** |
2 | 2 | * @file sbnobj/Common/Reco/BarycenterMatch.h |
3 | | - * @brief Container for the result of matching reconstructed OpFlashes with Pandora charge slices via the barycenter method |
4 | 3 | * @author Jack Smedley (jsmedley@fnal.gov) |
5 | 4 | * @date June 21, 2023 |
6 | 5 | * |
|
14 | 13 | #define SBNOBJ_COMMON_RECO_BARYCENTERMATCH_H |
15 | 14 |
|
16 | 15 | namespace sbn { |
17 | | - |
| 16 | + /** |
| 17 | + * @brief Information on matching of a reconstructed TPC object with a optical flash via barycenter matching algorithm. |
| 18 | + */ |
18 | 19 | class BarycenterMatch { |
19 | 20 | public: |
20 | 21 |
|
21 | | - /// NaN value to initialize data members |
| 22 | + // NaN value to initialize data members |
22 | 23 | static constexpr float fDefault = std::numeric_limits<float>::signaling_NaN(); |
23 | 24 |
|
24 | | - /// Data members related to the slice barycetner determination |
25 | | - float chargeTotal { fDefault }; ///< Total charge in slice contributing to barycenter |
| 25 | + /// @name Data members related to the slice barycenter determination |
| 26 | + /// @{ |
| 27 | + float chargeTotal { fDefault }; ///< Total charge in slice contributing to barycenter (integrated ADC counts) |
26 | 28 | float chargeCenterXLocal { fDefault }; ///< Weighted mean X position of spacepoints, measured with respect to the cathode (cm) |
27 | 29 | geo::Point_t chargeCenter { fDefault, fDefault, fDefault }; ///< Weighted mean spacepoint position in X,Y,Z (cm) |
28 | 30 | geo::Vector_t chargeWidth { fDefault, fDefault, fDefault }; ///< Weighted standard devitation of spacepoint position in X,Y,Z (cm) |
| 31 | + /// @} |
| 32 | + |
29 | 33 |
|
30 | | - /// Data members related to matched recob::OpFlash, also reachable by association |
| 34 | + /// @name Data members related to matched recob::OpFlash, also reachable by association |
| 35 | + /// @{ |
31 | 36 | float flashTime { fDefault }; ///< Matched OpFlash time (us) |
32 | 37 | float flashFirstHit { fDefault }; ///< Time of first OpHit in matched OpFlash (us) |
33 | 38 | float flashPEs { fDefault }; ///< Total PEs in matched flash |
34 | 39 | float flashAsymmetry { fDefault }; ///< East-West asymmetry of PEs in matched flash |
35 | 40 | geo::Point_t flashCenter { fDefault, fDefault, fDefault }; ///< Weighted mean ophit position in X,Y,Z [no meaingful X info for ophits] (cm) |
36 | 41 | geo::Vector_t flashWidth { fDefault, fDefault, fDefault }; ///< Weighted standard devitation of ophit position in X,Y,Z [no meaingful X info for ophits] (cm) |
| 42 | + /// @} |
37 | 43 |
|
38 | 44 |
|
39 | | - /// Data members related to quality of match |
40 | | - float deltaY { fDefault }; ///< abs( Matched flash Y center - charge Y center ) (cm) |
41 | | - float deltaZ { fDefault }; ///< abs( Matched flash Z cetner - charge Z center ) (cm) |
42 | | - float radius { fDefault }; ///< Hypotenuse of DeltaY and DeltaZ, PARAMETER MINIMIZED BY MATCHING (cm) |
43 | | - float deltaT { fDefault }; ///< abs( Matched flash time - anab::T0 ) when available (us) |
| 45 | + /// @name Data members related to quality of match |
| 46 | + /// @{ |
| 47 | + float deltaY { fDefault }; ///< | Matched flash Y center - charge Y center | (cm) |
| 48 | + float deltaZ { fDefault }; ///< | Matched flash Z center - charge Z center | (cm) |
| 49 | + float radius { fDefault }; ///< Hypotenuse of DeltaY and DeltaZ (cm) |
| 50 | + float deltaT { fDefault }; ///< | Matched flash time - anab::T0 | when available (us) |
44 | 51 | float overlapY { fDefault }; ///< Spatial overlap of flash and charge centroids in Y [>0] OR distance apart if no overlap [<0] (cm) |
45 | 52 | float overlapZ { fDefault }; ///< Spatial overlap of flash and charge centroids in Z [>0] OR distance apart if no overlap [<0] (cm) |
46 | | - float deltaZ_Trigger { fDefault }; ///< abs( Triggering flash Z cetner - charge Z center ) (cm) |
| 53 | + float deltaZ_Trigger { fDefault }; ///< | Triggering flash Z center - charge Z center | (cm) |
| 54 | + float deltaY_Trigger { fDefault }; ///< | Triggering flash Y center - charge Y center | (cm) |
| 55 | + float radius_Trigger { fDefault }; ///< Hypotenuse of DeltaY_Trigger and DeltaZ_Trigger (cm) |
| 56 | + /// @} |
47 | 57 |
|
48 | 58 | }; |
49 | 59 | } |
|
0 commit comments