TTbarMassFilter Class Reference

Require the invariant mass of a top + anti-top pair to be within a certain range. More...

#include <TTbarMassFilter.h>

Inheritance diagram for TTbarMassFilter:

Collaboration diagram for TTbarMassFilter:

Public Member Functions
	TTbarMassFilter (const std::string &name, ISvcLocator *pSvcLocator)
virtual StatusCode	filterEvent ()
virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
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. More...

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> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
double	m_massRangeLowThr
double	m_massRangeHighThr
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

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

Detailed Description

Require the invariant mass of a top + anti-top pair to be within a certain range.

Events that do not contain top AND anti-top 1 or 2 pairs are rejected.

Author

Gia Khoriauli, October 2010

Definition at line 14 of file TTbarMassFilter.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

TTbarMassFilter()

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

Definition at line 10 of file TTbarMassFilter.cxx.

  : GenFilter(name, pSvcLocator)
{
  declareProperty("TopPairMassLowThreshold",  m_massRangeLowThr  = 300000.);
  declareProperty("TopPairMassHighThreshold", m_massRangeHighThr = 500000.);
}

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() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

declareGaudiProperty() [2/4]

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());
 
  }

declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

declareGaudiProperty() [4/4]

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

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

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() [1/2]

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; }

evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 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 TTbarMassFilter::filterEvent ( )

virtual

Todo:

How generator-portable is this status code assumption?

Implements GenFilter.

Definition at line 18 of file TTbarMassFilter.cxx.

                                        {
  int  top      = 0;
  int  topbar       = 0;
  bool isLastTop    = false;
  bool isFirstTop = false;
  double topPairInvariantMass = 0.;
  std::vector<HepMC::ConstGenParticlePtr> tops;
  std::vector<HepMC::ConstGenVertexPtr>   top_vtxs;
 
  for (McEventCollection::const_iterator itr = events()->begin(); itr!=events()->end(); ++itr) {
    const HepMC::GenEvent* genEvt = (*itr);
#ifdef HEPMC3
    for (const auto& mcpart: *genEvt) {
      // Reset the flag. it become true if the top with a final ('last') status is found
      isLastTop = false;
      // Reset the flag. becomes true if the top with the initial ('first') status is found
      isFirstTop = false;
 
      // Work only with tops
      if (std::abs(mcpart->pdg_id()) == 6) {
        // Assume that this is the 'last' top
        isLastTop=true;
        auto decayVtx = mcpart->end_vertex();
        // Unusual case...
        if (!decayVtx) {
          ATH_MSG_WARNING("top particle" << mcpart << " has no valid decay vertex. ");
          ATH_MSG_WARNING("It looks like a Pythia history particle. Skip this particle ");
          continue;
        }
 
        // Find out whether this is the top particle with final statuscode, so, just before its decay.
        for (const auto& child_mcpart: decayVtx->particles_out() ) {
          if (std::abs(child_mcpart->pdg_id()) == 6) {
            // This is not a 'last' top: break the loop over the children, and do nothing with this top particle
            isLastTop = false;
            break;
          }
        }
 
        // Store the 'last' top
        if (isLastTop) {
          ATH_MSG_DEBUG("Top particle " << mcpart << " is found and stored");
          tops.push_back(mcpart);
        }
 
        // Find and store production vertices for the 'last' tops. This will help to easily couple top and anti-top
        // pairs later if there are 2 pairs of them. It's a very rare case but needs to be properly handled.
        if (isLastTop) {
          // Investigate whether this top particle is the 'first' one.
          isFirstTop = false;
          // Retrieve the production vertex of the current 'last' top particle
          auto prodVtx = mcpart->production_vertex();
          if (!prodVtx) {
            ATH_MSG_WARNING("Top particle " << mcpart << " has no valid production vertex");
            //save null pointer for consistency
            top_vtxs.emplace_back(nullptr);
          } else {
            // Loop until the 'first' top particle  production vertex is not reached
            while (!isFirstTop && prodVtx) {
              // Loop over the top mother particles
              for (const auto&  mother_mcpart: prodVtx->particles_in()) {
                // One of the mother particles is still top quark. needed to go up in the hierarchy
                if (mother_mcpart->pdg_id() == 6) {
                  isFirstTop = false;
                  prodVtx = mother_mcpart->production_vertex();
                  if (!prodVtx) {
                    ATH_MSG_WARNING("mother particle is still a top " << mcpart << ", but has no valid production vertex");
                    top_vtxs.emplace_back(nullptr);
                  }
                  break;
                } else {
                  // The current (in loop over the mother particles) mother particle is not a top.
                  // maybe the found top particle is the initial one? set the flag true. it will be
                  // set false if one of the other mother particles is top quark.
                  isFirstTop = true;
                }
              }
            }
 
            //Store the production vertex for the given top particle. it's a production vertex
            //  of the initial ('first') top particle for the current final ('last') top.
            if (isFirstTop) {
              top_vtxs.push_back(std::move(prodVtx));
            }
          }
        }
 
        // Investigate how many top and anti-tops are found and make a decision
        // to continue or stop looping over GenParticles in the event
        if (isLastTop) {
          // One more 'last' top particle was stored into the vector --> increment the number of top or anti-top particles.
          if (tops[tops.size()-1]->pdg_id() == 6) top++; else topbar++;
 
          // One top and one ati-top 'last' particles are found.  Stop looping
          // over the particles
          if (top==1 && topbar==1) break;
 
          // This should not happen. But depends on a style how a given
          // generator records the particles.  In very rare cases there are more
          // than 1 top-pairs created. If occasionally the same signed tops from
          // the different couples are ordered first in the generator record,
          // then the situation below is possible
          if (top > 1 || topbar > 1) ATH_MSG_INFO("More than one top-pair exist in the event.");
 
          // Both top-pairs are found. don't expect more than that.  So, it's
          // time to break the loop over particles.  this fairly assumes that
          // there are no more top-pairs
          if (top==2 && topbar==2) break;
        }
      }
    }
#else
    HepMC::GenEvent::particle_const_iterator pitr = genEvt->particles_begin();
    for (; pitr!=genEvt->particles_end(); ++pitr) {
      // Reset the flag. it become true if the top with a final ('last') status is found
      isLastTop = false;
      // Reset the flag. becomes true if the top with the initial ('first') status is found
      isFirstTop = false;
      HepMC::GenParticle* mcpart = (*pitr);
 
      // Work only with tops
      if (std::abs(mcpart->pdg_id()) == 6) {
        // Assume that this is the 'last' top
        isLastTop=true;
        HepMC::GenVertex* decayVtx = mcpart->end_vertex();
        // Unusual case...
        if (!decayVtx) {
          ATH_MSG_WARNING("top particle " << mcpart << " has no valid decay vertex. ");
          ATH_MSG_WARNING("It looks like a Pythia history particle. Skip this particle ");
          continue;
        }
 
        // Find out whether this is the top particle with final statuscode, so, just before its decay.
 
        HepMC::GenVertex::particles_out_const_iterator child_mcpartItr  = decayVtx->particles_out_const_begin();
        HepMC::GenVertex::particles_out_const_iterator child_mcpartItrE = decayVtx->particles_out_const_end();
        for (; child_mcpartItr!=child_mcpartItrE; ++child_mcpartItr) {
          HepMC::GenParticle* child_mcpart = (*child_mcpartItr);
          if (std::abs(child_mcpart->pdg_id()) == 6) {
            // This is not a 'last' top: break the loop over the children, and do nothing with this top particle
            isLastTop = false;
            break;
          }
        }
 
        // Store the 'last' top
        if (isLastTop) {
          ATH_MSG_DEBUG("Top particle " << mcpart << " is found and stored");
          tops.push_back(mcpart);
        }
 
        // Find and store production vertices for the 'last' tops. This will help to easily couple top and anti-top
        // pairs later if there are 2 pairs of them. It's a very rare case but needs to be properly handled.
        if (isLastTop) {
          // Investigate whether this top particle is the 'first' one.
          isFirstTop = false;
          // Retrieve the production vertex of the current 'last' top particle
          HepMC::GenVertex* prodVtx = mcpart->production_vertex();
          if (!prodVtx) {
            ATH_MSG_WARNING("Top particle " << mcpart << " has no valid production vertex");
            //save null pointer for consistency
            top_vtxs.push_back(NULL);
          } else {
            // Loop until the 'first' top particle  production vertex is not reached
            while (!isFirstTop && prodVtx) {
              // Loop over the top mother particles
              HepMC::GenVertex::particles_in_const_iterator mother_mcpartItr  = prodVtx->particles_in_const_begin();
              HepMC::GenVertex::particles_in_const_iterator mother_mcpartItrE = prodVtx->particles_in_const_end();
              for (; mother_mcpartItr != mother_mcpartItrE; ++mother_mcpartItr) {
                HepMC::GenParticle* mother_mcpart = (*mother_mcpartItr);
                // One of the mother particles is still top quark. needed to go up in the hierarchy
                if (mother_mcpart->pdg_id() == 6) {
                  isFirstTop = false;
                  prodVtx = mother_mcpart->production_vertex();
                  if (!prodVtx) {
                    ATH_MSG_WARNING("mother particle is still a top " << mcpart << ", but has no valid production vertex");
                    top_vtxs.push_back(NULL);
                  }
                  break;
                } else {
                  // The current (in loop over the mother particles) mother particle is not a top.
                  // maybe the found top particle is the initial one? set the flag true. it will be
                  // set false if one of the other mother particles is top quark.
                  isFirstTop = true;
                }
              }
            }
 
            //Store the production vertex for the given top particle. it's a production vertex
            //  of the initial ('first') top particle for the current final ('last') top.
            if (isFirstTop) {
              top_vtxs.push_back(prodVtx);
            }
          }
        }
 
        // Investigate how many top and anti-tops are found and make a decision
        // to continue or stop looping over GenParticles in the event
        if (isLastTop) {
          // One more 'last' top particle was stored into the vector --> increment the number of top or anti-top particles.
          if (tops[tops.size()-1]->pdg_id() == 6) top++; else topbar++;
 
          // One top and one ati-top 'last' particles are found.  Stop looping
          // over the particles
          if (top==1 && topbar==1) break;
 
          // This should not happen. But depends on a style how a given
          // generator records the particles.  In very rare cases there are more
          // than 1 top-pairs created. If occasionally the same signed tops from
          // the different couples are ordered first in the generator record,
          // then the situation below is possible
          if (top > 1 || topbar > 1) ATH_MSG_INFO("More than one top-pair exist in the event.");
 
          // Both top-pairs are found. don't expect more than that.  So, it's
          // time to break the loop over particles.  this fairly assumes that
          // there are no more top-pairs
          if (top==2 && topbar==2) break;
        }
 
      }
    }
#endif
  }
 
  // Main case: there is one top-pair in the event
  if (tops.size()==2) {
    HepMC::FourVector topSumMomentum(0.,0.,0.,0.);
    topSumMomentum.set(tops[0]->momentum().px()+tops[1]->momentum().px(),
                       tops[0]->momentum().py()+tops[1]->momentum().py(),
                       tops[0]->momentum().pz()+tops[1]->momentum().pz(),
                       tops[0]->momentum().e() +tops[1]->momentum().e());
    topPairInvariantMass = topSumMomentum.m();
  }
 
  // Very rare case: there are 2 top-pairs found in the event.
  // One pair comes from the hard scattering and another from additional gluon
  // splitting. Using particle production vertices one needs to correctly couple
  // the tops to anti-tops
  else if (tops.size() == 4 && top_vtxs.size() == 4) {
    HepMC::FourVector topSumMomentum_1(0.,0.,0.,0.);
    HepMC::FourVector topSumMomentum_2(0.,0.,0.,0.);
    double topPairInvMass_1=0.;
    double topPairInvMass_2=0.;
 
    // There must be only two different vertecies out of the four
    auto prodVtx = top_vtxs[0];
    int top_11 = 0;
    int top_12 = -1;
    int top_21 = -1;
    int top_22 = -1;
    for (size_t i = 1; i < top_vtxs.size(); ++i) {
      if (top_vtxs[i] == prodVtx) top_12=i;
      else {
        if (top_21 < 0) top_21 = i;
        else top_22 = i;
      }
    }
 
    // Check that the first top particle shares a production vertex with another top
    if (top_12 < 0) {
      ATH_MSG_ERROR("First top particle doesn't share the production vertex to any other top particles. Event failed the filter");
      setFilterPassed(false);
      return StatusCode::SUCCESS;
    }
    if ((top_21 < 0) or (top_22 < 0)) {
      ATH_MSG_ERROR("Indexing error. Event failed the filter");
      setFilterPassed(false);
      return StatusCode::SUCCESS;
    }
 
    // Check that the second top-pair really has the same production vertex
    if (top_vtxs[top_21] != top_vtxs[top_22]) {
      ATH_MSG_ERROR("Production vertex for the second top-pair particles is not the same. Event failed the filter");
      setFilterPassed(false);
      return StatusCode::SUCCESS;
    }
 
    // First couple. check the coupled top quark's signs. They must be opposite.
    if (tops[top_11]->pdg_id() == tops[top_12]->pdg_id()) ATH_MSG_ERROR("first top-pair particles have the same charge");
    else {
      // The right coupling seems to be achieved. Calculate the invariant mass of the couple
      topSumMomentum_1.set(tops[top_11]->momentum().px()+tops[top_12]->momentum().px(),
                           tops[top_11]->momentum().py()+tops[top_12]->momentum().py(),
                           tops[top_11]->momentum().pz()+tops[top_12]->momentum().pz(),
                           tops[top_11]->momentum().e() +tops[top_12]->momentum().e());
      topPairInvMass_1 = topSumMomentum_1.m();
    }
 
    // Second couple. check the coupled top quark's signs. They must be opposite.
    if (tops[top_21]->pdg_id() == tops[top_21]->pdg_id()) ATH_MSG_ERROR("second top-pair particles have the same charge");
    else {
      // The right coupling seems to be achieved. Calculate the invariant mass of the couple
      topSumMomentum_2.set(tops[top_21]->momentum().px()+tops[top_22]->momentum().px(),
                           tops[top_21]->momentum().py()+tops[top_22]->momentum().py(),
                           tops[top_21]->momentum().pz()+tops[top_22]->momentum().pz(),
                           tops[top_21]->momentum().e() +tops[top_22]->momentum().e());
      topPairInvMass_2 = topSumMomentum_2.m();
    }
 
    // Choose the top-pair with the largest invariant mass
    topPairInvariantMass = std::max(topPairInvMass_1, topPairInvMass_2);
  }
 
  // Something wrong with the number of tops in the event or with the stored vertices....
  else ATH_MSG_ERROR("Size of the collected final top particles vector " << tops.size() <<
                     " doesn't match to the size of there production vertices vector size " << top_vtxs.size() <<
                     ". Event fails the filter");
 
  // Filter is expected to run on the ttbar sample. This means there should be 1
  // or very rarely 2 top-pairs in the truth.  If this is not the case then
  // something wrong must have a place in this event or in the filter and has to
  // be investigated.
  if (tops.size() != 2 && tops.size() != 4) {
    ATH_MSG_WARNING("1 or 2 top-pairs are expected in the event. But there are " << tops.size() << " final-status top particles.");
  }
 
  // Proper top-pair invariant mass is calculated. Check if it is in the range of the interest and accept the event if so.
  setFilterPassed(topPairInvariantMass > m_massRangeLowThr && topPairInvariantMass <= m_massRangeHighThr);
  ATH_MSG_DEBUG("The top-pair invariant mass is " << topPairInvariantMass << " CLHEP::MeV");
  return StatusCode::SUCCESS;
}

filterFinalize()

virtual StatusCode GenFilter::filterFinalize ( )

inlinevirtualinherited

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

Definition at line 47 of file GenFilter.h.

{ return StatusCode::SUCCESS; }

filterInitialize()

virtual StatusCode GenFilter::filterInitialize ( )

inlinevirtualinherited

Reimplemented in xAODBSignalFilter, xAODM4MuIntervalFilter, xAODDecaysFinalStateFilter, xAODLeptonPairFilter, xAODDecayTimeFilter, xAODHeavyFlavorHadronFilter, xAODLeptonFilter, xAODElectronFilter, xAODHTFilter, xAODParticleDecayFilter, xAODTauFilter, xAODChargedTracksWeightFilter, xAODVBFMjjIntervalFilter, xAODXtoVVDecayFilterExtended, xAODTTbarWithJpsimumuFilter, xAODChargedTracksFilter, xAODMultiElecMuTauFilter, xAODTTbarWToLeptonFilter, xAODVBFForwardJetsFilter, xAODJetFilter, xAODMultiBjetFilter, xAODMultiCjetFilter, xAODParticleFilter, xAODMultiMuonFilter, xAODMuonFilter, xAODPhotonFilter, xAODDirectPhotonFilter, xAODForwardProtonFilter, xAODMETFilter, xAODParentTwoChildrenFilter, xAODSameParticleHardScatteringFilter, xAODParentChildFilter, xAODMultiElectronFilter, xAODMultiLeptonFilter, xAODSplitPhotonFilter, xAODFourLeptonMassFilter, xAODMuDstarFilter, MuDstarFilter, TrimuMassRangeFilter, BoostedHadTopAndTopPair, LeptonFilter, LeptonPairFilter, DecaysFinalStateFilter, MultiParticleFilter, DiBjetFilter, FourLeptonInvMassFilter, MassRangeFilter, ParentChildwStatusFilter, VBFHbbEtaSortingFilter, ParticleDecayFilter, HeavyFlavorHadronFilter, TauFilter, TTbarPlusHeavyFlavorFilter, MultiBjetFilter, QCDTruthJetFilter, VBFMjjIntervalFilter, XtoVVDecayFilterExtended, FourLeptonMassFilter, HTFilter, TTbarWithJpsimumuFilter, xAODDiLeptonMassFilter, ChargedTracksWeightFilter, DiLeptonMassFilter, QCDTruthMultiJetFilter, M4MuIntervalFilter, MultiCjetFilter, VBFForwardJetsFilter, JetFilter, ParticleFilter, TruthJetFilter, DiPhotonFilter, ParentTwoChildrenFilter, SameParticleHardScatteringFilter, DecayTimeFilter, DirectPhotonFilter, and ParentChildFilter.

Definition at line 45 of file GenFilter.h.

{ 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;
}

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() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< Algorithm >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

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, PyAthena::Alg, and AthHistogramAlgorithm.

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_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_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_massRangeHighThr

double TTbarMassFilter::m_massRangeHighThr

private

Definition at line 23 of file TTbarMassFilter.h.

m_massRangeLowThr

double TTbarMassFilter::m_massRangeLowThr

private

Definition at line 22 of file TTbarMassFilter.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.

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.

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_ppSvc

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

privateinherited

Handle on the particle property service.

Definition at line 160 of file GenBase.h.

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:

• TTbarMassFilter.h
• TTbarMassFilter.cxx