Simulation::GenEventValidityChecker Class Reference

#include <GenEventValidityChecker.h>

Inheritance diagram for Simulation::GenEventValidityChecker:

Collaboration diagram for Simulation::GenEventValidityChecker:

Public Member Functions
	GenEventValidityChecker (const std::string &t, const std::string &n, const IInterface *p)
	Constructor with parameters. More...
StatusCode	initialize () override final
	Athena algtool's Hooks. More...
StatusCode	finalize () override final
	Athena algtool's Hooks. More...
StatusCode	manipulate (HepMC::GenEvent &ge, const EventContext &ctx) const override final
	checks the the validity of the given GenEvent More...

Private Attributes
Gaudi::Property< bool >	m_checkTime {this, "CheckTime", true}
	check the time dimension value for validity More...

Detailed Description

Use the manipulate() method of this AthenaTool, to check a given GenEven for its validity.

Author

Elmar.Ritsch -at- cern.ch

Definition at line 20 of file GenEventValidityChecker.h.

Constructor & Destructor Documentation

GenEventValidityChecker()

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

Constructor with parameters.

Constructor.

Definition at line 17 of file GenEventValidityChecker.cxx.

    : base_class(t,n,p)
  {
  }

Member Function Documentation

finalize()

StatusCode Simulation::GenEventValidityChecker::finalize ( )

finaloverride

Athena algtool's Hooks.

Definition at line 33 of file GenEventValidityChecker.cxx.

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

initialize()

StatusCode Simulation::GenEventValidityChecker::initialize ( )

finaloverride

Athena algtool's Hooks.

Definition at line 25 of file GenEventValidityChecker.cxx.

  {
    ATH_MSG_VERBOSE("Initializing ...");
    ATH_MSG_VERBOSE("Initialize successful");
    return StatusCode::SUCCESS;
  }

manipulate()

StatusCode Simulation::GenEventValidityChecker::manipulate ( HepMC::GenEvent &  ge, const EventContext &  ctx  ) const

finaloverride

checks the the validity of the given GenEvent

checks the given GenEvent

Returns

StatusCode::SUCCESS in case of a valid GenEvent, StatusCode::FAILURE otherwise

Definition at line 41 of file GenEventValidityChecker.cxx.

  {
    bool allOK = true;
 
    // loop over the vertices in the GenEvent
#ifdef HEPMC3
    auto vtxIt  = ge.vertices().begin();
    auto vtxEnd = ge.vertices().end();
#else
    auto vtxIt  = ge.vertices_begin();
    auto vtxEnd = ge.vertices_end();
#endif
    for( ; vtxIt != vtxEnd; ++vtxIt) {
      // for quick access:
      const HepMC::FourVector &curPos = (*vtxIt)->position();
 
      // check if all position values are in range
      allOK &= std::isfinite( curPos.x() );
      allOK &= std::isfinite( curPos.y() );
      allOK &= std::isfinite( curPos.z() );
      // in case m_checkTime==false --> always return true here:
      allOK &= std::isfinite( curPos.t() ) || !m_checkTime;
    }
 
    if (allOK) {
      ATH_MSG_DEBUG("All vertices in the given GenEvent are valid.");
      return StatusCode::SUCCESS;
    }
 
    ATH_MSG_ERROR("At least one vertex in the given GenEvent has an invalid position value (NaN or inf).");
    return StatusCode::FAILURE;
  }

Member Data Documentation

m_checkTime

Gaudi::Property<bool> Simulation::GenEventValidityChecker::m_checkTime {this, "CheckTime", true}

private

check the time dimension value for validity

Definition at line 35 of file GenEventValidityChecker.h.

---

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

• GenEventValidityChecker.h
• GenEventValidityChecker.cxx