columnar::ColumnarLinkTool Class Reference

a columnar tool to merge the two components of an element link into the proper repesentation for columnar More...

#include <ColumnarLinkTool.h>

Inheritance diagram for columnar::ColumnarLinkTool:

Collaboration diagram for columnar::ColumnarLinkTool:

Classes
struct	ColumnSlot
	generic per-column low-level accessor state More...
struct	TargetSlot
	per-target container information More...

Public Member Functions
	ColumnarLinkTool (const std::string &name)
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual void	callEvents (EventContextRange events) const override
virtual void	print () const
	Print the state of the tool.
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	sysInitialize () override
	Perform system initialization for an algorithm.
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
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Public Attributes
Gaudi::Property< std::vector< std::string > >	m_targetContainerNames
Gaudi::Property< bool >	m_errorOnUnknownKey
Gaudi::Property< unsigned >	m_nestingDepth

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.

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
std::vector< TargetSlot >	m_targetSlots
ColumnSlot	m_srcContainerSlot
	per-event particle offsets of the source container
std::vector< ColumnSlot >	m_linkOffsetSlots
	offset columns describing the nested-vector structure of the link triple; outermost first; size matches m_nestingDepth
ColumnSlot	m_indexSlot
	flat input column with the per-link index into the target container
ColumnSlot	m_keySlot
	flat input column with the raw sgkey identifying the target container
ColumnSlot	m_outLinkSlot
	flat output column with the merged link
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

Detailed Description

a columnar tool to merge the two components of an element link into the proper repesentation for columnar

This tool reads both the index and sgkey columns of a link (directly from the xAOD input), adjusts the index with the event offset, looks up the sgkey, and writes out a combined column.

With m_nestingDepth set to a non-zero value the tool also supports vector-of-link and (nested) vector-of-vector-of-link inputs: the link triple (linkIndex, linkSGKey, outLink) is then expected as flat data columns suffixed .data, with one or more offset columns describing the per-particle nesting. The tool only needs to iterate the flat link range per event since the per-link merging is independent of which particle/sub-vector a link belongs to.

This tool only works in ColumnarModeArray, in xAOD mode links are directly represented by ElementLink objects.

Definition at line 44 of file ColumnarLinkTool.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

ColumnarLinkTool()

columnar::ColumnarLinkTool::ColumnarLinkTool

(

const std::string &

name

)

Definition at line 72 of file ColumnarLinkTool.cxx.

    : AsgTool (name)
  {}

Member Function Documentation

callEvents()

void columnar::ColumnarLinkTool::callEvents ( EventContextRange events ) const

overridevirtual

Definition at line 155 of file ColumnarLinkTool.cxx.

  {
    using CM = ColumnarModeArray;
 
    for (EventContextId event : events)
    {
      void** dataArea = event.getDataArea();
      const std::size_t eventIdx = event.getIndex();
 
      // compute the flat-link range for this event by walking the
      // source-particle offset and the nested-vector offset chain
      const auto *srcPartOff = static_cast<const ColumnarOffsetType*>
        (dataArea[m_srcContainerSlot.dataIndex]);
      std::size_t flatStart = srcPartOff[eventIdx];
      std::size_t flatEnd   = srcPartOff[eventIdx + 1];
      for (const auto& off : m_linkOffsetSlots)
      {
        const auto *a = static_cast<const ColumnarOffsetType*>
          (dataArea[off.dataIndex]);
        flatStart = a[flatStart];
        flatEnd   = a[flatEnd];
      }
 
      const auto *indexArr = static_cast<const CM::LinkIndexType*>
        (dataArea[m_indexSlot.dataIndex]);
      const auto *keyArr   = static_cast<const SG::sgkey_t*>
        (dataArea[m_keySlot.dataIndex]);
      auto       *outArr   = static_cast<CM::LinkIndexType*>
        (dataArea[m_outLinkSlot.dataIndex]);
 
      for (std::size_t j = flatStart; j < flatEnd; ++ j)
      {
        const CM::LinkIndexType index = indexArr[j];
        const SG::sgkey_t       key   = keyArr[j];
 
        if (index == 0 && key == 0)
        {
          outArr[j] = CM::invalidLinkValue;
          continue;
        }
 
        std::size_t t = 0;
        while (t < m_targetSlots.size() && m_targetSlots[t].sgKey != key)
          ++ t;
 
        if (t == m_targetSlots.size())
        {
          if (m_errorOnUnknownKey.value())
          {
            throw std::runtime_error
              ("ColumnarLinkTool: unknown sgkey " + std::to_string (key));
          }
          outArr[j] = CM::mergeLinkKeyIndex (0xfe, index);
          continue;
        }
 
        const auto *targetOffsets = static_cast<const ColumnarOffsetType*>
          (dataArea[m_targetSlots[t].dataIndex]);
        const CM::LinkIndexType myIndex = index + targetOffsets[eventIdx];
        if (myIndex >= targetOffsets[eventIdx + 1])
        {
          throw std::runtime_error
            ("ColumnarLinkTool: link index " + std::to_string (index)
             + " out of range for target "
             + m_targetContainerNames.value().at (t));
        }
 
        outArr[j] = CM::mergeLinkKeyIndex (t, myIndex);
      }
    }
  }

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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< AlgTool > >::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; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::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; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::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

getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::Event both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::Event, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::Event both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::Event, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

getProperty()

template<class T>

const T * asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

initialize()

StatusCode columnar::ColumnarLinkTool::initialize ( void )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 79 of file ColumnarLinkTool.cxx.

  {
    if (m_targetContainerNames.empty())
    {
      ATH_MSG_ERROR ("targetContainerNames is empty");
      return StatusCode::FAILURE;
    }
 
    m_targetSlots.resize (m_targetContainerNames.size());
    for (std::size_t i = 0; i < m_targetContainerNames.size(); ++ i)
    {
      const auto& name = m_targetContainerNames.value()[i];
      auto keyIter = knownSgKeys.find (name);
      if (keyIter == knownSgKeys.end())
      {
        ATH_MSG_ERROR ("unknown target container name: " << name);
        return StatusCode::FAILURE;
      }
 
      auto& slot = m_targetSlots[i];
      slot.sgKey = keyIter->second;
      slot.accessorData = std::make_unique<ColumnAccessorDataArray>
        (&slot.dataIndex, &slot.accessorData,
         &typeid (ColumnarOffsetType), ColumnAccessMode::input);
 
      ColumnInfo info;
      info.offsetName = eventContextCIName;
      info.isOffset = true;
      addColumn (name, slot.accessorData.get(), std::move (info));
    }
 
    // source-container per-event particle offsets
    registerColumn (*this, m_srcContainerSlot, sourceContainerName,
                    &typeid (ColumnarOffsetType), ColumnAccessMode::input,
                    std::string (eventContextCIName), true);
 
    // nested-vector offset columns; outermost first
    const unsigned depth = m_nestingDepth.value();
    m_linkOffsetSlots.resize (depth);
    std::string parentOffsetName = sourceContainerName;
    for (unsigned i = 0; i < depth; ++ i)
    {
      const std::string name = linkOffsetName (i, depth);
      registerColumn (*this, m_linkOffsetSlots[i], name,
                      &typeid (ColumnarOffsetType), ColumnAccessMode::input,
                      parentOffsetName, true);
      parentOffsetName = name;
    }
 
    // the innermost offset name becomes the offset for the flat data
    // columns
    const std::string& innerOffsetName = parentOffsetName;
    const std::string dataSuffix = (depth == 0u ? "" : ".data");
 
    registerColumn (*this, m_indexSlot,
                    std::string ("Container.linkIndex") + dataSuffix,
                    &typeid (ColumnarModeArray::LinkIndexType),
                    ColumnAccessMode::input, innerOffsetName, false);
    registerColumn (*this, m_keySlot,
                    std::string ("Container.linkSGKey") + dataSuffix,
                    &typeid (SG::sgkey_t),
                    ColumnAccessMode::input, innerOffsetName, false);
    registerColumn (*this, m_outLinkSlot,
                    std::string ("Container.outLink") + dataSuffix,
                    &typeid (ColumnarModeArray::LinkIndexType),
                    ColumnAccessMode::output, innerOffsetName, false);
 
    // give the base class a chance to initialize the column accessor
    // backends
    ANA_CHECK (initializeColumns());
    return StatusCode::SUCCESS;
  }

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::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.

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns

The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::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.

print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

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< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

m_errorOnUnknownKey

Gaudi::Property<bool> columnar::ColumnarLinkTool::m_errorOnUnknownKey

Initial value:

{
      this, "errorOnUnknownKey", true,
      "whether an unknown sgkey should produce an error (true), or an invalid link (false)"}

Definition at line 64 of file ColumnarLinkTool.h.

                                            {
      this, "errorOnUnknownKey", true,
      "whether an unknown sgkey should produce an error (true), or an invalid link (false)"};

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

m_indexSlot

ColumnSlot columnar::ColumnarLinkTool::m_indexSlot

private

flat input column with the per-link index into the target container

Definition at line 115 of file ColumnarLinkTool.h.

m_keySlot

ColumnSlot columnar::ColumnarLinkTool::m_keySlot

private

flat input column with the raw sgkey identifying the target container

Definition at line 119 of file ColumnarLinkTool.h.

m_linkOffsetSlots

std::vector<ColumnSlot> columnar::ColumnarLinkTool::m_linkOffsetSlots

private

offset columns describing the nested-vector structure of the link triple; outermost first; size matches m_nestingDepth

Definition at line 111 of file ColumnarLinkTool.h.

m_nestingDepth

Gaudi::Property<unsigned> columnar::ColumnarLinkTool::m_nestingDepth

Initial value:

{
      this, "nestingDepth", 0u,
      "nesting depth of vector-of-link inputs (0 = scalar link per particle, 1 = vector of links per particle, 2 = vector of vector of links, ...)"}

Definition at line 68 of file ColumnarLinkTool.h.

                                           {
      this, "nestingDepth", 0u,
      "nesting depth of vector-of-link inputs (0 = scalar link per particle, 1 = vector of links per particle, 2 = vector of vector of links, ...)"};

m_outLinkSlot

ColumnSlot columnar::ColumnarLinkTool::m_outLinkSlot

private

flat output column with the merged link

Definition at line 122 of file ColumnarLinkTool.h.

m_srcContainerSlot

ColumnSlot columnar::ColumnarLinkTool::m_srcContainerSlot

private

per-event particle offsets of the source container

Definition at line 106 of file ColumnarLinkTool.h.

m_targetContainerNames

Gaudi::Property<std::vector<std::string> > columnar::ColumnarLinkTool::m_targetContainerNames

Initial value:

{
      this, "targetContainerNames", {},
      "names of the allowed target containers, in order of their columnar-key index"}

Definition at line 60 of file ColumnarLinkTool.h.

                                                               {
      this, "targetContainerNames", {},
      "names of the allowed target containers, in order of their columnar-key index"};

m_targetSlots

std::vector<TargetSlot> columnar::ColumnarLinkTool::m_targetSlots

private

Definition at line 103 of file ColumnarLinkTool.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• ColumnarLinkTool.h
• ColumnarLinkTool.cxx