Simplistic kinematic filter on energy and pseudorapidity. More...

#include <KinematicSimSelector.h>

Inheritance diagram for ISF::KinematicSimSelector:

Collaboration diagram for ISF::KinematicSimSelector:

Public Member Functions
	KinematicSimSelector (const std::string &t, const std::string &n, const IInterface *p)
	Constructor with parameters.
	~KinematicSimSelector ()
	Destructor.
virtual StatusCode	initialize () override
virtual StatusCode	finalize () override
virtual bool	passSelectorCuts (const ISFParticle &particle) const override
	check whether given particle passes all cuts -> will be used for routing decision
virtual StatusCode	sysInitialize () override
	Gaudi sysInitialize() method.
virtual ServiceHandle< ISimulationSvc > *simulator	ATLAS_NOT_THREAD_SAFE () override
	return a handle on the simulator
virtual SimSvcID simSvcID	ATLAS_NOT_THREAD_SAFE () override
	return the simulation service ID
virtual void beginEvent	ATLAS_NOT_THREAD_SAFE () override
	called at the beginning of each athena event (can be used for eg.
virtual void endEvent	ATLAS_NOT_THREAD_SAFE () override
	called at the end of each athena event (can be used for eg.
virtual void update	ATLAS_NOT_THREAD_SAFE (const ISFParticle &) override
	update internal event representation
virtual bool	isDynamic () override
	return if is this a static or dynamic SimulationSelector (is used by fully dynamic particle routers)
virtual ISF::SimulationFlavor	simFlavor () const override
	return the simulation flavor
virtual void	initializeSelector () override
	initialize Selector
virtual bool	selfSelect (const ISFParticle &particle) const override
	make the routing decision
bool	pass (const ISFParticle &particle) const
	check whether the given particle passes all cuts

Protected Attributes
float	m_cut_minPosEta
	minimum pseudorapidity of particle position
float	m_cut_maxPosEta
	maximum pseudorapidity of particle position
float	m_cut_minMomEta
	minimum pseudorapidity of particle momentum
float	m_cut_maxMomEta
	maximum pseudorapidity of particle momentum
double	m_cut_minMom2
	minimum squarde particle momentum magnitude
double	m_cut_maxMom2
	maximum squared particle momentum magnitude
double	m_cut_maxEkin
	maximum particle kinetic energy
float	m_cut_charge
	particle charge
int	m_cut_pdg
	particle PDG code

Private Member Functions
void	SimulationFlavorHandler (Gaudi::Details::PropertyBase &)

Private Attributes
ServiceHandle< ISimulationSvc >	m_simulator {this, "Simulator", "", "simulation service assigned to a single advisor"}
Gaudi::Property< bool >	m_isDynamic {this, "IsDynamic", false, "this selector is either dynamic or static"}
Gaudi::Property< bool >	m_invertCuts {this, "InvertCuts", false, "invert the result given by passesCuts(..) method"}
Gaudi::CheckedProperty< unsigned short >	m_simFlavorProp {this, "SimulationFlavor", 0, "the simulation flavour that this selector will select"}
ISF::SimulationFlavor	m_simflavor {ISF::UndefinedSim}
	simulation flavor

Detailed Description

Simplistic kinematic filter on energy and pseudorapidity.

Author: Elmar.Ritsch -at- cern.ch

Definition at line 22 of file KinematicSimSelector.h.

Constructor & Destructor Documentation

◆ KinematicSimSelector()

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

Constructor with parameters.

Constructor.

Definition at line 11 of file KinematicSimSelector.cxx.

  : BaseSimulationSelector(t,n,p)
  , KinematicParticleCuts()
{
  declareProperty("MinPosEta",            m_cut_minPosEta  , "Minimum Position Pseudorapidity" );
  declareProperty("MaxPosEta",            m_cut_maxPosEta  , "Maximum Position Pseudorapidity" );
  declareProperty("MinMomEta",            m_cut_minMomEta  , "Minimum Momentum Pseudorapidity" );
  declareProperty("MaxMomEta",            m_cut_maxMomEta  , "Maximum Momentum Pseudorapidity" );
  declareProperty("MinMom",               m_cut_minMom2    , "Minimum Particle Momentum"       );
  declareProperty("MaxMom",               m_cut_maxMom2    , "Maximum Particle Momentum"       );
  declareProperty("MaxEkin",              m_cut_maxEkin    , "Maximum Particle Kinetic Energy" );
  declareProperty("Charge",               m_cut_charge     , "Particle Charge"                 );
  declareProperty("ParticlePDG",          m_cut_pdg        , "Particle PDG Code"               );
}

◆ ~KinematicSimSelector()

ISF::KinematicSimSelector::~KinematicSimSelector ( )

Destructor.

Definition at line 27 of file KinematicSimSelector.cxx.

28{

29}

Member Function Documentation

◆ ATLAS_NOT_THREAD_SAFE() [1/5]

virtual void endEvent ISF::BaseSimulationSelector::ATLAS_NOT_THREAD_SAFE ( )

overridevirtualinherited

called at the end of each athena event (can be used for eg.

resetting dynamic selectors)

◆ ATLAS_NOT_THREAD_SAFE() [2/5]

virtual void beginEvent ISF::BaseSimulationSelector::ATLAS_NOT_THREAD_SAFE ( )

overridevirtualinherited

called at the beginning of each athena event (can be used for eg.

resetting dynamic selectors)

◆ ATLAS_NOT_THREAD_SAFE() [3/5]

virtual SimSvcID simSvcID ISF::BaseSimulationSelector::ATLAS_NOT_THREAD_SAFE ( )

overridevirtualinherited

return the simulation service ID

◆ ATLAS_NOT_THREAD_SAFE() [4/5]

virtual ServiceHandle< ISimulationSvc > *simulator ISF::BaseSimulationSelector::ATLAS_NOT_THREAD_SAFE ( )

overridevirtualinherited

return a handle on the simulator

◆ ATLAS_NOT_THREAD_SAFE() [5/5]

virtual void update ISF::BaseSimulationSelector::ATLAS_NOT_THREAD_SAFE ( const ISFParticle & )

overridevirtualinherited

update internal event representation

◆ finalize()

StatusCode ISF::KinematicSimSelector::finalize ( )

overridevirtual

Definition at line 49 of file KinematicSimSelector.cxx.

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

◆ initialize()

StatusCode ISF::KinematicSimSelector::initialize ( )

overridevirtual

Definition at line 32 of file KinematicSimSelector.cxx.

{
  ATH_MSG_VERBOSE("Initializing ...");
  auto gendata = std::make_unique<GenData>();
  double mass = gendata->particleMass(abs(m_cut_pdg)).value_or(0.0);
 
  // compute and store the square of the momentum cuts (faster comparisons)
  if ( !(m_cut_minMom2<0.)) m_cut_minMom2 *= m_cut_minMom2;
  if ( !(m_cut_maxMom2<0.)) m_cut_maxMom2 *= m_cut_maxMom2;
 
  // if use kinetic energy 
  if(!(m_cut_maxEkin < 0.)) m_cut_maxMom2 = m_cut_maxEkin * (m_cut_maxEkin + 2 * mass);
 
  return StatusCode::SUCCESS;
}

◆ initializeSelector()

void ISF::BaseSimulationSelector::initializeSelector ( )

overridevirtualinherited

initialize Selector

Definition at line 84 of file BaseSimulationSelector.cxx.

84{ }

◆ isDynamic()

bool ISF::BaseSimulationSelector::isDynamic ( )

overridevirtualinherited

return if is this a static or dynamic SimulationSelector (is used by fully dynamic particle routers)

return if is this a static or dynamic SimulationSelector (is used by fully dynamic partilce routers)

Definition at line 69 of file BaseSimulationSelector.cxx.

                                          {
  return m_isDynamic;
}

◆ pass()

bool ISF::KinematicParticleCuts::pass ( const ISFParticle & particle ) const

inlineinherited

check whether the given particle passes all cuts

◆ passSelectorCuts()

bool ISF::KinematicSimSelector::passSelectorCuts ( const ISFParticle & particle ) const

overridevirtual

check whether given particle passes all cuts -> will be used for routing decision

Definition at line 55 of file KinematicSimSelector.cxx.

{
  return ISF::KinematicParticleCuts::pass(particle);
}

◆ selfSelect()

bool ISF::BaseSimulationSelector::selfSelect ( const ISFParticle & particle ) const

overridevirtualinherited

make the routing decision

Definition at line 54 of file BaseSimulationSelector.cxx.

{
  bool pass = passSelectorCuts(particle);
  pass = ( m_invertCuts ? (!pass) : pass );
 
  return pass;
}

◆ simFlavor()

ISF::SimulationFlavor ISF::BaseSimulationSelector::simFlavor ( ) const

overridevirtualinherited

return the simulation flavor

return the simulation service ID

Definition at line 79 of file BaseSimulationSelector.cxx.

                                                               {
  return m_simflavor;
}

◆ SimulationFlavorHandler()

void ISF::BaseSimulationSelector::SimulationFlavorHandler ( Gaudi::Details::PropertyBase & )

privateinherited

Definition at line 20 of file BaseSimulationSelector.cxx.

{
  // FIXME would probably be better to have this in SimulationFlavor.h
  switch(m_simFlavorProp.value())
    {
    case 1: m_simflavor = ISF::ParticleKiller; break;
    case 2: m_simflavor = ISF::Fatras; break;
    case 3: m_simflavor = ISF::Geant4; break;
    case 4: m_simflavor = ISF::FastCaloSim; break;
    case 5: m_simflavor = ISF::FastCaloSimV2; break;
    case 6: m_simflavor = ISF::Parametric; break;
    case 7: m_simflavor = ISF::FatrasPileup; break;
    case 8: m_simflavor = ISF::FastCaloSimPileup; break;
    }
}

◆ sysInitialize()

StatusCode ISF::BaseSimulationSelector::sysInitialize ( )

overridevirtualinherited

Gaudi sysInitialize() method.

Definition at line 37 of file BaseSimulationSelector.cxx.

{
  ATH_CHECK( AthAlgTool::sysInitialize() );
 
  if (!m_simulator.empty()) {
    ATH_CHECK( m_simulator.retrieve() );
  }
 
  return StatusCode::SUCCESS;
}

Member Data Documentation

◆ m_cut_charge

float ISF::KinematicParticleCuts::m_cut_charge

protectedinherited

particle charge

Definition at line 43 of file KinematicParticleCuts.h.

◆ m_cut_maxEkin

double ISF::KinematicParticleCuts::m_cut_maxEkin

protectedinherited

maximum particle kinetic energy

Definition at line 42 of file KinematicParticleCuts.h.

◆ m_cut_maxMom2

double ISF::KinematicParticleCuts::m_cut_maxMom2

protectedinherited

maximum squared particle momentum magnitude

Definition at line 41 of file KinematicParticleCuts.h.

◆ m_cut_maxMomEta

float ISF::KinematicParticleCuts::m_cut_maxMomEta

protectedinherited

maximum pseudorapidity of particle momentum

Definition at line 39 of file KinematicParticleCuts.h.

◆ m_cut_maxPosEta

float ISF::KinematicParticleCuts::m_cut_maxPosEta

protectedinherited

maximum pseudorapidity of particle position

Definition at line 37 of file KinematicParticleCuts.h.

◆ m_cut_minMom2

double ISF::KinematicParticleCuts::m_cut_minMom2

protectedinherited

minimum squarde particle momentum magnitude

Definition at line 40 of file KinematicParticleCuts.h.

◆ m_cut_minMomEta

float ISF::KinematicParticleCuts::m_cut_minMomEta

protectedinherited

minimum pseudorapidity of particle momentum

Definition at line 38 of file KinematicParticleCuts.h.

◆ m_cut_minPosEta

float ISF::KinematicParticleCuts::m_cut_minPosEta

protectedinherited

minimum pseudorapidity of particle position

Definition at line 36 of file KinematicParticleCuts.h.

◆ m_cut_pdg

int ISF::KinematicParticleCuts::m_cut_pdg

protectedinherited

particle PDG code

Definition at line 44 of file KinematicParticleCuts.h.

◆ m_invertCuts

Gaudi::Property<bool> ISF::BaseSimulationSelector::m_invertCuts {this, "InvertCuts", false, "invert the result given by passesCuts(..) method"}

privateinherited

Definition at line 75 of file BaseSimulationSelector.h.

75{this, "InvertCuts", false, "invert the result given by passesCuts(..) method"};

◆ m_isDynamic

Gaudi::Property<bool> ISF::BaseSimulationSelector::m_isDynamic {this, "IsDynamic", false, "this selector is either dynamic or static"}

privateinherited

Definition at line 74 of file BaseSimulationSelector.h.

74{this, "IsDynamic", false, "this selector is either dynamic or static"};

◆ m_simflavor

ISF::SimulationFlavor ISF::BaseSimulationSelector::m_simflavor {ISF::UndefinedSim}

privateinherited

simulation flavor

Definition at line 78 of file BaseSimulationSelector.h.

78{ISF::UndefinedSim};

ISF::UndefinedSim

@ UndefinedSim

Definition SimulationFlavor.h:20

◆ m_simFlavorProp

Gaudi::CheckedProperty<unsigned short> ISF::BaseSimulationSelector::m_simFlavorProp {this, "SimulationFlavor", 0, "the simulation flavour that this selector will select"}

privateinherited

Definition at line 76 of file BaseSimulationSelector.h.

76{this, "SimulationFlavor", 0, "the simulation flavour that this selector will select"};

◆ m_simulator

ServiceHandle<ISimulationSvc> ISF::BaseSimulationSelector::m_simulator {this, "Simulator", "", "simulation service assigned to a single advisor"}

privateinherited

Definition at line 73 of file BaseSimulationSelector.h.

73{this, "Simulator", "", "simulation service assigned to a single advisor"};

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

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KinematicSimSelector()

◆ ~KinematicSimSelector()

Member Function Documentation

◆ ATLAS_NOT_THREAD_SAFE() [1/5]

◆ ATLAS_NOT_THREAD_SAFE() [2/5]

◆ ATLAS_NOT_THREAD_SAFE() [3/5]

◆ ATLAS_NOT_THREAD_SAFE() [4/5]

◆ ATLAS_NOT_THREAD_SAFE() [5/5]

◆ finalize()

◆ initialize()

◆ initializeSelector()

◆ isDynamic()

◆ pass()

◆ passSelectorCuts()

◆ selfSelect()

◆ simFlavor()

◆ SimulationFlavorHandler()

◆ sysInitialize()

Member Data Documentation

◆ m_cut_charge

◆ m_cut_maxEkin

◆ m_cut_maxMom2

◆ m_cut_maxMomEta

◆ m_cut_maxPosEta

◆ m_cut_minMom2

◆ m_cut_minMomEta

◆ m_cut_minPosEta

◆ m_cut_pdg

◆ m_invertCuts

◆ m_isDynamic

◆ m_simflavor

◆ m_simFlavorProp

◆ m_simulator