GenParticlePositionFilter.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
// GenParticlePositionFilter.cxx, (c) ATLAS Detector software
 
// class header include
#include "GenParticlePositionFilter.h"
 
// HepMC includes
#include "AtlasHepMC/GenParticle.h"
#include "AtlasHepMC/GenVertex.h"
#include "AtlasHepMC/SimpleVector.h"
 
ISF::GenParticlePositionFilter::GenParticlePositionFilter( const std::string& t,
                                                           const std::string& n,
                                                           const IInterface* p )
  : base_class(t,n,p),
    m_geoIDSvc("ISF_GeoIDSvc", n),
    m_checkRegion()
{
    // the GeoID indentification service
    declareProperty("GeoIDService",
        m_geoIDSvc,
        "The GeoID Service");
    declareProperty("CheckRegion",
        m_checkRegion,
        "Check if the given particles are within the specified regions");
}
 
 
// Athena algtool's Hooks
StatusCode  ISF::GenParticlePositionFilter::initialize()
{
    ATH_MSG_VERBOSE("initialize()");
 
    // retrieve the GeoIDService
    if ( m_geoIDSvc.retrieve().isFailure()){
        ATH_MSG_ERROR( "Could not retrieve " << m_geoIDSvc << ". Abort.");
        return StatusCode::FAILURE;
    }
 
    ATH_MSG_VERBOSE("initialize() successful");
    return StatusCode::SUCCESS;
}
 
 
#ifdef HEPMC3
bool ISF::GenParticlePositionFilter::pass(const HepMC::ConstGenParticlePtr& particle) const
{
  // the GenParticle production vertex
  auto  vtx = particle->production_vertex();
#else
bool ISF::GenParticlePositionFilter::pass(const HepMC::GenParticle& particle) const
{
  // the GenParticle production vertex
  HepMC::GenVertexPtr vtx = particle.production_vertex();
#endif
 
  // no production vertex?
  if (!vtx) {
    ATH_MSG_DEBUG("GenParticle does not have a production vertex, filtering it out");
    return false;
  }
 
  // (x,y,z,t) position
  HepMC::FourVector pos = vtx->position();
 
  bool inside = false;
  // check if the particle position is inside (or on surface)
  // of any of the given ISF Simulation GeoIDs
  std::vector<int>::const_iterator checkRegionIt    = m_checkRegion.begin();
  std::vector<int>::const_iterator checkRegionItEnd = m_checkRegion.end();
  for ( ; (checkRegionIt!=checkRegionItEnd) && (!inside); ++checkRegionIt) {
    // consult the GeoID identification service
    ISF::InsideType insideCheck = m_geoIDSvc->inside( pos.x(),
                                                      pos.y(),
                                                      pos.z(),
                                                      AtlasDetDescr::AtlasRegion(*checkRegionIt) );
    // is inside only if ==fInside or ==fSurface
    inside |= (insideCheck==ISF::fInside) || (insideCheck==ISF::fSurface);
  }
 
 
  // return whether pos was inside any of the simulation geometries
  if (inside)
    ATH_MSG_VERBOSE("GenParticle is inside AtlasVolume and passed the filter");
  else
    ATH_MSG_VERBOSE("GenParticle is outside AtlasVolume and got fitered out");
  return inside;
}
 
 
StatusCode  ISF::GenParticlePositionFilter::finalize()
{
  ATH_MSG_VERBOSE("Finalizing ...");
  return StatusCode::SUCCESS;
}