sim::SimEnergyDeposit Class Reference

Energy deposition in the active material. More...

#include "SimEnergyDeposit.h"

Public Types
using	Length_t = float
using	Point_t = geo::Point_t

Public Member Functions
	SimEnergyDeposit (int np=0, int ne=0, double sy=0, double e=0., geo::Point_t start={0., 0., 0.}, geo::Point_t end={0., 0., 0.}, double t0=0., double t1=0., int id=0, int pdg=0, int origTrackID=0)
int	NumPhotons () const
int	NumFPhotons () const
int	NumSPhotons () const
int	NumElectrons () const
double	ScintYieldRatio () const
double	Energy () const
geo::Point_t	Start () const
geo::Point_t	End () const
double	Time () const
int	TrackID () const
int	OrigTrackID () const
void	setTrackID (int id)
int	PdgCode () const
geo::Length_t	StartX () const
geo::Length_t	StartY () const
geo::Length_t	StartZ () const
double	StartT () const
geo::Length_t	EndX () const
geo::Length_t	EndY () const
geo::Length_t	EndZ () const
double	EndT () const
geo::Point_t	MidPoint () const
geo::Length_t	MidPointX () const
geo::Length_t	MidPointY () const
geo::Length_t	MidPointZ () const
geo::Length_t	X () const
geo::Length_t	Y () const
geo::Length_t	Z () const
double	T () const
double	T0 () const
double	T1 () const
double	E () const
geo::Length_t	StepLength () const
bool	operator< (const SimEnergyDeposit &rhs) const

Private Attributes
int	numPhotons
	of scintillation photons More...
int	numElectrons
	of ionization electrons More...
float	scintYieldRatio
	scintillation yield of LAr More...
float	edep
	energy deposition (MeV) More...
geo::Point_t	startPos
	positions in (cm) More...
geo::Point_t	endPos
double	startTime
	(ns) More...
double	endTime
	(ns) More...
int	trackID
	simulation track id More...
int	pdgCode
	pdg code of particle to avoid lookup by particle type later More...
int	origTrackID
	complementary simulation track id, kept true to G4 even for shower secondaries/tertiaries etc. More...

Detailed Description

Energy deposition in the active material.

The detector simulation (presently LArG4, which invokes Geant4) propagates particles through the detector in intervals of "steps". In Geant4, a step is normally defined by the smallest of the distance from the current position of the particle to the point where it enters a new volume boundary, the particle undergoes some "interesting" physics event, or the range of the particle due to its energy falls below a given limit.

In LArG4, an additional limit is applied: We force the steps to be small (typically 1/10th the wire spacing in the planes of the TPC) so we can process the energy deposited by each step into electron clusters.

The SimEnergyDeposit class defines what Geant4 truth information for each step is passed to the ionization -> sim::SimChannel conversion, and for the optical-photon -> sim::SimPhoton conversion.

William Seligman, Nevis Labs, 10/12/2017

Definition at line 40 of file SimEnergyDeposit.h.

Member Typedef Documentation

using sim::SimEnergyDeposit::Length_t = float

Definition at line 43 of file SimEnergyDeposit.h.

using sim::SimEnergyDeposit::Point_t = geo::Point_t

Definition at line 44 of file SimEnergyDeposit.h.

Constructor & Destructor Documentation

sim::SimEnergyDeposit::SimEnergyDeposit ( int  np = 0, int  ne = 0, double  sy = 0, double  e = 0., geo::Point_t  start = {0., 0., 0.}, geo::Point_t  end = {0., 0., 0.}, double  t0 = 0., double  t1 = 0., int  id = 0, int  pdg = 0, int  origTrackID = 0  )

inline

Definition at line 58 of file SimEnergyDeposit.h.

                                        {0., 0., 0.},
                     geo::Point_t end = {0., 0., 0.},
                     double t0 = 0.,
                     double t1 = 0.,
                     int id = 0,
                     int pdg = 0,
                     int origTrackID = 0)
      : numPhotons(np)
      //      , numFPhotons(nfp)
      //      , numSPhotons(nsp)
      , numElectrons(ne)
      , scintYieldRatio(sy)
      , edep(e)
      , startPos(start)
      , endPos(end)
      , startTime(t0)
      , endTime(t1)
      , trackID(id)
      , pdgCode(pdg)
      , origTrackID(origTrackID)
    {}

Member Function Documentation

double sim::SimEnergyDeposit::E ( ) const

inline

Definition at line 133 of file SimEnergyDeposit.h.

References edep.

{ return edep; }

geo::Point_t sim::SimEnergyDeposit::End ( ) const

inline

Definition at line 97 of file SimEnergyDeposit.h.

References endPos.

Referenced by sim::DumpSimEnergyDeposits::dumpEnergyDeposit(), sim::MergeSimSourcesUtility::offsetSimEnergyDepositTrackID(), and phot::PhotonLibraryPropagation::produce().

{ return {endPos.X(), endPos.Y(), endPos.Z()}; }

double sim::SimEnergyDeposit::EndT ( ) const

inline

Definition at line 115 of file SimEnergyDeposit.h.

References endTime.

{ return endTime; }

geo::Length_t sim::SimEnergyDeposit::EndX ( ) const

inline

Definition at line 112 of file SimEnergyDeposit.h.

References endPos.

Referenced by larg4::ISCalcCorrelated::AngleToEFieldAtStep(), and larg4::ISCalcNESTLAr::CalcIonAndScint().

{ return endPos.X(); }

geo::Length_t sim::SimEnergyDeposit::EndY ( ) const

inline

Definition at line 113 of file SimEnergyDeposit.h.

References endPos.

Referenced by larg4::ISCalcCorrelated::AngleToEFieldAtStep(), and larg4::ISCalcNESTLAr::CalcIonAndScint().

{ return endPos.Y(); }

geo::Length_t sim::SimEnergyDeposit::EndZ ( ) const

inline

Definition at line 114 of file SimEnergyDeposit.h.

References endPos.

Referenced by larg4::ISCalcCorrelated::AngleToEFieldAtStep(), and larg4::ISCalcNESTLAr::CalcIonAndScint().

{ return endPos.Z(); }

double sim::SimEnergyDeposit::Energy ( ) const

inline

Definition at line 95 of file SimEnergyDeposit.h.

References edep.

Referenced by larg4::ISCalcSeparate::CalcIon(), larg4::ISCalcNESTLAr::CalcIonAndScint(), larg4::ISCalcSeparate::CalcIonAndScint(), larg4::ISCalcCorrelated::CalcIonAndScint(), larg4::ISCalcSeparate::CalcScint(), detsim::ISCalculationSeparate::CalculateIonization(), detsim::ISCalculationSeparate::CalculateIonizationAndScintillation(), detsim::ISCalculationSeparate::CalculateScintillation(), sim::DumpSimEnergyDeposits::dumpEnergyDeposit(), and sim::MergeSimSourcesUtility::offsetSimEnergyDepositTrackID().

{ return edep; }

geo::Point_t sim::SimEnergyDeposit::MidPoint ( ) const

inline

Definition at line 118 of file SimEnergyDeposit.h.

References endPos, and startPos.

Referenced by larg4::ISCalcCorrelated::AngleToEFieldAtStep(), sim::DumpSimEnergyDeposits::dumpEnergyDeposit(), larg4::ISCalcNESTLAr::EFieldAtStep(), larg4::ISCalcSeparate::EFieldAtStep(), larg4::ISCalcCorrelated::EFieldAtStep(), and phot::PhotonLibraryPropagation::produce().

    {
      return {(startPos.X() + endPos.X()) / 2.,
              (startPos.Y() + endPos.Y()) / 2.,
              (startPos.Z() + endPos.Z()) / 2.};
    }

geo::Length_t sim::SimEnergyDeposit::MidPointX ( ) const

inline

Definition at line 124 of file SimEnergyDeposit.h.

References endPos, and startPos.

Referenced by detsim::ISCalculationSeparate::CalculateIonization(), and detsim::ISCalculationSeparate::EFieldAtStep().

{ return (startPos.X() + endPos.X()) / 2.; }

geo::Length_t sim::SimEnergyDeposit::MidPointY ( ) const

inline

Definition at line 125 of file SimEnergyDeposit.h.

References endPos, and startPos.

Referenced by detsim::ISCalculationSeparate::CalculateIonization(), and detsim::ISCalculationSeparate::EFieldAtStep().

{ return (startPos.Y() + endPos.Y()) / 2.; }

geo::Length_t sim::SimEnergyDeposit::MidPointZ ( ) const

inline

Definition at line 126 of file SimEnergyDeposit.h.

References endPos, and startPos.

Referenced by detsim::ISCalculationSeparate::CalculateIonization(), and detsim::ISCalculationSeparate::EFieldAtStep().

{ return (startPos.Z() + endPos.Z()) / 2.; }

int sim::SimEnergyDeposit::NumElectrons ( ) const

inline

Definition at line 93 of file SimEnergyDeposit.h.

References numElectrons.

Referenced by sim::DumpSimEnergyDeposits::dumpEnergyDeposit(), and sim::MergeSimSourcesUtility::offsetSimEnergyDepositTrackID().

{ return numElectrons; }

int sim::SimEnergyDeposit::NumFPhotons ( ) const

inline

Definition at line 91 of file SimEnergyDeposit.h.

References numPhotons, and scintYieldRatio.

Referenced by sim::DumpSimEnergyDeposits::dumpEnergyDeposit().

{ return round(numPhotons * scintYieldRatio); }

int sim::SimEnergyDeposit::NumPhotons ( ) const

inline

Definition at line 90 of file SimEnergyDeposit.h.

References numPhotons.

Referenced by sim::DumpSimEnergyDeposits::dumpEnergyDeposit(), and sim::MergeSimSourcesUtility::offsetSimEnergyDepositTrackID().

{ return numPhotons; }

int sim::SimEnergyDeposit::NumSPhotons ( ) const

inline

Definition at line 92 of file SimEnergyDeposit.h.

References numPhotons, and scintYieldRatio.

Referenced by sim::DumpSimEnergyDeposits::dumpEnergyDeposit().

{ return round(numPhotons * (1.0 - scintYieldRatio)); }

bool sim::SimEnergyDeposit::operator< ( const SimEnergyDeposit &  rhs ) const

inline

Definition at line 147 of file SimEnergyDeposit.h.

References edep, startPos, startTime, and trackID.

    {
      return trackID < rhs.trackID && startTime < rhs.startTime &&
             startPos.Z() < rhs.startPos.Z() && startPos.Y() < rhs.startPos.Y() &&
             startPos.X() < rhs.startPos.X() && edep > rhs.edep; // sort by _decreasing_ energy
    }

int sim::SimEnergyDeposit::OrigTrackID ( ) const

inline

Definition at line 100 of file SimEnergyDeposit.h.

References origTrackID.

Referenced by sim::MergeSimSourcesUtility::offsetSimEnergyDepositTrackID().

{ return origTrackID; }

int sim::SimEnergyDeposit::PdgCode ( ) const

inline

Definition at line 102 of file SimEnergyDeposit.h.

References pdgCode.

Referenced by larg4::ISCalcNESTLAr::CalcIonAndScint(), larg4::ISCalcCorrelated::CalcIonAndScint(), detsim::ISCalculationSeparate::CalculateScintillation(), sim::DumpSimEnergyDeposits::dumpEnergyDeposit(), larg4::ISCalc::GetScintYield(), larg4::ISCalc::GetScintYieldRatio(), and sim::MergeSimSourcesUtility::offsetSimEnergyDepositTrackID().

{ return pdgCode; }

double sim::SimEnergyDeposit::ScintYieldRatio ( ) const

inline

Definition at line 94 of file SimEnergyDeposit.h.

References scintYieldRatio.

Referenced by sim::MergeSimSourcesUtility::offsetSimEnergyDepositTrackID().

{ return scintYieldRatio; }

void sim::SimEnergyDeposit::setTrackID ( int  id )

inline

Definition at line 101 of file SimEnergyDeposit.h.

References trackID.

{ trackID = id; }

geo::Point_t sim::SimEnergyDeposit::Start ( ) const

inline

Definition at line 96 of file SimEnergyDeposit.h.

References startPos.

Referenced by sim::DumpSimEnergyDeposits::dumpEnergyDeposit(), and sim::MergeSimSourcesUtility::offsetSimEnergyDepositTrackID().

{ return {startPos.X(), startPos.Y(), startPos.Z()}; }

double sim::SimEnergyDeposit::StartT ( ) const

inline

Definition at line 111 of file SimEnergyDeposit.h.

References startTime.

{ return startTime; }

geo::Length_t sim::SimEnergyDeposit::StartX ( ) const

inline

Definition at line 108 of file SimEnergyDeposit.h.

References startPos.

Referenced by larg4::ISCalcCorrelated::AngleToEFieldAtStep(), and larg4::ISCalcNESTLAr::CalcIonAndScint().

{ return startPos.X(); }

geo::Length_t sim::SimEnergyDeposit::StartY ( ) const

inline

Definition at line 109 of file SimEnergyDeposit.h.

References startPos.

Referenced by larg4::ISCalcCorrelated::AngleToEFieldAtStep(), and larg4::ISCalcNESTLAr::CalcIonAndScint().

{ return startPos.Y(); }

geo::Length_t sim::SimEnergyDeposit::StartZ ( ) const

inline

Definition at line 110 of file SimEnergyDeposit.h.

References startPos.

Referenced by larg4::ISCalcCorrelated::AngleToEFieldAtStep(), and larg4::ISCalcNESTLAr::CalcIonAndScint().

{ return startPos.Z(); }

geo::Length_t sim::SimEnergyDeposit::StepLength ( ) const

inline

Definition at line 138 of file SimEnergyDeposit.h.

References endPos, and startPos.

Referenced by larg4::ISCalcSeparate::CalcIon(), larg4::ISCalcCorrelated::CalcIonAndScint(), detsim::ISCalculationSeparate::CalculateIonization(), and sim::DumpSimEnergyDeposits::dumpEnergyDeposit().

{ return (endPos - startPos).R(); }

double sim::SimEnergyDeposit::T ( ) const

inline

Definition at line 130 of file SimEnergyDeposit.h.

References endTime, and startTime.

{ return (startTime + endTime) / 2.; }

double sim::SimEnergyDeposit::T0 ( ) const

inline

Definition at line 131 of file SimEnergyDeposit.h.

References startTime.

Referenced by sim::MergeSimSourcesUtility::offsetSimEnergyDepositTrackID(), and phot::PhotonLibraryPropagation::produce().

{ return startTime; }

double sim::SimEnergyDeposit::T1 ( ) const

inline

Definition at line 132 of file SimEnergyDeposit.h.

References endTime.

Referenced by sim::MergeSimSourcesUtility::offsetSimEnergyDepositTrackID().

{ return endTime; }

double sim::SimEnergyDeposit::Time ( ) const

inline

Definition at line 98 of file SimEnergyDeposit.h.

References endTime, and startTime.

Referenced by sim::DumpSimEnergyDeposits::dumpEnergyDeposit().

{ return (startTime + endTime) / 2.; }

int sim::SimEnergyDeposit::TrackID ( ) const

inline

Definition at line 99 of file SimEnergyDeposit.h.

References trackID.

Referenced by sim::DumpSimEnergyDeposits::dumpEnergyDeposit(), and sim::MergeSimSourcesUtility::offsetSimEnergyDepositTrackID().

{ return trackID; }

geo::Length_t sim::SimEnergyDeposit::X ( ) const

inline

Definition at line 127 of file SimEnergyDeposit.h.

References endPos, and startPos.

{ return (startPos.X() + endPos.X()) / 2.; }

geo::Length_t sim::SimEnergyDeposit::Y ( ) const

inline

Definition at line 128 of file SimEnergyDeposit.h.

References endPos, and startPos.

{ return (startPos.Y() + endPos.Y()) / 2.; }

geo::Length_t sim::SimEnergyDeposit::Z ( ) const

inline

Definition at line 129 of file SimEnergyDeposit.h.

References endPos, and startPos.

{ return (startPos.Z() + endPos.Z()) / 2.; }

Member Data Documentation

float sim::SimEnergyDeposit::edep

private

energy deposition (MeV)

Definition at line 183 of file SimEnergyDeposit.h.

Referenced by E(), Energy(), and operator<().

geo::Point_t sim::SimEnergyDeposit::endPos

private

Definition at line 185 of file SimEnergyDeposit.h.

Referenced by End(), EndX(), EndY(), EndZ(), MidPoint(), MidPointX(), MidPointY(), MidPointZ(), StepLength(), X(), Y(), and Z().

double sim::SimEnergyDeposit::endTime

private

(ns)

Definition at line 187 of file SimEnergyDeposit.h.

Referenced by EndT(), T(), T1(), and Time().

int sim::SimEnergyDeposit::numElectrons

private

of ionization electrons

Definition at line 181 of file SimEnergyDeposit.h.

Referenced by NumElectrons().

int sim::SimEnergyDeposit::numPhotons

private

of scintillation photons

Definition at line 178 of file SimEnergyDeposit.h.

Referenced by NumFPhotons(), NumPhotons(), and NumSPhotons().

int sim::SimEnergyDeposit::origTrackID

private

complementary simulation track id, kept true to G4 even for shower secondaries/tertiaries etc.

Definition at line 191 of file SimEnergyDeposit.h.

Referenced by OrigTrackID().

int sim::SimEnergyDeposit::pdgCode

private

pdg code of particle to avoid lookup by particle type later

Definition at line 189 of file SimEnergyDeposit.h.

Referenced by PdgCode().

float sim::SimEnergyDeposit::scintYieldRatio

private

scintillation yield of LAr

Definition at line 182 of file SimEnergyDeposit.h.

Referenced by NumFPhotons(), NumSPhotons(), and ScintYieldRatio().

geo::Point_t sim::SimEnergyDeposit::startPos

private

positions in (cm)

Definition at line 184 of file SimEnergyDeposit.h.

Referenced by MidPoint(), MidPointX(), MidPointY(), MidPointZ(), operator<(), Start(), StartX(), StartY(), StartZ(), StepLength(), X(), Y(), and Z().

double sim::SimEnergyDeposit::startTime

private

(ns)

Definition at line 186 of file SimEnergyDeposit.h.

Referenced by operator<(), StartT(), T(), T0(), and Time().

int sim::SimEnergyDeposit::trackID

private

simulation track id

Definition at line 188 of file SimEnergyDeposit.h.

Referenced by operator<(), setTrackID(), and TrackID().

---

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

• lardataobj/v09_18_03/source/lardataobj/Simulation/SimEnergyDeposit.h