xAODJetFilter Class Reference

Applies the generator level filter for jet candidates. More...

#include <xAODJetFilter.h>

Inheritance diagram for xAODJetFilter:

Collaboration diagram for xAODJetFilter:

Classes
struct	McObj

Public Member Functions
virtual StatusCode	filterInitialize () override final
virtual StatusCode	filterEvent () override final
	GenFilter (const std::string &name, ISvcLocator *pSvcLocator)
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Event loop algorithm methods: not to be overloaded
StatusCode	initialize ()
StatusCode	execute ()
StatusCode	finalize ()
Gen-specific event loop methods: to be overloaded!
virtual StatusCode	filterFinalize ()
Counters
int	nPassed () const
int	nFailed () const
int	nNeeded () const
Event collection accessors (const and non-const)
HepMC::GenEvent *event	ATLAS_NOT_CONST_THREAD_SAFE ()
	Access the current signal event (first in the McEventCollection)
McEventCollection *events	ATLAS_NOT_CONST_THREAD_SAFE ()
	Access the current event's McEventCollection.
const HepMC::GenEvent *	event_const () const
	Access the current signal event (const)
const McEventCollection *	events_const () const
	Access the current event's McEventCollection (const)
const McEventCollection *	events_const (const EventContext &ctx) const
Particle data accessors
const ServiceHandle< IPartPropSvc >	partPropSvc () const
	Access the particle property service.
const HepPDT::ParticleDataTable &	particleTable () const
	Get a particle data table.
const HepPDT::ParticleDataTable &	pdt () const
	Shorter alias to get a particle data table.
const HepPDT::ParticleData *	particleData (int pid) const
	Access an element in the particle data table.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Protected Attributes
Counters and requirements
int	m_nPass
int	m_nFail
int	m_nNeeded
Properties
std::string	m_mcEventKey {}
	StoreGate key for the MC event collection (defaults to GEN_EVENT)
BooleanProperty	m_mkMcEvent {this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"}
	Flag to determine if a new MC event collection should be made if it doesn't exist.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_truthPartContKey {this, "TruthParticleContainerKey", "TruthGen"}
Gaudi::Property< double >	m_userEta {this, "EtaRange", 2.7, " "}
Gaudi::Property< double >	m_userThresh {this, "JetThreshold", 17000., " "}
Gaudi::Property< double >	m_stop {this, "SeedThreshold", 1000., " "}
Gaudi::Property< double >	m_cone {this, "ConeSize", 0.4, " "}
Gaudi::Property< int >	m_gride {this, "GridSizeEta",2, " "}
Gaudi::Property< int >	m_gridp {this, "GridSizePhi",2, " "}
Gaudi::Property< int >	m_userNumber {this, "JetNumber",1, " "}
Gaudi::Property< bool >	m_type {this, "JetType",true, " "}
double	m_etaRange {}
double	m_emaxeta {}
double	m_edeta {}
double	m_edphi {}
int	m_nphicell {}
int	m_netacell {}
int	m_nphicell2 {}
int	m_netacell2 {}
std::vector< McObj >	m_Jets
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Static Private Attributes
static const int	m_grphi = 105
static const int	m_greta = 200

Utility event-mangling functions
Todo Replace with HepMC units when available
ServiceHandle< IPartPropSvc >	m_ppSvc {this, "PartPropSvc", "PartPropSvc"}
	Handle on the particle property service.
SG::ReadHandleKey< McEventCollection >	m_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }
	Const handle to the MC event collection.
void	GeVToMeV (HepMC::GenEvent *evt)
	Scale event energies/momenta by x 1000.
void	MeVToGeV (HepMC::GenEvent *evt)
	Scale event energies/momenta by x 1/1000.
void	cmTomm (HepMC::GenEvent *evt)
	Scale event lengths by x 10.
void	mmTocm (HepMC::GenEvent *evt)
	Scale event lengths by x 1/10.

Detailed Description

Applies the generator level filter for jet candidates.

Author

I Hinchliffe, May 2002

Definition at line 16 of file xAODJetFilter.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

ATLAS_NOT_CONST_THREAD_SAFE() [1/2]

HepMC::GenEvent *event GenBase::ATLAS_NOT_CONST_THREAD_SAFE ( )

inlineinherited

Access the current signal event (first in the McEventCollection)

Note

This function will make a new McEventCollection if there is not already a valid one and MakeMcEvent=True.

Definition at line 76 of file GenBase.h.

                                                      {
    if (events()->empty())
      ATH_MSG_ERROR("McEventCollection is empty during first event access");
    return *(events()->begin());
  }

ATLAS_NOT_CONST_THREAD_SAFE() [2/2]

McEventCollection *events GenBase::ATLAS_NOT_CONST_THREAD_SAFE ( )

inherited

Access the current event's McEventCollection.

Note

This function will make a new McEventCollection if there is not already a valid one and MakeMcEvent=True.

cmTomm()

void GenBase::cmTomm ( HepMC::GenEvent * evt )

protectedinherited

Scale event lengths by x 10.

Definition at line 78 of file GenBase.cxx.

                                       {
  for (HepMC::GenEvent::vertex_iterator vtx = evt->vertices_begin(); vtx != evt->vertices_end(); ++vtx) {
    const HepMC::FourVector fv((*vtx)->position().x() * 10,
                               (*vtx)->position().y() * 10,
                               (*vtx)->position().z() * 10,
                               (*vtx)->position().t() * 10);
    (*vtx)->set_position(fv);
  }
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

event_const()

const HepMC::GenEvent * GenBase::event_const ( ) const

inlineinherited

Access the current signal event (const)

Definition at line 83 of file GenBase.h.

                                           {
    if (events_const()->empty())
      ATH_MSG_ERROR("Const McEventCollection is empty during first event access");
    return *(events_const()->begin());
  }

events_const() [1/2]

const McEventCollection * GenBase::events_const ( ) const

inlineinherited

Access the current event's McEventCollection (const)

Definition at line 96 of file GenBase.h.

                                                {
    return events_const( getContext() );
  }

events_const() [2/2]

const McEventCollection * GenBase::events_const ( const EventContext & ctx ) const

inlineinherited

Definition at line 99 of file GenBase.h.

                                                                         {
    SG::ReadHandle<McEventCollection> ret = SG::makeHandle(m_mcevents_const, ctx);
    if (!ret.isValid())
      ATH_MSG_ERROR("No McEventCollection found in StoreGate with key " << m_mcevents_const.key());
    return ret.cptr();
  }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode GenFilter::execute ( )

virtualinherited

Todo

Probably the filter should only look at the first event... right?

Reimplemented from GenBase.

Definition at line 29 of file GenFilter.cxx.

                              {
  if (events_const()->empty()) {
    ATH_MSG_ERROR("No events found in McEventCollection");
    return StatusCode::FAILURE;
  } else if (events_const()->size() > 1) {
    ATH_MSG_WARNING("More than one event in current McEventCollection -- which is valid?");
  }
  StatusCode sc = filterEvent();
#ifdef HEPMC3
  if (filterPassed() || m_keepAll ) {
#else
  if (filterPassed() ) {
#endif
    ATH_MSG_DEBUG("Event passed filter");
    m_nPass += 1;
  } else {
    ATH_MSG_DEBUG("Event failed filter");
    m_nFail += 1;
  }
  // Bail out once we have enough events
  if (m_nPass >= m_nNeeded && m_nNeeded > 0)
    sc = StatusCode::FAILURE;
  return sc;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

filterEvent()

StatusCode xAODJetFilter::filterEvent ( )

finaloverridevirtual

Implements GenFilter.

Definition at line 50 of file xAODJetFilter.cxx.

                                      {
  // Init grid
  //coverity[STACK_USE]
  double etgrid[m_grphi][m_greta];    // clean it out before we start
  //coverity[STACK_USE]
  bool etgridused[m_grphi][m_greta];  // will use this to mark off cells after
                                      // they are added to jets
  for (int ie = 0; ie < m_greta; ++ie) {  // initialise everything to be safe
    for (int ip = 0; ip < m_grphi; ++ip) {
      etgrid[ip][ie] = 0.;
      etgridused[ip][ie] = false;
    }
  }
 
// Retrieve TruthGen container from xAOD Gen slimmer, contains all particles witout barcode_zero and 
// duplicated barcode ones
  SG::ReadHandle<xAOD::TruthParticleContainer> xTruthParticleContainer{m_truthPartContKey};
  if (!xTruthParticleContainer.isValid()) {
    ATH_MSG_ERROR("No TruthParticle collection with name " << m_truthPartContKey.key() << " found in StoreGate!");
    return StatusCode::FAILURE;
  }
 
  // Loop over all particles in the event and build up the grid
  for (const xAOD::TruthParticle* part : *xTruthParticleContainer) {
      if (part->isGenStable()) {  // stables only
        if (!MC::isMuon(part) &&
            !MC::isSMNeutrino(part) &&
            (std::abs(part->eta()) <=
             m_emaxeta)) {  // no neutrinos or muons and particles must be in
                            // active range
          int ip, ie;
          ip = static_cast<int>((M_PI + part->phi()) /
                     m_edphi);  // phi is in range -CLHEP::pi to CLHEP::pi
          ie = static_cast<int>((part->eta() + m_emaxeta) / m_edeta);
          if (ie < 0 ||
              (ie >=
               m_greta)) {  // its outside the ends so we should not be here
            ATH_MSG_FATAL("Jet too close to end");
            return StatusCode::FAILURE;
          }
          while (ip < 0)
            ip += m_grphi;  // fix phi wrapping note that this is done after rr
                            // is calculated
          while (ip > m_grphi - 1)
            ip -= m_grphi;  // fix phi wrapping note that this is done after rr
                            // is calculated
          etgrid[ip][ie] = etgrid[ip][ie] + part->pt();  // fortran had pt here
        }
    }
  } // end Particles loop
 
  // Find the highest cell; we loop here until we cannot find more jets
  double ethigh = 2. * m_stop;  // et of highest cell
  while (
      ethigh >
      m_stop) {  // stop looping when there are no cells left above threshold;
    ethigh = 0.;
    int etahigh = 0;
    int phihigh = 0;
    for (int ie0 = m_netacell; ie0 < m_greta - m_netacell;
         ++ie0) {  // only look away from the edges
      for (int ip0 = 0; ip0 < m_grphi; ++ip0) {
        if (etgrid[ip0][ie0] > ethigh && !etgridused[ip0][ie0]) {
          ethigh = etgrid[ip0][ie0];
          etahigh = ie0;
          phihigh = ip0;
        }
      }
    }
 
    if (ethigh >
        m_stop) {  // this passes only if there is tower above threshold
      // new jet
      CLHEP::HepLorentzVector FoundJet;
      double jetpx = 0.;
      double jetpy = 0.;
      double jetpz = 0.;
      double jete = 0.;
      if (!m_type) {  // grid handle differantly if there are an even number of
                      // cells
        if (m_netacell2 % 2 == 0 && m_nphicell2 % 2 == 1) {  // eta even
          double sum = 0.;
          double sum1 = 0.;
          for (int ip0 = 0; ip0 < m_nphicell2; ip0++) {
            int ip1 = ip0 - m_nphicell + phihigh;
            sum = sum + etgrid[ip1][etahigh - 1];
            sum1 = sum1 + etgrid[ip1][etahigh + 1];
          }
          if (sum < sum1) {
            etahigh += 1;  // shift over by one
          }
        }
        if (m_netacell2 % 2 == 1 && m_nphicell2 % 2 == 0) {  // phi even
          double sum = 0.;
          double sum1 = 0.;
          for (int ie0 = 0; ie0 < m_netacell2; ie0++) {
            int ie1 = ie0 - m_netacell + etahigh;
            sum = sum + etgrid[(phihigh - 1) % m_grphi][ie1];
            sum1 = sum1 + etgrid[(phihigh + 1) % m_grphi][ie1];
          }
          if (sum < sum1) {
            phihigh = (phihigh + 1) % m_grphi;  // shift over by one
          }
        }
        if (m_netacell2 % 2 == 0 && m_nphicell2 % 2 == 0) {  // both even
          double sum = 0.;
          double sum1 = 0.;
          double sum2 = 0.;
          double sum3 = 0.;
          for (int ie0 = 0; ie0 < m_netacell2; ie0++) {
            for (int ip0 = 0; ip0 < m_nphicell2; ip0++) {
              int ip1 = ip0 - m_nphicell + phihigh;
              int ie1 = ie0 - m_netacell + etahigh;
              if (!etgridused[ip1][ie1])
                sum = sum + etgrid[ip1][ie1];
              if (!etgridused[ip1][ie1 + 1])
                sum1 = sum1 + etgrid[ip1][ie1 + 1];
              if (!etgridused[ip1 + 1][ie1])
                sum2 = sum2 + etgrid[(ip1 + 1) % m_grphi][ie1];
              if (!etgridused[ip1 + 1][ie1 + 1])
                sum3 = sum3 + etgrid[(ip1 + 1) % m_grphi][ie1 + 1];
            }
          }
          if (sum < sum1 && sum2 < sum1 && sum3 < sum1)
            etahigh = etahigh + 1;
          if (sum < sum2 && sum1 <= sum2 && sum3 < sum2)
            phihigh = (phihigh + 1) % m_grphi;
          if (sum < sum3 && sum2 <= sum3 && sum1 <= sum3) {
            etahigh = etahigh + 1;
            phihigh = (phihigh + 1) % m_grphi;
          }
        }
      }
      // Add up stuff around high cell
      for (int ie0 = 0; ie0 < m_netacell2; ++ie0) {
        int ie1 = ie0 - m_netacell + etahigh;
        if ((ie1 < 0) ||
            (ie1 >=
             m_greta)) {  // its outside the ends so we should not be here
          ATH_MSG_FATAL("  Jet too close to end");
          return StatusCode::FAILURE;
        }
        for (int ip0 = 0; ip0 < m_nphicell2; ++ip0) {
          int ip1 = ip0 - m_nphicell + phihigh;
          // are we using a cone, if so check that its inside
          double rr = (ie1 - etahigh) * (ie1 - etahigh) * m_edeta * m_edeta +
                      (ip1 - phihigh) * (ip1 - phihigh) * m_edphi * m_edphi;
          while (ip1 < 0)
            ip1 += m_grphi;  // fix phi wrapping note that this is done after rr
                             // is calculated
          while (ip1 > m_grphi - 1)
            ip1 -= m_grphi;  // fix phi wrapping note that this is done after rr
                             // is calculated
          if (rr < m_cone * m_cone || !m_type) {  // make sure that its inside
            // check that the cell can be used and add energy to jet and mark
            // the cell as used
            if (!etgridused[ip1][ie1]) {
              etgridused[ip1][ie1] = true;
              jetpx = jetpx + etgrid[ip1][ie1] *
                                  std::cos(-M_PI + (ip1 + 0.5) * m_edphi);
              jetpy = jetpy + etgrid[ip1][ie1] *
                                  std::sin(-M_PI + (ip1 + 0.5) * m_edphi);
              jetpz = jetpz + etgrid[ip1][ie1] *
                                  std::sinh((ie1 + 0.5) * m_edeta - m_emaxeta);
              jete = jete +
                     etgrid[ip1][ie1] * std::cosh((ie1 + 0.5) * m_edeta - m_emaxeta);
            }
          }
        }
      }
      FoundJet.setPx(jetpx);
      FoundJet.setPy(jetpy);
      FoundJet.setPz(jetpz);
      FoundJet.setE(jete);
      if (std::abs(FoundJet.pseudoRapidity()) < m_userEta) {
        m_Jets.push_back(FoundJet);  // OK we found one. add it to the list  if
                                     // its inside the eta region
      }
    }
  }
  sort(m_Jets.begin(), m_Jets.end(), std::greater<McObj>());
  ATH_MSG_DEBUG("  Summary.  "
                << " Number of jets found   = " << m_Jets.size() << " \n ");
  if (m_Jets.size() > 0) {
    ATH_MSG_DEBUG(" Highest pt (in GeV)  "
                  << (m_Jets[0].P().perp() / Gaudi::Units::GeV)
                  << "   Rapidity " << m_Jets[0].P().pseudoRapidity()
                  << "   Phi " << m_Jets[0].P().phi() << "\n ");
    ATH_MSG_DEBUG(" Second Highest pt (in GeV)  "
                  << (m_Jets[1].P().perp() / Gaudi::Units::GeV)
                  << "   Rapidity " << m_Jets[1].P().pseudoRapidity()
                  << "   Phi " << m_Jets[1].P().phi() << "\n ");
    ATH_MSG_DEBUG(" Lowest pt (in GeV)  "
                  << (m_Jets[m_Jets.size() - 1].P().perp() / Gaudi::Units::GeV)
                  << "   Rapidity "
                  << m_Jets[m_Jets.size() - 1].P().pseudoRapidity() << "   Phi "
                  << m_Jets[m_Jets.size() - 1].P().phi() << "\n ");
  }
  // now look at the jets and check the filter
  if (m_Jets.size() >= (unsigned)m_userNumber) {
    if (m_Jets[m_userNumber - 1].P().perp() > m_userThresh) {
      m_Jets.clear();  // clean it out
      return StatusCode::SUCCESS;
    }
  }
  setFilterPassed(false);  // it failed to find any useful jets
  m_Jets.clear();          // clean out the found jets
  return StatusCode::SUCCESS;
}

filterFinalize()

virtual StatusCode GenFilter::filterFinalize ( )

inlinevirtualinherited

Reimplemented in BoostedHadTopAndTopPair, BSignalFilter, ChargedTracksWeightFilter, DecaysFinalStateFilter, DiBjetFilter, DiLeptonMassFilter, FourLeptonInvMassFilter, HeavyFlavorHadronFilter, HTFilter, LeptonFilter, LeptonPairFilter, M4MuIntervalFilter, MuDstarFilter, MultiBjetFilter, MultiCjetFilter, MultiParticleFilter, ParentChildwStatusFilter, ParticleDecayFilter, QCDTruthJetFilter, QCDTruthMultiJetFilter, TauFilter, TrimuMassRangeFilter, TTbarPlusHeavyFlavorFilter, TTbarWithJpsimumuFilter, VBFHbbEtaSortingFilter, xAODBSignalFilter, xAODChargedTracksWeightFilter, xAODDiLeptonMassFilter, xAODHeavyFlavorHadronFilter, xAODHTFilter, xAODMultiBjetFilter, xAODMultiCjetFilter, xAODTauFilter, xAODTTbarWithJpsimumuFilter, xAODXtoVVDecayFilterExtended, and XtoVVDecayFilterExtended.

Definition at line 47 of file GenFilter.h.

{ return StatusCode::SUCCESS; }

filterInitialize()

StatusCode xAODJetFilter::filterInitialize ( )

finaloverridevirtual

Reimplemented from GenFilter.

Definition at line 14 of file xAODJetFilter.cxx.

                                           {
  ATH_CHECK(m_truthPartContKey.initialize());
  m_emaxeta = 6.0;
  m_edphi = 2 * M_PI / m_grphi;         // cell size
  m_edeta = 2. * m_emaxeta / m_greta;  // cell size
  // How many cells in the jet cluster
  if (!m_type) {  // it's the rectangular grid
    m_nphicell = m_gridp / 2;
    m_netacell = m_gride / 2;
    m_nphicell2 = m_gridp;
    m_netacell2 = m_gride;
  } else {
    m_nphicell = static_cast<int>(m_cone / m_edphi);  // number of cells inside cone
    m_netacell = static_cast<int>(m_cone / m_edeta);  // number of cells inside come
    m_nphicell2 =
        2 * m_nphicell +
        1;  // guaranteed to be odd so that the highest cell is in middle
    m_netacell2 = 2 * m_netacell + 1;
  }
  ATH_MSG_INFO("Parameters are \n ");
  if (m_type) {
    ATH_MSG_INFO("  Cone algorithm: "
                 << " Pt cut  = " << m_userThresh
                 << ", Number= " << m_userNumber << ", Cone size=" << m_cone
                 << ", Rapidity range " << m_userEta);
  } else {
    ATH_MSG_INFO("  GridAlgorithm: "
                 << " Pt cut  = " << m_userThresh << ", Number= "
                 << m_userNumber << ", eta size (units of 0.06) =" << m_gride
                 << ", phi size (units of 0.06) =" << m_gridp
                 << ", Rapidity range " << m_userEta);
  }
 
  return StatusCode::SUCCESS;
}

finalize()

StatusCode GenFilter::finalize ( )

inherited

Definition at line 56 of file GenFilter.cxx.

                               {
  ATH_MSG_INFO("Events passed = " << m_nPass << "  Events failed = " << m_nFail);
  CHECK(filterFinalize());
  return StatusCode::SUCCESS;
}

GenFilter()

GenFilter::GenFilter	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 33 of file GenFilter.cxx.

  : GenBase(name, pSvcLocator)
{
  declareProperty("TotalPassed", m_nNeeded=-1);
#ifdef HEPMC3
  declareProperty("KeepAllEvents", m_keepAll=false);
#endif
  m_nPass = 0;
  m_nFail = 0;
}

GeVToMeV()

void GenBase::GeVToMeV ( HepMC::GenEvent * evt )

protectedinherited

Scale event energies/momenta by x 1000.

Todo

Add HepMC units awareness and do it differently when HepMC provides this functionality directly (and reference-based FourVector accessors)

Definition at line 58 of file GenBase.cxx.

                                         {
  for (HepMC::GenEvent::particle_iterator p = evt->particles_begin(); p != evt->particles_end(); ++p) {
    const HepMC::FourVector fv((*p)->momentum().px() * 1000,
                               (*p)->momentum().py() * 1000,
                               (*p)->momentum().pz() * 1000,
                               (*p)->momentum().e()  * 1000);
    (*p)->set_momentum(fv);
    (*p)->set_generated_mass(1000 * (*p)->generated_mass());
  }
}

initialize()

StatusCode GenFilter::initialize ( )

virtualinherited

Reimplemented from GenBase.

Definition at line 20 of file GenFilter.cxx.

                                 {
  CHECK(GenBase::initialize());
  m_nPass = 0;
  m_nFail = 0;
  CHECK(filterInitialize());
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

MeVToGeV()

void GenBase::MeVToGeV ( HepMC::GenEvent * evt )

protectedinherited

Scale event energies/momenta by x 1/1000.

Definition at line 68 of file GenBase.cxx.

                                         {
  for (HepMC::GenEvent::particle_iterator p = evt->particles_begin(); p != evt->particles_end(); ++p) {
    const HepMC::FourVector fv((*p)->momentum().px() / 1000,
                               (*p)->momentum().py() / 1000,
                               (*p)->momentum().pz() / 1000,
                               (*p)->momentum().e()  / 1000);
    (*p)->set_momentum(fv);
    (*p)->set_generated_mass((*p)->generated_mass() / 1000);
  }
}

mmTocm()

void GenBase::mmTocm ( HepMC::GenEvent * evt )

protectedinherited

Scale event lengths by x 1/10.

Definition at line 87 of file GenBase.cxx.

                                       {
  for (HepMC::GenEvent::vertex_iterator vtx = evt->vertices_begin(); vtx != evt->vertices_end(); ++vtx) {
    const HepMC::FourVector fv((*vtx)->position().x() / 10,
                               (*vtx)->position().y() / 10,
                               (*vtx)->position().z() / 10,
                               (*vtx)->position().t() / 10);
    (*vtx)->set_position(fv);
  }
}

msg()

MsgStream & AthCommonMsg< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

nFailed()

int GenFilter::nFailed ( ) const

inlineinherited

Definition at line 53 of file GenFilter.h.

{ return m_nFail; }

nNeeded()

int GenFilter::nNeeded ( ) const

inlineinherited

Definition at line 54 of file GenFilter.h.

{ return m_nNeeded; }

nPassed()

int GenFilter::nPassed ( ) const

inlineinherited

Definition at line 52 of file GenFilter.h.

{ return m_nPass; }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

particleData()

const HepPDT::ParticleData * GenBase::particleData ( int pid ) const

inlineinherited

Access an element in the particle data table.

Definition at line 126 of file GenBase.h.

                                                        {
    return pdt().particle(HepPDT::ParticleID(std::abs(pid)));
  }

particleTable()

const HepPDT::ParticleDataTable & GenBase::particleTable ( ) const

inlineinherited

Get a particle data table.

Definition at line 118 of file GenBase.h.

                                                       {
    return *(m_ppSvc->PDT());
  }

partPropSvc()

const ServiceHandle< IPartPropSvc > GenBase::partPropSvc ( ) const

inlineinherited

Access the particle property service.

Definition at line 113 of file GenBase.h.

                                                        {
    return m_ppSvc;
  }

pdt()

const HepPDT::ParticleDataTable & GenBase::pdt ( ) const

inlineinherited

Shorter alias to get a particle data table.

Definition at line 123 of file GenBase.h.

{ return particleTable(); }

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_cone

Gaudi::Property<double> xAODJetFilter::m_cone {this, "ConeSize", 0.4, " "}

private

Definition at line 58 of file xAODJetFilter.h.

{this, "ConeSize", 0.4, " "};  //cone sixe

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_edeta

double xAODJetFilter::m_edeta {}

private

Definition at line 70 of file xAODJetFilter.h.

{}; // size of eta bins

m_edphi

double xAODJetFilter::m_edphi {}

private

Definition at line 71 of file xAODJetFilter.h.

{}; //size of phi bins

m_emaxeta

double xAODJetFilter::m_emaxeta {}

private

Definition at line 69 of file xAODJetFilter.h.

{}; // largest eta of bins

m_etaRange

double xAODJetFilter::m_etaRange {}

private

Definition at line 68 of file xAODJetFilter.h.

{}; //range over which search runs

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

m_greta

const int xAODJetFilter::m_greta = 200

staticprivate

Definition at line 65 of file xAODJetFilter.h.

m_gride

Gaudi::Property<int> xAODJetFilter::m_gride {this, "GridSizeEta",2, " "}

private

Definition at line 59 of file xAODJetFilter.h.

{this, "GridSizeEta",2, " "}; //how many cells in eta

m_gridp

Gaudi::Property<int> xAODJetFilter::m_gridp {this, "GridSizePhi",2, " "}

private

Definition at line 60 of file xAODJetFilter.h.

{this, "GridSizePhi",2, " "}; //how many cells in phi

m_grphi

const int xAODJetFilter::m_grphi = 105

staticprivate

Definition at line 64 of file xAODJetFilter.h.

m_Jets

std::vector<McObj> xAODJetFilter::m_Jets

private

Definition at line 76 of file xAODJetFilter.h.

m_mcEventKey

std::string GenBase::m_mcEventKey {}

protectedinherited

StoreGate key for the MC event collection (defaults to GEN_EVENT)

Definition at line 137 of file GenBase.h.

{};

m_mcevents_const

SG::ReadHandleKey<McEventCollection> GenBase::m_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }

privateinherited

Const handle to the MC event collection.

Definition at line 163 of file GenBase.h.

{ this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" };

m_mkMcEvent

BooleanProperty GenBase::m_mkMcEvent {this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"}

protectedinherited

Flag to determine if a new MC event collection should be made if it doesn't exist.

Definition at line 139 of file GenBase.h.

{this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"};

m_netacell

int xAODJetFilter::m_netacell {}

private

Definition at line 73 of file xAODJetFilter.h.

{}; // number of eta cells inside half cone

m_netacell2

int xAODJetFilter::m_netacell2 {}

private

Definition at line 75 of file xAODJetFilter.h.

{}; // number of eta cells inside full cone

m_nFail

int GenFilter::m_nFail

protectedinherited

Definition at line 66 of file GenFilter.h.

m_nNeeded

int GenFilter::m_nNeeded

protectedinherited

Definition at line 67 of file GenFilter.h.

m_nPass

int GenFilter::m_nPass

protectedinherited

Definition at line 65 of file GenFilter.h.

m_nphicell

int xAODJetFilter::m_nphicell {}

private

Definition at line 72 of file xAODJetFilter.h.

{}; // number of phi cells inside half cone

m_nphicell2

int xAODJetFilter::m_nphicell2 {}

private

Definition at line 74 of file xAODJetFilter.h.

{}; // number of phi cells inside full cone

m_ppSvc

ServiceHandle<IPartPropSvc> GenBase::m_ppSvc {this, "PartPropSvc", "PartPropSvc"}

privateinherited

Handle on the particle property service.

Definition at line 160 of file GenBase.h.

{this, "PartPropSvc", "PartPropSvc"};

m_stop

Gaudi::Property<double> xAODJetFilter::m_stop {this, "SeedThreshold", 1000., " "}

private

Definition at line 57 of file xAODJetFilter.h.

{this, "SeedThreshold", 1000., " "}; //seed tower threshold

m_truthPartContKey

SG::ReadHandleKey<xAOD::TruthParticleContainer> xAODJetFilter::m_truthPartContKey {this, "TruthParticleContainerKey", "TruthGen"}

private

Definition at line 54 of file xAODJetFilter.h.

{this, "TruthParticleContainerKey", "TruthGen"};

m_type

Gaudi::Property<bool> xAODJetFilter::m_type {this, "JetType",true, " "}

private

Definition at line 62 of file xAODJetFilter.h.

{this, "JetType",true, " "}; // cone or grid to define jet

m_userEta

Gaudi::Property<double> xAODJetFilter::m_userEta {this, "EtaRange", 2.7, " "}

private

Definition at line 55 of file xAODJetFilter.h.

{this, "EtaRange", 2.7, " "}; //range over which triggers are searched for

m_userNumber

Gaudi::Property<int> xAODJetFilter::m_userNumber {this, "JetNumber",1, " "}

private

Definition at line 61 of file xAODJetFilter.h.

{this, "JetNumber",1, " "}; //how many are we looking for

m_userThresh

Gaudi::Property<double> xAODJetFilter::m_userThresh {this, "JetThreshold", 17000., " "}

private

Definition at line 56 of file xAODJetFilter.h.

{this, "JetThreshold", 17000., " "}; // lowest et jet

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• xAODJetFilter.h
• xAODJetFilter.cxx