ISF::EntryLayerTool Class Reference

#include <EntryLayerTool.h>

Inheritance diagram for ISF::EntryLayerTool:

Collaboration diagram for ISF::EntryLayerTool:

Public Member Functions
	EntryLayerTool (const std::string &t, const std::string &n, const IInterface *p)
	Constructor with parameters.
virtual	~EntryLayerTool ()=default
	Destructor.
virtual StatusCode	initialize () override final
	Athena algtool's Hooks.
virtual bool	passesFilters (const ISFParticle &particle) override final
	Check if given particle passes the EntryLayer filters.
virtual ISF::EntryLayer	identifyEntryLayer (const ISFParticle &particle) override final
	Identify the corresponding entry layer for the given particle (may return ISF::fUnsetEntryLayer if particle is not on an entry layer surface)
virtual ISF::EntryLayer	registerParticle (const ISF::ISFParticle &particle, ISF::EntryLayer entryLayer) override final
	Add the given particle to the corresponding Entry/Exit layer if applicable.
virtual StatusCode	registerTrackRecordCollection (TrackRecordCollection *collection, EntryLayer layer) override final
	Register the TrackRecordCollection pointer for a layer.
virtual void	setupEvent () override final

Private Member Functions
TrackRecordCollection *	setupSGCollection (const std::string &name)
	used to setup a TrackRecordCollection on storegate

Private Attributes
ServiceHandle< ISF::IGeoIDSvc >	m_geoIDSvc
	GeoIDSvc will be used to determine the entry layer surface, the particle is on.
ISF::IGeoIDSvc *	m_geoIDSvcQuick
ParticleFilterArray	m_particleFilterHandle
	Array of filters to decide whether a particle is added to the Entry/Exit layer.
ISF::IParticleFilter **	m_particleFilter
size_t	m_numParticleFilters
TrackRecordCollection *	m_collection [ISF::fNumAtlasEntryLayers]
	The entry layer collections.
std::string	m_SGName [ISF::fNumAtlasEntryLayers]
std::string	m_volumeName [ISF::fNumAtlasEntryLayers]

Detailed Description

Author

Elmar.Ritsch -at- cern.ch

Definition at line 40 of file EntryLayerTool.h.

Constructor & Destructor Documentation

EntryLayerTool()

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

Constructor with parameters.

Constructor.

Definition at line 18 of file EntryLayerTool.cxx.

                                                                                             :
  base_class(t,n,p),
  m_geoIDSvc("GeoIDSvc",n),
  m_geoIDSvcQuick(0),
  m_particleFilterHandle(),
  m_particleFilter(),
  m_numParticleFilters(0),
  m_collection(),
  m_SGName(),
  m_volumeName()
{
  // geometry identification service
  declareProperty( "GeoIDSvc",
                   m_geoIDSvc,
                   "AthenaService used to indentify sub-detector by (x,y,z) coordintes.");
 
  // particle filters
  declareProperty( "ParticleFilters",
                   m_particleFilterHandle,
                   "ISF Particle filters, defining whether a particle will be stored or not.");
 
  // storegate collection names
  declareProperty( "CaloEntryLayer",
                   m_SGName[ISF::fAtlasCaloEntry] = "CaloEntryLayer",
                   "Name of CaloEntryLayer collection on Storegate");
  declareProperty( "MuonEntryLayer",
                   m_SGName[ISF::fAtlasMuonEntry] = "MuonEntryLayer",
                   "Name of MuonEntryLayer collection on Storegate");
  declareProperty( "MuonExitLayer",
                   m_SGName[ISF::fAtlasMuonExit]  = "MuonExitLayer",
                   "Name of MuonExitLayer collection on Storegate");
 
  // volumeNames for TrackRecords
  declareProperty( "CaloEntryVolumeString",
                   m_volumeName[ISF::fAtlasCaloEntry] = "IDET::IDET",
                   "VolumeName in TrackRecords in CaloEntryLayer");
  declareProperty( "MuonEntryVolumeString",
                   m_volumeName[ISF::fAtlasMuonEntry] = "CALO::CALO",
                   "VolumeName in TrackRecords in MuonEntryLayer");
  declareProperty( "MuonExitVolumeString",
                   m_volumeName[ISF::fAtlasMuonExit]  = "MUONQ02::MUONQ02",
                   "VolumeName in TrackRecords in MuonExitLayer");
}

~EntryLayerTool()

virtual ISF::EntryLayerTool::~EntryLayerTool ( )

virtualdefault

Destructor.

Member Function Documentation

identifyEntryLayer()

ISF::EntryLayer ISF::EntryLayerTool::identifyEntryLayer ( const ISFParticle & particle )

finaloverridevirtual

Identify the corresponding entry layer for the given particle (may return ISF::fUnsetEntryLayer if particle is not on an entry layer surface)

Definition at line 122 of file EntryLayerTool.cxx.

                                                                                {
  // the return value
  ISF::EntryLayer layerHit = ISF::fUnsetEntryLayer;
 
  const Amg::Vector3D &pos = particle.position();
 
  // check if particle on ID and/or Calo surface
  bool onIDSurface   = (m_geoIDSvcQuick->inside( pos, AtlasDetDescr::fAtlasID)   == ISF::fSurface);
  bool onCaloSurface = (m_geoIDSvcQuick->inside( pos, AtlasDetDescr::fAtlasCalo) == ISF::fSurface);
 
  // on CaloEntry layer ?
  if ( onIDSurface && onCaloSurface ) {
    layerHit = ISF::fAtlasCaloEntry;
  }
 
  // no surface hit yet -> test MS volume surface hit
  else {
    // check if particle on MS surface
    bool onMSSurface   = (m_geoIDSvcQuick->inside( pos, AtlasDetDescr::fAtlasMS) == ISF::fSurface);
 
    // on MuonEntry layer ?
    if (onCaloSurface && onMSSurface) {
      layerHit = ISF::fAtlasMuonEntry;
    }
    // on MuonExit layer ?
    else if (onMSSurface) {
      layerHit = ISF::fAtlasMuonExit;
    }
  }
  return layerHit;
}

initialize()

StatusCode ISF::EntryLayerTool::initialize ( )

finaloverridevirtual

Athena algtool's Hooks.

Definition at line 64 of file EntryLayerTool.cxx.

{
  ATH_MSG_INFO("initialize() ...");
 
  // retrieve the GeoIDSvc
  if ( m_geoIDSvc.retrieve().isFailure() ){
    ATH_MSG_FATAL( "Could not retrieve GeoID service. Abort.");
    return StatusCode::FAILURE;
  }
  // store a quick-access pointer to the c++ class directly
  m_geoIDSvcQuick = &(*m_geoIDSvc);
 
 
  // retrieve the ParticleFilters
  if ( m_particleFilterHandle.retrieve().isFailure() ){
    ATH_MSG_FATAL( "Could not retrieve ParticleFilters. Abort.");
    return StatusCode::FAILURE;
  }
  // store a quick-access pointer to the c++ classes directly
  m_numParticleFilters = m_particleFilterHandle.size();
  m_particleFilter = new ISF::IParticleFilter*[ m_numParticleFilters ];
  for ( size_t curFilter = 0; curFilter<m_numParticleFilters; curFilter++) {
    // convert ToolHandle to standard c++ class pointer
    m_particleFilter[curFilter] = &(*m_particleFilterHandle[curFilter]);
  }
 
  ATH_MSG_INFO("initialize() successful");
  return StatusCode::SUCCESS;
}

passesFilters()

bool ISF::EntryLayerTool::passesFilters ( const ISFParticle & particle )

finaloverridevirtual

Check if given particle passes the EntryLayer filters.

Definition at line 109 of file EntryLayerTool.cxx.

                                                                  {
  bool pass = true;
  for ( size_t curFilter=0; pass && (curFilter<m_numParticleFilters); curFilter++) {
    // check current filter
    pass = m_particleFilter[curFilter]->passFilter( particle);
  }
 
  return pass;
}

registerParticle()

ISF::EntryLayer ISF::EntryLayerTool::registerParticle ( const ISF::ISFParticle & particle, ISF::EntryLayer entryLayer )

finaloverridevirtual

Add the given particle to the corresponding Entry/Exit layer if applicable.

Definition at line 156 of file EntryLayerTool.cxx.

{
  // (1.) check whether the particle actually passes all the filters
  //      -> rather fast usually
  if ( !passesFilters(particle) ) {
    // return if not passed
    return ISF::fUnsetEntryLayer;
  }
 
  // (2.) check whether the particle lies on any entry surface
  //      -> this goes second because computation intensive routines
  //         are used for this
  if ( layerHit == ISF::fUnsetEntryLayer) {
    layerHit = identifyEntryLayer( particle);
  }
 
  // (3.) if particle is on a boundary surface
  //        -> add it to TrackRecordCollection
  if ( layerHit != ISF::fUnsetEntryLayer) {
    ATH_MSG_VERBOSE( "Particle >>" << particle << "<< hit boundary surface, "
                     "adding it to '" << m_SGName[layerHit] << "' TrackRecord collection");
 
    const Amg::Vector3D   &pos = particle.position();
    const Amg::Vector3D   &mom = particle.momentum();
    CLHEP::Hep3Vector      hepPos( pos.x(), pos.y(), pos.z() ); // not optimal, but required by TrackRecord
    CLHEP::Hep3Vector      hepMom( mom.x(), mom.y(), mom.z() ); // not optimal, but required by TrackRecord
 
    double mass            = particle.mass();
    double energy          = sqrt(mass*mass + mom.mag2());
 
    // Use barcode of generation zero particle from truth binding if possible (reproduces legacy AtlasG4 behaviour).
    // Use barcode assigend to ISFParticle only if no generation zero particle is present.
    auto                truthBinding = particle.getTruthBinding();
    auto generationZeroGenParticle = truthBinding ? truthBinding->getGenerationZeroGenParticle() : nullptr;
    const int barcode = generationZeroGenParticle ? HepMC::barcode(generationZeroGenParticle) : HepMC::barcode(particle); // FIXME barcode-based
    const int id = generationZeroGenParticle ? HepMC::uniqueID(generationZeroGenParticle) : particle.id();
    const int status = generationZeroGenParticle ? generationZeroGenParticle->status() : particle.status();
 
    m_collection[layerHit]->Emplace(particle.pdgCode(),
                                    status,
                                    energy,
                                    hepMom,
                                    hepPos,
                                    particle.timeStamp(),
                                    barcode, // FIXME barcode-based
                                    id,
                                    m_volumeName[layerHit] );
  }
 
  return layerHit;
}

registerTrackRecordCollection()

StatusCode ISF::EntryLayerTool::registerTrackRecordCollection ( TrackRecordCollection * collection, EntryLayer layer )

finaloverridevirtual

Register the TrackRecordCollection pointer for a layer.

Definition at line 209 of file EntryLayerTool.cxx.

{
  m_collection[layer]=collection; // Dummy implementation.
  return StatusCode::SUCCESS;
}

setupEvent()

void ISF::EntryLayerTool::setupEvent ( )

finaloverridevirtual

Definition at line 95 of file EntryLayerTool.cxx.

                                   {
 
  // initialize storegate collections at BeginEvent incident
  for ( int entryLayer=ISF::fFirstAtlasEntryLayer;
        entryLayer<ISF::fNumAtlasEntryLayers;
        entryLayer++) {
    m_collection[entryLayer] = setupSGCollection( m_SGName[entryLayer] );
  }
 
  return;
}

setupSGCollection()

TrackRecordCollection * ISF::EntryLayerTool::setupSGCollection ( const std::string & name )

private

used to setup a TrackRecordCollection on storegate

Definition at line 218 of file EntryLayerTool.cxx.

{
  TrackRecordCollection *collection = 0;
 
  // check if storegate already contains the collection
  // (a)     if yes ... try to retrieve it
  if ( evtStore()->contains<TrackRecordCollection>(collectionName) ){
    if ( (evtStore()->retrieve( collection, collectionName)).isFailure() )
      ATH_MSG_ERROR( "[ --- ] Unable to retrieve TrackRecordCollection " << collectionName);
    // (b)     if no ... try to create it
  } else {
    collection = new TrackRecordCollection( collectionName);
    if ( (evtStore()->record( collection, collectionName, true)).isFailure() ) {
      ATH_MSG_ERROR( "[ --- ] Unable to record SiHitCollection " << collectionName);
      delete collection;
      collection=0;
    }
  }
 
  return collection;
}

Member Data Documentation

m_collection

TrackRecordCollection* ISF::EntryLayerTool::m_collection[ISF::fNumAtlasEntryLayers]

private

The entry layer collections.

Definition at line 82 of file EntryLayerTool.h.

m_geoIDSvc

ServiceHandle<ISF::IGeoIDSvc> ISF::EntryLayerTool::m_geoIDSvc

private

GeoIDSvc will be used to determine the entry layer surface, the particle is on.

Definition at line 73 of file EntryLayerTool.h.

m_geoIDSvcQuick

ISF::IGeoIDSvc* ISF::EntryLayerTool::m_geoIDSvcQuick

private

Definition at line 74 of file EntryLayerTool.h.

m_numParticleFilters

size_t ISF::EntryLayerTool::m_numParticleFilters

private

Definition at line 79 of file EntryLayerTool.h.

m_particleFilter

ISF::IParticleFilter** ISF::EntryLayerTool::m_particleFilter

private

Definition at line 78 of file EntryLayerTool.h.

m_particleFilterHandle

ParticleFilterArray ISF::EntryLayerTool::m_particleFilterHandle

private

Array of filters to decide whether a particle is added to the Entry/Exit layer.

Definition at line 77 of file EntryLayerTool.h.

m_SGName

std::string ISF::EntryLayerTool::m_SGName[ISF::fNumAtlasEntryLayers]

private

Definition at line 83 of file EntryLayerTool.h.

m_volumeName

std::string ISF::EntryLayerTool::m_volumeName[ISF::fNumAtlasEntryLayers]

private

Definition at line 84 of file EntryLayerTool.h.

---

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

• EntryLayerTool.h
• EntryLayerTool.cxx