columnar::MetAssociationHelper< CM > Class Template Reference

a columnar version of xAOD::MissingETAssociationHelper More...

#include <MetAssociation.h>

Collaboration diagram for columnar::MetAssociationHelper< CM >:

Public Types
using	PartId = ObjectId<ContainerId::particle,CM>
using	JetId = ObjectId<ContainerId::jet,CM>
using	AssocId = ObjectId<ContainerId::metAssociation,CM>
using	OptAssocId = OptObjectId<ContainerId::metAssociation,CM>
using	ObjectLinkType = MetAssocationAccessors<CM>::ObjectLinkType
using	constvec_t = MissingETBase::Types::constvec_t
using	ConstVec = xAOD::MissingETAssociation::ConstVec
using	bitmask_t = MissingETBase::Types::bitmask_t

Public Member Functions
	MetAssociationHelper (xAOD::MissingETAssociationHelper &val_helper, const columnar::MetAssocationAccessors< CM > &val_accessors)
	MetAssociationHelper (ObjectRange< ContainerId::metAssociation, CM > map, const columnar::MetAssocationAccessors< CM > &val_accessors)
xAOD::MissingETAssociationHelper &	getXAODObject () const
ObjectRange< ContainerId::metAssociation, CM >	map () const noexcept
	the underlying association map
bool	objSelected (const xAOD::IParticle *obj) const
template<ContainerIdConcept CI>
bool	objSelected (ObjectId< CI, CM > obj) const
bool	objSelected (ObjectLinkType obj) const
bool	objSelected (AssocId assocId, std::size_t objIdx) const
bool	objSelected (AssocId assocId, const xAOD::IParticle *pPart) const
template<ContainerIdConcept CI>
bool	objSelected (AssocId assocId, ObjectId< CI, CM > pPart) const
bool	objSelected (AssocId assocId, ObjectLinkType pPart) const
bitmask_t	getObjSelectionFlags (AssocId assocId) const
void	setObjSelectionFlag (AssocId assocId, size_t objIdx, bool status)
void	setObjSelectionFlag (AssocId assocId, const xAOD::IParticle *pPart, bool status)
template<ContainerIdConcept CI>
void	setObjSelectionFlag (AssocId assocId, ObjectId< CI, CM > pPart, bool status)
void	setObjSelectionFlag (AssocId assocId, const ObjectLinkType &pPart, bool status)
bool	hasOverlaps (AssocId assocId, size_t objIdx, MissingETBase::UsageHandler::Policy p) const
bool	selectIfNoOverlaps (const xAOD::IParticle *obj, MissingETBase::UsageHandler::Policy p)
bool	selectIfNoOverlaps (PartId obj, MissingETBase::UsageHandler::Policy p)
OptAssocId	getJetAssociation (const xAOD::Jet *pJet) const
OptAssocId	getJetAssociation (JetId pJet) const
auto	getAssociations (const xAOD::IParticle *pPart) const
template<ContainerIdConcept CI>
auto	getAssociations (ObjectId< CI, CM > pPart) const
auto	getMiscAssociation () const
constvec_t	getConstVec (const xAOD::IParticle *pPart, MissingETBase::UsageHandler::Policy p) const
constvec_t	getConstVec (PartId pPart, MissingETBase::UsageHandler::Policy p) const
ConstVec	overlapCalVec (AssocId assoc) const
ConstVec	overlapTrkVec (AssocId assoc) const

Static Public Attributes
static constexpr bool	useMissingETAssociationHelper = std::is_same_v<CM,ColumnarModeXAOD>
static constexpr std::size_t	invalidIndex = MissingETBase::Constants::invalidIndex

Private Attributes
xAOD::MissingETAssociationHelper *	m_xaodHelper = nullptr
	the xAOD helper object, only used in xAOD mode, but its easier to define it in both modes regardless
ObjectRange< ContainerId::metAssociation, CM >	m_map
	the underlying MET association map
const MetAssocationAccessors< CM > *	m_accessors = nullptr
	the accessors for the members of the MET association map

Detailed Description

template<typename CM>
class columnar::MetAssociationHelper< CM >

a columnar version of xAOD::MissingETAssociationHelper

Definition at line 340 of file MetAssociation.h.

Member Typedef Documentation

AssocId

template<typename CM>

using columnar::MetAssociationHelper< CM >::AssocId = ObjectId<ContainerId::metAssociation,CM>

Definition at line 348 of file MetAssociation.h.

bitmask_t

template<typename CM>

using columnar::MetAssociationHelper< CM >::bitmask_t = MissingETBase::Types::bitmask_t

Definition at line 354 of file MetAssociation.h.

ConstVec

template<typename CM>

using columnar::MetAssociationHelper< CM >::ConstVec = xAOD::MissingETAssociation::ConstVec

Definition at line 353 of file MetAssociation.h.

constvec_t

template<typename CM>

using columnar::MetAssociationHelper< CM >::constvec_t = MissingETBase::Types::constvec_t

Definition at line 352 of file MetAssociation.h.

JetId

template<typename CM>

using columnar::MetAssociationHelper< CM >::JetId = ObjectId<ContainerId::jet,CM>

Definition at line 347 of file MetAssociation.h.

ObjectLinkType

template<typename CM>

using columnar::MetAssociationHelper< CM >::ObjectLinkType = MetAssocationAccessors<CM>::ObjectLinkType

Definition at line 350 of file MetAssociation.h.

OptAssocId

template<typename CM>

using columnar::MetAssociationHelper< CM >::OptAssocId = OptObjectId<ContainerId::metAssociation,CM>

Definition at line 349 of file MetAssociation.h.

PartId

template<typename CM>

using columnar::MetAssociationHelper< CM >::PartId = ObjectId<ContainerId::particle,CM>

Public Members

Definition at line 346 of file MetAssociation.h.

Constructor & Destructor Documentation

MetAssociationHelper() [1/2]

template<typename CM>

columnar::MetAssociationHelper< CM >::MetAssociationHelper ( xAOD::MissingETAssociationHelper & val_helper, const columnar::MetAssocationAccessors< CM > & val_accessors )

inline

Definition at line 360 of file MetAssociation.h.

      : m_xaodHelper (&val_helper), m_map (*val_helper.map()), m_accessors (&val_accessors)
    {}

MetAssociationHelper() [2/2]

template<typename CM>

columnar::MetAssociationHelper< CM >::MetAssociationHelper ( ObjectRange< ContainerId::metAssociation, CM > map, const columnar::MetAssocationAccessors< CM > & val_accessors )

inline

Definition at line 364 of file MetAssociation.h.

      : m_map (map), m_accessors (&val_accessors)
    {}

Member Function Documentation

getAssociations() [1/2]

template<typename CM>

auto columnar::MetAssociationHelper< CM >::getAssociations ( const xAOD::IParticle * pPart ) const

inlinenodiscard

Definition at line 503 of file MetAssociation.h.

                                                                         {
      return getAssociations(PartId(*pPart));}

getAssociations() [2/2]

template<typename CM>

template<ContainerIdConcept CI>

auto columnar::MetAssociationHelper< CM >::getAssociations ( ObjectId< CI, CM > pPart ) const

inlinenodiscard

Definition at line 506 of file MetAssociation.h.

                                                                    {
      // In the original xAOD code, this returned a `std::vector` by
      // value.  In columnar code we prefer not to pass vectors by
      // value, so we return a filtered range instead.
      return FilterRange (m_map.begin(), m_map.end(),
        [accessors = m_accessors, pPart] (AssocId assoc) {
          return (accessors->findIndex(assoc,pPart) != invalidIndex);});}

getConstVec() [1/2]

template<typename CM>

constvec_t columnar::MetAssociationHelper< CM >::getConstVec ( const xAOD::IParticle * pPart, MissingETBase::UsageHandler::Policy p ) const

inlinenodiscard

Other Members

Definition at line 521 of file MetAssociation.h.

                                                                                                             {
      return getConstVec(PartId(*pPart), p);}

getConstVec() [2/2]

template<typename CM>

constvec_t columnar::MetAssociationHelper< CM >::getConstVec ( PartId pPart, MissingETBase::UsageHandler::Policy p ) const

inlinenodiscard

Definition at line 523 of file MetAssociation.h.

                                                                                               {
      constvec_t totalvec;
      for (decltype(auto) assoc : getAssociations(pPart)) {
        if (p==MissingETBase::UsageHandler::OnlyTrack) {
          totalvec += m_accessors->trkVec(assoc, pPart);
        } else {
          totalvec += m_accessors->calVec(assoc, pPart);
        }
      }
      return totalvec;}

getJetAssociation() [1/2]

template<typename CM>

OptAssocId columnar::MetAssociationHelper< CM >::getJetAssociation ( const xAOD::Jet * pJet ) const

inlinenodiscard

Object Association Members

Definition at line 491 of file MetAssociation.h.

                                                                          {
      return getJetAssociation(JetId(*pJet));}

getJetAssociation() [2/2]

template<typename CM>

OptAssocId columnar::MetAssociationHelper< CM >::getJetAssociation ( JetId pJet ) const

inlinenodiscard

Definition at line 493 of file MetAssociation.h.

                                                                 {
      // this uses a linear search, which is the same as the original
      // xAOD code, but was flagged there as potentially inefficient
      for (auto assoc : m_map) {
        if (m_accessors->jetLink(assoc) == pJet) {
          return assoc;
        }
      }
      return std::nullopt;}

getMiscAssociation()

template<typename CM>

auto columnar::MetAssociationHelper< CM >::getMiscAssociation ( ) const

inlinenodiscard

Definition at line 514 of file MetAssociation.h.

                                                  {
      return m_accessors->getMiscAssociation(m_map);}

getObjSelectionFlags()

template<typename CM>

bitmask_t columnar::MetAssociationHelper< CM >::getObjSelectionFlags ( AssocId assocId ) const

inlinenodiscard

Definition at line 410 of file MetAssociation.h.

                                                                        {
      if constexpr (useMissingETAssociationHelper)
        return m_xaodHelper->getObjSelectionFlags(&assocId.getXAODObject());
      else
        return m_accessors->useObjectFlagsAcc(assocId);
    }

getXAODObject()

template<typename CM>

xAOD::MissingETAssociationHelper & columnar::MetAssociationHelper< CM >::getXAODObject ( ) const

inlinenodiscard

Definition at line 369 of file MetAssociation.h.

                                                                         {
      if constexpr (useMissingETAssociationHelper)
        return *m_xaodHelper;
      else
        throw std::logic_error ("can't call xAOD function in columnar mode");}

hasOverlaps()

template<typename CM>

bool columnar::MetAssociationHelper< CM >::hasOverlaps ( AssocId assocId, size_t objIdx, MissingETBase::UsageHandler::Policy p ) const

inlinenodiscard

Object Overlap Members

Definition at line 442 of file MetAssociation.h.

                                                                                                           {
      if ( objIdx == invalidIndex ) return false;
      auto indices = m_accessors->overlapIndices(assocId, objIdx);
      auto types = m_accessors->overlapTypes(assocId, objIdx);
      for(size_t iOL=0; iOL<indices.size(); ++iOL) {
        if(objSelected(assocId, indices[iOL])) {
          // printf("Test object %lu for overlaps: OL type %i\n",indices[iOL],(int)types[iOL]);
          switch(p) {
          case MissingETBase::UsageHandler::TrackCluster:      
            if((types[iOL] & 1<<xAOD::Type::CaloCluster) || (types[iOL] & 1<<xAOD::Type::TrackParticle)) {break;}
            else {continue;}
          case MissingETBase::UsageHandler::OnlyCluster:
            if(types[iOL] & 1<<xAOD::Type::CaloCluster) {break;}
            else {continue;}
          case MissingETBase::UsageHandler::OnlyTrack:
            if(types[iOL] & 1<<xAOD::Type::TrackParticle) {break;}
            else {continue;}
          case MissingETBase::UsageHandler::ParticleFlow:
            if(types[iOL] & 1<<xAOD::Type::ParticleFlow) {break;}
            else {continue;}
          case MissingETBase::UsageHandler::TruthParticle:
            if(types[iOL] & 1) {break;}
            else {continue;}
          case MissingETBase::UsageHandler::AllCalo:
            if(types[iOL] & ~(1<<xAOD::Type::TrackParticle)) {break;}
            else {continue;}
          default: continue;
          }
          return true;
        }
      }
      return false;
    }

map()

template<typename CM>

ObjectRange< ContainerId::metAssociation, CM > columnar::MetAssociationHelper< CM >::map ( ) const

inlinenodiscardnoexcept

the underlying association map

Definition at line 377 of file MetAssociation.h.

                                                                                  {
      return m_map;}

objSelected() [1/7]

template<typename CM>

bool columnar::MetAssociationHelper< CM >::objSelected ( AssocId assocId, const xAOD::IParticle * pPart ) const

inlinenodiscard

Definition at line 401 of file MetAssociation.h.

                                                                                      {
      return objSelected(assocId, PartId(*pPart));}

objSelected() [2/7]

template<typename CM>

template<ContainerIdConcept CI>

bool columnar::MetAssociationHelper< CM >::objSelected ( AssocId assocId, ObjectId< CI, CM > pPart ) const

inlinenodiscard

Definition at line 404 of file MetAssociation.h.

                                                                                 {
      return objSelected(assocId, m_accessors->findIndex(assocId,pPart));}

objSelected() [3/7]

template<typename CM>

bool columnar::MetAssociationHelper< CM >::objSelected ( AssocId assocId, ObjectLinkType pPart ) const

inlinenodiscard

Definition at line 406 of file MetAssociation.h.

                                                                                {
      return objSelected(assocId, m_accessors->findIndex(assocId,pPart));}

objSelected() [4/7]

template<typename CM>

bool columnar::MetAssociationHelper< CM >::objSelected ( AssocId assocId, std::size_t objIdx ) const

inlinenodiscard

Definition at line 393 of file MetAssociation.h.

                                                                            {
      if constexpr (useMissingETAssociationHelper)
        return m_xaodHelper->objSelected(&assocId.getXAODObject(), objIdx);
      else {
        if (objIdx >= sizeof(bitmask_t)*8) return false;
        return bool(m_accessors->useObjectFlagsAcc(assocId) & (static_cast<MissingETBase::Types::bitmask_t>(1)<<objIdx));
      }
    }

objSelected() [5/7]

template<typename CM>

bool columnar::MetAssociationHelper< CM >::objSelected ( const xAOD::IParticle * obj ) const

inlinenodiscard

Object Selection Flag Members

Definition at line 384 of file MetAssociation.h.

                                                                    {
      return objSelected(PartId(*obj));}

objSelected() [6/7]

template<typename CM>

template<ContainerIdConcept CI>

bool columnar::MetAssociationHelper< CM >::objSelected ( ObjectId< CI, CM > obj ) const

inlinenodiscard

Definition at line 387 of file MetAssociation.h.

                                                               {
      for (decltype(auto) assoc : getAssociations(obj)) if(objSelected(assoc,obj)) return true;
      return false;}

objSelected() [7/7]

template<typename CM>

bool columnar::MetAssociationHelper< CM >::objSelected ( ObjectLinkType obj ) const

inlinenodiscard

Definition at line 390 of file MetAssociation.h.

                                                              {
      for (decltype(auto) assoc : getAssociations(obj)) if(objSelected(assoc,obj)) return true;
      return false;}

overlapCalVec()

template<typename CM>

ConstVec columnar::MetAssociationHelper< CM >::overlapCalVec ( AssocId assoc ) const

inlinenodiscard

Definition at line 534 of file MetAssociation.h.

                                                              {
      constvec_t calvec;
      for (size_t iKey = 0; iKey < m_accessors->sizeCal(assoc); iKey++) {
        bool selector = (getObjSelectionFlags(assoc) & m_accessors->calkey(assoc)[iKey]) ? !m_accessors->isMisc(assoc) : m_accessors->isMisc(assoc);
        if (selector) calvec+=m_accessors->calVec(assoc,iKey);
      }
      return calvec;}

overlapTrkVec()

template<typename CM>

ConstVec columnar::MetAssociationHelper< CM >::overlapTrkVec ( AssocId assoc ) const

inlinenodiscard

Definition at line 542 of file MetAssociation.h.

                                                              {
        constvec_t trkvec;
        for (size_t iKey = 0; iKey < m_accessors->sizeTrk(assoc); iKey++) {
          bool selector = (getObjSelectionFlags(assoc) & m_accessors->trkkey(assoc)[iKey]) ? !m_accessors->isMisc(assoc) : m_accessors->isMisc(assoc);
          if (selector) trkvec+=ConstVec(m_accessors->trkpx(assoc)[iKey],m_accessors->trkpy(assoc)[iKey],m_accessors->trkpz(assoc)[iKey],m_accessors->trke(assoc)[iKey],m_accessors->trksumpt(assoc)[iKey]);
        }
        return trkvec;
      }

selectIfNoOverlaps() [1/2]

template<typename CM>

bool columnar::MetAssociationHelper< CM >::selectIfNoOverlaps ( const xAOD::IParticle * obj, MissingETBase::UsageHandler::Policy p )

inlinenodiscard

Definition at line 476 of file MetAssociation.h.

                                                                                                      {
      return selectIfNoOverlaps(PartId(*obj), p);}

selectIfNoOverlaps() [2/2]

template<typename CM>

bool columnar::MetAssociationHelper< CM >::selectIfNoOverlaps ( PartId obj, MissingETBase::UsageHandler::Policy p )

inlinenodiscard

Definition at line 478 of file MetAssociation.h.

                                                                                        {
      auto assocs = getAssociations(obj);
      bool overlaps(false);
      for(decltype(auto) assoc : assocs) overlaps |= hasOverlaps(assoc,m_accessors->findIndex(assoc,obj),p);
      if (overlaps) return false; 
      for(decltype(auto) assoc : assocs) setObjSelectionFlag(assoc,obj,true);
      return true;}

setObjSelectionFlag() [1/4]

template<typename CM>

void columnar::MetAssociationHelper< CM >::setObjSelectionFlag ( AssocId assocId, const ObjectLinkType & pPart, bool status )

inline

Definition at line 434 of file MetAssociation.h.

                                                                                        {
      setObjSelectionFlag(assocId,m_accessors->findIndex(assocId,pPart),status);}

setObjSelectionFlag() [2/4]

template<typename CM>

void columnar::MetAssociationHelper< CM >::setObjSelectionFlag ( AssocId assocId, const xAOD::IParticle * pPart, bool status )

inline

Definition at line 429 of file MetAssociation.h.

                                                                                       {
      setObjSelectionFlag(assocId,PartId(*pPart),status);}

setObjSelectionFlag() [3/4]

template<typename CM>

template<ContainerIdConcept CI>

void columnar::MetAssociationHelper< CM >::setObjSelectionFlag ( AssocId assocId, ObjectId< CI, CM > pPart, bool status )

inline

Definition at line 432 of file MetAssociation.h.

                                                                                  {
      setObjSelectionFlag(assocId,m_accessors->findIndex(assocId,pPart),status);}

setObjSelectionFlag() [4/4]

template<typename CM>

void columnar::MetAssociationHelper< CM >::setObjSelectionFlag ( AssocId assocId, size_t objIdx, bool status )

inline

Definition at line 418 of file MetAssociation.h.

                                                                          {
      if constexpr (useMissingETAssociationHelper)
        m_xaodHelper->setObjSelectionFlag(&assocId.getXAODObject(), objIdx, status);
      else
      {
        if (objIdx >= sizeof(bitmask_t)*8) return;
        bitmask_t mask = static_cast<bitmask_t>(1) << objIdx;
        if (status) m_accessors->useObjectFlagsAcc(assocId) |= mask;
        else m_accessors->useObjectFlagsAcc(assocId) &= ~mask;
      }
    }

Member Data Documentation

invalidIndex

template<typename CM>

std::size_t columnar::MetAssociationHelper< CM >::invalidIndex = MissingETBase::Constants::invalidIndex

staticconstexpr

Definition at line 357 of file MetAssociation.h.

m_accessors

template<typename CM>

const MetAssocationAccessors<CM>* columnar::MetAssociationHelper< CM >::m_accessors = nullptr

private

the accessors for the members of the MET association map

Definition at line 565 of file MetAssociation.h.

m_map

template<typename CM>

ObjectRange<ContainerId::metAssociation,CM> columnar::MetAssociationHelper< CM >::m_map

private

the underlying MET association map

Definition at line 562 of file MetAssociation.h.

m_xaodHelper

template<typename CM>

xAOD::MissingETAssociationHelper* columnar::MetAssociationHelper< CM >::m_xaodHelper = nullptr

private

the xAOD helper object, only used in xAOD mode, but its easier to define it in both modes regardless

Private Members

Definition at line 559 of file MetAssociation.h.

useMissingETAssociationHelper

template<typename CM>

bool columnar::MetAssociationHelper< CM >::useMissingETAssociationHelper = std::is_same_v<CM,ColumnarModeXAOD>

staticconstexpr

Definition at line 356 of file MetAssociation.h.

---

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

• MetAssociation.h