#include <TrackSummaryContainer.h>

Inheritance diagram for ActsTrk::MutableTrackSummaryContainer:

Collaboration diagram for ActsTrk::MutableTrackSummaryContainer:

Public Types
using	IndexType = uint32_t

Public Member Functions
	MutableTrackSummaryContainer ()
	MutableTrackSummaryContainer (const MutableTrackSummaryContainer &)=delete
MutableTrackSummaryContainer	operator= (const MutableTrackSummaryContainer &)=delete
	MutableTrackSummaryContainer (MutableTrackSummaryContainer &&)
MutableTrackSummaryContainer &	operator= (MutableTrackSummaryContainer &&other) noexcept
ActsTrk::IndexType	addTrack_impl ()
	adds new track to the tail of the container
void	removeTrack_impl (ActsTrk::IndexType itrack)
	clears track data under index
template<typename T>
constexpr void	addColumn_impl (std::string_view key)
	enables the container to support decoration of given name and type
void	copyDynamicFrom_impl (ActsTrk::IndexType itrack, Acts::HashedString key, const std::any &src_ptr)
	copies decorations from other container
std::any	component_impl (Acts::HashedString key, ActsTrk::IndexType itrack)
	write access to decorations
ActsTrk::Parameters	parameters (ActsTrk::IndexType itrack)
	write access to parameters
ActsTrk::Covariance	covariance (ActsTrk::IndexType itrack)
	write access to covariance
void	ensureDynamicColumns_impl (const MutableTrackSummaryContainer &other)
	synchronizes decorations
void	ensureDynamicColumns_impl (const TrackSummaryContainer &other)
void	reserve (ActsTrk::IndexType size)
	preallocate number of track objects
void	clear ()
	zeroes container
void	setReferenceSurface_impl (ActsTrk::IndexType itrack, std::shared_ptr< const Acts::Surface > surface)
	point given track to surface The surface ownership is shared
void	setParticleHypothesis_impl (ActsTrk::IndexType itrack, const Acts::ParticleHypothesis &particleHypothesis)
	sets particle hypothesis
xAOD::TrackSummaryContainer *	trackBackend ()
void	encodeSurfaces (xAOD::TrackSurfaceAuxContainer *dest, const Acts::GeometryContext &)
std::any	component_impl (Acts::HashedString key, ActsTrk::IndexType itrack) const
	access to components by pointer with type
ActsTrk::ConstParameters	parameters (ActsTrk::IndexType itrack) const
	parameters of the track
ActsTrk::ConstCovariance	covariance (ActsTrk::IndexType itrack) const
	covariance of the track fit
constexpr bool	hasColumn_impl (Acts::HashedString key) const
	return true if the container has specific decoration
const Acts::Surface *	referenceSurface_impl (ActsTrk::IndexType itrack) const
	return pointer to reference surface
Acts::ParticleHypothesis	particleHypothesis_impl (IndexType itrack) const
	return pointer to reference surface
std::size_t	size_impl () const
	returns number of stored tracks
void	fillFrom (ActsTrk::MutableTrackSummaryContainer &mtb)
void	restoreDecorations ()
void	decodeSurfaces (const xAOD::TrackSurfaceContainer *src)
std::vector< Acts::HashedString >	dynamicKeys_impl () const

Static Public Attributes
static constexpr auto	kInvalid = Acts::kTrackIndexInvalid
static const std::set< std::string >	staticVariables
static const std::set< Acts::HashedString >	staticVariableHashes

Protected Attributes
DataLink< xAOD::TrackSummaryContainer >	m_trackBackend = nullptr
std::vector< ActsTrk::detail::Decoration >	m_decorations
std::vector< std::shared_ptr< const Acts::Surface > >	m_surfaces

Private Attributes
std::unique_ptr< xAOD::TrackSummaryContainer >	m_mutableTrackBackend
std::unique_ptr< xAOD::TrackSummaryAuxContainer >	m_mutableTrackBackendAux

Friends
class	ActsTrk::MutableTrackContainerHandlesHelper

Detailed Description

Definition at line 118 of file Tracking/Acts/ActsEvent/ActsEvent/TrackSummaryContainer.h.

Member Typedef Documentation

◆ IndexType

using ActsTrk::TrackSummaryContainer::IndexType = uint32_t

inherited

Definition at line 58 of file Tracking/Acts/ActsEvent/ActsEvent/TrackSummaryContainer.h.

Constructor & Destructor Documentation

◆ MutableTrackSummaryContainer() [1/3]

ActsTrk::MutableTrackSummaryContainer::MutableTrackSummaryContainer ( )

Definition at line 140 of file TrackSummaryContainer.cxx.

                                                                  :
  m_mutableTrackBackend(std::make_unique<xAOD::TrackSummaryContainer>()),
  m_mutableTrackBackendAux(std::make_unique<xAOD::TrackSummaryAuxContainer>())
{
  m_mutableTrackBackend->setStore(m_mutableTrackBackendAux.get());
  TrackSummaryContainer::m_trackBackend = m_mutableTrackBackend.get();
}

◆ MutableTrackSummaryContainer() [2/3]

ActsTrk::MutableTrackSummaryContainer::MutableTrackSummaryContainer ( const MutableTrackSummaryContainer & )

delete

◆ MutableTrackSummaryContainer() [3/3]

ActsTrk::MutableTrackSummaryContainer::MutableTrackSummaryContainer ( MutableTrackSummaryContainer && other )

Definition at line 148 of file TrackSummaryContainer.cxx.

                                          :
  m_mutableTrackBackend(std::move(other.m_mutableTrackBackend)),
  m_mutableTrackBackendAux(std::move(other.m_mutableTrackBackendAux))
{
  m_mutableTrackBackend->setStore(m_mutableTrackBackendAux.get());
  TrackSummaryContainer::m_trackBackend = m_mutableTrackBackend.get();
 
  m_surfaces = std::move(other.m_surfaces);
  m_decorations = std::move(other.m_decorations);
}

Member Function Documentation

◆ addColumn_impl()

template<typename T>

void ActsTrk::MutableTrackSummaryContainer::addColumn_impl ( std::string_view key )

constexpr

enables the container to support decoration of given name and type

Definition at line 243 of file Tracking/Acts/ActsEvent/ActsEvent/TrackSummaryContainer.h.

                         {
  if (not ActsTrk::detail::accepted_decoration_types<T>::value) {
    throw std::runtime_error(
        "TrackSummaryContainer::addColumn_impl: "
        "unsupported decoration type");
  }
  m_decorations.emplace_back(ActsTrk::detail::decoration<T>(
      name,
      ActsTrk::detail::constDecorationGetter<T>, 
      ActsTrk::detail::decorationCopier<T>,
      ActsTrk::detail::decorationSetter<T>
      ));
}

◆ addTrack_impl()

ActsTrk::IndexType ActsTrk::MutableTrackSummaryContainer::addTrack_impl ( )

adds new track to the tail of the container

Definition at line 188 of file TrackSummaryContainer.cxx.

                                                                    {
  m_mutableTrackBackend->push_back(std::make_unique<xAOD::TrackSummary>());
  m_mutableTrackBackend->back()->resize();
  // ACTS assumes default to be pion, xAOD::ParticleHypothesis == 0 is geantino
  m_mutableTrackBackend->back()->setParticleHypothesis(xAOD::pion);
  m_surfaces.push_back(nullptr);
  return m_mutableTrackBackend->size() - 1;
}

◆ clear()

void ActsTrk::MutableTrackSummaryContainer::clear ( )

zeroes container

Definition at line 263 of file TrackSummaryContainer.cxx.

                                                {
  m_mutableTrackBackend->clear();
  m_surfaces.clear();
}

◆ component_impl() [1/2]

std::any ActsTrk::MutableTrackSummaryContainer::component_impl	(	Acts::HashedString	key,
		ActsTrk::IndexType	itrack )

write access to decorations

Definition at line 220 of file TrackSummaryContainer.cxx.

                                                   {
  std::any result = ::component_impl(*m_mutableTrackBackend, key, itrack);
  if (result.has_value()) {
    return result;
  }
  for (auto& d : m_decorations) {
    if (d.hash == key) {
      return d.setter(m_mutableTrackBackendAux.get(), itrack, d.auxid);
    }
  }
  throw std::runtime_error("TrackSummaryContainer no such component " +
                           std::to_string(key));
}

◆ component_impl() [2/2]

std::any ActsTrk::TrackSummaryContainer::component_impl	(	Acts::HashedString	key,
		ActsTrk::IndexType	itrack ) const

access to components by pointer with type

Definition at line 86 of file TrackSummaryContainer.cxx.

                                                         {
  std::any result = ::component_impl(*m_trackBackend, key, itrack);
  if (result.has_value()) {
    return result;
  }
  for (auto& d : m_decorations) {
    if (d.hash == key) {
      // TODO the dynamic case will be eliminated once we switch to use Aux containers directly
      return d.getter(m_trackBackend->getStore(), itrack, d.auxid);
    }
  }
  throw std::runtime_error("TrackSummaryContainer no such component " +
                           std::to_string(key));
}

◆ copyDynamicFrom_impl()

void ActsTrk::MutableTrackSummaryContainer::copyDynamicFrom_impl	(	ActsTrk::IndexType	itrack,
		Acts::HashedString	key,
		const std::any &	src_ptr )

copies decorations from other container

Definition at line 210 of file TrackSummaryContainer.cxx.

                           {
  if ( staticVariableHashes.count(key) == 1)  { return; }
  for ( const auto& d: m_decorations) {
    if (d.hash != key) { continue; }
    d.copier(m_mutableTrackBackendAux.get(), itrack, d.auxid, src_ptr);
  }
}

◆ covariance() [1/2]

ActsTrk::Covariance ActsTrk::MutableTrackSummaryContainer::covariance ( ActsTrk::IndexType itrack )

write access to covariance

Definition at line 240 of file TrackSummaryContainer.cxx.

                             {
  return m_mutableTrackBackend->at(itrack)->covParamsEigen();
}

◆ covariance() [2/2]

ActsTrk::ConstCovariance ActsTrk::TrackSummaryContainer::covariance ( ActsTrk::IndexType itrack ) const

covariance of the track fit

Definition at line 97 of file TrackSummaryContainer.cxx.

                                   {
  return m_trackBackend->at(itrack)->covParamsEigen();
}

◆ decodeSurfaces()

void ActsTrk::TrackSummaryContainer::decodeSurfaces ( const xAOD::TrackSurfaceContainer * src )

inherited

Definition at line 127 of file TrackSummaryContainer.cxx.

                                                                                      {
  m_surfaces.reserve(src->size());
  for ( auto xAODSurfacePtr: *src) {
    m_surfaces.push_back( decodeSurface(xAODSurfacePtr));
  }
}

◆ dynamicKeys_impl()

std::vector< Acts::HashedString > ActsTrk::TrackSummaryContainer::dynamicKeys_impl ( ) const

inherited

Definition at line 116 of file TrackSummaryContainer.cxx.

                                                                                 {
  std::vector<Acts::HashedString> result;
  for ( const auto& d: m_decorations) {
    if (staticVariableHashes.count(d.hash) == 1) {
      continue;
    }
    result.push_back(d.hash);
  }
  return result;
}

◆ encodeSurfaces()

void ActsTrk::MutableTrackSummaryContainer::encodeSurfaces	(	xAOD::TrackSurfaceAuxContainer *	dest,
		const Acts::GeometryContext &	geoContext )

Definition at line 273 of file TrackSummaryContainer.cxx.

                                                                                                                                  {
  dest->resize(m_surfaces.size());
  size_t destIndex = 0;
  // go over all surfaces and for each free surface record persistent version of it in the xAOD
  // at the same time store index to it updating TrackSummary
  for ( ActsTrk::IndexType index = 0, eindex = m_surfaces.size(); index < eindex; ++index ) {
    if ( m_surfaces[index] == nullptr or m_surfaces[index]->geometryId().value() != 0  ) {
      m_mutableTrackBackend->at(index)->setSurfaceIndex(Acts::kTrackIndexInvalid);
    } else {
      m_mutableTrackBackend->at(index)->setSurfaceIndex(destIndex);
      encodeSurface(dest, destIndex, m_surfaces[index].get(), geoContext);
      destIndex++;
    }
  }
  dest->resize(destIndex);
}

◆ ensureDynamicColumns_impl() [1/2]

void ActsTrk::MutableTrackSummaryContainer::ensureDynamicColumns_impl ( const MutableTrackSummaryContainer & other )

synchronizes decorations

Definition at line 245 of file TrackSummaryContainer.cxx.

                                               {
  for (auto& d : other.m_decorations) {
    m_decorations.push_back(d);
  }
}

◆ ensureDynamicColumns_impl() [2/2]

void ActsTrk::MutableTrackSummaryContainer::ensureDynamicColumns_impl ( const TrackSummaryContainer & other )

Definition at line 252 of file TrackSummaryContainer.cxx.

                                        {
  for (auto& d : other.m_decorations) {
    m_decorations.push_back(d);
  }
}

◆ fillFrom()

void ActsTrk::TrackSummaryContainer::fillFrom ( ActsTrk::MutableTrackSummaryContainer & mtb )

inherited

Definition at line 107 of file TrackSummaryContainer.cxx.

                                              {
  m_surfaces = std::move(mtb.m_surfaces);
}

◆ hasColumn_impl()

bool ActsTrk::TrackSummaryContainer::hasColumn_impl ( Acts::HashedString key ) const

constexprinherited

return true if the container has specific decoration

Definition at line 214 of file Tracking/Acts/ActsEvent/ActsEvent/TrackSummaryContainer.h.

                                {
  using namespace Acts::HashedStringLiteral;
  switch (key) {
    case "params"_hash:
    case "cov"_hash:
    case "nMeasurements"_hash:
    case "nHoles"_hash:
    case "chi2"_hash:
    case "ndf"_hash:
    case "nOutliers"_hash:
    case "nSharedHits"_hash:
    case "nSplitHits"_hash:
    case "tipIndex"_hash:
    case "stemIndex"_hash:
      return true;
  }
  for (auto& d : m_decorations) {
    if (d.hash == key) {
      return true;
    }
  }
  return false;
}

◆ operator=() [1/2]

MutableTrackSummaryContainer ActsTrk::MutableTrackSummaryContainer::operator= ( const MutableTrackSummaryContainer & )

delete

◆ operator=() [2/2]

ActsTrk::MutableTrackSummaryContainer & ActsTrk::MutableTrackSummaryContainer::operator= ( ActsTrk::MutableTrackSummaryContainer && other )

noexcept

Definition at line 162 of file TrackSummaryContainer.cxx.

                                                          {
  //NB. restoreDecorations may throw a GaudiException, resulting in a call to terminate()
  // because the function is annotated 'noexcept'
  m_mutableTrackBackend = std::exchange(other.m_mutableTrackBackend, nullptr);
  m_mutableTrackBackendAux = std::exchange(other.m_mutableTrackBackendAux, nullptr);
  //setStore throws an exception of type SG::ExcUntrackedSetStore, SG::ExcCLIDMismatch
  //resulting in a call to terminate() because the function is marked 'noexcept'
  m_mutableTrackBackend->setStore(m_mutableTrackBackendAux.get());
  TrackSummaryContainer::m_trackBackend = m_mutableTrackBackend.get();
 
  m_surfaces = std::move(other.m_surfaces);
  m_decorations = std::move(other.m_decorations);
 
  //restore decorations
  // restoreDecorations may throw a GaudiException or SG::ExcBadVarName
  // resulting in a call to terminate() because the function is marked 'noexcept'
  restoreDecorations();
 
  // invalidate vector type components of 'other'
  other.m_surfaces.clear();
  other.m_decorations.clear();
 
  return *this;
}

◆ parameters() [1/2]

ActsTrk::Parameters ActsTrk::MutableTrackSummaryContainer::parameters ( ActsTrk::IndexType itrack )

write access to parameters

Definition at line 235 of file TrackSummaryContainer.cxx.

                             {
  return m_mutableTrackBackend->at(itrack)->paramsEigen();
}

◆ parameters() [2/2]

ActsTrk::ConstParameters ActsTrk::TrackSummaryContainer::parameters ( ActsTrk::IndexType itrack ) const

parameters of the track

Definition at line 92 of file TrackSummaryContainer.cxx.

                                   {
  return m_trackBackend->at(itrack)->paramsEigen();
}

◆ particleHypothesis_impl()

Acts::ParticleHypothesis ActsTrk::TrackSummaryContainer::particleHypothesis_impl ( IndexType itrack ) const

inherited

return pointer to reference surface

Definition at line 42 of file TrackSummaryContainer.cxx.

                                                                                                  {
  return ActsTrk::ParticleHypothesis::convert( static_cast<xAOD::ParticleHypothesis>(m_trackBackend->at(itrack)->particleHypothesis()));
}

◆ referenceSurface_impl()

const Acts::Surface * ActsTrk::TrackSummaryContainer::referenceSurface_impl ( ActsTrk::IndexType itrack ) const

inherited

return pointer to reference surface

Definition at line 33 of file TrackSummaryContainer.cxx.

                                   {
  if (itrack >= m_surfaces.size())
    throw std::out_of_range(
        "TrackSummaryContainer index out of range when accessing reference "
        "surface");
  return m_surfaces[itrack].get();
}

◆ removeTrack_impl()

void ActsTrk::MutableTrackSummaryContainer::removeTrack_impl ( ActsTrk::IndexType itrack )

clears track data under index

Definition at line 197 of file TrackSummaryContainer.cxx.

                             {
  if (itrack >= m_mutableTrackBackend->size()) {
    throw std::out_of_range("removeTrack_impl track backend");
  }
  if (itrack >= m_surfaces.size()) {
    throw std::out_of_range("removeTrack_impl surfaces");
  }
  m_mutableTrackBackend->erase(m_mutableTrackBackend->begin() + itrack);
  m_surfaces.erase(m_surfaces.begin() + itrack);
}

◆ reserve()

void ActsTrk::MutableTrackSummaryContainer::reserve ( ActsTrk::IndexType size )

preallocate number of track objects

Definition at line 259 of file TrackSummaryContainer.cxx.

                                                                       {
  m_mutableTrackBackend->reserve(size);
}

◆ restoreDecorations()

void ActsTrk::TrackSummaryContainer::restoreDecorations ( )

inherited

Definition at line 112 of file TrackSummaryContainer.cxx.

                                                      {
  m_decorations = ActsTrk::detail::restoreDecorations(m_trackBackend->getConstStore(), staticVariables);
}

◆ setParticleHypothesis_impl()

void ActsTrk::MutableTrackSummaryContainer::setParticleHypothesis_impl	(	ActsTrk::IndexType	itrack,
		const Acts::ParticleHypothesis &	particleHypothesis )

sets particle hypothesis

Warning: it will fail for an arbitrary particles as it converts to a predefined set (

See also: xAOD::ParticleHypothesis in TrackingPrimitives.h) of values

Definition at line 290 of file TrackSummaryContainer.cxx.

                                                                                                                                              {
  m_mutableTrackBackend->at(itrack)->setParticleHypothesis(ActsTrk::ParticleHypothesis::convert(particleHypothesis));
}

◆ setReferenceSurface_impl()

void ActsTrk::MutableTrackSummaryContainer::setReferenceSurface_impl	(	ActsTrk::IndexType	itrack,
		std::shared_ptr< const Acts::Surface >	surface )

point given track to surface The surface ownership is shared

Definition at line 268 of file TrackSummaryContainer.cxx.

                                                                       {
  m_surfaces[itrack] = std::move(surface);
}

◆ size_impl()

std::size_t ActsTrk::TrackSummaryContainer::size_impl ( ) const

inherited

returns number of stored tracks

Definition at line 46 of file TrackSummaryContainer.cxx.

                                                        {
  return m_trackBackend->size();
}

◆ trackBackend()

xAOD::TrackSummaryContainer * ActsTrk::MutableTrackSummaryContainer::trackBackend ( )

inline

Definition at line 202 of file Tracking/Acts/ActsEvent/ActsEvent/TrackSummaryContainer.h.

                                           {
    return m_mutableTrackBackend.get();
  }

◆ ActsTrk::MutableTrackContainerHandlesHelper

friend class ActsTrk::MutableTrackContainerHandlesHelper

friend

Definition at line 199 of file Tracking/Acts/ActsEvent/ActsEvent/TrackSummaryContainer.h.

Member Data Documentation

◆ kInvalid

auto ActsTrk::TrackSummaryContainer::kInvalid = Acts::kTrackIndexInvalid

staticconstexprinherited

Definition at line 59 of file Tracking/Acts/ActsEvent/ActsEvent/TrackSummaryContainer.h.

◆ m_decorations

std::vector<ActsTrk::detail::Decoration> ActsTrk::TrackSummaryContainer::m_decorations

protectedinherited

Definition at line 114 of file Tracking/Acts/ActsEvent/ActsEvent/TrackSummaryContainer.h.

◆ m_mutableTrackBackend

std::unique_ptr<xAOD::TrackSummaryContainer> ActsTrk::MutableTrackSummaryContainer::m_mutableTrackBackend

private

Definition at line 209 of file Tracking/Acts/ActsEvent/ActsEvent/TrackSummaryContainer.h.

◆ m_mutableTrackBackendAux

std::unique_ptr<xAOD::TrackSummaryAuxContainer> ActsTrk::MutableTrackSummaryContainer::m_mutableTrackBackendAux

private

Definition at line 210 of file Tracking/Acts/ActsEvent/ActsEvent/TrackSummaryContainer.h.

◆ m_surfaces

std::vector<std::shared_ptr<const Acts::Surface> > ActsTrk::TrackSummaryContainer::m_surfaces

protectedinherited

Definition at line 115 of file Tracking/Acts/ActsEvent/ActsEvent/TrackSummaryContainer.h.

◆ m_trackBackend

DataLink<xAOD::TrackSummaryContainer> ActsTrk::TrackSummaryContainer::m_trackBackend = nullptr

protectedinherited

Definition at line 113 of file Tracking/Acts/ActsEvent/ActsEvent/TrackSummaryContainer.h.

◆ staticVariableHashes

const std::set< Acts::HashedString > ActsTrk::TrackSummaryContainer::staticVariableHashes

staticinherited

Initial value:

                                                                    = [](){
  std::set<Acts::HashedString> result;
  for (const auto& s: ActsTrk::TrackSummaryContainer::staticVariables) {
    result.insert(Acts::hashStringDynamic(s));
  }
  return result;
}()

Definition at line 19 of file Tracking/Acts/ActsEvent/ActsEvent/TrackSummaryContainer.h.

25 {

◆ staticVariables

const std::set< std::string > ActsTrk::TrackSummaryContainer::staticVariables

staticinherited

Initial value:

                                                           = {
"params", "covParams", "nMeasurements", "nHoles",   "chi2f",
"ndf",    "nOutliers", "nSharedHits",   "nSplitHits", "tipIndex", "stemIndex",
"particleHypothesis", "surfaceIndex"}

Definition at line 13 of file Tracking/Acts/ActsEvent/ActsEvent/TrackSummaryContainer.h.

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

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ IndexType

Constructor & Destructor Documentation

◆ MutableTrackSummaryContainer() [1/3]

◆ MutableTrackSummaryContainer() [2/3]

◆ MutableTrackSummaryContainer() [3/3]

Member Function Documentation

◆ addColumn_impl()

◆ addTrack_impl()

◆ clear()

◆ component_impl() [1/2]

◆ component_impl() [2/2]

◆ copyDynamicFrom_impl()

◆ covariance() [1/2]

◆ covariance() [2/2]

◆ decodeSurfaces()

◆ dynamicKeys_impl()

◆ encodeSurfaces()

◆ ensureDynamicColumns_impl() [1/2]

◆ ensureDynamicColumns_impl() [2/2]

◆ fillFrom()

◆ hasColumn_impl()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ parameters() [1/2]

◆ parameters() [2/2]

◆ particleHypothesis_impl()

◆ referenceSurface_impl()

◆ removeTrack_impl()

◆ reserve()

◆ restoreDecorations()

◆ setParticleHypothesis_impl()

◆ setReferenceSurface_impl()

◆ size_impl()

◆ trackBackend()

Friends And Related Symbol Documentation

◆ ActsTrk::MutableTrackContainerHandlesHelper

Member Data Documentation

◆ kInvalid

◆ m_decorations

◆ m_mutableTrackBackend

◆ m_mutableTrackBackendAux

◆ m_surfaces

◆ m_trackBackend

◆ staticVariableHashes

◆ staticVariables