EDepSim::Trajectory Class Reference

#include <EDepSimTrajectory.hh>

Inheritance diagram for EDepSim::Trajectory:

Public Member Functions
	Trajectory ()
	Trajectory (const G4Track *aTrack)
	Trajectory (EDepSim::Trajectory &)
virtual	~Trajectory ()
void *	operator new (size_t)
void	operator delete (void *)
int	operator== (const EDepSim::Trajectory &right) const
G4int	GetTrackID () const
	Get the track id described by this trajectory. More...
G4int	GetParentID () const
G4String	GetParticleName () const
	Get the particle name. More...
G4double	GetCharge () const
	Get the particle charge. More...
G4int	GetPDGEncoding () const
	Get the PDG MC particle number for this particle. More...
G4String	GetProcessName () const
	Get the interaction process that created the trajectory. More...
G4ThreeVector	GetInitialMomentum () const
	Get the initial momentum of the particle that created this trajectory. More...
G4double	GetInitialKineticEnergy () const
G4double	GetSDEnergyDeposit () const
	Get the amount of energy deposited into a sensitive detector. More...
void	AddSDEnergyDeposit (double energy)
	Add energy deposited into a sensitive detector. More...
G4double	GetSDLength () const
	Get the total length of this trajectory that is in a sensitive detector. More...
void	AddSDLength (double len)
	Add the length that has been deposited into a sensitive detector. More...
G4double	GetSDTotalEnergyDeposit () const
void	AddSDDaughterEnergyDeposit (double energy)
	Add energy deposited into a sensitive detector by a daughter. More...
G4double	GetRange () const
	Get the range of the particle that created this trajectory. More...
void	MarkTrajectory (bool save=true)
	Mark this trajectory as one that should be saved in the output. More...
bool	SaveTrajectory () const
	Check if this trajectory should be saved. More...
virtual void	AppendStep (const G4Step *aStep)
virtual int	GetPointEntries () const
	Get the number of trajectory points saved with this trajectory. More...
virtual G4VTrajectoryPoint *	GetPoint (G4int i) const
	Get a particular trajectory point. More...
virtual void	MergeTrajectory (G4VTrajectory *secondTrajectory)
G4ParticleDefinition *	GetParticleDefinition () const
	Get the full definition of the particle. More...
virtual const std::map< G4String, G4AttDef > *	GetAttDefs () const
virtual std::vector< G4AttValue > *	CreateAttValues () const

Private Attributes
TrajectoryPointContainer *	fPositionRecord
G4int	fTrackID
G4int	fParentID
G4int	fPDGEncoding
G4double	fPDGCharge
G4String	fParticleName
G4String	fProcessName
G4ThreeVector	fInitialMomentum
G4double	fSDEnergyDeposit
G4double	fSDTotalEnergyDeposit
G4double	fSDLength
bool	fSaveTrajectory

Detailed Description

EDepSim specific trajectory class to save internal bookkeeping information. This keeps track of information about a particular particle track. Important information kept includes how much energy this trajectory has deposited in sensitive detectors, and it can query it's children to find out how much energy they deposited. It also keeps track of the process that created the trajectory, the total length in the sensitive detectors, and points along the trajectory.

Definition at line 28 of file EDepSimTrajectory.hh.

Constructor & Destructor Documentation

EDepSim::Trajectory::Trajectory

(

)

Definition at line 18 of file EDepSimTrajectory.cc.

    : fPositionRecord(0), fTrackID(0), fParentID(0),
      fPDGEncoding(0), fPDGCharge(0.0), fParticleName(""),
      fProcessName(""), fInitialMomentum(G4ThreeVector()),
      fSDEnergyDeposit(0), fSDTotalEnergyDeposit(0), fSDLength(0), 
      fSaveTrajectory(false) {;}

EDepSim::Trajectory::Trajectory

(

const G4Track *

aTrack

)

Definition at line 25 of file EDepSimTrajectory.cc.

                                                   {
    fPositionRecord = new TrajectoryPointContainer();
    // Following is for the first trajectory point
    fPositionRecord->push_back(new EDepSim::TrajectoryPoint(aTrack));
    fTrackID = aTrack->GetTrackID();
    fParentID = aTrack->GetParentID();
    G4ParticleDefinition * fpParticleDefinition = aTrack->GetDefinition();
    fPDGEncoding = fpParticleDefinition->GetPDGEncoding();
    fPDGCharge = fpParticleDefinition->GetPDGCharge();
    fParticleName = fpParticleDefinition->GetParticleName();
    const G4VProcess* proc = aTrack->GetCreatorProcess();
    if (proc) fProcessName = proc->GetProcessName();
    else fProcessName = "primary";
    fInitialMomentum = aTrack->GetMomentum();
    fSDEnergyDeposit = 0.0;
    fSDTotalEnergyDeposit = 0.0;
    fSDLength = 0.0;
    fSaveTrajectory = false;
}

EDepSim::Trajectory::Trajectory

(

EDepSim::Trajectory &

right

)

Definition at line 45 of file EDepSimTrajectory.cc.

                                                       : G4VTrajectory() {
    fTrackID = right.fTrackID;
    fParentID = right.fParentID;
    fPDGEncoding = right.fPDGEncoding;
    fPDGCharge = right.fPDGCharge;
    fParticleName = right.fParticleName;
    fProcessName = right.fProcessName;
    fInitialMomentum = right.fInitialMomentum;
    fSDEnergyDeposit = right.fSDEnergyDeposit;
    fSDTotalEnergyDeposit = right.fSDTotalEnergyDeposit;
    fSDLength = right.fSDLength;
    fSaveTrajectory = right.fSaveTrajectory;

    fPositionRecord = new TrajectoryPointContainer();
    for(size_t i=0;i<right.fPositionRecord->size();++i) {
        EDepSim::TrajectoryPoint* rightPoint 
            = (EDepSim::TrajectoryPoint*)((*(right.fPositionRecord))[i]);
        fPositionRecord->push_back(new EDepSim::TrajectoryPoint(*rightPoint));
    }
}

EDepSim::Trajectory::~Trajectory ( )

virtual

Definition at line 66 of file EDepSimTrajectory.cc.

                               {
    for(size_t i=0;i<fPositionRecord->size();++i){
        delete  (*fPositionRecord)[i];
    }
    fPositionRecord->clear();
    
    delete fPositionRecord;
}

Member Function Documentation

void EDepSim::Trajectory::AddSDDaughterEnergyDeposit ( double  energy )

inline

Add energy deposited into a sensitive detector by a daughter.

Definition at line 90 of file EDepSimTrajectory.hh.

                                                   {
        fSDTotalEnergyDeposit += energy;
    }

void EDepSim::Trajectory::AddSDEnergyDeposit ( double  energy )

inline

Add energy deposited into a sensitive detector.

Definition at line 72 of file EDepSimTrajectory.hh.

                                           {
        fSDEnergyDeposit += energy;
        fSDTotalEnergyDeposit += energy;
    }

void EDepSim::Trajectory::AddSDLength ( double  len )

inline

Add the length that has been deposited into a sensitive detector.

Definition at line 81 of file EDepSimTrajectory.hh.

                                 {
        fSDLength += len;
    }

void EDepSim::Trajectory::AppendStep ( const G4Step *  aStep )

virtual

Definition at line 188 of file EDepSimTrajectory.cc.

                                                      {
    EDepSim::TrajectoryPoint* point = new EDepSim::TrajectoryPoint(aStep);
    fPositionRecord->push_back(point);
}

std::vector< G4AttValue > * EDepSim::Trajectory::CreateAttValues ( ) const

virtual

Definition at line 153 of file EDepSimTrajectory.cc.

                                                                {
    std::string c;
    std::ostringstream s(c);
    
    std::vector<G4AttValue>* values = new std::vector<G4AttValue>;
    
    s.seekp(std::ios::beg);
    s << fTrackID << std::ends;
    values->push_back(G4AttValue("ID",c.c_str(),""));
    
    s.seekp(std::ios::beg);
    s << fParentID << std::ends;
    values->push_back(G4AttValue("PID",c.c_str(),""));
    
    values->push_back(G4AttValue("PN",fParticleName,""));
    
    s.seekp(std::ios::beg);
    s << fPDGCharge << std::ends;
    values->push_back(G4AttValue("Ch",c.c_str(),""));
    
    s.seekp(std::ios::beg);
    s << fPDGEncoding << std::ends;
    values->push_back(G4AttValue("PDG",c.c_str(),""));
    
    s.seekp(std::ios::beg);
    s << G4BestUnit(fInitialMomentum,"Energy") << std::ends;
    values->push_back(G4AttValue("IMom",c.c_str(),""));
    
    s.seekp(std::ios::beg);
    s << GetPointEntries() << std::ends;
    values->push_back(G4AttValue("NTP",c.c_str(),""));
    
    return values;
}

const std::map< G4String, G4AttDef > * EDepSim::Trajectory::GetAttDefs ( ) const

virtual

Definition at line 108 of file EDepSimTrajectory.cc.

                                                                     {
    G4bool isNew;
    std::map<G4String,G4AttDef>* store
        = G4AttDefStore::GetInstance("EDepSim::Trajectory",isNew);
    
    if (isNew) {
        G4String ID("ID");
        (*store)[ID] = G4AttDef(ID,
                                "Track ID",
                                "Bookkeeping","","G4int");
        
        G4String PID("PID");
        (*store)[PID] = G4AttDef(PID,
                                 "Parent ID",
                                 "Bookkeeping","","G4int");
        
        G4String PN("PN");
        (*store)[PN] = G4AttDef(PN,
                                "Particle Name",
                                "Physics","","G4String");
        
        G4String Ch("Ch");
        (*store)[Ch] = G4AttDef(Ch,
                                "Charge",
                                "Physics","","G4double");
        
        G4String PDG("PDG");
        (*store)[PDG] = G4AttDef(PDG,
                                 "PDG Encoding",
                                 "Physics","","G4int");
        
        G4String IMom("IMom");
        (*store)[IMom] = G4AttDef(IMom, 
                                  "Momentum of track at start of trajectory",
                                  "Physics","","G4ThreeVector");
        
        G4String NTP("NTP");
        (*store)[NTP] = G4AttDef(NTP,
                                 "No. of points",
                                 "Physics","","G4int");
        
    }
    return store;
}

G4double EDepSim::Trajectory::GetCharge ( ) const

inline

Get the particle charge.

Definition at line 53 of file EDepSimTrajectory.hh.

{return fPDGCharge;}

G4double EDepSim::Trajectory::GetInitialKineticEnergy

(

)

const

Get the initial kinetic energy of the particle that created this trajectory.

Definition at line 75 of file EDepSimTrajectory.cc.

                                                          {
    const G4ParticleDefinition* p = GetParticleDefinition();
    double mom = GetInitialMomentum().mag();
    if (!p) return mom;
    double mass = p->GetPDGMass();
    double kin = std::sqrt(mom*mom + mass*mass) - mass;
    if (kin<0.0) return 0.0;
    return kin;
}

G4ThreeVector EDepSim::Trajectory::GetInitialMomentum ( ) const

inline

Get the initial momentum of the particle that created this trajectory.

Definition at line 62 of file EDepSimTrajectory.hh.

{return fInitialMomentum;}

G4int EDepSim::Trajectory::GetParentID ( ) const

inline

Get the track id of the parent of the track described by this trajectory.

Definition at line 47 of file EDepSimTrajectory.hh.

{return fParentID;}

G4ParticleDefinition * EDepSim::Trajectory::GetParticleDefinition

(

)

const

Get the full definition of the particle.

Definition at line 193 of file EDepSimTrajectory.cc.

                                                                     {
    return (G4ParticleTable::GetParticleTable()->FindParticle(fParticleName));
}

G4String EDepSim::Trajectory::GetParticleName ( ) const

inline

Get the particle name.

Definition at line 50 of file EDepSimTrajectory.hh.

{return fParticleName;}

G4int EDepSim::Trajectory::GetPDGEncoding ( ) const

inline

Get the PDG MC particle number for this particle.

Definition at line 56 of file EDepSimTrajectory.hh.

{return fPDGEncoding;}

virtual G4VTrajectoryPoint* EDepSim::Trajectory::GetPoint ( G4int  i ) const

inlinevirtual

Get a particular trajectory point.

Definition at line 110 of file EDepSimTrajectory.hh.

                                                        {
        return (*fPositionRecord)[i];
    }

virtual int EDepSim::Trajectory::GetPointEntries ( ) const

inlinevirtual

Get the number of trajectory points saved with this trajectory.

Definition at line 107 of file EDepSimTrajectory.hh.

{return fPositionRecord->size();}

G4String EDepSim::Trajectory::GetProcessName ( ) const

inline

Get the interaction process that created the trajectory.

Definition at line 59 of file EDepSimTrajectory.hh.

{return fProcessName;}

G4double EDepSim::Trajectory::GetRange

(

)

const

Get the range of the particle that created this trajectory.

Definition at line 85 of file EDepSimTrajectory.cc.

                                           {
    if (GetPointEntries()<2) return 0.0;
    G4ThreeVector first 
        = dynamic_cast<EDepSim::TrajectoryPoint*>(GetPoint(0))->GetPosition();
    G4ThreeVector last 
        = dynamic_cast<EDepSim::TrajectoryPoint*>(GetPoint(GetPointEntries()-1))
            ->GetPosition();
    return (last - first).mag();
}

G4double EDepSim::Trajectory::GetSDEnergyDeposit ( ) const

inline

Get the amount of energy deposited into a sensitive detector.

Definition at line 69 of file EDepSimTrajectory.hh.

{return fSDEnergyDeposit;}

G4double EDepSim::Trajectory::GetSDLength ( ) const

inline

Get the total length of this trajectory that is in a sensitive detector.

Definition at line 78 of file EDepSimTrajectory.hh.

{return fSDLength;}

G4double EDepSim::Trajectory::GetSDTotalEnergyDeposit ( ) const

inline

Get the total amount of energy deposited into a sensitive detector by this trajectory and all of it's daughters.

Definition at line 87 of file EDepSimTrajectory.hh.

{return fSDTotalEnergyDeposit;}

G4int EDepSim::Trajectory::GetTrackID ( ) const

inline

Get the track id described by this trajectory.

Definition at line 43 of file EDepSimTrajectory.hh.

{return fTrackID;}

void EDepSim::Trajectory::MarkTrajectory

(

bool

save = true

)

Mark this trajectory as one that should be saved in the output.

Definition at line 95 of file EDepSimTrajectory.cc.

                                                {
    fSaveTrajectory = true;
    if (!save) return;
    // Mark all parents to be saved as well.
    G4VTrajectory* g4Traj = EDepSim::TrajectoryMap::Get(fParentID);
    if (!g4Traj) return;
    EDepSim::Trajectory* traj = dynamic_cast<EDepSim::Trajectory*>(g4Traj);
    if (!traj) return;
    // Protect against infinite loops.
    if (this == traj) return;
    traj->MarkTrajectory(save);
}

void EDepSim::Trajectory::MergeTrajectory ( G4VTrajectory *  secondTrajectory )

virtual

Definition at line 197 of file EDepSimTrajectory.cc.

                                                                       {
    if(!secondTrajectory) return;
    EDepSim::Trajectory* second = (EDepSim::Trajectory*)secondTrajectory;
    G4int ent = second->GetPointEntries();
    // initial point of the second trajectory should not be merged
    for(G4int i=1; i<ent; ++i) { 
        fPositionRecord->push_back((*(second->fPositionRecord))[i]);
    }
    delete (*second->fPositionRecord)[0];
    second->fPositionRecord->clear();
}

void EDepSim::Trajectory::operator delete ( void *  aTrajectory )

inline

Definition at line 149 of file EDepSimTrajectory.hh.

                                                                {
    aTrajAllocator.FreeSingle((EDepSim::Trajectory*)aTrajectory);
}

void * EDepSim::Trajectory::operator new ( size_t  )

inline

Definition at line 144 of file EDepSimTrajectory.hh.

                                                   {
    void* aTrajectory = (void*) aTrajAllocator.MallocSingle();
    return aTrajectory;
}

int EDepSim::Trajectory::operator== ( const EDepSim::Trajectory &  right ) const

inline

Definition at line 38 of file EDepSimTrajectory.hh.

                                                                  {
        return (this==&right);
    }

bool EDepSim::Trajectory::SaveTrajectory ( ) const

inline

Check if this trajectory should be saved.

Definition at line 101 of file EDepSimTrajectory.hh.

{ return fSaveTrajectory;}

Member Data Documentation

G4ThreeVector EDepSim::Trajectory::fInitialMomentum

private

Definition at line 131 of file EDepSimTrajectory.hh.

G4int EDepSim::Trajectory::fParentID

private

Definition at line 126 of file EDepSimTrajectory.hh.

G4String EDepSim::Trajectory::fParticleName

private

Definition at line 129 of file EDepSimTrajectory.hh.

G4double EDepSim::Trajectory::fPDGCharge

private

Definition at line 128 of file EDepSimTrajectory.hh.

G4int EDepSim::Trajectory::fPDGEncoding

private

Definition at line 127 of file EDepSimTrajectory.hh.

TrajectoryPointContainer* EDepSim::Trajectory::fPositionRecord

private

Definition at line 124 of file EDepSimTrajectory.hh.

G4String EDepSim::Trajectory::fProcessName

private

Definition at line 130 of file EDepSimTrajectory.hh.

bool EDepSim::Trajectory::fSaveTrajectory

private

Definition at line 135 of file EDepSimTrajectory.hh.

G4double EDepSim::Trajectory::fSDEnergyDeposit

private

Definition at line 132 of file EDepSimTrajectory.hh.

G4double EDepSim::Trajectory::fSDLength

private

Definition at line 134 of file EDepSimTrajectory.hh.

G4double EDepSim::Trajectory::fSDTotalEnergyDeposit

private

Definition at line 133 of file EDepSimTrajectory.hh.

G4int EDepSim::Trajectory::fTrackID

private

Definition at line 125 of file EDepSimTrajectory.hh.

---

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

• edep-sim/src/EDepSimTrajectory.hh
• edep-sim/src/EDepSimTrajectory.cc