Stores detailed information about a photonuclear interaction. More...

#include <PhotonuclearInteraction.h>

Classes
struct	ParticleInfo
	Stores kinematic and identity information for a particle. More...

Public Member Functions
	PhotonuclearInteraction ()=default
	Constructor.

virtual	~PhotonuclearInteraction ()=default
	Destructor.

void	clear ()
	Clear the interaction data.

void	setIncidentPhoton (int track_id, int pdg_id, double energy, double px, double py, double pz, double x, double y, double z, double time)
	Set the incident photon information.

ParticleInfo	getIncidentPhoton () const
	Get the incident photon information.

void	setTarget (int Z, int A, const std::string &material)
	Set the target nucleus information.

int	getTargetZ () const
	Get the target atomic number.

int	getTargetA () const
	Get the target mass number.

std::string	getTargetMaterial () const
	Get the target material name.

void	addImmediateSecondary (const ParticleInfo &particle)
	Add an immediate secondary particle from the PN interaction.

std::vector< ParticleInfo >	getImmediateSecondaries () const
	Get all immediate secondary particles.

int	getNumImmediateSecondaries () const
	Get the number of immediate secondary particles.

void	addDescendant (int immediate_secondary_id, int final_state_track_id)
	Add a final state descendant track for an immediate secondary.

std::map< int, std::vector< int > >	getDescendantMap () const
	Get the descendant map.

std::vector< int >	getDescendants (int immediate_secondary_id) const
	Get descendants for a specific immediate secondary.

void	setInteractionVolume (const std::string &volume)
	Set the volume where the interaction occurred.

std::string	getInteractionVolume () const
	Get the interaction volume name.

void	setProcessName (const std::string &process)
	Set the process name.

std::string	getProcessName () const
	Get the process name.

void	print () const
	Print information about this interaction.

Private Member Functions
	ClassDef (PhotonuclearInteraction, 1)
	ROOT dictionary generation.

Private Attributes
ParticleInfo	incident_photon_
	Incident photon information.

int	target_z_ {0}
	Target atomic number.

int	target_a_ {0}
	Target mass number.

std::string	target_material_ {""}
	Target material name.

std::vector< ParticleInfo >	immediate_secondaries_
	Immediate secondary particles from the cascade.

std::map< int, std::vector< int > >	descendant_map_
	Maps immediate secondary track ID -> final state track IDs.

std::string	interaction_volume_ {""}
	Volume where interaction occurred.

std::string	process_name_ {""}
	Process name (e.g., "photonNuclear")

Friends
std::ostream &	operator<< (std::ostream &o, const PhotonuclearInteraction &pn)
	Stream operator for printing.

Detailed Description

Stores detailed information about a photonuclear interaction.

This class records comprehensive details about photonuclear (PN) interactions to enable validation of cascade mechanisms, identification of edge cases, and analysis of final state particle production.

For each PN interaction, it captures:

Incident photon information (energy, momentum, position, time)
Target nucleus (Z, A, material)
All immediate secondary particles from the cascade
Mapping from cascade products to their final state descendants

Definition at line 32 of file PhotonuclearInteraction.h.

Member Function Documentation

◆ addDescendant()

void ldmx::PhotonuclearInteraction::addDescendant	(	int	immediate_secondary_id,
		int	final_state_track_id )

Add a final state descendant track for an immediate secondary.

This builds the map from immediate cascade products to their eventual final state particles.

Parameters

immediate_secondary_id	Track ID of the immediate secondary
final_state_track_id	Track ID of the final state descendant

Definition at line 50 of file PhotonuclearInteraction.cxx.

                                                                      {
  descendant_map_[immediate_secondary_id].push_back(final_state_track_id);
}

References descendant_map_.

◆ addImmediateSecondary()

void ldmx::PhotonuclearInteraction::addImmediateSecondary ( const ParticleInfo & particle )

Add an immediate secondary particle from the PN interaction.

Parameters

particle ParticleInfo for the secondary

Definition at line 45 of file PhotonuclearInteraction.cxx.

                                  {
  immediate_secondaries_.push_back(particle);
}

References immediate_secondaries_.

Referenced by simcore::PhotonuclearTracker::stepping().

◆ clear()

void ldmx::PhotonuclearInteraction::clear ( )

Clear the interaction data.

Definition at line 10 of file PhotonuclearInteraction.cxx.

                                    {
  incident_photon_ = ParticleInfo();
  target_z_ = 0;
  target_a_ = 0;
  target_material_ = "";
  immediate_secondaries_.clear();
  descendant_map_.clear();
  interaction_volume_ = "";
  process_name_ = "";
}

References descendant_map_, immediate_secondaries_, incident_photon_, interaction_volume_, process_name_, target_a_, target_material_, and target_z_.

◆ getDescendantMap()

std::map< int, std::vector< int > > ldmx::PhotonuclearInteraction::getDescendantMap ( ) const

inline

Get the descendant map.

Maps immediate secondary track ID -> list of final state track IDs

Returns: Map of secondary IDs to their descendant IDs

Definition at line 177 of file PhotonuclearInteraction.h.

                                                       {
    return descendant_map_;
  }

References descendant_map_.

◆ getDescendants()

std::vector< int > ldmx::PhotonuclearInteraction::getDescendants ( int immediate_secondary_id ) const

Get descendants for a specific immediate secondary.

Parameters

immediate_secondary_id Track ID of the immediate secondary

Returns: Vector of track IDs for descendants (empty if none)

Definition at line 55 of file PhotonuclearInteraction.cxx.

                                      {
  auto it = descendant_map_.find(immediate_secondary_id);
  if (it != descendant_map_.end()) {
    return it->second;
  }
  return std::vector<int>();
}

References descendant_map_.

◆ getImmediateSecondaries()

std::vector< ParticleInfo > ldmx::PhotonuclearInteraction::getImmediateSecondaries ( ) const

inline

Get all immediate secondary particles.

Returns: Vector of ParticleInfo for all immediate secondaries

Definition at line 146 of file PhotonuclearInteraction.h.

                                                          {
    return immediate_secondaries_;
  }

References immediate_secondaries_.

◆ getIncidentPhoton()

ParticleInfo ldmx::PhotonuclearInteraction::getIncidentPhoton ( ) const

inline

Get the incident photon information.

Returns: ParticleInfo for the incident photon

Definition at line 102 of file PhotonuclearInteraction.h.

102{ return incident_photon_; }

References incident_photon_.

◆ getInteractionVolume()

std::string ldmx::PhotonuclearInteraction::getInteractionVolume ( ) const

inline

Get the interaction volume name.

Returns: Volume name

Definition at line 203 of file PhotonuclearInteraction.h.

203{ return interaction_volume_; }

References interaction_volume_.

◆ getNumImmediateSecondaries()

int ldmx::PhotonuclearInteraction::getNumImmediateSecondaries ( ) const

inline

Get the number of immediate secondary particles.

Returns: Number of immediate secondaries

Definition at line 155 of file PhotonuclearInteraction.h.

                                         {
    return immediate_secondaries_.size();
  }

References immediate_secondaries_.

◆ getProcessName()

std::string ldmx::PhotonuclearInteraction::getProcessName ( ) const

inline

Get the process name.

Returns: Process name

Definition at line 217 of file PhotonuclearInteraction.h.

217{ return process_name_; }

References process_name_.

◆ getTargetA()

int ldmx::PhotonuclearInteraction::getTargetA ( ) const

inline

Get the target mass number.

Returns: Mass number A

Definition at line 125 of file PhotonuclearInteraction.h.

125{ return target_a_; }

References target_a_.

◆ getTargetMaterial()

std::string ldmx::PhotonuclearInteraction::getTargetMaterial ( ) const

inline

Get the target material name.

Returns: Material name

Definition at line 132 of file PhotonuclearInteraction.h.

132{ return target_material_; }

References target_material_.

◆ getTargetZ()

int ldmx::PhotonuclearInteraction::getTargetZ ( ) const

inline

Get the target atomic number.

Returns: Atomic number Z

Definition at line 118 of file PhotonuclearInteraction.h.

118{ return target_z_; }

References target_z_.

◆ print()

void ldmx::PhotonuclearInteraction::print ( ) const

Print information about this interaction.

Definition at line 86 of file PhotonuclearInteraction.cxx.

86{ std::cout << *this; }

◆ setIncidentPhoton()

void ldmx::PhotonuclearInteraction::setIncidentPhoton	(	int	track_id,
		int	pdg_id,
		double	energy,
		double	px,
		double	py,
		double	pz,
		double	x,
		double	y,
		double	z,
		double	time )

Set the incident photon information.

Parameters

track_id	Geant4 track ID
energy	Total energy [MeV]
px	Momentum x-component [MeV]
py	Momentum y-component [MeV]
pz	Momentum z-component [MeV]
x	Position x-component [mm]
y	Position y-component [mm]
z	Position z-component [mm]
time	Global time [ns]

Definition at line 21 of file PhotonuclearInteraction.cxx.

                                                             {
  incident_photon_.track_id_ = track_id;
  incident_photon_.pdg_id_ = pdg_id;
  incident_photon_.energy_ = energy;
  incident_photon_.px_ = px;
  incident_photon_.py_ = py;
  incident_photon_.pz_ = pz;
  incident_photon_.x_ = x;
  incident_photon_.y_ = y;
  incident_photon_.z_ = z;
  incident_photon_.time_ = time;
}

References ldmx::PhotonuclearInteraction::ParticleInfo::energy_, incident_photon_, ldmx::PhotonuclearInteraction::ParticleInfo::pdg_id_, ldmx::PhotonuclearInteraction::ParticleInfo::px_, ldmx::PhotonuclearInteraction::ParticleInfo::time_, ldmx::PhotonuclearInteraction::ParticleInfo::track_id_, and ldmx::PhotonuclearInteraction::ParticleInfo::x_.

Referenced by simcore::PhotonuclearTracker::stepping().

◆ setInteractionVolume()

void ldmx::PhotonuclearInteraction::setInteractionVolume ( const std::string & volume )

inline

Set the volume where the interaction occurred.

Parameters

volume Volume name

Definition at line 194 of file PhotonuclearInteraction.h.

                                                     {
    interaction_volume_ = volume;
  }

References interaction_volume_.

Referenced by simcore::PhotonuclearTracker::stepping().

◆ setProcessName()

void ldmx::PhotonuclearInteraction::setProcessName ( const std::string & process )

inline

Set the process name.

Parameters

process Process name (e.g., "photonNuclear")

Definition at line 210 of file PhotonuclearInteraction.h.

210{ process_name_ = process; }

References process_name_.

Referenced by simcore::PhotonuclearTracker::stepping().

◆ setTarget()

void ldmx::PhotonuclearInteraction::setTarget	(	int	Z,
		int	A,
		const std::string &	material )

Set the target nucleus information.

Parameters

Z	Atomic number
A	Mass number
material	Material name

Definition at line 38 of file PhotonuclearInteraction.cxx.

                                                                   {
  target_z_ = Z;
  target_a_ = A;
  target_material_ = material;
}

References target_a_, target_material_, and target_z_.

Referenced by simcore::PhotonuclearTracker::stepping().

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	o,
		const PhotonuclearInteraction &	pn )

friend

Stream operator for printing.

Definition at line 64 of file PhotonuclearInteraction.cxx.

                                                                         {
  o << "PhotonuclearInteraction:" << "  Process: " << pn.process_name_
    << "  Volume: " << pn.interaction_volume_
    << "  Incident photon: track_id=" << pn.incident_photon_.track_id_
    << " pdg=" << pn.incident_photon_.pdg_id_
    << " E=" << pn.incident_photon_.energy_ << " MeV"
    << "  Target: Z=" << pn.target_z_ << " A=" << pn.target_a_
    << " material=" << pn.target_material_
    << "  Immediate secondaries: " << pn.immediate_secondaries_.size()
    << std::endl;
  for (const auto& sec : pn.immediate_secondaries_) {
    o << "    track_id=" << sec.track_id_ << " pdg=" << sec.pdg_id_
      << " E=" << sec.energy_ << " MeV" << std::endl;
  }
  o << "  Descendant map entries: " << pn.descendant_map_.size() << std::endl;
  for (const auto& [sec_id, descendants] : pn.descendant_map_) {
    o << "    Secondary " << sec_id << " -> " << descendants.size()
      << " descendants" << std::endl;
  }
  return o;
}

Member Data Documentation

◆ descendant_map_

std::map<int, std::vector<int> > ldmx::PhotonuclearInteraction::descendant_map_

private

Maps immediate secondary track ID -> final state track IDs.

Definition at line 247 of file PhotonuclearInteraction.h.

Referenced by addDescendant(), clear(), getDescendantMap(), and getDescendants().

◆ immediate_secondaries_

std::vector<ParticleInfo> ldmx::PhotonuclearInteraction::immediate_secondaries_

private

Immediate secondary particles from the cascade.

Definition at line 244 of file PhotonuclearInteraction.h.

Referenced by addImmediateSecondary(), clear(), getImmediateSecondaries(), and getNumImmediateSecondaries().

◆ incident_photon_

ParticleInfo ldmx::PhotonuclearInteraction::incident_photon_

private

Incident photon information.

Definition at line 232 of file PhotonuclearInteraction.h.

Referenced by clear(), getIncidentPhoton(), and setIncidentPhoton().

◆ interaction_volume_

std::string ldmx::PhotonuclearInteraction::interaction_volume_ {""}

private

Volume where interaction occurred.

Definition at line 250 of file PhotonuclearInteraction.h.

250{""};

Referenced by clear(), getInteractionVolume(), and setInteractionVolume().

◆ process_name_

std::string ldmx::PhotonuclearInteraction::process_name_ {""}

private

Process name (e.g., "photonNuclear")

Definition at line 253 of file PhotonuclearInteraction.h.

253{""};

Referenced by clear(), getProcessName(), and setProcessName().

◆ target_a_

int ldmx::PhotonuclearInteraction::target_a_ {0}

private

Target mass number.

Definition at line 238 of file PhotonuclearInteraction.h.

238{0};

Referenced by clear(), getTargetA(), and setTarget().

◆ target_material_

std::string ldmx::PhotonuclearInteraction::target_material_ {""}

private

Target material name.

Definition at line 241 of file PhotonuclearInteraction.h.

241{""};

Referenced by clear(), getTargetMaterial(), and setTarget().

◆ target_z_

int ldmx::PhotonuclearInteraction::target_z_ {0}

private

Target atomic number.

Definition at line 235 of file PhotonuclearInteraction.h.

235{0};

Referenced by clear(), getTargetZ(), and setTarget().

The documentation for this class was generated from the following files:

SimCore/include/SimCore/Event/PhotonuclearInteraction.h
SimCore/src/SimCore/Event/PhotonuclearInteraction.cxx

Classes

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Function Documentation

◆ addDescendant()

◆ addImmediateSecondary()

◆ clear()

◆ getDescendantMap()

◆ getDescendants()

◆ getImmediateSecondaries()

◆ getIncidentPhoton()

◆ getInteractionVolume()

◆ getNumImmediateSecondaries()

◆ getProcessName()

◆ getTargetA()

◆ getTargetMaterial()

◆ getTargetZ()

◆ print()

◆ setIncidentPhoton()

◆ setInteractionVolume()

◆ setProcessName()

◆ setTarget()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ descendant_map_

◆ immediate_secondaries_

◆ incident_photon_

◆ interaction_volume_

◆ process_name_

◆ target_a_

◆ target_material_

◆ target_z_