simb::MCParticle Class Reference

#include <MCParticle.h>

Public Member Functions
	MCParticle ()
	Don't write this as ROOT output. More...
	MCParticle (const int trackId, const int pdg, const std::string process, const int mother=-1, const double mass=s_uninitialized, const int status=1)
	Standard constructor. More...
	MCParticle (MCParticle const &)=default
MCParticle &	operator= (const MCParticle &)=default
	MCParticle (MCParticle &&)=default
MCParticle &	operator= (MCParticle &&)=default
	MCParticle (MCParticle const &, int)
int	TrackId () const
int	StatusCode () const
int	PdgCode () const
int	Mother () const
const TVector3 &	Polarization () const
void	SetPolarization (const TVector3 &p)
std::string	Process () const
std::string	EndProcess () const
void	SetEndProcess (std::string s)
void	AddDaughter (const int trackID)
int	NumberDaughters () const
int	Daughter (const int i) const
unsigned int	NumberTrajectoryPoints () const
const TLorentzVector &	Position (const int i=0) const
double	Vx (const int i=0) const
double	Vy (const int i=0) const
double	Vz (const int i=0) const
double	T (const int i=0) const
const TLorentzVector &	EndPosition () const
double	EndX () const
double	EndY () const
double	EndZ () const
double	EndT () const
const TLorentzVector &	Momentum (const int i=0) const
double	Px (const int i=0) const
double	Py (const int i=0) const
double	Pz (const int i=0) const
double	E (const int i=0) const
double	P (const int i=0) const
double	Pt (const int i=0) const
double	Mass () const
const TLorentzVector &	EndMomentum () const
double	EndPx () const
double	EndPy () const
double	EndPz () const
double	EndE () const
void	SetGvtx (double *v)
void	SetGvtx (float *v)
void	SetGvtx (TLorentzVector v)
void	SetGvtx (double x, double y, double z, double t)
TLorentzVector	GetGvtx () const
double	Gvx () const
double	Gvy () const
double	Gvz () const
double	Gvt () const
int	FirstDaughter () const
int	LastDaughter () const
void	SetRescatter (int code)
int	Rescatter () const
const simb::MCTrajectory &	Trajectory () const
void	AddTrajectoryPoint (TLorentzVector const &position, TLorentzVector const &momentum)
void	AddTrajectoryPoint (TLorentzVector const &position, TLorentzVector const &momentum, std::string const &process, bool keepTransportation=false)
double	Weight () const
void	SetWeight (double wt)
void	SparsifyTrajectory (double margin=0.1, bool keep_second_to_last=false)
bool	operator< (const simb::MCParticle &other) const

Static Public Attributes
static const int	s_uninitialized = std::numeric_limits<int>::min()

Protected Types
typedef std::set< int >	daughters_type

Protected Attributes
int	fstatus
	Status code from generator, geant, etc. More...
int	ftrackId
	TrackId. More...
int	fpdgCode
	PDG code. More...
int	fmother
	Mother. More...
std::string	fprocess
	Detector-simulation physics process that created the particle. More...
std::string	fendprocess
	end process for the particle More...
simb::MCTrajectory	ftrajectory
	particle trajectory (position,momentum) More...
double	fmass
	Mass; from PDG unless overridden Should be in GeV. More...
TVector3	fpolarization
	Polarization. More...
daughters_type	fdaughters
	Sorted list of daughters of this particle. More...
double	fWeight
	Assigned weight to this particle for MC tests. More...
TLorentzVector	fGvtx
int	frescatter
	rescatter code More...

Friends
std::ostream &	operator<< (std::ostream &output, const simb::MCParticle &)

Detailed Description

Definition at line 24 of file MCParticle.h.

Member Typedef Documentation

typedef std::set<int> simb::MCParticle::daughters_type

protected

Definition at line 33 of file MCParticle.h.

Constructor & Destructor Documentation

simb::MCParticle::MCParticle

(

)

Don't write this as ROOT output.

Definition at line 32 of file MCParticle.cxx.

    : fstatus(s_uninitialized)
    , ftrackId(s_uninitialized)
    , fpdgCode(s_uninitialized)
    , fmother(s_uninitialized)
    , fprocess()
    , fendprocess()
    , fmass(s_uninitialized)
    , fpolarization()
    , fdaughters()
    , fWeight(s_uninitialized)
    , fGvtx()
    , frescatter(s_uninitialized)
  {
  }

simb::MCParticle::MCParticle	(	const int	trackId,
		const int	pdg,
		const std::string	process,
		const int	mother = -1,
		const double	mass = s_uninitialized,
		const int	status = 1
	)

Standard constructor.

Definition at line 50 of file MCParticle.cxx.

    : fstatus(status)
    , ftrackId(trackId)
    , fpdgCode(pdg)
    , fmother(mother)
    , fprocess(process)
    , fendprocess(std::string())
    , fmass(mass)
    , fpolarization()
    , fdaughters()
    , fWeight(0.)
    , fGvtx()
    , frescatter(s_uninitialized)
  {
    // If the user has supplied a mass, use it.  Otherwise, get the
    // particle mass from the PDG table.
    if ( mass < 0 ){
      const TDatabasePDG* databasePDG = TDatabasePDG::Instance();
      const TParticlePDG* definition = databasePDG->GetParticle( pdg );
      // Check that the particle is known to ROOT.  If not, this is
      // not a major error; Geant4 has an internal particle coding
      // scheme for nuclei that ROOT doesn't recognize.
      if ( definition != 0 ){
        fmass = definition->Mass();
      }
    }
    else fmass = mass;
    SetGvtx(0, 0, 0, 0);
  }

simb::MCParticle::MCParticle ( MCParticle const &  )

default

simb::MCParticle::MCParticle ( MCParticle &&  )

default

simb::MCParticle::MCParticle	(	MCParticle const &	p,
		int	offset
	)

Definition at line 86 of file MCParticle.cxx.

    : fstatus(p.StatusCode())
    , ftrackId(p.TrackId()+offset)
    , fpdgCode(p.PdgCode())
    , fmother(p.Mother()+offset)
    , fprocess(p.Process())
    , fendprocess(p.EndProcess())
    , ftrajectory(p.Trajectory())
    , fmass(p.Mass())
    , fWeight(p.Weight())
    , fGvtx(p.GetGvtx())
    , frescatter(p.Rescatter())
  {
    for(int i=0; i<p.NumberDaughters(); i++)
      fdaughters.insert(p.Daughter(i)+offset);
  }

Member Function Documentation

void simb::MCParticle::AddDaughter ( const int  trackID )

inline

Definition at line 268 of file MCParticle.h.

{ fdaughters.insert(trackID);                }

void simb::MCParticle::AddTrajectoryPoint ( TLorentzVector const &  position, TLorentzVector const &  momentum  )

inline

Definition at line 257 of file MCParticle.h.

                                                                              { ftrajectory.Add( position, momentum );     }

void simb::MCParticle::AddTrajectoryPoint ( TLorentzVector const &  position, TLorentzVector const &  momentum, std::string const &  process, bool  keepTransportation = false  )

inline

Definition at line 260 of file MCParticle.h.

                                                                              { ftrajectory.Add( position, momentum, process, keepTransportation); }

int simb::MCParticle::Daughter

(

const int

i

)

const

Definition at line 112 of file MCParticle.cxx.

  {
    daughters_type::const_iterator i = fdaughters.begin();
    std::advance( i, index );
    return *i;
  }

double simb::MCParticle::E ( const int  i = 0 ) const

inline

Definition at line 233 of file MCParticle.h.

{ return Momentum(i).E();          }

double simb::MCParticle::EndE ( ) const

inline

Definition at line 244 of file MCParticle.h.

{ return Momentum(ftrajectory.size()-1).T(); }

const TLorentzVector & simb::MCParticle::EndMomentum ( ) const

inline

Definition at line 240 of file MCParticle.h.

{ return Momentum(ftrajectory.size()-1);     }

const TLorentzVector & simb::MCParticle::EndPosition ( ) const

inline

Definition at line 225 of file MCParticle.h.

{ return Position(ftrajectory.size()-1);     }

std::string simb::MCParticle::EndProcess ( ) const

inline

Definition at line 216 of file MCParticle.h.

{ return fendprocess;              }

double simb::MCParticle::EndPx ( ) const

inline

Definition at line 241 of file MCParticle.h.

{ return Momentum(ftrajectory.size()-1).X(); }

double simb::MCParticle::EndPy ( ) const

inline

Definition at line 242 of file MCParticle.h.

{ return Momentum(ftrajectory.size()-1).Y(); }

double simb::MCParticle::EndPz ( ) const

inline

Definition at line 243 of file MCParticle.h.

{ return Momentum(ftrajectory.size()-1).Z(); }

double simb::MCParticle::EndT ( ) const

inline

Definition at line 229 of file MCParticle.h.

{ return Position(ftrajectory.size()-1).T(); }

double simb::MCParticle::EndX ( ) const

inline

Definition at line 226 of file MCParticle.h.

{ return Position(ftrajectory.size()-1).X(); }

double simb::MCParticle::EndY ( ) const

inline

Definition at line 227 of file MCParticle.h.

{ return Position(ftrajectory.size()-1).Y(); }

double simb::MCParticle::EndZ ( ) const

inline

Definition at line 228 of file MCParticle.h.

{ return Position(ftrajectory.size()-1).Z(); }

int simb::MCParticle::FirstDaughter ( void  ) const

inline

Definition at line 250 of file MCParticle.h.

{ return *(fdaughters.begin());              }

TLorentzVector simb::MCParticle::GetGvtx ( ) const

inline

Definition at line 245 of file MCParticle.h.

{ return fGvtx;                              }

double simb::MCParticle::Gvt ( ) const

inline

Definition at line 249 of file MCParticle.h.

{ return fGvtx.T();                          }

double simb::MCParticle::Gvx ( ) const

inline

Definition at line 246 of file MCParticle.h.

{ return fGvtx.X();                          }

double simb::MCParticle::Gvy ( ) const

inline

Definition at line 247 of file MCParticle.h.

{ return fGvtx.Y();                          }

double simb::MCParticle::Gvz ( ) const

inline

Definition at line 248 of file MCParticle.h.

{ return fGvtx.Z();                          }

int simb::MCParticle::LastDaughter ( void  ) const

inline

Definition at line 251 of file MCParticle.h.

{ return *(fdaughters.rbegin());             }

double simb::MCParticle::Mass ( void  ) const

inline

Definition at line 239 of file MCParticle.h.

{ return fmass;                              }

const TLorentzVector & simb::MCParticle::Momentum ( const int  i = 0 ) const

inline

Definition at line 220 of file MCParticle.h.

{ return ftrajectory.Momentum(i);  }

int simb::MCParticle::Mother ( ) const

inline

Definition at line 213 of file MCParticle.h.

{ return fmother;                  }

int simb::MCParticle::NumberDaughters ( ) const

inline

Definition at line 217 of file MCParticle.h.

{ return fdaughters.size();        }

unsigned int simb::MCParticle::NumberTrajectoryPoints ( ) const

inline

Definition at line 218 of file MCParticle.h.

{ return ftrajectory.size();       }

bool simb::MCParticle::operator< ( const simb::MCParticle &  other ) const

inline

Definition at line 274 of file MCParticle.h.

{ return ftrackId < other.ftrackId; }

MCParticle& simb::MCParticle::operator= ( const MCParticle &  )

default

MCParticle& simb::MCParticle::operator= ( MCParticle &&  )

default

double simb::MCParticle::P ( const int  i = 0 ) const

inline

Definition at line 234 of file MCParticle.h.

                                                                          { return std::sqrt(std::pow(Momentum(i).E(),2.)
                                                                                                 - std::pow(fmass,2.));            }

int simb::MCParticle::PdgCode ( void  ) const

inline

Definition at line 212 of file MCParticle.h.

{ return fpdgCode;                 }

const TVector3 & simb::MCParticle::Polarization ( ) const

inline

Definition at line 214 of file MCParticle.h.

{ return fpolarization;            }

const TLorentzVector & simb::MCParticle::Position ( const int  i = 0 ) const

inline

Definition at line 219 of file MCParticle.h.

{ return ftrajectory.Position(i);  }

std::string simb::MCParticle::Process ( void  ) const

inline

Definition at line 215 of file MCParticle.h.

{ return fprocess;                 }

double simb::MCParticle::Pt ( const int  i = 0 ) const

inline

Definition at line 236 of file MCParticle.h.

                                                                          { return std::sqrt(  std::pow(Momentum(i).Px(),2.)
                                                                                                 + std::pow(Momentum(i).Py(),2.)); }

double simb::MCParticle::Px ( const int  i = 0 ) const

inline

Definition at line 230 of file MCParticle.h.

{ return Momentum(i).Px();         }

double simb::MCParticle::Py ( const int  i = 0 ) const

inline

Definition at line 231 of file MCParticle.h.

{ return Momentum(i).Py();         }

double simb::MCParticle::Pz ( const int  i = 0 ) const

inline

Definition at line 232 of file MCParticle.h.

{ return Momentum(i).Pz();         }

int simb::MCParticle::Rescatter ( ) const

inline

Definition at line 252 of file MCParticle.h.

{ return frescatter;                         }

void simb::MCParticle::SetEndProcess

(

std::string

s

)

Definition at line 105 of file MCParticle.cxx.

  {
    fendprocess = s;
  }

void simb::MCParticle::SetGvtx

(

double *

v

)

Definition at line 120 of file MCParticle.cxx.

  {
    for(int i = 0; i < 4; i++) {
      fGvtx[i] = v[i];
    }
  }

void simb::MCParticle::SetGvtx

(

float *

v

)

Definition at line 128 of file MCParticle.cxx.

  {
    for(int i = 0; i < 4; i++) {
      fGvtx[i] = v[i];
    }
  }

void simb::MCParticle::SetGvtx

(

TLorentzVector

v

)

Definition at line 136 of file MCParticle.cxx.

  {
    fGvtx = v;
  }

void simb::MCParticle::SetGvtx	(	double	x,
		double	y,
		double	z,
		double	t
	)

Definition at line 142 of file MCParticle.cxx.

  {
    fGvtx.SetX(x);
    fGvtx.SetY(y);
    fGvtx.SetZ(z);
    fGvtx.SetT(t);
  }

void simb::MCParticle::SetPolarization ( const TVector3 &  p )

inline

Definition at line 269 of file MCParticle.h.

{ fpolarization = p;                         }

void simb::MCParticle::SetRescatter ( int  code )

inline

Definition at line 270 of file MCParticle.h.

{ frescatter    = code;                      }

void simb::MCParticle::SetWeight ( double  wt )

inline

Definition at line 271 of file MCParticle.h.

{ fWeight       = wt;                        }

void simb::MCParticle::SparsifyTrajectory ( double  margin = 0.1, bool  keep_second_to_last = false  )

inline

Definition at line 265 of file MCParticle.h.

                                                                              { ftrajectory.Sparsify( margin, keep_second_to_last );            }

int simb::MCParticle::StatusCode ( ) const

inline

Definition at line 211 of file MCParticle.h.

{ return fstatus;                  }

double simb::MCParticle::T ( const int  i = 0 ) const

inline

Definition at line 224 of file MCParticle.h.

{ return Position(i).T();          }

int simb::MCParticle::TrackId ( ) const

inline

Definition at line 210 of file MCParticle.h.

{ return ftrackId;                 }

const simb::MCTrajectory & simb::MCParticle::Trajectory ( ) const

inline

Definition at line 253 of file MCParticle.h.

{ return ftrajectory;                        }

double simb::MCParticle::Vx ( const int  i = 0 ) const

inline

Definition at line 221 of file MCParticle.h.

{ return Position(i).X();          }

double simb::MCParticle::Vy ( const int  i = 0 ) const

inline

Definition at line 222 of file MCParticle.h.

{ return Position(i).Y();          }

double simb::MCParticle::Vz ( const int  i = 0 ) const

inline

Definition at line 223 of file MCParticle.h.

{ return Position(i).Z();          }

double simb::MCParticle::Weight ( void  ) const

inline

Definition at line 254 of file MCParticle.h.

{ return fWeight;                            }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  output, const simb::MCParticle &  particle  )

friend

Definition at line 151 of file MCParticle.cxx.

  {
    output << "ID=" << particle.TrackId() << ", ";
    int pdg =  particle.PdgCode();

    // Try to translate the PDG code into text.
    const TDatabasePDG* databasePDG = TDatabasePDG::Instance();
    const TParticlePDG* definition = databasePDG->GetParticle( pdg );
    // Check that the particle is known to ROOT.  If not, this is
    // not a major error; Geant4 has an internal particle coding
    // scheme for nuclei that ROOT doesn't recognize.
    if ( definition != 0 ) output << definition->GetName();
    else output << "PDG=" << pdg;
    
    output << ", mass="      << particle.Mass()
           << ", Mother ID=" << particle.Mother()
           << ", Process="   << particle.Process()
           << ", Status="    << particle.StatusCode()
           << "\nthere are " << particle.NumberTrajectoryPoints() << " trajectory points";

    if(particle.NumberTrajectoryPoints() > 0 )
      output << "\nInitial vtx (x,y,z,t)=(" << particle.Vx()
             << "," << particle.Vy()
             << "," << particle.Vz()
             << "," << particle.T()
             << "),\n Initial mom (Px,Py,Pz,E)=(" << particle.Px()
             << "," << particle.Py()
             << "," << particle.Pz()
             << "," << particle.E()
             << ")" << std::endl;
    else
      output << std::endl;

    return output;
  }

Member Data Documentation

daughters_type simb::MCParticle::fdaughters

protected

Sorted list of daughters of this particle.

Definition at line 44 of file MCParticle.h.

std::string simb::MCParticle::fendprocess

protected

end process for the particle

Definition at line 40 of file MCParticle.h.

TLorentzVector simb::MCParticle::fGvtx

protected

Vertex needed by generater (genie) to rebuild genie::EventRecord for event reweighting

Definition at line 46 of file MCParticle.h.

double simb::MCParticle::fmass

protected

Mass; from PDG unless overridden Should be in GeV.

Definition at line 42 of file MCParticle.h.

int simb::MCParticle::fmother

protected

Mother.

Definition at line 38 of file MCParticle.h.

int simb::MCParticle::fpdgCode

protected

PDG code.

Definition at line 37 of file MCParticle.h.

TVector3 simb::MCParticle::fpolarization

protected

Polarization.

Definition at line 43 of file MCParticle.h.

std::string simb::MCParticle::fprocess

protected

Detector-simulation physics process that created the particle.

Definition at line 39 of file MCParticle.h.

int simb::MCParticle::frescatter

protected

rescatter code

Definition at line 48 of file MCParticle.h.

int simb::MCParticle::fstatus

protected

Status code from generator, geant, etc.

Definition at line 35 of file MCParticle.h.

int simb::MCParticle::ftrackId

protected

TrackId.

Definition at line 36 of file MCParticle.h.

simb::MCTrajectory simb::MCParticle::ftrajectory

protected

particle trajectory (position,momentum)

Definition at line 41 of file MCParticle.h.

double simb::MCParticle::fWeight

protected

Assigned weight to this particle for MC tests.

Definition at line 45 of file MCParticle.h.

const int simb::MCParticle::s_uninitialized = std::numeric_limits<int>::min()

static

How do we indicate an uninitialized variable? I don't want to use "0" for PDG, because that's potentially a valid value. Instead, let the compiler give us a value. The following template (from climits) evaluates the lower possible negative number that you can store in an int.

Definition at line 28 of file MCParticle.h.

---

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

• nusimdata/nusimdata/SimulationBase/MCParticle.h
• nusimdata/nusimdata/SimulationBase/MCParticle.cxx