EventAction Class Reference

The Event Action class. More...

#include <EventAction.h>

Inheritance diagram for EventAction:

Public Member Functions
	EventAction (const std::string &mcCollectionName, MCParticleGraph &mcParticleGraph)
	Constructor.
virtual	~EventAction ()
	Destructor.
void	BeginOfEventAction (const G4Event *event)
	This method is invoked before converting the primary particles to G4Track objects.
void	EndOfEventAction (const G4Event *event)
	This method is invoked at the very end of event processing.
std::ofstream *	getVREventStream () const
	This method gets the output stream for the event-history steps.

Protected Attributes
std::string	m_mcCollectionName
	The name of the MCParticle collection to which the MCParticles should be written.
MCParticleGraph &	m_mcParticleGraph
	Reference to the MCParticle graph which is converted to a MCParticle list by this class.

Private Attributes
bool	m_writeSimSteps {false}
	Flag for writing out the simulation steps.
std::ofstream *	m_VREventStream {nullptr}
	Output stream for writing each step of event's history for the Virtual Reality.
StoreObjPtr< EventMetaData >	m_evtMetaData
	Event metadata.

Detailed Description

The Event Action class.

This class is invoked by G4EventManager for each event.

Definition at line 34 of file EventAction.h.

Constructor & Destructor Documentation

EventAction()

EventAction	(	const std::string &	mcCollectionName,
		MCParticleGraph &	mcParticleGraph )

Constructor.

Parameters

mcCollectionName	The name of the MCParticle collection.
mcParticleGraph	Reference to the MCParticle graph.

Definition at line 24 of file EventAction.cc.

                                                                                           :
  G4UserEventAction(), m_mcCollectionName(mcCollectionName),  m_mcParticleGraph(mcParticleGraph)
{
  m_writeSimSteps = Environment::Instance().getWriteSimSteps();
  if (m_writeSimSteps)
    m_VREventStream = new std::ofstream;
}

~EventAction()

~EventAction ( )

virtual

Destructor.

Definition at line 32 of file EventAction.cc.

{
  if (m_writeSimSteps) {
    // Just in case the file is still opened...
    if (m_VREventStream->is_open())
      m_VREventStream->close();
    delete m_VREventStream;
  }
}

Member Function Documentation

BeginOfEventAction()

void BeginOfEventAction

(

const G4Event *

event

)

This method is invoked before converting the primary particles to G4Track objects.

Parameters

event

Pointer to the current G4Event object.

Definition at line 42 of file EventAction.cc.

{
  //Enable recording of Hits
  SensitiveDetectorBase::setActive(true);
  if (m_writeSimSteps) {
    // Open a new output file for the VR event-history steps
    if (m_VREventStream->is_open())
      m_VREventStream->close();
    if (not m_evtMetaData.isValid())
      B2FATAL("EventMetaData is not valid.");
    int eventNumber = m_evtMetaData->getEvent();
    std::string filename = boost::str(boost::format("event%1%.csv") % eventNumber);
    m_VREventStream->open(filename);
    B2INFO("Opened VR event-history file " << filename);
  }
}

EndOfEventAction()

void EndOfEventAction

(

const G4Event *

event

)

This method is invoked at the very end of event processing.

Parameters

event

The pointer to the G4Event object which allows to access trajectories, hits collections and/or digits collections.

Definition at line 60 of file EventAction.cc.

{
  //Disable recording of Hits
  SensitiveDetectorBase::setActive(false);
 
  //Create the final MCParticle list and update the indices of the MCParticle graph particles.
  m_mcParticleGraph.generateList(m_mcCollectionName, MCParticleGraph::c_clearParticles);
 
  //Build a TrackID to MCParticle index list
  vector<std::pair<unsigned int, bool> > indices;
  indices.resize(m_mcParticleGraph.size() + 1);
  for (unsigned int iParticle = 0; iParticle < m_mcParticleGraph.size(); ++iParticle) {
    const MCParticleGraph::GraphParticle& currParticle = m_mcParticleGraph[iParticle];
    //assert(currParticle.getTrackID()<indices.size());
    indices[currParticle.getTrackID()] = std::make_pair(currParticle.getIndex() - 1, currParticle.getIgnore());
  }
  RelationArray::ReplaceVec<> indexReplacement(indices);
 
  //Update all registered MCParticle Relations and replace the TrackID by the final MCParticle id
  const std::map<std::string, RelationArray::EConsolidationAction>& relations = SensitiveDetectorBase::getMCParticleRelations();
  for (std::map<std::string, RelationArray::EConsolidationAction>::const_iterator it = relations.begin(); it != relations.end();
       ++it) {
    RelationArray mcPartRelation(it->first);
    if (mcPartRelation) mcPartRelation.consolidate(indexReplacement, RelationArray::Identity(), it->second);
  }
 
  if (m_writeSimSteps) {
    // Close the VR event-history file
    if (m_VREventStream->is_open())
      m_VREventStream->close();
  }
}

getVREventStream()

std::ofstream * getVREventStream ( ) const

inline

This method gets the output stream for the event-history steps.

Definition at line 66 of file EventAction.h.

{ return m_VREventStream; }

Member Data Documentation

m_evtMetaData

StoreObjPtr<EventMetaData> m_evtMetaData

private

Event metadata.

Definition at line 77 of file EventAction.h.

m_mcCollectionName

std::string m_mcCollectionName

protected

The name of the MCParticle collection to which the MCParticles should be written.

Definition at line 70 of file EventAction.h.

m_mcParticleGraph

MCParticleGraph& m_mcParticleGraph

protected

Reference to the MCParticle graph which is converted to a MCParticle list by this class.

Definition at line 71 of file EventAction.h.

m_VREventStream

std::ofstream* m_VREventStream {nullptr}

private

Output stream for writing each step of event's history for the Virtual Reality.

Definition at line 76 of file EventAction.h.

{nullptr};  

m_writeSimSteps

bool m_writeSimSteps {false}

private

Flag for writing out the simulation steps.

Definition at line 75 of file EventAction.h.

{false}; 

---

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

• simulation/kernel/include/EventAction.h
• simulation/kernel/src/EventAction.cc