Skip to content

Light Calorimetry: Add obj for light calo objects #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lynnt20 wants to merge 10 commits into
base: develop
Choose a base branch
from
+66 −0
Open

Light Calorimetry: Add obj for light calo objects #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
d20b9a3
light calorimetry object, working version commit
lynnt20 Apr 25, 2023
e39af6a
add helper functions
lynnt20 May 16, 2023
fa0960e
Merge tag 'v09_19_00_01' into feature/lynnt_lightcalorimetry
lynnt20 May 16, 2024
878f4bd
Merge tag 'v09_19_05' into feature/lynnt_lightcalorimetry
lynnt20 Feb 12, 2025
7011f08
Merge tag 'v10_00_08' into feature/lynnt_lightcalorimetry
lynnt20 Apr 28, 2025
6d13a02
Merge tag 'v10_00_10' into feature/lynnt_lightcalorimetry
lynnt20 Apr 30, 2025
3d1aa8c
Merge tag 'v10_01_01' into feature/lynnt_lightcalorimetry
lynnt20 Aug 4, 2025
94bb6d1
Merge tag 'v10_03_00' into feature/lynnt_lightcalorimetry
lynnt20 Nov 13, 2025
e7249f6
simplify the class for light calo objects
lynnt20 Nov 17, 2025
234ce58
rename libraries, add comments
lynnt20 Dec 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions sbnobj/Common/Reco/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ cet_make_library(
CNNScore.cc
CRUMBSResult.cc
FlashTriggerPrimitive.cc
LightCalo.cc
MVAPID.cc
MergedTrackInfo.cc
OpT0FinderResult.cc
Expand Down
1 change: 1 addition & 0 deletions sbnobj/Common/Reco/LightCalo.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#include "sbnobj/Common/Reco/LightCalo.h"
47 changes: 47 additions & 0 deletions sbnobj/Common/Reco/LightCalo.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
/**
* @file sbnobj/Common/Reco/LightCalo.h
* @brief Defines data structures for light calorimetry products.
* @author Lynn Tung
* @date December 2nd, 2025
*
*/

#ifndef sbnobj_LightCalo_H
#define sbnobj_LightCalo_H

#include <limits>

namespace sbn{

/**
* @brief A simple class to store reconstructed charge, light, and visible energy.
*/

class LightCalo {
public:
Comment on lines +20 to +21
Copy link
Member

@PetrilloAtWork PetrilloAtWork Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the whole class content is public, I would declare it struct:

Suggested change
class LightCalo {
public:
struct LightCalo {

It is 100% equivalent, and I think clearer.


// NaN value to initialize data members
static constexpr double nan = std::numeric_limits<double>::signaling_NaN();

/// @name Reconstructed charge, light, and visible energy data members.
/// @{
double charge = nan; ///< Total charge in a reconstructed interaction (recob::Slice) [# of electrons]
double light = nan; ///< Total light in a reconstructed interaction (recob::Slice + recob::OpFlash) [# of photons]
double energy = nan; ///< Total visible energy (sum of charge+light) for a reconstructed interaction [GeV]
int bestplane = -1; ///< Plane that was used for the total charge
/// @}

/**
* Default constructor.
*/
LightCalo() = default;
LightCalo(double charge, double light, double energy, int bestplane)
: charge(charge)
, light(light)
, energy(energy)
, bestplane(bestplane)
{}
Comment on lines +34 to +43
Copy link
Member

@PetrilloAtWork PetrilloAtWork Jan 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have introduced a value constructor, and I want to make sure you are aware of the implications. I will compare yours with the same class in "plain old data" version, with no user-defined constructor (yours has two: the value constructor and the default one).

With your version, it's harder for the user to initialise the object only partially (e.g. initialise charge but not light). This is in general good, but note that partial initialization may still happen (LightCalo calo; calo.charge = 40000.0;).
With the POD version, aggregate initialisation can be used (LightCalo lc { 40000.0, 30000.0, 3.5, 2 };) that can omit the last arguments. This may or may not be desired. On the other end, POD have such guarantees (can be copied with a memcpy(), for example) that allow libraries writing them to disk to take shortcuts. I don't know whether ROOT takes advantage of any of the shortcuts.

In general I recommend POD classes, but that opens for partial initialisation.
So it's up to you and how you feel about it.

};
}

#endif
1 change: 1 addition & 0 deletions sbnobj/Common/Reco/classes.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
#include "sbnobj/Common/Reco/VertexHit.h"
#include "sbnobj/Common/Reco/MVAPID.h"
#include "sbnobj/Common/Reco/CRUMBSResult.h"
#include "sbnobj/Common/Reco/LightCalo.h"
#include "sbnobj/Common/Reco/OpT0FinderResult.h"
#include "sbnobj/Common/Reco/CNNScore.h"
#include "sbnobj/Common/Reco/TPCPMTBarycenterMatch.h"
Expand Down
16 changes: 16 additions & 0 deletions sbnobj/Common/Reco/classes_def.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,22 @@
<class name="art::Assns<sbn::crt::CRTHit, recob::Track, void>" />
<class name="art::Wrapper<art::Assns<sbn::crt::CRTHit, recob::Track, void>>" />

<class name="sbn::LightCalo">
</class>
Comment on lines +81 to +82
Copy link
Member

@PetrilloAtWork PetrilloAtWork Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs a checksum and a class version, so that when we change it ROOT knows how to read the old versions. Start with:

Suggested change
<class name="sbn::LightCalo">
</class>
<class name="sbn::LightCalo" classVersion="10" />

then build: it will tell you to build again. Rebuild... at this point you should see a fully successful build. Lastly, commit the new classes_def.xml to the branch.

<class name="std::vector<sbn::LightCalo>" />
<class name="art::Wrapper<sbn::LightCalo>" />
<class name="art::Wrapper<std::vector<sbn::LightCalo>>" />

<class name="art::Assns<recob::Slice, sbn::LightCalo>" />
<class name="art::Wrapper<art::Assns<recob::Slice, sbn::LightCalo>>" />
<class name="art::Assns<sbn::LightCalo, recob::Slice, void>" />
<class name="art::Wrapper<art::Assns<sbn::LightCalo, recob::Slice, void>>"/>

<class name="art::Assns<recob::OpFlash, sbn::LightCalo>" />
<class name="art::Assns<sbn::LightCalo, recob::OpFlash, void>" />
<class name="art::Wrapper<art::Assns<recob::OpFlash, sbn::LightCalo>>" />
<class name="art::Wrapper<art::Assns<sbn::LightCalo, recob::OpFlash, void>>" />
Comment on lines +87 to +95
Copy link
Member

@PetrilloAtWork PetrilloAtWork Jan 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The void in the associations is default and not necessary, but either way it should be consistent for ease of reading. Also for ease of reading, it would be better to have them in the same order.
Finally, I was under the impression that the explicit registration of the std::pair was needed too (at least it used to be).

Suggested change
<class name="art::Assns<recob::Slice, sbn::LightCalo>" />
<class name="art::Wrapper<art::Assns<recob::Slice, sbn::LightCalo>>" />
<class name="art::Assns<sbn::LightCalo, recob::Slice, void>" />
<class name="art::Wrapper<art::Assns<sbn::LightCalo, recob::Slice, void>>"/>
<class name="art::Assns<recob::OpFlash, sbn::LightCalo>" />
<class name="art::Assns<sbn::LightCalo, recob::OpFlash, void>" />
<class name="art::Wrapper<art::Assns<recob::OpFlash, sbn::LightCalo>>" />
<class name="art::Wrapper<art::Assns<sbn::LightCalo, recob::OpFlash, void>>" />
<class name="std::pair<recob::Slice, sbn::LightCalo>" />
<class name="art::Assns<recob::Slice, sbn::LightCalo>" />
<class name="art::Wrapper<art::Assns<recob::Slice, sbn::LightCalo>>" />
<class name="std::pair<sbn::LightCalo, recob::Slice>" />
<class name="art::Assns<sbn::LightCalo, recob::Slice>" />
<class name="art::Wrapper<art::Assns<sbn::LightCalo, recob::Slice>>"/>
<class name="std::pair<recob::OpFlash, sbn::LightCalo>" />
<class name="art::Assns<recob::OpFlash, sbn::LightCalo>" />
<class name="art::Wrapper<art::Assns<recob::OpFlash, sbn::LightCalo>>" />
<class name="std::pair<sbn::LightCalo, recob::OpFlash>" />
<class name="art::Assns<sbn::LightCalo, recob::OpFlash>" />
<class name="art::Wrapper<art::Assns<sbn::LightCalo, recob::OpFlash>>" />


<class name="sbn::OpT0Finder">
</class>
<class name="std::vector<sbn::OpT0Finder>" />
Expand Down