ISF::GenParticleGenericFilter Class Reference

Core Athena algorithm for the Integrated Simulation Framework. More...

#include <GenParticleGenericFilter.h>

Inheritance diagram for ISF::GenParticleGenericFilter:

Collaboration diagram for ISF::GenParticleGenericFilter:

Public Member Functions
	GenParticleGenericFilter (const std::string &t, const std::string &n, const IInterface *p)
	Constructor with framework parameters. More...
	~GenParticleGenericFilter ()
	Empty Destructor. More...
StatusCode	initialize ()
	Athena algtool's Hooks. More...
StatusCode	finalize ()
	Athena algtool's Hooks. More...
bool	pass (const HepMC::GenParticle &particle) const
	Interface method that returns whether the given particle passes all cuts or not. More...

Private Member Functions
bool	check_cuts_passed (const HepMC::GenParticle &particle) const
	Check whether the given particle passes all configure cuts or not. More...

Private Attributes
double	m_minEta
	the cuts defined by the use More...
double	m_maxEta
	max pseudorapidity cut More...
double	m_minPhi
	min phi cut More...
double	m_maxPhi
	max phi cut More...
double	m_minMom
	min momentum cut More...
double	m_maxMom
	max momentum cut More...
PDGCodes	m_pdgs
	list of accepted particle PDG IDs (any accepted if empty) More...
double	m_maxApplicableRadius
	Geometrical region (=cylindrical volume around z-axis) within which this filter is applicable. More...

Detailed Description

Core Athena algorithm for the Integrated Simulation Framework.

This GenParticle filter provides a general way of selecting/filtering out particles during GenEvent read-in.

Definition at line 41 of file GenParticleGenericFilter.h.

Constructor & Destructor Documentation

GenParticleGenericFilter()

ISF::GenParticleGenericFilter::GenParticleGenericFilter	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p
	)

Constructor with framework parameters.

Constructor.

Definition at line 25 of file GenParticleGenericFilter.cxx.

  : base_class(t,n,p),
    m_minEta(std::numeric_limits<decltype(m_minEta)>::lowest()),
    m_maxEta(std::numeric_limits<decltype(m_maxEta)>::max()),
    m_minPhi(-M_PI),
    m_maxPhi(M_PI),
    m_minMom(std::numeric_limits<decltype(m_minMom)>::lowest()),
    m_maxMom(std::numeric_limits<decltype(m_maxMom)>::max()),
    m_pdgs(),
    m_maxApplicableRadius(std::numeric_limits<decltype(m_maxApplicableRadius)>::max())
{
    // different cut parameters
    declareProperty("MinEta",
                    m_minEta,
                    "Minimum Particle Pseudorapidity");
    declareProperty("MaxEta",
                    m_maxEta,
                    "Maximum Particle Pseudorapidity");
    declareProperty("MinPhi",
                    m_minPhi,
                    "Minimum Particle Phi");
    declareProperty("MaxPhi",
                    m_maxPhi,
                    "Maximum Particle Phi");
    declareProperty("MinMom",
                    m_minMom,
                    "Minimum Particle Momentum");
    declareProperty("MaxMom",
                    m_maxMom,
                    "Maximum Particle Momentum");
    declareProperty("ParticlePDG",
                    m_pdgs,
                    "List of accepted particle PDG IDs (any accepted if empty)");
    declareProperty("MaxApplicableRadius",
                    m_maxApplicableRadius,
                    "Only particles with ProductionVertexRadius<MaxApplicableRadius may get filtered out");
}

~GenParticleGenericFilter()

ISF::GenParticleGenericFilter::~GenParticleGenericFilter ( )

inline

Empty Destructor.

Definition at line 48 of file GenParticleGenericFilter.h.

{}

Member Function Documentation

check_cuts_passed()

bool ISF::GenParticleGenericFilter::check_cuts_passed ( const HepMC::GenParticle &  particle ) const

private

Check whether the given particle passes all configure cuts or not.

Definition at line 126 of file GenParticleGenericFilter.cxx.

                                                                                          {
  const auto& momentum = particle.momentum();
  int pdg = particle.pdg_id();
#endif
  double mom = std::sqrt(momentum.x()*momentum.x()+momentum.y()*momentum.y()+momentum.z()*momentum.z());
  double eta = momentum.eta();
  double phi = momentum.phi();
 
  // check the particle pdg code
  if( m_pdgs.size() && std::find(std::begin(m_pdgs), std::end(m_pdgs), pdg) == std::end(m_pdgs) ) {
    return false;
  }
 
  // check the momentum cuts
  if (mom<m_minMom) {
    return false;
  }
  if (mom>m_maxMom) {
    return false;
  }
 
  // check the eta cuts
  if (eta<m_minEta || eta>m_maxEta) {
    return false;
  }
 
  // check the phi cuts
  if (phi<m_minPhi || phi>m_maxPhi) {
    return false;
  }
 
  // all cuts passed
  return true;
}

finalize()

StatusCode ISF::GenParticleGenericFilter::finalize

(

)

Athena algtool's Hooks.

Definition at line 76 of file GenParticleGenericFilter.cxx.

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

initialize()

StatusCode ISF::GenParticleGenericFilter::initialize

(

)

Athena algtool's Hooks.

Definition at line 67 of file GenParticleGenericFilter.cxx.

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

pass()

bool ISF::GenParticleGenericFilter::pass

(

const HepMC::GenParticle &

particle

)

const

Interface method that returns whether the given particle passes all cuts or not.

Returns whether the given particle passes all cuts or not.

Definition at line 102 of file GenParticleGenericFilter.cxx.

{
  bool pass = true;
  HepMC::ConstGenVertexPtr productionVertex = particle.production_vertex();
  if (!productionVertex || productionVertex->position().perp()<=m_maxApplicableRadius) {
      pass = check_cuts_passed(particle);
  }
  const auto momentum = particle.momentum();
  ATH_MSG_VERBOSE( "GenParticle '" << particle << "' with "
                   << (productionVertex ? "pos: r=" + std::to_string(productionVertex->position().perp()) : "")
                   << ", mom: eta=" << momentum.eta() << " phi=" << momentum.phi()
                   << " did " << (pass ? "" : "NOT ")
                   << "pass the cuts.");
  return pass;
}

Member Data Documentation

m_maxApplicableRadius

double ISF::GenParticleGenericFilter::m_maxApplicableRadius

private

Geometrical region (=cylindrical volume around z-axis) within which this filter is applicable.

Definition at line 79 of file GenParticleGenericFilter.h.

m_maxEta

double ISF::GenParticleGenericFilter::m_maxEta

private

max pseudorapidity cut

Definition at line 71 of file GenParticleGenericFilter.h.

m_maxMom

double ISF::GenParticleGenericFilter::m_maxMom

private

max momentum cut

Definition at line 75 of file GenParticleGenericFilter.h.

m_maxPhi

double ISF::GenParticleGenericFilter::m_maxPhi

private

max phi cut

Definition at line 73 of file GenParticleGenericFilter.h.

m_minEta

double ISF::GenParticleGenericFilter::m_minEta

private

the cuts defined by the use

min pseudorapidity cut

Definition at line 70 of file GenParticleGenericFilter.h.

m_minMom

double ISF::GenParticleGenericFilter::m_minMom

private

min momentum cut

Definition at line 74 of file GenParticleGenericFilter.h.

m_minPhi

double ISF::GenParticleGenericFilter::m_minPhi

private

min phi cut

Definition at line 72 of file GenParticleGenericFilter.h.

m_pdgs

PDGCodes ISF::GenParticleGenericFilter::m_pdgs

private

list of accepted particle PDG IDs (any accepted if empty)

Definition at line 76 of file GenParticleGenericFilter.h.

---

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

• GenParticleGenericFilter.h
• GenParticleGenericFilter.cxx