Skip to content

fix: fully move CherenkovRadiator state into RadiatorHistory #49

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

Merged
wdconinc merged 3 commits into from
Jan 28, 2026
Merged

fix: fully move CherenkovRadiator state into RadiatorHistory #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a85612
fix: fully move CherenkovRadiator state into RadiatorHistory
wdconinc Jan 27, 2026
ad17b21
fix: remove duplication with helper struct
wdconinc Jan 28, 2026
a56af41
fix: throw on data in both old and new API structs
wdconinc Jan 28, 2026
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
6 changes: 6 additions & 0 deletions include/ChargedParticle.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,12 @@ class ChargedParticle: public TransientParticle {
void PIDReconstruction(CherenkovPID &pid);

private:
struct TrajectoryData {
unsigned zdim;
const std::vector<std::pair<TVector3, TVector3>>& locations;
};

TrajectoryData GetTrajectoryData(CherenkovRadiator* radiator, RadiatorHistory* history) const;
// Optical photons produced elsewhere;
std::vector<OpticalPhoton*> m_OrphanPhotons;

Expand Down
31 changes: 17 additions & 14 deletions include/CherenkovRadiator.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ class CherenkovRadiator: public TObject {
CherenkovRadiator(const G4LogicalVolume *volume = 0, const G4RadiatorMaterial *material = 0):
m_LogicalVolume(volume), m_Material(material),
m_ReferenceRefractiveIndex(0.0), m_ReferenceAttenuationLength(0.0),
m_ID(0), m_Stat(0), m_AverageTheta(0.0), m_TrajectoryBinCount(1), m_Smearing(0.0),
m_GaussianSmearing(false) {};
m_ID(0), m_Stat(0), m_AverageTheta(0.0), m_Smearing(0.0),
m_GaussianSmearing(false), m_TrajectoryBinCount_deprecated(1) {};
~CherenkovRadiator() {};

double n( void ) const { return m_ReferenceRefractiveIndex; };
Expand Down Expand Up @@ -66,19 +66,21 @@ class CherenkovRadiator: public TObject {
TString m_AlternativeMaterialName;

public:
void SetTrajectoryBinCount(unsigned bins) { m_TrajectoryBinCount = bins; };
double GetTrajectoryBinCount( void) const { return m_TrajectoryBinCount; };

inline double GetSmearing( void ) const { return m_Smearing; };
void SetGaussianSmearing(double sigma) { m_GaussianSmearing = true; m_Smearing = sigma; }
void SetUniformSmearing (double range) { m_GaussianSmearing = false; m_Smearing = range; }
bool UseGaussianSmearing( void ) const { return m_GaussianSmearing; };

// FIXME: memory leak;
void ResetLocations( void ) { m_Locations.clear(); }
void AddLocation(/*unsigned sector,*/ const TVector3 &x, const TVector3 &n) {
m_Locations/*[sector]*/.push_back(std::make_pair(x, n));
};
// Backwards compatibility: deprecated methods for old non-thread-safe API
// WARNING: These are NOT thread-safe and should only be used with mutex protection
// For thread-safe code, use RadiatorHistory methods directly
void SetTrajectoryBinCount(unsigned bins) { m_TrajectoryBinCount_deprecated = bins; }
unsigned GetTrajectoryBinCount() const { return m_TrajectoryBinCount_deprecated; }
void ResetLocations() { m_Locations_deprecated.clear(); }
void AddLocation(const TVector3 &x, const TVector3 &n) {
m_Locations_deprecated.push_back(std::make_pair(x, n));
}
const std::vector<std::pair<TVector3, TVector3>>& GetLocations( void ) const { return m_Locations_deprecated; };

// Transient variables for the analysis script convenience;
unsigned m_ID; //!
Expand All @@ -87,17 +89,18 @@ class CherenkovRadiator: public TObject {
TVector3 m_AverageVertexPosition; //!
double m_AverageRefractiveIndex; //!

unsigned m_TrajectoryBinCount; //!
// This is a hack for now;
double m_Smearing; //!
bool m_GaussianSmearing; //!
//std::map<unsigned, std::vector<std::pair<TVector3, TVector3>>> _m_Locations; //!
std::vector<std::pair<TVector3, TVector3>> m_Locations; //!

std::vector<std::pair<double, double>> m_ri_lookup_table; //!

// Deprecated members for backwards compatibility (NOT thread-safe)
unsigned m_TrajectoryBinCount_deprecated; //!
std::vector<std::pair<TVector3, TVector3>> m_Locations_deprecated; //!

#ifndef DISABLE_ROOT_IO
ClassDef(CherenkovRadiator, 5);
ClassDef(CherenkovRadiator, 6);
#endif
};

Expand Down
19 changes: 16 additions & 3 deletions include/RadiatorHistory.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

class RadiatorHistory: public TObject {
public:
RadiatorHistory() {};
RadiatorHistory(): m_TrajectoryBinCount(1) {};
~RadiatorHistory() {
for(auto photon: m_Photons)
delete photon;
Expand All @@ -31,7 +31,16 @@ class RadiatorHistory: public TObject {
inline const ChargedParticleStep *GetStep(unsigned id) const {
return (id < m_Steps.size() ? m_Steps[id] : 0);
};
inline unsigned StepCount( void ) { return m_Steps.size(); };
inline unsigned StepCount( void ) { return m_Steps.size(); };

// Trajectory location management (moved from CherenkovRadiator for thread safety)
void SetTrajectoryBinCount(unsigned bins) { m_TrajectoryBinCount = bins; };
unsigned GetTrajectoryBinCount( void ) const { return m_TrajectoryBinCount; };
void ResetLocations( void ) { m_Locations.clear(); }
void AddLocation(const TVector3 &x, const TVector3 &n) {
m_Locations.push_back(std::make_pair(x, n));
};
const std::vector<std::pair<TVector3, TVector3>>& GetLocations( void ) const { return m_Locations; };

void AddStepBufferPoint(double time, const TVector3 &x) {
// Will be in ascending order of time;
Expand Down Expand Up @@ -72,8 +81,12 @@ class RadiatorHistory: public TObject {

std::map<double, TVector3> m_StepBuffer; //!

// Per-event trajectory data (moved from CherenkovRadiator for thread safety)
unsigned m_TrajectoryBinCount; //!
std::vector<std::pair<TVector3, TVector3>> m_Locations; //!

#ifndef DISABLE_ROOT_IO
ClassDef(RadiatorHistory, 1);
ClassDef(RadiatorHistory, 2);
#endif
};

Expand Down
44 changes: 35 additions & 9 deletions source/ChargedParticle.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,28 @@

// -------------------------------------------------------------------------------------

ChargedParticle::TrajectoryData ChargedParticle::GetTrajectoryData(CherenkovRadiator* radiator, RadiatorHistory* history) const {
bool history_has_data = !history->GetLocations().empty();
bool radiator_has_data = !radiator->GetLocations().empty();

// Both APIs populated indicates accidental misuse
if (history_has_data && radiator_has_data) {
throw std::runtime_error("Both RadiatorHistory and CherenkovRadiator have trajectory data");
}

// Prefer new thread-safe API, fall back to deprecated API for backwards compatibility
if (history_has_data) {
return {history->GetTrajectoryBinCount(), history->GetLocations()};
} else if (radiator_has_data) {
return {radiator->GetTrajectoryBinCount(), radiator->GetLocations()};
} else {
static const std::vector<std::pair<TVector3, TVector3>> empty_locations;
return {0, empty_locations};
}
}

// -------------------------------------------------------------------------------------

void ChargedParticle::PIDReconstruction(CherenkovPID &pid)
{
std::vector<OpticalPhoton*> photons;
Expand Down Expand Up @@ -42,8 +64,10 @@ void ChargedParticle::PIDReconstruction(CherenkovPID &pid)

for(auto rhistory: GetRadiatorHistory()) {
auto radiator = GetRadiator(rhistory);
unsigned zdim = radiator->GetTrajectoryBinCount();
if (radiator->m_Locations.size() != zdim+1) continue;
auto history = GetHistory(rhistory);

auto [zdim, locations] = GetTrajectoryData(radiator, history);
if (locations.size() != zdim+1) continue;

TVector3 phx = photon->GetDetectionPosition();

Expand All @@ -63,9 +87,9 @@ void ChargedParticle::PIDReconstruction(CherenkovPID &pid)
photon->m_Phi[radiator] = 0.0;

for(unsigned iq=0; iq<zdim+1; iq++) {
auto &solution = solutions[iq] = irt->Solve(radiator->m_Locations[iq].first,
auto &solution = solutions[iq] = irt->Solve(locations[iq].first,
// FIXME: give beam line as a parameter;
radiator->m_Locations[iq].second.Unit(), phx, TVector3(0,0,1), false);
locations[iq].second.Unit(), phx, TVector3(0,0,1), false);
if (!solution.Converged()) {
all_converged = false;
break;
Expand All @@ -74,11 +98,11 @@ void ChargedParticle::PIDReconstruction(CherenkovPID &pid)
photon->m_Phi[radiator] += solution.GetPhi();

if (attenuation) {
TVector3 from = radiator->m_Locations[iq].first, to;
TVector3 from = locations[iq].first, to;
bool ok = rear->GetCrossing(from, solution.m_Direction, &to);
if (ok) {
double length = (to - from).Mag();
//printf("%02d -> %7.2f\n", iq, radiator->m_Locations[iq].first.z());
//printf("%02d -> %7.2f\n", iq, locations[iq].first.z());
//weights[iq] = 1.0;
weights[iq] = exp(-length / attenuation);
} //if
Expand Down Expand Up @@ -117,11 +141,13 @@ void ChargedParticle::PIDReconstruction(CherenkovPID &pid)

for(auto rhistory: GetRadiatorHistory()) {
auto radiator = GetRadiator(rhistory);
unsigned zdim = radiator->GetTrajectoryBinCount();
if (radiator->m_Locations.size() != zdim+1) continue;
auto history = GetHistory(rhistory);

auto [zdim, locations] = GetTrajectoryData(radiator, history);
if (locations.size() != zdim+1) continue;

// Asume this estimate is good enough;
double pp = radiator->m_Locations[0].second.Mag();
double pp = locations[0].second.Mag();
double arg = sqrt(pp*pp + m*m)/(radiator->m_AverageRefractiveIndex*pp);
// Threshold check; FIXME: do it better?;
if (fabs(arg) > 1.0) continue;
Expand Down