ActsTrk::VolumePlacement::VolumeGeoPositioning Class Reference

Auxiliary class to store the aligned transforms of the volume and of the associated portals. More...

Inheritance diagram for ActsTrk::VolumePlacement::VolumeGeoPositioning:

Collaboration diagram for ActsTrk::VolumePlacement::VolumeGeoPositioning:

Public Types
enum class	CacheFlags : std::uint8_t { volumeLocToGlob , volumeGlobToLoc , portalLocToGlob }
	Flag to indicate which kind of transform is handled by the AlignedCache. More...

Public Member Functions
	VolumeGeoPositioning (const CacheFlags flags, const DetectorType type, const VolumePlacement *parent)
	Constructor for the cache storing the of the volume itself.
	VolumeGeoPositioning (const VolumePlacement *parent, const std::size_t portalIdx)
	Constructor for the cache storing the transform of the alignable portals.
virtual Amg::Transform3D	fetchTransform (const DetectorAlignStore *store) const override
	Fetch the transform to store it in the detector alignment cache.
IdentifierHash	hash () const
	Returns the sensor hash of this transformation cache.
const Amg::Transform3D &	getTransform (const DetectorAlignStore *store) const
	Returns the matching transformation from the alignment store.
const Amg::Transform3D &	getTransform (const GeometryContext &gctx) const
	returns the cached transform from the Acts Geometry context
const Amg::Transform3D &	getTransform (const Acts::GeometryContext &tgContext) const
	returns the cached transform from the Acts Geometry context
bool	storeTransform (DetectorAlignStore &store) const
	Store the final transform in the mutable alignment store.
virtual void	releaseNominalCache () const
	resets the nominal cache associated with the detector element
DetectorType	detectorType () const
	returns the detector type of the cache

Private Types
using	TicketCounter = detail::TrfStoreTicketCounter

Private Attributes
const VolumePlacement *	m_parent {nullptr}
	Back reference to the parent VolumePlacement.
CacheFlags	m_flags {CacheFlags::portalLocToGlob}
	Flags to indicate which transform type is handled.
const IdentifierHash	m_hash {}
const DetectorType	m_type {DetectorType::UnDefined}
const unsigned int	m_clientNo {TicketCounter::drawTicket(m_type)}
	Slot at which the aligned transforms can be put in the external DetectorAlignStore.
CxxUtils::CachedUniquePtrT< Amg::Transform3D > m_nomCache	ATLAS_THREAD_SAFE {}
	Cache to hold the nominal transform, if no DetectorAlignStore is provided The cache is automatically erased as soon as an instantiated store is presented to the class.

Detailed Description

Auxiliary class to store the aligned transforms of the volume and of the associated portals.

Definition at line 86 of file VolumePlacement.h.

Member Typedef Documentation

TicketCounter

using ActsTrk::AlignableGeoPositioning::TicketCounter = detail::TrfStoreTicketCounter

privateinherited

Definition at line 92 of file TransformCache.h.

Member Enumeration Documentation

CacheFlags

enum class ActsTrk::VolumePlacement::VolumeGeoPositioning::CacheFlags : std::uint8_t

strong

Flag to indicate which kind of transform is handled by the AlignedCache.

Enumerator
volumeLocToGlob
volumeGlobToLoc
portalLocToGlob

Definition at line 89 of file VolumePlacement.h.

                                         : std::uint8_t {
                        volumeLocToGlob, // Local -> global transform of the volume
                        volumeGlobToLoc, // Global -> local transform of the volume
                        portalLocToGlob  // Local -> global transform of the associated portal
                    };

Constructor & Destructor Documentation

VolumeGeoPositioning() [1/2]

ActsTrk::VolumePlacement::VolumeGeoPositioning::VolumeGeoPositioning ( const CacheFlags flags, const DetectorType type, const VolumePlacement * parent )

explicit

Constructor for the cache storing the of the volume itself.

Parameters

flags	Flag indicating local -> global or global -> local
type	In which detector transform store is the cache appended
parent	Pointer to the parent creating the cache

Definition at line 13 of file VolumePlacement.cxx.

                                                                              :
        ActsTrk::AlignableGeoPositioning{IdentifierHash{}, type},
        m_parent{parent}, m_flags{flags} {}

VolumeGeoPositioning() [2/2]

ActsTrk::VolumePlacement::VolumeGeoPositioning::VolumeGeoPositioning ( const VolumePlacement * parent, const std::size_t portalIdx )

explicit

Constructor for the cache storing the transform of the alignable portals.

Parameters

parent	Pointer to the parent creating the cache
portalidx	Index of the portal represented by the cache

Definition at line 18 of file VolumePlacement.cxx.

                                                                          :
        ActsTrk::AlignableGeoPositioning(portalIdx, parent->detectorType()),
        m_parent{parent} {}                                       

Member Function Documentation

detectorType()

DetectorType ActsTrk::AlignableGeoPositioning::detectorType ( ) const

inherited

returns the detector type of the cache

Definition at line 34 of file TransformCache.cxx.

{ return m_type; }

fetchTransform()

Amg::Transform3D ActsTrk::VolumePlacement::VolumeGeoPositioning::fetchTransform ( const DetectorAlignStore * store ) const

overridevirtual

Fetch the transform to store it in the detector alignment cache.

Implements ActsTrk::AlignableGeoPositioning.

Definition at line 23 of file VolumePlacement.cxx.

                                                                                                            {
        switch (m_flags) {
            case CacheFlags::volumeLocToGlob: {
                return m_parent->localToGlobalTransform(store);
            } case CacheFlags::portalLocToGlob: {
                return m_parent->localToGlobalTransform(store) *
                       m_parent->portalPlacement(hash())->portalToVolumeCenter();
            } case CacheFlags::volumeGlobToLoc: {
                return m_parent->localToGlobalTransform(store).inverse();
            }
        }
        return Amg::Transform3D::Identity();
    }

getTransform() [1/3]

const Amg::Transform3D & ActsTrk::AlignableGeoPositioning::getTransform ( const Acts::GeometryContext & tgContext ) const

inherited

returns the cached transform from the Acts Geometry context

Parameters

tgContext

The geometry context to be unpacked to the ATLAS geometry context

getTransform() [2/3]

const Amg::Transform3D & ActsTrk::AlignableGeoPositioning::getTransform ( const DetectorAlignStore * store ) const

inherited

Returns the matching transformation from the alignment store.

If a nullptr is given, then it's equivalent to the case that the transformation is pointing to a perfectly aligned surface. In this case, the internal nominal transformation cache is invoked.

Parameters

store

Pointer to the detector aligment store

getTransform() [3/3]

const Amg::Transform3D & ActsTrk::AlignableGeoPositioning::getTransform ( const GeometryContext & gctx ) const

inherited

returns the cached transform from the Acts Geometry context

Parameters

gctx	The geometry context holding the aligned transforms

hash()

IdentifierHash ActsTrk::AlignableGeoPositioning::hash ( ) const

inherited

Returns the sensor hash of this transformation cache.

releaseNominalCache()

void ActsTrk::AlignableGeoPositioning::releaseNominalCache ( ) const

virtualinherited

resets the nominal cache associated with the detector element

Reimplemented in ActsTrk::IReadoutSurfacePositioning.

Definition at line 22 of file TransformCache.cxx.

                                                            {
        m_nomCache.release();
    }

storeTransform()

bool ActsTrk::AlignableGeoPositioning::storeTransform ( DetectorAlignStore & store ) const

inherited

Store the final transform in the mutable alignment store.

Returns true whether a new transform was stored

Parameters

store

The reference to the store where the cache stores its transform

Definition at line 26 of file TransformCache.cxx.

                                                                                {
        if (store.detType != detectorType() || 
            store.trackingAlignment->getTransform(m_clientNo) != nullptr){
            return false;
        }
        store.trackingAlignment->setTransform(m_clientNo, fetchTransform(&store));
        return true;
    }

Member Data Documentation

ATLAS_THREAD_SAFE

CxxUtils::CachedUniquePtrT<Amg::Transform3D> m_nomCache ActsTrk::AlignableGeoPositioning::ATLAS_THREAD_SAFE {}

mutableprivateinherited

Cache to hold the nominal transform, if no DetectorAlignStore is provided The cache is automatically erased as soon as an instantiated store is presented to the class.

Definition at line 99 of file TransformCache.h.

{};

m_clientNo

const unsigned int ActsTrk::AlignableGeoPositioning::m_clientNo {TicketCounter::drawTicket(m_type)}

privateinherited

Slot at which the aligned transforms can be put in the external DetectorAlignStore.

Definition at line 95 of file TransformCache.h.

{TicketCounter::drawTicket(m_type)};

m_flags

CacheFlags ActsTrk::VolumePlacement::VolumeGeoPositioning::m_flags {CacheFlags::portalLocToGlob}

private

Flags to indicate which transform type is handled.

Definition at line 114 of file VolumePlacement.h.

{CacheFlags::portalLocToGlob};

m_hash

const IdentifierHash ActsTrk::AlignableGeoPositioning::m_hash {}

privateinherited

Definition at line 90 of file TransformCache.h.

{};

m_parent

const VolumePlacement* ActsTrk::VolumePlacement::VolumeGeoPositioning::m_parent {nullptr}

private

Back reference to the parent VolumePlacement.

Definition at line 112 of file VolumePlacement.h.

{nullptr};

m_type

const DetectorType ActsTrk::AlignableGeoPositioning::m_type {DetectorType::UnDefined}

privateinherited

Definition at line 91 of file TransformCache.h.

{DetectorType::UnDefined};

---

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

• VolumePlacement.h
• VolumePlacement.cxx