Abstract class. Is used to pass common implementation to concrete implementations of the EventRecordVisitorI interface generating the primary lepton for a specific processes (QEL,DIS,RES,IMD,...) More...

#include <PrimaryLeptonGenerator.h>

Inheritance diagram for genie::PrimaryLeptonGenerator:

[legend]

Collaboration diagram for genie::PrimaryLeptonGenerator:

[legend]

Public Member Functions
virtual void	ProcessEventRecord (GHepRecord *evrec) const
virtual void	SetPolarization (GHepRecord *ev) const
virtual TVector3	NucRestFrame2Lab (GHepRecord *ev) const
virtual void	AddToEventRecord (GHepRecord *ev, int pdgc, const TLorentzVector &p4) const
void	Configure (const Registry &config)
void	Configure (string config)
Public Member Functions inherited from genie::EventRecordVisitorI
virtual	~EventRecordVisitorI ()
Public Member Functions inherited from genie::Algorithm
virtual	~Algorithm ()
virtual void	FindConfig (void)
virtual const Registry &	GetConfig (void) const
Registry *	GetOwnedConfig (void)
virtual const AlgId &	Id (void) const
	Get algorithm ID.
virtual AlgStatus_t	GetStatus (void) const
	Get algorithm status.
virtual bool	AllowReconfig (void) const
virtual AlgCmp_t	Compare (const Algorithm *alg) const
	Compare with input algorithm.
virtual void	SetId (const AlgId &id)
	Set algorithm ID.
virtual void	SetId (string name, string config)
const Algorithm *	SubAlg (const RgKey &registry_key) const
void	AdoptConfig (void)
void	AdoptSubstructure (void)
virtual void	Print (ostream &stream) const
	Print algorithm info.

Protected Member Functions
	PrimaryLeptonGenerator ()
	PrimaryLeptonGenerator (string name)
	PrimaryLeptonGenerator (string name, string config)
virtual	~PrimaryLeptonGenerator ()
void	LoadConfig (void)
Protected Member Functions inherited from genie::EventRecordVisitorI
	EventRecordVisitorI ()
	EventRecordVisitorI (string name)
	EventRecordVisitorI (string name, string config)
Protected Member Functions inherited from genie::Algorithm
	Algorithm ()
	Algorithm (string name)
	Algorithm (string name, string config)
void	Initialize (void)
void	DeleteConfig (void)
void	DeleteSubstructure (void)
Registry *	ExtractLocalConfig (const Registry &in) const
Registry *	ExtractLowerConfig (const Registry &in, const string &alg_key) const
	Split an incoming configuration Registry into a block valid for the sub-algo identified by alg_key.
template<class T>
bool	GetParam (const RgKey &name, T &p, bool is_top_call=true) const
template<class T>
bool	GetParamDef (const RgKey &name, T &p, const T &def) const
template<class T>
int	GetParamVect (const std::string &comm_name, std::vector< T > &v, bool is_top_call=true) const
	Handle to load vectors of parameters.
int	GetParamVectKeys (const std::string &comm_name, std::vector< RgKey > &k, bool is_top_call=true) const
template<class T>
int	GetParamMat (const std::string &comm_name, TMatrixT< T > &mat, bool is_top_call=true) const
	Handle to load matrix of parameters.
template<class T>
int	GetParamMatSym (const std::string &comm_name, TMatrixTSym< T > &mat, bool is_top_call=true) const
int	GetParamMatKeys (const std::string &comm_name, std::vector< RgKey > &k, bool is_top_call=true) const
int	AddTopRegistry (Registry *rp, bool owns=true)
	add registry with top priority, also update ownership
int	AddLowRegistry (Registry *rp, bool owns=true)
	add registry with lowest priority, also update ownership
int	MergeTopRegistry (const Registry &r)
int	AddTopRegisties (const vector< Registry * > &rs, bool owns=false)
	Add registries with top priority, also udated Ownerships.

Protected Attributes
bool	fApplyCoulombCorrection
Protected Attributes inherited from genie::Algorithm
bool	fAllowReconfig
bool	fOwnsSubstruc
	true if it owns its substructure (sub-algs,...)
AlgId	fID
	algorithm name and configuration set
vector< Registry * >	fConfVect
vector< bool >	fOwnerships
	ownership for every registry in fConfVect
AlgStatus_t	fStatus
	algorithm execution status
AlgMap *	fOwnedSubAlgMp
	local pool for owned sub-algs (taken out of the factory pool)

Additional Inherited Members
Static Public Member Functions inherited from genie::Algorithm
static string	BuildParamVectKey (const std::string &comm_name, unsigned int i)
static string	BuildParamVectSizeKey (const std::string &comm_name)
static string	BuildParamMatKey (const std::string &comm_name, unsigned int i, unsigned int j)
static string	BuildParamMatRowSizeKey (const std::string &comm_name)
static string	BuildParamMatColSizeKey (const std::string &comm_name)

Detailed Description

Abstract class. Is used to pass common implementation to concrete implementations of the EventRecordVisitorI interface generating the primary lepton for a specific processes (QEL,DIS,RES,IMD,...)

Author: Costas Andreopoulos <c.andreopoulos \at cern.ch> University of Liverpool

Created:\n October 03, 2004

License:\n Copyright (c) 2003-2025, The GENIE Collaboration: For the full text of the license visit http://copyright.genie-mc.org

Definition at line 30 of file PrimaryLeptonGenerator.h.

Constructor & Destructor Documentation

◆ PrimaryLeptonGenerator() [1/3]

PrimaryLeptonGenerator::PrimaryLeptonGenerator ( )

protected

Definition at line 34 of file PrimaryLeptonGenerator.cxx.

                                               :
EventRecordVisitorI()
{
 
}

References genie::EventRecordVisitorI::EventRecordVisitorI().

◆ PrimaryLeptonGenerator() [2/3]

PrimaryLeptonGenerator::PrimaryLeptonGenerator ( string name )

protected

Definition at line 40 of file PrimaryLeptonGenerator.cxx.

                                                          :
EventRecordVisitorI(name)
{
 
}

References genie::EventRecordVisitorI::EventRecordVisitorI().

◆ PrimaryLeptonGenerator() [3/3]

PrimaryLeptonGenerator::PrimaryLeptonGenerator	(	string	name,
		string	config )

protected

Definition at line 46 of file PrimaryLeptonGenerator.cxx.

                                                                         :
EventRecordVisitorI(name, config)
{
 
}

References genie::EventRecordVisitorI::EventRecordVisitorI().

◆ ~PrimaryLeptonGenerator()

PrimaryLeptonGenerator::~PrimaryLeptonGenerator ( )

protectedvirtual

Definition at line 52 of file PrimaryLeptonGenerator.cxx.

{
 
}

Member Function Documentation

◆ AddToEventRecord()

void PrimaryLeptonGenerator::AddToEventRecord	(	GHepRecord *	ev,
		int	pdgc,
		const TLorentzVector &	p4 ) const

virtual

Definition at line 141 of file PrimaryLeptonGenerator.cxx.

{
// Adds the final state primary lepton GHepParticle to the event record.
// To be called by all concrete PrimaryLeptonGenerators before exiting.
 
  Interaction * interaction = evrec->Summary();
 
  GHepParticle * mom  = evrec->Probe();
  int            imom = evrec->ProbePosition();
 
  const TLorentzVector & vtx = *(mom->X4());
 
  TLorentzVector x4l(vtx);  // position 4-vector
  TLorentzVector p4l(p4);   // momentum 4-vector
 
  GHepParticle * nucltgt = evrec->TargetNucleus();
 
  bool is_ve = interaction->ProcInfo().IsInverseMuDecay() ||
               interaction->ProcInfo().IsIMDAnnihilation() ||
               interaction->ProcInfo().IsNuElectronElastic();
 
  bool can_correct = fApplyCoulombCorrection && nucltgt!=0 && !is_ve;
  if(can_correct) {
    LOG("LeptonicVertex", pINFO)
        << "Correcting f/s lepton energy for Coulomb effects";
 
    double m = interaction->FSPrimLepton()->Mass();
    double Z  = nucltgt->Z();
    double A  = nucltgt->A();
 
    //  charge radius of nucleus in GeV^-1
    double Rc = (1.1*TMath::Power(A,1./3.) + 0.86*TMath::Power(A,-1./3.))/0.197;
 
    // shift of lepton energy in homogenous sphere with radius Rc
    double Vo = 3*kAem*Z/(2*Rc);
    Vo *= 0.75; // as suggested in R.Gran's note
 
    double Elo = p4l.Energy();
    double e   = TMath::Min(Vo, Elo-m);
    double El  = TMath::Max(0., Elo-e);
 
    LOG("LeptonicVertex", pINFO)
      << "Lepton energy subtraction: E = " << Elo << " --> " << El;
 
    double pmag_old = p4l.P();
    double pmag_new = TMath::Sqrt(utils::math::NonNegative(El*El-m*m));
    double scale    = pmag_new / pmag_old;
    LOG("LeptonicVertex", pDEBUG)
         << "|pnew| = " << pmag_new << ", |pold| = " << pmag_old
         << ", scale = " << scale;
 
    double pxl = scale * p4l.Px();
    double pyl = scale * p4l.Py();
    double pzl = scale * p4l.Pz();
 
    p4l.SetPxPyPzE(pxl,pyl,pzl,El);
 
    TLorentzVector p4c = p4 - p4l;
    TLorentzVector x4dummy(0,0,0,0);;
 
    evrec->AddParticle(
        kPdgCoulobtron, kIStStableFinalState, -1,-1,-1,-1, p4c, x4dummy);
  }
 
  evrec->AddParticle(pdgc, kIStStableFinalState, imom,-1,-1,-1, p4l, x4l);
 
  // update the interaction summary
  evrec->Summary()->KinePtr()->SetFSLeptonP4(p4l);
}

References genie::GHepParticle::A(), genie::GHepRecord::AddParticle(), e, fApplyCoulombCorrection, genie::Interaction::FSPrimLepton(), genie::ProcessInfo::IsIMDAnnihilation(), genie::ProcessInfo::IsInverseMuDecay(), genie::ProcessInfo::IsNuElectronElastic(), genie::constants::kAem, genie::Interaction::KinePtr(), genie::kIStStableFinalState, genie::kPdgCoulobtron, LOG, genie::utils::math::NonNegative(), pDEBUG, pINFO, genie::GHepRecord::Probe(), genie::GHepRecord::ProbePosition(), genie::Interaction::ProcInfo(), genie::Kinematics::SetFSLeptonP4(), genie::GHepRecord::Summary(), genie::GHepRecord::TargetNucleus(), genie::GHepParticle::X4(), and genie::GHepParticle::Z().

Referenced by genie::COHPrimaryLeptonGenerator::CalculatePrimaryLepton_AlvarezRuso(), genie::NuEPrimaryLeptonGenerator::ProcessEventRecord(), and ProcessEventRecord().

◆ Configure() [1/2]

void PrimaryLeptonGenerator::Configure ( const Registry & config )

virtual

Configure the algorithm with an external registry The registry is merged with the top level registry if it is owned, Otherwise a copy of it is added with the highest priority

Reimplemented from genie::Algorithm.

Definition at line 220 of file PrimaryLeptonGenerator.cxx.

{
  Algorithm::Configure(config);
  this->LoadConfig();
}

References genie::Algorithm::Configure(), and LoadConfig().

◆ Configure() [2/2]

void PrimaryLeptonGenerator::Configure ( string config )

virtual

Configure the algorithm from the AlgoConfigPool based on param_set string given in input An algorithm contains a vector of registries coming from different xml configuration files, which are loaded according a very precise prioriy This methods will load a number registries in order of priority: 1) "Tunable" parameter set from CommonParametes. This is loaded with the highest prioriry and it is designed to be used for tuning procedure Usage not expected from the user. 2) For every string defined in "CommonParame" the corresponding parameter set will be loaded from CommonParameter.xml 3) parameter set specified by the config string and defined in the xml file of the algorithm 4) if config is not "Default" also the Default parameter set from the same xml file will be loaded Effectively this avoids the repetion of a parameter when it is not changed in the requested configuration

Reimplemented from genie::Algorithm.

Definition at line 226 of file PrimaryLeptonGenerator.cxx.

{
  Algorithm::Configure(config);
  this->LoadConfig();
}

References genie::Algorithm::Configure(), and LoadConfig().

◆ LoadConfig()

void PrimaryLeptonGenerator::LoadConfig ( void )

protected

Definition at line 232 of file PrimaryLeptonGenerator.cxx.

{
  GetParam( "ApplyCoulombCorrection", fApplyCoulombCorrection ) ;
 
}

References fApplyCoulombCorrection, and genie::Algorithm::GetParam().

Referenced by Configure(), and Configure().

◆ NucRestFrame2Lab()

TVector3 PrimaryLeptonGenerator::NucRestFrame2Lab ( GHepRecord * ev ) const

virtual

Definition at line 127 of file PrimaryLeptonGenerator.cxx.

{
// Velocity for an active Lorentz transform taking the final state primary
// lepton from the [nucleon rest frame] --> [LAB]
 
  Interaction * interaction = evrec->Summary();
  const InitialState & init_state = interaction->InitState();
 
  const TLorentzVector & pnuc4 = init_state.Tgt().HitNucP4(); //[@LAB]
  TVector3 beta = pnuc4.BoostVector();
 
  return beta;
}

References genie::Target::HitNucP4(), genie::Interaction::InitState(), genie::GHepRecord::Summary(), and genie::InitialState::Tgt().

Referenced by ProcessEventRecord().

◆ ProcessEventRecord()

void PrimaryLeptonGenerator::ProcessEventRecord ( GHepRecord * evrec ) const

virtual

Implements genie::EventRecordVisitorI.

Reimplemented in genie::COHPrimaryLeptonGenerator, genie::DFRPrimaryLeptonGenerator, genie::DISPrimaryLeptonGenerator, genie::IBDPrimaryLeptonGenerator, genie::NuEPrimaryLeptonGenerator, genie::QELPrimaryLeptonGenerator, genie::RESPrimaryLeptonGenerator, and genie::SKPrimaryLeptonGenerator.

Definition at line 57 of file PrimaryLeptonGenerator.cxx.

{
// This method generates the final state primary lepton
 
  Interaction * interaction = evrec->Summary();
 
  // Boost vector for [LAB] <-> [Nucleon Rest Frame] transforms
  TVector3 beta = this->NucRestFrame2Lab(evrec);
 
  // Neutrino 4p
  TLorentzVector * p4v = evrec->Probe()->GetP4(); // v 4p @ LAB
  p4v->Boost(-1.*beta);                           // v 4p @ Nucleon rest frame
 
  // Look-up selected kinematics & other needed kinematical params
  double Q2  = interaction->Kine().Q2(true);
  double y   = interaction->Kine().y(true);
  double Ev  = p4v->E();
  double ml  = interaction->FSPrimLepton()->Mass();
  double ml2 = TMath::Power(ml,2);
 
  LOG("LeptonicVertex", pNOTICE)
             << "Ev = " << Ev << ", Q2 = " << Q2 << ", y = " << y;
 
  // Compute the final state primary lepton energy and momentum components
  // along and perpendicular the neutrino direction
  double El  = (1-y)*Ev;
  double plp = El - 0.5*(Q2+ml2)/Ev;                          // p(//)
  double plt = TMath::Sqrt(TMath::Max(0.,El*El-plp*plp-ml2)); // p(-|)
 
  LOG("LeptonicVertex", pNOTICE)
        << "fsl: E = " << El << ", |p//| = " << plp << ", [pT] = " << plt;
 
  // Randomize transverse components
  RandomGen * rnd = RandomGen::Instance();
  double phi  = 2*kPi * rnd->RndLep().Rndm();
  double pltx = plt * TMath::Cos(phi);
  double plty = plt * TMath::Sin(phi);
 
  // Take a unit vector along the neutrino direction @ the nucleon rest frame
  TVector3 unit_nudir = p4v->Vect().Unit();
 
  // Rotate lepton momentum vector from the reference frame (x'y'z') where
  // {z':(neutrino direction), z'x':(theta plane)} to the nucleon rest frame
  TVector3 p3l(pltx,plty,plp);
  p3l.RotateUz(unit_nudir);
 
  // Lepton 4-momentum in the nucleon rest frame
  TLorentzVector p4l(p3l,El);
 
  LOG("LeptonicVertex", pNOTICE)
       << "fsl @ NRF: " << utils::print::P4AsString(&p4l);
 
  // Boost final state primary lepton to the lab frame
  p4l.Boost(beta); // active Lorentz transform
 
  LOG("LeptonicVertex", pNOTICE)
       << "fsl @ LAB: " << utils::print::P4AsString(&p4l);
 
  // Figure out the Final State Lepton PDG Code
  int pdgc = interaction->FSPrimLepton()->PdgCode();
 
  // Create a GHepParticle and add it to the event record
  this->AddToEventRecord(evrec, pdgc, p4l);
 
  // Set final state lepton polarization
  this->SetPolarization(evrec);
 
  delete p4v;
}

References AddToEventRecord(), genie::Interaction::FSPrimLepton(), genie::GHepParticle::GetP4(), genie::RandomGen::Instance(), genie::Interaction::Kine(), genie::constants::kPi, LOG, NucRestFrame2Lab(), genie::utils::print::P4AsString(), pNOTICE, genie::GHepRecord::Probe(), genie::Kinematics::Q2(), genie::RandomGen::RndLep(), SetPolarization(), genie::GHepRecord::Summary(), and genie::Kinematics::y().

Referenced by genie::COHPrimaryLeptonGenerator::ProcessEventRecord(), genie::DFRPrimaryLeptonGenerator::ProcessEventRecord(), genie::DISPrimaryLeptonGenerator::ProcessEventRecord(), genie::IBDPrimaryLeptonGenerator::ProcessEventRecord(), genie::QELPrimaryLeptonGenerator::ProcessEventRecord(), genie::RESPrimaryLeptonGenerator::ProcessEventRecord(), and genie::SKPrimaryLeptonGenerator::ProcessEventRecord().

◆ SetPolarization()

void PrimaryLeptonGenerator::SetPolarization ( GHepRecord * ev ) const

virtual

Definition at line 212 of file PrimaryLeptonGenerator.cxx.

{
  // The default treatment is just to delegate to the utility function.
  // Derived classes that need a different approach may override this
  // member function.
  genie::utils::SetPrimaryLeptonPolarization( ev );
}

References genie::utils::SetPrimaryLeptonPolarization().

Referenced by genie::COHPrimaryLeptonGenerator::CalculatePrimaryLepton_AlvarezRuso(), genie::NuEPrimaryLeptonGenerator::ProcessEventRecord(), and ProcessEventRecord().

Member Data Documentation

◆ fApplyCoulombCorrection

bool genie::PrimaryLeptonGenerator::fApplyCoulombCorrection

protected

Definition at line 59 of file PrimaryLeptonGenerator.h.

Referenced by AddToEventRecord(), and LoadConfig().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PrimaryLeptonGenerator() [1/3]

◆ PrimaryLeptonGenerator() [2/3]

◆ PrimaryLeptonGenerator() [3/3]

◆ ~PrimaryLeptonGenerator()

Member Function Documentation

◆ AddToEventRecord()

◆ Configure() [1/2]

◆ Configure() [2/2]

◆ LoadConfig()

◆ NucRestFrame2Lab()

◆ ProcessEventRecord()

◆ SetPolarization()

Member Data Documentation

◆ fApplyCoulombCorrection