A class to provide conversion from a MARS format ASCII input record into HepMC format, with or without sampling. More...

#include <MarsHaloGenerator.h>

Inheritance diagram for MarsHaloGenerator:

Collaboration diagram for MarsHaloGenerator:

Public Member Functions
	MarsHaloGenerator (const HepPDT::ParticleDataTable *particleTable, const std::string &inputFile, const std::vector< std::string > &generatorSettings)
virtual	~MarsHaloGenerator ()=default
virtual int	genInitialize ()
	A function to initialise the generator.
virtual int	genFinalize ()
	A function to finalise the generator.
virtual int	fillEvt (HepMC::GenEvent evt, CLHEP::HepRandomEngine engine)
	A function to create one event in HepMC format.
void	setInterfacePlane (double interfacePlane)
	Set the position of the interface plane in mm.
void	setEnableFlip (bool enableFlip)
	Turn on or off the event flipping code.
void	setFlipProbability (float flipProbability)
	Set probability of flipping an event about Z=0.
void	setEnableSampling (bool enableSampling)
	Turn on or off sampling from the input ASCII file.
void	setBufferFileName (const std::string &bufferFileName)
	Set the name of the binary buffer file, needed for sampling from a converted file.
void	setDebugEnable (bool debug)
	A function to turn on or off debug print out.

Protected Types
enum	enumGeneratorProcessIds { MARS_READ , MARS_SINGLE , MARS_SHOWER , FLUKA_READ , FLUKA_SINGLE , FLUKA_SHOWER }
	An enum of generator process identifiers. More...
enum	enumCounters { TOT_READ , TOT_AFTER , TOT_GEN , NUM_COUNTERS }
	An enum of particle counter indices. More...

Protected Member Functions
virtual int	readEvent (std::vector< BeamHaloParticle > beamHaloEvent, CLHEP::HepRandomEngine engine)
	A function to read one event in a simplified format.
virtual int	readParticle (BeamHaloParticle *beamHaloParticle)
	A function to read one particle from the input ASCII file.
bool	flipEvent (CLHEP::HepRandomEngine *engine)
	A member function to check if the event should be flipped.
int	convertEvent (std::vector< BeamHaloParticle > beamHaloEvent, HepMC::GenEvent evt, CLHEP::HepRandomEngine *engine)
	A member function to convert a vector of beam halo particles into a GenEvent.

Protected Attributes
const HepPDT::ParticleDataTable *	m_particleTable
	A pointer to the particle data table.
std::string	m_inputFile
	Input file name.
double	m_interfacePlane
	The position of the interface plane in mm.
bool	m_enableFlip
	Flag for flipping event.
float	m_flipProbability
	Flip probability.
bool	m_enableSampling
	Flag to enable or disable sampling.
std::string	m_bufferFileName
	The name of the binary buffer file, needed for sampling from a converted file.
std::unique_ptr< BeamHaloParticleBuffer >	m_beamHaloParticleBuffer
	Binary particle buffer for caching converted events.
std::unique_ptr< AsciiInput >	m_asciiInput
	A pointer to an AsciiInput object, used to read data from the Ascii input file.
std::unique_ptr< BeamHaloGeneratorSettings >	m_beamHaloGeneratorSettings
	A pointer to a BeamHaloGeneratorSettings object used to filter particles.
long	m_eventNumber
	A data member to count the event number.
long	m_counters [NUM_COUNTERS]
	Particle or event counters of dimension enumCounters.
double	m_wsums [NUM_COUNTERS]
	Sum of weights of particles or events of dimension enumCounters.
bool	m_debug
	A flat to turn on or off debug print out.

Private Attributes
std::vector< std::string >	m_generatorSettings
	A vector of generator settings in string command form.

Detailed Description

A class to provide conversion from a MARS format ASCII input record into HepMC format, with or without sampling.

Author: W. H. Bell W.Bel.nosp@m.l@ce.nosp@m.rn.ch

Definition at line 18 of file MarsHaloGenerator.h.

Member Enumeration Documentation

◆ enumCounters

enum BeamHaloGenerator::enumCounters

protectedinherited

An enum of particle counter indices.

Enumerator
TOT_READ
TOT_AFTER
TOT_GEN
NUM_COUNTERS

Definition at line 142 of file BeamHaloGenerator.h.

                    {
    TOT_READ, 
    TOT_AFTER,
    TOT_GEN,
    NUM_COUNTERS};

◆ enumGeneratorProcessIds

enum BeamHaloGenerator::enumGeneratorProcessIds

protectedinherited

An enum of generator process identifiers.

_READ corresponds to no sampling and therefore simple conversion from input file to HepMC record.

Enumerator
MARS_READ
MARS_SINGLE
MARS_SHOWER
FLUKA_READ
FLUKA_SINGLE
FLUKA_SHOWER

Definition at line 87 of file BeamHaloGenerator.h.

                               {
    MARS_READ,
    MARS_SINGLE,
    MARS_SHOWER,
    FLUKA_READ,
    FLUKA_SINGLE,
    FLUKA_SHOWER };

Constructor & Destructor Documentation

◆ MarsHaloGenerator()

MarsHaloGenerator::MarsHaloGenerator	(	const HepPDT::ParticleDataTable *	particleTable,
		const std::string &	inputFile,
		const std::vector< std::string > &	generatorSettings )

Definition at line 16 of file MarsHaloGenerator.cxx.

                                                                   :
  BeamHaloGenerator(particleTable, inputFile, generatorSettings) {
}

◆ ~MarsHaloGenerator()

virtual MarsHaloGenerator::~MarsHaloGenerator ( )

virtualdefault

Member Function Documentation

◆ convertEvent()

int BeamHaloGenerator::convertEvent	(	std::vector< BeamHaloParticle > *	beamHaloEvent,
		HepMC::GenEvent *	evt,
		CLHEP::HepRandomEngine *	engine )

protectedinherited

A member function to convert a vector of beam halo particles into a GenEvent.

Definition at line 88 of file BeamHaloGenerator.cxx.

                                                                  {
  double pz;
  bool flipFlag = flipEvent(engine);
  HepMC::GenParticlePtr genParticle;
  HepMC::GenVertexPtr genVertex;
  const double c = 2.99792458E+11; // speed of light in mm/s
 
  std::vector<BeamHaloParticle>::iterator itr = beamHaloEvent->begin();
  std::vector<BeamHaloParticle>::iterator itr_end = beamHaloEvent->end();
 
  if(itr != itr_end) {
    // Take the primary information from the first particle in the event.  If the event is more than one
    // particle, the particles come from the same primary proton.
    evt->weights().push_back((*itr).weight()); // event weight
    HepMC::FourVector primaryPosition = (*itr).positionAtPrimary();
    evt->weights().push_back(primaryPosition.x()); // Starting position of primary particle: x position (cm)
    evt->weights().push_back(primaryPosition.y()); // Starting position of primary particle: y position (cm)
    evt->weights().push_back(primaryPosition.z()); // Starting position of primary particle: z position (cm)
    evt->weights().push_back(primaryPosition.t()); // Starting position of primary particle: t (s)
  } 
 
  // Append each particle to the GenEvent
  for(;itr!=itr_end;++itr) {
    HepMC::FourVector position = (*itr).positionAtScoringPlane();
    HepMC::FourVector fourVector = (*itr).fourVector();
 
    if(!flipFlag) {
      genParticle = HepMC::newGenParticlePtr(fourVector,
                       (*itr).pdgId(),
                       1);
 
      genVertex = HepMC::newGenVertexPtr(HepMC::FourVector(position.x(),
                             position.y(),
                             (position.z() + m_interfacePlane),
                             c*position.t() -1.0*std::fabs(m_interfacePlane)),
                       1);
    }
    else {
      pz = fourVector.pz();
      fourVector.setPz(-pz);
 
      genParticle = HepMC::newGenParticlePtr(fourVector,
                       (*itr).pdgId(),
                       1);
 
      genVertex = HepMC::newGenVertexPtr(HepMC::FourVector(position.x(),
                             position.y(),
                             -1.0*(position.z() + m_interfacePlane),
                             c*position.t() -1.0*std::fabs(m_interfacePlane)),
                       1);
    }
 
    genVertex->add_particle_out(genParticle);
    evt->add_vertex(genVertex);
  }
 
  return 0;
}

◆ fillEvt()

int MarsHaloGenerator::fillEvt	(	HepMC::GenEvent *	evt,
		CLHEP::HepRandomEngine *	engine )

virtual

A function to create one event in HepMC format.

Implements BeamHaloGenerator.

Definition at line 71 of file MarsHaloGenerator.cxx.

                                                             {
  std::vector<BeamHaloParticle> beamHaloEvent;
  int ret_val;
 
  // Read one MARS event which passes the generator settings.
  if((ret_val = readEvent(&beamHaloEvent, engine)) != 0) return ret_val;
 
  // Convert the particles to GenParticles and attach them to the
  // event.  Flip the event if needed.
  if((ret_val = BeamHaloGenerator::convertEvent(&beamHaloEvent, evt, engine)) != 0) return ret_val;
 
  // Set the event number
  evt->set_event_number(m_eventNumber);
 
  // Clear the values set by the base class convertEvent method
  evt->weights().clear();
 
  // Check if sampling has been enabled or not.
  if(!m_enableSampling) {
    HepMC::set_signal_process_id(evt,BeamHaloGenerator::MARS_READ);
    evt->weights().push_back(beamHaloEvent[0].weight());
  }
  else {
    HepMC::set_signal_process_id(evt,BeamHaloGenerator::MARS_SINGLE);
    evt->weights().push_back(1.0);
  }
 
  m_eventNumber++;
 
  return 0;
}

◆ flipEvent()

bool BeamHaloGenerator::flipEvent ( CLHEP::HepRandomEngine * engine )

protectedinherited

A member function to check if the event should be flipped.

Definition at line 74 of file BeamHaloGenerator.cxx.

                                                              {
  if(!m_enableFlip) return false;
 
  // Check to see if the event should be flipped or not
  if(CLHEP::RandFlat::shoot(engine) <= m_flipProbability) {
    if(m_debug) std::cout << "Debug: Flipping event" << std::endl;
    return true;
  }
 
  return false;
}

◆ genFinalize()

int MarsHaloGenerator::genFinalize ( )

virtual

A function to finalise the generator.

Reimplemented from BeamHaloGenerator.

Definition at line 106 of file MarsHaloGenerator.cxx.

                                   {
  int ret_val;
 
  // Check if sampling has been enabled or not.
  if(!m_enableSampling) {
    m_asciiInput->close();
  }
  else {
    m_beamHaloParticleBuffer->close();
  }
 
  // Finalise base class
  if((ret_val = BeamHaloGenerator::genFinalize()) != 0) return ret_val;
 
  return 0;
}

◆ genInitialize()

int MarsHaloGenerator::genInitialize ( )

virtual

A function to initialise the generator.

Reimplemented from BeamHaloGenerator.

Definition at line 24 of file MarsHaloGenerator.cxx.

                                     {
  int ret_val;
 
  // Initialise base class
  if((ret_val = BeamHaloGenerator::genInitialize()) != 0) return ret_val;
 
  if(m_asciiInput->open()) {
    std::cout << "Error: Could not open ascii input file " << m_inputFile << std::endl;
    return 1;
  }
 
  // Check if sampling is required if sampling is required leave 
  // the ASCII file open for the event loop. 
  if(!m_enableSampling) return 0;
 
  m_beamHaloParticleBuffer = std::make_unique<BeamHaloParticleBuffer>(m_bufferFileName);
  if(m_beamHaloParticleBuffer->openForWriting()) {
    std::cout << "Error: Could not open binary buffer file " << m_bufferFileName << " for writing." << std::endl;
    return 1;
  }
 
  std::cout << "Info: Reading ascii input file " << m_inputFile << " into buffer" << std::endl;
 
  // Loop over all lines in the text file.
  BeamHaloParticle beamHaloParticle;
  bool eof = false;
  while(!eof) {
    ret_val = readParticle(&beamHaloParticle); 
    if(ret_val < 0) { eof = true; continue; }
    else if(ret_val > 0) { continue; }
 
    // Write the BeamHaloParticle into the binary buffer.
    if(m_beamHaloParticleBuffer->writeParticle(&beamHaloParticle)) {
      std::cout << "Warning: writeParticle failed." << std::endl;
    }
  } 
 
  m_asciiInput->close();
  m_beamHaloParticleBuffer->close();
 
  m_beamHaloParticleBuffer->openForReading();
 
  return 0;
}

◆ readEvent()

int MarsHaloGenerator::readEvent	(	std::vector< BeamHaloParticle > *	beamHaloEvent,
		CLHEP::HepRandomEngine *	engine )

protectedvirtual

A function to read one event in a simplified format.

Implements BeamHaloGenerator.

Definition at line 163 of file MarsHaloGenerator.cxx.

                                                               {
  BeamHaloParticle *beamHaloParticle;
  int ret_val;
 
  // Clear the event
  beamHaloEvent->clear();
 
  // Check if sampling is required  
  if(!m_enableSampling) {
    beamHaloParticle = new BeamHaloParticle();
    bool eof = false, gotParticle = false; 
    while(!eof && !gotParticle) {
      ret_val = readParticle(beamHaloParticle);
      if(ret_val < 0) { eof = true; }
      else if(ret_val == 0) { gotParticle = true; } 
    }
  } 
  else {  
    // Read one particle at random from the binary buffer.  This uses
    // the particle weights to produce a flat distribution rather than a
    // weighted one, but may generate the same particle twice.
    beamHaloParticle = m_beamHaloParticleBuffer->readRandomParticle(engine);
    if(!beamHaloParticle) {
      std::cout << "Error: readRandomParticle failed." << std::endl;
      return 1;
    }
  }
 
  // Increment generated particles information.
  m_counters[TOT_GEN]++;
  m_wsums[TOT_GEN]+= beamHaloParticle->weight();
 
 
  // Copy the BeamHaloParticle into this event
  beamHaloEvent->push_back(*beamHaloParticle);
 
  // Delete the pointer to the generated particle.
  delete beamHaloParticle;
 
  return 0;
}

◆ readParticle()

int MarsHaloGenerator::readParticle ( BeamHaloParticle * beamHaloParticle )

protectedvirtual

A function to read one particle from the input ASCII file.

Implements BeamHaloGenerator.

Definition at line 125 of file MarsHaloGenerator.cxx.

                                                                      {
  std::vector<std::string> row;
  MarsParticle marsParticle;
 
  // Read one row of the ASCII file.
  row = m_asciiInput->readRow();
  if(row.size() == 0) return -1; // EOF
 
  // Fill a MarsParticle with values from the string vector.
  if(marsParticle.read(&row)) {
    return 1;  
  }
 
  // Fill the BeamHaloParticle with the data in the MarsParticle
  if(beamHaloParticle->fill(m_particleTable, &marsParticle)) {
    std::cout << "Warning: Conversion from MarsParticle to BeamHaloParticle failed." << std::endl;
    return 1;
  }
 
  // Increment the particles read from file information.
  m_counters[TOT_READ]++;
  m_wsums[TOT_READ]+= beamHaloParticle->weight();
 
  // Check the generator settings.  If this particle fails skip it.
  if(!m_beamHaloGeneratorSettings->checkParticle(beamHaloParticle)) {
    if(m_debug) std::cout << "Debug: Particle fails generator settings cuts." << std::endl;
    return 1;
  }
 
  // Increment the particles after cuts information.
  m_counters[TOT_AFTER]++;
  m_wsums[TOT_AFTER]+= beamHaloParticle->weight();
 
  return 0;
}

◆ setBufferFileName()

void BeamHaloGenerator::setBufferFileName ( const std::string & bufferFileName )

inlineinherited

Set the name of the binary buffer file, needed for sampling from a converted file.

Definition at line 77 of file BeamHaloGenerator.h.

77{ m_bufferFileName = bufferFileName; }

◆ setDebugEnable()

void BeamHaloGenerator::setDebugEnable ( bool debug )

inlineinherited

A function to turn on or off debug print out.

Definition at line 80 of file BeamHaloGenerator.h.

80{ m_debug = debug; }

debug

const bool debug

Definition MakeUncertaintyPlots.cxx:53

◆ setEnableFlip()

void BeamHaloGenerator::setEnableFlip ( bool enableFlip )

inlineinherited

Turn on or off the event flipping code.

Definition at line 67 of file BeamHaloGenerator.h.

67{ m_enableFlip = enableFlip; }

◆ setEnableSampling()

void BeamHaloGenerator::setEnableSampling ( bool enableSampling )

inlineinherited

Turn on or off sampling from the input ASCII file.

Definition at line 73 of file BeamHaloGenerator.h.

73{ m_enableSampling = enableSampling; }

◆ setFlipProbability()

void BeamHaloGenerator::setFlipProbability ( float flipProbability )

inlineinherited

Set probability of flipping an event about Z=0.

Definition at line 70 of file BeamHaloGenerator.h.

70{ m_flipProbability = flipProbability; }

jobOptions_CavernBackground.flipProbability

flipProbability

Definition jobOptions_CavernBackground.py:24

◆ setInterfacePlane()

void BeamHaloGenerator::setInterfacePlane ( double interfacePlane )

inlineinherited

Set the position of the interface plane in mm.

Definition at line 64 of file BeamHaloGenerator.h.

64{ m_interfacePlane = interfacePlane; }

jobOptions_CavernBackground.interfacePlane

interfacePlane

Definition jobOptions_CavernBackground.py:23

Member Data Documentation

◆ m_asciiInput

std::unique_ptr<AsciiInput> BeamHaloGenerator::m_asciiInput

protectedinherited

A pointer to an AsciiInput object, used to read data from the Ascii input file.

Definition at line 132 of file BeamHaloGenerator.h.

◆ m_beamHaloGeneratorSettings

std::unique_ptr<BeamHaloGeneratorSettings> BeamHaloGenerator::m_beamHaloGeneratorSettings

protectedinherited

A pointer to a BeamHaloGeneratorSettings object used to filter particles.

Definition at line 136 of file BeamHaloGenerator.h.

◆ m_beamHaloParticleBuffer

std::unique_ptr<BeamHaloParticleBuffer> BeamHaloGenerator::m_beamHaloParticleBuffer

protectedinherited

Binary particle buffer for caching converted events.

Definition at line 128 of file BeamHaloGenerator.h.

◆ m_bufferFileName

std::string BeamHaloGenerator::m_bufferFileName

protectedinherited

The name of the binary buffer file, needed for sampling from a converted file.

Definition at line 125 of file BeamHaloGenerator.h.

◆ m_counters

long BeamHaloGenerator::m_counters[NUM_COUNTERS]

protectedinherited

Particle or event counters of dimension enumCounters.

Definition at line 149 of file BeamHaloGenerator.h.

◆ m_debug

bool BeamHaloGenerator::m_debug

protectedinherited

A flat to turn on or off debug print out.

Definition at line 155 of file BeamHaloGenerator.h.

◆ m_enableFlip

bool BeamHaloGenerator::m_enableFlip

protectedinherited

Flag for flipping event.

Definition at line 115 of file BeamHaloGenerator.h.

◆ m_enableSampling

bool BeamHaloGenerator::m_enableSampling

protectedinherited

Flag to enable or disable sampling.

Definition at line 121 of file BeamHaloGenerator.h.

◆ m_eventNumber

long BeamHaloGenerator::m_eventNumber

protectedinherited

A data member to count the event number.

Definition at line 139 of file BeamHaloGenerator.h.

◆ m_flipProbability

float BeamHaloGenerator::m_flipProbability

protectedinherited

Flip probability.

Definition at line 118 of file BeamHaloGenerator.h.

◆ m_generatorSettings

std::vector<std::string> BeamHaloGenerator::m_generatorSettings

privateinherited

A vector of generator settings in string command form.

Definition at line 160 of file BeamHaloGenerator.h.

◆ m_inputFile

std::string BeamHaloGenerator::m_inputFile

protectedinherited

Input file name.

Definition at line 109 of file BeamHaloGenerator.h.

◆ m_interfacePlane

double BeamHaloGenerator::m_interfacePlane

protectedinherited

The position of the interface plane in mm.

Definition at line 112 of file BeamHaloGenerator.h.

◆ m_particleTable

const HepPDT::ParticleDataTable* BeamHaloGenerator::m_particleTable

protectedinherited

A pointer to the particle data table.

Definition at line 106 of file BeamHaloGenerator.h.

◆ m_wsums

double BeamHaloGenerator::m_wsums[NUM_COUNTERS]

protectedinherited

Sum of weights of particles or events of dimension enumCounters.

Definition at line 152 of file BeamHaloGenerator.h.

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ enumCounters

◆ enumGeneratorProcessIds

Constructor & Destructor Documentation

◆ MarsHaloGenerator()

◆ ~MarsHaloGenerator()

Member Function Documentation

◆ convertEvent()

◆ fillEvt()

◆ flipEvent()

◆ genFinalize()

◆ genInitialize()

◆ readEvent()

◆ readParticle()

◆ setBufferFileName()

◆ setDebugEnable()

◆ setEnableFlip()

◆ setEnableSampling()

◆ setFlipProbability()

◆ setInterfacePlane()

Member Data Documentation

◆ m_asciiInput

◆ m_beamHaloGeneratorSettings

◆ m_beamHaloParticleBuffer

◆ m_bufferFileName

◆ m_counters

◆ m_debug

◆ m_enableFlip

◆ m_enableSampling

◆ m_eventNumber

◆ m_flipProbability

◆ m_generatorSettings

◆ m_inputFile

◆ m_interfacePlane

◆ m_particleTable

◆ m_wsums