ISF::GenParticleSimAcceptList Class Reference

Stable/Interacting particle filter for HepMC particles to be used in the stack filling process. More...

#include <GenParticleSimAcceptList.h>

Inheritance diagram for ISF::GenParticleSimAcceptList:

Collaboration diagram for ISF::GenParticleSimAcceptList:

Public Member Functions
	GenParticleSimAcceptList (const std::string &t, const std::string &n, const IInterface *p)
	Constructor.
	~GenParticleSimAcceptList ()
	Destructor.
virtual StatusCode	initialize () override final
	Athena algtool's Hooks.
virtual StatusCode	finalize () override final
virtual bool	pass (const HepMC::ConstGenParticlePtr &particle) const override
	passes through to the private version

Private Member Functions
bool	pass (const HepMC::ConstGenParticlePtr &particle, std::vector< int > &used_vertices) const
	returns true if the the particle and all daughters are on the accept list

Private Attributes
StringArrayProperty	m_acceptLists {this, "AcceptLists", {"G4particle_acceptlist.txt"} }
	The location of the accept lists.
std::vector< long int >	m_pdgId
	Allowed PDG IDs.
BooleanProperty	m_qs {this, "QuasiStableSim", true}
	Switch for quasi-stable particle simulation.
BooleanProperty	m_useShadowEvent {this, "UseShadowEvent", false, "New approach to selecting particles for simulation" }
DoubleProperty	m_minDecayRadiusQS {this, "MinimumDecayRadiusQS", 30.19*Gaudi::Units::mm}
	Decay radius below which QS particles should be ignored.

Detailed Description

Stable/Interacting particle filter for HepMC particles to be used in the stack filling process.

Checks this particle and all daughters.

Author

ZLMarshall -at- lbl.gov

Definition at line 31 of file GenParticleSimAcceptList.h.

Constructor & Destructor Documentation

GenParticleSimAcceptList()

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

Constructor.

Definition at line 23 of file GenParticleSimAcceptList.cxx.

  : base_class(t,n,p)
{
}

~GenParticleSimAcceptList()

ISF::GenParticleSimAcceptList::~GenParticleSimAcceptList ( )

inline

Destructor.

Definition at line 38 of file GenParticleSimAcceptList.h.

{}

Member Function Documentation

finalize()

StatusCode ISF::GenParticleSimAcceptList::finalize ( )

finaloverridevirtual

Definition at line 141 of file GenParticleSimAcceptList.cxx.

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

initialize()

StatusCode ISF::GenParticleSimAcceptList::initialize ( )

finaloverridevirtual

Athena algtool's Hooks.

Definition at line 31 of file GenParticleSimAcceptList.cxx.

{
    ATH_MSG_VERBOSE("Initializing ...");
 
    // Initialize the list
    m_pdgId.clear();
 
    for (auto &acceptList : m_acceptLists) {
      // Get the appropriate file handle
      std::string resolvedFilename = PathResolver::find_file( acceptList , "DATAPATH" );
      std::ifstream white_list;
      white_list.open( resolvedFilename );
      if (!white_list.is_open()){
        ATH_MSG_ERROR("Could not find accept list " << acceptList);
        return StatusCode::FAILURE;
      }
 
      // Parse the list into the vector
      std::string a_line;
      char * pEnd;
      while (!white_list.eof()){
        getline( white_list , a_line );
        long int pdg = strtol( a_line.c_str() , &pEnd , 10 );
        if (std::find(m_pdgId.begin(), m_pdgId.end(), pdg) == m_pdgId.end()) {
          m_pdgId.push_back(pdg);
        } else {
          ATH_MSG_DEBUG("pdgId " << pdg << " already in acceptlist. Will not add it again.");
        }
      }
 
      // Sort the list for use later
      std::sort( m_pdgId.begin() , m_pdgId.end() );
    }
 
    // All done!
    return StatusCode::SUCCESS;
}

pass() [1/2]

bool ISF::GenParticleSimAcceptList::pass ( const HepMC::ConstGenParticlePtr & particle ) const

overridevirtual

passes through to the private version

passes through to the private version of the filter

Definition at line 70 of file GenParticleSimAcceptList.cxx.

{
 
  ATH_MSG_VERBOSE( "Checking whether " << particle << " passes the filter." );
 
  std::vector<int> vertices(500);
  bool so_far_so_good = pass( particle , vertices );
 
  // Test all parent particles
  const int id_of_particle = particle->id();
  if (so_far_so_good && particle->production_vertex() && m_qs){
    for (auto& pit: particle->production_vertex()->particles_in()){
      // Loop breaker
      if ( pit->id() == id_of_particle ) continue;
      // Check this particle
      vertices.clear();
      bool parent_all_clear = pass( pit , vertices );
      ATH_MSG_VERBOSE( "Parent all clear: " << parent_all_clear <<
         "\nIf true, will not pass the daughter because it should have been picked up through the parent already (to avoid multi-counting)." );
      so_far_so_good = so_far_so_good && !parent_all_clear;
    } // Loop over parents
  } // particle had parents
 
  return so_far_so_good;
}

pass() [2/2]

bool ISF::GenParticleSimAcceptList::pass ( const HepMC::ConstGenParticlePtr & particle, std::vector< int > & used_vertices ) const

private

returns true if the the particle and all daughters are on the accept list

Definition at line 98 of file GenParticleSimAcceptList.cxx.

{
  // See if the particle is in the accept list
  bool passFilter = std::binary_search( m_pdgId.begin() , m_pdgId.end() , particle->pdg_id() ) || MC::isNucleus( particle->pdg_id() );
  // Remove documentation particles
  passFilter = passFilter && MC::isPhysical(particle);
  // Test all daughter particles
  if (particle->end_vertex() && m_qs && passFilter){
    // Primarily interested in passing particles decaying outside
    // m_minDecayRadiusQS (nomimally the inner radius of the
    // beampipe). However, it is also interesting to pass particles
    // which start outside m_minDecayRadiusQS, but decay inside it.
    passFilter = passFilter && ( (m_minDecayRadiusQS < particle->end_vertex()->position().perp()) || (m_minDecayRadiusQS < particle->production_vertex()->position().perp()) );
    if (passFilter) {
      // Break loops
      if ( std::find( used_vertices.begin() , used_vertices.end() , particle->end_vertex()->id() )==used_vertices.end() ){
        used_vertices.push_back( particle->end_vertex()->id() );
        for (auto& pit: particle->end_vertex()->particles_out()){
          passFilter = passFilter && pass( pit , used_vertices );
          if (!passFilter) {
            ATH_MSG_VERBOSE( "Daughter particle " << pit << " does not pass." );
            break;
          }
        } // Loop over daughters
      } // Break loops
    } // particle decayed before the min radius to be considered for simulation
    else {
      ATH_MSG_VERBOSE( "Particle " << particle << " was produced and decayed within a radius of " << m_minDecayRadiusQS << " mm.");
    }
  } // particle had daughters
  if (!m_useShadowEvent && !particle->end_vertex() && MC::isDecayed(particle)) { // no daughters... No end vertex... Check if this isn't trouble
    ATH_MSG_ERROR( "Found a particle with no end vertex that does not appear in the accept list." );
    ATH_MSG_ERROR( "This is VERY likely pointing to a problem with either the configuration you ");
    ATH_MSG_ERROR( "are using, or a bug in the generator.  Either way it should be fixed.  The");
    ATH_MSG_ERROR( "particle will come next, and then we will throw.");
    ATH_MSG_ERROR( particle );
    throw std::runtime_error("GenParticleSimAcceptList: Particle with no end vertex and not in acceptlist");
  }
 
  return passFilter;
}

Member Data Documentation

m_acceptLists

StringArrayProperty ISF::GenParticleSimAcceptList::m_acceptLists {this, "AcceptLists", {"G4particle_acceptlist.txt"} }

private

The location of the accept lists.

Definition at line 50 of file GenParticleSimAcceptList.h.

{this, "AcceptLists", {"G4particle_acceptlist.txt"} }; 

m_minDecayRadiusQS

DoubleProperty ISF::GenParticleSimAcceptList::m_minDecayRadiusQS {this, "MinimumDecayRadiusQS", 30.19*Gaudi::Units::mm}

private

Decay radius below which QS particles should be ignored.

Definition at line 54 of file GenParticleSimAcceptList.h.

{this, "MinimumDecayRadiusQS", 30.19*Gaudi::Units::mm}; 

m_pdgId

std::vector<long int> ISF::GenParticleSimAcceptList::m_pdgId

private

Allowed PDG IDs.

Definition at line 51 of file GenParticleSimAcceptList.h.

m_qs

BooleanProperty ISF::GenParticleSimAcceptList::m_qs {this, "QuasiStableSim", true}

private

Switch for quasi-stable particle simulation.

Definition at line 52 of file GenParticleSimAcceptList.h.

{this, "QuasiStableSim", true}; 

m_useShadowEvent

BooleanProperty ISF::GenParticleSimAcceptList::m_useShadowEvent {this, "UseShadowEvent", false, "New approach to selecting particles for simulation" }

private

Definition at line 53 of file GenParticleSimAcceptList.h.

{this, "UseShadowEvent", false, "New approach to selecting particles for simulation" };

---

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

• GenParticleSimAcceptList.h
• GenParticleSimAcceptList.cxx