All CascadeSteps from a single photonuclear interaction. More...

#include <CascadeHistory.h>

Public Member Functions
void	clear ()

void	setIncidentTrackId (int trackId)

void	setTargetNucleus (int a, int z)

void	setIncidentEnergy (double energy)

void	setExcitationEnergy (double energy)

void	setResidualNucleus (int a, int z)

void	addStep (const CascadeStep &step)

void	addStep (CascadeStep &&step)

void	reserve (size_t n)

int	getIncidentTrackId () const

int	getTargetA () const

int	getTargetZ () const

double	getIncidentEnergy () const

double	getExcitationEnergy () const

int	getResidualA () const

int	getResidualZ () const

size_t	getNumSteps () const

bool	empty () const

const std::vector< CascadeStep > &	getSteps () const

std::vector< CascadeStep > &	getSteps ()

const CascadeStep &	getStep (size_t i) const

const CascadeStep *	getStepByHistoryId (int historyId) const

const CascadeStep *	getIncidentStep () const

std::vector< const CascadeStep * >	getStepsAtGeneration (int generation) const

std::vector< const CascadeStep * >	getInteractingSteps () const

std::vector< const CascadeStep * >	getEscapedSteps () const

int	getMaxGeneration () const

int	getNumInteractions () const

void	print () const

Private Member Functions
	ClassDef (CascadeHistory, 1)

Private Attributes
int	incident_track_id_ {-1}

int	target_a_ {0}

int	target_z_ {0}

double	incident_energy_ {0.0}

double	excitation_energy_ {0.0}

int	residual_a_ {0}

int	residual_z_ {0}

std::vector< CascadeStep >	steps_

Detailed Description

All CascadeSteps from a single photonuclear interaction.

Keyed by the initiating photon's track ID for correlation with SimParticle. Parent-daughter relationships are encoded via history IDs (parentId = -1 for incident particle).

Definition at line 24 of file CascadeHistory.h.

Member Function Documentation

◆ addStep() [1/2]

void ldmx::CascadeHistory::addStep ( CascadeStep && step )

inline

Definition at line 44 of file CascadeHistory.h.

44{ steps_.push_back(std::move(step)); }

◆ addStep() [2/2]

void ldmx::CascadeHistory::addStep ( const CascadeStep & step )

inline

Definition at line 43 of file CascadeHistory.h.

43{ steps_.push_back(step); }

◆ clear()

void ldmx::CascadeHistory::clear ( )

Definition at line 11 of file CascadeHistory.cxx.

                           {
  incident_track_id_ = -1;
  target_a_ = 0;
  target_z_ = 0;
  steps_.clear();
}

◆ empty()

bool ldmx::CascadeHistory::empty ( ) const

inline

Definition at line 56 of file CascadeHistory.h.

56{ return steps_.empty(); }

◆ getEscapedSteps()

std::vector< const CascadeStep * > ldmx::CascadeHistory::getEscapedSteps ( ) const

Definition at line 57 of file CascadeHistory.cxx.

                                                                    {
  std::vector<const CascadeStep*> result;
  for (const auto& step : steps_) {
    if (step.didEscape()) {
      result.push_back(&step);
    }
  }
  return result;
}

◆ getExcitationEnergy()

double ldmx::CascadeHistory::getExcitationEnergy ( ) const

inline

Definition at line 51 of file CascadeHistory.h.

51{ return excitation_energy_; }

◆ getIncidentEnergy()

double ldmx::CascadeHistory::getIncidentEnergy ( ) const

inline

Definition at line 50 of file CascadeHistory.h.

50{ return incident_energy_; }

◆ getIncidentStep()

const CascadeStep * ldmx::CascadeHistory::getIncidentStep ( ) const

Definition at line 27 of file CascadeHistory.cxx.

                                                         {
  for (const auto& step : steps_) {
    if (step.getGeneration() == 0 && step.getParentId() == -1) {
      return &step;
    }
  }
  return steps_.empty() ? nullptr : &steps_.front();
}

◆ getIncidentTrackId()

int ldmx::CascadeHistory::getIncidentTrackId ( ) const

inline

Definition at line 47 of file CascadeHistory.h.

47{ return incident_track_id_; }

◆ getInteractingSteps()

std::vector< const CascadeStep * > ldmx::CascadeHistory::getInteractingSteps ( ) const

Definition at line 47 of file CascadeHistory.cxx.

                                                                        {
  std::vector<const CascadeStep*> result;
  for (const auto& step : steps_) {
    if (step.didInteract()) {
      result.push_back(&step);
    }
  }
  return result;
}

◆ getMaxGeneration()

int ldmx::CascadeHistory::getMaxGeneration ( ) const

Definition at line 67 of file CascadeHistory.cxx.

                                           {
  int max_gen = -1;
  for (const auto& step : steps_) {
    if (step.getGeneration() > max_gen) {
      max_gen = step.getGeneration();
    }
  }
  return max_gen;
}

◆ getNumInteractions()

int ldmx::CascadeHistory::getNumInteractions ( ) const

Definition at line 77 of file CascadeHistory.cxx.

                                             {
  int count = 0;
  for (const auto& step : steps_) {
    if (step.didInteract()) {
      ++count;
    }
  }
  return count;
}

◆ getNumSteps()

size_t ldmx::CascadeHistory::getNumSteps ( ) const

inline

Definition at line 55 of file CascadeHistory.h.

55{ return steps_.size(); }

◆ getResidualA()

int ldmx::CascadeHistory::getResidualA ( ) const

inline

Definition at line 52 of file CascadeHistory.h.

52{ return residual_a_; }

◆ getResidualZ()

int ldmx::CascadeHistory::getResidualZ ( ) const

inline

Definition at line 53 of file CascadeHistory.h.

53{ return residual_z_; }

◆ getStep()

const CascadeStep & ldmx::CascadeHistory::getStep ( size_t i ) const

inline

Definition at line 59 of file CascadeHistory.h.

59{ return steps_.at(i); }

◆ getStepByHistoryId()

const CascadeStep * ldmx::CascadeHistory::getStepByHistoryId ( int historyId ) const

Definition at line 18 of file CascadeHistory.cxx.

                                                                         {
  for (const auto& step : steps_) {
    if (step.getHistoryId() == historyId) {
      return &step;
    }
  }
  return nullptr;
}

◆ getSteps() [1/2]

std::vector< CascadeStep > & ldmx::CascadeHistory::getSteps ( )

inline

Definition at line 58 of file CascadeHistory.h.

58{ return steps_; }

◆ getSteps() [2/2]

const std::vector< CascadeStep > & ldmx::CascadeHistory::getSteps ( ) const

inline

Definition at line 57 of file CascadeHistory.h.

57{ return steps_; }

◆ getStepsAtGeneration()

std::vector< const CascadeStep * > ldmx::CascadeHistory::getStepsAtGeneration ( int generation ) const

Definition at line 36 of file CascadeHistory.cxx.

                          {
  std::vector<const CascadeStep*> result;
  for (const auto& step : steps_) {
    if (step.getGeneration() == generation) {
      result.push_back(&step);
    }
  }
  return result;
}

◆ getTargetA()

int ldmx::CascadeHistory::getTargetA ( ) const

inline

Definition at line 48 of file CascadeHistory.h.

48{ return target_a_; }

◆ getTargetZ()

int ldmx::CascadeHistory::getTargetZ ( ) const

inline

Definition at line 49 of file CascadeHistory.h.

49{ return target_z_; }

◆ print()

void ldmx::CascadeHistory::print ( ) const

Definition at line 87 of file CascadeHistory.cxx.

                                 {
  std::cout << "CascadeHistory: " << steps_.size() << " steps"
            << ", target A=" << target_a_ << " Z=" << target_z_
            << ", incident track=" << incident_track_id_ << "\n";
 
  for (const auto& step : steps_) {
    std::cout << "  [" << step.getHistoryId() << "] "
              << "PDG=" << step.getPdgId() << " gen=" << step.getGeneration()
              << " zone=" << step.getZone() << " E=" << step.getEnergy()
              << " MeV";
    if (step.getParentId() >= 0) {
      std::cout << " parent=" << step.getParentId();
    }
    if (step.didInteract()) {
      std::cout << " -> " << step.getNumDaughters() << " daughters";
    }
    if (step.didEscape()) {
      std::cout << " [escaped]";
    }
    std::cout << "\n";
  }
}

◆ reserve()

void ldmx::CascadeHistory::reserve ( size_t n )

inline

Definition at line 45 of file CascadeHistory.h.

45{ steps_.reserve(n); }

◆ setExcitationEnergy()

void ldmx::CascadeHistory::setExcitationEnergy ( double energy )

inline

Definition at line 37 of file CascadeHistory.h.

37{ excitation_energy_ = energy; }

◆ setIncidentEnergy()

void ldmx::CascadeHistory::setIncidentEnergy ( double energy )

inline

Definition at line 36 of file CascadeHistory.h.

36{ incident_energy_ = energy; }

◆ setIncidentTrackId()

void ldmx::CascadeHistory::setIncidentTrackId ( int trackId )

inline

Definition at line 31 of file CascadeHistory.h.

31{ incident_track_id_ = trackId; }

◆ setResidualNucleus()

void ldmx::CascadeHistory::setResidualNucleus	(	int	a,
		int	z )

inline

Definition at line 38 of file CascadeHistory.h.

                                        {
    residual_a_ = a;
    residual_z_ = z;
  }

◆ setTargetNucleus()

void ldmx::CascadeHistory::setTargetNucleus	(	int	a,
		int	z )

inline

Definition at line 32 of file CascadeHistory.h.

                                      {
    target_a_ = a;
    target_z_ = z;
  }

Member Data Documentation

◆ excitation_energy_

double ldmx::CascadeHistory::excitation_energy_ {0.0}

private

Definition at line 76 of file CascadeHistory.h.

76{0.0}; // [MeV]

◆ incident_energy_

double ldmx::CascadeHistory::incident_energy_ {0.0}

private

Definition at line 75 of file CascadeHistory.h.

75{0.0}; // [MeV]

◆ incident_track_id_

int ldmx::CascadeHistory::incident_track_id_ {-1}

private

Definition at line 72 of file CascadeHistory.h.

72{-1};

◆ residual_a_

int ldmx::CascadeHistory::residual_a_ {0}

private

Definition at line 77 of file CascadeHistory.h.

77{0};

◆ residual_z_

int ldmx::CascadeHistory::residual_z_ {0}

private

Definition at line 78 of file CascadeHistory.h.

78{0};

◆ steps_

std::vector<CascadeStep> ldmx::CascadeHistory::steps_

private

Definition at line 79 of file CascadeHistory.h.

◆ target_a_

int ldmx::CascadeHistory::target_a_ {0}

private

Definition at line 73 of file CascadeHistory.h.

73{0};

◆ target_z_

int ldmx::CascadeHistory::target_z_ {0}

private

Definition at line 74 of file CascadeHistory.h.

74{0};

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

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ addStep() [1/2]

◆ addStep() [2/2]

◆ clear()

◆ empty()

◆ getEscapedSteps()

◆ getExcitationEnergy()

◆ getIncidentEnergy()

◆ getIncidentStep()

◆ getIncidentTrackId()

◆ getInteractingSteps()

◆ getMaxGeneration()

◆ getNumInteractions()

◆ getNumSteps()

◆ getResidualA()

◆ getResidualZ()

◆ getStep()

◆ getStepByHistoryId()

◆ getSteps() [1/2]

◆ getSteps() [2/2]

◆ getStepsAtGeneration()

◆ getTargetA()

◆ getTargetZ()

◆ print()

◆ reserve()

◆ setExcitationEnergy()

◆ setIncidentEnergy()

◆ setIncidentTrackId()

◆ setResidualNucleus()

◆ setTargetNucleus()

Member Data Documentation

◆ excitation_energy_

◆ incident_energy_

◆ incident_track_id_

◆ residual_a_

◆ residual_z_

◆ steps_

◆ target_a_

◆ target_z_