Generates a Geant4 event from particle gun, but can have many particles. More...

#include <MultiParticleGunPrimaryGenerator.h>

Public Member Functions
	MultiParticleGunPrimaryGenerator (const std::string &name, const framework::config::Parameters &parameters)
	Constructor.

virtual	~MultiParticleGunPrimaryGenerator ()
	Destructor.

void	GeneratePrimaryVertex (G4Event *anEvent) override
	Generate vertices in the Geant4 event.

void	RecordConfig (const std::string &id, ldmx::RunHeader &rh) override
	Record the configuration of the primary generator into the run header.

Public Member Functions inherited from simcore::PrimaryGenerator
	PrimaryGenerator (const std::string &name, const framework::config::Parameters &parameters)
	Constructor.

virtual	~PrimaryGenerator ()=default
	Destructor.

Private Attributes
TRandom *	random_
	Random number generator.

G4ThreeVector	mpgVertex_
	The vertex position from which to fire the particles.

G4ThreeVector	mpgMomentum_
	The initial momentum of the particles.

double	mpgNParticles_ {1.}
	Number of particles that will be fired by the gun per event.

int	mpgPdgID_ {99999}
	PDG ID of the particle used by the gun.

bool	mpgEnablePoisson_ {false}
	Flag denoting whether the number of incident particles should be Poisson distributed.

Additional Inherited Members
Public Types inherited from simcore::PrimaryGenerator
using	Factory = ::simcore::Factory< PrimaryGenerator, std::shared_ptr< PrimaryGenerator >, const std::string &, const framework::config::Parameters & >
	Factory for primary generators.

Protected Attributes inherited from simcore::PrimaryGenerator
std::string	name_ {""}
	Name of the PrimaryGenerator.

Detailed Description

Generates a Geant4 event from particle gun, but can have many particles.

Definition at line 52 of file MultiParticleGunPrimaryGenerator.h.

Constructor & Destructor Documentation

◆ MultiParticleGunPrimaryGenerator()

simcore::generators::MultiParticleGunPrimaryGenerator::MultiParticleGunPrimaryGenerator	(	const std::string &	name,
		const framework::config::Parameters &	parameters
	)

Constructor.

Parameters

name	the name of this generator
parameters	the configuration parameters

Parameters: vertex : Position to shoot from (mm) momentum : 3-vector mometum of particles (MeV) nParticles : number of particles to shoot (mean if Poisson enabled) pdgID : pdgID of particle to shoot enablePoisson : whether to poisson distribute the number of particles

Definition at line 13 of file MultiParticleGunPrimaryGenerator.cxx.

    : PrimaryGenerator(name, parameters), random_(new TRandom) {
  auto stlVertex{parameters.getParameter<std::vector<double> >("vertex")};
  auto stlMomentum{parameters.getParameter<std::vector<double> >("momentum")};
  mpgNParticles_ = parameters.getParameter<int>("nParticles");
  mpgPdgID_ = parameters.getParameter<int>("pdgID");
  mpgEnablePoisson_ = parameters.getParameter<bool>("enablePoisson");
 
  if (stlVertex.size() != 3 or stlMomentum.size() != 3 or mpgNParticles_ <= 0) {
    EXCEPTION_RAISE("InvalideConfig",
                    "Parameters pass to '" + name_ + "' are not valid.");
  }
 
  mpgVertex_ = G4ThreeVector(stlVertex.at(0) * mm, stlVertex.at(1) * mm,
                             stlVertex.at(2) * mm);
  mpgMomentum_ = G4ThreeVector(stlMomentum.at(0) * MeV, stlMomentum.at(1) * MeV,
                               stlMomentum.at(2) * MeV);
}

References framework::config::Parameters::getParameter(), mpgEnablePoisson_, mpgMomentum_, mpgNParticles_, mpgPdgID_, mpgVertex_, and simcore::PrimaryGenerator::name_.

◆ ~MultiParticleGunPrimaryGenerator()

simcore::generators::MultiParticleGunPrimaryGenerator::~MultiParticleGunPrimaryGenerator ( )

virtual

Destructor.

Definition at line 33 of file MultiParticleGunPrimaryGenerator.cxx.

                                                                    {
  delete random_;
}

References random_.

Member Function Documentation

◆ GeneratePrimaryVertex()

void simcore::generators::MultiParticleGunPrimaryGenerator::GeneratePrimaryVertex ( G4Event * anEvent )

overridevirtual

Generate vertices in the Geant4 event.

Parameters

anEvent The Geant4 event.

Implements simcore::PrimaryGenerator.

Definition at line 37 of file MultiParticleGunPrimaryGenerator.cxx.

                                                                             {
  int cur_mpg_pdgid = mpgPdgID_;
  G4ThreeVector cur_mpg_vertex = mpgVertex_;
  G4ThreeVector cur_mpg_momentum = mpgMomentum_;
 
  // current number of vertices in the event!
  int curNVertices = anEvent->GetNumberOfPrimaryVertex();
 
  double nInteractionsInput = mpgNParticles_;
  int nInteractions = nInteractionsInput;
  if (mpgEnablePoisson_) {
    nInteractions = 0;
    while (nInteractions == 0) {  // keep generating a random poisson until > 0,
                                  // no point in generator 0 vertices...
      nInteractions = random_->Poisson(nInteractionsInput);
    }
  }
 
  // make a for loop
  for (int i = 0; i < (nInteractions - curNVertices); ++i) {
    G4PrimaryVertex* curvertex =
        new G4PrimaryVertex(cur_mpg_vertex, 0.);  // second input is t0
    // curvertex->SetPosition(0. * mm,0. * mm,-10. * mm);
    curvertex->SetWeight(1.);
 
    G4PrimaryParticle* primary =
        new G4PrimaryParticle(cur_mpg_pdgid, cur_mpg_momentum.x(),
                              cur_mpg_momentum.y(), cur_mpg_momentum.z());
 
    UserPrimaryParticleInformation* primaryInfo =
        new UserPrimaryParticleInformation();
    primaryInfo->setHepEvtStatus(1.);
    primary->SetUserInformation(primaryInfo);
 
    curvertex->SetPrimary(primary);
    anEvent->AddPrimaryVertex(curvertex);
  }
}

References mpgEnablePoisson_, mpgMomentum_, mpgNParticles_, mpgPdgID_, mpgVertex_, random_, and simcore::UserPrimaryParticleInformation::setHepEvtStatus().

◆ RecordConfig()

void simcore::generators::MultiParticleGunPrimaryGenerator::RecordConfig	(	const std::string &	id,
		ldmx::RunHeader &	rh
	)

overridevirtual

Record the configuration of the primary generator into the run header.

Note: you must include the id number in each entry into the run header just in case there are other generators

Implements simcore::PrimaryGenerator.

Definition at line 76 of file MultiParticleGunPrimaryGenerator.cxx.

                                                                       {
  rh.setStringParameter(
      id + " Class", "simcore::generators::MultiParticleGunPrimaryGenerator");
  rh.setIntParameter(id + " Poisson Enabled", mpgEnablePoisson_);
  rh.setFloatParameter(id + " N Particles", mpgNParticles_);
  rh.setIntParameter(id + " PDG ID", mpgPdgID_);
  rh.setFloatParameter(id + " Vertex X [mm]", mpgVertex_.x());
  rh.setFloatParameter(id + " Vertex Y [mm]", mpgVertex_.y());
  rh.setFloatParameter(id + " Vertex Z [mm]", mpgVertex_.z());
  rh.setFloatParameter(id + " Momentum X [MeV]", mpgMomentum_.x());
  rh.setFloatParameter(id + " Momentum Y [MeV]", mpgMomentum_.y());
  rh.setFloatParameter(id + " Momentum Z [MeV]", mpgMomentum_.z());
}