ActsTrk::AuxiliaryMeasurementHandler Class Reference

Utility class to handle the creation of the Auxiliary measurement used in an Acts track fit This class declares the additionally written xAOD::AuxiliaryMeasurementContainers to the AvalancheScheduler. More...

#include <AuxiliaryMeasurementHandler.h>

Collaboration diagram for ActsTrk::AuxiliaryMeasurementHandler:

Classes
class	MeasurementProvider
	Helper struct to create a new pseudo measurement. More...

Public Types
enum class	HandleStatus : std::uint8_t { ok = 0 , emptyKey = 1 , recordFail = 2 }
using	SurfacePtr_t = xAOD::AuxiliaryMeasurement::SurfacePtr_t
using	HandleReturn_t = Acts::Result<MeasurementProvider, HandleStatus>

Public Member Functions
template<class PropOwner>
	AuxiliaryMeasurementHandler (PropOwner *owner)
	Constructor taking the pointer to the class holding the object used to declare the data dependency from the WriteHandleKeys to the AvalancheScheduler.
StatusCode	initialize (const std::string &preFix, bool used=true)
	Initialize the write handle keys.
HandleReturn_t	makeHandle (const EventContext &ctx, const Acts::GeometryContext &gctx) const
	Creates a new MeasurementProvider and triggers the write of the container backend to StoreGate.

Private Types
using	Key_t = SG::WriteHandleKey<xAOD::AuxiliaryMeasurementContainer>

Private Member Functions
MsgStream &	msg (const MSG::Level lvl) const
	Return the reference to the msg logging stream.
bool	msgLvl (const MSG::Level lvl) const
	Returns whether the stream satisfies the logging level.

Private Attributes
std::function< MsgStream &(const MSG::Level)>	m_msgPrinter {}
	Lambda to access the parent's msg stream.
std::function< bool(const MSG::Level)>	m_msgLevel {}
	Lambda to return the msg level from the parent's msg stream.
Key_t	m_viewKey
	Key to write the view container.
Key_t	m_writeKey1D
	Key to write the 1D measurements.
Key_t	m_writeKey2D
	Key to write the 2D measurements.
Key_t	m_writeKey3D
	Key to write the 2D + time measurements.
SG::WriteHandleKey< xAOD::TrackSurfaceContainer >	m_surfaceKey
	Key to write the surfaces associated to the measurements.

Detailed Description

Utility class to handle the creation of the Auxiliary measurement used in an Acts track fit This class declares the additionally written xAOD::AuxiliaryMeasurementContainers to the AvalancheScheduler.

Per event, the user creates an instance of the MeasurementProvider which setups the storage backend for the measurements and writes the containers to StoreGate. Auxiliary measurements are created by calling the newMeasurement method.

Definition at line 22 of file AuxiliaryMeasurementHandler.h.

Member Typedef Documentation

HandleReturn_t

using ActsTrk::AuxiliaryMeasurementHandler::HandleReturn_t = Acts::Result<MeasurementProvider, HandleStatus>

Definition at line 112 of file AuxiliaryMeasurementHandler.h.

Key_t

using ActsTrk::AuxiliaryMeasurementHandler::Key_t = SG::WriteHandleKey<xAOD::AuxiliaryMeasurementContainer>

private

Definition at line 126 of file AuxiliaryMeasurementHandler.h.

SurfacePtr_t

using ActsTrk::AuxiliaryMeasurementHandler::SurfacePtr_t = xAOD::AuxiliaryMeasurement::SurfacePtr_t

Definition at line 24 of file AuxiliaryMeasurementHandler.h.

Member Enumeration Documentation

HandleStatus

enum class ActsTrk::AuxiliaryMeasurementHandler::HandleStatus : std::uint8_t

strong

Enumerator
ok
emptyKey
recordFail

Definition at line 107 of file AuxiliaryMeasurementHandler.h.

                                   : std::uint8_t{
                ok = 0,
                emptyKey = 1,
                recordFail = 2,
            };

Constructor & Destructor Documentation

AuxiliaryMeasurementHandler()

template<class PropOwner>

ActsTrk::AuxiliaryMeasurementHandler::AuxiliaryMeasurementHandler

(

PropOwner *

owner

)

Constructor taking the pointer to the class holding the object used to declare the data dependency from the WriteHandleKeys to the AvalancheScheduler.

The object should be defined in the header like ActsTrk::AuxiliaryMeasurementHandler m_pseudoHandle{this};

Member Function Documentation

initialize()

StatusCode ActsTrk::AuxiliaryMeasurementHandler::initialize	(	const std::string &	preFix,
		bool	used = true )

Initialize the write handle keys.

Parameters

preFix	Common prefix to be put in front of all keys
used	Flag indicating whether the auxiliary keys are used at all

Definition at line 25 of file AuxiliaryMeasurementHandler.cxx.

                                                                  {
        if (preFix.empty()) {
            ATH_MSG_ERROR("The prefix key of the auxiliary measurements must no be empty");
            return StatusCode::FAILURE;
        }
        m_surfaceKey = std::format("{:}AuxiliarySurfaceContainer", preFix);
        if (!m_surfaceKey.initialize(used).isSuccess()) {
            ATH_MSG_ERROR("Failed to initialize "<<m_surfaceKey.fullKey());
            return StatusCode::FAILURE;
        }
        m_viewKey = preFix;
        if (!m_viewKey.initialize(used).isSuccess()) {
            ATH_MSG_ERROR("Failed to initialize the view element key "<<m_viewKey.fullKey());
            return StatusCode::FAILURE;
        }
        unsigned counter{1};
        for (auto& initMe : {&m_writeKey1D, &m_writeKey2D, &m_writeKey3D}){
            (*initMe) = std::format("{:}AuxiliaryMeasContainer{:}D", preFix, counter++);
            if (!initMe->initialize(used).isSuccess()) {
                ATH_MSG_ERROR("Failed to initialize "<<(*initMe).fullKey());
                return StatusCode::FAILURE;
            }
        }
        return StatusCode::SUCCESS;
    }

makeHandle()

AuxiliaryMeasurementHandler::HandleReturn_t ActsTrk::AuxiliaryMeasurementHandler::makeHandle	(	const EventContext &	ctx,
		const Acts::GeometryContext &	gctx ) const

Creates a new MeasurementProvider and triggers the write of the container backend to StoreGate.

The user needs to provide a reference to a mutable xAOD::TrackSurfaceContainer where the persistified surfaces are appended to. The client needs to ensure that the lifetime of the surface container prevails the provider's lifetime.

Parameters

ctx	EventContext to write the containers to store gate
gctx	The geometry context to place the surface in space

Definition at line 73 of file AuxiliaryMeasurementHandler.cxx.

                                                                                            {
        if (m_surfaceKey.empty()) {
            return HandleReturn_t{HandleStatus::emptyKey};
        }
        MeasurementProvider newHandle{ctx, gctx, this};
        if (!newHandle.setupContainers().isSuccess()) {
            return HandleReturn_t{HandleStatus::recordFail};
        }
        return HandleReturn_t{std::move(newHandle)};
    }

msg()

MsgStream & ActsTrk::AuxiliaryMeasurementHandler::msg ( const MSG::Level lvl ) const

private

Return the reference to the msg logging stream.

Parameters

lvl	Logging level to be applied

Definition at line 18 of file AuxiliaryMeasurementHandler.cxx.

                                                                        {
        return m_msgPrinter(lvl);
    }

msgLvl()

bool ActsTrk::AuxiliaryMeasurementHandler::msgLvl ( const MSG::Level lvl ) const

private

Returns whether the stream satisfies the logging level.

Definition at line 22 of file AuxiliaryMeasurementHandler.cxx.

                                                                     {
        return m_msgLevel(lvl);
    }

Member Data Documentation

m_msgLevel

std::function<bool(const MSG::Level)> ActsTrk::AuxiliaryMeasurementHandler::m_msgLevel {}

private

Lambda to return the msg level from the parent's msg stream.

Definition at line 130 of file AuxiliaryMeasurementHandler.h.

{};

m_msgPrinter

std::function<MsgStream&(const MSG::Level)> ActsTrk::AuxiliaryMeasurementHandler::m_msgPrinter {}

private

Lambda to access the parent's msg stream.

Definition at line 128 of file AuxiliaryMeasurementHandler.h.

{};

m_surfaceKey

SG::WriteHandleKey<xAOD::TrackSurfaceContainer> ActsTrk::AuxiliaryMeasurementHandler::m_surfaceKey

private

Key to write the surfaces associated to the measurements.

Definition at line 140 of file AuxiliaryMeasurementHandler.h.

m_viewKey

Key_t ActsTrk::AuxiliaryMeasurementHandler::m_viewKey

private

Key to write the view container.

Definition at line 132 of file AuxiliaryMeasurementHandler.h.

m_writeKey1D

Key_t ActsTrk::AuxiliaryMeasurementHandler::m_writeKey1D

private

Key to write the 1D measurements.

Definition at line 134 of file AuxiliaryMeasurementHandler.h.

m_writeKey2D

Key_t ActsTrk::AuxiliaryMeasurementHandler::m_writeKey2D

private

Key to write the 2D measurements.

Definition at line 136 of file AuxiliaryMeasurementHandler.h.

m_writeKey3D

Key_t ActsTrk::AuxiliaryMeasurementHandler::m_writeKey3D

private

Key to write the 2D + time measurements.

Definition at line 138 of file AuxiliaryMeasurementHandler.h.

---

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

• AuxiliaryMeasurementHandler.h
• AuxiliaryMeasurementHandler.cxx