Simulation::VertexPositionFromFile Class Reference

#include <VertexPositionFromFile.h>

Inheritance diagram for Simulation::VertexPositionFromFile:

Collaboration diagram for Simulation::VertexPositionFromFile:

Public Member Functions
	VertexPositionFromFile (const std::string &t, const std::string &n, const IInterface *p)
	Constructor with parameters. More...
virtual	~VertexPositionFromFile ()=default
	Destructor. More...
StatusCode	initialize () override final
	Athena algtool's Hooks. More...
StatusCode	finalize () override final
	Athena algtool's Hooks. More...
CLHEP::HepLorentzVector *	generate (const EventContext &ctx) const override final
	returns current shift More...

Private Types
typedef std::pair< int, int >	RunEventPair
	using typedefs to make code more readable for (run,event) -> (x,y,z) mapping More...
typedef std::vector< double >	XYZCoordinates
typedef std::map< RunEventPair, XYZCoordinates >	EventCoordinatesMap

Private Member Functions
StatusCode	readVertexPosFile ()
	read-in and cache vertex positions from file More...
StatusCode	readRunEventNumFile ()
	read-in and cache run/event number overrides locally for vertex positioning More...

Private Attributes
Gaudi::Property< std::string >	m_vertexPositionFile {this, "VertexPositionsFile", ""}
	set vertex position by file More...
EventCoordinatesMap	m_vertexPositionMap {}
	vertex position for (run,event) pairs More...
Gaudi::Property< std::string >	m_runEventNumbersFile {this, "RunAndEventNumbersFile", ""}
	run and event number overrides according to file (to be used optionally in combination with 'set vertex by file') More...
std::vector< int >	m_vertexPositionRunNum {}
	run number override vector More...
std::vector< int >	m_vertexPositionEventNum {}
	event number override vector More...
SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfoKey {this, "EventInfoKey", "EventInfo"}
	Name of the EventInfo object in StoreGate. More...

Detailed Description

Returns a VertexShift based on what is given in the input file.

based on: https://svnweb.cern.ch/trac/atlasoff/browser/Simulation/G4Atlas/G4AtlasUtilities/trunk/src/VertexPositioner.cxx

Author

Elmar.Ritsch -at- cern.ch

Definition at line 35 of file VertexPositionFromFile.h.

Member Typedef Documentation

EventCoordinatesMap

typedef std::map< RunEventPair, XYZCoordinates> Simulation::VertexPositionFromFile::EventCoordinatesMap

private

Definition at line 56 of file VertexPositionFromFile.h.

RunEventPair

typedef std::pair< int, int > Simulation::VertexPositionFromFile::RunEventPair

private

using typedefs to make code more readable for (run,event) -> (x,y,z) mapping

Definition at line 54 of file VertexPositionFromFile.h.

XYZCoordinates

typedef std::vector< double > Simulation::VertexPositionFromFile::XYZCoordinates

private

Definition at line 55 of file VertexPositionFromFile.h.

Constructor & Destructor Documentation

VertexPositionFromFile()

Simulation::VertexPositionFromFile::VertexPositionFromFile	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p
	)

Constructor with parameters.

Constructor.

Definition at line 19 of file VertexPositionFromFile.cxx.

    : base_class(t,n,p)
  {
  }

~VertexPositionFromFile()

virtual Simulation::VertexPositionFromFile::~VertexPositionFromFile ( )

virtualdefault

Destructor.

Member Function Documentation

finalize()

StatusCode Simulation::VertexPositionFromFile::finalize ( )

finaloverride

Athena algtool's Hooks.

Definition at line 55 of file VertexPositionFromFile.cxx.

  {
    ATH_MSG_VERBOSE("Finalizing ...");
    return StatusCode::SUCCESS;
  }

generate()

CLHEP::HepLorentzVector * Simulation::VertexPositionFromFile::generate ( const EventContext &  ctx ) const

finaloverride

returns current shift

modifies (displaces) the given GenEvent

Definition at line 161 of file VertexPositionFromFile.cxx.

  {
    unsigned int runNumber(0), eventNumber(0);
    // override the run/event number from file
    if (!m_runEventNumbersFile.empty()) {
      // This works because we iterate over the file exactly once
      static std::atomic<size_t> runEventNumbersIndex(0);
      ATH_MSG_DEBUG("Retrieving event info from event file, position " << runEventNumbersIndex);
      runNumber   = m_vertexPositionRunNum[runEventNumbersIndex];
      eventNumber = m_vertexPositionEventNum[runEventNumbersIndex];
      ++runEventNumbersIndex;
    }
    // use run/event numbers from EventInfo class in storegate
    else {
      ATH_MSG_DEBUG("Retrieving event info from SG");
      SG::ReadHandle<xAOD::EventInfo> eventInfo(m_eventInfoKey, ctx);
      if (eventInfo.isValid()) {
        // read out run/event number
        runNumber   = eventInfo->runNumber();
        eventNumber = eventInfo->eventNumber();
      }
      else {
        ATH_MSG_ERROR("Could not retrieve event info from SG");
        return nullptr;
      }
    }
    ATH_MSG_DEBUG("Got run/event: " << runNumber << "/" << eventNumber);
    // read the (x,y,z) coordinates for the current (run,event)
    const RunEventPair curRunEvtPair(runNumber, eventNumber);
    const XYZCoordinates &updatedVertexPosition = m_vertexPositionMap.at(curRunEvtPair);
    ATH_MSG_DEBUG("Got vertex offset: " << updatedVertexPosition[0] << " " <<
                  updatedVertexPosition[1] << " " << updatedVertexPosition[2]);
    // no (x,y,z) coordinates given for the current (run,event) numbers
    if (updatedVertexPosition.size()!=3) {
      ATH_MSG_ERROR("Vertex position requested, but no info found in map for run/event: " <<
                    runNumber << "/" << eventNumber);
      return nullptr;
    }
    // store the actual vertex offset
    CLHEP::HepLorentzVector *vertexOffset =
      new CLHEP::HepLorentzVector( updatedVertexPosition[0], updatedVertexPosition[1],
                                   updatedVertexPosition[2], 0. );
    // and return it
    return vertexOffset;
  }

initialize()

StatusCode Simulation::VertexPositionFromFile::initialize ( )

finaloverride

Athena algtool's Hooks.

Definition at line 27 of file VertexPositionFromFile.cxx.

  {
    ATH_MSG_VERBOSE("Initializing ...");
 
    // read-in and cache the content of the VertexPositionsFile, throw error if:
    //  * no VertexPositionsFile is given
    //  * or something goes wrong in the file read-in
    if ( m_vertexPositionFile.empty() || readVertexPosFile().isFailure() ) {
      ATH_MSG_ERROR("Something went wrong with setting up the vertex positioning from file '"
                    << m_vertexPositionFile << "'");
      return StatusCode::FAILURE;
    }
 
    // if a filename is given for a event number overrides
    //   --> read in this file and cache its content locally
    if ( !m_runEventNumbersFile.empty() && readRunEventNumFile().isFailure()) {
      ATH_MSG_ERROR("Something went wrong with setting up the run/event number overrides from file'"
                    << m_runEventNumbersFile << "'");
      return StatusCode::FAILURE;
    }
 
    ATH_CHECK(m_eventInfoKey.initialize());
 
    // everything set up properly
    return StatusCode::SUCCESS;
  }

readRunEventNumFile()

StatusCode Simulation::VertexPositionFromFile::readRunEventNumFile ( )

private

read-in and cache run/event number overrides locally for vertex positioning

Definition at line 118 of file VertexPositionFromFile.cxx.

  {
    FILE *vefile = fopen( m_runEventNumbersFile.value().c_str(),"r");
    if ( !vefile) {
      ATH_MSG_ERROR("Could not open vertex positioning run/event number file: "<< m_runEventNumbersFile);
      return StatusCode::FAILURE;
    }
    ATH_MSG_VERBOSE("Opened vertex positioning run/event number file: " << m_runEventNumbersFile);
    //svcMgr.EvtIdModifierSvc.add_modifier(run_nbr=167776, evt_nbr=22, time_stamp=1299948350, lbk_nbr=130, nevts=1)
    int verun(0);     // run number
    int veevent(0);   // event number
    int vetime(0);    // time stamp
    int velbn(0);     // lumi block nr
    int ven(0);       // num events
    int numReadIn(0); // number of read-ins
    // read in file
    while (true) {
      // fill local variables with values given in file
      int r = fscanf(vefile, "svcMgr.EvtIdModifierSvc.add_modifier(run_nbr=%i, evt_nbr=%i, time_stamp=%i, lbk_nbr=%i, nevts=%i)\n",
                     &verun, &veevent, &vetime, &velbn, &ven);
 
      // if read-in was successful
      if (r>0) {
        ATH_MSG_DEBUG( "Read "<<r<<" vertex positioning run/event values: "
                       <<verun<<"/"<<veevent<<" "<<vetime<<"," <<velbn<<","<<ven );
        // store the run and event number locally
        m_vertexPositionRunNum.push_back( verun);
        m_vertexPositionEventNum.push_back( veevent);
        ++numReadIn;
      }
      // nothing read-in
      else {
        ATH_MSG_VERBOSE("Got "<<r<<" from fscanf, stopping");
        break;
      }
    } // loop over lines in file
    // close file
    fclose(vefile);
    ATH_MSG_VERBOSE("Read " << numReadIn <<" vertex positioning run/event entries from file.");
    return StatusCode::SUCCESS;
  }

readVertexPosFile()

StatusCode Simulation::VertexPositionFromFile::readVertexPosFile ( )

private

read-in and cache vertex positions from file

Definition at line 62 of file VertexPositionFromFile.cxx.

  {
    ATH_MSG_INFO("Will read in vertex positions from file.");
    FILE *vfile = fopen( m_vertexPositionFile.value().c_str(),"r");
    if (!vfile) {
      ATH_MSG_ERROR("Could not open vertex position file: " << m_vertexPositionFile);
      return StatusCode::FAILURE;
    }
    ATH_MSG_DEBUG("Opened vertex position file: " << m_vertexPositionFile);
    int          vrun(0);           // run number
    int          vevent(0);         // event number
    double       vx(0.); // vertex coordinates
    double       vy(0.); // vertex coordinates
    double       vz(0.); // vertex coordinates
    unsigned int numReadIn(0);      // number of vertex overrides read in
    // read in file
    while (true) {
      // fill local variables with values given in file
      int r = fscanf(vfile, "%i %i %lf %lf %lf\n", &vrun, &vevent, &vx, &vy, &vz);
      // if read-in was successful
      if (r>0) {
        ATH_MSG_VERBOSE( "Read "<<r<<" vertex position values from file: "<<vrun
                         <<"/"<<vevent<<" "<<vx<<","<<vy<<","<<vz);
        // get the corresponding (#run,#event) entry in the m_vertexPositionMap
        RunEventPair    curRunEvt(vrun, vevent);
        XYZCoordinates &curCoordinates = m_vertexPositionMap[curRunEvt];
        // check if (vrun,vevent) combination already filled
        if ( curCoordinates.size()!=0) {
          ATH_MSG_WARNING( "Already position information for run/event "<<vrun<<"/"<<vevent
                           << ", size=" << curCoordinates.size() );
        }
        else {
          curCoordinates.resize(3);
        }
        // store the (x,y,z) coordinates in the vertexPositionMap:
        curCoordinates[0] = vx;
        curCoordinates[1] = vy;
        curCoordinates[2] = vz;
        // use this trick to only allocate the amount of memory
        // actually used by curXYZ
        //curCoordinates.swap( curCoordinates);
        ++numReadIn;
      }
      // nothing read-in
      else {
        ATH_MSG_VERBOSE("Got "<<r<<" from fscanf, stopping");
        break;
      }
    } // loop over lines in file
    // close file
    fclose(vfile);
    ATH_MSG_VERBOSE("Read " << numReadIn << " vertex position entries from file.");
    return StatusCode::SUCCESS;
  }

Member Data Documentation

m_eventInfoKey

SG::ReadHandleKey<xAOD::EventInfo> Simulation::VertexPositionFromFile::m_eventInfoKey {this, "EventInfoKey", "EventInfo"}

private

Name of the EventInfo object in StoreGate.

Definition at line 72 of file VertexPositionFromFile.h.

m_runEventNumbersFile

Gaudi::Property<std::string> Simulation::VertexPositionFromFile::m_runEventNumbersFile {this, "RunAndEventNumbersFile", ""}

private

run and event number overrides according to file (to be used optionally in combination with 'set vertex by file')

Name of file containing event info overrides for pos overrides

Definition at line 69 of file VertexPositionFromFile.h.

m_vertexPositionEventNum

std::vector<int> Simulation::VertexPositionFromFile::m_vertexPositionEventNum {}

private

event number override vector

Definition at line 71 of file VertexPositionFromFile.h.

m_vertexPositionFile

Gaudi::Property<std::string> Simulation::VertexPositionFromFile::m_vertexPositionFile {this, "VertexPositionsFile", ""}

private

set vertex position by file

Name of file containing vertex position overrides

Definition at line 64 of file VertexPositionFromFile.h.

m_vertexPositionMap

EventCoordinatesMap Simulation::VertexPositionFromFile::m_vertexPositionMap {}

private

vertex position for (run,event) pairs

Definition at line 65 of file VertexPositionFromFile.h.

m_vertexPositionRunNum

std::vector<int> Simulation::VertexPositionFromFile::m_vertexPositionRunNum {}

private

run number override vector

Definition at line 70 of file VertexPositionFromFile.h.

---

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

• VertexPositionFromFile.h
• VertexPositionFromFile.cxx