simcore::generators::LHEPrimaryGenerator Class Reference

Generates a Geant4 event from an LHEEvent. More...

#include <LHEPrimaryGenerator.h>

Public Member Functions
	LHEPrimaryGenerator (const std::string &name, const framework::config::Parameters &parameters)
	Class constructor.
virtual	~LHEPrimaryGenerator ()=default
	Class destructor.
void	GeneratePrimaryVertex (G4Event *anEvent) override
	Generate vertices in the Geant4 event.
void	RecordConfig (const std::string &id, ldmx::RunHeader &rh) override
	Record configuration information.
Public Member Functions inherited from simcore::PrimaryGenerator
	PrimaryGenerator (const std::string &name, const framework::config::Parameters &parameters)
	Constructor.
	DECLARE_FACTORY_WITH_WAREHOUSE (PrimaryGenerator, std::shared_ptr< PrimaryGenerator >, const std::string &, const framework::config::Parameters &)
virtual	~PrimaryGenerator ()=default
	Destructor.
std::string	name ()

Private Attributes
std::string	file_path_
	The file path to the LHE file.
lhe::LHEReader	reader_
	The LHE reader with the event data.
std::vector< double >	vertex_
	The vertex offset to apply to the LHE event vertex.

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

Detailed Description

Generates a Geant4 event from an LHEEvent.

Definition at line 34 of file LHEPrimaryGenerator.h.

Constructor & Destructor Documentation

LHEPrimaryGenerator()

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

Class constructor.

Parameters

name	The name of the generator.
parameters	Configuration parameters.

Definition at line 6 of file LHEPrimaryGenerator.cxx.

    : PrimaryGenerator(name, parameters),
      file_path_{parameters.get<std::string>("filePath")},
      reader_{file_path_},
      vertex_{parameters.get<std::vector<double>>("vertex")} {}

Member Function Documentation

GeneratePrimaryVertex()

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

overridevirtual

Generate vertices in the Geant4 event.

Parameters

anEvent

The Geant4 event.

Implements simcore::PrimaryGenerator.

Definition at line 13 of file LHEPrimaryGenerator.cxx.

                                                                {
  std::unique_ptr<simcore::lhe::LHEEvent> lhe_event = reader_.readNextEvent();
 
  if (lhe_event != nullptr) {
    // Create a primary vertex for the Geant4 event
    // This is a raw pointer, and GEANT4 will delete it
    G4PrimaryVertex* vertex = new G4PrimaryVertex();
    vertex->SetPosition(lhe_event->getVertex()[0] + vertex_[0],
                        lhe_event->getVertex()[1] + vertex_[1],
                        lhe_event->getVertex()[2] + vertex_[2]);
    vertex->SetWeight(lhe_event->getEventWeight());
 
    std::map<simcore::lhe::LHEParticle*, G4PrimaryParticle*> particle_map;
 
    const auto& particles = lhe_event->getParticles();
    for (const auto& particle : particles) {
      // Check if the particle has a valid, outgoing particle status
      if (particle->getStatus() > 0) {
        // Create a primary particle for the Geant4
        // This is a raw pointer, and GEANT4 will delete it
        G4PrimaryParticle* primary = new G4PrimaryParticle();
        // Tungsten ion in the LHE files
        // TODO: can this never be +623?
        if (particle->getPdgId() == -623) {
          G4ParticleDefinition* tungsten_ion_def =
              G4IonTable::GetIonTable()->GetIon(74, 184, 0.);
          if (tungsten_ion_def != nullptr) {
            primary->SetParticleDefinition(tungsten_ion_def);
          } else {
            EXCEPTION_RAISE("EventGenerator",
                            "Failed to find particle definition for W ion.");
          }
        } else {
          primary->SetPDGcode(particle->getPdgId());
        }
 
        // Set the primary particle's momentum and lifetime
        primary->Set4Momentum(
            particle->getMomentum(0) * GeV, particle->getMomentum(1) * GeV,
            particle->getMomentum(2) * GeV, particle->getMomentum(3) * GeV);
        primary->SetProperTime(particle->getLifetime() * nanosecond);
 
        auto primary_info = std::make_unique<UserPrimaryParticleInformation>();
        primary_info->setHepEvtStatus(particle->getStatus());
        primary->SetUserInformation(primary_info.release());
 
        particle_map[particle.get()] = primary;
 
        /*
         * Assign primary as daughter but only if the mother is not a DOC
         * particle.
         */
        if (particle->getMotherParticle(0) != nullptr &&
            particle->getMotherParticle(0)->getStatus() > 0) {
          G4PrimaryParticle* primary_mom =
              particle_map[particle->getMotherParticle(0)];
          if (primary_mom != nullptr) {
            primary_mom->SetDaughter(primary);
          }
        } else {
          vertex->SetPrimary(primary);
        }
      }  // end condition for valid, outgoing particle status
    }
 
    anEvent->AddPrimaryVertex(vertex);
 
  } else {
    ldmx_log(error) << "Ran out of input events so run will be aborted!";
    G4RunManager::GetRunManager()->AbortRun(true);
    anEvent->SetEventAborted();
  }
}

References reader_, simcore::lhe::LHEReader::readNextEvent(), and vertex_.

RecordConfig()

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

overridevirtual

Record configuration information.

Parameters

id	The configuration ID.
rh	The run header.

Implements simcore::PrimaryGenerator.

Definition at line 87 of file LHEPrimaryGenerator.cxx.

                                                          {
  rh.setStringParameter(id + " Class",
                        "simcore::generators::LHEPrimaryGenerator");
  rh.setStringParameter(id + " LHE File", file_path_);
}

References file_path_, and ldmx::RunHeader::setStringParameter().

Member Data Documentation

file_path_

std::string simcore::generators::LHEPrimaryGenerator::file_path_

private

The file path to the LHE file.

Definition at line 66 of file LHEPrimaryGenerator.h.

Referenced by RecordConfig().

reader_

lhe::LHEReader simcore::generators::LHEPrimaryGenerator::reader_

private

The LHE reader with the event data.

Definition at line 72 of file LHEPrimaryGenerator.h.

Referenced by GeneratePrimaryVertex().

vertex_

std::vector<double> simcore::generators::LHEPrimaryGenerator::vertex_

private

The vertex offset to apply to the LHE event vertex.

Definition at line 77 of file LHEPrimaryGenerator.h.

Referenced by GeneratePrimaryVertex().

---

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

• SimCore/include/SimCore/Generators/LHEPrimaryGenerator.h
• SimCore/src/SimCore/Generators/LHEPrimaryGenerator.cxx