Encapsulates user defined information associated with a Geant4 event. More...

#include <UserEventInformation.h>

Public Member Functions
	UserEventInformation ()=default
	Constructor.

virtual	~UserEventInformation ()=default
	Destructor.

void	Print () const override
	Print the information associated with the track.

void	incBremCandidateCount ()
	Increment the number of brem candidates in an event.

void	decBremCandidateCount ()
	Decrease the number of brem candidates in an event.

void	setDarkBremMaterialZ (double z_)
	Set the Z of the element in which the dark brem ocurred.

double	getDarkBremMaterialZ () const
	Get the Z of the element in which the dark brem ocurred.

void	setWeight (double weight)
	Set the event weight.

double	getWeight ()

void	incWeight (double step_weight)
	Increment the event weight by the input weight for an individual step.

int	bremCandidateCount ()

void	addPNEnergy (double delta)
	Add energy to the photonuclear running total.

void	addENEnergy (double delta)
	Add energy to the electronuclear running total.

double	getPNEnergy () const
	Get the total energy that went PN.

double	getENEnergy () const
	Get the total energy that went EN.

void	lastStepWasPN (bool yes)
	Tell us if last step was PN.

bool	wasLastStepPN () const
	Was the last step a PN interaction?

void	lastStepWasEN (bool yes)
	Tell us if last step was EN.

bool	wasLastStepEN () const
	Was the last step a EN interaction?

void	addHepMC3GenEvent (ldmx::HepMC3GenEvent event)

std::vector< ldmx::HepMC3GenEvent >	getHepMC3GenEvents ()

Private Attributes
int	brem_candidate_count_ {0}
	Total number of brem candidates in the event.

double	weight_ {1.}
	The event weight.

double	total_photonuclear_energy_ {0.}
	The total energy that went into the photon-nuclear interaction.

bool	last_step_pn_ {false}
	Was the most recent step a photon-nuclear interaction?

double	total_electronuclear_energy_ {0.}
	The total energy that went into the electron-nuclear interaction.

bool	last_step_en_ {false}
	Was the most recent step a electron-nuclear interaction?

double	db_material_z_ {-1.}
	atomic Z of the element in which dark brem occurred (-1 if didn't happen)

std::vector< ldmx::HepMC3GenEvent >	hepmc3_events_
	a collection of HepMC3 event records.

Detailed Description

Encapsulates user defined information associated with a Geant4 event.

Definition at line 14 of file UserEventInformation.h.

Member Function Documentation

◆ addENEnergy()

void simcore::UserEventInformation::addENEnergy ( double delta )

inline

Add energy to the electronuclear running total.

Parameters

[in] delta energy to add to the total

Definition at line 86 of file UserEventInformation.h.

86{ total_electronuclear_energy_ += delta; }

simcore::UserEventInformation::total_electronuclear_energy_

double total_electronuclear_energy_

The total energy that went into the electron-nuclear interaction.

Definition UserEventInformation.h:165

References total_electronuclear_energy_.

◆ addHepMC3GenEvent()

void simcore::UserEventInformation::addHepMC3GenEvent ( ldmx::HepMC3GenEvent event )

inline

Definition at line 124 of file UserEventInformation.h.

                                                   {
    hepmc3_events_.push_back(event);
  }

◆ addPNEnergy()

void simcore::UserEventInformation::addPNEnergy ( double delta )

inline

Add energy to the photonuclear running total.

Parameters

[in] delta energy to add to the total

Definition at line 79 of file UserEventInformation.h.

79{ total_photonuclear_energy_ += delta; }

simcore::UserEventInformation::total_photonuclear_energy_

double total_photonuclear_energy_

The total energy that went into the photon-nuclear interaction.

Definition UserEventInformation.h:151

References total_photonuclear_energy_.

◆ bremCandidateCount()

int simcore::UserEventInformation::bremCandidateCount ( )

inline

Returns: The total number of brem candidates that this event contains.

Definition at line 72 of file UserEventInformation.h.

72{ return brem_candidate_count_; }

simcore::UserEventInformation::brem_candidate_count_

int brem_candidate_count_

Total number of brem candidates in the event.

Definition UserEventInformation.h:133

References brem_candidate_count_.

◆ decBremCandidateCount()

void simcore::UserEventInformation::decBremCandidateCount ( )

inline

Decrease the number of brem candidates in an event.

Definition at line 29 of file UserEventInformation.h.

29{ brem_candidate_count_ -= 1; }

References brem_candidate_count_.

Referenced by biasing::TargetProcessFilter::stepping().

◆ getDarkBremMaterialZ()

double simcore::UserEventInformation::getDarkBremMaterialZ ( ) const

inline

Get the Z of the element in which the dark brem ocurred.

Note: This will return -1 if no dark brem ocurred within this event.

Parameters

[in] z_ atomic Z of element in which the dark brem ocurred

Definition at line 46 of file UserEventInformation.h.

46{ return db_material_z_; }

simcore::UserEventInformation::db_material_z_

double db_material_z_

atomic Z of the element in which dark brem occurred (-1 if didn't happen)

Definition UserEventInformation.h:178

References db_material_z_.

◆ getENEnergy()

double simcore::UserEventInformation::getENEnergy ( ) const

inline

Get the total energy that went EN.

Returns: total simulated energy that went EN in this event

Definition at line 98 of file UserEventInformation.h.

98{ return total_electronuclear_energy_; }

References total_electronuclear_energy_.

◆ getHepMC3GenEvents()

std::vector< ldmx::HepMC3GenEvent > simcore::UserEventInformation::getHepMC3GenEvents ( )

inline

Definition at line 127 of file UserEventInformation.h.

                                                     {
    return hepmc3_events_;
  }

◆ getPNEnergy()

double simcore::UserEventInformation::getPNEnergy ( ) const

inline

Get the total energy that went PN.

Returns: total simulated energy that went PN in this event

Definition at line 92 of file UserEventInformation.h.

92{ return total_photonuclear_energy_; }

References total_photonuclear_energy_.

◆ getWeight()

double simcore::UserEventInformation::getWeight ( )

inline

Returns: The event weight

Definition at line 58 of file UserEventInformation.h.

58{ return weight_; }

simcore::UserEventInformation::weight_

double weight_

The event weight.

Definition UserEventInformation.h:142

References weight_.

◆ incBremCandidateCount()

void simcore::UserEventInformation::incBremCandidateCount ( )

inline

Increment the number of brem candidates in an event.

Definition at line 26 of file UserEventInformation.h.

26{ brem_candidate_count_ += 1; }

References brem_candidate_count_.

Referenced by biasing::DeepEcalProcessFilter::stepping(), and biasing::TargetBremFilter::stepping().

◆ incWeight()

void simcore::UserEventInformation::incWeight ( double step_weight )

inline

Increment the event weight by the input weight for an individual step.

Parameters

[in] step_weight weight of an individual step

Definition at line 66 of file UserEventInformation.h.

66{ weight_ *= step_weight; }

References weight_.

◆ lastStepWasEN()

void simcore::UserEventInformation::lastStepWasEN ( bool yes )

inline

Tell us if last step was EN.

Parameters

[in] yes true if it was

Definition at line 116 of file UserEventInformation.h.

116{ last_step_en_ = yes; }

simcore::UserEventInformation::last_step_en_

bool last_step_en_

Was the most recent step a electron-nuclear interaction?

Definition UserEventInformation.h:170

References last_step_en_.

◆ lastStepWasPN()

void simcore::UserEventInformation::lastStepWasPN ( bool yes )

inline

Tell us if last step was PN.

Parameters

[in] yes true if it was

Definition at line 104 of file UserEventInformation.h.

104{ last_step_pn_ = yes; }

simcore::UserEventInformation::last_step_pn_

bool last_step_pn_

Was the most recent step a photon-nuclear interaction?

Definition UserEventInformation.h:156

References last_step_pn_.

◆ Print()

void simcore::UserEventInformation::Print ( ) const

override

Print the information associated with the track.

Definition at line 10 of file UserEventInformation.cxx.

                                       {
  std::cout << "Event weight: " << weight_ << "\n"
            << "Brem candidate count: " << brem_candidate_count_ << "\n"
            << "e_{PN} = " << total_photonuclear_energy_ << " MeV  "
            << "e_{EN} = " << total_electronuclear_energy_ << " MeV"
            << std::endl;
}

References brem_candidate_count_, total_electronuclear_energy_, total_photonuclear_energy_, and weight_.

◆ setDarkBremMaterialZ()

void simcore::UserEventInformation::setDarkBremMaterialZ ( double z_ )

inline

Set the Z of the element in which the dark brem ocurred.

Parameters

[in] z_ atomic Z of element in which the dark brem ocurred

Definition at line 36 of file UserEventInformation.h.

36{ db_material_z_ = z_; }

References db_material_z_.

◆ setWeight()

void simcore::UserEventInformation::setWeight ( double weight )

inline

Set the event weight.

Parameters

[in] weight the event weight

Definition at line 53 of file UserEventInformation.h.

53{ weight_ = weight; }

References weight_.

◆ wasLastStepEN()

bool simcore::UserEventInformation::wasLastStepEN ( ) const

inline

Was the last step a EN interaction?

Returns: true if it was

Definition at line 122 of file UserEventInformation.h.

122{ return last_step_en_; }

References last_step_en_.

◆ wasLastStepPN()

bool simcore::UserEventInformation::wasLastStepPN ( ) const

inline

Was the last step a PN interaction?

Returns: true if it was

Definition at line 110 of file UserEventInformation.h.

110{ return last_step_pn_; }

References last_step_pn_.

Member Data Documentation

◆ brem_candidate_count_

int simcore::UserEventInformation::brem_candidate_count_ {0}

private

Total number of brem candidates in the event.

Definition at line 133 of file UserEventInformation.h.

133{0};

Referenced by bremCandidateCount(), decBremCandidateCount(), incBremCandidateCount(), and Print().

◆ db_material_z_

double simcore::UserEventInformation::db_material_z_ {-1.}

private

atomic Z of the element in which dark brem occurred (-1 if didn't happen)

The default is -1. and so will provide unphysical results if the dark brem did not occur within the event in question.

Definition at line 178 of file UserEventInformation.h.

178{-1.};

Referenced by getDarkBremMaterialZ(), and setDarkBremMaterialZ().

◆ hepmc3_events_

std::vector<ldmx::HepMC3GenEvent> simcore::UserEventInformation::hepmc3_events_

private

a collection of HepMC3 event records.

Definition at line 183 of file UserEventInformation.h.

◆ last_step_en_

bool simcore::UserEventInformation::last_step_en_ {false}

private

Was the most recent step a electron-nuclear interaction?

Definition at line 170 of file UserEventInformation.h.

170{false};

Referenced by lastStepWasEN(), and wasLastStepEN().

◆ last_step_pn_

bool simcore::UserEventInformation::last_step_pn_ {false}

private

Was the most recent step a photon-nuclear interaction?

Definition at line 156 of file UserEventInformation.h.

156{false};

Referenced by lastStepWasPN(), and wasLastStepPN().

◆ total_electronuclear_energy_

double simcore::UserEventInformation::total_electronuclear_energy_ {0.}

private

The total energy that went into the electron-nuclear interaction.

Note: The action TrackNuclearEnergy relies on the assumption that this running total starts at 0, so the value of this member variable should always be 0 at construction.

Definition at line 165 of file UserEventInformation.h.

165{0.};

Referenced by addENEnergy(), getENEnergy(), and Print().

◆ total_photonuclear_energy_

double simcore::UserEventInformation::total_photonuclear_energy_ {0.}

private

The total energy that went into the photon-nuclear interaction.

Note: The action TrackNuclearEnergy relies on the assumption that this running total starts at 0, so the value of this member variable should always be 0 at construction.

Definition at line 151 of file UserEventInformation.h.

151{0.};

Referenced by addPNEnergy(), getPNEnergy(), and Print().

◆ weight_

double simcore::UserEventInformation::weight_ {1.}

private

The event weight.

Note: The action WeightByStep relies on the assumption that this weight starts at 1, so the value of this member variable should always be 1.

Definition at line 142 of file UserEventInformation.h.

142{1.};

Referenced by getWeight(), incWeight(), Print(), and setWeight().

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

SimCore/include/SimCore/G4User/UserEventInformation.h
SimCore/src/SimCore/G4User/UserEventInformation.cxx

Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ addENEnergy()

◆ addHepMC3GenEvent()

◆ addPNEnergy()

◆ bremCandidateCount()

◆ decBremCandidateCount()

◆ getDarkBremMaterialZ()

◆ getENEnergy()

◆ getHepMC3GenEvents()

◆ getPNEnergy()

◆ getWeight()

◆ incBremCandidateCount()

◆ incWeight()

◆ lastStepWasEN()

◆ lastStepWasPN()

◆ Print()

◆ setDarkBremMaterialZ()

◆ setWeight()

◆ wasLastStepEN()

◆ wasLastStepPN()

Member Data Documentation

◆ brem_candidate_count_

◆ db_material_z_

◆ hepmc3_events_

◆ last_step_en_

◆ last_step_pn_

◆ total_electronuclear_energy_

◆ total_photonuclear_energy_

◆ weight_