ATLAS Offline Software
Loading...
Searching...
No Matches
ActsTrk::CaloExtension Class Reference

The CaloExtension holds the ID extrapolation states through the calorimeter and the associated CaloClusters. More...

#include <CaloExtension.h>

Collaboration diagram for ActsTrk::CaloExtension:

Public Types

using ClusterVec_t = std::vector<const xAOD::CaloCluster*>
 Abrivation of the calo cluster vector.
using ParamVec_t = std::vector<Acts::BoundTrackParameters>
 Abrivation of the Bound track parameter vector.

Public Member Functions

 CaloExtension (const xAOD::TrackParticle *track)
 Constructor taking the pointer to the ID track used for the extrapolations.
const xAOD::TrackParticletrack () const
std::size_t size () const
 Number of extensions stored in the instance.
bool empty () const
const Acts::BoundTrackParameters & parameters (const std::size_t parIdx) const
 Returns the extension parameters associated with the n-th extension.
void appendParameters (Acts::BoundTrackParameters &&pars)
 Append a list of recorded hit parameters.
void associateCluster (const xAOD::CaloCluster *clust)
 Associates a calorimeter cluster with the calo extension.
std::optional< Acts::BoundTrackParameters > lastParameters () const
 Returns the outermost parameters known to the extension.
const ParamVec_tparameters () const
 Returns the view onto the cached BoundTackParameters.
const ClusterVec_tassociatedClusters () const
 Returns the view on the asociated clusters.
std::optional< Acts::BoundTrackParameters > lastTrackParameters () const
 Returns the track parameters asssociated with the last measurement state of the ID track.

Private Attributes

const xAOD::TrackParticlem_idTrack {nullptr}
 Pointer to the associated ID track particle.
ParamVec_t m_parameters {}
 Define the list of bound track parameters.
ClusterVec_t m_clusters {}
 The list of assoicated clusters.

Detailed Description

The CaloExtension holds the ID extrapolation states through the calorimeter and the associated CaloClusters.

Definition at line 31 of file Acts/ActsEvent/ActsEvent/CaloExtension.h.

Member Typedef Documentation

◆ ClusterVec_t

Abrivation of the calo cluster vector.

Definition at line 46 of file Acts/ActsEvent/ActsEvent/CaloExtension.h.

◆ ParamVec_t

using ActsTrk::CaloExtension::ParamVec_t = std::vector<Acts::BoundTrackParameters>

Abrivation of the Bound track parameter vector.

Definition at line 48 of file Acts/ActsEvent/ActsEvent/CaloExtension.h.

Constructor & Destructor Documentation

◆ CaloExtension()

ActsTrk::CaloExtension::CaloExtension ( const xAOD::TrackParticle * track)

Constructor taking the pointer to the ID track used for the extrapolations.

Definition at line 24 of file Acts/ActsEvent/Root/CaloExtension.cxx.

24 :
const xAOD::TrackParticle * m_idTrack
Pointer to the associated ID track particle.
const xAOD::TrackParticle * track() const

Member Function Documentation

◆ appendParameters()

void ActsTrk::CaloExtension::appendParameters ( Acts::BoundTrackParameters && pars)

Append a list of recorded hit parameters.

Definition at line 40 of file Acts/ActsEvent/Root/CaloExtension.cxx.

40 {
41 m_parameters.emplace_back(std::move(pars));
42 }
ParamVec_t m_parameters
Define the list of bound track parameters.

◆ associateCluster()

void ActsTrk::CaloExtension::associateCluster ( const xAOD::CaloCluster * clust)

Associates a calorimeter cluster with the calo extension.

Parameters
clustPointer to the calo cluster

Definition at line 43 of file Acts/ActsEvent/Root/CaloExtension.cxx.

43 {
44 if (!clust) {
45 THROW_EXCEPTION("The calorimeter cluster not be a nullptr");
46 }
47 if (!Acts::rangeContainsValue(m_clusters, clust)) {
48 m_clusters.push_back(clust);
49 }
50 }
ClusterVec_t m_clusters
The list of assoicated clusters.
#define THROW_EXCEPTION(MESSAGE)
Definition throwExcept.h:10

◆ associatedClusters()

const CaloExtension::ClusterVec_t & ActsTrk::CaloExtension::associatedClusters ( ) const

Returns the view on the asociated clusters.

Definition at line 54 of file Acts/ActsEvent/Root/CaloExtension.cxx.

54 {
55 return m_clusters;
56 }

◆ empty()

bool ActsTrk::CaloExtension::empty ( ) const

Definition at line 60 of file Acts/ActsEvent/Root/CaloExtension.cxx.

60 {
61 return m_parameters.empty();
62 }

◆ lastParameters()

std::optional< Acts::BoundTrackParameters > ActsTrk::CaloExtension::lastParameters ( ) const

Returns the outermost parameters known to the extension.

Definition at line 33 of file Acts/ActsEvent/Root/CaloExtension.cxx.

33 {
34 if (! m_parameters.empty()) {
35 return m_parameters.back();
36 }
37 return lastTrackParameters();
38 }
std::optional< Acts::BoundTrackParameters > lastTrackParameters() const
Returns the track parameters asssociated with the last measurement state of the ID track.

◆ lastTrackParameters()

std::optional< Acts::BoundTrackParameters > ActsTrk::CaloExtension::lastTrackParameters ( ) const

Returns the track parameters asssociated with the last measurement state of the ID track.

Definition at line 30 of file Acts/ActsEvent/Root/CaloExtension.cxx.

30 {
31 return m_idTrack ? ActsTrk::lastTrackParameters(*m_idTrack) : std::nullopt;
32 }
std::optional< Acts::BoundTrackParameters > lastTrackParameters(const xAOD::TrackParticle &trkPart, const bool skipOutlier=true)
Returns the last MeasurementState in form of Acts::BoundTrackParameters.

◆ parameters() [1/2]

const CaloExtension::ParamVec_t & ActsTrk::CaloExtension::parameters ( ) const

Returns the view onto the cached BoundTackParameters.

Definition at line 51 of file Acts/ActsEvent/Root/CaloExtension.cxx.

51 {
52 return m_parameters;
53 }

◆ parameters() [2/2]

const Acts::BoundTrackParameters & ActsTrk::CaloExtension::parameters ( const std::size_t parIdx) const

Returns the extension parameters associated with the n-th extension.

◆ size()

std::size_t ActsTrk::CaloExtension::size ( ) const

Number of extensions stored in the instance.

Definition at line 57 of file Acts/ActsEvent/Root/CaloExtension.cxx.

57 {
58 return m_parameters.size();
59 }

◆ track()

const xAOD::TrackParticle * ActsTrk::CaloExtension::track ( ) const

Definition at line 27 of file Acts/ActsEvent/Root/CaloExtension.cxx.

27 {
28 return m_idTrack;
29 }

Member Data Documentation

◆ m_clusters

ClusterVec_t ActsTrk::CaloExtension::m_clusters {}
private

The list of assoicated clusters.

Definition at line 69 of file Acts/ActsEvent/ActsEvent/CaloExtension.h.

69{};

◆ m_idTrack

const xAOD::TrackParticle* ActsTrk::CaloExtension::m_idTrack {nullptr}
private

Pointer to the associated ID track particle.

Definition at line 65 of file Acts/ActsEvent/ActsEvent/CaloExtension.h.

65{nullptr};

◆ m_parameters

ParamVec_t ActsTrk::CaloExtension::m_parameters {}
private

Define the list of bound track parameters.

Definition at line 67 of file Acts/ActsEvent/ActsEvent/CaloExtension.h.

67{};

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